Struct Claims

pub struct Claims<T> {
    pub expires: Option<u64>,
    pub id: String,
    pub issued_at: u64,
    pub issuer: String,
    pub subject: String,
    pub not_before: Option<u64>,
    pub metadata: Option<T>,
    /* private fields */
}

Represents a set of RFC 7519 compliant JSON Web Token claims.

Fields

expires: Option<u64>

All timestamps in JWTs are stored in seconds since the epoch format as described as NumericDate in the RFC. Corresponds to the exp field in a JWT.

id: String

Corresponds to the jti field in a JWT.

issued_at: u64

The iat field, stored in seconds since the epoch

issuer: String

Issuer of the token, by convention usually the public key of the account that signed the token

subject: String

Subject of the token, usually the public key of the module corresponding to the WebAssembly file being signed

not_before: Option<u64>

The nbf JWT field, indicates the time when the token becomes valid. If None token is valid immediately

metadata: Option<T>

Custom jwt claims in the wascap namespace

Implementations

impl<T> Claims<T>

where T: Serialize + DeserializeOwned + WascapEntity,

pub fn encode(&self, kp: &KeyPair) -> Result<String>

pub fn decode(input: &str) -> Result<Claims<T>>

pub fn name(&self) -> String

impl Claims<Account>

pub fn new( name: String, issuer: String, subject: String, additional_keys: Vec<String>, ) -> Claims<Account>

Creates a new non-expiring Claims wrapper for metadata representing an account

pub fn with_dates( name: String, issuer: String, subject: String, not_before: Option<u64>, expires: Option<u64>, additional_keys: Vec<String>, ) -> Claims<Account>

Creates a new Claims wrapper for metadata representing an account, with optional valid before and expiration dates

impl Claims<CapabilityProvider>

pub fn new( name: String, issuer: String, subject: String, vendor: String, rev: Option<i32>, ver: Option<String>, hashes: HashMap<String, String>, ) -> Claims<CapabilityProvider>

Creates a new non-expiring Claims wrapper for metadata representing a capability provider

pub fn with_provider( issuer: String, subject: String, not_before: Option<u64>, expires: Option<u64>, provider: CapabilityProvider, ) -> Claims<CapabilityProvider>

Creates a new Claims non-expiring wrapper for metadata representing a capability provider, with optional valid before and expiration dates

pub fn with_dates( name: String, issuer: String, subject: String, vendor: String, rev: Option<i32>, ver: Option<String>, hashes: HashMap<String, String>, not_before: Option<u64>, expires: Option<u64>, ) -> Claims<CapabilityProvider>

Creates a new Claims wrapper for metadata representing a capability provider, with optional valid before and expiration dates

impl Claims<Operator>

pub fn new( name: String, issuer: String, subject: String, additional_keys: Vec<String>, ) -> Claims<Operator>

Creates a new non-expiring Claims wrapper for metadata representing an operator

pub fn with_dates( name: String, issuer: String, subject: String, not_before: Option<u64>, expires: Option<u64>, additional_keys: Vec<String>, ) -> Claims<Operator>

Creates a new Claims wrapper for metadata representing an operator, with optional valid before and expiration dates

impl Claims<Cluster>

pub fn new( name: String, issuer: String, subject: String, additional_keys: Vec<String>, ) -> Claims<Cluster>

Creates a new non-expiring Claims wrapper for metadata representing a cluster

pub fn with_dates( name: String, issuer: String, subject: String, not_before: Option<u64>, expires: Option<u64>, additional_keys: Vec<String>, ) -> Claims<Cluster>

Creates a new Claims wrapper for metadata representing a cluster, with optional valid before and expiration dates

impl Claims<Component>

pub fn new( name: String, issuer: String, subject: String, tags: Option<Vec<String>>, provider: bool, rev: Option<i32>, ver: Option<String>, call_alias: Option<String>, ) -> Self

Creates a new non-expiring Claims wrapper for metadata representing an component

pub fn with_dates( name: String, issuer: String, subject: String, tags: Option<Vec<String>>, not_before: Option<u64>, expires: Option<u64>, provider: bool, rev: Option<i32>, ver: Option<String>, call_alias: Option<String>, ) -> Claims<Component>

Creates a new Claims wrapper for metadata representing an component, with optional valid before and expiration dates

impl Claims<Invocation>

pub fn new( issuer: String, subject: String, target_url: &str, origin_url: &str, hash: &str, ) -> Claims<Invocation>

Creates a new non-expiring Claims wrapper for metadata representing an invocation

pub fn with_dates( issuer: String, subject: String, not_before: Option<u64>, expires: Option<u64>, target_url: &str, origin_url: &str, hash: &str, ) -> Claims<Invocation>

Creates a new Claims wrapper for metadata representing an invocation, with optional valid before and expiration dates

impl Claims<Host>

pub fn new( name: String, issuer: String, subject: String, tags: Option<HashMap<String, String>>, ) -> Self

Creates a new non-expiring Claims wrapper for metadata representing a host

pub fn with_dates( name: String, issuer: String, subject: String, not_before: Option<u64>, expires: Option<u64>, tags: Option<HashMap<String, String>>, ) -> Claims<Host>

Trait Implementations

impl<T: Clone> Clone for Claims<T>

fn clone(&self) -> Claims<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Claims<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Claims<T>

fn default() -> Claims<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Claims<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Claims<T>

fn eq(&self, other: &Claims<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for Claims<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for Claims<T>