Struct domain::base::opt::cookie::StandardServerCookie

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

An interoperable server cookie for DNS cookies.

In the original specification, the server cookie was of variable length and rules for its generation were left to the server implementers. This resulted in interoperability problems if servers from multiple vendors were placed behind the same public address. Thus, RFC 9018 defined a standard mechanism of the content and generation of the cookie. This type is such a standard server cookie.

This standard server cookie consists of a 1 octet version number (currently 1), 3 reserved octets that must be zero, a 4 octet timestamp as seconds since the Unix epoch, and 8 octets of hash value.

In version 1, the hash is calculated feeding the SipHash-2-4 that has been initialized with a server secret the concatenation of client cookie, version, reserved, timestamp, client IP address. Generatin and checking the hash is available if the siphasher feature is enabled.

Implementations

impl StandardServerCookie

pub fn new( version: u8, reserved: [u8; 3], timestamp: Serial, hash: [u8; 8] ) -> Self

Creates a new server cookie from the provided components.

pub fn calculate( client_cookie: ClientCookie, timestamp: Serial, client_ip: IpAddr, secret: &[u8; 16] ) -> Self

Calculates the server cookie for the given components.

pub fn version(self) -> u8

Returns the version field of the cookie.

pub fn reserved(self) -> [u8; 3]

Returns the reserved field of the cookie.

pub fn timestamp(self) -> Serial

Returns the timestamp field of the cookie.

pub fn hash(self) -> [u8; 8]

Returns the hash field of the cookie.

pub fn set_hash(&mut self, hash: [u8; 8])

Sets the hash field to the given value.

pub fn check_hash( self, client_cookie: ClientCookie, client_ip: IpAddr, secret: &[u8; 16] ) -> bool

Returns whether the hash matches the given client cookie and secret.

Trait Implementations

impl Clone for StandardServerCookie

fn clone(&self) -> StandardServerCookie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StandardServerCookie

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

Formats the value using the given formatter.

impl Display for StandardServerCookie

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

Formats the value using the given formatter.

impl From<StandardServerCookie> for ServerCookie

fn from(src: StandardServerCookie) -> Self

Converts to this type from the input type.

impl Hash for StandardServerCookie

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StandardServerCookie

fn cmp(&self, other: &StandardServerCookie) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StandardServerCookie

fn eq(&self, other: &StandardServerCookie) -> 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.

impl PartialOrd for StandardServerCookie

fn partial_cmp(&self, other: &StandardServerCookie) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for StandardServerCookie

impl Eq for StandardServerCookie

impl StructuralPartialEq for StandardServerCookie