Struct ed25519_dalek::pkcs8::KeypairBytes

pub struct KeypairBytes {
    pub secret_key: [u8; 32],
    pub public_key: Option<PublicKeyBytes>,
}

Available on crate feature pkcs8 only.

Ed25519 keypair serialized as bytes.

This type is primarily useful for decoding/encoding PKCS#8 private key files (either DER or PEM) encoded using the following traits:

• DecodePrivateKey: decode DER or PEM encoded PKCS#8 private key.
• EncodePrivateKey: encode DER or PEM encoded PKCS#8 private key.

PKCS#8 private key files encoded with PEM begin with:

-----BEGIN PRIVATE KEY-----

Note that this type operates on raw bytes and performs no validation that keys represent valid Ed25519 field elements.

Fields

secret_key: [u8; 32]

Ed25519 secret key.

Little endian serialization of an element of the Curve25519 scalar field, prior to “clamping” (i.e. setting/clearing bits to ensure the scalar is actually a valid field element)

public_key: Option<PublicKeyBytes>

Ed25519 public key (if available).

Compressed Edwards-y encoded curve point.

Implementations

impl KeypairBytes

pub fn from_bytes(bytes: &[u8; 64]) -> KeypairBytes

Parse raw keypair from a 64-byte input.

pub fn to_bytes(&self) -> Option<[u8; 64]>

Serialize as a 64-byte keypair.

Returns

• Some(bytes) if the public_key is present.
• None if the public_key is absent (i.e. None).

Trait Implementations

impl Debug for KeypairBytes

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

Formats the value using the given formatter.

impl Drop for KeypairBytes

fn drop(&mut self)

Executes the destructor for this type.

impl EncodePrivateKey for KeypairBytes

Available on crate feature alloc only.

fn to_pkcs8_der(&self) -> Result<SecretDocument, Error>

Serialize a SecretDocument containing a PKCS#8-encoded private key.

fn to_pkcs8_pem( &self, line_ending: LineEnding ) -> Result<Zeroizing<String>, Error>

Available on crate feature pem only.

Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.

fn write_pkcs8_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Available on crate feature std only.

Write ASN.1 DER-encoded PKCS#8 private key to the given path

fn write_pkcs8_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding ) -> Result<(), Error>

Available on crate features pem and std only.

Write ASN.1 DER-encoded PKCS#8 private key to the given path

impl From<&SigningKey> for KeypairBytes

fn from(signing_key: &SigningKey) -> KeypairBytes

Converts to this type from the input type.

impl From<SigningKey> for KeypairBytes

fn from(signing_key: SigningKey) -> KeypairBytes

Converts to this type from the input type.

impl FromStr for KeypairBytes

Available on crate feature pem only.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(pem: &str) -> Result<KeypairBytes, Error>

Parses a string s to return a value of this type.

impl TryFrom<&[u8]> for KeypairBytes

type Error = Error

The type returned in the event of a conversion error.

fn try_from(der_bytes: &[u8]) -> Result<KeypairBytes, Error>

Performs the conversion.

impl TryFrom<&KeypairBytes> for PublicKeyBytes

type Error = Error

The type returned in the event of a conversion error.

fn try_from(keypair: &KeypairBytes) -> Result<PublicKeyBytes, Error>

Performs the conversion.

impl TryFrom<&KeypairBytes> for SigningKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pkcs8_key: &KeypairBytes) -> Result<Self>

Performs the conversion.

impl TryFrom<KeypairBytes> for PublicKeyBytes

type Error = Error

The type returned in the event of a conversion error.

fn try_from(keypair: KeypairBytes) -> Result<PublicKeyBytes, Error>

Performs the conversion.

impl TryFrom<KeypairBytes> for SigningKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pkcs8_key: KeypairBytes) -> Result<Self>

Performs the conversion.

impl TryFrom<PrivateKeyInfo<'_>> for KeypairBytes

type Error = Error

The type returned in the event of a conversion error.

fn try_from(private_key: PrivateKeyInfo<'_>) -> Result<KeypairBytes, Error>

Performs the conversion.