BtrzAuth v0.5.0 BtrzAuth.Guardian View Source
Link to this section Summary
Functions
An optional callback invoked after the token has been generated and signed
An optional callback invoked after sign in has been called
An optional callback invoked before sign out has happened
An optional callback that allows the claims to be modified while they’re being built. This is useful to hook into the encoding lifecycle
Fetches the configuration for this module
Returns a resolved value of the configuration found at a key
Decodes and verifies a token using the configuration on the implementation module
The default type of token for this module
Encodes the claims.
See Guardian.encode_and_sign
for more information
Exchanges a token of one type for another
An optional callback invoked when a token is exchanged
An optional callback invoked when a token is refreshed
An optional callback invoked when a token is revoked
An optional callback invoked after the claims have been validated
Provides the content of the token but without verification of either the claims or the signature
Refresh a token
Fetches the resource that is represented by claims
Fetch the resource and claims directly from a token
Revoke a token
Fetches the subject for a token for the provided resource and claims The subject should be a short identifier that can be used to identify the resource
An optional callback to add custom verification to claims when decoding a token
Link to this section Functions
An optional callback invoked after the token has been generated and signed.
Callback implementation for Guardian.after_encode_and_sign/4
.
An optional callback invoked after sign in has been called
By returning an error the sign in will be halted
- Note that if you return an error, a token still may have been generated
Callback implementation for Guardian.after_sign_in/5
.
An optional callback invoked before sign out has happened
Callback implementation for Guardian.before_sign_out/3
.
An optional callback that allows the claims to be modified while they’re being built. This is useful to hook into the encoding lifecycle
Callback implementation for Guardian.build_claims/3
.
Fetches the configuration for this module
Returns a resolved value of the configuration found at a key
See Guardian.Config.resolve_value
decode_and_verify( Guardian.Token.token(), Guardian.Token.claims(), Guardian.options() ) :: {:ok, Guardian.Token.claims()} | {:error, any()}
Decodes and verifies a token using the configuration on the implementation module.
See Guardian.decode_and_verify
The default type of token for this module
encode_and_sign(any(), Guardian.Token.claims(), Guardian.options()) :: {:ok, Guardian.Token.token(), Guardian.Token.claims()} | {:error, any()}
Encodes the claims.
See Guardian.encode_and_sign
for more information
exchange( token :: Guardian.Token.token(), from_type :: String.t() | [String.t(), ...], to_type :: String.t(), options :: Guardian.options() ) :: {:ok, {Guardian.Token.token(), Guardian.Token.claims()}, {Guardian.Token.token(), Guardian.Token.claims()}} | {:error, any()}
Exchanges a token of one type for another.
See Guardian.exchange
for more information
An optional callback invoked when a token is exchanged
Callback implementation for Guardian.on_exchange/3
.
An optional callback invoked when a token is refreshed
Callback implementation for Guardian.on_refresh/3
.
An optional callback invoked when a token is revoked
Callback implementation for Guardian.on_revoke/3
.
An optional callback invoked after the claims have been validated
Callback implementation for Guardian.on_verify/3
.
Provides the content of the token but without verification of either the claims or the signature
Claims will be present at the :claims
key.
See Guardian.peek
for more information
refresh(Guardian.Token.token(), Guardian.options()) :: {:ok, {Guardian.Token.token(), Guardian.Token.claims()}, {Guardian.Token.token(), Guardian.Token.claims()}} | {:error, any()}
Refresh a token.
See Guardian.refresh
for more information
Fetches the resource that is represented by claims.
For JWT this would normally be found in the sub
field
Callback implementation for Guardian.resource_from_claims/1
.
resource_from_token( token :: Guardian.Token.token(), claims_to_check :: Guardian.Token.claims() | nil, opts :: Guardian.options() ) :: {:ok, Guardian.Token.resource(), Guardian.Token.claims()}
Fetch the resource and claims directly from a token
See Guardian.resource_from_token
for more information
revoke(Guardian.Token.token(), Guardian.options()) :: {:ok, Guardian.Token.claims()} | {:error, any()}
Revoke a token.
See Guardian.revoke
for more information
Fetches the subject for a token for the provided resource and claims The subject should be a short identifier that can be used to identify the resource
Callback implementation for Guardian.subject_for_token/2
.
An optional callback to add custom verification to claims when decoding a token
Returning {:ok, claims} will allow the decoding to continue Returning {:error, reason} will stop the decoding and return the error
Callback implementation for Guardian.verify_claims/2
.