AshAuthentication.Phoenix.Plug.RequireRecoveryCodes (ash_authentication_phoenix v3.0.0-rc.6)

View Source

A plug that enforces recovery code configuration for routes.

This plug checks if the current user has recovery codes configured and can optionally redirect users who haven't set up recovery codes to the setup page.

Behaviour When No User Is Present

When there is no authenticated user, this plug passes through without modification. Use this plug after your authentication plug.

Usage

pipeline :require_recovery_codes do
  plug AshAuthentication.Phoenix.Plug.RequireRecoveryCodes,
    resource: MyApp.Accounts.User,
    on_missing: :redirect_to_setup,
    setup_path: "/recovery-codes"
end

Options

  • :resource - Required. The user resource module.
  • :strategy - Optional. The name of the recovery code strategy.
  • :on_missing - What to do when recovery codes are not configured:
    • :halt - Return a 403 response (default)
    • :redirect_to_setup - Redirect to the setup page
    • {:redirect, path} - Redirect to a custom path
  • :setup_path - Path to redirect to. Defaults to "/recovery-codes".
  • :current_user_assign - The assign key for the current user. Defaults to :current_user.
  • :error_message - Flash message when redirecting. Defaults to "Recovery codes required".