ockam_vault 0.132.0

A software-only Ockam Vault implementation.
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

use cfg_if::cfg_if;

use crate::{HandleToSecret, SecretBufferHandle};
use ockam_core::compat::vec::Vec;

/// SHA256 digest length
pub const SHA256_LENGTH: usize = 32;

/// SHA-256 Output.
pub struct Sha256Output(pub [u8; SHA256_LENGTH]);

/// Handle to an AES-256 Secret Key.
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
pub struct AeadSecretKeyHandle(pub AeadSecretKeyHandleType);

impl AeadSecretKeyHandle {
    /// Constructor
    pub fn new(handle: HandleToSecret) -> Self {
        Self(AeadSecretKeyHandleType::new(handle))
    }
}

cfg_if! {
    if #[cfg(any(not(feature = "disable_default_noise_protocol"), feature = "OCKAM_XX_25519_AES256_GCM_SHA256"))] {
        /// Hash used for Noise handshake.
        pub struct HashOutput(pub Sha256Output);

        /// SHA-256 HKDF Output.
        pub struct Sha256HkdfOutput(pub Vec<SecretBufferHandle>);

        /// HKDF Output.
        pub struct HkdfOutput(pub Sha256HkdfOutput);

        /// Handle to an AES-256 Secret Key.
        #[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
        pub struct Aes256GcmSecretKeyHandle(pub HandleToSecret);

        impl Aes256GcmSecretKeyHandle {
            /// Constructor
            pub fn new(handle: HandleToSecret) -> Self {
                Self(handle)
            }
        }

        /// Handle to a AEAD Secret Key.
        pub type AeadSecretKeyHandleType = Aes256GcmSecretKeyHandle;
    } else if #[cfg(feature = "OCKAM_XX_25519_AES128_GCM_SHA256")] {
        /// Hash used for Noise handshake.
        pub struct HashOutput(pub Sha256Output);

        /// SHA-256 HKDF Output.
        pub struct Sha256HkdfOutput(pub Vec<SecretBufferHandle>);

        /// HKDF Output.
        pub struct HkdfOutput(pub Sha256HkdfOutput);

        /// Handle to an AES-128 Secret Key.
        #[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
        pub struct Aes128GcmSecretKeyHandle(pub HandleToSecret);

        impl Aes128GcmSecretKeyHandle {
            /// Constructor
            pub fn new(handle: HandleToSecret) -> Self {
                Self(handle)
            }
        }

        /// Handle to a AEAD Secret Key.
        pub type AeadSecretKeyHandleType = Aes128GcmSecretKeyHandle;
    } else if #[cfg(feature = "OCKAM_XX_25519_ChaChaPolyBLAKE2s")] {
        /// Blake2s digest length
        pub const BLAKE2S_LENGTH: usize = 32;

        /// Blake2s Output.
        pub struct Blake2sOutput(pub [u8; BLAKE2S_LENGTH]);

        /// Hash used for Noise handshake.
        pub struct HashOutput(pub Blake2sOutput);

        /// Blake2s HKDF Output.
        pub struct Blake2sHkdfOutput(Vec<SecretBufferHandle>);

        /// HKDF Output.
        pub struct HkdfOutput(pub Blake2sHkdfOutput);

        /// Handle to a ChaCha20-Poly1305 Secret Key.
        #[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
        pub struct Chacha20Poly1305SecretKeyHandle(pub HandleToSecret);

        impl Chacha20Poly1305SecretKeyHandle {
            /// Constructor
            pub fn new(handle: HandleToSecret) -> Self {
                Self(handle)
            }
        }

        /// Handle to a AEAD Secret Key.
        pub type AeadSecretKeyHandleType = Chacha20Poly1305SecretKeyHandle;
    }
}