Struct Keypair

#[repr(C)]
pub struct Keypair {
    pub secret: SecretKey,
    pub public: PublicKey,
}

A public/secret long-term key pair.

This is an Ed25519 key pair.

Fields

secret: SecretKey

The secret half of the key pair. Keep private.

public: PublicKey

The public half of the key pair. Feel free to share.

Implementations

impl Keypair

pub const SIZE: usize = 64usize

Size of a key pair, in bytes (== 64).

pub fn from_slice(s: &[u8]) -> Option<Keypair>

Deserialize a keypair from a byte slice.

The slice length must be 64; where the first 32 bytes are the secret key, and the second 32 bytes are the public key (libsodium’s standard layout).

pub fn from_base64(s: &str) -> Option<Keypair>

Deserialize from the bas64 representation. Ignores optional .ed25519 suffix.

Example

let s = "R6DKoOCt1Cj/IB2/ocvj2Eyp8AgmFdoJ9hH2TO4Tl8Yfapd5Lmw4pSpoY0WBEnqpHjz6UB4/QL2Wr0hWVAyi1w==.ed25519";
if let Some(keypair) = ssb_crypto::Keypair::from_base64(s) {
  // let auth = keypair.sign("hello".to_bytes());
  // ...
} else {
    panic!()
}

pub fn as_base64(&self) -> String

Does not include “.ed25519” suffix or a sigil prefix.

Example

let s = "R6DKoOCt1Cj/IB2/ocvj2Eyp8AgmFdoJ9hH2TO4Tl8Yfapd5Lmw4pSpoY0WBEnqpHjz6UB4/QL2Wr0hWVAyi1w==";
let kp = ssb_crypto::Keypair::from_base64(s).unwrap();
assert_eq!(kp.as_base64(), s);

pub fn generate() -> Keypair

Generate a new random keypair.

pub fn from_seed(seed: &[u8]) -> Option<Keypair>

Create a keypair from the given seed bytes. Slice length must be 32.

pub fn generate_with_rng<R>(r: &mut R) -> Keypair

where R: CryptoRng + RngCore,

Generate a new random keypair using the given cryptographically-secure random number generator.

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

Generate a signature for a given byte slice.

Trait Implementations

impl AsBytes for Keypair

fn as_bytes(&self) -> &[u8]

Get the bytes of this value.

fn as_bytes_mut(&mut self) -> &mut [u8]

where Self: FromBytes,

Get the bytes of this value mutably.

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<(), Error>

Formats the value using the given formatter.

impl Into<Keypair> for &Keypair

fn into(self) -> Keypair

Converts this type into the (usually inferred) input type.

impl FromBytes for Keypair