pub struct Keypair { /* private fields */ }Expand description
Identity keypair of a node.
§Example: Generating RSA keys with OpenSSL
openssl genrsa -out private.pem 2048
openssl pkcs8 -in private.pem -inform PEM -topk8 -out private.pk8 -outform DER -nocrypt
rm private.pem # optionalLoading the keys:
let mut bytes = std::fs::read("private.pk8").unwrap();
let keypair = Keypair::rsa_from_pkcs8(&mut bytes);Implementations§
Source§impl Keypair
impl Keypair
Sourcepub fn generate_ed25519() -> Keypair
Available on crate features ed25519 and rand only.
pub fn generate_ed25519() -> Keypair
ed25519 and rand only.Generate a new Ed25519 keypair.
Sourcepub fn generate_secp256k1() -> Keypair
Available on crate features secp256k1 and rand only.
pub fn generate_secp256k1() -> Keypair
secp256k1 and rand only.Generate a new Secp256k1 keypair.
Sourcepub fn generate_ecdsa() -> Keypair
Available on crate features ecdsa and rand only.
pub fn generate_ecdsa() -> Keypair
ecdsa and rand only.Generate a new ECDSA keypair.
pub fn try_into_ed25519(self) -> Result<Keypair, OtherVariantError>
ed25519 only.pub fn try_into_secp256k1(self) -> Result<Keypair, OtherVariantError>
secp256k1 only.pub fn try_into_rsa(self) -> Result<Keypair, OtherVariantError>
rsa and non-WebAssembly only.pub fn try_into_ecdsa(self) -> Result<Keypair, OtherVariantError>
ecdsa only.Sourcepub fn rsa_from_pkcs8(pkcs8_der: &mut [u8]) -> Result<Keypair, DecodingError>
Available on crate feature rsa and non-WebAssembly only.
pub fn rsa_from_pkcs8(pkcs8_der: &mut [u8]) -> Result<Keypair, DecodingError>
rsa and non-WebAssembly only.Decode an keypair from a DER-encoded secret key in PKCS#8 PrivateKeyInfo format (i.e. unencrypted) as defined in RFC5208.
Sourcepub fn secp256k1_from_der(der: &mut [u8]) -> Result<Keypair, DecodingError>
Available on crate feature secp256k1 only.
pub fn secp256k1_from_der(der: &mut [u8]) -> Result<Keypair, DecodingError>
secp256k1 only.Decode a keypair from a DER-encoded Secp256k1 secret key in an ECPrivateKey structure as defined in RFC5915.
pub fn ed25519_from_bytes( bytes: impl AsMut<[u8]>, ) -> Result<Keypair, DecodingError>
ed25519 only.Sourcepub fn sign(&self, msg: &[u8]) -> Result<Vec<u8>, SigningError>
pub fn sign(&self, msg: &[u8]) -> Result<Vec<u8>, SigningError>
Sign a message using the private key of this keypair, producing a signature that can be verified using the corresponding public key.
Sourcepub fn to_protobuf_encoding(&self) -> Result<Vec<u8>, DecodingError>
pub fn to_protobuf_encoding(&self) -> Result<Vec<u8>, DecodingError>
Encode a private key as protobuf structure.
Sourcepub fn from_protobuf_encoding(bytes: &[u8]) -> Result<Keypair, DecodingError>
pub fn from_protobuf_encoding(bytes: &[u8]) -> Result<Keypair, DecodingError>
Decode a private key from a protobuf structure and parse it as a Keypair.
Sourcepub fn derive_secret(&self, domain: &[u8]) -> Option<[u8; 32]>
Available on crate features ecdsa or secp256k1 or ed25519 or rsa only.
pub fn derive_secret(&self, domain: &[u8]) -> Option<[u8; 32]>
ecdsa or secp256k1 or ed25519 or rsa only.Deterministically derive a new secret from this Keypair, taking into account the provided domain.
This works for all key types except RSA where it returns None.
§Example
let key = identity::Keypair::generate_ed25519();
let new_key = key.derive_secret(b"my encryption key").expect("can derive secret for ed25519");