Struct Ed25519KeyPair

pub struct Ed25519KeyPair { /* private fields */ }

Available on crate feature ed25519 only.

An Ed25519 public key or keypair

Implementations

impl Ed25519KeyPair

pub fn to_signing_key(&self) -> Option<Ed25519SigningKey>

Create a signing key from the secret key

pub fn to_x25519_keypair(&self) -> X25519KeyPair

Convert this keypair to an X25519 keypair

pub fn sign(&self, message: &[u8]) -> Option<[u8; 64]>

Sign a message with the secret key

pub fn verify_signature(&self, message: &[u8], signature: &[u8]) -> bool

Verify a signature against the public key

Trait Implementations

impl Clone for Ed25519KeyPair

fn clone(&self) -> Ed25519KeyPair

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ed25519KeyPair

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

Formats the value using the given formatter.

impl Drop for Ed25519KeyPair

fn drop(&mut self)

Executes the destructor for this type.

impl FromJwk for Ed25519KeyPair

fn from_jwk_parts(jwk: JwkParts<'_>) -> Result<Self, Error>

Import the key from a pre-parsed JWK

fn from_jwk(jwk: &str) -> Result<Self, Error>

Import the key from a JWK string reference

fn from_jwk_slice(jwk: &[u8]) -> Result<Self, Error>

Import the key from a JWK byte slice

impl HasKeyAlg for Ed25519KeyPair

fn algorithm(&self) -> KeyAlg

Get the corresponding key algorithm.

impl HasKeyBackend for Ed25519KeyPair

fn key_backend(&self) -> KeyBackend

Get the corresponding key backend.

impl KeyGen for Ed25519KeyPair

fn generate(rng: impl KeyMaterial) -> Result<Self, Error>

Create a new key from a key material generator.

fn random() -> Result<Self, Error>

Generate a new random key.

impl KeyMeta for Ed25519KeyPair

type KeySize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

The size of the key secret bytes

impl KeyPublicBytes for Ed25519KeyPair

fn from_public_bytes(key: &[u8]) -> Result<Self, Error>

Create a new key instance from a slice of public key bytes.

fn with_public_bytes<O>(&self, f: impl FnOnce(&[u8]) -> O) -> O

Access a temporary slice of the key public bytes.

impl KeySecretBytes for Ed25519KeyPair

fn from_secret_bytes(key: &[u8]) -> Result<Self, Error>

Create a new key instance from a slice of key secret bytes.

fn with_secret_bytes<O>(&self, f: impl FnOnce(Option<&[u8]>) -> O) -> O

Access a temporary slice of the key secret bytes, if any.

impl KeySigVerify for Ed25519KeyPair

fn verify_signature( &self, message: &[u8], signature: &[u8], sig_type: Option<SignatureType>, ) -> Result<bool, Error>

Check the validity of signature over a message with the specified signature type.

impl KeySign for Ed25519KeyPair

fn write_signature( &self, message: &[u8], sig_type: Option<SignatureType>, out: &mut dyn WriteBuffer, ) -> Result<(), Error>

Create a signature of the requested type and write it to the provided buffer.

fn create_signature( &self, message: &[u8], sig_type: Option<SignatureType>, ) -> Result<SecretBytes, Error>

Available on crate feature alloc only.

Create a signature of the requested type and return an allocated buffer.

impl KeypairBytes for Ed25519KeyPair

fn from_keypair_bytes(kp: &[u8]) -> Result<Self, Error>

Create a new key instance from a slice of keypair bytes.

fn with_keypair_bytes<O>(&self, f: impl FnOnce(Option<&[u8]>) -> O) -> O

Create a new key instance from a slice of keypair bytes.

fn to_keypair_bytes_buffer<B: WriteBuffer>( &self, out: &mut B, ) -> Result<(), Error>

Write the keypair bytes to a buffer.

fn to_keypair_bytes(&self) -> Result<SecretBytes, Error>

Available on crate feature alloc only.

Write the keypair bytes to a new allocated buffer.

impl KeypairMeta for Ed25519KeyPair

type PublicKeySize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

The size of the key public bytes

type KeypairSize = UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>

The size of the secret bytes and public bytes combined

impl ToJwk for Ed25519KeyPair

fn encode_jwk(&self, enc: &mut dyn JwkEncoder) -> Result<(), Error>

Write the JWK representation to an encoder

fn to_jwk_thumbprint(&self, alg: Option<KeyAlg>) -> Result<String, Error>

Available on crate feature alloc only.

Create the JWK thumbprint of the key

fn to_jwk_public(&self, alg: Option<KeyAlg>) -> Result<String, Error>

Available on crate feature alloc only.

Create a JWK of the public key

fn to_jwk_secret(&self, alg: Option<KeyAlg>) -> Result<SecretBytes, Error>

Available on crate feature alloc only.

Create a JWK of the secret key

impl TryFrom<&Ed25519KeyPair> for X25519KeyPair

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Ed25519KeyPair) -> Result<Self, Self::Error>

Performs the conversion.

impl ZeroizeOnDrop for Ed25519KeyPair