Enum sequoia_openpgp::types::SymmetricAlgorithm

source ·
#[non_exhaustive]
pub enum SymmetricAlgorithm {
Show 14 variants Unencrypted, IDEA, TripleDES, CAST5, Blowfish, AES128, AES192, AES256, Twofish, Camellia128, Camellia192, Camellia256, Private(u8), Unknown(u8),
}
Expand description

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)§

This enum is marked as 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§

source§

impl SymmetricAlgorithm

source

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.

source

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::Unencrypted.is_supported());
assert!(!SymmetricAlgorithm::Private(101).is_supported());
source

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

Length of a key for this algorithm in bytes.

Fails if the algorithm isn’t known to Sequoia.

source

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

Length of a block for this algorithm in bytes.

Fails if the algorithm isn’t known to Sequoia.

Trait Implementations§

source§

impl Clone for SymmetricAlgorithm

source§

fn clone(&self) -> SymmetricAlgorithm

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SymmetricAlgorithm

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for SymmetricAlgorithm

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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));
source§

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

Formats the value using the given formatter. Read more
source§

impl From<SymmetricAlgorithm> for u8

source§

fn from(s: SymmetricAlgorithm) -> u8

Converts to this type from the input type.
source§

impl From<u8> for SymmetricAlgorithm

source§

fn from(u: u8) -> Self

Converts to this type from the input type.
source§

impl Hash for SymmetricAlgorithm

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for SymmetricAlgorithm

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl PartialEq for SymmetricAlgorithm

source§

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

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

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.
source§

impl PartialOrd for SymmetricAlgorithm

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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 · source§

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
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Copy for SymmetricAlgorithm

source§

impl Eq for SymmetricAlgorithm

source§

impl StructuralPartialEq for SymmetricAlgorithm

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T