Enum trust_dns_proto::rr::dnssec::rdata::tsig::TsigAlgorithm

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

This is supported on crate feature dnssec only.

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<'_>) -> ProtoResult<()>

Write the Algorithm to the given encoder

pub fn read(decoder: &mut BinDecoder<'_>) -> ProtoResult<Self>

Read the Algorithm from the given Encoder

pub fn from_name(name: Name) -> Self

Convert a DNS name to an Algorithm

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

This is supported on crate feature ring only.

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]
) -> ProtoResult<()>

This is supported on crate feature ring only.

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) -> ProtoResult<usize>

This is supported on crate feature ring only.

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

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

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TsigAlgorithm

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for TsigAlgorithm

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

Formats the value using the given formatter.

impl Hash for TsigAlgorithm

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

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

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

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

This method tests for !=.

impl Serialize for TsigAlgorithm

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for TsigAlgorithm

impl StructuralEq for TsigAlgorithm

impl StructuralPartialEq for TsigAlgorithm