appcore-dnt 1.0.0

Authenticated encrypted binary container contracts for AppCore Runtime.
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

// =============================================================================
//        #######
//     ###       ###     F: codec.rs
//    ##   ## ##   ##    P: AppCore-Runtime
//         ## ##
//                       C: 2026/08/02 00:04:12 by dnettoRaw
//    ##   ## ##   ##    U: 2026/08/02 10:29:16 by dnettoRaw
//      ###########      S: 1.0.1-rc.8
// =============================================================================

//! DNT codec contracts.

use crate::{CodecError, CodecId};
use zeroize::Zeroize;

/// Payload codec used before encryption and after authentication.
pub trait DntCodec: Send + Sync {
    /// Returns the stable codec identifier.
    fn codec_id(&self) -> CodecId;
    /// Returns true when this codec can decode the authenticated identifier.
    fn matches_codec_id(&self, codec_id: &CodecId) -> bool {
        self.codec_id() == *codec_id
    }
    /// Encodes caller-owned bytes before sealing.
    fn encode(&self, value: &[u8]) -> Result<Vec<u8>, CodecError>;
    /// Decodes authenticated plaintext bytes after opening.
    fn decode(&self, payload: &[u8]) -> Result<Vec<u8>, CodecError>;
    /// Decodes an owned authenticated payload after opening.
    ///
    /// Codecs that are identity transforms can return `payload` directly to
    /// avoid an allocation in the read path. Transforming codecs may keep the
    /// default implementation.
    fn decode_owned(&self, mut payload: Vec<u8>) -> Result<Vec<u8>, CodecError> {
        let decoded = self.decode(&payload);
        payload.zeroize();
        decoded
    }
}

/// Identity codec for arbitrary binary payloads.
#[derive(Debug, Clone, Copy, Default)]
pub struct BytesCodec;

impl DntCodec for BytesCodec {
    fn codec_id(&self) -> CodecId {
        // appcore-norm: allow(clippy::expect_used) reason: codec identifier is a validated package constant
        CodecId::new("bytes").expect("static codec id")
    }

    fn matches_codec_id(&self, codec_id: &CodecId) -> bool {
        codec_id.as_str() == "bytes"
    }

    fn encode(&self, value: &[u8]) -> Result<Vec<u8>, CodecError> {
        Ok(value.to_vec())
    }

    fn decode(&self, payload: &[u8]) -> Result<Vec<u8>, CodecError> {
        Ok(payload.to_vec())
    }

    fn decode_owned(&self, payload: Vec<u8>) -> Result<Vec<u8>, CodecError> {
        Ok(payload)
    }
}

/// Identity codec for caller-validated JSON bytes.
#[derive(Debug, Clone, Copy, Default)]
pub struct IdentityJsonCodec;

impl DntCodec for IdentityJsonCodec {
    fn codec_id(&self) -> CodecId {
        // appcore-norm: allow(clippy::expect_used) reason: codec identifier is a validated package constant
        CodecId::new("json").expect("static codec id")
    }

    fn matches_codec_id(&self, codec_id: &CodecId) -> bool {
        codec_id.as_str() == "json"
    }

    fn encode(&self, value: &[u8]) -> Result<Vec<u8>, CodecError> {
        Ok(value.to_vec())
    }

    fn decode(&self, payload: &[u8]) -> Result<Vec<u8>, CodecError> {
        Ok(payload.to_vec())
    }

    fn decode_owned(&self, payload: Vec<u8>) -> Result<Vec<u8>, CodecError> {
        Ok(payload)
    }
}