Enum sequoia_openpgp::types::HashAlgorithm
source · [−]#[non_exhaustive]
pub enum HashAlgorithm {
MD5,
SHA1,
RipeMD,
SHA256,
SHA384,
SHA512,
SHA224,
Private(u8),
Unknown(u8),
}
Expand description
The OpenPGP hash algorithms as defined in Section 9.4 of RFC 4880.
Note: This enum cannot be exhaustively matched to allow future extensions.
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)
This enum is marked as non-exhaustive
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
Private(u8)
Private hash algorithm identifier.
Unknown(u8)
Unknown hash algorithm identifier.
Implementations
sourceimpl HashAlgorithm
impl HashAlgorithm
sourcepub fn is_supported(self) -> bool
pub fn is_supported(self) -> bool
Whether Sequoia supports this algorithm.
sourceimpl HashAlgorithm
impl HashAlgorithm
sourcepub fn context(self) -> Result<Box<dyn Digest>>
pub fn context(self) -> Result<Box<dyn Digest>>
Creates a new hash context for this algorithm.
Errors
Fails with Error::UnsupportedHashAlgorithm
if Sequoia does
not support this algorithm. See
HashAlgorithm::is_supported
.
sourcepub fn oid(self) -> Result<&'static [u8]>
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.
sourceimpl HashAlgorithm
impl HashAlgorithm
sourcepub fn text_name(&self) -> Result<&str>
pub fn text_name(&self) -> Result<&str>
Returns the text name of this algorithm.
Section 9.4 of RFC 4880 defines a textual representation of hash algorithms. This is used in cleartext signed messages (see Section 7 of RFC 4880).
Examples
assert_eq!(HashAlgorithm::RipeMD.text_name()?, "RIPEMD160");
sourcepub fn variants() -> impl Iterator<Item = Self>
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
sourceimpl Clone for HashAlgorithm
impl Clone for HashAlgorithm
sourcefn clone(&self) -> HashAlgorithm
fn clone(&self) -> HashAlgorithm
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for HashAlgorithm
impl Debug for HashAlgorithm
sourceimpl Default for HashAlgorithm
impl Default for HashAlgorithm
sourceimpl Display for HashAlgorithm
impl Display for HashAlgorithm
sourceimpl From<HashAlgorithm> for u8
impl From<HashAlgorithm> for u8
sourcefn from(h: HashAlgorithm) -> u8
fn from(h: HashAlgorithm) -> u8
Converts to this type from the input type.
sourceimpl From<u8> for HashAlgorithm
impl From<u8> for HashAlgorithm
sourceimpl FromStr for HashAlgorithm
impl FromStr for HashAlgorithm
sourceimpl Hash for HashAlgorithm
impl Hash for HashAlgorithm
sourceimpl Ord for HashAlgorithm
impl Ord for HashAlgorithm
sourceimpl PartialEq<HashAlgorithm> for HashAlgorithm
impl PartialEq<HashAlgorithm> for HashAlgorithm
sourcefn eq(&self, other: &HashAlgorithm) -> bool
fn eq(&self, other: &HashAlgorithm) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &HashAlgorithm) -> bool
fn ne(&self, other: &HashAlgorithm) -> bool
This method tests for !=
.
sourceimpl PartialOrd<HashAlgorithm> for HashAlgorithm
impl PartialOrd<HashAlgorithm> for HashAlgorithm
sourcefn partial_cmp(&self, other: &HashAlgorithm) -> Option<Ordering>
fn partial_cmp(&self, other: &HashAlgorithm) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for HashAlgorithm
impl Eq for HashAlgorithm
impl StructuralEq for HashAlgorithm
impl StructuralPartialEq for HashAlgorithm
Auto Trait Implementations
impl RefUnwindSafe for HashAlgorithm
impl Send for HashAlgorithm
impl Sync for HashAlgorithm
impl Unpin for HashAlgorithm
impl UnwindSafe for HashAlgorithm
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more