reallyme-codec 0.2.3

ReallyMe codec utilities for PEM, lowercase hex, multibase, multicodec, multikey, CBOR, JCS, and base encodings.
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
// SPDX-FileCopyrightText: Copyright © 2026 ReallyMe LLC. All rights reserved
//
// SPDX-License-Identifier: MIT OR Apache-2.0

#[test]
fn multikey_parse_dispatch_matches_primitive_parser() {
    let public_key = [11_u8; 32];
    let multikey = codec_multikey::encode_multikey("ed25519-pub", &public_key).unwrap();
    let primitive = codec_multikey::parse_multikey(&multikey).unwrap();
    let request = multikey_parse_request(&multikey);

    let binary = process_binary_and_proto_json(&request);

    let result = result_payload(&binary);
    let parsed = decode_protobuf::<CodecMultikeyParseResult>(result.bytes()).unwrap();
    assert_eq!(parsed.codec_name, primitive.codec_name);
    assert_eq!(parsed.algorithm_name, primitive.alg);
    assert_eq!(parsed.public_key, primitive.public_key.as_slice());
    assert_eq!(
        parsed.expected_public_key_length,
        u32::try_from(primitive.key_length).unwrap()
    );
    assert!(!parsed.variable_public_key_length);
}

#[test]
fn multikey_parse_dispatch_preserves_variable_length_flag() {
    let public_key = [13_u8; 80];
    let multikey = codec_multikey::encode_multikey("rsa-pub", &public_key).unwrap();
    let request = multikey_parse_request(&multikey);
    let envelope = process_binary_and_proto_json(&request);
    let result = result_payload(&envelope);
    let parsed = decode_protobuf::<CodecMultikeyParseResult>(result.bytes()).unwrap();

    assert_eq!(parsed.codec_name, "rsa-pub");
    assert_eq!(parsed.algorithm_name, "RSA");
    assert_eq!(parsed.public_key, public_key.as_slice());
    assert_eq!(parsed.expected_public_key_length, 0);
    assert!(parsed.variable_public_key_length);
}

#[test]
fn multikey_parse_dispatch_rejects_noncanonical_multibase() {
    let request = multikey_parse_request("not-a-key");
    let envelope = process_binary_and_proto_json(&request);
    let error = codec_error_payload(&envelope);

    assert_eq!(error.branch(), CodecWireErrorBranch::Multiformat);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_MULTIFORMAT_INVALID_MULTIKEY
    );
}

#[test]
fn multikey_parse_dispatch_rejects_unknown_prefix() {
    let multikey = codec_multibase::bytes_to_multibase58btc(&[0, 0, 7]).unwrap();
    let request = multikey_parse_request(&multikey);
    let envelope = process_binary_and_proto_json(&request);
    let error = codec_error_payload(&envelope);

    assert_eq!(error.branch(), CodecWireErrorBranch::Multiformat);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_MULTIFORMAT_UNKNOWN_MULTICODEC
    );
}

#[test]
fn dag_cbor_verify_cid_dispatch_matches_primitive_verifier() {
    let payload = vec![0xa0];
    let cid = codec_cbor::compute_cid_dag_cbor(&payload);
    let primitive = codec_cbor::verify_dag_cbor_cid(&cid, &payload);
    let request = dag_cbor_verify_cid_request(&cid, &payload);

    let binary = process_binary_and_proto_json(&request);

    let result = result_payload(&binary);
    let verified = decode_protobuf::<CodecDagCborVerifyCidResult>(result.bytes()).unwrap();
    assert_eq!(verified.valid, primitive.0);
    assert_eq!(verified.expected_cid, primitive.1);
    assert_eq!(verified.actual_cid, primitive.2);
}

#[test]
fn dag_cbor_generated_result_takes_semantic_string_ownership() {
    let payload = [0xa0];
    let cid = codec_cbor::compute_cid_dag_cbor(&payload);
    let verification = verify_dag_cbor_cid(&cid, &payload).unwrap();
    let expected_cid_allocation = verification.expected_cid().as_ptr();
    let actual_cid_allocation = verification.actual_cid().as_ptr();

    let result = dag_cbor_verify_cid_result_proto(verification);

    // The adapter must transfer both owned strings into the generated
    // owner. Reallocating here would create avoidable identity-bearing
    // copies and weaken the ownership model at every scalar boundary.
    assert_eq!(result.expected_cid.as_ptr(), expected_cid_allocation);
    assert_eq!(result.actual_cid.as_ptr(), actual_cid_allocation);
}

#[test]
fn dag_cbor_verify_cid_dispatch_preserves_invalid_cid_sanitization() {
    let payload = vec![0xa0];
    let request = dag_cbor_verify_cid_request("not-a-cid", &payload);
    let envelope = process_binary_and_proto_json(&request);
    let result = result_payload(&envelope);
    let verified = decode_protobuf::<CodecDagCborVerifyCidResult>(result.bytes()).unwrap();

    assert!(!verified.valid);
    assert_eq!(
        verified.expected_cid,
        codec_cbor::compute_cid_dag_cbor(&payload)
    );
    assert_eq!(verified.actual_cid, "");
}

#[test]
fn dag_cbor_verify_cid_dispatch_rejects_oversized_payload() {
    let payload = vec![0_u8; codec_cbor::MAX_DAG_CBOR_INPUT_LEN + 1];
    let request = dag_cbor_verify_cid_request("", &payload);
    let envelope = process_binary_and_proto_json(&request);
    let error = codec_error_payload(&envelope);

    assert_eq!(error.branch(), CodecWireErrorBranch::Boundary);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_BOUNDARY_RESOURCE_LIMIT_EXCEEDED
    );
}

#[test]
fn dag_cbor_encode_request_returns_primitive_canonical_bytes() {
    let semantic = CborValue::Map(vec![
        ("z".to_owned(), CborValue::Int(-1)),
        ("a".to_owned(), CborValue::Bytes(vec![1, 2, 3])),
    ]);
    let request = CodecOperationRequest {
        operation: Some(
            codec_proto::generated::proto::reallyme::codec::v1::CodecDagCborEncodeRequest {
                value: buffa::MessageField::some(dag_cbor_proto_fixture()),
                __buffa_unknown_fields: Default::default(),
            }
            .into(),
        ),
        __buffa_unknown_fields: Default::default(),
    };

    let result = result_payload(&process_operation_response(&request.encode_to_vec()));
    let encoded = decode_protobuf::<CodecDagCborEncodeResult>(result.bytes()).unwrap();
    let expected = encode_dag_cbor_value(&semantic).unwrap();
    assert_eq!(encoded.encoded.as_slice(), expected.as_slice());

    let json = serde_json::to_vec(&request).unwrap();
    assert_eq!(
        process_operation_response(&request.encode_to_vec()),
        process_operation_response_json(&json)
    );
}

#[test]
fn dag_cbor_decode_request_returns_typed_generated_value() {
    let encoded = encode_dag_cbor_value(&CborValue::Map(vec![(
        "a".to_owned(),
        CborValue::Array(vec![CborValue::Bool(true), CborValue::Int(-2)]),
    )]))
    .unwrap();
    let request = CodecOperationRequest {
        operation: Some(
            codec_proto::generated::proto::reallyme::codec::v1::CodecDagCborDecodeRequest {
                encoded: encoded.to_vec(),
                __buffa_unknown_fields: Default::default(),
            }
            .into(),
        ),
        __buffa_unknown_fields: Default::default(),
    };

    let result = result_payload(&process_operation_response(&request.encode_to_vec()));
    let mut decoded = decode_protobuf::<CodecDagCborDecodeResult>(result.bytes()).unwrap();
    let reencoded_request = CodecOperationRequest {
        operation: Some(
            codec_proto::generated::proto::reallyme::codec::v1::CodecDagCborEncodeRequest {
                value: core::mem::take(&mut decoded.value),
                __buffa_unknown_fields: Default::default(),
            }
            .into(),
        ),
        __buffa_unknown_fields: Default::default(),
    };
    let reencoded = result_payload(&process_operation_response(
        &reencoded_request.encode_to_vec(),
    ));
    let reencoded = decode_protobuf::<CodecDagCborEncodeResult>(reencoded.bytes()).unwrap();
    assert_eq!(reencoded.encoded.as_slice(), encoded.as_slice());
}

#[test]
fn dag_cbor_encode_rejects_integer_map_keys() {
    let request = CodecOperationRequest {
        operation: Some(
            codec_proto::generated::proto::reallyme::codec::v1::CodecDagCborEncodeRequest {
                value: buffa::MessageField::some(deterministic_cbor_map_fixture()),
                __buffa_unknown_fields: Default::default(),
            }
            .into(),
        ),
        __buffa_unknown_fields: Default::default(),
    };

    let error = codec_error_payload(&process_operation_response(&request.encode_to_vec()));
    assert_eq!(error.branch(), CodecWireErrorBranch::Boundary);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_BOUNDARY_MALFORMED_PROTOBUF
    );
}

#[test]
fn dag_cbor_encode_rejects_unsigned_values_outside_i64() {
    let request = CodecOperationRequest {
        operation: Some(
            codec_proto::generated::proto::reallyme::codec::v1::CodecDagCborEncodeRequest {
                value: buffa::MessageField::some(CodecDeterministicCborValue {
                    value: Some(
                        CodecDeterministicCborInteger {
                            value: Some(
                                CodecDeterministicCborUnsignedInteger {
                                    value: i64::MAX.unsigned_abs() + 1,
                                    __buffa_unknown_fields: Default::default(),
                                }
                                .into(),
                            ),
                            __buffa_unknown_fields: Default::default(),
                        }
                        .into(),
                    ),
                    __buffa_unknown_fields: Default::default(),
                }),
                __buffa_unknown_fields: Default::default(),
            }
            .into(),
        ),
        __buffa_unknown_fields: Default::default(),
    };

    let error = codec_error_payload(&process_operation_response(&request.encode_to_vec()));
    assert_eq!(error.branch(), CodecWireErrorBranch::Boundary);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_BOUNDARY_MALFORMED_PROTOBUF
    );
}

#[test]
fn pem_decode_dispatch_matches_primitive_decoder() {
    let der = b"not real der";
    let pem = codec_pem::encode_pem(
        PemLabel::PublicKey,
        der,
        codec_pem::PemEncodeOptions::default(),
    )
    .unwrap();
    let policy = PemDecodePolicy {
        allowed_labels: &[PemLabel::PublicKey],
        ..PemDecodePolicy::default()
    };
    let primitive = codec_pem::decode_pem(&pem, policy).unwrap();
    let request = pem_decode_request(
        pem.as_bytes(),
        Some(CodecPemDecodeOptions {
            allowed_labels: vec![EnumValue::from(CodecPemLabel::CODEC_PEM_LABEL_PUBLIC_KEY)],
            max_input_len: 0,
            max_der_len: 0,
            __buffa_unknown_fields: Default::default(),
        }),
    );

    let binary = process_binary_and_proto_json(&request);

    let result = result_payload(&binary);
    let decoded = decode_protobuf::<CodecPemDecodeResult>(result.bytes()).unwrap();
    assert_eq!(decoded.label, primitive.label.as_str());
    assert_eq!(decoded.der, primitive.der.as_slice());
}

#[test]
fn pem_generated_result_takes_semantic_der_ownership() {
    let der = b"private der";
    let pem = codec_pem::encode_pem(
        PemLabel::PrivateKey,
        der,
        codec_pem::PemEncodeOptions::default(),
    )
    .unwrap();
    let decoded = decode_pem(&pem, PemDecodePolicy::default()).unwrap();
    let der_allocation = decoded.der().as_ptr();

    let result = pem_decode_result_proto(decoded).unwrap();

    // This pointer equality is the regression proof that private DER is
    // moved from one zeroizing owner to the next, not copied through an
    // additional secret-bearing allocation.
    assert_eq!(result.der.as_ptr(), der_allocation);
    assert_eq!(result.der, der);
}

#[test]
fn pem_decode_dispatch_preserves_label_mismatch_error() {
    let pem = b"-----BEGIN PUBLIC KEY-----\nAA==\n-----END PRIVATE KEY-----\n";
    let request = pem_decode_request(pem, None);
    let envelope = process_binary_and_proto_json(&request);
    let error = codec_error_payload(&envelope);

    assert_eq!(error.branch(), CodecWireErrorBranch::Pem);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_PEM_LABEL_MISMATCH
    );
}

#[test]
fn pem_decode_dispatch_preserves_unsupported_label_error() {
    let der = b"not real der";
    let pem = codec_pem::encode_pem(
        PemLabel::PublicKey,
        der,
        codec_pem::PemEncodeOptions::default(),
    )
    .unwrap();
    let request = pem_decode_request(
        pem.as_bytes(),
        Some(CodecPemDecodeOptions {
            allowed_labels: vec![EnumValue::from(CodecPemLabel::CODEC_PEM_LABEL_PRIVATE_KEY)],
            max_input_len: 0,
            max_der_len: 0,
            __buffa_unknown_fields: Default::default(),
        }),
    );
    let envelope = process_binary_and_proto_json(&request);
    let error = codec_error_payload(&envelope);

    assert_eq!(error.branch(), CodecWireErrorBranch::Pem);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_PEM_UNSUPPORTED_LABEL
    );
}

#[test]
fn remaining_structured_requests_reject_binary_unknown_fields() {
    let mut multikey = CodecMultikeyParseRequest {
        multikey: "not-a-key".to_owned(),
        __buffa_unknown_fields: Default::default(),
    };
    multikey.__buffa_unknown_fields.push(UnknownField {
        number: 99,
        data: UnknownFieldData::Varint(7),
    });

    let mut dag_cbor = CodecDagCborVerifyCidRequest {
        cid: String::new(),
        payload: vec![0xa0],
        __buffa_unknown_fields: Default::default(),
    };
    dag_cbor.__buffa_unknown_fields.push(UnknownField {
        number: 99,
        data: UnknownFieldData::Varint(7),
    });

    let mut options = CodecPemDecodeOptions {
        allowed_labels: Vec::new(),
        max_input_len: 0,
        max_der_len: 0,
        __buffa_unknown_fields: Default::default(),
    };
    options.__buffa_unknown_fields.push(UnknownField {
        number: 99,
        data: UnknownFieldData::Varint(7),
    });

    let requests = [
        CodecOperationRequest {
            operation: Some(multikey.into()),
            __buffa_unknown_fields: Default::default(),
        },
        CodecOperationRequest {
            operation: Some(dag_cbor.into()),
            __buffa_unknown_fields: Default::default(),
        },
        pem_decode_request(b"", Some(options)),
    ];

    for request in requests {
        let error = codec_error_payload(&process_operation_response(&request.encode_to_vec()));
        assert_eq!(error.branch(), CodecWireErrorBranch::Boundary);
        assert_eq!(
            error.reason(),
            CodecErrorReason::CODEC_ERROR_REASON_BOUNDARY_MALFORMED_PROTOBUF
        );
    }
}

#[test]
fn remaining_structured_requests_reject_proto_json_unknown_fields() {
    let requests = [
        br#"{"multikeyParse":{"multikey":"not-a-key","unknown":7}}"#.as_slice(),
        br#"{"dagCborVerifyCid":{"cid":"","payload":"oA==","unknown":7}}"#.as_slice(),
        br#"{"pemDecode":{"pem":"","options":{"unknown":7}}}"#.as_slice(),
    ];

    for request in requests {
        let error = codec_error_payload(&process_operation_response_json(request));
        assert_eq!(error.branch(), CodecWireErrorBranch::Boundary);
        assert_eq!(
            error.reason(),
            CodecErrorReason::CODEC_ERROR_REASON_BOUNDARY_MALFORMED_JSON
        );
    }
}

#[test]
fn malformed_binary_is_a_structured_boundary_error() {
    let error = codec_error_payload(&process_operation_response(&[0xff]));
    assert_eq!(error.branch(), CodecWireErrorBranch::Boundary);
    assert_eq!(
        error.reason(),
        CodecErrorReason::CODEC_ERROR_REASON_BOUNDARY_MALFORMED_PROTOBUF
    );
}

#[test]
fn pem_encode_rejects_unknown_line_ending_in_binary_and_json() {
    use codec_proto::generated::proto::reallyme::codec::v1::CodecPemEncodeRequest;

    for unknown in [-1, 3, i32::MAX] {
        let request = CodecOperationRequest {
            operation: Some(CodecPemEncodeRequest {
                label: CodecPemLabel::CODEC_PEM_LABEL_PUBLIC_KEY.into(),
                der: vec![0x01],
                options: buffa::MessageField::some(CodecPemEncodeOptions {
                    line_ending: EnumValue::from(unknown),
                    ..Default::default()
                }),
                __buffa_unknown_fields: Default::default(),
            }.into()),
            __buffa_unknown_fields: Default::default(),
        };
        let error = codec_error_payload(&process_binary_and_proto_json(&request));
        assert_eq!(error.branch(), CodecWireErrorBranch::Boundary);
        assert_eq!(error.reason(), CodecErrorReason::CODEC_ERROR_REASON_BOUNDARY_MALFORMED_PROTOBUF);
    }
}

#[test]
fn pem_encode_preserves_absent_unspecified_and_known_line_endings() {
    use codec_proto::generated::proto::reallyme::codec::v1::{CodecPemEncodeRequest, CodecPemEncodeResult};
    for (line_ending, newline) in [
        (None, "\n"),
        (Some(CodecPemLineEnding::CODEC_PEM_LINE_ENDING_UNSPECIFIED), "\n"),
        (Some(CodecPemLineEnding::CODEC_PEM_LINE_ENDING_LF), "\n"),
        (Some(CodecPemLineEnding::CODEC_PEM_LINE_ENDING_CRLF), "\r\n"),
    ] {
        let options = line_ending.map(|number| CodecPemEncodeOptions {
            line_ending: EnumValue::from(number),
            ..Default::default()
        });
        let request = CodecOperationRequest {
            operation: Some(CodecPemEncodeRequest {
                label: CodecPemLabel::CODEC_PEM_LABEL_PUBLIC_KEY.into(),
                der: vec![0x01],
                options: options.into(),
                __buffa_unknown_fields: Default::default(),
            }.into()),
            __buffa_unknown_fields: Default::default(),
        };
        let response = process_binary_and_proto_json(&request);
        let result = result_payload(&response);
        let encoded = decode_protobuf::<CodecPemEncodeResult>(result.bytes()).unwrap();
        assert_eq!(encoded.pem, format!("-----BEGIN PUBLIC KEY-----{newline}AQ=={newline}-----END PUBLIC KEY-----{newline}").as_bytes());
    }
}