Phauxth v2.0.0-alpha.5 Phauxth.AuthenticateToken View Source

Authenticates the user by verifying a Phauxth token.

You need to define a get_by(attrs) function in the user_context module you are using - see the documentation for Phauxth.Config for more information about the user_context.

Token authentication

This module looks for a token in the request headers. It then uses the token_module (which you need to set in the config) to check if it is valid. If it is valid, the get_by function in the user_context module is called, to get user information from the database.

If you want to store the token in a cookie, see the documentation for Phauxth.Authenticate.Token, which has an example of how you can create a custom module to verify tokens stored in cookies.

Options

There are two options:

  • :user_context - the users module to be used

    • the default is Phauxth.Config.user_context()
  • :log_meta - additional custom metadata for Phauxth.Log

    • this should be a keyword list

There are also options for signing / verifying the token. See the documentation for the Phauxth.Token module for details.

Examples

Add the following line to the pipeline you want to authenticate in the web/router.ex file:

plug Phauxth.AuthenticateToken

And if you are using a different users module:

plug Phauxth.AuthenticateToken, user_context: MyApp.Users

In the example above, you need to have the get_by/1 function defined in MyApp.Users.