Enum CryptographicKeyContext

pub enum CryptographicKeyContext {
    OpenPgp {
        user_ids: OpenPgpUserIdList,
        version: OpenPgpVersion,
    },
    Raw,
}

The cryptographic context in which a key is used

Each key can only be used in one cryptographic context. This is because the NetHSM offers only a single certificate slot per key, which can be used to attach certificates for a specific cryptographic use.

Variants

OpenPgp

A key is used in an OpenPGP context

Fields

user_ids: OpenPgpUserIdList

List of OpenPGP User IDs for the certificate.

version: OpenPgpVersion

OpenPGP version for the certificate.

Raw

A key is used in a raw cryptographic context

Implementations

impl CryptographicKeyContext

pub fn validate_signing_key_setup( &self, key_type: KeyType, key_mechanisms: &[KeyMechanism], signature_type: SignatureType, ) -> Result<(), Error>

Validates the cryptographic context against a signing key setup

Errors

Returns an Error::Key if the key setup can not be used for signing operations in the respective cryptographic context.

Examples

use nethsm::{
    CryptographicKeyContext,
    KeyMechanism,
    KeyType,
    OpenPgpUserIdList,
    OpenPgpVersion,
    SignatureType,
};

CryptographicKeyContext::Raw.validate_signing_key_setup(
    KeyType::Curve25519,
    &[KeyMechanism::EdDsaSignature],
    SignatureType::EdDsa,
)?;

CryptographicKeyContext::OpenPgp {
    user_ids: OpenPgpUserIdList::new(vec!["Foobar McFooface <foobar@mcfooface.org>".parse()?])?,
    version: OpenPgpVersion::V4,
}
.validate_signing_key_setup(
    KeyType::Curve25519,
    &[KeyMechanism::EdDsaSignature],
    SignatureType::EdDsa,
)?;

// OpenPGP does not support ECDSA P224
assert!(
    CryptographicKeyContext::OpenPgp {
        user_ids: OpenPgpUserIdList::new(vec![
            "Foobar McFooface <foobar@mcfooface.org>".parse()?
        ])?,
        version: OpenPgpVersion::V4,
    }
    .validate_signing_key_setup(
        KeyType::EcP224,
        &[KeyMechanism::EcdsaSignature],
        SignatureType::EcdsaP224,
    )
    .is_err()
);

Trait Implementations

impl Clone for CryptographicKeyContext

fn clone(&self) -> CryptographicKeyContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CryptographicKeyContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CryptographicKeyContext

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CryptographicKeyContext

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

Formats the value using the given formatter.

impl Hash for CryptographicKeyContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CryptographicKeyContext

fn eq(&self, other: &CryptographicKeyContext) -> 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 Serialize for CryptographicKeyContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SignedPublicKey> for CryptographicKeyContext

fn try_from(value: SignedPublicKey) -> Result<Self, Self::Error>

Creates a CryptographicKeyContext from [SignedPublicKey].

Drops any invalid OpenPGP User ID (e.g. non-UTF-8).

Errors

Returns an error if

• duplicate OpenPGP User IDs are encountered in value,
• or no valid OpenPGP version can be derived from the OpenPGP primary key in value.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for CryptographicKeyContext

impl StructuralPartialEq for CryptographicKeyContext