Struct ImportKeyParams 

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

Params for import_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: KeyAlgorithm

What the bytes are, as a key algorithm name.

Required, because raw material says nothing about itself: a symmetric algorithm reads the bytes as the key itself, every other one reads them as PKCS#8 DER. unwrap_key can leave this out for a keypair because the artifact it reads carries a description; an artifact of plain bytes carries nothing.

expect_key: Option<String>

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

Optional, since a ceremony may be lifting material whose identity it learns only afterwards. Where it is known it is the only evidence available about material this ceremony did not itself produce.

label: String

Label for the imported key.

policy: Option<KeyPolicyParams>

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

Nothing travels with raw key material saying what it may do, so the ceremony declares it, exactly as at unwrap_key.

Trait Implementations

impl Clone for ImportKeyParams

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 ImportKeyParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImportKeyParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ImportKeyParams

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 ImportKeyParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.