zymic_core 0.1.1

Core library providing the primitives and streaming APIs for the Zymic authenticated encryption format.
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

// SPDX-License-Identifier: MIT
//! Error types for the Zymic core crate.
use alloc::string::{String, ToString};
use core::fmt;

#[derive(Debug, Clone, PartialEq)]
pub struct Error {
    kind: ErrorKind,
}

#[derive(Debug, Clone, PartialEq)]
pub(crate) enum ErrorKind {
    Authentication,
    Cipher(String),
    #[cfg(feature = "std")]
    IntegerOverflow,
    InvalidArgument,
    InvalidArrayLength(usize, usize),
    InvalidBufLength,
    InvalidEndLength(u32),
    InvalidFrameLength(u8),
    InvalidMagicNumber(u32),
    #[cfg(feature = "std")]
    Io(String),
    ParentKeyIdMismatch,
    #[cfg(feature = "rand_core")]
    Rng(String),
    #[cfg(feature = "std")]
    Truncation,
    TryFromInt(core::num::TryFromIntError),
    #[cfg(feature = "std")]
    UnexpectedEof,
    UnexpectedSeqNum(u32, u32),
    UnsupportedCrypto(u16),
    UnsupportedVersion(u8),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match &self.kind {
            ErrorKind::Authentication => write!(f, "authentication failure"),
            ErrorKind::Cipher(e) => write!(f, "cipher failure: {e}"),
            #[cfg(feature = "std")]
            ErrorKind::IntegerOverflow => write!(f, "integer overflow"),
            ErrorKind::InvalidArgument => write!(f, "invalid argument"),
            ErrorKind::InvalidArrayLength(e, r) => {
                write!(f, "invalid array length: expected {e}, received {r}")
            }
            ErrorKind::InvalidBufLength => write!(f, "invalid buffer length"),
            ErrorKind::InvalidEndLength(n) => {
                write!(f, "invalid end length of {n} bytes")
            }
            ErrorKind::InvalidFrameLength(n) => {
                write!(f, "invalid frame length of 2^{n} bytes")
            }
            ErrorKind::InvalidMagicNumber(n) => write!(f, "invalid magic number: {n}"),
            #[cfg(feature = "std")]
            ErrorKind::Io(e) => write!(f, "I/O error: {e}"),
            ErrorKind::ParentKeyIdMismatch => write!(
                f,
                "parent key ID does not match the parent key ID found in the header"
            ),
            #[cfg(feature = "rand_core")]
            ErrorKind::Rng(e) => write!(f, "failed to generate random data: {e}"),
            #[cfg(feature = "std")]
            ErrorKind::Truncation => write!(f, "data has been truncated"),
            ErrorKind::TryFromInt(e) => write!(f, "integer conversion failure: {e}"),
            #[cfg(feature = "std")]
            ErrorKind::UnexpectedEof => write!(f, "unexpected end of file"),
            ErrorKind::UnexpectedSeqNum(e, r) => write!(
                f,
                "unexpected sequence number: expected {e}, but received {r}"
            ),
            ErrorKind::UnsupportedCrypto(v) => write!(f, "unsupported crypto algorithm: {v}"),
            ErrorKind::UnsupportedVersion(v) => write!(f, "unsupported version: {v}"),
        }?;
        Ok(())
    }
}

impl Error {
    pub(crate) fn new(kind: ErrorKind) -> Self {
        Self { kind }
    }

    #[cfg(test)]
    pub(crate) fn kind(&self) -> &ErrorKind {
        &self.kind
    }
}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl std::error::Error for Error {}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl From<std::io::Error> for Error {
    fn from(error: std::io::Error) -> Self {
        Self::new(ErrorKind::Io(error.to_string()))
    }
}

#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
impl From<Error> for std::io::Error {
    fn from(error: Error) -> Self {
        Self::other(error)
    }
}

impl From<aes_gcm::Error> for Error {
    fn from(error: aes_gcm::Error) -> Self {
        Self::new(ErrorKind::Cipher(error.to_string()))
    }
}

impl From<core::num::TryFromIntError> for Error {
    fn from(error: core::num::TryFromIntError) -> Self {
        Self::new(ErrorKind::TryFromInt(error))
    }
}