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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
use Error;
use Result;
use TPK;
use constants::{HashAlgorithm, SignatureType, ReasonForRevocation};
use crypto::Signer;
use packet::{UserID, UserAttribute, Key, signature, Signature};

impl Key {
    /// Creates a binding signature.
    ///
    /// The signature binds this userid to `tpk`. `signer` will be used
    /// to create a signature using `signature` as builder.
    /// The`hash_algo` defaults to SHA512, `creation_time` to the
    /// current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Example
    ///
    /// This example demonstrates how to bind this key to a TPK.  Note
    /// that in general, the `TPKBuilder` is a better way to add
    /// subkeys to a TPK.
    ///
    /// ```
    /// # use sequoia_openpgp::{*, packet::prelude::*, constants::*, tpk::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let (tpk, _) = TPKBuilder::new().generate()?;
    /// let mut keypair = tpk.primary().clone().into_keypair()?;
    ///
    /// // Let's add an encryption subkey.
    /// let flags = KeyFlags::default().set_encrypt_at_rest(true);
    /// assert_eq!(tpk.keys_valid().key_flags(flags.clone()).count(), 0);
    ///
    /// // Generate a subkey and a binding signature.
    /// let subkey = Key::V4(Key4::generate_ecc(false, Curve::Cv25519)?);
    /// let builder = signature::Builder::new(SignatureType::SubkeyBinding)
    ///     .set_key_flags(&flags)?;
    /// let binding = subkey.bind(&mut keypair, &tpk, builder, None, None)?;
    ///
    /// // Now merge the key and binding signature into the TPK.
    /// let tpk = tpk.merge_packets(vec![subkey.into_packet(Tag::SecretSubkey)?,
    ///                                  binding.into()])?;
    ///
    /// // Check that we have an encryption subkey.
    /// assert_eq!(tpk.keys_valid().key_flags(flags).count(), 1);
    /// # Ok(()) }
    pub fn bind<H, T>(&self, signer: &mut Signer, tpk: &TPK,
                      signature: signature::Builder,
                      hash_algo: H, creation_time: T)
                      -> Result<Signature>
        where H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        signature
            .set_signature_creation_time(
                creation_time.into().unwrap_or_else(time::now_utc))?
            .set_issuer_fingerprint(signer.public().fingerprint())?
            .set_issuer(signer.public().keyid())?
            .sign_subkey_binding(
                signer, tpk.primary(), self,
                hash_algo.into().unwrap_or(HashAlgorithm::SHA512))
    }

    /// Returns a revocation certificate for the subkey.
    ///
    /// The revocation signature revokes the binding between this user
    /// attribute and `tpk`.  `signer` will be used to create a
    /// signature with the given reason in `code` and `reason`.
    /// `signature_type`.  `hash_algo` defaults to SHA512,
    /// `creation_time` to the current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Example
    ///
    /// ```
    /// # use sequoia_openpgp::{*, packet::*, constants::*, tpk::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let (tpk, _) = TPKBuilder::new()
    ///     .add_encryption_subkey()
    ///     .generate()?;
    /// let mut keypair = tpk.primary().clone().into_keypair()?;
    ///
    /// // Generate the revocation for the first and only Subkey.
    /// let revocation =
    ///     tpk.subkeys().nth(0).unwrap().subkey()
    ///         .revoke(&mut keypair, &tpk,
    ///                 ReasonForRevocation::KeyRetired,
    ///                 b"Smells funny.", None, None)?;
    /// assert_eq!(revocation.sigtype(), SignatureType::SubkeyRevocation);
    ///
    /// // Now merge the revocation signature into the TPK.
    /// let tpk = tpk.merge_packets(vec![revocation.clone().into()])?;
    ///
    /// // Check that it is revoked.
    /// let subkey = tpk.subkeys().nth(0).unwrap();
    /// if let RevocationStatus::Revoked(revocations) = subkey.revoked(None) {
    ///     assert_eq!(revocations.len(), 1);
    ///     assert_eq!(revocations[0], revocation);
    /// } else {
    ///     panic!("Subkey is not revoked.");
    /// }
    /// # Ok(()) }
    /// ```
    pub fn revoke<H, T>(&self, signer: &mut Signer, tpk: &TPK,
                        code: ReasonForRevocation, reason: &[u8],
                        hash_algo: H, creation_time: T)
        -> Result<Signature>
        where H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        self.bind(signer, tpk,
                  signature::Builder::new(SignatureType::SubkeyRevocation)
                  .set_reason_for_revocation(code, reason)?,
                  // Unwrap arguments to prevent further
                  // monomorphization of bind().
                  hash_algo.into().unwrap_or(HashAlgorithm::SHA512),
                  creation_time.into().unwrap_or_else(time::now_utc))
    }
}

impl UserID {
    /// Creates a binding signature.
    ///
    /// The signature binds this userid to `tpk`. `signer` will be used
    /// to create a signature using `signature` as builder.
    /// The`hash_algo` defaults to SHA512, `creation_time` to the
    /// current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Example
    ///
    /// This example demonstrates how to bind this userid to a TPK.
    /// Note that in general, the `TPKBuilder` is a better way to add
    /// userids to a TPK.
    ///
    /// ```
    /// # use sequoia_openpgp::{*, packet::prelude::*, constants::*, tpk::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let (tpk, _) = TPKBuilder::new().generate()?;
    /// let mut keypair = tpk.primary().clone().into_keypair()?;
    /// assert_eq!(tpk.userids().len(), 0);
    ///
    /// // Generate a userid and a binding signature.
    /// let userid = UserID::from("test@example.org");
    /// let builder =
    ///     signature::Builder::new(SignatureType::PositiveCertificate);
    /// let binding = userid.bind(&mut keypair, &tpk, builder, None, None)?;
    ///
    /// // Now merge the userid and binding signature into the TPK.
    /// let tpk = tpk.merge_packets(vec![userid.into(), binding.into()])?;
    ///
    /// // Check that we have a userid.
    /// assert_eq!(tpk.userids().len(), 1);
    /// # Ok(()) }
    pub fn bind<H, T>(&self, signer: &mut Signer, tpk: &TPK,
                      signature: signature::Builder,
                      hash_algo: H, creation_time: T)
                      -> Result<Signature>
        where H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        signature
            .set_signature_creation_time(
                creation_time.into().unwrap_or_else(time::now_utc))?
            .set_issuer_fingerprint(signer.public().fingerprint())?
            .set_issuer(signer.public().keyid())?
            .sign_userid_binding(
                signer, tpk.primary(), self,
                hash_algo.into().unwrap_or(HashAlgorithm::SHA512))
    }

    /// Returns a certificate for the user id.
    ///
    /// The signature binds this userid to `tpk`. `signer` will be
    /// used to create a certification signature of type
    /// `signature_type`.  `signature_type` defaults to
    /// `SignatureType::GenericCertificate`, `hash_algo` to SHA512,
    /// `creation_time` to the current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Errors
    ///
    /// Returns `Error::InvalidArgument` if `signature_type` is not
    /// one of `SignatureType::{Generic, Persona, Casual,
    /// Positive}Certificate`
    ///
    /// # Example
    ///
    /// This example demonstrates how to certify a userid.
    ///
    /// ```
    /// # use sequoia_openpgp::{*, packet::prelude::*, constants::*, tpk::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let (alice, _) = TPKBuilder::new()
    ///     .primary_keyflags(KeyFlags::default().set_certify(true))
    ///     .add_userid("alice@example.org")
    ///     .generate()?;
    /// let mut keypair = alice.primary().clone().into_keypair()?;
    ///
    /// // Generate a TPK for Bob.
    /// let (bob, _) = TPKBuilder::new()
    ///     .primary_keyflags(KeyFlags::default().set_certify(true))
    ///     .add_userid("bob@example.org")
    ///     .generate()?;
    ///
    /// // Alice now certifies the binding between `bob@example.org` and `bob`.
    /// let certificate =
    ///     bob.userids().nth(0).unwrap().userid()
    ///     .certify(&mut keypair, &bob, SignatureType::PositiveCertificate,
    ///              None, None)?;
    ///
    /// // `certificate` can now be used, e.g. by merging it into `bob`.
    /// let bob = bob.merge_packets(vec![certificate.into()])?;
    ///
    /// // Check that we have a certification on the userid.
    /// assert_eq!(bob.userids().nth(0).unwrap().certifications().len(), 1);
    /// # Ok(()) }
    pub fn certify<S, H, T>(&self, signer: &mut Signer, tpk: &TPK,
                            signature_type: S,
                            hash_algo: H, creation_time: T)
                            -> Result<Signature>
        where S: Into<Option<SignatureType>>,
              H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        let typ = signature_type.into();
        let typ = match typ {
            Some(SignatureType::GenericCertificate)
                | Some(SignatureType::PersonaCertificate)
                | Some(SignatureType::CasualCertificate)
                | Some(SignatureType::PositiveCertificate) => typ.unwrap(),
            Some(t) => return Err(Error::InvalidArgument(
                format!("Invalid signature type: {}", t)).into()),
            None => SignatureType::GenericCertificate,
        };
        self.bind(signer, tpk, signature::Builder::new(typ),
                  // Unwrap arguments to prevent further
                  // monomorphization of bind().
                  hash_algo.into().unwrap_or(HashAlgorithm::SHA512),
                  creation_time.into().unwrap_or_else(time::now_utc))
    }

    /// Returns a revocation certificate for the user id.
    ///
    /// The revocation signature revokes the binding between this user
    /// attribute and `tpk`.  `signer` will be used to create a
    /// signature with the given reason in `code` and `reason`.
    /// `signature_type`.  `hash_algo` defaults to SHA512,
    /// `creation_time` to the current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Example
    ///
    /// ```
    /// # use sequoia_openpgp::{*, constants::*, tpk::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let (tpk, _) = TPKBuilder::new()
    ///     .add_userid("some@example.org")
    ///     .generate()?;
    /// let mut keypair = tpk.primary().clone().into_keypair()?;
    ///
    /// // Generate the revocation for the first and only UserID.
    /// let revocation =
    ///     tpk.userids().nth(0).unwrap().userid()
    ///         .revoke(&mut keypair, &tpk,
    ///                 ReasonForRevocation::UIDRetired,
    ///                 b"Left example.org.", None, None)?;
    /// assert_eq!(revocation.sigtype(), SignatureType::CertificateRevocation);
    ///
    /// // Now merge the revocation signature into the TPK.
    /// let tpk = tpk.merge_packets(vec![revocation.clone().into()])?;
    ///
    /// // Check that it is revoked.
    /// let uid = tpk.userids().nth(0).unwrap();
    /// if let RevocationStatus::Revoked(revocations) = uid.revoked(None) {
    ///     assert_eq!(revocations.len(), 1);
    ///     assert_eq!(revocations[0], revocation);
    /// } else {
    ///     panic!("UserID is not revoked.");
    /// }
    /// # Ok(()) }
    /// ```
    pub fn revoke<H, T>(&self, signer: &mut Signer, tpk: &TPK,
                        code: ReasonForRevocation, reason: &[u8],
                        hash_algo: H, creation_time: T)
        -> Result<Signature>
        where H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        self.bind(signer, tpk,
                  signature::Builder::new(SignatureType::CertificateRevocation)
                  .set_reason_for_revocation(code, reason)?,
                  // Unwrap arguments to prevent further
                  // monomorphization of bind().
                  hash_algo.into().unwrap_or(HashAlgorithm::SHA512),
                  creation_time.into().unwrap_or_else(time::now_utc))
    }
}

impl UserAttribute {
    /// Creates a binding signature.
    ///
    /// The signature binds this user attribute to `tpk`. `signer`
    /// will be used to create a signature using `signature` as
    /// builder.  The`hash_algo` defaults to SHA512, `creation_time`
    /// to the current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Example
    ///
    /// This example demonstrates how to bind this user attribute to a
    /// TPK.  Note that in general, the `TPKBuilder` is a better way
    /// to add userids to a TPK.
    ///
    /// ```
    /// # use sequoia_openpgp::{*, packet::prelude::*, constants::*, tpk::*,
    ///                         packet::user_attribute::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let (tpk, _) = TPKBuilder::new()
    ///     .generate()?;
    /// let mut keypair = tpk.primary().clone().into_keypair()?;
    /// assert_eq!(tpk.userids().len(), 0);
    ///
    /// // Generate a user attribute and a binding signature.
    /// let user_attr = UserAttribute::new(&[
    ///     Subpacket::Image(
    ///         Image::Private(100, vec![0, 1, 2].into_boxed_slice())),
    /// ])?;
    /// let builder =
    ///     signature::Builder::new(SignatureType::PositiveCertificate);
    /// let binding = user_attr.bind(&mut keypair, &tpk, builder, None, None)?;
    ///
    /// // Now merge the user attribute and binding signature into the TPK.
    /// let tpk = tpk.merge_packets(vec![user_attr.into(), binding.into()])?;
    ///
    /// // Check that we have a user attribute.
    /// assert_eq!(tpk.user_attributes().len(), 1);
    /// # Ok(()) }
    pub fn bind<H, T>(&self, signer: &mut Signer, tpk: &TPK,
                      signature: signature::Builder,
                      hash_algo: H, creation_time: T)
                      -> Result<Signature>
        where H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        signature
            .set_signature_creation_time(
                creation_time.into().unwrap_or_else(time::now_utc))?
            .set_issuer_fingerprint(signer.public().fingerprint())?
            .set_issuer(signer.public().keyid())?
            .sign_user_attribute_binding(
                signer, tpk.primary(), self,
                hash_algo.into().unwrap_or(HashAlgorithm::SHA512))
    }

    /// Returns a certificate for the user attribute.
    ///
    /// The signature binds this user attribute to `tpk`. `signer` will be
    /// used to create a certification signature of type
    /// `signature_type`.  `signature_type` defaults to
    /// `SignatureType::GenericCertificate`, `hash_algo` to SHA512,
    /// `creation_time` to the current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Errors
    ///
    /// Returns `Error::InvalidArgument` if `signature_type` is not
    /// one of `SignatureType::{Generic, Persona, Casual,
    /// Positive}Certificate`
    ///
    /// # Example
    ///
    /// This example demonstrates how to certify a userid.
    ///
    /// ```
    /// # use sequoia_openpgp::{*, packet::prelude::*, constants::*, tpk::*,
    ///                         packet::user_attribute::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let (alice, _) = TPKBuilder::new()
    ///     .add_userid("alice@example.org")
    ///     .generate()?;
    /// let mut keypair = alice.primary().clone().into_keypair()?;
    ///
    /// // Generate a TPK for Bob.
    /// let user_attr = UserAttribute::new(&[
    ///     Subpacket::Image(
    ///         Image::Private(100, vec![0, 1, 2].into_boxed_slice())),
    /// ])?;
    /// let (bob, _) = TPKBuilder::new()
    ///     .primary_keyflags(KeyFlags::default().set_certify(true))
    ///     .add_user_attribute(user_attr)
    ///     .generate()?;
    ///
    /// // Alice now certifies the binding between `bob@example.org` and `bob`.
    /// let certificate =
    ///     bob.user_attributes().nth(0).unwrap().user_attribute()
    ///     .certify(&mut keypair, &bob, SignatureType::PositiveCertificate,
    ///              None, None)?;
    ///
    /// // `certificate` can now be used, e.g. by merging it into `bob`.
    /// let bob = bob.merge_packets(vec![certificate.into()])?;
    ///
    /// // Check that we have a certification on the userid.
    /// assert_eq!(bob.user_attributes().nth(0).unwrap().certifications().len(),
    ///            1);
    /// # Ok(()) }
    pub fn certify<S, H, T>(&self, signer: &mut Signer, tpk: &TPK,
                            signature_type: S,
                            hash_algo: H, creation_time: T)
                            -> Result<Signature>
        where S: Into<Option<SignatureType>>,
              H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        let typ = signature_type.into();
        let typ = match typ {
            Some(SignatureType::GenericCertificate)
                | Some(SignatureType::PersonaCertificate)
                | Some(SignatureType::CasualCertificate)
                | Some(SignatureType::PositiveCertificate) => typ.unwrap(),
            Some(t) => return Err(Error::InvalidArgument(
                format!("Invalid signature type: {}", t)).into()),
            None => SignatureType::GenericCertificate,
        };
        self.bind(signer, tpk, signature::Builder::new(typ),
                  // Unwrap arguments to prevent further
                  // monomorphization of bind().
                  hash_algo.into().unwrap_or(HashAlgorithm::SHA512),
                  creation_time.into().unwrap_or_else(time::now_utc))
    }

    /// Returns a revocation certificate for the user attribute.
    ///
    /// The revocation signature revokes the binding between this user
    /// attribute and `tpk`.  `signer` will be used to create a
    /// signature with the given reason in `code` and `reason`.
    /// `signature_type`.  `hash_algo` defaults to SHA512,
    /// `creation_time` to the current time.
    ///
    /// This function adds a creation time subpacket, a issuer
    /// fingerprint subpacket, and a issuer subpacket to the
    /// signature.
    ///
    /// # Example
    ///
    /// ```
    /// # use sequoia_openpgp::{*, constants::*, tpk::*,
    ///                         packet::user_attribute::*};
    /// # f().unwrap();
    /// # fn f() -> Result<()> {
    /// // Generate a TPK, and create a keypair from the primary key.
    /// let user_attr = UserAttribute::new(&[
    ///     Subpacket::Image(
    ///         Image::Private(100, vec![0, 1, 2].into_boxed_slice())),
    /// ])?;
    /// let (tpk, _) = TPKBuilder::new()
    ///     .add_user_attribute(user_attr)
    ///     .generate()?;
    /// let mut keypair = tpk.primary().clone().into_keypair()?;
    ///
    /// // Generate the revocation for the first and only UserAttribute.
    /// let revocation =
    ///     tpk.user_attributes().nth(0).unwrap().user_attribute()
    ///         .revoke(&mut keypair, &tpk,
    ///                 ReasonForRevocation::UIDRetired,
    ///                 b"I look different now.", None, None)?;
    /// assert_eq!(revocation.sigtype(), SignatureType::CertificateRevocation);
    ///
    /// // Now merge the revocation signature into the TPK.
    /// let tpk = tpk.merge_packets(vec![revocation.clone().into()])?;
    ///
    /// // Check that it is revoked.
    /// let ua = tpk.user_attributes().nth(0).unwrap();
    /// if let RevocationStatus::Revoked(revocations) = ua.revoked(None) {
    ///     assert_eq!(revocations.len(), 1);
    ///     assert_eq!(revocations[0], revocation);
    /// } else {
    ///     panic!("UserAttribute is not revoked.");
    /// }
    /// # Ok(()) }
    /// ```
    pub fn revoke<H, T>(&self, signer: &mut Signer, tpk: &TPK,
                        code: ReasonForRevocation, reason: &[u8],
                        hash_algo: H, creation_time: T)
        -> Result<Signature>
        where H: Into<Option<HashAlgorithm>>,
              T: Into<Option<time::Tm>>
    {
        self.bind(signer, tpk,
                  signature::Builder::new(SignatureType::CertificateRevocation)
                  .set_reason_for_revocation(code, reason)?,
                  // Unwrap arguments to prevent further
                  // monomorphization of bind().
                  hash_algo.into().unwrap_or(HashAlgorithm::SHA512),
                  creation_time.into().unwrap_or_else(time::now_utc))
    }
}