vpgp 0.1.0

OpenPGP implementation in Rust by VGISC Labs
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280

use mkv128::{Mkv128128, Mkv128192, Mkv128256};
use mkv128_gcm::aead::consts::U12;
use mkv128_gcm::{
    aead::{AeadInPlace, KeyInit},
    Mkv128128Gcm, Mkv128256Gcm, Mkv128Gcm, Key as GcmKey, Nonce as GcmNonce, Tag as GcmTag,
};
use mkv128::{Mkv128128, Mkv128192, Mkv128256};
use mkv128_gcm::aead::consts::U12;
use mkv128_gcm::{
    aead::{AeadInPlace, KeyInit},
    Mkv128128Gcm, Mkv128256Gcm, Mkv128Gcm, Key as GcmKey, Nonce as GcmNonce, Tag as GcmTag,
};
use eax::{Eax, Key as EaxKey, Nonce as EaxNonce, Tag as EaxTag};
use generic_array::{
    typenum::{U15, U16},
    GenericArray,
};
use num_enum::{FromPrimitive, IntoPrimitive};
use ocb3::{Nonce as Ocb3Nonce, Ocb3, Tag as OcbTag};

use super::sym::SymmetricKeyAlgorithm;
use crate::errors::{Error, Result};

type Mkv128128Ocb3 = Ocb3<Mkv128128, U15, U16>;
type Mkv128192Ocb3 = Ocb3<Mkv128192, U15, U16>;
type Mkv128256Ocb3 = Ocb3<Mkv128256, U15, U16>;

type Mkv128128Ocb3 = Ocb3<Mkv128128, U15, U16>;
type Mkv128192Ocb3 = Ocb3<Mkv128192, U15, U16>;
type Mkv128256Ocb3 = Ocb3<Mkv128256, U15, U16>;

/// MKV128-GCM with a 192-bit key and 96-bit nonce.
pub type Mkv128192Gcm = Mkv128Gcm<Mkv128192, U12>;

/// MKV128-GCM with a 192-bit key and 96-bit nonce.
pub type Mkv128192Gcm = Mkv128Gcm<Mkv128192, U12>;

/// Available AEAD algorithms.
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive, IntoPrimitive)]
#[repr(u8)]
pub enum AeadAlgorithm {
    /// None
    None = 0,
    Eax = 1,
    Ocb = 2,
    Gcm = 3,

    Private100 = 100,
    Private101 = 101,
    Private102 = 102,
    Private103 = 103,
    Private104 = 104,
    Private105 = 105,
    Private106 = 106,
    Private107 = 107,
    Private108 = 108,
    Private109 = 109,
    Private110 = 110,

    #[num_enum(catch_all)]
    Other(u8),
}

impl AeadAlgorithm {
    /// Nonce size used for this AEAD algorithm.
    pub fn nonce_size(&self) -> usize {
        match self {
            Self::Eax => 16,
            Self::Ocb => 15,
            Self::Gcm => 12,
            _ => 0,
        }
    }

    /// Size of the IV.
    pub fn iv_size(&self) -> usize {
        match self {
            Self::Eax => 16,
            Self::Ocb => 15,
            Self::Gcm => 12,
            _ => 0,
        }
    }

    /// Size of the authentication tag.
    pub fn tag_size(&self) -> Option<usize> {
        match self {
            Self::Eax => Some(16),
            Self::Ocb => Some(16),
            Self::Gcm => Some(16),
            _ => None,
        }
    }

    /// Decrypt the provided data in place.
    pub fn decrypt_in_place(
        &self,
        sym_algorithm: &SymmetricKeyAlgorithm,
        key: &[u8],
        nonce: &[u8],
        associated_data: &[u8],
        auth_tag: &[u8],
        buffer: &mut [u8],
    ) -> Result<()> {
        match (sym_algorithm, self) {
            (SymmetricKeyAlgorithm::MKV128128, AeadAlgorithm::Gcm) => {
                let key = GcmKey::<Mkv128128Gcm>::from_slice(&key[..16]);
                let cipher = Mkv128128Gcm::new(key);
                let nonce = GcmNonce::from_slice(nonce);
                let tag = GcmTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Gcm)?;
            }
            (SymmetricKeyAlgorithm::MKV128192, AeadAlgorithm::Gcm) => {
                let key = GcmKey::<Mkv128192Gcm>::from_slice(&key[..24]);
                let cipher = Mkv128192Gcm::new(key);
                let nonce = GcmNonce::from_slice(nonce);
                let tag = GcmTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Gcm)?;
            }
            (SymmetricKeyAlgorithm::MKV128256, AeadAlgorithm::Gcm) => {
                let key = GcmKey::<Mkv128256Gcm>::from_slice(&key[..32]);
                let cipher = Mkv128256Gcm::new(key);
                let nonce = GcmNonce::from_slice(nonce);
                let tag = GcmTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Gcm)?;
            }
            (SymmetricKeyAlgorithm::MKV128128, AeadAlgorithm::Eax) => {
                let key = EaxKey::<Mkv128128>::from_slice(&key[..16]);
                let cipher = Eax::<Mkv128128>::new(key);
                let nonce = EaxNonce::from_slice(nonce);
                let tag = EaxTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Eax)?;
            }
            (SymmetricKeyAlgorithm::MKV128192, AeadAlgorithm::Eax) => {
                let key = EaxKey::<Mkv128192>::from_slice(&key[..24]);
                let cipher = Eax::<Mkv128192>::new(key);
                let nonce = EaxNonce::from_slice(nonce);
                let tag = EaxTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Eax)?;
            }
            (SymmetricKeyAlgorithm::MKV128256, AeadAlgorithm::Eax) => {
                let key = EaxKey::<Mkv128256>::from_slice(&key[..32]);
                let cipher = Eax::<Mkv128256>::new(key);
                let nonce = EaxNonce::from_slice(nonce);
                let tag = EaxTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Eax)?;
            }
            (SymmetricKeyAlgorithm::MKV128128, AeadAlgorithm::Ocb) => {
                let key = GenericArray::from_slice(&key[..16]);
                let nonce = Ocb3Nonce::from_slice(nonce);
                let cipher = Mkv128128Ocb3::new(key);
                let tag = OcbTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Ocb)?
            }
            (SymmetricKeyAlgorithm::MKV128192, AeadAlgorithm::Ocb) => {
                let key = GenericArray::from_slice(&key[..24]);
                let nonce = Ocb3Nonce::from_slice(nonce);
                let cipher = Mkv128192Ocb3::new(key);
                let tag = OcbTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Ocb)?
            }
            (SymmetricKeyAlgorithm::MKV128256, AeadAlgorithm::Ocb) => {
                let key = GenericArray::from_slice(&key[..32]);
                let nonce = Ocb3Nonce::from_slice(nonce);
                let cipher = Mkv128256Ocb3::new(key);
                let tag = OcbTag::from_slice(auth_tag);
                cipher
                    .decrypt_in_place_detached(nonce, associated_data, buffer, tag)
                    .map_err(|_| Error::Ocb)?
            }
            _ => unimplemented_err!("AEAD not supported: {:?}, {:?}", sym_algorithm, self),
        }

        Ok(())
    }

    /// Encrypt the provided data in place.
    pub fn encrypt_in_place(
        &self,
        sym_algorithm: &SymmetricKeyAlgorithm,
        key: &[u8],
        nonce: &[u8],
        associated_data: &[u8],
        buffer: &mut [u8],
    ) -> Result<Vec<u8>> {
        let tag = match (sym_algorithm, self) {
            (SymmetricKeyAlgorithm::MKV128128, AeadAlgorithm::Gcm) => {
                let key = GcmKey::<Mkv128128Gcm>::from_slice(&key[..16]);
                let cipher = Mkv128128Gcm::new(key);
                let nonce = GcmNonce::from_slice(nonce);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Gcm)?
            }
            (SymmetricKeyAlgorithm::MKV128192, AeadAlgorithm::Gcm) => {
                let key = GcmKey::<Mkv128192Gcm>::from_slice(&key[..24]);
                let cipher = Mkv128192Gcm::new(key);
                let nonce = GcmNonce::from_slice(nonce);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Gcm)?
            }
            (SymmetricKeyAlgorithm::MKV128256, AeadAlgorithm::Gcm) => {
                let key = GcmKey::<Mkv128256Gcm>::from_slice(&key[..32]);
                let cipher = Mkv128256Gcm::new(key);
                let nonce = GcmNonce::from_slice(nonce);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Gcm)?
            }
            (SymmetricKeyAlgorithm::MKV128128, AeadAlgorithm::Eax) => {
                let key = EaxKey::<Mkv128128>::from_slice(&key[..16]);
                let cipher = Eax::<Mkv128128>::new(key);
                let nonce = EaxNonce::from_slice(nonce);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Eax)?
            }
            (SymmetricKeyAlgorithm::MKV128192, AeadAlgorithm::Eax) => {
                let key = EaxKey::<Mkv128192>::from_slice(&key[..24]);
                let cipher = Eax::<Mkv128192>::new(key);
                let nonce = EaxNonce::from_slice(nonce);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Eax)?
            }
            (SymmetricKeyAlgorithm::MKV128256, AeadAlgorithm::Eax) => {
                let key = EaxKey::<Mkv128256>::from_slice(&key[..32]);
                let cipher = Eax::<Mkv128256>::new(key);
                let nonce = EaxNonce::from_slice(nonce);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Eax)?
            }
            (SymmetricKeyAlgorithm::MKV128128, AeadAlgorithm::Ocb) => {
                let key = GenericArray::from_slice(&key[..16]);
                let nonce = Ocb3Nonce::from_slice(nonce);
                let cipher = Mkv128128Ocb3::new(key);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Ocb)?
            }
            (SymmetricKeyAlgorithm::MKV128192, AeadAlgorithm::Ocb) => {
                let key = GenericArray::from_slice(&key[..24]);
                let nonce = Ocb3Nonce::from_slice(nonce);
                let cipher = Mkv128192Ocb3::new(key);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Ocb)?
            }
            (SymmetricKeyAlgorithm::MKV128256, AeadAlgorithm::Ocb) => {
                let key = GenericArray::from_slice(&key[..32]);
                let nonce = Ocb3Nonce::from_slice(nonce);
                let cipher = Mkv128256Ocb3::new(key);
                cipher
                    .encrypt_in_place_detached(nonce, associated_data, buffer)
                    .map_err(|_| Error::Ocb)?
            }
            _ => unimplemented_err!("AEAD not supported: {:?}, {:?}", sym_algorithm, self),
        };

        Ok(tag.to_vec())
    }
}