gmssl-rs 0.1.1

Safe, idiomatic Rust wrapper for the GmSSL cryptographic library (SM2/SM3/SM4/SM9/ZUC/X.509)
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
// SM9 identity-based cryptography.
//
// SM9 (GM/T 0044-2016) supports identity-based signatures (IBS) and
// identity-based encryption (IBE) using bilinear pairings on BN curves.

use std::mem::MaybeUninit;
use gmssl_rs_sys;

use crate::error::{ok_or_library_error, verify_result, GmsslError};
use crate::pem_helpers;

// ============================================================================
// SM9 Sign Master Key (held by KGC)
// ============================================================================

pub struct Sm9SignMasterKey {
    key: gmssl_rs_sys::SM9_SIGN_MASTER_KEY,
}

impl std::fmt::Debug for Sm9SignMasterKey {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Sm9SignMasterKey").finish()
    }
}

impl Sm9SignMasterKey {
    /// Generate a new SM9 signature master key.
    pub fn generate() -> Result<Self, GmsslError> {
        let mut key = MaybeUninit::uninit();
        ok_or_library_error(
            unsafe { gmssl_rs_sys::sm9_sign_master_key_generate(key.as_mut_ptr()) },
            "sm9_sign_master_key_generate",
        )?;
        Ok(Sm9SignMasterKey {
            key: unsafe { key.assume_init() },
        })
    }

    /// Extract a user's signing private key from the master key.
    pub fn extract_key(&self, id: &str) -> Result<Sm9SignKey, GmsslError> {
        let id_c = std::ffi::CString::new(id)
            .map_err(|_| GmsslError::InvalidInput("ID contains NUL byte"))?;
        let mut key = MaybeUninit::uninit();
        ok_or_library_error(
            unsafe {
                gmssl_rs_sys::sm9_sign_master_key_extract_key(
                    &self.key,
                    id_c.as_ptr(),
                    id.len(),
                    key.as_mut_ptr(),
                )
            },
            "sm9_sign_master_key_extract_key",
        )?;
        Ok(Sm9SignKey {
            key: unsafe { key.assume_init() },
            id: id.to_string(),
        })
    }

    /// Import from encrypted PEM (in-memory).
    pub fn from_encrypted_pem(pem_data: &[u8], password: &str) -> Result<Self, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        let mut key = MaybeUninit::uninit();
        let fp = unsafe { pem_helpers::file_from_bytes(pem_data)? };
        let ret = unsafe {
            gmssl_rs_sys::sm9_sign_master_key_info_decrypt_from_pem(
                key.as_mut_ptr(),
                pass_c.as_ptr(),
                fp,
            )
        };
        unsafe { libc::fclose(fp) };
        ok_or_library_error(ret, "sm9_sign_master_key_info_decrypt_from_pem")?;
        Ok(Sm9SignMasterKey {
            key: unsafe { key.assume_init() },
        })
    }

    /// Export to encrypted PEM (in-memory).
    pub fn to_encrypted_pem(&self, password: &str) -> Result<Vec<u8>, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        unsafe {
            pem_helpers::collect_to_bytes(|fp| {
                gmssl_rs_sys::sm9_sign_master_key_info_encrypt_to_pem(
                    &self.key,
                    pass_c.as_ptr(),
                    fp,
                )
            })
        }
    }
}

// ============================================================================
// SM9 Sign User Key
// ============================================================================

pub struct Sm9SignKey {
    key: gmssl_rs_sys::SM9_SIGN_KEY,
    id: String,
}

impl std::fmt::Debug for Sm9SignKey {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Sm9SignKey").field("id", &self.id).finish()
    }
}

impl Sm9SignKey {
    /// Get the user identity associated with this key.
    pub fn id(&self) -> &str {
        &self.id
    }

    /// Import from encrypted PEM (in-memory).
    pub fn from_encrypted_pem(pem_data: &[u8], password: &str) -> Result<Self, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        let mut key = MaybeUninit::uninit();
        let fp = unsafe { pem_helpers::file_from_bytes(pem_data)? };
        let ret = unsafe {
            gmssl_rs_sys::sm9_sign_key_info_decrypt_from_pem(
                key.as_mut_ptr(),
                pass_c.as_ptr(),
                fp,
            )
        };
        unsafe { libc::fclose(fp) };
        ok_or_library_error(ret, "sm9_sign_key_info_decrypt_from_pem")?;
        Ok(Sm9SignKey {
            key: unsafe { key.assume_init() },
            id: String::new(), // PEM doesn't encode the ID
        })
    }

    /// Export to encrypted PEM (in-memory).
    pub fn to_encrypted_pem(&self, password: &str) -> Result<Vec<u8>, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        unsafe {
            pem_helpers::collect_to_bytes(|fp| {
                gmssl_rs_sys::sm9_sign_key_info_encrypt_to_pem(
                    &self.key,
                    pass_c.as_ptr(),
                    fp,
                )
            })
        }
    }
}

// ============================================================================
// SM9 Sign/Verify
// ============================================================================

/// Sign a message using an SM9 signing key.
pub fn sm9_sign(key: &Sm9SignKey, data: &[u8]) -> Result<Vec<u8>, GmsslError> {
    let mut ctx = MaybeUninit::uninit();
    ok_or_library_error(
        unsafe { gmssl_rs_sys::sm9_sign_init(ctx.as_mut_ptr()) },
        "sm9_sign_init",
    )?;
    ok_or_library_error(
        unsafe { gmssl_rs_sys::sm9_sign_update(ctx.as_mut_ptr(), data.as_ptr(), data.len()) },
        "sm9_sign_update",
    )?;

    let mut sig = vec![0u8; 256];
    let mut siglen: usize = sig.len();
    ok_or_library_error(
        unsafe {
            gmssl_rs_sys::sm9_sign_finish(
                ctx.as_mut_ptr(),
                &key.key,
                sig.as_mut_ptr(),
                &mut siglen,
            )
        },
        "sm9_sign_finish",
    )?;
    // GmSSL sets *siglen = 0 before DER encoding, causing size_t wrap.
    // Recover actual size from ASN.1 SEQUENCE header.
    truncate_der_sequence(&mut sig);
    Ok(sig)
}

/// Verify an SM9 signature.
pub fn sm9_verify(
    mpk: &Sm9SignMasterKey,
    id: &str,
    data: &[u8],
    sig: &[u8],
) -> Result<bool, GmsslError> {
    let id_c = std::ffi::CString::new(id)
        .map_err(|_| GmsslError::InvalidInput("ID contains NUL byte"))?;

    let mut ctx = MaybeUninit::uninit();
    ok_or_library_error(
        unsafe { gmssl_rs_sys::sm9_verify_init(ctx.as_mut_ptr()) },
        "sm9_verify_init",
    )?;
    ok_or_library_error(
        unsafe { gmssl_rs_sys::sm9_verify_update(ctx.as_mut_ptr(), data.as_ptr(), data.len()) },
        "sm9_verify_update",
    )?;

    verify_result(
        unsafe {
            gmssl_rs_sys::sm9_verify_finish(
                ctx.as_mut_ptr(),
                sig.as_ptr(),
                sig.len(),
                &mpk.key,
                id_c.as_ptr(),
                id.len(),
            )
        },
        "sm9_verify_finish",
    )
}

// ============================================================================
// SM9 Enc Master Key (held by KGC)
// ============================================================================

pub struct Sm9EncMasterKey {
    key: gmssl_rs_sys::SM9_ENC_MASTER_KEY,
}

impl std::fmt::Debug for Sm9EncMasterKey {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Sm9EncMasterKey").finish()
    }
}

impl Sm9EncMasterKey {
    /// Generate a new SM9 encryption master key.
    pub fn generate() -> Result<Self, GmsslError> {
        let mut key = MaybeUninit::uninit();
        ok_or_library_error(
            unsafe { gmssl_rs_sys::sm9_enc_master_key_generate(key.as_mut_ptr()) },
            "sm9_enc_master_key_generate",
        )?;
        Ok(Sm9EncMasterKey {
            key: unsafe { key.assume_init() },
        })
    }

    /// Extract a user's decryption private key from the master key.
    pub fn extract_key(&self, id: &str) -> Result<Sm9EncKey, GmsslError> {
        let id_c = std::ffi::CString::new(id)
            .map_err(|_| GmsslError::InvalidInput("ID contains NUL byte"))?;
        let mut key = MaybeUninit::uninit();
        ok_or_library_error(
            unsafe {
                gmssl_rs_sys::sm9_enc_master_key_extract_key(
                    &self.key,
                    id_c.as_ptr(),
                    id.len(),
                    key.as_mut_ptr(),
                )
            },
            "sm9_enc_master_key_extract_key",
        )?;
        Ok(Sm9EncKey {
            key: unsafe { key.assume_init() },
            id: id.to_string(),
        })
    }

    /// Import from encrypted PEM (in-memory).
    pub fn from_encrypted_pem(pem_data: &[u8], password: &str) -> Result<Self, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        let mut key = MaybeUninit::uninit();
        let fp = unsafe { pem_helpers::file_from_bytes(pem_data)? };
        let ret = unsafe {
            gmssl_rs_sys::sm9_enc_master_key_info_decrypt_from_pem(
                key.as_mut_ptr(),
                pass_c.as_ptr(),
                fp,
            )
        };
        unsafe { libc::fclose(fp) };
        ok_or_library_error(ret, "sm9_enc_master_key_info_decrypt_from_pem")?;
        Ok(Sm9EncMasterKey {
            key: unsafe { key.assume_init() },
        })
    }

    /// Export to encrypted PEM (in-memory).
    pub fn to_encrypted_pem(&self, password: &str) -> Result<Vec<u8>, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        unsafe {
            pem_helpers::collect_to_bytes(|fp| {
                gmssl_rs_sys::sm9_enc_master_key_info_encrypt_to_pem(
                    &self.key,
                    pass_c.as_ptr(),
                    fp,
                )
            })
        }
    }
}

// ============================================================================
// SM9 Enc User Key
// ============================================================================

pub struct Sm9EncKey {
    key: gmssl_rs_sys::SM9_ENC_KEY,
    id: String,
}

impl std::fmt::Debug for Sm9EncKey {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Sm9EncKey").field("id", &self.id).finish()
    }
}

impl Sm9EncKey {
    /// Get the user identity associated with this key.
    pub fn id(&self) -> &str {
        &self.id
    }

    /// Import from encrypted PEM (in-memory).
    pub fn from_encrypted_pem(pem_data: &[u8], password: &str) -> Result<Self, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        let mut key = MaybeUninit::uninit();
        let fp = unsafe { pem_helpers::file_from_bytes(pem_data)? };
        let ret = unsafe {
            gmssl_rs_sys::sm9_enc_key_info_decrypt_from_pem(
                key.as_mut_ptr(),
                pass_c.as_ptr(),
                fp,
            )
        };
        unsafe { libc::fclose(fp) };
        ok_or_library_error(ret, "sm9_enc_key_info_decrypt_from_pem")?;
        Ok(Sm9EncKey {
            key: unsafe { key.assume_init() },
            id: String::new(),
        })
    }

    /// Export to encrypted PEM (in-memory).
    pub fn to_encrypted_pem(&self, password: &str) -> Result<Vec<u8>, GmsslError> {
        let pass_c = std::ffi::CString::new(password)
            .map_err(|_| GmsslError::InvalidInput("password contains NUL byte"))?;
        unsafe {
            pem_helpers::collect_to_bytes(|fp| {
                gmssl_rs_sys::sm9_enc_key_info_encrypt_to_pem(
                    &self.key,
                    pass_c.as_ptr(),
                    fp,
                )
            })
        }
    }
}

// ============================================================================
// SM9 Encrypt/Decrypt
// ============================================================================

/// Encrypt data for a recipient identified by `id` using the master public key.
pub fn sm9_encrypt(
    mpk: &Sm9EncMasterKey,
    id: &str,
    data: &[u8],
) -> Result<Vec<u8>, GmsslError> {
    if data.len() > gmssl_rs_sys::SM9_MAX_PLAINTEXT_SIZE {
        return Err(GmsslError::InvalidInput(
            "SM9 plaintext exceeds 255 bytes maximum",
        ));
    }
    let id_c = std::ffi::CString::new(id)
        .map_err(|_| GmsslError::InvalidInput("ID contains NUL byte"))?;

    let mut out = vec![0u8; gmssl_rs_sys::SM9_MAX_CIPHERTEXT_SIZE];
    let mut outlen: usize = out.len();
    ok_or_library_error(
        unsafe {
            gmssl_rs_sys::sm9_encrypt(
                &mpk.key,
                id_c.as_ptr(),
                id.len(),
                data.as_ptr(),
                data.len(),
                out.as_mut_ptr(),
                &mut outlen,
            )
        },
        "sm9_encrypt",
    )?;
    // GmSSL sets *outlen = 0 before DER encoding, causing size_t wrap.
    // Recover actual size from ASN.1 SEQUENCE header.
    truncate_der_sequence(&mut out);
    Ok(out)
}

/// Decrypt data using the user's private key.
pub fn sm9_decrypt(key: &Sm9EncKey, id: &str, ciphertext: &[u8]) -> Result<Vec<u8>, GmsslError> {
    let id_c = std::ffi::CString::new(id)
        .map_err(|_| GmsslError::InvalidInput("ID contains NUL byte"))?;

    let mut out = vec![0u8; ciphertext.len()];
    let mut outlen: usize = out.len();
    ok_or_library_error(
        unsafe {
            gmssl_rs_sys::sm9_decrypt(
                &key.key,
                id_c.as_ptr(),
                id.len(),
                ciphertext.as_ptr(),
                ciphertext.len(),
                out.as_mut_ptr(),
                &mut outlen,
            )
        },
        "sm9_decrypt",
    )?;
    out.truncate(outlen);
    Ok(out)
}

/// Truncate a Vec containing a DER SEQUENCE to its actual encoded size.
fn truncate_der_sequence(data: &mut Vec<u8>) {
    if data.len() >= 2 && data[0] == 0x30 {
        let content_len = data[1] as usize;
        let total = if content_len < 0x80 {
            2 + content_len
        } else if content_len == 0x81 && data.len() >= 3 {
            2 + 1 + data[2] as usize
        } else if content_len == 0x82 && data.len() >= 4 {
            let l = u16::from_be_bytes([data[2], data[3]]) as usize;
            2 + 2 + l
        } else {
            return;
        };
        if total <= data.len() {
            data.truncate(total);
        }
    }
}

#[cfg(test)]
mod tests;