Enum HashAlgorithm

#[non_exhaustive]
pub enum HashAlgorithm {
    MD5,
    SHA1,
    RipeMD,
    SHA256,
    SHA384,
    SHA512,
    SHA224,
    SHA3_256,
    SHA3_512,
    Private(u8),
    Unknown(u8),
}

The OpenPGP hash algorithms as defined in Section 9.5 of RFC 9580.

Examples

Use HashAlgorithm to set the preferred hash algorithms on a signature:

use sequoia_openpgp as openpgp;
use openpgp::packet::signature::SignatureBuilder;
use openpgp::types::{HashAlgorithm, SignatureType};

let mut builder = SignatureBuilder::new(SignatureType::DirectKey)
    .set_hash_algo(HashAlgorithm::SHA512);

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.

MD5

Rivest et.al. message digest 5.

SHA1

NIST Secure Hash Algorithm (deprecated)

RipeMD

RIPEMD-160

SHA256

256-bit version of SHA2

SHA384

384-bit version of SHA2

SHA512

512-bit version of SHA2

SHA224

224-bit version of SHA2

SHA3_256

256-bit version of SHA3

SHA3_512

512-bit version of SHA3

Private(u8)

Private hash algorithm identifier.

Unknown(u8)

Unknown hash algorithm identifier.

Implementations

impl HashAlgorithm

pub fn is_supported(self) -> bool

Whether Sequoia supports this algorithm.

impl HashAlgorithm

pub fn context(self) -> Result<Builder>

Creates a new hash context for this algorithm.

Errors

Fails with Error::UnsupportedHashAlgorithm if Sequoia does not support this algorithm. See HashAlgorithm::is_supported.

pub fn oid(self) -> Result<&'static [u8]>

Returns the prefix of a serialized DigestInfo structure that contains the ASN.1 OID of this hash algorithm.

The prefix is used for encoding RSA signatures according to the EMSA-PKCS1-v1_5 algorithm as specified in RFC 8017.

let algo = HashAlgorithm::SHA512;
let digest = // raw bytes of the digest
let digest_info = Vec::from(algo.oid()?).extend(digest);

Errors

Fails with Error::UnsupportedHashAlgorithm for unknown or private hash algorithms.

impl HashAlgorithm

pub fn text_name(&self) -> Result<&str>

Returns the text name of this algorithm.

Section 9.5 of RFC 9580 defines a textual representation of hash algorithms. This is used in cleartext signed messages (see Section 7 of RFC 9580).

Examples

assert_eq!(HashAlgorithm::RipeMD.text_name()?, "RIPEMD160");

pub fn digest_size(&self) -> Result<usize>

Returns the digest size for this algorithm.

pub fn salt_size(&self) -> Result<usize>

Returns the salt size for this algorithm.

Version 6 signatures salt the hash, and the size of the hash is dependent on the hash algorithm.

pub fn variants() -> impl Iterator<Item = Self>

Returns an iterator over all valid variants.

Returns an iterator over all known variants. This does not include the HashAlgorithm::Private, or HashAlgorithm::Unknown variants.

Trait Implementations

impl Clone for HashAlgorithm

fn clone(&self) -> HashAlgorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HashAlgorithm

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

Formats the value using the given formatter.

impl Default for HashAlgorithm

fn default() -> Self

Returns the “default value” for a type.

impl Display for HashAlgorithm

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

Formats the value using the given formatter.

impl From<HashAlgorithm> for u8

fn from(h: HashAlgorithm) -> u8

Converts to this type from the input type.

impl From<u8> for HashAlgorithm

fn from(u: u8) -> Self

Converts to this type from the input type.

impl FromStr for HashAlgorithm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl Hash for HashAlgorithm

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

fn cmp(&self, other: &HashAlgorithm) -> 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,

Restrict a value to a certain interval.

impl PartialEq for HashAlgorithm

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for HashAlgorithm

fn partial_cmp(&self, other: &HashAlgorithm) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for HashAlgorithm

impl Eq for HashAlgorithm

impl StructuralPartialEq for HashAlgorithm