cesr-rs 0.2.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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use super::code::IndexedSigCode;
#[cfg(feature = "alloc")]
#[allow(
    unused_imports,
    reason = "alloc prelude items; subset used per cfg/feature combination"
)]
use alloc::string::String;
use thiserror::Error as ThisError;

/// Errors produced while parsing an indexed CESR signature stream.
#[derive(Debug, ThisError, PartialEq, Eq)]
pub enum ParseError {
    /// The input stream is empty.
    #[error("empty CESR stream")]
    EmptyStream,

    /// The stream ended before enough characters were available.
    #[error("stream too short: need {need} chars, got {got}")]
    StreamTooShort {
        /// Number of characters needed.
        need: usize,
        /// Number of characters available.
        got: usize,
    },

    /// The code prefix does not match any known indexed signature code.
    #[error("unknown indexed sig code: '{0}'")]
    UnknownCode(String),

    /// A Base64 decode failure was encountered in the stream.
    #[error("invalid base64 in indexed sig stream")]
    InvalidBase64,

    /// Non-canonical encoding: index had unnecessary leading zeros.
    #[error("non-canonical encoding: leading zeros in indexed sig")]
    NonCanonical,

    /// The ondex field was non-zero for a `CurrentOnly` code.
    #[error("ondex must be 0 for current-only code, got {0}")]
    OndexNotZeroForCurrentOnly(u32),
}

/// Errors produced while validating an indexed CESR signature builder.
#[derive(Debug, ThisError, PartialEq, Eq)]
pub enum ValidationError {
    /// The signer index exceeds the maximum allowed by the code.
    #[error("index {index} exceeds max {max} for code {code:?}")]
    IndexTooLarge {
        /// The indexed signature code.
        code: IndexedSigCode,
        /// The index that was supplied.
        index: u32,
        /// The maximum index permitted.
        max: u32,
    },

    /// The ondex exceeds the maximum allowed by the code.
    #[error("ondex {ondex} exceeds max {max} for code {code:?}")]
    OndexTooLarge {
        /// The indexed signature code.
        code: IndexedSigCode,
        /// The ondex that was supplied.
        ondex: u32,
        /// The maximum ondex permitted.
        max: u32,
    },

    /// An ondex was provided for a `CurrentOnly` code which has no ondex field.
    #[error("ondex not allowed for current-only code {0:?}")]
    OndexOnCurrentOnly(IndexedSigCode),

    /// The ondex differs from index on a Both-mode code with os=0 (no wire
    /// space for a separate ondex). keripy raises `InvalidVarIndexError` here.
    #[error("ondex {ondex} must equal index {index} for code {code:?} (os=0)")]
    OndexMustEqualIndex {
        /// The indexed signature code.
        code: IndexedSigCode,
        /// The index that was supplied.
        index: u32,
        /// The ondex that was supplied.
        ondex: u32,
    },

    /// The raw byte slice length does not match the code's expected raw size.
    #[error("unexpected raw size for {code:?}: expected {expected}, got {got}")]
    UnexpectedRawSize {
        /// The indexed signature code.
        code: IndexedSigCode,
        /// Expected number of bytes.
        expected: usize,
        /// Actual number of bytes received.
        got: usize,
    },
}

impl From<super::code::CodeError> for ParseError {
    fn from(e: super::code::CodeError) -> Self {
        match e {
            super::code::CodeError::UnknownCode(s) => Self::UnknownCode(s),
        }
    }
}

impl From<crate::utils::error::Error> for ParseError {
    fn from(e: crate::utils::error::Error) -> Self {
        match e {
            crate::utils::error::Error::InvalidBase64Char(_)
            | crate::utils::error::Error::InvalidBase64Value(_)
            | crate::utils::error::Error::IntegerOverflow => Self::InvalidBase64,
            crate::utils::error::Error::ShortBinaryStream => {
                Self::StreamTooShort { need: 0, got: 0 }
            }
        }
    }
}