Repository navigation
Authentication
Laravex ships a session-based authentication guard that mirrors Laravel's Auth facade. The implementation lives in Laravex.Auth.Guard and leans on Laravex.Session.Store for persistence.
Out of the box Laravex provides:
- A session guard (
Laravex.Auth.Guard) that authenticates users vialogin_websession key - Remember-me cookies for persistent login across browser restarts
-
authandguestmiddleware aliases wired up in the middleware kernel - Bearer-token support delegated to API-Tokens
The user model is resolved from config/auth.exs:
# config/auth.exs
%{
"defaults" => %{"guard" => "web", "passwords" => "users"},
"providers" => %{
"users" => %{"driver" => "eloquex", "model" => "App.Models.User"}
}
}# In a controller action — request is always passed in
user = Laravex.Auth.Guard.user(request) # returns the struct or nil
id = Laravex.Auth.Guard.id(request) # shortcut to user.id
auth = Laravex.Auth.Guard.check?(request) # boolean
Guard.user/1first checks the process dictionary for anacting_asoverride (useful in tests), then looks uplogin_webin the session, and finally falls back to the remember-me cookie.
Guard.attempt/2 takes a credentials map and the current request struct:
credentials = %{
"email" => request.params["email"],
"password" => request.params["password"],
"remember" => request.params["remember"] # any truthy value enables remember-me
}
case Laravex.Auth.Guard.attempt(credentials, request) do
{:ok, user, request} ->
# session regenerated, user stored
{:redirect, "/dashboard"}
{:error, :invalid} ->
{:render, "auth/login", %{error: "These credentials do not match our records."}}
endInternally, attempt/2:
- Looks up the user by email via
model.find_by_email/1 - Verifies the password using Hashing (
Laravex.Hashing.Hash.check/2) - Rehashes the stored password if
needs_rehash?/1is true (seamless upgrade) - Regenerates the session ID
- Writes
login_web→user.idinto the session - Optionally issues a remember-me cookie
If you already have a user struct (e.g., after OAuth or email verification), call Guard.login/2:
request = Laravex.Auth.Guard.login(user, request)
# Or with remember-me:
request = Laravex.Auth.Guard.login(user, request, remember: true)# Log in by primary key (fetches the model automatically)
{:ok, user, request} = Laravex.Auth.Guard.login_using_id(42, request)
{:ok, user, request} = Laravex.Auth.Guard.login_using_id(42, request, remember: true)
# Returns {:error, :invalid} if no user with that ID existsLog a user in for the current request only without touching the session or cookies (useful in tests and single-request contexts):
request = Laravex.Auth.Guard.once(user, request)case Laravex.Auth.Guard.validate_credentials(%{"email" => email, "password" => password}) do
{:ok, user} -> # credentials are valid
:error -> # invalid
end
# Returns true when NO user is authenticated (inverse of check?)
Laravex.Auth.Guard.guest?(request)request = Laravex.Auth.Guard.logout(request)logout/1 clears login_web from the session, regenerates the session ID, nullifies the user's remember_token in the database, and expires the remember-me cookie.
When remember: true is passed to attempt/2 or login/3:
- A 60-character random token is generated and stored in
user.remember_token - The cookie
remember_webis set with a one-year lifetime (HTTP-only) - On the next request,
Guard.user/1decodesid|tokenfrom the cookie and re-hydrates the user
The cookie value is Base64-encoded "<user_id>|<token>".
The auth and guest middleware aliases are pre-registered in Laravex.Http.Middleware:
# routes/web.ex
Router.group([middleware: ["auth"]], fn ->
Router.get("/dashboard", &App.Http.Controllers.DashboardController.index/1)
end)
# Guest-only (redirects authenticated users away)
Router.group([middleware: ["guest"]], fn ->
Router.get("/login", &App.Http.Controllers.AuthController.show_login/1)
end)| Alias | Module | Behaviour |
|---|---|---|
auth |
Laravex.Http.Middleware.Authenticate |
Redirects unauthenticated users to /login; returns 401 JSON for API/AJAX |
guest |
Laravex.Http.Middleware.RedirectIfAuthenticated |
Redirects authenticated users to /
|
For stateless API routes, pass auth:api to get JSON 401 responses instead of redirects:
Router.group([middleware: ["auth:api"]], fn ->
Router.get("/api/profile", &App.Http.Controllers.ProfileController.show/1)
end)You can guard individual routes or entire groups:
# Single route
Router.get("/account", &App.Http.Controllers.AccountController.show/1,
middleware: ["auth"]
)
# Group
Router.group([prefix: "admin", middleware: ["auth", "can:access-admin"]], fn ->
Router.get("/", &App.Http.Controllers.Admin.DashboardController.index/1)
end)# Temporarily impersonate a user within the current process
Process.put(:laravex_acting_as, user)
# Clear the override
Process.delete(:laravex_acting_as)- Authorization — Gate and Policies
- Hashing — PBKDF2 password hashing
- Passwords — Password reset flow
- API-Tokens — Sanctum-like bearer tokens
-
Starter-Kits —
install:starter-kitfor ready-made login/register views
Laravex — Laravel-faithful application skeleton & runtime for Elixir.
GitHub
·
Docs
·
Limitations
·
Laravel Docs
Not affiliated with Laravel LLC or the Elixir core team. Built to feel like Laravel on the BEAM.
- Home
- Installation
- Configuration
- Directory-Structure
- Request-Lifecycle
- Service-Container
- Service-Providers
- Deployment
- Routing
- Middleware
- CSRF-Protection
- Controllers
- Requests
- Responses
- Views
- Blade-Templates
- Asset-Bundling
- Session
- Validation
- Error-Handling
- Logging
- Artisan-Console
- Broadcasting
- Cache
- Collections
- Events
- File-Storage
- Helpers
- HTTP-Client
- Localization
- Notifications
- Pipeline
- Queues
- Rate-Limiting
- Strings
- Task-Scheduling