Struct KeyPolicyParams 

#[non_exhaustive]
pub struct KeyPolicyParams {
    pub persistent: Option<bool>,
    pub sensitive: Option<bool>,
    pub extractable: Option<bool>,
    pub wrap_with_trusted_only: Option<bool>,
    pub usages: Option<Vec<KeyUsage>>,
}

The policy: block, mirroring KeyPolicy field for field.

Every field is optional and falls back to the restrictive choice: a persistent, sensitive, non-extractable key. The usages fall back to what the algorithm permits, by KeyPolicy::default_for, so a keypair may sign and verify and a symmetric key may wrap and unwrap. A ceremony that wraps a key it generated has to say extractable: true, because otherwise the key cannot leave the backend and the wrap step will refuse.

This is PKCS#11 vocabulary: what the token permits. The KeyUsage extension in a certificate is a different thing, settled by profile: on issue_certificate.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

persistent: Option<bool>

Key survives the session. CKA_TOKEN.

sensitive: Option<bool>

Key material is never revealed in plaintext. CKA_SENSITIVE.

extractable: Option<bool>

Key may be wrapped and leave the backend. CKA_EXTRACTABLE.

wrap_with_trusted_only: Option<bool>

Key may only be wrapped by a trusted wrapping key. CKA_WRAP_WITH_TRUSTED.

usages: Option<Vec<KeyUsage>>

Operations the key is permitted to perform: sign, verify, encrypt, decrypt, wrap, unwrap, derive.

Implementations

impl KeyPolicyParams

pub fn resolve_from(&self, defaults: &KeyPolicy) -> KeyPolicy

Resolve the declared policy against a base.

The base is the caller’s to choose, because what a key may do when the ceremony says nothing follows from its algorithm: see KeyPolicy::default_for.

Trait Implementations

impl Clone for KeyPolicyParams

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPolicyParams

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

Formats the value using the given formatter.

impl Default for KeyPolicyParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyPolicyParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for KeyPolicyParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for KeyPolicyParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.