Struct dcaf::endpoints::creation_hint::AuthServerRequestCreationHint

pub struct AuthServerRequestCreationHint {
    pub auth_server: Option<String>,
    pub kid: Option<ByteString>,
    pub audience: Option<String>,
    pub scope: Option<Scope>,
    pub client_nonce: Option<Vec<u8>>,
}

This is sent by an RS as a response to an Unauthorized Resource Request Message to help the sender of the Unauthorized Resource Request Message acquire a valid access token.

For more information, see section 5.3 of RFC 9200.

Use the AuthServerRequestCreationHintBuilder (which you can access using the builder() method) to create an instance of this struct.

Example

Figure 3 of RFC 9200 gives us an example of a Request Creation Hint payload, given in CBOR diagnostic notation¹:

{
    "AS" : "coaps://as.example.com/token",
    "audience" : "coaps://rs.example.com"
    "scope" : "rTempC",
    "cnonce" : h'e0a156bb3f'
}

This could be built and serialized as an AuthServerRequestCreationHint like so:

// Scope could be built from TextEncodedScope too,
// which also offers to take a space-separated string.
let scope = Scope::try_from(vec!["rTempC"])?;
let hint: AuthServerRequestCreationHint = AuthServerRequestCreationHint::builder()
    .auth_server("coaps://as.example.com/token")
    .audience("coaps://rs.example.com")
    .scope(scope)
    .client_nonce(vec![0xe0, 0xa1, 0x56, 0xbb, 0x3f])
    .build()?;
let mut serialized = Vec::new();
hint.clone().serialize_into(&mut serialized)?;
assert_eq!(AuthServerRequestCreationHint::deserialize_from(serialized.as_slice())?, hint);

---

1. Note that abbreviations aren’t used here, so keep in mind that the labels are really integers instead of strings. ↩

Fields

auth_server: Option<String>

An absolute URI that identifies the appropriate AS for the RS.

kid: Option<ByteString>

The key identifier of a key used in an existing security association between the client and the RS.

audience: Option<String>

An identifier the client should request at the AS, as suggested by the RS.

scope: Option<Scope>

The suggested scope that the client should request towards the AS.

See the documentation of Scope for details.

client_nonce: Option<Vec<u8>>

A client nonce as described in section 5.3.1 of RFC 9200.

Implementations

impl AuthServerRequestCreationHint

pub fn builder() -> AuthServerRequestCreationHintBuilder

Returns a new builder for this struct.

Trait Implementations

impl Clone for AuthServerRequestCreationHint

fn clone(&self) -> AuthServerRequestCreationHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthServerRequestCreationHint

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

Formats the value using the given formatter.

impl Default for AuthServerRequestCreationHint

fn default() -> AuthServerRequestCreationHint

Returns the “default value” for a type.

impl Hash for AuthServerRequestCreationHint

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<AuthServerRequestCreationHint> for AuthServerRequestCreationHint

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

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 Eq for AuthServerRequestCreationHint

impl StructuralEq for AuthServerRequestCreationHint

impl StructuralPartialEq for AuthServerRequestCreationHint