rasn 0.28.2

A safe no_std ASN.1 codec framework.
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
use bitvec::prelude::*;
use rasn::prelude::*;
use rasn::{aper, ber, jer, oer, uper};

#[derive(AsnType, Decode, Encode, Debug, Clone, PartialEq)]
#[rasn(automatic_tags)]
pub struct Hashes {
    #[rasn(size("3"))]
    pub hashed3: OctetString,
    #[rasn(size("8"))]
    pub hashed8: OctetString,
    #[rasn(size("16"))]
    pub hashed16: OctetString,
    #[rasn(size("32"))]
    pub hashed32: OctetString,
    #[rasn(size("64"))]
    pub hashed64: OctetString,
}
#[derive(AsnType, Decode, Encode, Debug, Clone, PartialEq)]
#[rasn(automatic_tags)]
pub struct ConstrainedHashes {
    pub hashed3: FixedOctetString<3>,
    pub hashed8: FixedOctetString<8>,
    pub hashed16: FixedOctetString<16>,
    pub hashed32: FixedOctetString<32>,
    pub hashed64: FixedOctetString<64>,
}
#[derive(AsnType, Decode, Encode, Debug, Clone, PartialEq)]
#[rasn(automatic_tags)]
pub struct ConstrainedFixBitString {
    pub hashed3: FixedBitString<3>,
}
#[derive(AsnType, Decode, Encode, Debug, Clone, PartialEq)]
#[rasn(automatic_tags)]
pub struct ConstrainedBitString {
    #[rasn(size("3"))]
    pub hashed3: BitString,
}

fn build_octet() -> Hashes {
    Hashes {
        hashed3: vec![0x01, 0x02, 0x03].into(),
        hashed8: vec![0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08].into(),
        hashed16: vec![
            0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
            0x0F, 0x10,
        ]
        .into(),
        hashed32: vec![
            0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
            0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C,
            0x1D, 0x1E, 0x1F, 0x20,
        ]
        .into(),
        hashed64: vec![
            0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
            0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C,
            0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A,
            0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38,
            0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F, 0x40,
        ]
        .into(),
    }
}
fn build_fixed_octet() -> ConstrainedHashes {
    ConstrainedHashes {
        hashed3: [0x01, 0x02, 0x03].into(),
        hashed8: [0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08].into(),
        hashed16: [
            0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
            0x0F, 0x10,
        ]
        .into(),
        hashed32: [
            0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
            0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C,
            0x1D, 0x1E, 0x1F, 0x20,
        ]
        .into(),
        hashed64: [
            0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E,
            0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C,
            0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A,
            0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38,
            0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F, 0x40,
        ]
        .into(),
    }
}

// Test whether constrained OctetString and FixedOctetString are equal
macro_rules! test_decode_eq {
    ($fn_name:ident, $codec:ident) => {
        #[test]
        fn $fn_name() {
            let items = build_octet();
            let fixed_items = build_fixed_octet();
            let encoded = $codec::encode(&items).unwrap();
            let encoded_fixed = $codec::encode(&fixed_items).unwrap();
            let decoded = $codec::decode::<Hashes>(&encoded).unwrap();
            let decoded_fixed = $codec::decode::<ConstrainedHashes>(&encoded_fixed).unwrap();
            let bits = BitString::from_bitslice(&BitVec::<u8, Msb0>::repeat(true, 3));
            let bs = ConstrainedBitString {
                hashed3: BitString::from(bits),
            };
            let bool_array = [true, true, true];
            let mut bit_array: BitArray<[u8; 3], Msb0> = BitArray::ZERO;
            for (i, &value) in bool_array.iter().enumerate() {
                bit_array.set(i, value);
            }
            let bs_fixed = ConstrainedFixBitString { hashed3: bit_array };
            let encoded_bs = $codec::encode(&bs).unwrap();
            let encoded_bs_fixed = $codec::encode(&bs_fixed).unwrap();
            let decoded_bs = $codec::decode::<ConstrainedBitString>(&encoded_bs).unwrap();
            let decoded_bs_fixed =
                $codec::decode::<ConstrainedFixBitString>(&encoded_bs_fixed).unwrap();
            assert_eq!(bs, decoded_bs);
            assert_eq!(encoded_bs, encoded_bs_fixed);
            assert_eq!(bs_fixed, decoded_bs_fixed);
            assert_eq!(items, decoded);
            assert_eq!(encoded, encoded_fixed);
            assert_eq!(fixed_items, decoded_fixed);
            assert_eq!(items.hashed3.as_ref(), decoded_fixed.hashed3.as_ref());
            assert_eq!(items.hashed8.as_ref(), decoded_fixed.hashed8.as_ref());
            assert_eq!(items.hashed16.as_ref(), decoded_fixed.hashed16.as_ref());
            assert_eq!(items.hashed32.as_ref(), decoded_fixed.hashed32.as_ref());
            assert_eq!(items.hashed64.as_ref(), decoded_fixed.hashed64.as_ref());
        }
    };
}
test_decode_eq!(test_uper_octet_eq, uper);
test_decode_eq!(test_oer_octet_eq, oer);
test_decode_eq!(test_ber_octet_eq, ber);
test_decode_eq!(test_jer_octet_eq, jer);

#[derive(AsnType, Decode, Encode, Debug, Clone, PartialEq)]
#[rasn(automatic_tags)]
pub struct ABitString {
    #[rasn(size("0..=255"))]
    pub the_string: BitString,
}

/// Tests that valid strings are parsed and invalid strings are rejected.
#[test]
fn test_jer_bitstring_dec() {
    use bitvec::prelude::*;

    let good_cases: Vec<(&str, usize, BitVec<u8, bitvec::order::Msb0>)> = vec![
        ("", 0, bitvec::bits![u8, Msb0;].into()),
        ("00", 1, bitvec::bits![u8, Msb0; 0].into()),
        ("00", 3, bitvec::bits![u8, Msb0; 0,0,0].into()),
        ("0F", 3, bitvec::bits![u8, Msb0; 0,0,0].into()),
        ("F0", 3, bitvec::bits![u8, Msb0; 1,1,1].into()),
        ("00", 7, bitvec::bits![u8, Msb0; 0,0,0,0,0,0,0].into()),
        ("00", 8, bitvec::bits![u8, Msb0; 0,0,0,0,0,0,0,0].into()),
        ("0F", 8, bitvec::bits![u8, Msb0; 0,0,0,0,1,1,1,1].into()),
        (
            "\\u0030\\u0030",
            8,
            bitvec::bits![u8, Msb0; 0,0,0,0,0,0,0,0].into(),
        ),
        (
            "\\u0046\\u0046",
            8,
            bitvec::bits![u8, Msb0; 1,1,1,1,1,1,1,1].into(),
        ),
    ];

    let bad_cases: Vec<(&str, usize)> = vec![
        (" ", 0),
        ("!", 0),
        ("0", 0),
        (" 0", 0),
        ("0 ", 0),
        ("0!", 0),
        ("  ", 0),
        ("00 ", 0),
        (" 00", 0),
        ("000", 0),
        ("Œ", 0),
        ("ŒŒ", 0),
        ("ŒŒŒ", 0),
        ("ABCDEFG", 0),
        (" ABCDEF", 0),
        ("\u{0000}", 0),
        ("\u{FFFF}", 0),
        ("\u{0123}", 0),
        ("\u{30}", 0),
        ("\\u0030", 0),
        ("\\u202E\\u0030\\u0030", 0),
        ("⣐⡄", 0),
        ("😎", 0),
        ("🙈🙉🙊", 0),
        ("", 1),
        ("", 8),
        ("00", 0),
        ("00", 10),
        ("00", 16),
        ("00", 16384),
        ("0000", 0),
        ("0000", 8),
        ("0000", 17),
    ];

    for (case, length, bits) in good_cases {
        let json = format!("{{\"the_string\":{{\"length\":{length},\"value\":\"{case}\"}}}}");
        let expected = ABitString { the_string: bits };
        let decoded = jer::decode::<ABitString>(&json);
        if let Err(e) = decoded {
            panic!("should have decoded case \"{case}\" fine: {e:?}");
        }
        assert_eq!(decoded.unwrap(), expected);
    }

    for (case, length) in bad_cases {
        let json = format!("{{\"the_string\":{{\"length\":{length},\"value\":\"{case}\"}}}}");
        let decoded = jer::decode::<ABitString>(&json);
        if let Ok(decoded) = decoded {
            panic!(
                "should have rejected case \"{case}\", but decoded: {decoded:?} (length {})",
                decoded.the_string.len()
            );
        }
    }
}

#[derive(AsnType, Decode, Encode, Debug, Clone, PartialEq)]
#[rasn(automatic_tags)]
pub struct AnOctetString {
    #[rasn(size("0..=255"))]
    pub the_string: OctetString,
}

/// Tests that valid strings are parsed and invalid strings are rejected.
#[test]
fn test_jer_octetstring_dec() {
    let good_cases: Vec<&[u8]> = vec![
        &[],
        &[0x00; 1],
        &[0x00; 2],
        &[0x0F; 1],
        &[0xFF; 1],
        &[0xFF; 2],
        &[0x00; 10],
        &[0x00; 100],
        &[0x00; 200],
        &[0x01, 0x23],
        &[0xAB, 0xCD],
        &[0xAB, 0xCD, 0xEF],
        &[0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF],
        &[0x00; 255],
        &[0x0F; 255],
        &[0xFF; 255],
        &[0x00; 256],
        &[0x0F; 256],
        &[0xFF; 256],
        &[0x00; 16384],
        &[0x0F; 16384],
        &[0xFF; 16384],
    ];

    let special_cases: Vec<(&str, &[u8])> =
        vec![("\\u0030\\u0030", &[0x00]), ("\\u0046\\u0046", &[0xFF])];

    let bad_cases = vec![
        " ",
        "!",
        "0",
        " 0",
        "0 ",
        "0!",
        "  ",
        "000",
        "Œ",
        "ŒŒ",
        "ŒŒŒ",
        "ABCDEFG",
        " ABCDEF",
        "\u{0000}",
        "\u{FFFF}",
        "\u{0123}",
        "\u{30}",
        "\\u0030",
        "\\u202E\\u0030\\u0030",
        "⣐⡄",
        "😎",
        "🙈🙉🙊",
    ];

    for case in good_cases {
        let upper_hex = case
            .iter()
            .map(|b| format!("{b:02X}"))
            .collect::<Vec<String>>()
            .join("");
        let json = format!("{{\"the_string\":\"{upper_hex}\"}}");
        let expected = AnOctetString {
            the_string: case.into(),
        };
        let decoded = jer::decode::<AnOctetString>(&json);
        if let Err(e) = decoded {
            panic!("should have decoded case \"{upper_hex}\" fine: {e:?}");
        }
        assert_eq!(decoded.unwrap(), expected);
    }

    for (case, expected) in special_cases {
        let json = format!("{{\"the_string\":\"{case}\"}}");
        let expected = AnOctetString {
            the_string: expected.into(),
        };
        let decoded = jer::decode::<AnOctetString>(&json);
        if let Err(e) = decoded {
            panic!("should have decoded case \"{case}\" fine: {e:?}");
        }
        assert_eq!(decoded.unwrap(), expected);
    }

    for case in bad_cases {
        let json = format!("{{\"the_string\":\"{case}\"}}");
        let decoded = jer::decode::<AnOctetString>(&json);
        if let Ok(decoded) = decoded {
            panic!(
                "should have rejected case \"{case}\", but decoded: {decoded:?} (length {})",
                decoded.the_string.len()
            );
        }
    }
}

// Tests that OctetStrings are encoded and decoded correctly (APER, UPER).
const BYTE_ARRAYS: &[&[u8]] = &[
    &[],
    &[0x00; 1],
    &[0x00; 2],
    &[0x0F; 1],
    &[0xFF; 1],
    &[0xFF; 2],
    &[0x00; 10],
    &[0x00; 100],
    &[0x00; 128],
    &[0x00; 200],
    &[0x01, 0x23],
    &[0xAB, 0xCD],
    &[0xAB, 0xCD, 0xEF],
    &[0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF],
    &[0x00; 255],
    &[0x0F; 255],
    &[0xFF; 255],
    &[0x00; 256],
    &[0x0F; 256],
    &[0xFF; 256],
    &[0x00; 16383],
    &[0x0F; 16383],
    &[0xFF; 16383],
];

#[test]
fn test_per_encode_octet_string() {
    for case in BYTE_ARRAYS {
        let length = case.len(); // number of bytes
        let mut buf_expected: Vec<u8> = Vec::new();
        if length < 128 {
            // X.691, 11.9.a)
            buf_expected.push(length as u8);
        } else if length < 16384 {
            // X.691, 11.9.b)
            let length = (length as u16).to_be_bytes();
            buf_expected.push(0b10000000 | length[0]);
            buf_expected.push(length[1]);
        } else {
            // X.691, 11.9.c)
            todo!("implement chunk generation");
        }
        buf_expected.extend_from_slice(case);

        let bytes = OctetString::from_static(case);
        assert_eq!(buf_expected, aper::encode::<OctetString>(&bytes).unwrap());
        assert_eq!(buf_expected, uper::encode::<OctetString>(&bytes).unwrap());

        assert_eq!(*case, &*aper::decode::<OctetString>(&buf_expected).unwrap());
        assert_eq!(*case, &*uper::decode::<OctetString>(&buf_expected).unwrap());
    }
}

// Tests that UTF8Strings are encoded and decoded correctly (APER, UPER).
const UTF8_STRINGS: &[&str] = &[
    "",
    "Hello World!",
    "Hello World! 🌍",
    "こんにちは世界!",
    "你好世界!",
    "안녕하세요!",
    "مرحبا بالعالم!",
    "હેલો વિશ્વ!",
    "привіт світ!",
    " ",
    "!",
    "0",
    " 0",
    "0 ",
    "0!",
    "  ",
    "000",
    "Œ",
    "ŒŒ",
    "ŒŒŒ",
    "ABCDEFG",
    " ABCDEF",
    "åäö",
    "\0",
    "\n",
    "\r\nASN.1",
    "\u{0000}",
    "\u{0001}",
    "\u{FFFF}",
    "\u{0123}",
    "\u{30}",
    "\\u0030",
    "\\u202E\\u0030\\u0030",
    "⣐⡄",
    "😎",
    "🙈🙉🙊",
    "👭👩🏻‍🤝‍👨🏾🧑🏿‍🤝‍🧑🏼",
];

#[test]
fn test_per_encode_utf8_string() {
    for case in UTF8_STRINGS {
        let case = case.to_string();
        // The X.691 spec, chapter 11.9, says determinant should be the number
        // of characters, but for UTF-8 this is a non-trivial operation and
        // dependant on the supported Unicode release. Actual implementations
        // seem to interpret the spec as "number of octets" instead - which is
        // reasonable (see `asn1tools` for example).
        let length = case.len(); // number of bytes
        let mut buf_expected: Vec<u8> = Vec::new();
        if length < 128 {
            // X.691, 11.9.a)
            buf_expected.push(length as u8);
        } else if length < 16384 {
            // X.691, 11.9.b)
            let length = length.to_le_bytes();
            buf_expected.push(0b10000000 | length[1]);
            buf_expected.push(length[0]);
        } else {
            // X.691, 11.9.c)
            todo!("implement chunk generation");
        }
        buf_expected.extend_from_slice(case.as_bytes());

        assert_eq!(buf_expected, aper::encode::<Utf8String>(&case).unwrap());
        assert_eq!(buf_expected, uper::encode::<Utf8String>(&case).unwrap());

        assert_eq!(case, aper::decode::<Utf8String>(&buf_expected).unwrap());
        assert_eq!(case, uper::decode::<Utf8String>(&buf_expected).unwrap());
    }
}