Rename RemoteKeyPair to SigningKey

Author: djc

rcgen/src/crl.rs

@@ -24,7 +24,7 @@ use crate::{
 /// #[cfg(not(feature = "crypto"))]
 /// struct MyKeyPair { public_key: Vec<u8> }
 /// #[cfg(not(feature = "crypto"))]
-/// impl RemoteKeyPair for MyKeyPair {
+/// impl SigningKey for MyKeyPair {
 ///   fn public_key(&self) -> &[u8] { &self.public_key }
 ///   fn sign(&self, _: &[u8]) -> Result<Vec<u8>, rcgen::Error> { Ok(vec![]) }
 ///   fn algorithm(&self) -> &'static SignatureAlgorithm { &PKCS_ED25519 }

rcgen/src/key_pair.rs

@@ -40,7 +40,7 @@ pub(crate) enum KeyPairKind {
 	#[cfg(feature = "crypto")]
 	Rsa(RsaKeyPair, &'static dyn RsaEncoding),
 	/// A remote key pair
-	Remote(Box<dyn RemoteKeyPair + Send + Sync>),
+	Remote(Box<dyn SigningKey + Send + Sync>),
 }
 
 impl fmt::Debug for KeyPairKind {
@@ -188,7 +188,7 @@ impl KeyPair {
 	}
 
 	/// Obtains the key pair from a raw public key and a remote private key
-	pub fn from_remote(key_pair: Box<dyn RemoteKeyPair + Send + Sync>) -> Result<Self, Error> {
+	pub fn from_remote(key_pair: Box<dyn SigningKey + Send + Sync>) -> Result<Self, Error> {
 		Ok(Self {
 			alg: key_pair.algorithm(),
 			kind: KeyPairKind::Remote(key_pair),
@@ -496,7 +496,7 @@ impl KeyPair {
 	}
 
 	/// Access the remote key pair if it is a remote one
-	pub fn as_remote(&self) -> Option<&(dyn RemoteKeyPair + Send + Sync)> {
+	pub fn as_remote(&self) -> Option<&(dyn SigningKey + Send + Sync)> {
 		#[cfg_attr(not(feature = "crypto"), allow(irrefutable_let_patterns))]
 		if let KeyPairKind::Remote(remote) = &self.kind {
 			Some(remote.as_ref())
@@ -654,11 +654,11 @@ impl PublicKeyData for KeyPair {
 	}
 }
 
-/// A private key that is not directly accessible, but can be used to sign messages
+/// A key that can be used to sign messages
 ///
 /// Trait objects based on this trait can be passed to the [`KeyPair::from_remote`] function for generating certificates
 /// from a remote and raw private key, for example an HSM.
-pub trait RemoteKeyPair {
+pub trait SigningKey {
 	/// Returns the public key of this key pair in the binary format as in [`KeyPair::public_key_raw`]
 	fn public_key(&self) -> &[u8];
 

rcgen/src/lib.rs

@@ -62,7 +62,7 @@ pub use error::{Error, InvalidAsn1String};
 pub use key_pair::PublicKeyData;
 #[cfg(all(feature = "crypto", feature = "aws_lc_rs"))]
 pub use key_pair::RsaKeySize;
-pub use key_pair::{KeyPair, RemoteKeyPair, SubjectPublicKeyInfo};
+pub use key_pair::{KeyPair, SigningKey, SubjectPublicKeyInfo};
 #[cfg(feature = "crypto")]
 use ring_like::digest;
 pub use sign_algo::algo::*;

rcgen/tests/webpki.rs

@@ -14,7 +14,7 @@ use webpki::{
 };
 
 use rcgen::{
-	BasicConstraints, Certificate, CertificateParams, DnType, Error, IsCa, KeyPair, RemoteKeyPair,
+	BasicConstraints, Certificate, CertificateParams, DnType, Error, IsCa, KeyPair, SigningKey,
 };
 use rcgen::{CertificateRevocationListParams, RevocationReason, RevokedCertParams};
 #[cfg(feature = "x509-parser")]
@@ -317,7 +317,7 @@ fn test_webpki_separate_ca_with_other_signing_alg() {
 fn from_remote() {
 	struct Remote(EcdsaKeyPair);
 
-	impl RemoteKeyPair for Remote {
+	impl SigningKey for Remote {
 		fn public_key(&self) -> &[u8] {
 			self.0.public_key().as_ref()
 		}