Packages
phauxth
0.12.0-rc
2.5.1
retired
2.5.0
2.4.0
2.3.2
2.3.1
2.3.0
2.2.0
2.1.1
2.1.0
2.0.1
2.0.0
2.0.0-rc.2
2.0.0-rc.1
2.0.0-rc.0
2.0.0-beta.1
2.0.0-beta.0
2.0.0-alpha.5
2.0.0-alpha.4
retired
2.0.0-alpha.3
retired
2.0.0-alpha.2
retired
2.0.0-alpha.1
retired
2.0.0-alpha.0
retired
1.2.9
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.1
1.2.0
1.1.3
1.1.2
1.1.1
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
0.17.1
0.17.0
0.16.0
0.15.1
0.15.0
0.14.0
0.13.0-rc.1
0.13.0-rc.0
0.12.1-rc.1
0.12.1-rc.0
0.12.0-rc
0.11.0
0.10.3
0.10.2
0.10.0
0.9.0
0.8.2
0.8.1
0.8.0
Authentication library for Phoenix, and other Plug-based, web applications
Current section
Files
Jump to
Current section
Files
lib/phauxth/login.ex
defmodule Phauxth.Login do
@moduledoc """
Module to handle login.
`Phauxth.Login.verify/2` checks the user's password, and returns
{:ok, user} if login is successful or {:error, message} if there
is an error.
If login is successful, you need to either add the user to the
session, by running `put_session(conn, :user_id, id)`, or send
an API token to the user.
If you are using two-factor authentication, you need to first check
the user schema for `otp_required: true` and, if necessary, redirect
the user to the one-time password input page.
## Options
There is one option:
* identifier - the name which is used to identify the user (in the database)
* this should be an atom, and the default is `:email`
## Examples
In the example below, Phauxth.Login.verify is called within the create
function in the session controller.
def create(conn, %{"session" => params}) do
case Phauxth.Login.verify(params, MyApp.Accounts) do
{:ok, user} -> handle_successful_login
{:error, message} -> handle_error
end
end
"""
use Phauxth.Login.Base
end