Struct Key

pub struct Key(pub [u8; 32]);

Represents a WireGuard encryption key.

WireGuard makes no meaningful distinction between public, private and preshared keys - any sequence of 32 bytes can be used as either of those.

This means that you need to be careful when working with Keys, especially ones created from external data.

Tuple Fields

0: [u8; 32]

Implementations

impl Key

pub fn generate_private() -> Self

Generates and returns a new private key.

pub fn generate_preshared() -> Self

Generates and returns a new preshared key.

pub fn get_public(&self) -> Self

Generates a public key for this private key.

pub fn zero() -> Self

Generates an all-zero key.

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

pub fn to_base64(&self) -> String

Converts the key to a standardized base64 representation, as used by the wg utility and wg-quick.

pub fn from_base64(key: &str) -> Result<Self, InvalidKey>

Converts a base64 representation of the key to the raw bytes.

This can fail, as not all text input is valid base64 - in this case Err(InvalidKey) is returned.

pub fn from_hex(hex_str: &str) -> Result<Self, InvalidKey>

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl PartialEq for Key

fn eq(&self, other: &Key) -> 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 Eq for Key

impl StructuralPartialEq for Key