rusty_crypt 0.3.2

Rust library allowing for a very quick and simple implementation of AES-GCM encryption
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

use thiserror::Error;

/// Errors returned by `rusty_crypt`.
///
/// This enum represents all possible failures that can occur during:
///
/// - AES-256-GCM encryption
/// - AES-256-GCM decryption
/// - Base64 encoding/decoding
/// - Key validation
/// - Nonce validation
/// - Secure random generation
///
/// Every public function in this crate returns a [`Result`] containing
/// either the expected value or a [`CryptoError`].
///
/// # Example
///
/// ```rust
/// use rusty_crypt::{AesGcmDecrypt, CryptoError};
///
/// fn decrypt_data() -> Result<String, CryptoError> {
///     let decryptor = AesGcmDecrypt;
///
///     let decrypted = decryptor.decrypt(
///         "invalid_ciphertext",
///         "invalid_key",
///     )?;
///
///     Ok(decrypted)
/// }
/// ```
#[derive(Debug, Error)]
pub enum CryptoError {
    /// The provided Base64 data is invalid.
    ///
    /// This error can happen when:
    ///
    /// - The encryption key is not valid Base64
    /// - The ciphertext is not valid Base64
    /// - The nonce is not valid Base64
    #[error("Invalid base64")]
    InvalidBase64(#[from] base64::DecodeError),

    /// The AES key size is invalid.
    ///
    /// AES-256-GCM requires exactly:
    ///
    /// ```text
    /// 32 bytes (256 bits)
    /// ```
    ///
    /// Any other key size will be rejected.
    #[error("Invalid key size")]
    InvalidKeySize,

    /// The AES-GCM nonce size is invalid.
    ///
    /// AES-256-GCM requires a nonce of:
    ///
    /// ```text
    /// 12 bytes (96 bits)
    /// ```
    #[error("Invalid nonce size")]
    InvalidNonceSize,

    /// Encryption operation failed.
    ///
    /// This error is returned when AES-GCM cannot encrypt the provided data.
    #[error("Encryption failed")]
    EncryptionFailed,

    /// The ciphertext format is invalid.
    ///
    /// This can happen when:
    ///
    /// - The encrypted data format is incorrect
    /// - The nonce is missing
    /// - The ciphertext structure is corrupted
    #[error("Invalid cipher text")]
    InvalidCiphertext,

    /// Secure random generation failed.
    ///
    /// This error can occur when generating:
    ///
    /// - AES encryption keys
    /// - AES-GCM nonces
    #[error("Random generation failed")]
    RandomGenerationFailed,

    /// Decryption operation failed.
    ///
    /// This error is returned when:
    ///
    /// - The encryption key is incorrect
    /// - The ciphertext was modified
    /// - Authentication verification failed
    #[error("Decryption failed")]
    DecryptionFailed,

    /// The decrypted bytes are not valid UTF-8.
    ///
    /// This error only occurs when decrypting text data.
    ///
    /// Use byte decryption methods such as:
    ///
    /// [`AesGcmDecrypt::decrypt_bytes`](crate::AesGcmDecrypt::decrypt_bytes)
    ///
    /// when working with arbitrary binary data.
    #[error("Invalid UTF-8")]
    InvalidUtf8(#[from] std::string::FromUtf8Error),
}