Enum psa_crypto::types::algorithm::Algorithm

pub enum Algorithm {
    None,
    Hash(Hash),
    Mac(Mac),
    Cipher(Cipher),
    Aead(Aead),
    AsymmetricSignature(AsymmetricSignature),
    AsymmetricEncryption(AsymmetricEncryption),
    KeyAgreement(KeyAgreement),
    KeyDerivation(KeyDerivation),
}

Enumeration of possible algorithm definitions. Each variant of the enum contains a main algorithm type (which is required for that variant).

Variants

None

An invalid algorithm identifier value. None does not allow any cryptographic operation with the key. The key can still be used for non-cryptographic actions such as exporting, if permitted by the usage flags.

Hash(Hash)

Tuple Fields

0: Hash

Hash algorithm.

Mac(Mac)

Tuple Fields

0: Mac

MAC algorithm.

Cipher(Cipher)

Tuple Fields

0: Cipher

Symmetric Cipher algorithm.

Aead(Aead)

Tuple Fields

0: Aead

Authenticated Encryption with Associated Data (AEAD) algorithm.

AsymmetricSignature(AsymmetricSignature)

Tuple Fields

0: AsymmetricSignature

Public-key signature algorithm.

AsymmetricEncryption(AsymmetricEncryption)

Tuple Fields

0: AsymmetricEncryption

Public-key encryption algorithm.

KeyAgreement(KeyAgreement)

Tuple Fields

0: KeyAgreement

Key agreement algorithm.

KeyDerivation(KeyDerivation)

Tuple Fields

0: KeyDerivation

Key derivation algorithm.

Implementations

impl Algorithm

pub fn is_hmac(self) -> bool

Check if the algorithm is a HMAC algorithm, truncated or not

Example

use psa_crypto::types::algorithm::{Algorithm, Mac, FullLengthMac, Hash};
let hmac = Algorithm::Mac(Mac::Truncated {
    mac_alg: FullLengthMac::Hmac { hash_alg: Hash::Sha256 },
    mac_length: 30,
});
assert!(hmac.is_hmac());

Trait Implementations

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Algorithm

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<Aead> for Algorithm

fn from(alg: Aead) -> Self

Performs the conversion.

impl From<AsymmetricEncryption> for Algorithm

fn from(alg: AsymmetricEncryption) -> Self

Performs the conversion.

impl From<AsymmetricSignature> for Algorithm

fn from(alg: AsymmetricSignature) -> Self

Performs the conversion.

impl From<Cipher> for Algorithm

fn from(alg: Cipher) -> Self

Performs the conversion.

impl From<Hash> for Algorithm

fn from(alg: Hash) -> Self

Performs the conversion.

impl From<KeyAgreement> for Algorithm

fn from(alg: KeyAgreement) -> Self

Performs the conversion.

impl From<KeyDerivation> for Algorithm

fn from(alg: KeyDerivation) -> Self

Performs the conversion.

impl From<Mac> for Algorithm

fn from(alg: Mac) -> Self

Performs the conversion.

impl PartialEq<Algorithm> for Algorithm

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

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

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

This method tests for !=.

impl Serialize for Algorithm

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<Algorithm> for psa_algorithm_t

type Error = Error

The type returned in the event of a conversion error.

fn try_from(alg: Algorithm) -> Result<Self>

Performs the conversion.

impl TryFrom<u32> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(alg: psa_algorithm_t) -> Result<Self>

Performs the conversion.

impl Zeroize for Algorithm

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Copy for Algorithm

impl StructuralPartialEq for Algorithm