quantum-shield 0.3.1

Hybrid post-quantum cryptography: X25519 + ML-KEM-1024 encryption and Ed25519 + ML-DSA-87 signatures
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

//! Error types for quantum-shield.
//!
//! Decryption and verification failures are deliberately opaque: they carry
//! no algorithm-specific detail, so callers cannot accidentally build a
//! padding/format oracle out of the error messages.

/// Result type alias for quantum-shield operations.
pub type Result<T> = core::result::Result<T, Error>;

/// Errors that can occur during cryptographic operations.
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// The wire object declares a format version this crate does not support.
    #[error("unsupported wire format version {0}")]
    UnsupportedVersion(u8),

    /// The wire object declares a cipher suite this crate does not support.
    #[error("unsupported cipher suite {0}")]
    UnsupportedSuite(u8),

    /// The input is a quantum-shield 0.1.x JSON artifact. The v1 format is
    /// cryptographically broken and unsupported by design.
    #[error(
        "quantum-shield v1 (0.1.x) artifacts are not supported; \
         decrypt with a 0.1.x build and re-encrypt with v2"
    )]
    LegacyV1Artifact,

    /// Key material failed to parse or validate.
    #[error("invalid key material")]
    InvalidKey,

    /// An envelope failed to parse (wrong magic, truncated, or malformed).
    #[error("invalid envelope encoding")]
    InvalidEnvelope,

    /// A signature failed to parse (wrong magic, truncated, or malformed).
    #[error("invalid signature encoding")]
    InvalidSignature,

    /// Decryption failed. No further detail is provided by design.
    #[error("decryption failed")]
    DecryptionFailed,

    /// Signature verification failed. No further detail is provided by design.
    #[error("signature verification failed")]
    VerificationFailed,

    /// The plaintext exceeds [`MAX_PLAINTEXT_LEN`](crate::MAX_PLAINTEXT_LEN).
    #[error("message too large: {len} bytes exceeds the {max}-byte limit")]
    MessageTooLarge {
        /// Length of the rejected message in bytes.
        len: usize,
        /// The enforced limit in bytes.
        max: usize,
    },

    /// The signing context exceeds [`MAX_CONTEXT_LEN`](crate::MAX_CONTEXT_LEN).
    #[error("context longer than 255 bytes")]
    ContextTooLong,

    /// The operating system's secure random number generator failed.
    #[error("operating system randomness unavailable")]
    RandomnessUnavailable,

    /// A multi-recipient envelope was requested with no recipients.
    #[error("no recipients")]
    NoRecipients,

    /// A multi-recipient envelope exceeds [`MAX_RECIPIENTS`](crate::MAX_RECIPIENTS).
    #[error("too many recipients: {count} exceeds the {max} limit")]
    TooManyRecipients {
        /// The rejected recipient count.
        count: usize,
        /// The enforced limit.
        max: usize,
    },

    /// A streaming chunk was submitted after the final chunk.
    #[error("stream already finished")]
    StreamFinished,

    /// A stream ended without a final chunk (possible truncation).
    #[error("stream truncated")]
    StreamTruncated,
}