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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
use std::fmt;
#[cfg(test)]
use quickcheck::{Arbitrary, Gen};
use crate::types::Bitfield;
/// Describes preferences regarding key servers.
///
/// Key server preferences are specified in [Section 5.2.3.17 of RFC 4880] and
/// [Section 5.2.3.18 of RFC 4880bis].
///
/// [Section 5.2.3.17 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-5.2.3.17
/// [Section 5.2.3.18 of RFC 4880bis]: https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-09#section-5.2.3.18
///
/// The keyserver preferences are set by the user's OpenPGP
/// implementation to communicate them to any peers.
///
/// # A note on equality
///
/// `PartialEq` compares the serialized form of the two key server
/// preference sets. If you prefer to compare two key server
/// preference sets for semantic equality, you should use
/// [`KeyServerPreferences::normalized_eq`]. The difference between
/// semantic equality and serialized equality is that semantic
/// equality ignores differences in the amount of padding.
///
/// [`KeyServerPreferences::normalized_eq`]: #method.normalized_eq
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// # use openpgp::Result;
/// use openpgp::cert::prelude::*;
/// use openpgp::policy::StandardPolicy;
///
/// # fn main() -> Result<()> {
/// let p = &StandardPolicy::new();
///
/// let (cert, _) =
/// CertBuilder::general_purpose(None, Some("alice@example.org"))
/// .generate()?;
///
/// match cert.with_policy(p, None)?.primary_userid()?.key_server_preferences() {
/// Some(preferences) => {
/// println!("Certificate holder's keyserver preferences:");
/// assert!(preferences.no_modify());
/// # unreachable!();
/// }
/// None => {
/// println!("Certificate Holder did not specify any key server preferences.");
/// }
/// }
/// # Ok(()) }
/// ```
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct KeyServerPreferences(Bitfield);
assert_send_and_sync!(KeyServerPreferences);
impl fmt::Debug for KeyServerPreferences {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let mut need_comma = false;
if self.no_modify() {
f.write_str("no modify")?;
need_comma = true;
}
for i in self.0.iter() {
match i {
KEYSERVER_PREFERENCE_NO_MODIFY => (),
i => {
if need_comma { f.write_str(", ")?; }
write!(f, "#{}", i)?;
need_comma = true;
},
}
}
// Mention any padding, as equality is sensitive to this.
let padding = self.0.padding_len();
if padding > 0 {
if need_comma { f.write_str(", ")?; }
write!(f, "+padding({} bytes)", padding)?;
}
Ok(())
}
}
impl KeyServerPreferences {
/// Creates a new instance from `bits`.
pub fn new<B: AsRef<[u8]>>(bits: B) -> Self {
KeyServerPreferences(bits.as_ref().to_vec().into())
}
/// Returns an empty key server preference set.
pub fn empty() -> Self {
Self::new(&[])
}
/// Returns a slice containing the raw values.
pub(crate) fn as_slice(&self) -> &[u8] {
self.0.as_slice()
}
/// Compares two key server preference sets for semantic equality.
///
/// `KeyServerPreferences`' implementation of `PartialEq` compares
/// two key server preference sets for serialized equality. That
/// is, the `PartialEq` implementation considers two key server
/// preference sets to *not* be equal if they have different
/// amounts of padding. This comparison function ignores padding.
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
/// let a = KeyServerPreferences::new(&[0x1]);
/// let b = KeyServerPreferences::new(&[0x1, 0x0]);
///
/// assert!(a != b);
/// assert!(a.normalized_eq(&b));
/// # Ok(()) }
/// ```
pub fn normalized_eq(&self, other: &Self) -> bool {
self.0.normalized_eq(&other.0)
}
/// Returns whether the specified keyserver preference flag is set.
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
/// // Keyserver Preferences flags 0 and 2.
/// let ksp = KeyServerPreferences::new(&[0x5]);
///
/// assert!(ksp.get(0));
/// assert!(! ksp.get(1));
/// assert!(ksp.get(2));
/// assert!(! ksp.get(3));
/// assert!(! ksp.get(8));
/// assert!(! ksp.get(80));
/// # assert!(! ksp.no_modify());
/// # Ok(()) }
/// ```
pub fn get(&self, bit: usize) -> bool {
self.0.get(bit)
}
/// Sets the specified keyserver preference flag.
///
/// This also clears any padding (trailing NUL bytes).
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
/// let ksp = KeyServerPreferences::empty().set(0).set(2);
///
/// assert!(ksp.get(0));
/// assert!(! ksp.get(1));
/// assert!(ksp.get(2));
/// assert!(! ksp.get(3));
/// # assert!(! ksp.no_modify());
/// # Ok(()) }
/// ```
pub fn set(self, bit: usize) -> Self {
Self(self.0.set(bit))
}
/// Clears the specified keyserver preference flag.
///
/// This also clears any padding (trailing NUL bytes).
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
/// let ksp = KeyServerPreferences::empty().set(0).set(2).clear(2);
///
/// assert!(ksp.get(0));
/// assert!(! ksp.get(1));
/// assert!(! ksp.get(2));
/// assert!(! ksp.get(3));
/// # assert!(! ksp.no_modify());
/// # Ok(()) }
/// ```
pub fn clear(self, bit: usize) -> Self {
Self(self.0.clear(bit))
}
/// Returns whether the certificate's owner requests that the
/// certificate is not modified.
///
/// If this flag is set, the certificate's owner requests that the
/// certificate should only be changed by the owner and the key
/// server's operator.
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
/// let ksp = KeyServerPreferences::empty();
/// assert!(! ksp.no_modify());
/// # Ok(()) }
/// ```
pub fn no_modify(&self) -> bool {
self.get(KEYSERVER_PREFERENCE_NO_MODIFY)
}
/// Requests that the certificate is not modified.
///
/// See [`KeyServerPreferences::no_modify`].
///
/// [`KeyServerPreferences::no_modify`]: #method.no_modify
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
/// let ksp = KeyServerPreferences::empty().set_no_modify();
/// assert!(ksp.no_modify());
/// # Ok(()) }
/// ```
pub fn set_no_modify(self) -> Self {
self.set(KEYSERVER_PREFERENCE_NO_MODIFY)
}
/// Clears the request that the certificate is not modified.
///
/// See [`KeyServerPreferences::no_modify`].
///
/// [`KeyServerPreferences::no_modify`]: #method.no_modify
///
/// # Examples
///
/// ```
/// use sequoia_openpgp as openpgp;
/// use openpgp::types::KeyServerPreferences;
///
/// # fn main() -> openpgp::Result<()> {
/// let ksp = KeyServerPreferences::new(&[0x80][..]);
/// assert!(ksp.no_modify());
/// let ksp = ksp.clear_no_modify();
/// assert!(! ksp.no_modify());
/// # Ok(()) }
/// ```
pub fn clear_no_modify(self) -> Self {
self.clear(KEYSERVER_PREFERENCE_NO_MODIFY)
}
}
/// The key holder requests that this key only be modified or updated
/// by the key holder or an administrator of the key server.
const KEYSERVER_PREFERENCE_NO_MODIFY: usize = 7;
#[cfg(test)]
impl Arbitrary for KeyServerPreferences {
fn arbitrary<G: Gen>(g: &mut G) -> Self {
Self::new(Vec::arbitrary(g))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn basics() -> crate::Result<()> {
let p = KeyServerPreferences::empty();
assert_eq!(p.no_modify(), false);
let p = KeyServerPreferences::new(&[]);
assert_eq!(p.no_modify(), false);
let p = KeyServerPreferences::new(&[0xff]);
assert_eq!(p.no_modify(), true);
Ok(())
}
quickcheck! {
fn roundtrip(val: KeyServerPreferences) -> bool {
let mut q = KeyServerPreferences::new(val.as_slice());
assert_eq!(val, q);
assert!(val.normalized_eq(&q));
// Add some padding to q. Make sure they are still equal.
q.0.raw.push(0);
assert!(val != q);
assert!(val.normalized_eq(&q));
q.0.raw.push(0);
assert!(
|