Enum trust_dns_client::rr::rdata::tsig::TsigAlgorithm

pub enum TsigAlgorithm {
    HmacMd5,
    Gss,
    HmacSha1,
    HmacSha224,
    HmacSha256,
    HmacSha256_128,
    HmacSha384,
    HmacSha384_192,
    HmacSha512,
    HmacSha512_256,
    Unknown(Name),
}

Algorithm used to authenticate communication

RFC8945 Secret Key Transaction Authentication for DNS

     +==========================+================+=================+
     | Algorithm Name           | Implementation | Use             |
     +==========================+================+=================+
     | HMAC-MD5.SIG-ALG.REG.INT | MAY            | MUST NOT        |
     +--------------------------+----------------+-----------------+
     | gss-tsig                 | MAY            | MAY             |
     +--------------------------+----------------+-----------------+
     | hmac-sha1                | MUST           | NOT RECOMMENDED |
     +--------------------------+----------------+-----------------+
     | hmac-sha224              | MAY            | MAY             |
     +--------------------------+----------------+-----------------+
     | hmac-sha256              | MUST           | RECOMMENDED     |
     +--------------------------+----------------+-----------------+
     | hmac-sha256-128          | MAY            | MAY             |
     +--------------------------+----------------+-----------------+
     | hmac-sha384              | MAY            | MAY             |
     +--------------------------+----------------+-----------------+
     | hmac-sha384-192          | MAY            | MAY             |
     +--------------------------+----------------+-----------------+
     | hmac-sha512              | MAY            | MAY             |
     +--------------------------+----------------+-----------------+
     | hmac-sha512-256          | MAY            | MAY             |
     +--------------------------+----------------+-----------------+

Variants

HmacMd5

HMAC-MD5.SIG-ALG.REG.INT (not supported for cryptographic operations)

Gss

gss-tsig (not supported for cryptographic operations)

HmacSha1

hmac-sha1 (not supported for cryptographic operations)

HmacSha224

hmac-sha224 (not supported for cryptographic operations)

HmacSha256

hmac-sha256

HmacSha256_128

hmac-sha256-128 (not supported for cryptographic operations)

HmacSha384

hmac-sha384

HmacSha384_192

hmac-sha384-192 (not supported for cryptographic operations)

HmacSha512

hmac-sha512

HmacSha512_256

hmac-sha512-256 (not supported for cryptographic operations)

Unknown(Name)

Unkown algorithm

Implementations

impl TsigAlgorithm

pub fn to_name(&self) -> Name

Return DNS name for the algorithm

pub fn emit(&self, encoder: &mut BinEncoder<'_>) -> Result<(), ProtoError>

Write the Algorithm to the given encoder

pub fn read(decoder: &mut BinDecoder<'_>) -> Result<TsigAlgorithm, ProtoError>

Read the Algorithm from the given Encoder

pub fn from_name(name: Name) -> TsigAlgorithm

Convert a DNS name to an Algorithm

pub fn mac_data(
    &self,
    key: &[u8],
    message: &[u8]
) -> Result<Vec<u8, Global>, ProtoError>

Compute the Message Authentication Code using key and algorithm

Supported algorithm are HmacSha256, HmacSha384, HmacSha512 and HmacSha512_256 Other algorithm return an error.

pub fn verify_mac(
    &self,
    key: &[u8],
    message: &[u8],
    tag: &[u8]
) -> Result<(), ProtoError>

Verifies the hmac tag against the given key and this algorithm.

This is both faster than independently creating the MAC and also constant time preventing timing attacks

pub fn output_len(&self) -> Result<usize, ProtoError>

Return length in bytes of the algorithms output

pub fn supported(&self) -> bool

Return true if cryptographic operations needed for using this algorithm are supported, false otherwise

Trait Implementations

impl Clone for TsigAlgorithm

pub fn clone(&self) -> TsigAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TsigAlgorithm

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

Formats the value using the given formatter.

impl Display for TsigAlgorithm

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

Formats the value using the given formatter.

impl Hash for TsigAlgorithm

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

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 PartialEq<TsigAlgorithm> for TsigAlgorithm

pub fn eq(&self, other: &TsigAlgorithm) -> bool

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

pub fn ne(&self, other: &TsigAlgorithm) -> bool

This method tests for !=.

impl Eq for TsigAlgorithm

impl StructuralEq for TsigAlgorithm

impl StructuralPartialEq for TsigAlgorithm