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

Hash algorithm.

Mac(Mac)

MAC algorithm.

Cipher(Cipher)

Symmetric Cipher algorithm.

Aead(Aead)

Authenticated Encryption with Associated Data (AEAD) algorithm.

AsymmetricSignature(AsymmetricSignature)

Public-key signature algorithm.

AsymmetricEncryption(AsymmetricEncryption)

Public-key encryption algorithm.

KeyAgreement(KeyAgreement)

Key agreement algorithm.

KeyDerivation(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 duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Algorithm

impl Debug for Algorithm

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Algorithm

impl From<Aead> for Algorithm

fn from(alg: Aead) -> Algorithm

Converts to this type from the input type.

impl From<AsymmetricEncryption> for Algorithm

fn from(alg: AsymmetricEncryption) -> Algorithm

Converts to this type from the input type.

impl From<AsymmetricSignature> for Algorithm

fn from(alg: AsymmetricSignature) -> Algorithm

Converts to this type from the input type.

impl From<Cipher> for Algorithm

fn from(alg: Cipher) -> Algorithm

Converts to this type from the input type.

impl From<Hash> for Algorithm

fn from(alg: Hash) -> Algorithm

Converts to this type from the input type.

impl From<KeyAgreement> for Algorithm

fn from(alg: KeyAgreement) -> Algorithm

Converts to this type from the input type.

impl From<KeyDerivation> for Algorithm

fn from(alg: KeyDerivation) -> Algorithm

Converts to this type from the input type.

impl From<Mac> for Algorithm

fn from(alg: Mac) -> Algorithm

Converts to this type from the input type.

impl PartialEq for Algorithm

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Algorithm

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Algorithm

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.