cesr-rs 0.8.0

CESR + KERI primitives for Rust as a single feature-gated, no_std-capable crate
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

#[cfg(feature = "alloc")]
#[allow(
    unused_imports,
    reason = "alloc prelude items; subset used per cfg/feature combination"
)]
use alloc::vec;
/// ISO-8601 datetime primitive encoded as CESR Matter.
pub mod dater;
/// Unsigned integer primitive with automatic CESR code selection.
pub mod number;
/// Sequence number primitive wrapping [`Number`].
pub mod seqner;
/// Indexed signature primitive with optional verfer attachment.
pub mod siger;
/// Signing threshold holder for weighted or unweighted thresholds.
pub mod tholder;

use crate::core::matter::code::{
    DigestCode, LabelerCode, NoncerCode, SeedCode, SignatureCode, TexterCode, VerKeyCode,
    VerserCode,
};
use crate::core::matter::matter::Matter;

pub use dater::Dater;
pub use number::Number;
pub use seqner::Seqner;
pub use siger::Siger;
pub use tholder::{Tholder, ThresholdError};

/// Verification key — can verify signatures
pub type Verfer<'a> = Matter<'a, VerKeyCode>;

/// Digest — holds a hash value
pub type Diger<'a> = Matter<'a, DigestCode>;

/// Signing key seed — can produce signatures (actual crypto in cesr-crypto)
pub type Signer<'a> = Matter<'a, SeedCode>;

/// Non-indexed signature
pub type Cigar<'a> = Matter<'a, SignatureCode>;

/// Self-addressing identifier (SAID) — a digest used as a content identifier
pub type Saider<'a> = Matter<'a, DigestCode>;

/// AID prefix — a verification key used as an autonomic identifier
pub type Prefixer<'a> = Matter<'a, VerKeyCode>;

/// Version primitive — encodes protocol/genus version info
pub type Verser<'a> = Matter<'a, VerserCode>;

/// Nonce/UUID primitive — salt, digest, or empty
pub type Noncer<'a> = Matter<'a, NoncerCode>;

/// Label primitive — field name or tag
pub type Labeler<'a> = Matter<'a, LabelerCode>;

/// Text primitive — variable-length byte string
pub type Texter<'a> = Matter<'a, TexterCode>;

#[cfg(test)]
mod tests {
    use super::*;
    use crate::core::matter::code::{DigestCode, VerKeyCode};
    use alloc::borrow::Cow;

    #[test]
    fn verfer_is_matter_with_verkey_code() {
        let code = VerKeyCode::Ed25519;
        let raw = vec![0u8; 32];
        let verfer: Verfer<'_> =
            crate::core::matter::matter::Matter::new(code, Cow::Owned(raw), Cow::from(""));
        assert_eq!(*verfer.code(), VerKeyCode::Ed25519);
    }

    #[test]
    fn saider_is_matter_with_digest_code() {
        let code = DigestCode::Blake3_256;
        let raw = vec![0u8; 32];
        let saider: Saider<'_> =
            crate::core::matter::matter::Matter::new(code, Cow::Owned(raw), Cow::from(""));
        assert_eq!(*saider.code(), DigestCode::Blake3_256);
    }

    #[test]
    fn prefixer_is_matter_with_verkey_code() {
        let code = VerKeyCode::Ed25519;
        let raw = vec![0u8; 32];
        let prefixer: Prefixer<'_> =
            crate::core::matter::matter::Matter::new(code, Cow::Owned(raw), Cow::from(""));
        assert_eq!(*prefixer.code(), VerKeyCode::Ed25519);
    }
}