Packages
ash_authentication
5.0.0-rc.6
5.0.0-rc.12
5.0.0-rc.11
5.0.0-rc.10
5.0.0-rc.9
5.0.0-rc.8
5.0.0-rc.7
5.0.0-rc.6
5.0.0-rc.5
5.0.0-rc.4
5.0.0-rc.3
5.0.0-rc.2
5.0.0-rc.1
5.0.0-rc.0
4.14.1
4.14.0
4.13.7
4.13.6
4.13.5
4.13.4
4.13.3
4.13.2
retired
4.13.1
retired
4.13.0
4.12.0
4.11.0
4.10.0
4.9.9
4.9.8
4.9.7
4.9.6
4.9.5
4.9.4
4.9.3
4.9.2
4.9.1
4.9.0
4.8.7
4.8.6
4.8.5
4.8.3
4.8.2
4.8.1
4.8.0
4.7.6
4.7.5
4.7.4
4.7.3
4.7.2
4.7.1
4.7.0
4.6.4
4.6.3
4.6.2
4.6.1
4.6.0
4.5.6
4.5.5
4.5.4
4.5.3
4.5.2
4.5.1
4.5.0
4.4.9
4.4.8
4.4.7
4.4.6
4.4.5
4.4.4
4.4.3
4.4.2
4.4.1
4.4.0
4.3.12
4.3.11
4.3.10
4.3.9
4.3.8
4.3.7
4.3.6
4.3.5
4.3.4
4.3.3
4.3.2
4.3.1
4.3.0
4.2.7
4.2.6
4.2.5
4.2.4
4.2.3
4.2.2
4.2.1
4.2.0
4.1.0
4.0.4
4.0.3
4.0.2
4.0.1
4.0.0
4.0.0-rc.6
4.0.0-rc.5
4.0.0-rc.3
4.0.0-rc.2
4.0.0-rc.1
4.0.0-rc.0
3.12.4
3.12.3
3.12.2
3.12.1
3.12.0
3.11.16
3.11.15
3.11.14
3.11.13
3.11.12
3.11.11
3.11.10
3.11.9
3.11.8
3.11.7
3.11.6
3.11.5
3.11.4
3.11.3
3.11.2
3.11.1
3.11.0
3.10.8
3.10.7
3.10.6
3.10.5
3.10.4
3.10.3
3.10.2
3.10.1
3.10.0
3.9.6
3.9.5
3.9.4
3.9.3
3.9.2
3.9.1
3.9.0
3.8.0
3.7.9
3.7.8
3.7.6
3.7.5
3.7.4
3.7.3
3.7.2
3.7.1
3.7.0
3.6.1
3.6.0
3.5.3
3.5.2
3.5.1
3.5.0
3.3.1
3.3.0
3.2.2
3.2.1
3.2.0
3.1.0
3.0.3
Authentication extension for the Ash Framework.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/mix/tasks/ash_authentication.add_strategy.ex
# SPDX-FileCopyrightText: 2022 Alembic Pty Ltd
#
# SPDX-License-Identifier: MIT
# credo:disable-for-this-file Credo.Check.Design.AliasUsage
if Code.ensure_loaded?(Igniter) do
defmodule Mix.Tasks.AshAuthentication.AddStrategy do
use Igniter.Mix.Task
@example "mix ash_authentication.add_strategy password"
@shortdoc "Adds the provided strategy or strategies to your user resource"
@strategies [
password: "Register and sign in with a username/email and a password.",
magic_link: "Register and sign in with a magic link, sent via email to the user.",
otp: "Sign in with a short one-time password sent via email or SMS.",
api_key: "Sign in with an API key.",
totp: "Authenticate with a time-based one-time password (TOTP).",
recovery_code: "Authenticate with one-time recovery codes as a 2FA fallback.",
github: "Sign in with GitHub.",
google: "Sign in with Google.",
apple: "Sign in with Apple.",
auth0: "Sign in with Auth0.",
microsoft: "Sign in with Microsoft.",
okta: "Sign in with Okta.",
slack: "Sign in with Slack.",
oidc: "Sign in with a generic OpenID Connect provider.",
oauth2: "Sign in with a generic OAuth2 provider."
]
@strategy_explanation Enum.map_join(@strategies, "\n", fn {name, description} ->
" * `#{name}` - #{description}"
end)
@strategy_names @strategies |> Keyword.keys() |> Enum.map(&to_string/1)
@strategy_tasks %{
"password" => "ash_authentication.add_strategy.password",
"magic_link" => "ash_authentication.add_strategy.magic_link",
"otp" => "ash_authentication.add_strategy.otp",
"api_key" => "ash_authentication.add_strategy.api_key",
"totp" => "ash_authentication.add_strategy.totp",
"recovery_code" => "ash_authentication.add_strategy.recovery_code",
"github" => "ash_authentication.add_strategy.github",
"google" => "ash_authentication.add_strategy.google",
"apple" => "ash_authentication.add_strategy.apple",
"auth0" => "ash_authentication.add_strategy.auth0",
"microsoft" => "ash_authentication.add_strategy.microsoft",
"okta" => "ash_authentication.add_strategy.okta",
"slack" => "ash_authentication.add_strategy.slack",
"oidc" => "ash_authentication.add_strategy.oidc",
"oauth2" => "ash_authentication.add_strategy.oauth2"
}
@moduledoc """
#{@shortdoc}
This task will add the provided strategy or strategies to your user resource.
The following strategies are available. For all others, see the relevant documentation for setup
#{@strategy_explanation}
Each strategy can also be added directly with its own task:
* `mix ash_authentication.add_strategy.password`
* `mix ash_authentication.add_strategy.magic_link`
* `mix ash_authentication.add_strategy.otp`
* `mix ash_authentication.add_strategy.api_key`
* `mix ash_authentication.add_strategy.totp`
## Example
```bash
#{@example}
```
## Options
* `--user`, `-u` - The user resource. Defaults to `YourApp.Accounts.User`
* `--identity-field`, `-i` - The field on the user resource that will be used to identify
the user. Defaults to `email`
## Password options
- `hash-provider` - The hash provider to use, either `bcrypt` or `argon2`. Defaults to `bcrypt`.
## TOTP options
- `--mode`, `-m` - Either `primary` or `2fa`. Defaults to `2fa`.
- `--name`, `-n` - The name of the TOTP strategy. Defaults to `totp`.
"""
def info(_argv, _composing_task) do
%Igniter.Mix.Task.Info{
group: :ash,
example: @example,
extra_args?: false,
only: nil,
positional: [
strategies: [rest: true]
],
composes: Map.values(@strategy_tasks),
schema: [
accounts: :string,
user: :string,
identity_field: :string,
api_key: :string,
hash_provider: :string,
mode: :string,
name: :string,
base_url: :string,
authorize_url: :string,
token_url: :string,
user_url: :string,
team_id: :string
],
aliases: [
a: :accounts,
u: :user,
i: :identity_field,
m: :mode,
n: :name
],
defaults: [
identity_field: "email"
]
}
end
def igniter(igniter) do
strategies = igniter.args.positional[:strategies] || []
invalid_strategy = Enum.find(strategies, &(&1 not in @strategy_names))
if invalid_strategy do
Mix.shell().error("""
Invalid strategy provided: `#{invalid_strategy}`
Not all strategies can be installed using `ash_authentication.add_strategy` yet.
Want to see a strategy added? Open an issue (or even better, a PR!) on GitHub.
See a list of strategies and how to install them here:
https://hexdocs.pm/ash_authentication/get-started.html
Available Strategies:
#{@strategy_explanation}
""")
exit({:shutdown, 1})
end
argv = igniter.args.argv_flags
Enum.reduce(strategies, igniter, fn strategy, igniter ->
Igniter.compose_task(igniter, @strategy_tasks[strategy], argv)
end)
end
end
else
defmodule Mix.Tasks.AshAuthentication.AddStrategy do
@shortdoc "Adds the provided strategy or strategies to your user resource"
@moduledoc @shortdoc
use Mix.Task
def run(_argv) do
Mix.shell().error("""
The task 'ash_authentication.add_strategy' requires igniter to be run.
Please install igniter and try again.
For more information, see: https://hexdocs.pm/igniter
""")
exit({:shutdown, 1})
end
end
end