Enum AEADAlgorithm 

#[non_exhaustive]
pub enum AEADAlgorithm {
    EAX,
    OCB,
    GCM,
    Private(u8),
    Unknown(u8),
}

AEAD modes.

See AEAD Algorithms for details.

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

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

Examples

Use AEADAlgorithm to set the preferred AEAD algorithms on a signature:

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

let features = Features::empty().set_seipdv2();
let mut builder = SignatureBuilder::new(SignatureType::DirectKey)
    .set_features(features)?
    .set_preferred_aead_ciphersuites(vec![
        (SymmetricAlgorithm::Camellia128, AEADAlgorithm::EAX),
    ])?;

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.

EAX

EAX mode.

OCB

OCB mode.

GCM

Galois/Counter mode.

Private(u8)

Private algorithm identifier.

Unknown(u8)

Unknown algorithm identifier.

Implementations

impl AEADAlgorithm

pub fn context<'s>( self, symm: SymmetricAlgorithm, key: &'s SessionKey, aad: &'s [u8], nonce: &'s [u8], ) -> Result<Builder<'s>, Error>

Creates a new AEAD context builder for this algorithm.

Errors

Fails with Error::UnsupportedSymmetricAlgorithm if Sequoia does not support the given symmetric algorithm, and Error::UnsupportedAEADAlgorithm if Sequoia does not support the given AEAD algorithm, or combination of symmetric algorithm and AEAD algorithm.

impl AEADAlgorithm

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

Returns the digest size of the AEAD algorithm.

pub fn nonce_size(&self) -> Result<usize, Error>

Returns the nonce size of the AEAD algorithm.

impl AEADAlgorithm

pub fn is_supported(&self) -> bool

Returns whether this algorithm is supported.

Examples

use sequoia_openpgp as openpgp;
use openpgp::types::AEADAlgorithm;

assert!(! AEADAlgorithm::Private(100).is_supported());

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

Returns an iterator over all valid variants.

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

Trait Implementations

impl Clone for AEADAlgorithm

fn clone(&self) -> AEADAlgorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AEADAlgorithm

impl Debug for AEADAlgorithm

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

Formats the value using the given formatter.

impl Default for AEADAlgorithm

fn default() -> AEADAlgorithm

Returns the best AEAD mode supported by the backend.

This SHOULD return OCB, which is the mandatory-to-implement algorithm, but fall back to any supported algorithm.

impl Display for AEADAlgorithm

Formats the AEAD algorithm name.

There are two ways the AEAD 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::AEADAlgorithm;

// default, short format
assert_eq!("EAX", format!("{}", AEADAlgorithm::EAX));

// alternate, long format
assert_eq!("EAX mode", format!("{:#}", AEADAlgorithm::EAX));

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

Formats the value using the given formatter.

impl Eq for AEADAlgorithm

impl From<u8> for AEADAlgorithm

fn from(u: u8) -> AEADAlgorithm

Converts to this type from the input type.

impl Hash for AEADAlgorithm

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

where __H: Hasher,

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 AEADAlgorithm

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for AEADAlgorithm

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AEADAlgorithm

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