Enum dcaf::common::cbor_values::ProofOfPossessionKey

pub enum ProofOfPossessionKey {
    PlainCoseKey(CoseKey),
    EncryptedCoseKey(CoseEncrypt0),
    KeyId(ByteString),
}

A proof-of-possession key as specified by RFC 8747, section 3.1.

Can either be a COSE key, an encrypted COSE key, or simply a key ID. As described in RFC 9201, PoP keys are used for the req_cnf parameter in AccessTokenRequest, as well as for the cnf and rs_cnf parameters in AccessTokenResponse.

Example

We showcase creation of an AccessTokenRequest in which we set req_cnf to a PoP key with an ID of 0xDCAF which the access token shall be bound to:

let key = ProofOfPossessionKey::KeyId(vec![0xDC, 0xAF]);
let request: AccessTokenRequest = AccessTokenRequest::builder().client_id("test_client").req_cnf(key).build()?;
assert_eq!(request.req_cnf.unwrap().key_id().to_vec(), vec![0xDC, 0xAF]);

Variants

PlainCoseKey(CoseKey)

An unencrypted CoseKey used to represent an asymmetric public key or (if the CWT it’s contained in is encrypted) a symmetric key.

For details, see section 3.2 of RFC 8747.

EncryptedCoseKey(CoseEncrypt0)

An encrypted CoseKey used to represent a symmetric key.

For details, see section 3.3 of RFC 8747.

KeyId(ByteString)

Key ID of the actual proof-of-possession key.

Note that as described in section 6 of RFC 8747, certain caveats apply when choosing to represent a proof-of-possession key by its Key ID.

For details, see section 3.4 of RFC 8747.

Implementations

impl ProofOfPossessionKey

pub fn key_id(&self) -> &ByteString

Returns the key ID of this PoP key, cloning it if necessary. Note that the returned key ID may be empty if no key ID was present in the key.

Example

let key = CoseKeyBuilder::new_symmetric_key(vec![0; 5]).key_id(vec![0xDC, 0xAF]).build();
let pop_key = ProofOfPossessionKey::from(key);
assert_eq!(pop_key.key_id().to_vec(), vec![0xDC, 0xAF]);

Trait Implementations

impl Clone for ProofOfPossessionKey

fn clone(&self) -> ProofOfPossessionKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProofOfPossessionKey

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<CoseEncrypt0> for ProofOfPossessionKey

fn from(enc: CoseEncrypt0) -> Self

Converts to this type from the input type.

impl From<CoseKey> for ProofOfPossessionKey

fn from(key: CoseKey) -> Self

Converts to this type from the input type.

impl From<ProofOfPossessionKey> for &'static str

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

Converts to this type from the input type.

impl From<Vec<u8, Global>> for ProofOfPossessionKey

fn from(kid: ByteString) -> Self

Converts to this type from the input type.

impl PartialEq<ProofOfPossessionKey> for ProofOfPossessionKey

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

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

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

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

impl ToCborMap for ProofOfPossessionKey

fn serialize_into<W>(self, writer: W) -> Result<(), Error<W::Error>>where Self: Sized, W: Write, W::Error: Debug,

Serializes this type as a CBOR map bytestring into the given writer.

fn deserialize_from<R>(reader: R) -> Result<Self, Error<R::Error>>where Self: Sized, R: Read, R::Error: Debug,

Deserializes from the given reader — which is expected to be an instance of this type, represented as a CBOR map bytestring — into an instance of this type.

fn to_ciborium_value(&self) -> Value

Converts this type to a CBOR serializable Value using to_cbor_map.

impl TryFrom<ProofOfPossessionKey> for ByteString

type Error = WrongSourceTypeError<ProofOfPossessionKey>

The type returned in the event of a conversion error.

fn try_from( value: ProofOfPossessionKey ) -> Result<Self, WrongSourceTypeError<ProofOfPossessionKey>>

Performs the conversion.

impl TryFrom<ProofOfPossessionKey> for CoseEncrypt0

type Error = WrongSourceTypeError<ProofOfPossessionKey>

The type returned in the event of a conversion error.

fn try_from( value: ProofOfPossessionKey ) -> Result<Self, WrongSourceTypeError<ProofOfPossessionKey>>

Performs the conversion.

impl TryFrom<ProofOfPossessionKey> for CoseKey

type Error = WrongSourceTypeError<ProofOfPossessionKey>

The type returned in the event of a conversion error.

fn try_from( value: ProofOfPossessionKey ) -> Result<Self, WrongSourceTypeError<ProofOfPossessionKey>>

Performs the conversion.

impl StructuralPartialEq for ProofOfPossessionKey