Enum trust_dns_proto::rr::dnssec::Algorithm

#[non_exhaustive]
pub enum Algorithm {
    RSAMD5,
    DSA,
    RSASHA1,
    RSASHA1NSEC3SHA1,
    RSASHA256,
    RSASHA512,
    ECDSAP256SHA256,
    ECDSAP384SHA384,
    ED25519,
    Unknown(u8),
}

Available on crate feature dnssec only.

DNSSec signing and validation algorithms.

For reference the iana documents have all the officially registered algorithms.

RFC 6944, DNSSEC DNSKEY Algorithm Status, April 2013

2.2.  Algorithm Implementation Status Assignment Rationale

RSASHA1 has an implementation status of Must Implement, consistent
with [RFC4034].  RSAMD5 has an implementation status of Must Not
Implement because of known weaknesses in MD5.

The status of RSASHA1-NSEC3-SHA1 is set to Recommended to Implement
as many deployments use NSEC3.  The status of RSA/SHA-256 and RSA/
SHA-512 are also set to Recommended to Implement as major deployments
(such as the root zone) use these algorithms [ROOTDPS].  It is
believed that RSA/SHA-256 or RSA/SHA-512 algorithms will replace
older algorithms (e.g., RSA/SHA-1) that have a perceived weakness.

Likewise, ECDSA with the two identified curves (ECDSAP256SHA256 and
ECDSAP384SHA384) is an algorithm that may see widespread use due to
the perceived similar level of security offered with smaller key size
compared to the key sizes of algorithms such as RSA.  Therefore,
ECDSAP256SHA256 and ECDSAP384SHA384 are Recommended to Implement.

All other algorithms used in DNSSEC specified without an
implementation status are currently set to Optional.

2.3.  DNSSEC Implementation Status Table

The DNSSEC algorithm implementation status table is listed below.
Only the algorithms already specified for use with DNSSEC at the time
of writing are listed.

 +------------+------------+-------------------+-------------------+
 |    Must    |  Must Not  |    Recommended    |      Optional     |
 |  Implement | Implement  |   to Implement    |                   |
 +------------+------------+-------------------+-------------------+
 |            |            |                   |                   |
 |   RSASHA1  |   RSAMD5   |   RSASHA256       |   Any             |
 |            |            |   RSASHA1-NSEC3   |   registered      |
 |            |            |    -SHA1          |   algorithm       |
 |            |            |   RSASHA512       |   not listed in   |
 |            |            |   ECDSAP256SHA256 |   this table      |
 |            |            |   ECDSAP384SHA384 |                   |
 +------------+------------+-------------------+-------------------+

   This table does not list the Reserved values in the IANA registry
   table or the values for INDIRECT (252), PRIVATE (253), and PRIVATEOID
   (254).  These values may relate to more than one algorithm and are
   therefore up to the implementer's discretion.  As noted, any
   algorithm not listed in the table is Optional.  As of this writing,
   the Optional algorithms are DSASHA1, DH, DSA-NSEC3-SHA1, and GOST-
   ECC, but in general, anything not explicitly listed is Optional.

2.4.  Specifying New Algorithms and Updating the Status of Existing
      Entries

   [RFC6014] establishes a parallel procedure for adding a registry
   entry for a new algorithm other than a standards track document.
   Because any algorithm not listed in the foregoing table is Optional,
   algorithms entered into the registry using the [RFC6014] procedure
   are automatically Optional.

   It has turned out to be useful for implementations to refer to a
   single document that specifies the implementation status of every
   algorithm.  Accordingly, when a new algorithm is to be registered
   with a status other than Optional, this document shall be made
   obsolete by a new document that adds the new algorithm to the table
   in Section 2.3.  Similarly, if the status of any algorithm in the
   table in Section 2.3 changes, a new document shall make this document
   obsolete; that document shall include a replacement of the table in
   Section 2.3.  This way, the goal of having one authoritative document
   to specify all the status values is achieved.

   This document cannot be updated, only made obsolete and replaced by a
   successor document.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

RSAMD5

👎Deprecated:

this is a compromised hashing function, it is here for backward compatibility

DO NOT USE, MD5 is a compromised hashing function, it is here for backward compatibility

DSA

👎Deprecated:

this is a compromised hashing function, it is here for backward compatibility

DO NOT USE, DSA is a compromised hashing function, it is here for backward compatibility

RSASHA1

👎Deprecated:

this is a compromised hashing function, it is here for backward compatibility

DO NOT USE, SHA1 is a compromised hashing function, it is here for backward compatibility

RSASHA1NSEC3SHA1

👎Deprecated:

this is a compromised hashing function, it is here for backward compatibility

DO NOT USE, SHA1 is a compromised hashing function, it is here for backward compatibility

RSASHA256

RSA public key with SHA256 hash

RSASHA512

RSA public key with SHA512 hash

ECDSAP256SHA256

rfc6605

ECDSAP384SHA384

rfc6605

ED25519

draft-ietf-curdle-dnskey-eddsa-03

Unknown(u8)

An unknown algorithm identifier

Implementations

impl Algorithm

pub fn from_u8(value: u8) -> Self

http://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml

pub fn hash_len(self) -> Option<usize>

length in bytes that the hash portion of this function will produce

pub fn to_str(self) -> &'static str

👎Deprecated:

use as_str instead

Convert to string form

pub fn as_str(self) -> &'static str

Convert to string form

Trait Implementations

impl<'r> BinDecodable<'r> for Algorithm

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

Read the type from the stream

fn from_bytes(bytes: &'r [u8]) -> ProtoResult<Self>

Returns the object in binary form

impl BinEncodable for Algorithm

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

Write the type to the stream

fn to_bytes(&self) -> ProtoResult<Vec<u8>>

Returns the object in binary form

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Algorithm

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

Deserialize this value from the given Serde deserializer.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl From<Algorithm> for &'static str

fn from(a: Algorithm) -> &'static str

Converts to this type from the input type.

impl From<Algorithm> for DigestType

fn from(a: Algorithm) -> Self

Converts to this type from the input type.

impl From<Algorithm> for SupportedAlgorithms

fn from(algorithm: Algorithm) -> Self

Converts to this type from the input type.

impl From<Algorithm> for u8

fn from(a: Algorithm) -> Self

Converts to this type from the input type.

impl Hash for Algorithm

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 Ord for Algorithm

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Algorithm> for Algorithm

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

fn partial_cmp(&self, other: &Algorithm) -> 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 Serialize for Algorithm

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

Serialize this value into the given Serde serializer.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralEq for Algorithm

impl StructuralPartialEq for Algorithm