purecrypto 0.6.10

A pure-Rust cryptography toolkit with no foreign-code dependencies, from constant-time primitives up to keys, X.509 and TLS.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
//! C ABI for ECDSA key generation, signing, verification, and PEM I/O.

use alloc::boxed::Box;

use super::common::{PcStatus, guard, out_write, slice, wipe_vec};
use crate::ec::{
    BoxedEcdhPrivateKey, BoxedEcdsaPrivateKey, BoxedEcdsaPublicKey, BoxedEcdsaSignature, CurveId,
    Ed448PrivateKey, Ed448Signature, Ed25519PrivateKey, Ed25519Signature,
};
use crate::hash::{Sha256, Sha384, Sha512};
use crate::rng::OsRng;
use crate::x509::AnyPublicKey;

/// Curve identifiers (mirror `PcCurve` in `purecrypto.h`).
pub mod curve {
    #![allow(missing_docs)]
    pub const P256: i32 = 1;
    pub const P384: i32 = 2;
    pub const P521: i32 = 3;
    pub const SECP256K1: i32 = 4;
}

fn curve_from_id(id: i32) -> Option<CurveId> {
    Some(match id {
        curve::P256 => CurveId::P256,
        curve::P384 => CurveId::P384,
        curve::P521 => CurveId::P521,
        curve::SECP256K1 => CurveId::Secp256k1,
        _ => return None,
    })
}

/// An opaque ECDSA private key.
pub struct PcEcKey(BoxedEcdsaPrivateKey);

/// Returns a shared borrow of the inner Rust key. Used by sibling FFI
/// modules (notably `x509.rs::pc_ec_self_signed_pem`).
pub(super) fn pc_ec_inner_key(handle: &PcEcKey) -> &BoxedEcdsaPrivateKey {
    &handle.0
}

/// Generates an ECDSA key on `curve` (see `PcCurve`), or NULL on failure.
#[unsafe(no_mangle)]
pub extern "C" fn pc_ec_generate(curve_id: i32) -> *mut PcEcKey {
    crate::ffi::common::guard_ptr(|| {
        let Some(curve) = curve_from_id(curve_id) else {
            return core::ptr::null_mut();
        };
        let key = BoxedEcdsaPrivateKey::generate(curve, &mut OsRng);
        Box::into_raw(Box::new(PcEcKey(key)))
    })
}

/// Parses a SEC1 `EC PRIVATE KEY` PEM into a key handle, or NULL on failure.
///
/// # Safety
/// `pem` must be valid UTF-8 for `len` bytes.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ec_from_pem(pem: *const u8, len: usize) -> *mut PcEcKey {
    crate::ffi::common::guard_ptr(|| {
        let Some(bytes) = (unsafe { slice(pem, len) }) else {
            return core::ptr::null_mut();
        };
        let Ok(s) = core::str::from_utf8(bytes) else {
            return core::ptr::null_mut();
        };
        match BoxedEcdsaPrivateKey::from_sec1_pem(s) {
            Ok(k) => Box::into_raw(Box::new(PcEcKey(k))),
            Err(_) => core::ptr::null_mut(),
        }
    })
}

/// Writes the key as a SEC1 `EC PRIVATE KEY` PEM string to `out`.
///
/// # Safety
/// `key` from [`pc_ec_generate`]/[`pc_ec_from_pem`]; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ec_private_to_pem(
    key: *const PcEcKey,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        // The PEM is a re-encoding of the private key; wipe the temporary
        // before its backing storage returns to the allocator.
        let mut pem = unsafe { &*key }.0.to_sec1_pem().into_bytes();
        let st = unsafe { out_write(&pem, out, out_len) };
        wipe_vec(&mut pem);
        st
    })
}

/// Writes the public key as a PKIX `PUBLIC KEY` (SPKI) PEM string to `out`.
///
/// # Safety
/// `key` valid; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ec_public_to_pem(
    key: *const PcEcKey,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        let pem = AnyPublicKey::Ecdsa(unsafe { &*key }.0.public_key()).to_spki_pem();
        unsafe { out_write(pem.as_bytes(), out, out_len) }
    })
}

/// Signs `msg` with `key`, writing a DER `Ecdsa-Sig-Value` to `out`. The digest
/// is chosen by the curve (P-256/secp256k1 → SHA-256, P-384 → SHA-384, P-521 →
/// SHA-512).
///
/// # Safety
/// `key` valid; `msg` valid for `msg_len`; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ec_sign(
    key: *const PcEcKey,
    msg: *const u8,
    msg_len: usize,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        let Some(m) = (unsafe { slice(msg, msg_len) }) else {
            return PcStatus::NullPointer;
        };
        let sk = &unsafe { &*key }.0;
        let curve = sk.curve();
        let sig = match curve {
            CurveId::P256 | CurveId::Secp256k1 => sk.sign::<Sha256>(m),
            CurveId::P384 => sk.sign::<Sha384>(m),
            CurveId::P521 => sk.sign::<Sha512>(m),
            // SM2 is not ECDSA; it has its own signature scheme (use the SM2 API).
            CurveId::Sm2p256v1 => return PcStatus::Unsupported,
        };
        match sig {
            Ok(s) => unsafe { out_write(&s.to_der(curve), out, out_len) },
            Err(_) => PcStatus::Internal,
        }
    })
}

/// Verifies a DER `Ecdsa-Sig-Value` `sig` over `msg` under the SPKI (PKIX
/// `PUBLIC KEY`) DER in `spki`. Returns [`PcStatus::Ok`] iff valid.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ec_verify(
    spki: *const u8,
    spki_len: usize,
    msg: *const u8,
    msg_len: usize,
    sig: *const u8,
    sig_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(spki), Some(m), Some(sig)) = (
            unsafe { slice(spki, spki_len) },
            unsafe { slice(msg, msg_len) },
            unsafe { slice(sig, sig_len) },
        ) else {
            return PcStatus::NullPointer;
        };
        let key = match AnyPublicKey::from_spki_der(spki) {
            Ok(AnyPublicKey::Ecdsa(k)) => k,
            Ok(_) => return PcStatus::Unsupported,
            Err(_) => return PcStatus::BadEncoding,
        };
        let parsed = match BoxedEcdsaSignature::from_der(sig) {
            Ok(s) => s,
            Err(_) => return PcStatus::BadEncoding,
        };
        let ok = match key.curve() {
            CurveId::P256 | CurveId::Secp256k1 => key.verify::<Sha256>(m, &parsed),
            CurveId::P384 => key.verify::<Sha384>(m, &parsed),
            CurveId::P521 => key.verify::<Sha512>(m, &parsed),
            // SM2 is not ECDSA; it has its own signature scheme (use the SM2 API).
            CurveId::Sm2p256v1 => return PcStatus::Unsupported,
        };
        if ok.is_ok() {
            PcStatus::Ok
        } else {
            PcStatus::Verification
        }
    })
}

/// Frees an ECDSA key. NULL is ignored.
///
/// # Safety
/// `key` from [`pc_ec_generate`]/[`pc_ec_from_pem`], not freed twice.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ec_free(key: *mut PcEcKey) {
    if !key.is_null() {
        drop(unsafe { Box::from_raw(key) });
    }
}

/// An opaque Ed25519 private key.
pub struct PcEd25519Key(Ed25519PrivateKey);

/// Generates an Ed25519 key, or NULL on failure.
#[unsafe(no_mangle)]
pub extern "C" fn pc_ed25519_generate() -> *mut PcEd25519Key {
    crate::ffi::common::guard_ptr(|| {
        Box::into_raw(Box::new(PcEd25519Key(Ed25519PrivateKey::generate(
            &mut OsRng,
        ))))
    })
}

/// Parses a PKCS#8 `PRIVATE KEY` PEM into an Ed25519 key handle, or NULL.
///
/// # Safety
/// `pem` must be valid for `len` bytes.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed25519_from_pem(pem: *const u8, len: usize) -> *mut PcEd25519Key {
    crate::ffi::common::guard_ptr(|| {
        let Some(bytes) = (unsafe { slice(pem, len) }) else {
            return core::ptr::null_mut();
        };
        let Ok(s) = core::str::from_utf8(bytes) else {
            return core::ptr::null_mut();
        };
        match Ed25519PrivateKey::from_pkcs8_pem(s) {
            Ok(k) => Box::into_raw(Box::new(PcEd25519Key(k))),
            Err(_) => core::ptr::null_mut(),
        }
    })
}

/// Writes the key as a PKCS#8 `PRIVATE KEY` PEM string to `out`.
///
/// # Safety
/// `key` valid; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed25519_private_to_pem(
    key: *const PcEd25519Key,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        // The PEM is a re-encoding of the private key; wipe the temporary
        // before its backing storage returns to the allocator.
        let mut pem = unsafe { &*key }.0.to_pkcs8_pem().into_bytes();
        let st = unsafe { out_write(&pem, out, out_len) };
        wipe_vec(&mut pem);
        st
    })
}

/// Writes the public key as a PKIX `PUBLIC KEY` (SPKI) PEM string to `out`.
///
/// # Safety
/// `key` valid; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed25519_public_to_pem(
    key: *const PcEd25519Key,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        let pem = AnyPublicKey::Ed25519(unsafe { &*key }.0.public_key()).to_spki_pem();
        unsafe { out_write(pem.as_bytes(), out, out_len) }
    })
}

/// Signs `msg` with `key`, writing the raw 64-byte Ed25519 signature to `out`.
///
/// # Safety
/// `key` valid; `msg` valid for `msg_len`; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed25519_sign(
    key: *const PcEd25519Key,
    msg: *const u8,
    msg_len: usize,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        let Some(m) = (unsafe { slice(msg, msg_len) }) else {
            return PcStatus::NullPointer;
        };
        let sig = unsafe { &*key }.0.sign(m);
        unsafe { out_write(&sig.to_bytes(), out, out_len) }
    })
}

/// Verifies a raw 64-byte Ed25519 signature `sig` over `msg` under the SPKI
/// (PKIX `PUBLIC KEY`) DER in `spki`. Returns [`PcStatus::Ok`] iff valid.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed25519_verify(
    spki: *const u8,
    spki_len: usize,
    msg: *const u8,
    msg_len: usize,
    sig: *const u8,
    sig_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(spki), Some(m), Some(sig)) = (
            unsafe { slice(spki, spki_len) },
            unsafe { slice(msg, msg_len) },
            unsafe { slice(sig, sig_len) },
        ) else {
            return PcStatus::NullPointer;
        };
        let key = match AnyPublicKey::from_spki_der(spki) {
            Ok(AnyPublicKey::Ed25519(k)) => k,
            Ok(_) => return PcStatus::Unsupported,
            Err(_) => return PcStatus::BadEncoding,
        };
        let Ok(bytes) = <[u8; 64]>::try_from(sig) else {
            return PcStatus::BadEncoding;
        };
        if key.verify(m, &Ed25519Signature::from_bytes(bytes)).is_ok() {
            PcStatus::Ok
        } else {
            PcStatus::Verification
        }
    })
}

/// Frees an Ed25519 key. NULL is ignored.
///
/// # Safety
/// `key` from [`pc_ed25519_generate`]/[`pc_ed25519_from_pem`], not freed twice.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed25519_free(key: *mut PcEd25519Key) {
    if !key.is_null() {
        drop(unsafe { Box::from_raw(key) });
    }
}

/// An opaque Ed448 private key.
pub struct PcEd448Key(Ed448PrivateKey);

/// Generates an Ed448 key, or NULL on failure.
#[unsafe(no_mangle)]
pub extern "C" fn pc_ed448_generate() -> *mut PcEd448Key {
    crate::ffi::common::guard_ptr(|| {
        Box::into_raw(Box::new(PcEd448Key(Ed448PrivateKey::generate(&mut OsRng))))
    })
}

/// Parses a PKCS#8 `PRIVATE KEY` PEM into an Ed448 key handle, or NULL.
///
/// # Safety
/// `pem` must be valid for `len` bytes.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed448_from_pem(pem: *const u8, len: usize) -> *mut PcEd448Key {
    crate::ffi::common::guard_ptr(|| {
        let Some(bytes) = (unsafe { slice(pem, len) }) else {
            return core::ptr::null_mut();
        };
        let Ok(s) = core::str::from_utf8(bytes) else {
            return core::ptr::null_mut();
        };
        match Ed448PrivateKey::from_pkcs8_pem(s) {
            Ok(k) => Box::into_raw(Box::new(PcEd448Key(k))),
            Err(_) => core::ptr::null_mut(),
        }
    })
}

/// Writes the key as a PKCS#8 `PRIVATE KEY` PEM string to `out`.
///
/// # Safety
/// `key` valid; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed448_private_to_pem(
    key: *const PcEd448Key,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        // The PEM is a re-encoding of the private key; wipe the temporary
        // before its backing storage returns to the allocator.
        let mut pem = unsafe { &*key }.0.to_pkcs8_pem().into_bytes();
        let st = unsafe { out_write(&pem, out, out_len) };
        wipe_vec(&mut pem);
        st
    })
}

/// Writes the public key as a PKIX `PUBLIC KEY` (SPKI) PEM string to `out`.
///
/// # Safety
/// `key` valid; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed448_public_to_pem(
    key: *const PcEd448Key,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        let pem = AnyPublicKey::Ed448(unsafe { &*key }.0.public_key()).to_spki_pem();
        unsafe { out_write(pem.as_bytes(), out, out_len) }
    })
}

/// Signs `msg` with `key`, writing the raw 114-byte Ed448 signature to `out`.
/// The empty context is used (pure Ed448, RFC 8032 §5.2).
///
/// # Safety
/// `key` valid; `msg` valid for `msg_len`; buffer rules for `out`.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed448_sign(
    key: *const PcEd448Key,
    msg: *const u8,
    msg_len: usize,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        if key.is_null() {
            return PcStatus::NullPointer;
        }
        let Some(m) = (unsafe { slice(msg, msg_len) }) else {
            return PcStatus::NullPointer;
        };
        let sig = unsafe { &*key }.0.sign(m);
        unsafe { out_write(&sig.to_bytes(), out, out_len) }
    })
}

/// Verifies a raw 114-byte Ed448 signature `sig` over `msg` under the SPKI
/// (PKIX `PUBLIC KEY`) DER in `spki`. Returns [`PcStatus::Ok`] iff valid.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed448_verify(
    spki: *const u8,
    spki_len: usize,
    msg: *const u8,
    msg_len: usize,
    sig: *const u8,
    sig_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(spki), Some(m), Some(sig)) = (
            unsafe { slice(spki, spki_len) },
            unsafe { slice(msg, msg_len) },
            unsafe { slice(sig, sig_len) },
        ) else {
            return PcStatus::NullPointer;
        };
        let key = match AnyPublicKey::from_spki_der(spki) {
            Ok(AnyPublicKey::Ed448(k)) => k,
            Ok(_) => return PcStatus::Unsupported,
            Err(_) => return PcStatus::BadEncoding,
        };
        let Ok(bytes) = <[u8; 114]>::try_from(sig) else {
            return PcStatus::BadEncoding;
        };
        if key.verify(m, &Ed448Signature::from_bytes(bytes)).is_ok() {
            PcStatus::Ok
        } else {
            PcStatus::Verification
        }
    })
}

/// Frees an Ed448 key. NULL is ignored.
///
/// # Safety
/// `key` from [`pc_ed448_generate`]/[`pc_ed448_from_pem`], not freed twice.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ed448_free(key: *mut PcEd448Key) {
    if !key.is_null() {
        drop(unsafe { Box::from_raw(key) });
    }
}

/// Derives an ECDH shared secret using the SEC1-encoded private scalar `priv_be`
/// (big-endian, `field_len(curve)` bytes) and the peer's SPKI DER. Writes the
/// raw shared secret (the affine x-coordinate, `field_len` bytes) to `out`.
///
/// # Safety
/// All pointers valid for their declared lengths; `out_len` non-NULL.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_ecdh(
    curve_id: i32,
    priv_be: *const u8,
    priv_len: usize,
    peer_spki: *const u8,
    peer_spki_len: usize,
    out: *mut u8,
    out_len: *mut usize,
) -> PcStatus {
    guard(|| {
        let Some(curve) = curve_from_id(curve_id) else {
            return PcStatus::Unsupported;
        };
        let (Some(d), Some(spki)) = (unsafe { slice(priv_be, priv_len) }, unsafe {
            slice(peer_spki, peer_spki_len)
        }) else {
            return PcStatus::NullPointer;
        };
        let sk = match BoxedEcdhPrivateKey::from_bytes(curve, d) {
            Ok(s) => s,
            Err(_) => return PcStatus::BadEncoding,
        };
        let peer: BoxedEcdsaPublicKey = match AnyPublicKey::from_spki_der(spki) {
            Ok(AnyPublicKey::Ecdsa(k)) if k.curve() == curve => k,
            Ok(AnyPublicKey::Ecdsa(_)) => return PcStatus::Unsupported,
            Ok(_) => return PcStatus::Unsupported,
            Err(_) => return PcStatus::BadEncoding,
        };
        let mut secret = match sk.diffie_hellman(&peer) {
            Ok(s) => s,
            Err(_) => return PcStatus::Verification,
        };
        // Capture the status, then wipe the shared secret before its Vec is
        // dropped so the bytes don't linger in a freed allocation — including
        // on the `out_write` failure path (e.g. BufferTooSmall). Mirrors
        // `pc_sm2_decrypt` / `pc_rsa_decrypt_oaep`.
        let st = unsafe { out_write(&secret, out, out_len) };
        wipe_vec(&mut secret);
        st
    })
}