Skip to main content

StatusListToken

Struct StatusListToken 

Source
#[non_exhaustive]
pub struct StatusListToken { pub sub: String, pub iat: i64, pub exp: Option<i64>, pub ttl: Option<u64>, pub status_list: StatusList, pub additional: IndexMap<String, Value>, }
Available on crate feature status-list only.
Expand description

The claims of a status list token in JWT format (Token Status List §5.1).

§Examples

use chrono::{TimeZone as _, Utc};
use identity_kit::status_list::{StatusListRef, StatusListToken, StatusType};
use identity_kit::vc::Jwt;
use identity_kit::vc::validation::TimeOptions;

// Token Status List §8.2.
let jwt: Jwt = "eyJhbGciOiJFUzI1NiIsImtpZCI6IjEyIiwidHlwIjoic3RhdHVzbGlzdCtqd3QifQ.e\
    yJleHAiOjIyOTE3MjAxNzAsImlhdCI6MTY4NjkyMDE3MCwiaXNzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbSIsInN0YXR1\
    c19saXN0Ijp7ImJpdHMiOjEsImxzdCI6ImVOcmJ1UmdBQWhjQlhRIn0sInN1YiI6Imh0dHBzOi8vZXhhbXBsZS5jb20\
    vc3RhdHVzbGlzdHMvMSIsInR0bCI6NDMyMDB9.2lKUUNG503R9htu4aHAYi7vjmr3sgApbfoDvPrl65N3URUO1EYqq\
    Ql45Jfzd-Av4QzlKa3oVALpLwOEUOq-U_g".parse()?;
let (header, token) = StatusListToken::decode(&jwt)?;
assert_eq!(header.kid.as_deref(), Some("12"));
assert_eq!(token.sub, "https://example.com/statuslists/1");
assert_eq!(token.ttl, Some(43200));

let now = TimeOptions::at(Utc.with_ymd_and_hms(2024, 1, 1, 0, 0, 0).unwrap());
let reference = StatusListRef::new("https://example.com/statuslists/1", 0);
assert_eq!(token.status_of(&reference, now)?, StatusType::INVALID);
assert_eq!(token.status_of(&StatusListRef::new(&reference.uri, 1), now)?, StatusType::VALID);
assert!(token.status_of(&StatusListRef::new(&reference.uri, 16), now).is_err());

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§sub: String

sub: the URI of the token, the uri referenced tokens use.

§iat: i64

iat: when the token was issued. A NumericDate with a fraction is floored.

§exp: Option<i64>

exp: when the token expires. A NumericDate with a fraction is floored.

§ttl: Option<u64>

ttl: how many seconds the token may be cached.

§status_list: StatusList

status_list: the list.

§additional: IndexMap<String, Value>

Every other claim, in insertion order.

Implementations§

Source§

impl StatusListToken

Source

pub const TYP: &'static str = "statuslist+jwt"

The typ of a status list token, statuslist+jwt.

Source

pub const MEDIA_TYPE: &'static str = "application/statuslist+jwt"

The media type of a status list token, application/statuslist+jwt.

Source

pub fn new( sub: impl Into<String>, iat: DateTime<Utc>, status_list: StatusList, ) -> Self

A token for the list at sub, issued at iat.

Source

pub fn with_expires_at(self, time: DateTime<Utc>) -> Self

This token with exp.

Source

pub fn with_ttl(self, seconds: u64) -> Self

This token with ttl.

Source

pub fn with_claim( self, name: impl Into<String>, value: impl Into<Value>, ) -> Self

This token with the claim name set to value.

Source

pub fn decode(jwt: &Jwt) -> Result<(JwsHeader, Self), StatusListError>

Decodes jwt without verifying it: the header, whose typ must be statuslist+jwt, and the claims.

§Errors

StatusListError::Jws, StatusListError::UnexpectedTyp or StatusListError::Payload.

Source

pub async fn sign(&self, signer: &dyn Signer) -> Result<Jwt, StatusListError>

Signs this token with signer, typ: statuslist+jwt and what names the signer’s key (JwsHeader::for_signer): its certificate chain in x5c, or else its kid.

§Errors

StatusListError::Jws when signing fails.

§Panics

Never: the token always serializes to JSON, and the JWS is one this function has just encoded.

Source

pub fn status_of( &self, reference: &StatusListRef, time: TimeOptions, ) -> Result<StatusType, StatusListError>

The status of the token reference points at (Token Status List §8.3, steps 4 to 6): sub must be the referenced URI, the token must not have been issued after time nor have expired at it, each with its leeway, and the index must be in range.

§Errors

StatusListError::SubjectMismatch, StatusListError::NotYetIssued, StatusListError::Expired or StatusListError::IndexOutOfRange.

Trait Implementations§

Source§

impl Clone for StatusListToken

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StatusListToken

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for StatusListToken

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for StatusListToken

Source§

impl PartialEq for StatusListToken

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for StatusListToken

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for StatusListToken

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more