Phauxth v1.2.0 Phauxth.Confirm View Source

Module to provide user confirmation for new users and when resetting passwords.

See the documentation for the verify function for details.

Link to this section Summary

Functions

Verify the confirmation key and get the user data from the database

Link to this section Functions

Link to this function get_user(key_source, arg) View Source
Link to this function verify(params, user_context, opts \\ []) View Source

Verify the confirmation key and get the user data from the database.

This can be used to confirm an email for new users and also for password resetting.

Options

There are four options for the verify function:

  • endpoint - the name of the endpoint of your app

    • this can also be set in the config
  • max_age - the maximum age of the token, in seconds

    • the default is 1200 seconds (20 minutes)
  • mode - the mode - email confirmation or password resetting

    • set this to :pass_reset to use this function for password resetting
  • log_meta - additional custom metadata for Phauxth.Log

    • this should be a keyword list

In addition, there are also options for generating the token. See the documentation for the Phauxth.Token module for details.

Examples

The following function is an example of using verify in a Phoenix controller.

def index(conn, params) do
  case Phauxth.Confirm.verify(params, Accounts) do
    {:ok, user} ->
      Accounts.confirm_user(user)
      message = "Your account has been confirmed"
      Accounts.Message.confirm_success(user.email)
      handle_success() # redirect or send json
    {:error, message} ->
      handle_error()
  end
end

In this example, the Accounts.confirm_user function updates the database, setting the confirmed_at value to the current time.

Password resetting

For password resetting, use the mode: :pass_reset option, as in the following example:

def update(conn, %{"password_reset" => params}) do
  case Phauxth.Confirm.verify(params, Accounts, mode: :pass_reset) do
    {:ok, user} ->
      Accounts.update_password(user, params)
      |> handle_password_reset(conn, params)
    {:error, message} ->
      handle_error()
  end
end

The Accounts.update_password function tries to add the new password to the database. If the password reset is successful, the handle_password_reset function sends a message (email or phone) to the user and redirects the user to the next page or sends a json response. If unsuccessful, the handle_password_reset function handles the error.