Struct Keypair 

pub struct Keypair(/* private fields */);

Wrapper around pkarr::Keypair that customizes PublicKey rendering.

Implementations

impl Keypair

pub fn random() -> Self

Generate a random keypair.

pub fn secret(&self) -> [u8; 32]

Export the secret bytes used to derive this keypair.

pub fn from_secret(secret: &[u8; 32]) -> Self

Construct a Keypair from a 32-byte secret.

pub fn from_secret_key_file(path: &Path) -> Result<Self, Error>

Read a keypair from a pkarr secret key file.

pub fn public_key(&self) -> PublicKey

Return the PublicKey associated with this Keypair.

Display the returned key with .to_string() to get the pubky<z32> identifier or PublicKey::z32() when you specifically need the bare z-base32 text (e.g. hostnames).

pub const fn as_inner(&self) -> &Keypair

Borrow the inner pkarr::Keypair.

pub fn write_secret_key_file(&self, path: &Path) -> Result<(), Error>

Persist the secret key to disk using the pkarr format.

pub fn into_inner(self) -> Keypair

Extract the inner pkarr::Keypair.

Methods from Deref<Target = Keypair>

pub fn sign(&self, message: &[u8]) -> Signature

Signs a message with the private key of this Keypair.

pub fn verify(&self, message: &[u8], signature: &Signature) -> Result<(), Error>

Verifies a message against a given signature using this Keypair.

pub fn secret_key(&self) -> [u8; 32]

Returns the secret part of this Keypair.

pub fn public_key(&self) -> PublicKey

Returns the PublicKey of this Keypair.

pub fn to_z32(&self) -> String

Converts the public key of this Keypair to a z-base32 encoded string.

pub fn to_uri_string(&self) -> String

Converts the public key of this Keypair to a URI string.

pub fn write_secret_key_file( &self, secret_file_path: &Path, ) -> Result<(), Error>

Writes the secret of the keypair to a file, as a hex encoded string. If the file already exists, it will be overwritten. In unix like operating systems, the file permission 600 is set.

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

Formats the value using the given formatter.

impl Deref for Keypair

type Target = Keypair

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Keypair

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Keypair> for Keypair

fn from(keypair: Keypair) -> Self

Converts to this type from the input type.

impl From<Keypair> for Keypair

fn from(value: Keypair) -> Self

Converts to this type from the input type.