Struct tor_interface::tor_crypto::X25519PrivateKey

pub struct X25519PrivateKey { /* private fields */ }

An x25519 private key

Implementations

impl X25519PrivateKey

A wrapper around tor_llcrypto::pk::curve25519::StaticSecret

pub fn generate() -> X25519PrivateKey

Securely generate a new X25519PrivateKey

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

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

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

pub fn from_base64(base64: &str) -> Result<X25519PrivateKey, Error>

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

PrivateKeyBlob = base64 encoding of x25519 key

Only key blob strings derived from X25519PrivateKey::to_base64() are required to convert correctly.

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

Sign the provided message and return an Ed25519Signature and SignBit.

This method first converts this X25519PrivateKey to an Ed25519PrivateKey and SignBit. Then, the message is signed using the derived Ed25519PrivateKey. To verify the signature, both the X25519PublicKey and this calculated SignBit are required.

⚠ Warning ⚠

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

pub fn to_base64(&self) -> String

Write X25519PrivateKey to a base64 encocded String.

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

Convert this private key to an array of bytes.

Trait Implementations

impl Clone for X25519PrivateKey

fn clone(&self) -> X25519PrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for X25519PrivateKey

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

Formats the value using the given formatter.

impl PartialEq for X25519PrivateKey

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

This method tests for self and other values to be equal, and is used by ==.

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

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