Struct domain::rdata::rfc2845::Tsig

pub struct Tsig<O, N> { /* fields omitted */ }

Methods

impl<O, N> Tsig<O, N>

pub fn new(
    algorithm: N,
    time_signed: Time48,
    fudge: u16,
    mac: O,
    original_id: u16,
    error: TsigRcode,
    other: O
) -> Self

Creates a new TSIG record from its components.

See the access methods for an explanation of these components.

Panics

Since time_signed is actually a 48 bit integer, the function will panic of the upper 16 bits are not all 0.

pub fn algorithm(&self) -> &N

Returns a reference to the algorithm name.

TSIG encodes the algorithm used for keys and signatures as a domain name. It does, however, only use the format. No structure is used at all.

pub fn time_signed(&self) -> Time48

Returns the Unix time when the signature is created.

Despite its type, this is actually a 48 bit number. The upper 16 bits will never be set.

pub fn fudge(&self) -> u16

Return the number of seconds of offset from signing time permitted.

When a signature is checked, the local system time needs to be within this many seconds from time_signed to be accepted.

pub fn mac(&self) -> &O

Returns a reference to the bytes value containing the MAC.

pub fn mac_slice(&self) -> &[u8] where
    O: AsRef<[u8]>, 

Returns an octet slice containing the MAC.

pub fn into_mac(self) -> O

Converts the record data into the MAC.

pub fn original_id(&self) -> u16

Returns the original message ID.

Since the message ID is part of the signature generation but may be changed for a forwarded message, it is included in the TSIG record.

pub fn error(&self) -> TsigRcode

Returns the TSIG error.

pub fn other(&self) -> &O

Returns a reference to the other bytes.

This field is only used for BADTIME errors to return the server time. Otherwise it is empty.

pub fn other_time(&self) -> Option<Time48> where
    O: AsRef<[u8]>, 

Returns the other bytes as the server time.

If the other bytes field is exactly 6 bytes long, this methods returns it as a u64 representation of the Unix time contained.

pub fn is_valid_now(&self) -> bool

Returns whether the record is valid right now.

The method checks whether the current system time is within fudge seconds of the time_signed.

Trait Implementations

impl<O, OO, N, NN> CanonicalOrd<Tsig<OO, NN>> for Tsig<O, N> where
    O: AsRef<[u8]>,
    OO: AsRef<[u8]>,
    N: ToDname,
    NN: ToDname, 

fn canonical_cmp(&self, other: &Tsig<OO, NN>) -> Ordering

Returns the canonical ordering between self and other.

#[must_use]fn canonical_lt(&self, other: &Rhs) -> bool

Returns whether self is canonically less than other.

#[must_use]fn canonical_le(&self, other: &Rhs) -> bool

Returns whether self is canonically less than or equal to other.

#[must_use]fn canonical_gt(&self, other: &Rhs) -> bool

Returns whether self is canonically greater than other.

#[must_use]fn canonical_ge(&self, other: &Rhs) -> bool

Returns whether self is canonically greater than or equal to other.

impl<O: Clone, N: Clone> Clone for Tsig<O, N>

fn clone(&self) -> Tsig<O, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: AsRef<[u8]>, N: Compose> Compose for Tsig<O, N>

fn compose<T: OctetsBuilder>(&self, target: &mut T) -> Result<(), ShortBuf>

Appends the concrete representation of the value to the target.

fn compose_canonical<T: OctetsBuilder>(
    &self,
    target: &mut T
) -> Result<(), ShortBuf>

Appends the canonical representation of the value to the target.

impl<O: AsRef<[u8]>, N: Debug> Debug for Tsig<O, N>

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

Formats the value using the given formatter.

impl<O: AsRef<[u8]>, N: Display> Display for Tsig<O, N>

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

Formats the value using the given formatter.

impl<O: AsRef<[u8]>, N: ToDname> Eq for Tsig<O, N>

impl<O, N> From<Tsig<O, N>> for AllRecordData<O, N>

fn from(value: Tsig<O, N>) -> Self

Performs the conversion.

impl<O: AsRef<[u8]>, N: Hash> Hash for Tsig<O, N>

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, 

Feeds a slice of this type into the given [Hasher].

impl<O: AsRef<[u8]>, N: ToDname> Ord for Tsig<O, N>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<Ref: OctetsRef> Parse<Ref> for Tsig<Ref::Range, ParsedDname<Ref>>

fn parse(parser: &mut Parser<Ref>) -> Result<Self, ParseError>

Extracts a value from the beginning of parser.

fn skip(parser: &mut Parser<Ref>) -> Result<(), ParseError>

Skips over a value of this type at the beginning of parser.

impl<O, OO, N, NN> PartialEq<Tsig<OO, NN>> for Tsig<O, N> where
    O: AsRef<[u8]>,
    OO: AsRef<[u8]>,
    N: ToDname,
    NN: ToDname, 

fn eq(&self, other: &Tsig<OO, NN>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<O, OO, N, NN> PartialOrd<Tsig<OO, NN>> for Tsig<O, N> where
    O: AsRef<[u8]>,
    OO: AsRef<[u8]>,
    N: ToDname,
    NN: ToDname, 

fn partial_cmp(&self, other: &Tsig<OO, NN>) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<O, N> RtypeRecordData for Tsig<O, N>

const RTYPE: Rtype

The record type of a value of this type.