Struct Keypair 

pub struct Keypair {
    keypair: KeyPairInner,
}

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      # optional

Loading the keys:

let mut bytes = std::fs::read("private.pk8").unwrap();
let keypair = Keypair::rsa_from_pkcs8(&mut bytes);

Fields

keypair: KeyPairInner

Implementations

impl Keypair

pub fn generate_ed25519() -> Keypair

Generate a new Ed25519 keypair.

pub fn generate_secp256k1() -> Keypair

Generate a new Secp256k1 keypair.

pub fn generate_ecdsa() -> Keypair

Generate a new ECDSA keypair.

pub fn try_into_ed25519(self) -> Result<Keypair, OtherVariantError>

pub fn try_into_secp256k1(self) -> Result<Keypair, OtherVariantError>

pub fn try_into_rsa(self) -> Result<Keypair, OtherVariantError>

pub fn try_into_ecdsa(self) -> Result<Keypair, OtherVariantError>

pub fn rsa_from_pkcs8(pkcs8_der: &mut [u8]) -> Result<Keypair, DecodingError>

Decode an keypair from a DER-encoded secret key in PKCS#8 PrivateKeyInfo format (i.e. unencrypted) as defined in RFC5208.

pub fn secp256k1_from_der(der: &mut [u8]) -> Result<Keypair, DecodingError>

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>

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.

pub fn public(&self) -> PublicKey

Get the public key of this keypair.

pub fn to_protobuf_encoding(&self) -> Result<Vec<u8>, DecodingError>

Encode a private key as protobuf structure.

pub fn from_protobuf_encoding(bytes: &[u8]) -> Result<Keypair, DecodingError>

Decode a private key from a protobuf structure and parse it as a Keypair.

pub fn key_type(&self) -> KeyType

Return a KeyType of the Keypair.

pub fn derive_secret(&self, domain: &[u8]) -> Option<[u8; 32]>

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");

Trait Implementations

impl Clone for Keypair

fn clone(&self) -> Keypair

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Keypair

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Keypair> for Keypair

Available on crate feature ecdsa only.

fn from(kp: Keypair) -> Keypair

Converts to this type from the input type.

impl From<Keypair> for Keypair

Available on crate feature ed25519 only.

fn from(kp: Keypair) -> Keypair

Converts to this type from the input type.

impl From<Keypair> for Keypair

Available on crate feature secp256k1 only.

fn from(kp: Keypair) -> Keypair

Converts to this type from the input type.

impl From<Keypair> for Keypair

Available on crate feature rsa and non-WebAssembly only.

fn from(kp: Keypair) -> Keypair

Converts to this type from the input type.

impl TryInto<Keypair> for Keypair

Available on crate feature ed25519 only.

type Error = OtherVariantError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Keypair, <Keypair as TryInto<Keypair>>::Error>

Performs the conversion.

impl TryInto<Keypair> for Keypair

Available on crate feature ecdsa only.

type Error = OtherVariantError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Keypair, <Keypair as TryInto<Keypair>>::Error>

Performs the conversion.

impl TryInto<Keypair> for Keypair

Available on crate feature secp256k1 only.

type Error = OtherVariantError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Keypair, <Keypair as TryInto<Keypair>>::Error>

Performs the conversion.

impl TryInto<Keypair> for Keypair

Available on crate feature rsa and non-WebAssembly only.

type Error = OtherVariantError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Keypair, <Keypair as TryInto<Keypair>>::Error>

Performs the conversion.