feat(identity): make Keypair and Publickey opaque

identity/src/keypair.rs

@@ -36,6 +36,11 @@ use crate::secp256k1;
 #[cfg(feature = "ecdsa")]
 use crate::ecdsa;
 
+#[derive(Debug, Clone)]
+pub struct Keypair {
+    keypair: Inner,
+}
+
 /// Identity keypair of a node.
 ///
 /// # Example: Generating RSA keys with OpenSSL
@@ -55,57 +60,44 @@ use crate::ecdsa;
 ///
 #[derive(Debug, Clone)]
 #[allow(clippy::large_enum_variant)]
-pub enum Keypair {
+enum Inner {
     /// An Ed25519 keypair.
     #[cfg(feature = "ed25519")]
-    #[deprecated(
-        since = "0.1.0",
-        note = "This enum will be made opaque in the future, use `Keypair::try_into_ed25519` instead."
-    )]
     Ed25519(ed25519::Keypair),
     /// An RSA keypair.
     #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
-    #[deprecated(
-        since = "0.1.0",
-        note = "This enum will be made opaque in the future, use `Keypair::try_into_rsa` instead."
-    )]
     Rsa(rsa::Keypair),
     /// A Secp256k1 keypair.
     #[cfg(feature = "secp256k1")]
-    #[deprecated(
-        since = "0.1.0",
-        note = "This enum will be made opaque in the future, use `Keypair::try_into_secp256k1` instead."
-    )]
     Secp256k1(secp256k1::Keypair),
     /// An ECDSA keypair.
     #[cfg(feature = "ecdsa")]
-    #[deprecated(
-        since = "0.1.0",
-        note = "This enum will be made opaque in the future, use `Keypair::try_into_ecdsa` instead."
-    )]
     Ecdsa(ecdsa::Keypair),
 }
 
 impl Keypair {
     /// Generate a new Ed25519 keypair.
     #[cfg(feature = "ed25519")]
     pub fn generate_ed25519() -> Keypair {
-        #[allow(deprecated)]
-        Keypair::Ed25519(ed25519::Keypair::generate())
+        Keypair {
+            keypair: Inner::Ed25519(ed25519::Keypair::generate()),
+        }
     }
 
     /// Generate a new Secp256k1 keypair.
     #[cfg(feature = "secp256k1")]
     pub fn generate_secp256k1() -> Keypair {
-        #[allow(deprecated)]
-        Keypair::Secp256k1(secp256k1::Keypair::generate())
+        Keypair {
+            keypair: Inner::Secp256k1(secp256k1::Keypair::generate()),
+        }
     }
 
     /// Generate a new ECDSA keypair.
     #[cfg(feature = "ecdsa")]
     pub fn generate_ecdsa() -> Keypair {
-        #[allow(deprecated)]
-        Keypair::Ecdsa(ecdsa::Keypair::generate())
+        Keypair {
+            keypair: Inner::Ecdsa(ecdsa::Keypair::generate()),
+        }
     }
 
     #[cfg(feature = "ed25519")]
@@ -167,34 +159,37 @@ impl Keypair {
     #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
     pub fn rsa_from_pkcs8(pkcs8_der: &mut [u8]) -> Result<Keypair, DecodingError> {
         #[allow(deprecated)]
-        rsa::Keypair::from_pkcs8(pkcs8_der).map(Keypair::Rsa)
+        Ok(rsa::Keypair::from_pkcs8(pkcs8_der).map(|kp| Keypair {
+            keypair: Inner::Rsa(kp),
+        })?)
     }
 
     /// Decode a keypair from a DER-encoded Secp256k1 secret key in an ECPrivateKey
     /// structure as defined in [RFC5915].
     ///
     /// [RFC5915]: https://tools.ietf.org/html/rfc5915
     #[cfg(feature = "secp256k1")]
-    pub fn secp256k1_from_der(der: &mut [u8]) -> Result<Keypair, DecodingError> {
+    pub fn secp256k1_from_der(der: &mut [u8]) -> Result<Inner, DecodingError> {
         #[allow(deprecated)]
-        secp256k1::SecretKey::from_der(der)
-            .map(|sk| Keypair::Secp256k1(secp256k1::Keypair::from(sk)))
+        secp256k1::SecretKey::from_der(der).map(|sk| Inner::Secp256k1(secp256k1::Keypair::from(sk)))
     }
 
     #[cfg(feature = "ed25519")]
     pub fn ed25519_from_bytes(bytes: impl AsMut<[u8]>) -> Result<Keypair, DecodingError> {
         #[allow(deprecated)]
-        Ok(Keypair::Ed25519(ed25519::Keypair::from(
-            ed25519::SecretKey::from_bytes(bytes)?,
-        )))
+        Ok(Keypair {
+            keypair: Inner::Ed25519(ed25519::Keypair::from(ed25519::SecretKey::from_bytes(
+                bytes,
+            )?)),
+        })
     }
 
     /// Sign a message using the private key of this keypair, producing
     /// a signature that can be verified using the corresponding public key.
     pub fn sign(&self, msg: &[u8]) -> Result<Vec<u8>, SigningError> {
-        use Keypair::*;
+        use Inner::*;
         #[allow(deprecated)]
-        match self {
+        match self.keypair {
             #[cfg(feature = "ed25519")]
             Ed25519(ref pair) => Ok(pair.sign(msg)),
             #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
@@ -208,9 +203,9 @@ impl Keypair {
 
     /// Get the public key of this keypair.
     pub fn public(&self) -> PublicKey {
-        use Keypair::*;
+        use Inner::*;
         #[allow(deprecated)]
-        match self {
+        match &self.keypair {
             #[cfg(feature = "ed25519")]
             Ed25519(pair) => PublicKey::Ed25519(pair.public()),
             #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
@@ -234,18 +229,18 @@ impl Keypair {
         return Err(DecodingError::missing_feature("ed25519"));
 
         #[allow(deprecated)]
-        let pk: proto::PrivateKey = match self {
+        let pk: proto::PrivateKey = match &self.keypair {
             #[cfg(feature = "ed25519")]
-            Self::Ed25519(data) => proto::PrivateKey {
+            Inner::Ed25519(data) => proto::PrivateKey {
                 Type: proto::KeyType::Ed25519,
                 Data: data.encode().to_vec(),
             },
             #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
-            Self::Rsa(_) => return Err(DecodingError::encoding_unsupported("RSA")),
+            Inner::Rsa(_) => return Err(DecodingError::encoding_unsupported("RSA")),
             #[cfg(feature = "secp256k1")]
-            Self::Secp256k1(_) => return Err(DecodingError::encoding_unsupported("secp256k1")),
+            Inner::Secp256k1(_) => return Err(DecodingError::encoding_unsupported("secp256k1")),
             #[cfg(feature = "ecdsa")]
-            Self::Ecdsa(_) => return Err(DecodingError::encoding_unsupported("ECDSA")),
+            Inner::Ecdsa(_) => return Err(DecodingError::encoding_unsupported("ECDSA")),
         };
 
         let mut buf = Vec::with_capacity(pk.get_size());
@@ -270,7 +265,11 @@ impl Keypair {
             proto::KeyType::Ed25519 =>
             {
                 #[allow(deprecated)]
-                ed25519::Keypair::decode(&mut private_key.Data).map(Keypair::Ed25519)
+                Ok(
+                    ed25519::Keypair::decode(&mut private_key.Data).map(|kp| Keypair {
+                        keypair: Inner::Ed25519(kp),
+                    })?,
+                )
             }
             #[cfg(not(feature = "ed25519"))]
             proto::KeyType::Ed25519 => Err(DecodingError::missing_feature("ed25519")),
@@ -284,32 +283,32 @@ impl Keypair {
 #[cfg(feature = "ecdsa")]
 impl From<ecdsa::Keypair> for Keypair {
     fn from(kp: ecdsa::Keypair) -> Self {
-        #[allow(deprecated)]
-        Keypair::Ecdsa(kp)
+        Inner::Ecdsa(kp)
     }
 }
 
 #[cfg(feature = "ed25519")]
 impl From<ed25519::Keypair> for Keypair {
     fn from(kp: ed25519::Keypair) -> Self {
-        #[allow(deprecated)]
-        Keypair::Ed25519(kp)
+        Keypair {
+            keypair: Inner::Ed25519(kp),
+        }
     }
 }
 
 #[cfg(feature = "secp256k1")]
 impl From<secp256k1::Keypair> for Keypair {
     fn from(kp: secp256k1::Keypair) -> Self {
-        #[allow(deprecated)]
-        Keypair::Secp256k1(kp)
+        Inner::Secp256k1(kp)
     }
 }
 
 #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
 impl From<rsa::Keypair> for Keypair {
     fn from(kp: rsa::Keypair) -> Self {
-        #[allow(deprecated)]
-        Keypair::Rsa(kp)
+        Keypair {
+            keypair: Inner::Rsa(kp),
+        }
     }
 }
 
@@ -318,15 +317,14 @@ impl TryInto<ed25519::Keypair> for Keypair {
     type Error = OtherVariantError;
 
     fn try_into(self) -> Result<ed25519::Keypair, Self::Error> {
-        #[allow(deprecated)]
-        match self {
-            Keypair::Ed25519(inner) => Ok(inner),
+        match self.keypair {
+            Inner::Ed25519(inner) => Ok(inner),
             #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
-            Keypair::Rsa(_) => Err(OtherVariantError::new(KeyType::RSA)),
+            Inner::Rsa(_) => Err(OtherVariantError::new(KeyType::RSA)),
             #[cfg(feature = "secp256k1")]
-            Keypair::Secp256k1(_) => Err(OtherVariantError::new(KeyType::Secp256k1)),
+            Inner::Secp256k1(_) => Err(OtherVariantError::new(KeyType::Secp256k1)),
             #[cfg(feature = "ecdsa")]
-            Keypair::Ecdsa(_) => Err(OtherVariantError::new(KeyType::Ecdsa)),
+            Inner::Ecdsa(_) => Err(OtherVariantError::new(KeyType::Ecdsa)),
         }
     }
 }
@@ -336,15 +334,14 @@ impl TryInto<ecdsa::Keypair> for Keypair {
     type Error = OtherVariantError;
 
     fn try_into(self) -> Result<ecdsa::Keypair, Self::Error> {
-        #[allow(deprecated)]
         match self {
-            Keypair::Ecdsa(inner) => Ok(inner),
+            Inner::Ecdsa(inner) => Ok(inner),
             #[cfg(feature = "ed25519")]
-            Keypair::Ed25519(_) => Err(OtherVariantError::new(KeyType::Ed25519)),
+            Inner::Ed25519(_) => Err(OtherVariantError::new(KeyType::Ed25519)),
             #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
-            Keypair::Rsa(_) => Err(OtherVariantError::new(KeyType::RSA)),
+            Inner::Rsa(_) => Err(OtherVariantError::new(KeyType::RSA)),
             #[cfg(feature = "secp256k1")]
-            Keypair::Secp256k1(_) => Err(OtherVariantError::new(KeyType::Secp256k1)),
+            Inner::Secp256k1(_) => Err(OtherVariantError::new(KeyType::Secp256k1)),
         }
     }
 }
@@ -354,15 +351,14 @@ impl TryInto<secp256k1::Keypair> for Keypair {
     type Error = OtherVariantError;
 
     fn try_into(self) -> Result<secp256k1::Keypair, Self::Error> {
-        #[allow(deprecated)]
         match self {
-            Keypair::Secp256k1(inner) => Ok(inner),
+            Inner::Secp256k1(inner) => Ok(inner),
             #[cfg(feature = "ed25519")]
-            Keypair::Ed25519(_) => Err(OtherVariantError::new(KeyType::Ed25519)),
+            Inner::Ed25519(_) => Err(OtherVariantError::new(KeyType::Ed25519)),
             #[cfg(all(feature = "rsa", not(target_arch = "wasm32")))]
-            Keypair::Rsa(_) => Err(OtherVariantError::new(KeyType::RSA)),
+            Inner::Rsa(_) => Err(OtherVariantError::new(KeyType::RSA)),
             #[cfg(feature = "ecdsa")]
-            Keypair::Ecdsa(_) => Err(OtherVariantError::new(KeyType::Ecdsa)),
+            Inner::Ecdsa(_) => Err(OtherVariantError::new(KeyType::Ecdsa)),
         }
     }
 }
@@ -372,15 +368,14 @@ impl TryInto<rsa::Keypair> for Keypair {
     type Error = OtherVariantError;
 
     fn try_into(self) -> Result<rsa::Keypair, Self::Error> {
-        #[allow(deprecated)]
-        match self {
-            Keypair::Rsa(inner) => Ok(inner),
+        match self.keypair {
+            Inner::Rsa(inner) => Ok(inner),
             #[cfg(feature = "ed25519")]
-            Keypair::Ed25519(_) => Err(OtherVariantError::new(KeyType::Ed25519)),
+            Inner::Ed25519(_) => Err(OtherVariantError::new(KeyType::Ed25519)),
             #[cfg(feature = "secp256k1")]
-            Keypair::Secp256k1(_) => Err(OtherVariantError::new(KeyType::Secp256k1)),
+            Inner::Secp256k1(_) => Err(OtherVariantError::new(KeyType::Secp256k1)),
             #[cfg(feature = "ecdsa")]
-            Keypair::Ecdsa(_) => Err(OtherVariantError::new(KeyType::Ecdsa)),
+            Inner::Ecdsa(_) => Err(OtherVariantError::new(KeyType::Ecdsa)),
         }
     }
 }

identity/src/lib.rs

@@ -126,6 +126,7 @@ impl From<&PublicKey> for proto::PublicKey {
 
 pub use error::{DecodingError, OtherVariantError, SigningError};
 pub use keypair::{Keypair, PublicKey};
+
 #[cfg(feature = "peerid")]
 pub use peer_id::{ParseError, PeerId};
 

transports/noise/src/protocol/x25519.rs

@@ -161,20 +161,16 @@ impl Keypair<X25519> {
     /// >  * [Noise: Static Key Reuse](http://www.noiseprotocol.org/noise.html#security-considerations)
     #[allow(unreachable_patterns)]
     pub fn from_identity(id_keys: &identity::Keypair) -> Option<AuthenticKeypair<X25519>> {
-        match id_keys {
-            identity::Keypair::Ed25519(p) => {
-                let kp = Keypair::from(SecretKey::from_ed25519(&p.secret()));
-                let id = KeypairIdentity {
-                    public: id_keys.public(),
-                    signature: None,
-                };
-                Some(AuthenticKeypair {
-                    keypair: kp,
-                    identity: id,
-                })
-            }
-            _ => None,
-        }
+        let ed25519_keypair = id_keys.clone().try_into_ed25519().ok()?;
+        let kp = Keypair::from(SecretKey::from_ed25519(&ed25519_keypair.secret()));
+        let id = KeypairIdentity {
+            public: id_keys.public(),
+            signature: None,
+        };
+        Some(AuthenticKeypair {
+            keypair: kp,
+            identity: id,
+        })
     }
 }