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
|
use std::convert::TryFrom;
use std::sync::Mutex;
use win_crypto_ng::symmetric as cng;
use crate::crypto::symmetric::Mode;
use crate::{Error, Result};
use crate::types::SymmetricAlgorithm;
impl Mode for Mutex<cng::SymmetricAlgorithmKey> {
fn block_size(&self) -> usize {
self.lock().expect("Mutex not to be poisoned")
.block_size().expect("CNG not to fail internally")
}
fn encrypt(
&mut self,
iv: &mut [u8],
dst: &mut [u8],
src: &[u8],
) -> Result<()> {
let block_size = Mode::block_size(self);
// If necessary, round up to the next block size and pad with zeroes
// NOTE: In theory CFB doesn't need this but CNG always requires
// passing full blocks.
let mut _src = vec![];
let missing = (block_size - (src.len() % block_size)) % block_size;
let src = if missing != 0 {
_src = vec![0u8; src.len() + missing];
&mut _src[..src.len()].copy_from_slice(src);
&_src
} else {
src
};
let len = std::cmp::min(src.len(), dst.len());
// NOTE: `None` IV is required for ECB mode but we don't ever use it.
let buffer = cng::SymmetricAlgorithmKey::encrypt(
&*self.lock().expect("Mutex not to be poisoned"),
Some(iv), src, None)?;
Ok(dst[..len].copy_from_slice(&buffer.as_slice()[..len]))
}
fn decrypt(
&mut self,
iv: &mut [u8],
dst: &mut [u8],
src: &[u8],
) -> Result<()> {
let block_size = Mode::block_size(self);
// If necessary, round up to the next block size and pad with zeroes
// NOTE: In theory CFB doesn't need this but CNG always requires
// passing full blocks.
let mut _src = vec![];
let missing = (block_size - (src.len() % block_size)) % block_size;
let src = if missing != 0 {
_src = vec![0u8; src.len() + missing];
&mut _src[..src.len()].copy_from_slice(src);
&_src
} else {
src
};
let len = std::cmp::min(src.len(), dst.len());
// NOTE: `None` IV is required for ECB mode but we don't ever use it.
let buffer = cng::SymmetricAlgorithmKey::decrypt(
&*self.lock().expect("Mutex not to be poisoned"),
Some(iv), src, None)?;
dst[..len].copy_from_slice(&buffer.as_slice()[..len]);
Ok(())
}
}
#[derive(Debug, thiserror::Error)]
#[error("Unsupported algorithm: {0}")]
pub struct UnsupportedAlgorithm(SymmetricAlgorithm);
assert_send_and_sync!(UnsupportedAlgorithm);
impl From<UnsupportedAlgorithm> for Error {
fn from(value: UnsupportedAlgorithm) -> Error {
Error::UnsupportedSymmetricAlgorithm(value.0)
}
}
impl TryFrom<SymmetricAlgorithm> for (cng::SymmetricAlgorithmId, usize) {
type Error = UnsupportedAlgorithm;
fn try_from(value: SymmetricAlgorithm) -> std::result::Result<Self, Self::Error> {
Ok(match value {
SymmetricAlgorithm::TripleDES => (cng::SymmetricAlgorithmId::TripleDes, 168),
SymmetricAlgorithm::AES128 => (cng::SymmetricAlgorithmId::Aes, 128),
SymmetricAlgorithm::AES192 => (cng::SymmetricAlgorithmId::Aes, 192),
SymmetricAlgorithm::AES256 => (cng::SymmetricAlgorithmId::Aes, 256),
algo => Err(UnsupportedAlgorithm(algo))?,
})
}
}
impl SymmetricAlgorithm {
/// Returns whether this algorithm is supported by the crypto backend.
///
/// All backends support all the AES variants.
///
/// # Examples
///
/// ```rust
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::SymmetricAlgorithm;
///
/// assert!(SymmetricAlgorithm::AES256.is_supported());
/// assert!(SymmetricAlgorithm::TripleDES.is_supported());
///
/// assert!(!SymmetricAlgorithm::IDEA.is_supported());
/// assert!(!SymmetricAlgorithm::Unencrypted.is_supported());
/// assert!(!SymmetricAlgorithm::Private(101).is_supported());
/// ```
pub fn is_supported(&self) -> bool {
use self::SymmetricAlgorithm::*;
match self {
AES128 | AES192 | AES256 | TripleDES => true,
_ => false,
}
}
/// Length of a key for this algorithm in bytes. Fails if the crypto
/// backend does not support this algorithm.
pub fn key_size(self) -> Result<usize> {
Ok(match self {
SymmetricAlgorithm::TripleDES => 24,
SymmetricAlgorithm::AES128 => 16,
SymmetricAlgorithm::AES192 => 24,
SymmetricAlgorithm::AES256 => 32,
_ => Err(UnsupportedAlgorithm(self))?,
})
}
/// Length of a block for this algorithm in bytes. Fails if the crypto
/// backend does not support this algorithm.
pub fn block_size(self) -> Result<usize> {
Ok(match self {
SymmetricAlgorithm::TripleDES => 8,
SymmetricAlgorithm::AES128 => 16,
SymmetricAlgorithm::AES192 => 16,
SymmetricAlgorithm::AES256 => 16,
_ => Err(UnsupportedAlgorithm(self))?,
})
}
/// Creates a symmetric cipher context for encrypting in CFB mode.
pub(crate) fn make_encrypt_cfb(self, key: &[u8]) -> Result<Box<dyn Mode>> {
let (algo, _) = TryFrom::try_from(self)?;
let algo = cng::SymmetricAlgorithm::open(algo, cng::ChainingMode::Cfb)?;
let mut key = algo.new_key(key)?;
// Use full-block CFB mode as expected everywhere else (by default it's
// set to 8-bit CFB)
key.set_msg_block_len(key.block_size()?)?;
Ok(Box::new(Mutex::new(key)))
}
/// Creates a symmetric cipher context for decrypting in CFB mode.
pub(crate) fn make_decrypt_cfb(self, key: &[u8]) -> Result<Box<dyn Mode>> {
Self::make_encrypt_cfb(self, key)
}
/// Creates a Nettle context for encrypting in CBC mode.
pub(crate) fn make_encrypt_cbc(self, key: &[u8]) -> Result<Box<dyn Mode>> {
let (algo, _) = TryFrom::try_from(self)?;
let algo = cng::SymmetricAlgorithm::open(algo, cng::ChainingMode::Cbc)?;
Ok(Box::new(Mutex::new(
algo.new_key(key).expect(
"CNG to successfully create a symmetric key for valid/supported algorithm"
)
)))
}
/// Creates a Nettle context for decrypting in CBC mode.
pub(crate) fn make_decrypt_cbc(self, key: &[u8]) -> Result<Box<dyn Mode>> {
let (algo, _) = TryFrom::try_from(self)?;
let algo = cng::SymmetricAlgorithm::open(algo, cng::ChainingMode::Cbc)?;
Ok(Box::new(Mutex::new(
algo
|
