Enum sequoia_openpgp::types::SymmetricAlgorithm

#[non_exhaustive]
pub enum SymmetricAlgorithm {
    Unencrypted,
    IDEA,
    TripleDES,
    CAST5,
    Blowfish,
    AES128,
    AES192,
    AES256,
    Twofish,
    Camellia128,
    Camellia192,
    Camellia256,
    Private(u8),
    Unknown(u8),
}

The symmetric-key algorithms as defined in Section 9.2 of RFC 4880.

The values can be converted into and from their corresponding values of the serialized format.

Use SymmetricAlgorithm::from to translate a numeric value to a symbolic one.

Note: This enum cannot be exhaustively matched to allow future extensions.

Examples

Use SymmetricAlgorithm to set the preferred symmetric algorithms on a signature:

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

let mut builder = SignatureBuilder::new(SignatureType::DirectKey)
    .set_hash_algo(HashAlgorithm::SHA512)
    .set_preferred_symmetric_algorithms(vec![
        SymmetricAlgorithm::AES256,
    ])?;

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.

Unencrypted

Null encryption.

IDEA

IDEA block cipher.

TripleDES

3-DES in EDE configuration.

CAST5

CAST5/CAST128 block cipher.

Blowfish

Schneier et.al. Blowfish block cipher.

AES128

10-round AES.

AES192

12-round AES.

AES256

14-round AES.

Twofish

Twofish block cipher.

Camellia128

18 rounds of NESSIEs Camellia.

Camellia192

24 rounds of NESSIEs Camellia w/192 bit keys.

Camellia256

24 rounds of NESSIEs Camellia w/256 bit keys.

Private(u8)

Private algorithm identifier.

Unknown(u8)

Unknown algorithm identifier.

Implementations

impl SymmetricAlgorithm

pub fn is_supported(&self) -> bool

Returns whether this algorithm is supported by the crypto backend.

All backends support all the AES variants.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::SymmetricAlgorithm;

assert!(SymmetricAlgorithm::AES256.is_supported());
assert!(SymmetricAlgorithm::TripleDES.is_supported());

assert!(!SymmetricAlgorithm::IDEA.is_supported());
assert!(!SymmetricAlgorithm::Unencrypted.is_supported());
assert!(!SymmetricAlgorithm::Private(101).is_supported());

pub fn key_size(self) -> Result<usize>

Length of a key for this algorithm in bytes.

Fails if Sequoia does not support this algorithm.

pub fn block_size(self) -> Result<usize>

Length of a block for this algorithm in bytes.

Fails if Sequoia does not support this algorithm.

impl SymmetricAlgorithm

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 SymmetricAlgorithm::Unencrypted, SymmetricAlgorithm::Private, or SymmetricAlgorithm::Unknown variants.

Trait Implementations

impl Clone for SymmetricAlgorithm

fn clone(&self) -> SymmetricAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymmetricAlgorithm

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

Formats the value using the given formatter.

impl Default for SymmetricAlgorithm

fn default() -> Self

Returns the “default value” for a type.

impl Display for SymmetricAlgorithm

Formats the symmetric algorithm name.

There are two ways the symmetric algorithm name can be formatted. By default the short name is used. The alternate format uses the full algorithm name.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::SymmetricAlgorithm;

// default, short format
assert_eq!("AES-128", format!("{}", SymmetricAlgorithm::AES128));

// alternate, long format
assert_eq!("AES with 128-bit key", format!("{:#}", SymmetricAlgorithm::AES128));

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

Formats the value using the given formatter.

impl From<SymmetricAlgorithm> for u8

fn from(s: SymmetricAlgorithm) -> u8

Converts to this type from the input type.

impl From<u8> for SymmetricAlgorithm

fn from(u: u8) -> Self

Converts to this type from the input type.

impl Hash for SymmetricAlgorithm

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 SymmetricAlgorithm

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SymmetricAlgorithm> for SymmetricAlgorithm

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

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

impl Eq for SymmetricAlgorithm

impl StructuralEq for SymmetricAlgorithm

impl StructuralPartialEq for SymmetricAlgorithm