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
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
/*
* gmcrypto-c — C ABI for gmcrypto-core (pure-Rust SM2/SM3/SM4 SDK).
*
* AUTO-GENERATED by cbindgen. DO NOT EDIT BY HAND.
* Regenerate via: cargo build -p gmcrypto-c --features regen-header
*
* Failure-mode invariant (v0.4 W4 / Q4.8 of docs/v0.4-scope.md):
* every int return is 0 on success, non-zero on failure. Non-zero
* codes are NOT enumerated — they are equivalent `Failed` per the
* crate's failure-mode discipline.
*/
/* Warning: this file is auto-generated by cbindgen; do not edit. */
/*
Success return code.
*/
/*
Generic failure return code. All non-zero returns are equivalent
per the failure-mode invariant; this constant exists only as a
convenience for C callers that want a named symbol for the
not-success case.
*/
/*
SM3 digest output size in bytes (32 = 256 bits).
*/
/*
SM4 block size in bytes (16 = 128 bits).
*/
/*
SM4 key size in bytes (16 = 128 bits).
*/
/*
SEC1 uncompressed-point size for SM2 public keys
(`04 || X || Y` = 65 bytes).
*/
/*
SM2 private-key scalar size in bytes (32 = 256 bits big-endian).
*/
/*
Opaque handle for a streaming HMAC-SM3 keyed MAC.
*/
typedef struct gmcrypto_hmac_sm3_t gmcrypto_hmac_sm3_t;
/*
Opaque handle for an SM2 private key.
*/
typedef struct gmcrypto_sm2_privkey_t gmcrypto_sm2_privkey_t;
/*
Opaque handle for an SM2 public key.
*/
typedef struct gmcrypto_sm2_pubkey_t gmcrypto_sm2_pubkey_t;
/*
Opaque handle for a streaming SM3 hasher.
*/
typedef struct gmcrypto_sm3_t gmcrypto_sm3_t;
/*
Opaque handle for a streaming SM4-CBC decryptor (v0.5 W1). Same
buffer-back-by-one padding-oracle defense as the v0.3 W5 Rust
streaming surface: the most recent decrypted block is held back
from emission until [`gmcrypto_sm4_cbc_decryptor_finalize`]
confirms it is the last block and validates the PKCS#7 padding.
*/
typedef struct gmcrypto_sm4_cbc_decryptor_t gmcrypto_sm4_cbc_decryptor_t;
/*
Opaque handle for a streaming SM4-CBC encryptor (v0.5 W1).
Construct with [`gmcrypto_sm4_cbc_encryptor_new`], feed plaintext via
[`gmcrypto_sm4_cbc_encryptor_update`], emit the trailing PKCS#7-
padded block(s) via [`gmcrypto_sm4_cbc_encryptor_finalize`].
*/
typedef struct gmcrypto_sm4_cbc_encryptor_t gmcrypto_sm4_cbc_encryptor_t;
/*
Opaque handle for an SM4 cipher (key-scheduled).
*/
typedef struct gmcrypto_sm4_t gmcrypto_sm4_t;
/*
C ABI function pointer for caller-supplied RNG. Returns `0` on
success and non-zero on failure. See module-level docs for the
full contract.
*/
typedef int ;
/*
Returns a NUL-terminated string with the `gmcrypto-c` version
(e.g. `"0.4.0"`). The returned pointer is to a static `&'static
CStr` and must NOT be freed by the caller.
*/
const char *;
/*
Single-shot SM3 hash. Writes 32 bytes to `out_digest`.
# Returns
[`GMCRYPTO_OK`] on success; [`GMCRYPTO_ERR`] on invalid input
(null `out_digest`, null `msg` with non-zero `msg_len`).
*/
int ;
/*
Construct a fresh streaming SM3 hasher. Returns an opaque handle;
must be freed via [`gmcrypto_sm3_free`].
Returns NULL on allocation failure.
*/
gmcrypto_sm3_t *;
/*
Absorb `data` into the streaming SM3 hasher.
*/
int ;
/*
Consume the streaming SM3 hasher and write the digest to
`out_digest`. The handle is **freed** by this call; do not call
[`gmcrypto_sm3_free`] on it afterwards.
*/
int ;
/*
Free a streaming SM3 hasher. Passing NULL is a no-op.
*/
void ;
/*
Single-shot HMAC-SM3. Writes 32 bytes to `out_tag`.
*/
int ;
/*
Construct a fresh streaming HMAC-SM3 instance keyed with `key`.
Returns NULL on invalid input.
*/
gmcrypto_hmac_sm3_t *;
/*
Absorb `data` into the streaming HMAC-SM3 instance.
*/
int ;
/*
Consume the streaming HMAC-SM3 instance and write the 32-byte tag
to `out_tag`. The handle is **freed** by this call.
*/
int ;
/*
Consume the streaming HMAC-SM3 instance and verify the candidate
tag in constant time. Returns [`GMCRYPTO_OK`] on match;
[`GMCRYPTO_ERR`] on mismatch. The handle is **freed** by this call.
*/
int ;
/*
Free a streaming HMAC-SM3 instance. NULL is a no-op.
*/
void ;
/*
Derive `out_len` bytes via PBKDF2-HMAC-SM3 over `(pwd, salt,
iterations)`. Writes into the caller-supplied `out` buffer.
*/
int ;
/*
Construct an SM4 cipher from a 16-byte key. Returns NULL on null
key.
*/
gmcrypto_sm4_t *;
/*
Encrypt one 16-byte block in place under the SM4 cipher.
*/
int ;
/*
Decrypt one 16-byte block in place under the SM4 cipher.
*/
int ;
/*
Free an SM4 cipher. NULL is a no-op.
*/
void ;
/*
SM4-CBC single-shot encrypt with PKCS#7 padding. IV must be
caller-supplied and unpredictable (per NIST SP 800-38A
Appendix C). Output length is always `((pt_len / 16) + 1) * 16`.
*/
int ;
/*
SM4-CBC single-shot decrypt. Single-`Failed` return on any
failure mode (length not multiple of 16, bad padding, key/IV
mismatch) per the failure-mode invariant.
*/
int ;
/*
Construct a streaming SM4-CBC encryptor. `key` is exactly 16
bytes; `iv` is exactly 16 bytes and MUST be caller-supplied
unpredictable bytes (NIST SP 800-38A Appendix C). Returns NULL
on invalid pointer input.
*/
gmcrypto_sm4_cbc_encryptor_t *;
/*
Absorb plaintext into the streaming SM4-CBC encryptor and emit
zero or more full ciphertext blocks. The caller-allocated `out`
buffer MUST be at least `pt_len + 16` bytes — that is the upper
bound on bytes emitted by a single `_update` call (a buffered
partial block from a prior call can produce one extra block when
this call's input fills it). On insufficient capacity, the call
returns [`GMCRYPTO_ERR`] and the encryptor state is left mid-
stream (the ciphertext bytes that would have been emitted are
lost). Callers should size the output buffer correctly up-front.
*/
int ;
/*
Apply PKCS#7 padding to the buffered tail and emit the final
ciphertext block(s). Consumes the encryptor — the handle is
**freed** by this call; do NOT call
[`gmcrypto_sm4_cbc_encryptor_free`] on it afterwards.
Output is always exactly one block (16 bytes).
*/
int ;
/*
Free a streaming SM4-CBC encryptor. Passing NULL is a no-op. Do
NOT call after [`gmcrypto_sm4_cbc_encryptor_finalize`] — that
already consumed the handle.
*/
void ;
/*
Construct a streaming SM4-CBC decryptor. `key` is exactly 16
bytes; `iv` is exactly 16 bytes and must match the value used
during encryption. Returns NULL on invalid pointer input.
*/
gmcrypto_sm4_cbc_decryptor_t *;
/*
Absorb ciphertext into the streaming SM4-CBC decryptor and emit
zero or more full plaintext blocks. The final-candidate block is
HELD BACK from emission until `_finalize` validates the trailing
padding (buffer-back-by-one padding-oracle defense). Same buffer-
size contract as the encryptor's `_update`: caller MUST allocate
`out_capacity >= ct_len + 16` (strict upper bound on bytes emitted
in one call). On insufficient capacity returns [`GMCRYPTO_ERR`]
and the decryptor state is left mid-stream; size the buffer
up-front.
*/
int ;
/*
Strip PKCS#7 padding from the held-back final block and emit the
last plaintext bytes. Consumes the decryptor — the handle is
**freed** by this call; do NOT call
[`gmcrypto_sm4_cbc_decryptor_free`] on it afterwards.
Returns [`GMCRYPTO_ERR`] on any failure mode (length not multiple
of 16, no full blocks seen, or padding-strip rejection) — single
uninformative failure code per the failure-mode invariant. The
caller-supplied `out_actual_len` is set to `0` on failure.
*/
int ;
/*
Free a streaming SM4-CBC decryptor. Passing NULL is a no-op. Do
NOT call after [`gmcrypto_sm4_cbc_decryptor_finalize`] — that
already consumed the handle.
*/
void ;
/*
SM4-GCM single-shot encrypt. `ct_out` receives `pt_len` bytes (via
the capacity/actual-len convention); `tag_out` receives exactly 16
bytes. Returns [`GMCRYPTO_OK`] / [`GMCRYPTO_ERR`].
*/
int ;
/*
SM4-GCM single-shot decrypt with a 16-byte tag. `pt_out` receives
`ct_len` bytes. Returns [`GMCRYPTO_OK`] only if the tag verifies;
[`GMCRYPTO_ERR`] on any failure (single failure mode).
*/
int ;
/*
SM4-GCM encrypt with a truncated tag. `tag_len` must be in
`{4, 8, 12, 13, 14, 15, 16}`; `tag_out` receives `tag_len` bytes.
Invalid `tag_len` → [`GMCRYPTO_ERR`].
*/
int ;
/*
SM4-GCM decrypt with a truncated tag. `tag` is `tag_len` bytes;
`tag_len` must be in `{4, 8, 12, 13, 14, 15, 16}`. `pt_out`
receives `ct_len` bytes. [`GMCRYPTO_ERR`] on any failure.
*/
int ;
/*
SM4-CCM single-shot encrypt. `tag_len` must be in
`{4, 6, 8, 10, 12, 14, 16}`; `nonce_len` in `[7, 13]`. `out`
receives `pt_len + tag_len` bytes (`ciphertext ‖ tag`). Invalid
parameters → [`GMCRYPTO_ERR`].
*/
int ;
/*
SM4-CCM single-shot decrypt. Input `ct` is `ct_len` bytes
(`ciphertext ‖ tag`); `tag_len` must match the value used at
encrypt time. `pt_out` receives `ct_len - tag_len` bytes.
[`GMCRYPTO_ERR`] on any failure (single failure mode).
*/
int ;
/*
Construct an SM2 private key from a 32-byte big-endian scalar.
Returns NULL on out-of-range scalar (must be in `[1, n-2]`).
*/
gmcrypto_sm2_privkey_t *;
/*
Construct an SM2 public key from a SEC1 uncompressed-point byte
string (`04 || X || Y`, 65 bytes). Returns NULL on
invalid input (off-curve, identity point, non-uncompressed
prefix).
*/
gmcrypto_sm2_pubkey_t *;
/*
Export the SM2 private key as a 32-byte big-endian scalar.
**Caller MUST zeroize the output buffer** after use. Per Q4.19,
this entry point exists as `#[doc(hidden)]`-equivalent on the
Rust side and is NOT SemVer-stable across v0.4.x.
*/
int ;
/*
Export the SM2 public key as a SEC1 uncompressed-point byte
string (`04 || X || Y`, 65 bytes).
*/
int ;
/*
Free an SM2 private key. NULL is a no-op. The inner scalar is
zeroized via `ZeroizeOnDrop` before the heap slot is freed.
*/
void ;
/*
Free an SM2 public key. NULL is a no-op.
*/
void ;
/*
Emit a password-encrypted PKCS#8 PEM blob containing the SM2
private key. PBES2 / PBKDF2-HMAC-SM3 / SM4-CBC per RFC 8018.
*/
int ;
/*
Load an SM2 private key from a password-encrypted PKCS#8 PEM blob.
On success, writes the new handle to `*out_key` and returns
[`GMCRYPTO_OK`]. Caller MUST free via [`gmcrypto_sm2_privkey_free`].
*/
int ;
/*
Sign `msg` with the SM2 private key using the supplied
`signer_id` (or [`DEFAULT_SIGNER_ID`] = `"1234567812345678"` if
`signer_id_len == 0`). Output is DER-encoded
`SEQUENCE { r, s }`. RNG is sourced from `getrandom::SysRng`.
*/
int ;
/*
Verify a DER-encoded `(r, s)` signature against `msg` using the
SM2 public key and `signer_id`. Returns [`GMCRYPTO_OK`] on
valid; [`GMCRYPTO_ERR`] on invalid or any error.
*/
int ;
/*
SM2 public-key encrypt. Output is GM/T 0009-2012 DER. RNG from
`getrandom::SysRng`.
*/
int ;
/*
SM2 private-key decrypt of a GM/T 0009-2012 DER ciphertext.
*/
int ;
/*
SM2 public-key encrypt; output in the modern raw byte-concat
`C1 || C3 || C2` format. `C1` is the 65-byte SEC1-uncompressed
point (`0x04 || X || Y`); `C3` is the 32-byte SM3 MAC; `C2` is
`msg_len` bytes of XOR-ed ciphertext. Output length is exactly
`65 + 32 + msg_len`.
RNG is sourced from `getrandom::SysRng` internally (same as
[`gmcrypto_sm2_encrypt`]). The W3 RNG-callback variant lands as a
separate workstream.
Same failure-mode posture as [`gmcrypto_sm2_encrypt`]: single
[`GMCRYPTO_ERR`] on any failure mode (identity public key, KDF-
zero retries exhausted).
*/
int ;
/*
SM2 private-key decrypt of a modern raw byte-concat
`C1 || C3 || C2` ciphertext. Input length must be at least
`65 + 32 + 1 = 98` bytes (C1 + C3 + at least one C2 byte).
Same failure-mode posture as [`gmcrypto_sm2_decrypt`]: single
[`GMCRYPTO_ERR`] on any failure mode (malformed input, off-curve
C1, identity C1, MAC mismatch, or KDF-zero detection). Caller
cannot distinguish wrong-key from corrupt-ciphertext via timing
or return code.
*/
int ;
/*
SM2 private-key decrypt of a **legacy** raw byte-concat
`C1 || C2 || C3` ciphertext. Decrypt-only — there is no emit path
for the legacy ordering, and there will not be one in any v0.5+
version (per `CLAUDE.md` "Don't" entry).
The two raw byte-concat orderings (`C1 || C3 || C2` modern vs
`C1 || C2 || C3` legacy) are NOT auto-detected. The caller MUST
know which format their wire-data follows. Mis-feeding modern
ciphertext to this entry point or vice-versa will fail at the MAC
check (`GMCRYPTO_ERR`); the failure-mode invariant precludes the
caller from distinguishing wrong-format from wrong-key.
Same failure-mode posture as [`gmcrypto_sm2_decrypt_c1c3c2`]:
single [`GMCRYPTO_ERR`] on any failure.
*/
int ;
/*
`_with_rng` variant of [`gmcrypto_sm2_sign`]. Identical contract
except RNG bytes come from the caller's `rng_callback` rather
than `getrandom::SysRng`.
Returns [`GMCRYPTO_OK`] on success; [`GMCRYPTO_ERR`] on any
failure including:
- null `key` pointer
- null `rng_callback` pointer
- callback returned non-zero on any draw
- signing produced no valid signature within the retry budget
Per the failure-mode invariant, the caller cannot distinguish
callback-error from signing-failure via return code or timing.
*/
int ;
/*
`_with_rng` variant of [`gmcrypto_sm2_encrypt`]. Identical
contract except RNG bytes come from the caller's `rng_callback`
rather than `getrandom::SysRng`.
Output is GM/T 0009-2012 DER (same as `gmcrypto_sm2_encrypt`).
For raw byte-concat output (`C1 || C3 || C2`), use
`gmcrypto_sm2_encrypt_c1c3c2` — v0.5 doesn't ship a
`_c1c3c2_with_rng` combined variant; if needed, callers can
re-encode the DER output via gmcrypto-core's
`asn1::ciphertext::decode` + `raw_ciphertext::encode_c1c3c2`.
Same `GMCRYPTO_ERR`-on-any-failure posture as
`gmcrypto_sm2_sign_with_rng`.
*/
int ;
/* GMCRYPTO_H_ */