pq-key-encoder 1.0.1

Post-quantum key encoding (DER, PEM, JWK) for ML-KEM, ML-DSA, SLH-DSA
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
use alloc::vec::Vec;
use pq_oid::Algorithm;

use crate::asn1::length::{encode_length, encoded_length_size};
use crate::asn1::{algorithm, decode, encode, tags};
use crate::error::{Error, Result};

/// Encode a private key as PKCS8 DER into the given buffer.
/// Zero intermediate allocations — computes total size, then writes directly.
pub(crate) fn encode_pkcs8(algorithm: Algorithm, key_bytes: &[u8], out: &mut Vec<u8>) {
    // Version INTEGER 0: always 3 bytes (02 01 00)
    let version_len: usize = 3;

    let alg_id_len = algorithm::encoded_algorithm_identifier_size(algorithm);

    // OCTET STRING: tag(1) + length + key_bytes
    let octet_len = 1 + encoded_length_size(key_bytes.len()) + key_bytes.len();

    // Outer SEQUENCE content = version + alg_id + octet_string
    let seq_content_len = version_len + alg_id_len + octet_len;
    let total = 1 + encoded_length_size(seq_content_len) + seq_content_len;
    out.reserve(total);

    // Write outer SEQUENCE
    out.push(tags::TAG_SEQUENCE);
    encode_length(seq_content_len, out);

    // Write version INTEGER 0 directly
    encode::encode_integer_zero(out);

    // Write AlgorithmIdentifier directly
    algorithm::encode_algorithm_identifier(algorithm, out);

    // Write OCTET STRING directly
    encode::encode_octet_string(key_bytes, out);
}

/// Decode PKCS8 DER. Returns `(Algorithm, &key_bytes)` borrowing from input.
/// Applies private key normalization automatically.
pub(crate) fn decode_pkcs8(der: &[u8]) -> Result<(Algorithm, &[u8])> {
    // Read outer SEQUENCE
    let outer = decode::read_tlv(der, 0)?;
    if outer.tag != tags::TAG_SEQUENCE {
        return Err(Error::InvalidDer("expected outer SEQUENCE in PKCS8"));
    }
    if outer.bytes_read != der.len() {
        return Err(Error::InvalidDer(
            "trailing data after outer SEQUENCE in PKCS8",
        ));
    }

    let seq = outer.value;

    // Read version INTEGER
    let ver_tlv = decode::read_tlv(seq, 0)?;
    if ver_tlv.tag != tags::TAG_INTEGER {
        return Err(Error::InvalidDer("expected INTEGER version in PKCS8"));
    }
    // Accept version 0 (PKCS#8) or version 1 (OneAsymmetricKey)
    if ver_tlv.value.len() != 1 || (ver_tlv.value[0] != 0 && ver_tlv.value[0] != 1) {
        return Err(Error::InvalidDer(
            "unsupported PrivateKeyInfo version in PKCS8",
        ));
    }
    let version = ver_tlv.value[0];

    // Decode AlgorithmIdentifier
    let (alg, alg_bytes_read) = algorithm::decode_algorithm_identifier(seq, ver_tlv.bytes_read)?;

    // Read OCTET STRING containing the private key
    let key_offset = ver_tlv.bytes_read + alg_bytes_read;
    let key_tlv = decode::read_tlv(seq, key_offset)?;
    if key_tlv.tag != tags::TAG_OCTET_STRING {
        return Err(Error::InvalidDer("expected OCTET STRING in PKCS8"));
    }

    // Skip optional trailing context-tagged fields.
    // RFC 5958: [0] attributes allowed in both versions,
    // [1] publicKey only allowed in version 1 (OneAsymmetricKey).
    let trailing_offset = key_offset + key_tlv.bytes_read;
    let mut offset = trailing_offset;
    while offset < seq.len() {
        let trailing_tlv = decode::read_tlv(seq, offset)?;
        if trailing_tlv.tag == tags::TAG_CONTEXT_0 {
            // [0] attributes — allowed in both versions
        } else if trailing_tlv.tag == tags::TAG_CONTEXT_1
            || trailing_tlv.tag == tags::TAG_CONTEXT_1_IMPLICIT
        {
            // [1] publicKey — constructed (0xA1) or implicit primitive (0x81)
            if version == 0 {
                return Err(Error::InvalidDer(
                    "[1] publicKey not allowed in version 0 PKCS8",
                ));
            }
        } else {
            return Err(Error::InvalidDer(
                "unexpected trailing data in PKCS8 SEQUENCE",
            ));
        }
        offset += trailing_tlv.bytes_read;
    }

    // Normalize private key bytes
    let normalized = normalize_private_key_bytes(alg, key_tlv.value);

    Ok((alg, normalized))
}

/// Normalize private key bytes to handle different encoding formats.
/// Returns a slice borrowing from the input.
pub(crate) fn normalize_private_key_bytes(algorithm: Algorithm, bytes: &[u8]) -> &[u8] {
    let expected = algorithm.private_key_size();

    // Format 1: Direct raw bytes
    if bytes.len() == expected {
        return bytes;
    }

    // Try to parse as TLV
    let tlv = match decode::read_tlv(bytes, 0) {
        Ok(tlv) => tlv,
        Err(_) => return bytes,
    };

    // Format 2: RFC 8410 style — inner OCTET STRING wrapping raw key
    if tlv.tag == tags::TAG_OCTET_STRING
        && tlv.bytes_read == bytes.len()
        && tlv.value.len() == expected
    {
        return tlv.value;
    }

    // Format 3: OpenSSL style — SEQUENCE containing OCTET STRINGs
    if tlv.tag == tags::TAG_SEQUENCE && tlv.bytes_read == bytes.len() {
        let seq_value = tlv.value;
        let mut scan_offset = 0;
        while scan_offset < seq_value.len() {
            let inner = match decode::read_tlv(seq_value, scan_offset) {
                Ok(inner) => inner,
                Err(_) => break,
            };
            if inner.tag == tags::TAG_OCTET_STRING && inner.value.len() == expected {
                return inner.value;
            }
            scan_offset += inner.bytes_read;
        }
    }

    // Fallback: return unchanged
    bytes
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::asn1::length::encode_length;
    use pq_oid::{MlDsa, MlKem, SlhDsa};

    #[test]
    fn test_roundtrip_ml_kem_512() {
        let alg = Algorithm::MlKem(MlKem::Kem512);
        let key_bytes = vec![0xABu8; 1632];
        let mut buf = Vec::new();
        encode_pkcs8(alg, &key_bytes, &mut buf);
        let (decoded_alg, decoded_bytes) = decode_pkcs8(&buf).unwrap();
        assert_eq!(decoded_alg, alg);
        assert_eq!(decoded_bytes, &key_bytes[..]);
    }

    #[test]
    fn test_roundtrip_ml_dsa_44() {
        let alg = Algorithm::MlDsa(MlDsa::Dsa44);
        let key_bytes = vec![0xCDu8; 2560];
        let mut buf = Vec::new();
        encode_pkcs8(alg, &key_bytes, &mut buf);
        let (decoded_alg, decoded_bytes) = decode_pkcs8(&buf).unwrap();
        assert_eq!(decoded_alg, alg);
        assert_eq!(decoded_bytes, &key_bytes[..]);
    }

    #[test]
    fn test_roundtrip_slh_dsa_sha2_128s() {
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let key_bytes = vec![0xEFu8; 64];
        let mut buf = Vec::new();
        encode_pkcs8(alg, &key_bytes, &mut buf);
        let (decoded_alg, decoded_bytes) = decode_pkcs8(&buf).unwrap();
        assert_eq!(decoded_alg, alg);
        assert_eq!(decoded_bytes, &key_bytes[..]);
    }

    #[test]
    fn test_roundtrip_all_algorithms() {
        for alg in Algorithm::all() {
            let key_bytes = vec![0x42u8; alg.private_key_size()];
            let mut buf = Vec::new();
            encode_pkcs8(alg, &key_bytes, &mut buf);
            let (decoded_alg, decoded_bytes) = decode_pkcs8(&buf).unwrap();
            assert_eq!(decoded_alg, alg, "failed for {}", alg);
            assert_eq!(decoded_bytes.len(), key_bytes.len());
        }
    }

    #[test]
    fn test_normalize_direct_raw() {
        let alg = Algorithm::MlKem(MlKem::Kem512);
        let raw = vec![0xAAu8; 1632];
        let result = normalize_private_key_bytes(alg, &raw);
        assert_eq!(result, &raw[..]);
    }

    #[test]
    fn test_normalize_rfc8410_octet_string() {
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let raw = vec![0xBBu8; 64];
        // Wrap in OCTET STRING
        let mut wrapped = Vec::new();
        wrapped.push(tags::TAG_OCTET_STRING);
        encode_length(raw.len(), &mut wrapped);
        wrapped.extend_from_slice(&raw);

        let result = normalize_private_key_bytes(alg, &wrapped);
        assert_eq!(result, &raw[..]);
    }

    #[test]
    fn test_normalize_openssl_sequence() {
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let seed = vec![0xCCu8; 32]; // seed (wrong size)
        let expanded = vec![0xDDu8; 64]; // expanded key (correct size)

        // Build inner: OCTET_STRING(seed) + OCTET_STRING(expanded)
        let mut inner = Vec::new();
        inner.push(tags::TAG_OCTET_STRING);
        encode_length(seed.len(), &mut inner);
        inner.extend_from_slice(&seed);
        inner.push(tags::TAG_OCTET_STRING);
        encode_length(expanded.len(), &mut inner);
        inner.extend_from_slice(&expanded);

        // Wrap in SEQUENCE
        let mut wrapped = Vec::new();
        wrapped.push(tags::TAG_SEQUENCE);
        encode_length(inner.len(), &mut wrapped);
        wrapped.extend_from_slice(&inner);

        let result = normalize_private_key_bytes(alg, &wrapped);
        assert_eq!(result, &expanded[..]);
    }

    #[test]
    fn test_normalize_fallback() {
        let alg = Algorithm::MlKem(MlKem::Kem512);
        let garbage = vec![0xFFu8; 100];
        let result = normalize_private_key_bytes(alg, &garbage);
        assert_eq!(result, &garbage[..]);
    }

    #[test]
    fn test_version0_rejects_public_key_field() {
        // Build a valid version-0 PKCS8 with a [1] publicKey appended
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let key_bytes = vec![0xAAu8; 64];
        let mut valid = Vec::new();
        encode_pkcs8(alg, &key_bytes, &mut valid);

        // Decode the outer SEQUENCE to get its content
        let outer = decode::read_tlv(&valid, 0).unwrap();
        let mut inner = outer.value.to_vec();

        // Append [1] publicKey (context tag 0xA1 with some dummy data)
        let pub_key = [0x01u8; 32];
        inner.push(tags::TAG_CONTEXT_1);
        encode_length(pub_key.len(), &mut inner);
        inner.extend_from_slice(&pub_key);

        // Re-wrap in outer SEQUENCE
        let mut buf = Vec::new();
        buf.push(tags::TAG_SEQUENCE);
        encode_length(inner.len(), &mut buf);
        buf.extend_from_slice(&inner);

        let err = decode_pkcs8(&buf).unwrap_err();
        assert!(
            matches!(err, Error::InvalidDer(msg) if msg.contains("[1] publicKey")),
            "expected [1] publicKey rejection, got: {:?}",
            err
        );
    }

    #[test]
    fn test_version1_accepts_public_key_field() {
        // Build a version-1 PKCS8 with a [1] publicKey appended
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let key_bytes = vec![0xBBu8; 64];

        // Build inner manually with version 1
        let mut inner = Vec::new();
        inner.extend_from_slice(&[0x02, 0x01, 0x01]); // INTEGER 1

        let mut alg_id = Vec::new();
        algorithm::encode_algorithm_identifier(alg, &mut alg_id);
        inner.extend_from_slice(&alg_id);

        let mut octet = Vec::new();
        encode::encode_octet_string(&key_bytes, &mut octet);
        inner.extend_from_slice(&octet);

        // Append [1] publicKey
        let pub_key = [0x01u8; 32];
        inner.push(tags::TAG_CONTEXT_1);
        encode_length(pub_key.len(), &mut inner);
        inner.extend_from_slice(&pub_key);

        // Wrap in outer SEQUENCE
        let mut buf = Vec::new();
        buf.push(tags::TAG_SEQUENCE);
        encode_length(inner.len(), &mut buf);
        buf.extend_from_slice(&inner);

        let (decoded_alg, decoded_bytes) = decode_pkcs8(&buf).unwrap();
        assert_eq!(decoded_alg, alg);
        assert_eq!(decoded_bytes, &key_bytes[..]);
    }

    #[test]
    fn test_version1_accepts_implicit_public_key_tag() {
        // Build a version-1 PKCS8 with implicit [1] publicKey (tag 0x81)
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let key_bytes = vec![0xBBu8; 64];

        let mut inner = Vec::new();
        inner.extend_from_slice(&[0x02, 0x01, 0x01]); // INTEGER 1

        let mut alg_id = Vec::new();
        algorithm::encode_algorithm_identifier(alg, &mut alg_id);
        inner.extend_from_slice(&alg_id);

        let mut octet = Vec::new();
        encode::encode_octet_string(&key_bytes, &mut octet);
        inner.extend_from_slice(&octet);

        // Append [1] publicKey with implicit primitive tag 0x81
        let pub_key = [0x01u8; 32];
        inner.push(tags::TAG_CONTEXT_1_IMPLICIT);
        encode_length(pub_key.len(), &mut inner);
        inner.extend_from_slice(&pub_key);

        let mut buf = Vec::new();
        buf.push(tags::TAG_SEQUENCE);
        encode_length(inner.len(), &mut buf);
        buf.extend_from_slice(&inner);

        let (decoded_alg, decoded_bytes) = decode_pkcs8(&buf).unwrap();
        assert_eq!(decoded_alg, alg);
        assert_eq!(decoded_bytes, &key_bytes[..]);
    }

    #[test]
    fn test_version0_rejects_implicit_public_key_tag() {
        // Build a version-0 PKCS8 with implicit [1] publicKey (tag 0x81) — must reject
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let key_bytes = vec![0xAAu8; 64];
        let mut valid = Vec::new();
        encode_pkcs8(alg, &key_bytes, &mut valid);

        let outer = decode::read_tlv(&valid, 0).unwrap();
        let mut inner = outer.value.to_vec();

        let pub_key = [0x01u8; 32];
        inner.push(tags::TAG_CONTEXT_1_IMPLICIT);
        encode_length(pub_key.len(), &mut inner);
        inner.extend_from_slice(&pub_key);

        let mut buf = Vec::new();
        buf.push(tags::TAG_SEQUENCE);
        encode_length(inner.len(), &mut buf);
        buf.extend_from_slice(&inner);

        let err = decode_pkcs8(&buf).unwrap_err();
        assert!(
            matches!(err, Error::InvalidDer(msg) if msg.contains("[1] publicKey")),
            "expected [1] publicKey rejection, got: {:?}",
            err
        );
    }

    #[test]
    fn test_version0_accepts_attributes_field() {
        // Build a valid version-0 PKCS8 with a [0] attributes appended
        let alg = Algorithm::SlhDsa(SlhDsa::Sha2_128s);
        let key_bytes = vec![0xCCu8; 64];
        let mut valid = Vec::new();
        encode_pkcs8(alg, &key_bytes, &mut valid);

        // Decode the outer SEQUENCE to get its content
        let outer = decode::read_tlv(&valid, 0).unwrap();
        let mut inner = outer.value.to_vec();

        // Append [0] attributes (context tag 0xA0 with some dummy data)
        let attrs = [0x05, 0x00]; // NULL
        inner.push(tags::TAG_CONTEXT_0);
        encode_length(attrs.len(), &mut inner);
        inner.extend_from_slice(&attrs);

        // Re-wrap in outer SEQUENCE
        let mut buf = Vec::new();
        buf.push(tags::TAG_SEQUENCE);
        encode_length(inner.len(), &mut buf);
        buf.extend_from_slice(&inner);

        let (decoded_alg, decoded_bytes) = decode_pkcs8(&buf).unwrap();
        assert_eq!(decoded_alg, alg);
        assert_eq!(decoded_bytes, &key_bytes[..]);
    }

    #[test]
    fn test_decode_invalid_version() {
        // Build a PKCS8 with version 2
        let mut inner = Vec::new();
        inner.extend_from_slice(&[0x02, 0x01, 0x02]); // INTEGER 2
                                                      // rest doesn't matter for this test

        let mut buf = Vec::new();
        buf.push(tags::TAG_SEQUENCE);
        encode_length(inner.len(), &mut buf);
        buf.extend_from_slice(&inner);

        assert!(decode_pkcs8(&buf).is_err());
    }
}