Struct ruma::signatures::Ed25519KeyPair

pub struct Ed25519KeyPair { /* private fields */ }

Available on crate feature signatures only.

An Ed25519 key pair.

Implementations

impl Ed25519KeyPair

pub fn new( oid: ObjectIdentifier, privkey: &[u8], pubkey: Option<&[u8]>, version: String, ) -> Result<Ed25519KeyPair, Error>

Create a key pair from its constituent parts.

pub fn from_der( document: &[u8], version: String, ) -> Result<Ed25519KeyPair, Error>

Initializes a new key pair.

Parameters

• document: PKCS#8 v1/v2 DER-formatted document containing the private (and optionally public) key.
• version: The “version” of the key used for this signature. Versions are used as an identifier to distinguish signatures generated from different keys but using the same algorithm on the same homeserver.

Errors

Returns an error if the public and private keys provided are invalid for the implementing algorithm.

Returns an error when the PKCS#8 document had a public key, but it doesn’t match the one generated from the private key. This is a fallback and extra validation against corruption or

pub fn from_pkcs8_oak( oak: PrivateKeyInfo<'_>, version: String, ) -> Result<Ed25519KeyPair, Error>

Constructs a key pair from pkcs8::PrivateKeyInfo.

pub fn from_pkcs8_pki( oak: PrivateKeyInfo<'_>, version: String, ) -> Result<Ed25519KeyPair, Error>

Constructs a key pair from pkcs8::PrivateKeyInfo.

pub fn generate() -> Result<Zeroizing<Vec<u8>>, Error>

Generates a new key pair.

Returns

Returns a Vec<u8> representing a DER-encoded PKCS#8 v2 document (with public key)

Errors

Returns an error if the generation failed.

pub fn version(&self) -> &str

Returns the version string for this keypair.

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

Returns the public key.

Trait Implementations

impl Debug for Ed25519KeyPair

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

Formats the value using the given formatter.

impl KeyPair for Ed25519KeyPair

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

Signs a JSON object.