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
use alloc::{
string::{String, ToString},
vec::Vec,
};
use crate::{
error::{
DisableKeyError, DuplicatePubIdError, KeyNotFoundError, MalformedError, OpenError,
RemoveKeyError, SealError,
},
jose::{Claims, VerifiedJws},
key::Key,
keyring::Keyring,
Aad, Envelope, Metadata, Origin, Primitive, Rng, Status, SystemRng, Verifier,
};
#[cfg(not(feature = "std"))]
type Set<V> = alloc::collections::BTreeSet<V>;
use super::{Algorithm, KeyInfo, KeyringInfo, Material, Signature, SigningKey};
#[derive(Clone, Debug)]
pub struct Signer {
keyring: Keyring<SigningKey>,
verifier: Verifier,
}
impl Signer {
/// Opens a [`Signer`] keyring from the given `data` and validates the
/// authenticity with `aad` by means of the [`Envelope`] `envelope`.
///
/// # Errors
/// Errors if the keyring could not be opened by the or the authenticity
/// could not be verified by the [`Envelope`] using futures.
///
/// # Example
/// ```rust
/// use navajo::Aad;
/// use navajo::dsa::{ Signer, Algorithm };
/// use navajo::envelope::InMemory;
///
/// #[tokio::main]
/// async fn main() {
/// let signer = Signer::new(Algorithm::Ed25519, None /* Option<String> */, None /* Option<navajo::Metadata> */);
/// let primary_key = signer.primary_key();
/// // in a real application, you would use a real key management service.
/// // InMemory is only suitable for testing.
/// let in_mem = InMemory::default();
/// let data = Signer::seal(Aad::empty(), &signer, &in_mem).await.unwrap();
/// let signer = Signer::open(Aad::empty(), data, &in_mem).await.unwrap();
/// assert_eq!(signer.primary_key(), primary_key);
/// }
/// ```
pub async fn open<A, D, E>(aad: Aad<A>, data: D, envelope: &E) -> Result<Self, OpenError>
where
E: 'static + Envelope,
D: 'static + AsRef<[u8]> + Send + Sync,
A: 'static + AsRef<[u8]> + Send + Sync,
{
let primitive = Primitive::open(aad, data, envelope).await?;
primitive
.signer()
.ok_or(OpenError("primitive is not Signer".into()))
}
/// Opens a [`Signer`] keyring from the given `data` and validates the
/// authenticity with `aad` by means of the [`Envelope`] using
/// blocking APIs.
///
/// # Errors
/// Errors if the keyring could not be opened by the or the authenticity
/// could not be verified by the [`Envelope`].
///
/// # Example
/// ```rust
/// use navajo::Aad;
/// use navajo::dsa::{ Signer, Algorithm };
/// use navajo::envelope::InMemory;
///
/// let signer = Signer::new(Algorithm::Ed25519, None /* Option<String> */, None /* Option<navajo::Metadata> */);
/// let primary_key = signer.primary_key();
/// // in a real application, you would use a real key management service.
/// // InMemory is only suitable for testing.
/// let in_mem = InMemory::default();
/// let data = Signer::seal_sync(Aad(&b"associated data"), &signer, &in_mem).unwrap();
/// let signer = Signer::open_sync(Aad(&b"associated data"), &data, &in_mem).unwrap();
/// assert_eq!(signer.primary_key(), primary_key);
/// ```
pub fn open_sync<A, E, C>(aad: Aad<A>, ciphertext: C, envelope: &E) -> Result<Self, OpenError>
where
A: AsRef<[u8]>,
C: AsRef<[u8]>,
E: 'static + crate::envelope::sync::Envelope,
{
let primitive = Primitive::open_sync(aad, ciphertext, envelope)?;
if let Some(signer) = primitive.signer() {
Ok(signer)
} else {
Err(OpenError("primitive is not a signer".into()))
}
}
/// Seals an [`Signer`] keyring and tags it with `aad` for future
/// authenticationby means of the [`Envelope`].
///
/// # Errors
/// Errors if the keyring could not be sealed by the [`Envelope`].
///
/// # Example
/// ```rust
/// use navajo::Aad;
/// use navajo::dsa::{ Signer, Algorithm };
/// use navajo::envelope::InMemory;
///
/// #[tokio::main]
/// async fn main() {
/// let signer = Signer::new(Algorithm::Ed25519, None /* Option<String> */, None /* Option<navajo::Metadata> */);
/// let primary_key = signer.primary_key();
/// // in a real application, you would use a real key management service.
/// // InMemory is only suitable for testing.
/// let in_mem = InMemory::default();
/// let data = Signer::seal(Aad::empty(), &signer, &in_mem).await.unwrap();
/// let signer = Signer::open(Aad::empty(), data, &in_mem).await.unwrap();
/// assert_eq!(signer.primary_key(), primary_key);
/// }
/// ```
pub async fn seal<A, E>(aad: Aad<A>, signer: &Self, envelope: &E) -> Result<Vec<u8>, SealError>
where
A: 'static + AsRef<[u8]> + Send + Sync,
E: Envelope + 'static,
{
Primitive::Dsa(signer.clone()).seal(aad, envelope).await
}
/// Seals a [`Signer`] keyring and tags it with `aad` for future
/// authenticationby means of the [`Envelope`].
///
/// # Errors
/// Errors if the keyring could not be sealed by the [`Envelope`].
///
/// # Example
/// ```rust
/// use navajo::Aad;
/// use navajo::dsa::{ Signer, Algorithm };
/// use navajo::envelope::InMemory;
///
/// let signer = Signer::new(Algorithm::Ed25519, None /* Option<String> */, None /* Option<navajo::Metadata> */);
/// let primary_key = signer.primary_key();
/// // in a real application, you would use a real key management service.
/// // InMemory is only suitable for testing.
/// let in_mem = InMemory::default();
/// let ciphertext = Signer::seal_sync(Aad::empty(), &signer, &in_mem).unwrap();
/// let signer = Signer::open_sync(Aad::empty(), ciphertext, &in_mem).unwrap();
/// assert_eq!(signer.primary_key(), primary_key);
/// ```
pub fn seal_sync<A, E>(aad: Aad<A>, signer: &Self, envelope: &E) -> Result<Vec<u8>, SealError>
where
A: AsRef<[u8]>,
E: 'static + crate::envelope::sync::Envelope,
{
Primitive::Dsa(signer.clone()).seal_sync(aad, envelope)
}
pub fn new(algorithm: Algorithm, pub_id: Option<String>, meta: Option<Metadata>) -> Self {
Self::generate(&SystemRng, algorithm, pub_id, meta)
}
pub(crate) fn from_keyring(keyring: Keyring<SigningKey>) -> Self {
let verifier = Verifier::from_keyring(keyring.clone());
Self { keyring, verifier }
}
fn generate<N>(
rng: &N,
algorithm: Algorithm,
pub_id: Option<String>,
metadata: Option<Metadata>,
) -> Self
where
N: Rng,
{
let id = rng.u32().unwrap();
let key = SigningKey::generate(
rng,
algorithm,
pub_id.unwrap_or(id.to_string()),
metadata.clone(),
);
let key = Key::new(id, Status::Primary, crate::Origin::Navajo, key, metadata);
let keyring = Keyring::new(key);
let verifier = Verifier::from_keyring(keyring.clone());
Self { keyring, verifier }
}
pub(crate) fn keyring(&self) -> &Keyring<Material> {
&self.keyring
}
pub fn keys(&self) -> Vec<KeyInfo> {
self.keyring.keys().iter().map(Into::into).collect()
}
pub fn add(
&mut self,
algorithm: Algorithm,
pub_id: Option<String>,
metadata: Option<Metadata>,
) -> Result<KeyInfo, DuplicatePubIdError> {
let id = self.keyring.next_id(&SystemRng);
let pub_id = pub_id.unwrap_or(id.to_string());
let signing_key = SigningKey::generate(&SystemRng, algorithm, pub_id, metadata.clone());
let verifying_key = signing_key.verifying_key.clone();
let key = Key::new(id, Status::Enabled, Origin::Navajo, signing_key, metadata);
self.keyring.add(key.clone());
self.verifier.add(verifying_key)?;
Ok(key.into())
}
pub fn primary_key(&self) -> KeyInfo {
self.keyring.primary().into()
}
pub fn primary_key_id(&self) -> &str {
self.keyring.primary().pub_id()
}
pub fn sign(&self, message: &[u8]) -> Signature {
self.keyring.primary().sign(message)
}
pub fn sign_jws<'t>(&self, claims: Claims) -> Result<VerifiedJws<'t>, MalformedError> {
self.keyring.primary().sign_jws(claims)
}
pub fn verifier(&self) -> Verifier {
self.verifier.clone()
}
pub fn promote(&mut self, key_id: u32) -> Result<KeyInfo, KeyNotFoundError> {
self.keyring.promote(key_id).map(Into::into)
}
pub fn enable(&mut self, key_id: u32) -> Result<KeyInfo, KeyNotFoundError> {
self.keyring.enable(key_id)?;
let key = self.keyring.get(key_id)?;
let _ = self.verifier.add(key.verifying_key());
Ok(key.into())
}
pub fn disable(&mut self, key_id: u32) -> Result<KeyInfo, DisableKeyError> {
let key = self.keyring.get(key_id)?;
let _ = self.verifier.delete(key.pub_id());
self.keyring.disable(key_id).map(Into::into)
}
pub fn delete(&mut self, key_id: impl Into<u32>) -> Result<KeyInfo, RemoveKeyError> {
let key_id = key_id.into();
let key = self.keyring.get(key_id)?;
self.verifier.delete(key.pub_id())?;
self.keyring.remove(key_id).map(Into::into)
}
pub fn set_key_metadata(
&mut self,
key_id: u32,
metadata: Option<Metadata>,
) -> Result<KeyInfo, KeyNotFoundError> {
self.keyring.update_key_metadata(key_id, metadata)?;
let key = self.keyring.get(key_id)?;
Ok(key.into())
}
pub fn info(&self) -> KeyringInfo {
KeyringInfo {
keys: self.keys(),
version: self.keyring().version,
kind: crate::primitive::Kind::Dsa,
}
}
}