Documentation

Legacy function for backward compatibility.

Fetches the user from the session and stores it in the controller context. New code should use authMiddleware in Config.hs instead.

Middleware that authenticates the current user and stores it in the request vault using currentUserVaultKey.

This is the standard middleware for user authentication. Add it to your Config.hs:

import IHP.LoginSupport.Middleware

config :: ConfigBuilder
config = do
    option $ AuthMiddleware (authMiddleware @User)

For both user and admin authentication:

option $ AuthMiddleware (authMiddleware @User . adminAuthMiddleware @Admin)

This is equivalent to userIdMiddleware (sessionKey @User) . fetchUserMiddleware @User.

Middleware that authenticates the current admin and stores it in the request vault using currentAdminVaultKey.

option $ AuthMiddleware (authMiddleware @User . adminAuthMiddleware @Admin)

This is equivalent to adminIdMiddleware (sessionKey @Admin) . fetchAdminMiddleware @Admin.

Middleware that reads a userId from the session and stores it in currentUserIdVaultKey. No database query is performed.

This is useful when you only need the user's UUID (e.g. for row-level security) and want to avoid the cost of a database fetch.

option $ AuthMiddleware (userIdMiddleware (sessionKey @User))

For full user record access, compose with fetchUserMiddleware:

option $ AuthMiddleware (userIdMiddleware (sessionKey @User) . fetchUserMiddleware @User)

Same as userIdMiddleware but stores the admin ID in currentAdminIdVaultKey.

option $ AuthMiddleware (adminIdMiddleware (sessionKey @Admin))

Middleware that reads the userId from currentUserIdVaultKey, fetches the full user record from the database, and stores it in currentUserVaultKey.

Must be composed after userIdMiddleware:

userIdMiddleware (sessionKey @User) . fetchUserMiddleware @User

Middleware that reads the adminId from currentAdminIdVaultKey, fetches the full admin record from the database, and stores it in currentAdminVaultKey.

Must be composed after adminIdMiddleware:

adminIdMiddleware (sessionKey @Admin) . fetchAdminMiddleware @Admin

Building block: reads a UUID from the given ID vault key, fetches the record from the database, and stores it in the given user vault key.

Parse UUID from session bytes. Expects the raw 36-byte UUID ASCII format written by login (e.g. "550e8400-e29b-41d4-a716-446655440000").

Low-level building block: middleware that runs a fetch function and stores the result in the request vault under the given key.

This decouples the vault insertion from the database lookup, making it useful for testing and custom authentication schemes.

Vault key for the current user record. Used by authMiddleware to store the authenticated user in the WAI request vault.

Vault key for the current admin record. Used by adminAuthMiddleware to store the authenticated admin in the WAI request vault.

Vault key for the current user's UUID. Used by userIdMiddleware to store just the user ID (no DB fetch).

Vault key for the current admin's UUID. Used by adminIdMiddleware to store just the admin ID (no DB fetch).

Pure lookup of an auth record from the WAI request vault.