Struct CatalystRBACTokenV1

pub(crate) struct CatalystRBACTokenV1 {
    catalyst_id: CatalystId,
    network: Network,
    signature: Signature,
    raw: Vec<u8>,
    reg_chain: Option<RegistrationChain>,
}

A Catalyst RBAC Authorization Token.

See this document for more details.

Fields

catalyst_id: CatalystId

A Catalyst identifier.

network: Network

A network value.

The network value is contained in the Catalyst ID and can be accessed from it, but it is a string, so we convert it to this enum during the validation.

signature: Signature

Ed25519 Signature of the Token

raw: Vec<u8>

Raw bytes of the token without the signature.

reg_chain: Option<RegistrationChain>

A corresponded RBAC chain, constructed from the most recent data from the database. Lazy initialized

Implementations

impl CatalystRBACTokenV1

const AUTH_TOKEN_PREFIX: &str = "catid."

Bearer Token prefix for this token.

pub(crate) fn new( network: &str, subnet: Option<&str>, role0_pk: VerifyingKey, sk: &SigningKey, ) -> Result<Self>

Creates a new token instance.

pub(crate) fn parse(token: &str) -> Result<CatalystRBACTokenV1>

Parses a token from the given string.

The token consists of the following parts:

• “catid” prefix.
• Nonce.
• Network.
• Role 0 public key.
• Signature.

For example:

catid.:173710179@preprod.cardano/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE.<signature>

pub(crate) fn verify(&self, public_key: &VerifyingKey) -> Result<()>

Given the PublicKey, verifies the token was correctly signed.

pub(crate) fn is_young(&self, max_age: Duration, max_skew: Duration) -> bool

Checks that the token timestamp is valid.

The timestamp is valid if it isn’t too old or too skewed.

pub(crate) fn catalyst_id(&self) -> &CatalystId

Returns a Catalyst ID from the token.

pub(crate) fn network(&self) -> Network

Returns a network.

pub(crate) async fn reg_chain(&mut self) -> Result<Option<RegistrationChain>>

Returns a corresponded registration chain if any registrations present. If it is a first call, fetch all data from the database and initialize it.

Trait Implementations

impl Clone for CatalystRBACTokenV1

fn clone(&self) -> CatalystRBACTokenV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CatalystRBACTokenV1

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

Formats the value using the given formatter.

impl Display for CatalystRBACTokenV1

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

Formats the value using the given formatter.

impl From<CatalystRBACSecurityScheme> for CatalystRBACTokenV1

fn from(value: CatalystRBACSecurityScheme) -> Self

Converts to this type from the input type.