Struct Cookie

pub struct Cookie {
    value: Sensitive<Zeroizing<[u8; 32]>>,
}

A secret cookie value, used in RPC authentication.

Fields

value: Sensitive<Zeroizing<[u8; 32]>>

The value of the cookie.

Implementations

impl Cookie

pub fn load( path: &Path, mistrust: &Mistrust, ) -> Result<Cookie, CookieAccessError>

Read an RPC cookie from a provided path.

pub fn create<R: CryptoRng + RngCore>( path: &Path, rng: &mut R, mistrust: &Mistrust, ) -> Result<Cookie, CookieAccessError>

Available on crate feature rpc-server only.

Create a new RPC cookie and store it at a provided path, overwriting any previous file at that location.

fn new<R: CryptoRng + RngCore>(rng: &mut R) -> Self

Create a new random cookie.

fn new_mac(&self) -> TupleHash

Return an appropriately personalized TupleHash instance, keyed from this cookie.

pub fn server_mac( &self, client_nonce: &CookieAuthNonce, server_nonce: &CookieAuthNonce, socket_canonical: &str, ) -> CookieAuthMac

Compute the “server_mac” value as in the RPC cookie authentication protocol.

pub fn client_mac( &self, client_nonce: &CookieAuthNonce, server_nonce: &CookieAuthNonce, socket_canonical: &str, ) -> CookieAuthMac

Compute the “client_mac” value as in the RPC cookie authentication protocol.

Trait Implementations

impl AsRef<[u8; 32]> for Cookie

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Cookie

fn clone(&self) -> Cookie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cookie

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

Formats the value using the given formatter.