Module scheme

Source
Expand description

Catalyst RBAC Security Scheme definition Catalyst RBAC Security Scheme

Structsยง

AuthTokenAccessViolation
Token does not have required access rights
AuthTokenError
Error with the Authorization Token
CatalystRBACSecurityScheme
Catalyst RBAC Access Token

Constantsยง

AUTHORIZATION_HEADER ๐Ÿ”’
The header name that holds the authorization RBAC token
MAX_TOKEN_AGE ๐Ÿ”’
Time in the past the Token can be valid for.
MAX_TOKEN_SKEW ๐Ÿ”’
Time in the future the Token can be valid for.

Staticsยง

CACHE ๐Ÿ”’
Cached auth tokens

Functionsยง

checker_api_catalyst_auth ๐Ÿ”’
When added to an endpoint, this hook is called per request to verify the bearer token is valid. The performed validation is described here.
indexed_registrations ๐Ÿ”’
Returns a sorted list of all registrations for the given Catalyst ID from the database.
last_signing_key ๐Ÿ”’
Returns the last signing key from the registration chain.
registration ๐Ÿ”’
Returns a RBAC registration from the given block and slot.
registration_chain ๐Ÿ”’
Build a registration chain from the given indexed data.
service_unavailable ๐Ÿ”’
Returns a 503 error instance.

Type Aliasesยง

EncodedAuthToken
Auth token in the form of catv1..