Struct fxa_client::ScopedKey

pub struct ScopedKey {
    pub kty: String,
    pub scope: String,
    pub k: String,
    pub kid: String,
}

A cryptograpic key associated with an OAuth scope.

Some OAuth scopes have a corresponding client-side encryption key that is required in order to access protected data. This struct represents such key material in a format compatible with the common “JWK” standard.

Fields

kty: String

The type of key.

In practice for FxA, this will always be string string “oct” (short for “octal”) to represent a raw symmetric key.

scope: String

The OAuth scope with which this key is associated.

k: String

The key material, as base64-url-encoded bytes.

⚠️ Warning: the value of this field should never be revealed outside of the application. For example, it should never to sent to a server or logged in a log file.

kid: String

An opaque unique identifier for this key.

Unlike the k field, this value is not secret and may be revealed to the server.

Implementations

impl ScopedKey

pub fn key_bytes(&self) -> Result<Vec<u8>>

Trait Implementations

impl Clone for ScopedKey

fn clone(&self) -> ScopedKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScopedKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScopedKey

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

Deserialize this value from the given Serde deserializer.

impl Serialize for ScopedKey

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

Serialize this value into the given Serde serializer.