Enum Capability 

pub enum Capability {
    ChangeAuthenticationKey,
    CreateOtpAead,
    DecryptCbc,
    DecryptEcb,
    DecryptOaep,
    DecryptOtp,
    DecryptPkcs,
    DeleteAsymmetricKey,
    DeleteAuthenticationKey,
    DeleteHmacKey,
    DeleteOpaque,
    DeleteOtpAeadKey,
    DeletePublicWrapKey,
    DeleteSymmetricKey,
    DeleteTemplate,
    DeleteWrapKey,
    DeriveEcdh,
    EncryptCbc,
    EncryptEcb,
    ExportableUnderWrap,
    ExportWrapped,
    GenerateAsymmetricKey,
    GenerateHmacKey,
    GenerateOtpAeadKey,
    GenerateSymmetricKey,
    GenerateWrapKey,
    GetLogEntries,
    GetOpaque,
    GetOption,
    GetPseudoRandom,
    GetTemplate,
    ImportWrapped,
    PutAsymmetricKey,
    PutAuthenticationKey,
    PutHmacKey,
    PutOpaque,
    PutOtpAeadKey,
    PutPublicWrapKey,
    PutSymmetricKey,
    PutTemplate,
    PutWrapKey,
    RandomizeOtpAead,
    ResetDevice,
    RewrapFromOtpAeadKey,
    RewrapToOtpAeadKey,
    SetOption,
    SignAttestationCertificate,
    SignEcdsa,
    SignEddsa,
    SignHmac,
    SignPkcs,
    SignPss,
    SignSshCertificate,
    UnwrapData,
    VerifyHmac,
    WrapData,
}

A capability of an object stored on a YubiHSM2.

Variants

ChangeAuthenticationKey

Replace authentication key objects.

Applicable for authentication key objects.

CreateOtpAead

Create OTP AEAD.

Applicable for authentication and OTP AEAD key objects.

DecryptCbc

Decrypt data using AES CBC mode.

Applicable for authentication and symmetric key objects.

DecryptEcb

Decrypt data using AES ECB mode.

Applicable for authentication and symmetric key objects.

DecryptOaep

Decrypt data using RSA-OAEP.

Applicable for authentication and asymmetric key objects.

DecryptOtp

Decrypt OTP.

Applicable for authentication and OTP AEAD key objects.

DecryptPkcs

Decrypt data using RSA-PKCS1v1.5.

Applicable for authentication and asymmetric key objects.

DeleteAsymmetricKey

Delete asymmetric key objects.

Applicable for authentication key objects.

DeleteAuthenticationKey

Delete authentication key objects.

Applicable for authentication key objects.

DeleteHmacKey

Delete HMAC key objects.

Applicable for authentication key objects.

DeleteOpaque

Delete opaque objects.

Applicable for authentication key objects.

DeleteOtpAeadKey

Delete OTP AEAD key objects.

Applicable for authentication key objects.

DeletePublicWrapKey

Delete RSA public wrap key.

Applicable for authentication and wrap key objects.

DeleteSymmetricKey

Delete AES key.

Applicable for authentication key objects.

DeleteTemplate

Delete template objects.

Applicable for authentication key objects.

DeleteWrapKey

Delete wrap key objects.

Applicable for authentication key objects.

DeriveEcdh

Perform ECDH.

Applicable for authentication and asymmetric key objects.

EncryptCbc

Encrypt data using AES CBC mode.

Applicable for authentication and symmetric key objects.

EncryptEcb

Encrypt data using AES ECB mode.

Applicable for authentication and symmetric key objects.

ExportableUnderWrap

The object can be exported under wrap (encrypted).

Applicable for all objects.

ExportWrapped

Export other objects under wrap.

Applicable for authentication and wrap key objects.

Note

Both the authentication key used for export and the wrapping key need to be capable of export.

GenerateAsymmetricKey

Generate asymmetric key objects.

Applicable for authentication key objects.

GenerateHmacKey

Generate HMAC key objects.

Applicable for authentication key objects.

GenerateOtpAeadKey

Generate OTP AEAD key objects.

Applicable for authentication key objects.

GenerateSymmetricKey

Generate AES key.

Applicable for authentication key objects.

GenerateWrapKey

Generate wrap key objects.

Applicable for authentication key objects.

GetLogEntries

Read the log store.

Applicable for authentication key objects.

GetOpaque

Read opaque objects.

Applicable for authentication key objects.

GetOption

Read device-global options.

Applicable for authentication key objects.

GetPseudoRandom

Extract random bytes.

Applicable for authentication key objects.

GetTemplate

Read template objects.

Applicable for authentication key objects.

ImportWrapped

Import wrapped objects.

Applicable for authentication and wrap key objects.

Note

Both the authentication key used for import and the wrapping key need to be capable of import.

PutAsymmetricKey

Write asymmetric key objects.

Applicable for authentication key objects.

PutAuthenticationKey

Write authentications key objects.

Applicable for authentication key objects.

PutHmacKey

Write HMAC key objects.

Applicable for authentication key objects.

PutOpaque

Write opaque objects.

Applicable for authentication key objects.

PutOtpAeadKey

Write OTP AEAD key objects.

Applicable for authentication key objects.

PutPublicWrapKey

Write RSA public wrap key.

Applicable for authentication and wrap key objects.

PutSymmetricKey

Import AES key.

Applicable for authentication key objects.

PutTemplate

Write template objects.

Applicable for authentication key objects.

PutWrapKey

Write wrap key objects.

Applicable for authentication key objects.

RandomizeOtpAead

Create OTP AEAD from random data.

Applicable for authentication and OTP AEAD key objects.

ResetDevice

Perform a factory reset on the device.

Applicable for authentication key objects.

RewrapFromOtpAeadKey

Rewrap AEADs from one OTP AEAD key to another.

Applicable for authentication and OTP AEAD key objects.

RewrapToOtpAeadKey

Rewrap AEADs to one OTP AEAD key from another.

Applicable for authentication and OTP AEAD key objects.

SetOption

Write device-global options.

Applicable for authentication key objects.

SignAttestationCertificate

Attest properties of asymmetric key objects.

Applicable for authentication and asymmetric key objects.

SignEcdsa

Compute digital signatures using ECDSA.

Applicable for authentication and asymmetric key objects.

SignEddsa

Compute digital signatures using EdDSA.

Applicable for authentication and asymmetric key objects.

SignHmac

Compute HMAC of data.

Applicable for authentication and HMAC key objects.

SignPkcs

Compute digital signatures using RSA-PKCS1v1.5.

Applicable for authentication and asymmetric key objects.

SignPss

Compute digital signatures using RSA-PSS.

Applicable for authentication and asymmetric key objects.

SignSshCertificate

Sign SSH certificates.

Applicable for authentication and asymmetric key objects.

UnwrapData

Unwrap user-provided data.

Applicable for authentication and wrap key objects.

VerifyHmac

Verify HMAC of data.

Applicable for authentication and HMAC key objects.

WrapData

Wrap user-provided data.

Applicable for authentication and wrap key objects.

Trait Implementations

impl AsRef<str> for Capability

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Capability

fn clone(&self) -> Capability

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capability

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Capability

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Capability

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

Formats the value using the given formatter.

impl<'_derivative_strum> From<&'_derivative_strum Capability> for &'static str

fn from(x: &'_derivative_strum Capability) -> &'static str

Converts to this type from the input type.

impl From<&Capability> for Capability

fn from(value: &Capability) -> Self

Converts to this type from the input type.

impl From<Capability> for &'static str

fn from(x: Capability) -> &'static str

Converts to this type from the input type.

impl FromStr for Capability

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Capability, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Capability

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 IntoEnumIterator for Capability

type Iterator = CapabilityIter

fn iter() -> CapabilityIter

impl Ord for Capability

fn cmp(&self, other: &Capability) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Capability

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

fn partial_cmp(&self, other: &Capability) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Capability

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Capability

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Capability, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl ValueEnum for Capability

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Copy for Capability

impl Eq for Capability

impl StructuralPartialEq for Capability