rskit-encryption 0.1.0-alpha.2

Encryption utilities: AES-256-GCM and ChaCha20-Poly1305
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

//! Core encryption traits and types.

use rskit_errors::AppResult;

/// Supported encryption algorithms.
#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Algorithm {
    /// AES-256-GCM (default, widely supported with hardware acceleration)
    AesGcm,
    /// ChaCha20-Poly1305 (modern, performant on CPUs without AES-NI)
    ChaCha20Poly1305,
}

impl Algorithm {
    /// Returns the algorithm name as a string.
    pub fn name(&self) -> &'static str {
        match self {
            Self::AesGcm => "aes-256-gcm",
            Self::ChaCha20Poly1305 => "chacha20-poly1305",
        }
    }

    pub(crate) const fn id(self) -> u8 {
        match self {
            Self::AesGcm => 1,
            Self::ChaCha20Poly1305 => 2,
        }
    }

    pub(crate) fn from_id(id: u8) -> Option<Self> {
        match id {
            1 => Some(Self::AesGcm),
            2 => Some(Self::ChaCha20Poly1305),
            _ => None,
        }
    }
}

impl std::fmt::Display for Algorithm {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.name())
    }
}

/// Trait for symmetric encryption and decryption operations.
///
/// Implementations are thread-safe and can be shared across async boundaries.
pub trait Encryptor: Send + Sync {
    /// Encrypts plaintext and returns base64-encoded ciphertext.
    ///
    /// The ciphertext includes a random nonce prepended to the encrypted data,
    /// so each call to encrypt with the same plaintext produces different output.
    fn encrypt(&self, plaintext: &[u8]) -> AppResult<String>;

    /// Decrypts base64-encoded ciphertext and returns the plaintext.
    fn decrypt(&self, ciphertext: &str) -> AppResult<Vec<u8>>;

    /// Returns the algorithm used by this encryptor.
    fn algorithm(&self) -> Algorithm;
}