Enum yubirs::piv::id::Key

pub enum Key {
    Authentication,
    CardManagement,
    Signature,
    KeyManagement,
    CardAuthentication,
    Retired1,
    Retired2,
    Retired3,
    Retired4,
    Retired5,
    Retired6,
    Retired7,
    Retired8,
    Retired9,
    Retired10,
    Retired11,
    Retired12,
    Retired13,
    Retired14,
    Retired15,
    Retired16,
    Retired17,
    Retired18,
    Retired19,
    Retired20,
    Attestation,
}

This enumeration describes the identifiers for the various slots the Yubikey has for certificates.

Variants

Authentication

Used to authenticate the card and the cardholder. Used for things like system login. The PIN is required to perform any private key operations.

CardManagement

The card management key, used to authenticate administrative / management functionality on the Yubikey itself.

Signature

Used for digital dignatures for the purpose of document signing, or signing files and executables. The PIN is required to perform any private key operations.

KeyManagement

Used for encryption for confidentiality, e.g. encrypting e-mails or files. The PIN is required to perform any private key operations.

CardAuthentication

Used to support additional physical access applications, such as providing physical access to buildings via PIV-enabled door locks. The PIN is NOT required to perform private key operations.

Retired1

Retired2

Retired3

Retired4

Retired5

Retired6

Retired7

Retired8

Retired9

Retired10

Retired11

Retired12

Retired13

Retired14

Retired15

Retired16

Retired17

Retired18

Retired19

Retired20

Attestation

This slot is only available on Yubikey 4.3 and newer. It is used for attestation of other keys generated on device. This slot is not cleared on reset, but can be overwritten.

Methods

impl Key

pub fn to_value(&self) -> c_uchar

pub fn to_object(&self) -> Result<Object>

Each key is stored as a data object on the Yubikey. So, to retrieve a stored key, we need the Object ID associated with it (which this function returns).

Note that, for some Keys, there is no associated Object. In this case, an error will be returned instead.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl FromStr for Key

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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

impl Hash for Key

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Key

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Key

impl StructuralPartialEq for Key