Struct TpmKey 

pub struct TpmKey {
    pub key_type: ObjectIdentifier,
    pub empty_auth: Option<bool>,
    pub policy: Option<Vec<TpmPolicy>>,
    pub secret: Option<OctetString>,
    pub auth_policy: Option<Vec<TpmAuthPolicy>>,
    pub description: Option<Utf8String>,
    pub rsa_parent: Option<bool>,
    pub parent: u32,
    pub pub_key: OctetString,
    pub priv_key: OctetString,
}

A TPM key struct that is directly compatible with ASN.1 DER encoding.

Fields

key_type: ObjectIdentifier

empty_auth: Option<bool>

policy: Option<Vec<TpmPolicy>>

secret: Option<OctetString>

auth_policy: Option<Vec<TpmAuthPolicy>>

description: Option<Utf8String>

rsa_parent: Option<bool>

parent: u32

pub_key: OctetString

priv_key: OctetString

Implementations

impl TpmKey

pub fn new( device: &mut Device, context: &mut ContextCache<'_>, auth_list: &[Auth], auth: &Auth, parent_handle: TpmHandle, template: &TpmKeyTemplate<'_>, ) -> Result<Self, KeyError>

Creates a new TpmKey by executing a TPM2_Create command.

Errors

Returns a KeyError if any of the TPM structures cannot be serialized or the command fails.

pub fn from_external_key( device: &mut Device, parent_handle: TpmHandle, external_key: &ExternalKey, rng: &mut (impl RngCore + CryptoRng), handles: &[u32], auth_list: &[Auth], context: &mut ContextCache<'_>, ) -> Result<Self, KeyError>

Imports an external key under a TPM parent, creating a new TpmKey.

Errors

Returns an error if the TPM import operation fails.

Remarks on symmetricAlg

In TPM2_Import the symmetricAlg parameter defines the cipher for the inner wrapper of the duplicate blob.

The key import process differences for ECC and RSA parents:

• ECC: the import uses ECDH with AES-CFB as the symmetric algorithm.
• RSA: the import uses RSA-OAEP to encrypt a seed, which passed in the inSymSeed command parameter, encryptionKey is zero-length vector and symmetricAlg must be set to TPM_ALG_NULL.

pub fn public(&self) -> Result<Tpm2bPublic, KeyError>

Parses and returns the public area of the key.

Errors

Returns a KeyError if the public key bytes cannot be parsed.

pub fn to_pem(&self) -> Result<String, KeyError>

Serialize TPM key to PEM.

Errors

Returns CliError if the key’s OID or other fields cannot be encoded to DER.

pub fn to_der(&self) -> Result<Vec<u8>, KeyError>

Serialize TPM key to DER bytes.

Errors

Returns CliError if the key’s OID or other fields cannot be encoded to DER.

pub fn from_pem(pem_bytes: &[u8]) -> Result<Self, KeyError>

Parse TPM key from PEM bytes.

Errors

Returns CliError if the PEM bytes cannot be parsed.

pub fn from_der(der_bytes: &[u8]) -> Result<Self, KeyError>

Parse TPM key from DER bytes.

Errors

Returns CliError if the DER bytes cannot be parsed into a valid TpmKeyAsn1 data.

Trait Implementations

impl AsnType for TpmKey

const TAG: Tag

The associated tag for the type.

const IDENTIFIER: Identifier

Identifier of an ASN.1 type as specified in the original specification if not identical with the identifier of Self

const TAG_TREE: TagTree = _

The root of this type’s tree of tag’s if it a CHOICE type, otherwise its Leaf that points Self::TAG.

const CONSTRAINTS: Constraints = Constraints::NONE

The set of constraints for values of the given type.

fn is_present(&self) -> bool

Whether the type is present with value. OPTIONAL fields are common in SEQUENCE or SET.

impl Clone for TpmKey

fn clone(&self) -> TpmKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Constructed<10> for TpmKey

const FIELDS: Fields<10usize>

Fields contained in the “root component list”.

const IS_EXTENSIBLE: bool = false

Whether the type is extensible.

const EXTENDED_FIELDS: Option<Fields<0usize>> = None

Fields contained in the list of extensions.

impl Debug for TpmKey

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

Formats the value using the given formatter.

impl Decode for TpmKey

fn decode_with_tag_and_constraints<D: Decoder>( decoder: &mut D, tag: Tag, constraints: Constraints, ) -> Result<Self, D::Error>

Decode this value implicitly tagged with tag from a given ASN.1 decoder with a set of constraints on what values of that type are allowed.

fn decode<D>(decoder: &mut D) -> Result<Self, <D as Decoder>::Error>

where D: Decoder,

Decode this value from a given ASN.1 decoder.

fn decode_with_tag<D>( decoder: &mut D, tag: Tag, ) -> Result<Self, <D as Decoder>::Error>

where D: Decoder,

Decode this value implicitly tagged with tag from a given ASN.1 decoder.

fn decode_with_constraints<D>( decoder: &mut D, constraints: Constraints, ) -> Result<Self, <D as Decoder>::Error>

where D: Decoder,

Decode this value from a given ASN.1 decoder with a set of constraints on what values of that type are allowed.

impl Encode for TpmKey

fn encode_with_tag_and_constraints<'encoder, EN: Encoder<'encoder>>( &self, encoder: &mut EN, tag: Tag, constraints: Constraints, identifier: Identifier, ) -> Result<(), EN::Error>

Encode this value with tag into the given crate::Encoder with the constraints the values this is allowed to encode into.

fn encode<'b, E>( &self, encoder: &mut E, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encodes self’s data into the given crate::Encoder.

fn encode_with_tag<'b, E>( &self, encoder: &mut E, tag: Tag, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value with tag into the given crate::Encoder.

fn encode_with_identifier<'b, E>( &self, encoder: &mut E, identifier: Identifier, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value with identifier into the given crate::Encoder.

fn encode_with_tag_and_identifier<'b, E>( &self, encoder: &mut E, tag: Tag, identifier: Identifier, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value with tag and identifier into the given crate::Encoder.

fn encode_with_constraints<'b, E>( &self, encoder: &mut E, constraints: Constraints, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value into the given crate::Encoder with the constraints the values this is allowed to encode into.

fn encode_with_constraints_and_identifier<'b, E>( &self, encoder: &mut E, constraints: Constraints, identifier: Identifier, ) -> Result<(), <E as Encoder<'b>>::Error>

where E: Encoder<'b>,

Encode this value into the given crate::Encoder with identifier and the constraints the values this is allowed to encode into.

impl PartialEq for TpmKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TpmKey

impl StructuralPartialEq for TpmKey