AshAuthentication.Strategy.RecoveryCode

Strategy for recovery code authentication.

Allows users to authenticate using one-time recovery codes when they can't access their primary authentication method (e.g., TOTP authenticator app). Recovery codes are single-use and deleted after successful verification.

Requirements

1. A separate Ash resource for storing recovery codes with:
   • A sensitive string attribute for the hashed code
   • A belongs_to relationship to the user resource
   • create, read, and destroy actions
2. A has_many relationship on the user resource pointing to recovery codes
3. A brute force protection strategy (rate limiting, audit log, or custom preparation)

Example

defmodule MyApp.Accounts.RecoveryCode do
  use Ash.Resource,
    data_layer: AshPostgres.DataLayer,
    domain: MyApp.Accounts

  attributes do
    uuid_primary_key :id
    attribute :code, :string, sensitive?: true, allow_nil?: false
  end

  relationships do
    belongs_to :user, MyApp.Accounts.User, allow_nil?: false
  end

  actions do
    defaults [:read, :destroy]
    create :create do
      accept [:code]
      argument :user_id, :uuid, allow_nil?: false
      change manage_relationship(:user_id, :user, type: :append)
    end
  end
end

defmodule MyApp.Accounts.User do
  use Ash.Resource,
    extensions: [AshAuthentication],
    domain: MyApp.Accounts

  relationships do
    has_many :recovery_codes, MyApp.Accounts.RecoveryCode
  end

  authentication do
    strategies do
      recovery_code do
        recovery_code_resource MyApp.Accounts.RecoveryCode
        hash_provider AshAuthentication.BcryptProvider
        brute_force_strategy {:preparation, MyApp.NoopPreparation}
      end
    end
  end
end

Actions

The recovery code strategy generates up to two actions:

• verify - Verifies a recovery code for a user. On success, deletes the used code and returns the user. On failure, returns nil.
• generate - When generate_enabled? is true, generates new recovery codes for a user. Deletes any existing codes and returns the plaintext codes.

authentication.strategies.recovery_code

recovery_code name \\ :recovery_code

Adds recovery code authentication for account recovery when TOTP is unavailable.

Arguments

Options

Introspection

Target: AshAuthentication.Strategy.RecoveryCode