Phauxth v2.0.0-beta.1 Phauxth.Token behaviour 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.

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

  @max_age 14_400
  @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 ++ [max_age: @max_age])
  end
end

Link to this section Summary

Callbacks

Signs a token

Verifies a token

Link to this section Types

Link to this section Callbacks

Link to this callback sign(data, opts) View Source
sign(data(), opts()) :: binary()

Signs a token.

Link to this callback verify(binary, opts) View Source
verify(binary(), opts()) :: {:ok, map()} | {:error, atom() | binary()}

Verifies a token.