diff options
author | Neal H. Walfield <neal@pep.foundation> | 2019-05-07 11:12:21 +0200 |
---|---|---|
committer | Neal H. Walfield <neal@pep.foundation> | 2019-05-07 12:18:42 +0200 |
commit | 381ecfedce31d38d6bd447d85a05f7d9a458c38b (patch) | |
tree | fc9b245eb8a46bee88e9bdaac00c7efd91d70cfc /openpgp | |
parent | 4ecdcafbb1a46a39e7fe54c2802c421c2160884d (diff) |
openpgp: Rename TPKBuilder::default to TPKBuilder::new
- One would think that TPKBuilder::default would return something
filled with useful defaults, but it just returns a nearly empty
builder. Rename it to TPKBuilder::new, which is less misleading.
Diffstat (limited to 'openpgp')
-rw-r--r-- | openpgp/examples/generate-encrypt-decrypt.rs | 2 | ||||
-rw-r--r-- | openpgp/examples/generate-sign-verify.rs | 2 | ||||
-rw-r--r-- | openpgp/src/parse/stream.rs | 2 | ||||
-rw-r--r-- | openpgp/src/serialize/tpk.rs | 4 | ||||
-rw-r--r-- | openpgp/src/tpk/bindings.rs | 20 | ||||
-rw-r--r-- | openpgp/src/tpk/builder.rs | 37 | ||||
-rw-r--r-- | openpgp/src/tpk/mod.rs | 20 |
7 files changed, 47 insertions, 40 deletions
diff --git a/openpgp/examples/generate-encrypt-decrypt.rs b/openpgp/examples/generate-encrypt-decrypt.rs index c19f9eb2..c338f154 100644 --- a/openpgp/examples/generate-encrypt-decrypt.rs +++ b/openpgp/examples/generate-encrypt-decrypt.rs @@ -27,7 +27,7 @@ fn main() { /// Generates an encryption-capable key. fn generate() -> openpgp::Result<openpgp::TPK> { - let (tpk, _revocation) = openpgp::tpk::TPKBuilder::default() + let (tpk, _revocation) = openpgp::tpk::TPKBuilder::new() .add_userid("someone@example.org") .add_encryption_subkey() .generate()?; diff --git a/openpgp/examples/generate-sign-verify.rs b/openpgp/examples/generate-sign-verify.rs index 86d49c60..0ebb3d1e 100644 --- a/openpgp/examples/generate-sign-verify.rs +++ b/openpgp/examples/generate-sign-verify.rs @@ -26,7 +26,7 @@ fn main() { /// Generates an signing-capable key. fn generate() -> openpgp::Result<openpgp::TPK> { - let (tpk, _revocation) = openpgp::tpk::TPKBuilder::default() + let (tpk, _revocation) = openpgp::tpk::TPKBuilder::new() .add_userid("someone@example.org") .add_signing_subkey() .generate()?; diff --git a/openpgp/src/parse/stream.rs b/openpgp/src/parse/stream.rs index 7f3a9ac5..c56e5e9b 100644 --- a/openpgp/src/parse/stream.rs +++ b/openpgp/src/parse/stream.rs @@ -1593,7 +1593,7 @@ mod test { use crypto::KeyPair; use std::io::Write; - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .add_signing_subkey() .generate().unwrap(); diff --git a/openpgp/src/serialize/tpk.rs b/openpgp/src/serialize/tpk.rs index 6415b33a..3a046572 100644 --- a/openpgp/src/serialize/tpk.rs +++ b/openpgp/src/serialize/tpk.rs @@ -196,7 +196,7 @@ impl TPK { /// # use sequoia_openpgp::{*, tpk::*, parse::Parse, serialize::Serialize}; /// # f().unwrap(); /// # fn f() -> Result<()> { -/// let (tpk, _) = TPKBuilder::default().generate()?; +/// let (tpk, _) = TPKBuilder::new().generate()?; /// assert!(tpk.is_tsk()); /// /// let mut buf = Vec::new(); @@ -229,7 +229,7 @@ impl<'a> TSK<'a> { /// # use sequoia_openpgp::{*, tpk::*, parse::Parse, serialize::Serialize}; /// # f().unwrap(); /// # fn f() -> Result<()> { - /// let (tpk, _) = TPKBuilder::default().add_signing_subkey().generate()?; + /// let (tpk, _) = TPKBuilder::new().add_signing_subkey().generate()?; /// assert_eq!(tpk.keys_valid().secret(true).count(), 2); /// /// // Only write out the primary key's secret. diff --git a/openpgp/src/tpk/bindings.rs b/openpgp/src/tpk/bindings.rs index eb355df0..e890cbbf 100644 --- a/openpgp/src/tpk/bindings.rs +++ b/openpgp/src/tpk/bindings.rs @@ -28,7 +28,7 @@ impl Key { /// # f().unwrap(); /// # fn f() -> Result<()> { /// // Generate a TPK, and create a keypair from the primary key. - /// let (tpk, _) = TPKBuilder::default().generate()?; + /// let (tpk, _) = TPKBuilder::new().generate()?; /// let mut keypair = tpk.primary().clone().into_keypair()?; /// /// // Let's add an encryption subkey. @@ -84,7 +84,7 @@ impl Key { /// # f().unwrap(); /// # fn f() -> Result<()> { /// // Generate a TPK, and create a keypair from the primary key. - /// let (tpk, _) = TPKBuilder::default() + /// let (tpk, _) = TPKBuilder::new() /// .add_encryption_subkey() /// .generate()?; /// let mut keypair = tpk.primary().clone().into_keypair()?; @@ -150,7 +150,7 @@ impl UserID { /// # f().unwrap(); /// # fn f() -> Result<()> { /// // Generate a TPK, and create a keypair from the primary key. - /// let (tpk, _) = TPKBuilder::default().generate()?; + /// let (tpk, _) = TPKBuilder::new().generate()?; /// let mut keypair = tpk.primary().clone().into_keypair()?; /// assert_eq!(tpk.userids().len(), 0); /// @@ -210,14 +210,14 @@ impl UserID { /// # f().unwrap(); /// # fn f() -> Result<()> { /// // Generate a TPK, and create a keypair from the primary key. - /// let (alice, _) = TPKBuilder::default() + /// 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::default() + /// let (bob, _) = TPKBuilder::new() /// .primary_keyflags(KeyFlags::default().set_certify(true)) /// .add_userid("bob@example.org") /// .generate()?; @@ -278,7 +278,7 @@ impl UserID { /// # f().unwrap(); /// # fn f() -> Result<()> { /// // Generate a TPK, and create a keypair from the primary key. - /// let (tpk, _) = TPKBuilder::default() + /// let (tpk, _) = TPKBuilder::new() /// .add_userid("some@example.org") /// .generate()?; /// let mut keypair = tpk.primary().clone().into_keypair()?; @@ -345,7 +345,7 @@ impl UserAttribute { /// # f().unwrap(); /// # fn f() -> Result<()> { /// // Generate a TPK, and create a keypair from the primary key. - /// let (tpk, _) = TPKBuilder::default() + /// let (tpk, _) = TPKBuilder::new() /// .generate()?; /// let mut keypair = tpk.primary().clone().into_keypair()?; /// assert_eq!(tpk.userids().len(), 0); @@ -410,7 +410,7 @@ impl UserAttribute { /// # f().unwrap(); /// # fn f() -> Result<()> { /// // Generate a TPK, and create a keypair from the primary key. - /// let (alice, _) = TPKBuilder::default() + /// let (alice, _) = TPKBuilder::new() /// .add_userid("alice@example.org") /// .generate()?; /// let mut keypair = alice.primary().clone().into_keypair()?; @@ -420,7 +420,7 @@ impl UserAttribute { /// Subpacket::Image( /// Image::Private(100, vec![0, 1, 2].into_boxed_slice())), /// ])?; - /// let (bob, _) = TPKBuilder::default() + /// let (bob, _) = TPKBuilder::new() /// .primary_keyflags(KeyFlags::default().set_certify(true)) /// .add_user_attribute(user_attr) /// .generate()?; @@ -487,7 +487,7 @@ impl UserAttribute { /// Subpacket::Image( /// Image::Private(100, vec![0, 1, 2].into_boxed_slice())), /// ])?; - /// let (tpk, _) = TPKBuilder::default() + /// let (tpk, _) = TPKBuilder::new() /// .add_user_attribute(user_attr) /// .generate()?; /// let mut keypair = tpk.primary().clone().into_keypair()?; diff --git a/openpgp/src/tpk/builder.rs b/openpgp/src/tpk/builder.rs index 56242bba..6b866f57 100644 --- a/openpgp/src/tpk/builder.rs +++ b/openpgp/src/tpk/builder.rs @@ -94,8 +94,17 @@ pub struct TPKBuilder { password: Option<Password>, } -impl Default for TPKBuilder { - fn default() -> Self { +impl TPKBuilder { + /// Returns a new TPKBuilder. + /// + /// The returned TPKBuilder is setup to only create a + /// certification-capable primary key using the default cipher + /// suite (currently: `CipherSuite::RSA3k`). You'll almost + /// certainly want to add subkeys (using + /// `TPKBuilder::add_signing_subkey`, or + /// `TPKBuilder::add_encryption_subkey`, for instance), and user + /// ids (using `TPKBuilder::add_userid`). + pub fn new() -> Self { TPKBuilder{ ciphersuite: CipherSuite::RSA3k, primary: KeyBlueprint{ @@ -107,9 +116,7 @@ impl Default for TPKBuilder { password: None, } } -} -impl TPKBuilder { /// Generates a key compliant to /// [Autocrypt](https://autocrypt.org/). /// @@ -346,7 +353,7 @@ mod tests { #[test] fn all_opts() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .add_userid("test1@example.com") .add_userid("test2@example.com") @@ -369,7 +376,7 @@ mod tests { #[test] fn direct_key_sig() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .add_signing_subkey() .add_encryption_subkey() @@ -390,14 +397,14 @@ mod tests { #[test] fn setter() { - let (tpk1, _) = TPKBuilder::default() + let (tpk1, _) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .set_cipher_suite(CipherSuite::RSA3k) .set_cipher_suite(CipherSuite::Cv25519) .generate().unwrap(); assert_eq!(tpk1.primary().pk_algo(), PublicKeyAlgorithm::EdDSA); - let (tpk2, _) = TPKBuilder::default() + let (tpk2, _) = TPKBuilder::new() .add_userid("test2@example.com") .add_encryption_subkey() .generate().unwrap(); @@ -409,7 +416,7 @@ mod tests { #[test] fn defaults() { - let (tpk1, _) = TPKBuilder::default() + let (tpk1, _) = TPKBuilder::new() .add_userid("test2@example.com") .generate().unwrap(); assert_eq!(tpk1.primary().pk_algo(), @@ -453,7 +460,7 @@ mod tests { #[test] fn always_certify() { - let (tpk1, _) = TPKBuilder::default() + let (tpk1, _) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .primary_keyflags(KeyFlags::default()) .add_encryption_subkey() @@ -472,7 +479,7 @@ mod tests { #[test] fn gen_wired_subkeys() { - let (tpk1, _) = TPKBuilder::default() + let (tpk1, _) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .primary_keyflags(KeyFlags::default()) .add_subkey(KeyFlags::default().set_certify(true)) @@ -492,7 +499,7 @@ mod tests { #[test] fn generate_revocation_certificate() { use RevocationStatus; - let (tpk, revocation) = TPKBuilder::default() + let (tpk, revocation) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .generate().unwrap(); assert_eq!(tpk.revoked(None), RevocationStatus::NotAsFarAsWeKnow); @@ -505,7 +512,7 @@ mod tests { fn builder_roundtrip() { use PacketPile; - let (tpk,_) = TPKBuilder::default() + let (tpk,_) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .add_signing_subkey() .generate().unwrap(); @@ -518,7 +525,7 @@ mod tests { #[test] fn encrypted_secrets() { - let (tpk,_) = TPKBuilder::default() + let (tpk,_) = TPKBuilder::new() .set_cipher_suite(CipherSuite::Cv25519) .set_password(Some(String::from("streng geheim").into())) .generate().unwrap(); @@ -530,7 +537,7 @@ mod tests { use self::CipherSuite::*; for cs in vec![Cv25519, RSA3k, P256, P384, P521] { - assert!(TPKBuilder::default() + assert!(TPKBuilder::new() .set_cipher_suite(cs) .generate().is_ok()); } diff --git a/openpgp/src/tpk/mod.rs b/openpgp/src/tpk/mod.rs index cff7f538..13ca6d5b 100644 --- a/openpgp/src/tpk/mod.rs +++ b/openpgp/src/tpk/mod.rs @@ -1792,7 +1792,7 @@ impl TPK { /// # fn main() { f().unwrap(); } /// # fn f() -> Result<()> /// # { - /// let (tpk, _) = TPKBuilder::default() + /// let (tpk, _) = TPKBuilder::new() /// .set_cipher_suite(CipherSuite::Cv25519) /// .generate()?; /// assert_eq!(RevocationStatus::NotAsFarAsWeKnow, tpk.revoked(None)); @@ -1844,7 +1844,7 @@ impl TPK { /// # fn main() { f().unwrap(); } /// # fn f() -> Result<()> /// # { - /// let (mut tpk, _) = TPKBuilder::default() + /// let (mut tpk, _) = TPKBuilder::new() /// .set_cipher_suite(CipherSuite::Cv25519) /// .generate()?; /// assert_eq!(RevocationStatus::NotAsFarAsWeKnow, tpk.revoked(None)); @@ -3565,7 +3565,7 @@ mod test { // XXX: testing sequoia against itself isn't optimal, but I couldn't // find a tool to generate direct key signatures :-( - let (tpk1, _) = TPKBuilder::default().generate().unwrap(); + let (tpk1, _) = TPKBuilder::new().generate().unwrap(); let mut buf = Vec::default(); tpk1.serialize(&mut buf).unwrap(); @@ -3687,7 +3687,7 @@ mod test { fn revoke_uid() { use std::{thread, time}; - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .add_userid("Test1") .add_userid("Test2") .generate().unwrap(); @@ -3826,7 +3826,7 @@ mod test { #[test] fn select_no_keys() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .generate().unwrap(); let flags = KeyFlags::default().set_encrypt_for_transport(true); @@ -3835,7 +3835,7 @@ mod test { #[test] fn select_valid_and_right_flags() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .add_encryption_subkey() .generate().unwrap(); let flags = KeyFlags::default().set_encrypt_for_transport(true); @@ -3845,7 +3845,7 @@ mod test { #[test] fn select_valid_and_wrong_flags() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .add_encryption_subkey() .add_signing_subkey() .generate().unwrap(); @@ -3856,7 +3856,7 @@ mod test { #[test] fn select_invalid_and_right_flags() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .add_encryption_subkey() .generate().unwrap(); let mut now = time::now(); @@ -3868,7 +3868,7 @@ mod test { #[test] fn select_primary() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .add_certification_subkey() .generate().unwrap(); let flags = KeyFlags::default().set_certify(true); @@ -3952,7 +3952,7 @@ Pu1xwz57O4zo1VYf6TqHJzVC3OMvMUM2hhdecMUe5x6GorNaj6g= #[test] fn missing_uids() { - let (tpk, _) = TPKBuilder::default() + let (tpk, _) = TPKBuilder::new() .add_userid("test1@example.com") .add_userid("test2@example.com") .add_encryption_subkey() |