Phauxth.Token behaviour (Phauxth v2.5.1) View Source
Behaviour for signing and verifying tokens.
If you are using Phauxth for token authentication, email confirmation or password resetting, you will need to define a module in your app that uses this behaviour (see the examples section below).
After you have created the token module, add the token_module
value to the phauxth config:
config phauxth, token_module: MyAppWeb.Auth.Token
Use the token module to sign the tokens, and then Phauxth will use this module to verify the tokens.
Examples
The following is an example token module using Phoenix tokens.
defmodule MyAppWeb.Auth.Token do
@behaviour Phauxth.Token
alias Phoenix.Token
alias MyAppWeb.Endpoint
@token_salt "JaKgaBf2"
@impl true
def sign(data, opts \ []) do
Token.sign(Endpoint, @token_salt, data, opts)
end
@impl true
def verify(token, opts \ []) do
Token.verify(Endpoint, @token_salt, token, opts)
end
end
Link to this section Summary
Link to this section Types
Specs
Specs
opts() :: keyword()
Link to this section Callbacks
Specs
Signs a token.
Specs
Verifies a token.