obcrypt 1.0.0-rc1

Bytes-in/bytes-out cryptographic core of the oboron protocol (authenticated core schemes, no encoding).
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

//! Error types returned by obcrypt operations.

use thiserror::Error;

/// All errors that can occur in obcrypt operations.
///
/// `#[non_exhaustive]` — new variants may be added in minor releases.
/// Match with a wildcard arm if you exhaustively-match in your code.
#[non_exhaustive]
#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum Error {
    /// `Key::from_slice` was called with a slice whose length isn't 64.
    #[error("key must be 64 bytes")]
    InvalidKeyLength,

    /// `Key::from_hex` was called with a string that isn't valid hex
    /// or doesn't decode to exactly 64 bytes (i.e. isn't 128 hex
    /// characters).
    #[error("invalid hex key (expected 128 hex characters)")]
    InvalidHex,

    /// [`Scheme::from_str`](crate::Scheme) could not match the input to
    /// any feature-enabled scheme.
    #[error("unknown scheme")]
    UnknownScheme,

    /// The underlying AEAD primitive reported a generic encryption
    /// failure (in practice: out-of-memory or RNG failure).
    #[error("encryption failed")]
    EncryptionFailed,

    /// `encrypt*` was called with `plaintext.is_empty()`.
    #[error("encryption failed: empty plaintext")]
    EmptyPlaintext,

    /// AEAD tag check failed. Indicates a wrong key, a tampered
    /// ciphertext, or the wrong scheme supplied for decryption.
    #[error("decryption failed")]
    DecryptionFailed,

    /// `decrypt*` (mock schemes) was called with `payload.is_empty()`.
    #[error("decryption failed: empty payload")]
    EmptyPayload,

    /// The scheme output is shorter than the scheme's minimum layout
    /// length (e.g. a SIV tag, or a probabilistic scheme's nonce plus
    /// tag) — so it cannot be a valid output.
    #[error("decryption failed: payload too short")]
    PayloadTooShort,
}