Struct domain::rdata::tsig::Tsig

pub struct Tsig<Octs, Name> { /* private fields */ }

Implementations

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, ) -> Result<Self, LongRecordData>

where O: AsRef<[u8]>, N: ToDname,

Creates new TSIG record data from its components.

See the access methods for an explanation of these components. The function will return an error if the wire format length of the record would exceed 65,535 octets.

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

Creates new TSIG record data without checking.

Safety

The caller needs to ensure that the wire format length of the created record will not exceed 65,535 octets.

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_at(&self, now: Time48) -> bool

Returns whether the record is valid at the given time.

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

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.

impl<Octs> Tsig<Octs, ParsedDname<Octs>>

pub fn parse<'a, Src: Octets<Range<'a> = Octs> + ?Sized + 'a>( parser: &mut Parser<'a, Src>, ) -> Result<Self, ParseError>

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.

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

Returns whether self is canonically less than other.

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

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

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

Returns whether self is canonically greater than other.

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

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

impl<Octs: Clone, Name: Clone> Clone for Tsig<Octs, Name>

fn clone(&self) -> Tsig<Octs, Name>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octs: AsRef<[u8]>, Name: ToDname> ComposeRecordData for Tsig<Octs, Name>

fn rdlen(&self, _compress: bool) -> Option<u16>

Returns the length of the record data if available.

fn compose_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the wire format of the record data into target.

fn compose_canonical_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the canonical wire format of the record data into target.

fn compose_len_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the record data prefixed with its length.

fn compose_canonical_len_rdata<Target: Composer + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the record data prefixed with its length.

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<Octs, TOcts, Name, TName> FlattenInto<Tsig<TOcts, TName>> for Tsig<Octs, Name>

where TOcts: OctetsFrom<Octs>, Name: FlattenInto<TName, AppendError = TOcts::Error>,

type AppendError = <TOcts as OctetsFrom<Octs>>::Error

fn try_flatten_into(self) -> Result<Tsig<TOcts, TName>, Self::AppendError>

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

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

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Octs, SrcOctets, Name, SrcName> OctetsFrom<Tsig<SrcOctets, SrcName>> for Tsig<Octs, Name>

where Octs: OctetsFrom<SrcOctets>, Name: OctetsFrom<SrcName>, Octs::Error: From<Name::Error>,

type Error = <Octs as OctetsFrom<SrcOctets>>::Error

fn try_octets_from( source: Tsig<SrcOctets, SrcName>, ) -> Result<Self, Self::Error>

Performs the conversion.

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.

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<'a, Octs: Octets + ?Sized> ParseRecordData<'a, Octs> for Tsig<Octs::Range<'a>, ParsedDname<Octs::Range<'a>>>

fn parse_rdata( rtype: Rtype, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parses the record data.

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 ==.

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<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.

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<O, N> RecordData for Tsig<O, N>

fn rtype(&self) -> Rtype

Returns the record type associated with this record data instance.

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