Struct Ed25519PrivateKey

pub struct Ed25519PrivateKey { /* private fields */ }

An ed25519 private key.

This key type is used with crate::tor_provider::TorProvider trait for hosting onion-services and can be convertd to an Ed25519PublicKey. It can also be used to sign messages and create an Ed25519Signature.

Implementations

impl Ed25519PrivateKey

A wrapper around tor_llcrypto::pk::ed25519::ExpandedKeypair.

pub fn generate() -> Ed25519PrivateKey

Securely generate a new Ed25519PrivateKey.

pub fn from_raw(raw: &[u8; 64]) -> Result<Ed25519PrivateKey, Error>

Attempt to create an Ed25519PrivateKey from an array of bytes. Not all byte buffers of the required size can create a valid Ed25519PrivateKey. Only buffers derived from Ed25519PrivateKey::to_bytes() are required to convert correctly.

To securely generate a valid Ed25519PrivateKey, use Ed25519PrivateKey::generate().

pub fn from_key_blob_legacy(key_blob: &str) -> Result<Ed25519PrivateKey, Error>

Create an Ed25519PrivateKey from a String in the legacy c-tor daemon key blob format used in the ADD_ONION control-port command. From the c-tor control specification:

For a “ED25519-V3” key is the Base64 encoding of the concatenation of the 32-byte ed25519 secret scalar in little-endian and the 32-byte ed25519 PRF secret.

Only key blob strings created by the legacy c-tor daemon are required to convert correctly using this function. An Ed25519PrivateKey created using this method will seriaise to a different (but cryptographically equivalent) scalar-reduced key blob string using the Ed25519PrivateKey::to_key_blob() function.

pub fn from_key_blob(key_blob: &str) -> Result<Ed25519PrivateKey, Error>

Create an Ed25519PrivateKey from a String in the legacy c-tor daemon key blob format used in the ADD_ONION control-port command. From the c-tor control specification:

For a “ED25519-V3” key is the Base64 encoding of the concatenation of the 32-byte ed25519 secret scalar in little-endian and the 32-byte ed25519 PRF secret.

Only key blob strings derived from Ed25519PrivateKey::to_key_blob() are required to convert correctly using this function.

pub fn from_private_x25519( x25519_private: &X25519PrivateKey, ) -> Result<(Ed25519PrivateKey, SignBit), Error>

Construct an Ed25519PrivateKEy from an X25519PrivateKey.

pub fn to_key_blob(&self) -> String

Write Ed25519PrivateKey to a c-tor key blob formatted String.

pub fn sign_message(&self, message: &[u8]) -> Ed25519Signature

Sign the provided message and return an Ed25519Signature.

⚠ Warning ⚠

Only ever sign messages the private key owner controls the contents of!

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

Convert this private key to an array of bytes.

Trait Implementations

impl Clone for Ed25519PrivateKey

fn clone(&self) -> Ed25519PrivateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ed25519PrivateKey

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

Formats the value using the given formatter.

impl PartialEq for Ed25519PrivateKey

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.