Enum psa_crypto::types::key::Type

pub enum Type {
    RawData,
    Hmac,
    Derive,
    Aes,
    Des,
    Camellia,
    Arc4,
    Chacha20,
    RsaPublicKey,
    RsaKeyPair,
    EccKeyPair {
        curve_family: EccFamily,
    },
    EccPublicKey {
        curve_family: EccFamily,
    },
    DhKeyPair {
        group_family: DhFamily,
    },
    DhPublicKey {
        group_family: DhFamily,
    },
}

Enumeration of key types supported.

Variants

RawData

Not a valid key type for any cryptographic operation but can be used to store arbitrary data in the key store.

Hmac

HMAC key.

Derive

A secret key for derivation.

Aes

Key for a cipher, AEAD or MAC algorithm based on the AES block cipher.

Des

Key for a cipher or MAC algorithm based on DES or 3DES (Triple-DES).

Camellia

Key for a cipher, AEAD or MAC algorithm based on the Camellia block cipher.

Arc4

Key for the RC4 stream cipher.

Chacha20

Key for the ChaCha20 stream cipher or the Chacha20-Poly1305 AEAD algorithm.

RsaPublicKey

RSA public key.

RsaKeyPair

RSA key pair: both the private and public key.

EccKeyPair

Fields

curve_family: EccFamily

ECC curve family to use.

Elliptic curve key pair: both the private and public key.

EccPublicKey

Fields

curve_family: EccFamily

ECC curve family to use.

Elliptic curve public key.

DhKeyPair

Fields

group_family: DhFamily

Diffie-Hellman group family to use.

Diffie-Hellman key pair: both the private key and public key.

DhPublicKey

Fields

group_family: DhFamily

Diffie-Hellman group family to use.

Diffie-Hellman public key.

Implementations

impl Type

pub fn is_ecc_key_pair(self) -> bool

Checks if a key type is ECC key pair with any curve family inside.

pub fn is_ecc_public_key(self) -> bool

Checks if a key type is ECC public key with any curve family inside.

Example

use psa_crypto::types::key::{Type, EccFamily};

assert!(Type::EccPublicKey { curve_family: EccFamily::SecpK1}.is_ecc_public_key());

pub fn is_rsa_public_key(self) -> bool

Checks if a key type is RSA public key.

pub fn is_dh_public_key(self) -> bool

Checks if a key type is DH public key with any group family inside.

pub fn is_dh_key_pair(self) -> bool

Checks if a key type is DH key pair with any group family inside.

pub fn is_public_key(self) -> bool

Checks if a key type is an asymmetric public key type.

pub fn key_type_public_key_of_key_pair(self) -> Result<Type>

If key is public or key pair, returns the corresponding public key type.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Type

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

Deserialize this value from the given Serde deserializer.

impl Display for Type

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

Formats the value using the given formatter.

impl PartialEq<Type> for Type

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

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

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

This method tests for !=.

impl Serialize for Type

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

Serialize this value into the given Serde serializer.

impl TryFrom<Type> for psa_key_type_t

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key_type: Type) -> Result<Self>

Performs the conversion.

impl TryFrom<u16> for Type

type Error = Error

The type returned in the event of a conversion error.

fn try_from(key_type: psa_key_type_t) -> Result<Self>

Performs the conversion.

impl Zeroize for Type

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 Type

impl StructuralPartialEq for Type