Struct UnwrapKeyParams 

#[non_exhaustive]
pub struct UnwrapKeyParams {
    pub algorithm: Option<KeyAlgorithm>,
    pub expect_key: Option<String>,
    pub label: String,
    pub policy: Option<KeyPolicyParams>,
}

Params for unwrap_key action.

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.

algorithm: Option<KeyAlgorithm>

What the ceremony is restoring, as a key algorithm name.

Nothing travels with a wrapped key saying what it is, so a recovered blob is read as whatever this names. Required to recover a symmetric key, whose bytes are indistinguishable from any other bytes of the same length. Optional for a keypair, which names itself once its DER parses, and checked against what came out when given.

expect_key: Option<String>

The expected identity of the recovered key: "sha256:<hex>" over its SPKI DER for a keypair, "cmac-aes:<hex>" for a symmetric key.

Usually the value the origin ceremony’s generate_key step recorded. On mismatch the step fails rather than importing a key the ceremony did not mean to restore.

label: String

Label for the unwrapped key.

policy: Option<KeyPolicyParams>

What the recovered key is permitted to do, and whether it may leave the backend again.

Nothing travels with a wrapped key that says what it may do, so the receiving ceremony declares that. Without a policy: the key may sign, verify and be wrapped again; a key restored to serve as a wrapping key has to say usages: [wrap, unwrap].

Trait Implementations

impl Clone for UnwrapKeyParams

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 UnwrapKeyParams

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

Formats the value using the given formatter.

impl Default for UnwrapKeyParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnwrapKeyParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for UnwrapKeyParams

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 UnwrapKeyParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.