Struct PrivateKey

pub struct PrivateKey(/* private fields */);

Private key

Wrapper around x25519_dalek::StaticSecret with some traits.

Implements

• Implements Zeroize and ZeroizeOnDrop for clearing secrets from memory.
• Implements TryFrom<&str> or TryFrom<String> for importing key from Base64 format.
• Implements fmt::Display for exporting key in Wireguard’s format.
• Implements fmt::Debug.

Examples

// generate new random key:
let key = PrivateKey::random();

// import key:
let imported_key = PrivateKey::try_from("sJkP2oorqrq49P6Ln25MWo3X04PxhB8k+RnJJnZ4gEo=")?;

// export key via `fmt::Display` trait:
let exported_key = imported_key.to_string();

assert_eq!(exported_key, "sJkP2oorqrq49P6Ln25MWo3X04PxhB8k+RnJJnZ4gEo=".to_string());

Implementations

impl PrivateKey

pub fn random() -> PrivateKey

Generate new a random PrivateKey

impl PrivateKey

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

View private key as byte array.

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

Convert private key to a byte array.

Trait Implementations

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl Display for PrivateKey

Exporting key as base64 for Wireguard.

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

Formats the value using the given formatter.

impl Drop for PrivateKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<&PrivateKey> for PublicKey

fn from(value: &PrivateKey) -> Self

Converts to this type from the input type.

impl PartialEq for PrivateKey

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.

impl TryFrom<&str> for PrivateKey

type Error = WireguardError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for PrivateKey

type Error = WireguardError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Zeroize for PrivateKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.