Struct libp2p_identity::Keypair

pub struct Keypair { /* private fields */ }

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

Implementations

impl Keypair

pub fn generate_ed25519() -> Keypair

Available on crate features ed25519 and rand only.

Generate a new Ed25519 keypair.

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

Available on crate feature ed25519 only.

pub fn ed25519_from_bytes( bytes: impl AsMut<[u8]>, ) -> Result<Keypair, DecodingError>

Available on crate feature ed25519 only.

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]>

Available on crate features 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");

Trait Implementations

impl Clone for Keypair

fn clone(&self) -> Keypair

Returns a copy 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

Formats the value using the given formatter.

impl From<Keypair> for Keypair

Available on crate feature ed25519 only.

fn from(kp: Keypair) -> Self

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, Self::Error>

Performs the conversion.