Struct Attributes

Source

pub struct Attributes {
    pub lifetime: Lifetime,
    pub key_type: Type,
    pub bits: usize,
    pub policy: Policy,
}

Expand description

Native definition of the attributes needed to fully describe a cryptographic key.

Fields§

§lifetime: Lifetime

Lifetime of the key

§key_type: Type

Intrinsic category and type of the key

§bits: usize

Size of the key in bits

§policy: Policy

Policy restricting the permitted usage of the key

Implementations§

Source §

impl Attributes

Source

pub fn is_exportable(self) -> bool

Check if a key has permission to be exported

Source

pub fn can_export(self) -> Result<()>

Check export in a fallible way

§Example

use psa_crypto::types::key::{Attributes, Type, Lifetime, Policy, UsageFlags};
use psa_crypto::types::algorithm::{Algorithm, AsymmetricSignature, Hash};

let mut usage_flags: UsageFlags = Default::default();
let mut attributes = Attributes {
    key_type: Type::RsaKeyPair,
    bits: 1024,
    lifetime: Lifetime::Volatile,
    policy: Policy {
        usage_flags,
        permitted_algorithms: Algorithm::AsymmetricSignature(AsymmetricSignature::RsaPkcs1v15Sign {
            hash_alg: Hash::Sha256.into(),
        }),
    },
};

// Can not export because the export flag is set to false.
attributes.can_export().unwrap_err();

Source

pub fn is_hash_signable(self) -> bool

Check if a key has permission to sign a message hash

Source

pub fn can_sign_hash(self) -> Result<()>

Check hash signing permission in a fallible way

Source

pub fn is_hash_verifiable(self) -> bool

Check if a key has permission to verify a message hash

Source

pub fn can_verify_hash(self) -> Result<()>

Check hash verifying permission in a fallible way

Source

pub fn is_message_signable(self) -> bool

Check if a key has permission to sign a message

Source

pub fn can_sign_message(self) -> Result<()>

Check message signing permission in a fallible way

Source

pub fn is_message_verifiable(self) -> bool

Check if a key has permission to verify a message

Source

pub fn can_verify_message(self) -> Result<()>

Check message verifying permission in a fallible way

Source

pub fn is_encrypt_permitted(self) -> bool

Check if a key has permissions to encrypt a message

Source

pub fn can_encrypt_message(self) -> Result<()>

Check encrypt permission in a fallible way

Source

pub fn is_decrypt_permitted(self) -> bool

Check if a key has permissions to decrypt a message

Source

pub fn can_decrypt_message(self) -> Result<()>

Check decrypt permission in a fallible way

Source

pub fn is_derivable(self) -> bool

Check if a key has permissions to be derived from

Source

pub fn can_derive_from(self) -> Result<()>

Check derive permission of a fallible way

Source

pub fn can_convert_into_psa(self) -> Result<()>

Check if can be converted into psa_key_attributes_t

Source

pub fn is_alg_permitted(self, alg: Algorithm) -> bool

Check if the alg given for a cryptographic operation is permitted to be used with the key

Source

pub fn permits_alg(self, alg: Algorithm) -> Result<()>

Check if alg is permitted in a fallible way

Source

pub fn is_compatible_with_alg(self, alg: Algorithm) -> bool

Check if the alg given for a cryptographic operation is compatible with the type of the key

§Example

use psa_crypto::types::key::{Attributes, Type, Lifetime, Policy, UsageFlags};
use psa_crypto::types::algorithm::{Algorithm, AsymmetricSignature, Hash};

let permitted_alg = Algorithm::AsymmetricSignature(AsymmetricSignature::RsaPkcs1v15Sign {
    hash_alg: Hash::Sha256.into(),
});
let alg = Algorithm::AsymmetricSignature(AsymmetricSignature::RsaPkcs1v15Sign {
    hash_alg: Hash::Sha256.into(),
});
let mut usage_flags: UsageFlags = Default::default();
let mut attributes = Attributes {
    key_type: Type::RsaKeyPair,
    bits: 1024,
    lifetime: Lifetime::Volatile,
    policy: Policy {
        usage_flags,
        permitted_algorithms: permitted_alg,
    },
};

assert!(attributes.is_compatible_with_alg(alg));
attributes.key_type = Type::RsaPublicKey;
assert!(attributes.is_compatible_with_alg(alg));

Source

pub fn compatible_with_alg(self, alg: Algorithm) -> Result<()>

Check if alg is compatible in a fallible way

Source

pub fn from_key_id(key_id: Id) -> Result<Self>

Gets the attributes for a given key ID

The Id structure can be created with the from_persistent_key_id constructor on Id.

§Example

psa_crypto::init().unwrap();
let my_key_id = key_management::generate(attributes, None).unwrap();
//...
let key_attributes = Attributes::from_key_id(my_key_id);

Source