Struct Psk 

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

Implementations

impl Psk

pub fn null() -> Psk

A null PSK (all zeroes).

This should only be used when PSK authentication is not required and only encryption is desired. Using a null PSK provides confidentiality but not authentication.

pub fn generate() -> Psk

Generate a random PSK using a cryptographically secure random number generator.

This is the recommended way to create a PSK for secure authentication. The PSK must then be shared with the other party through a secure out-of-band channel (QR code, NFC, secure messaging, etc.).

Example

use ap_noise::Psk;

let psk = Psk::generate();

pub fn from_bytes(bytes: [u8; 32]) -> Psk

Construct a PSK from a 32-byte array.

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

Export the PSK as a 32-byte array.

pub fn to_hex(&self) -> String

Encode the PSK as a hexadecimal string.

This is the recommended format for storing or transmitting PSKs (e.g., in QR codes, configuration files, or secure storage). The resulting string is 64 characters long.

Example

use ap_noise::Psk;
use rand::thread_rng;

let psk = Psk::generate();
let encoded = psk.to_hex();
assert_eq!(encoded.len(), 64);

pub fn from_hex(s: &str) -> Result<Psk, NoiseProtocolError>

Decode a PSK from a hexadecimal string.

Returns an error if the string is not valid hex or does not decode to exactly 32 bytes.

Example

use ap_noise::Psk;
use rand::thread_rng;

let psk = Psk::generate();
let encoded = psk.to_hex();
let decoded = Psk::from_hex(&encoded).unwrap();
assert_eq!(psk.to_bytes(), decoded.to_bytes());

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

pub fn id(&self) -> String

Compute a stable, non-secret identifier for this PSK.

Returns hex(SHA256(psk)[0..8]) — a 16-character hex string derived from the first 8 bytes of the PSK’s SHA-256 hash. This serves as a lookup key for matching incoming handshakes to pending pairings without revealing the PSK itself.

Trait Implementations

impl Clone for Psk

fn clone(&self) -> Psk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Psk

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

Formats the value using the given formatter.

impl Drop for Psk

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Psk

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