View Source Mobilizon.Service.Auth.Authenticator behaviour (Mobilizon v5.0.0-beta.1)

Module to handle authentification (currently through database or LDAP)

Summary

Types

tokens()

tokens_with_user()

ttl()

Callbacks

can_change_email?(t)

can_change_password?(t)

provider_name()

Functions

authenticate(email, password)

can_change_email?(user)

can_change_password?(user)

can_reset_password?(user)

fetch_user(email)

generate_access_token(user, ttl \\ nil)

Generates access token for an user.

generate_refresh_token(user, ttl \\ nil)

Generates refresh token for an user.

generate_tokens(user)

Generates access token and refresh token for an user.

has_password?(user)

implementation()

provider_name()

Types

tokens()

@type tokens() :: %{access_token: String.t(), refresh_token: String.t()}

tokens_with_user()

@type tokens_with_user() :: %{
  access_token: String.t(),
  refresh_token: String.t(),
  user: Mobilizon.Users.User.t()
}

ttl()

@type ttl() :: {pos_integer(), :second | :minute | :hour | :week}

Callbacks

can_change_email?(t)

@callback can_change_email?(Mobilizon.Users.User.t()) :: boolean()

can_change_password?(t)

@callback can_change_password?(Mobilizon.Users.User.t()) :: boolean()

provider_name()

@callback provider_name() :: String.t() | nil

Functions

authenticate(email, password)

@spec authenticate(String.t(), String.t()) :: {:ok, tokens_with_user()}

can_change_email?(user)

can_change_password?(user)

can_reset_password?(user)

@spec can_reset_password?(Mobilizon.Users.User.t()) :: boolean()

fetch_user(email)

@spec fetch_user(String.t()) :: Mobilizon.Users.User.t() | {:error, :user_not_found}

generate_access_token(user, ttl \\ nil)

@spec generate_access_token(
  Mobilizon.Users.User.t() | ApplicationToken.t(),
  ttl() | nil
) ::
  {:ok, String.t()} | {:error, any()}

Generates access token for an user.

generate_refresh_token(user, ttl \\ nil)

@spec generate_refresh_token(
  Mobilizon.Users.User.t() | ApplicationToken.t(),
  ttl() | nil
) ::
  {:ok, String.t()} | {:error, any()}

Generates refresh token for an user.

generate_tokens(user)

@spec generate_tokens(Mobilizon.Users.User.t() | ApplicationToken.t()) ::
  {:ok, tokens()} | {:error, any()}

Generates access token and refresh token for an user.

has_password?(user)

@spec has_password?(Mobilizon.Users.User.t()) :: boolean()

View Source Mobilizon.Service.Auth.Authenticator behaviour (Mobilizon v5.0.0-beta.1)

Summary

Types

Callbacks

Functions

Types

tokens()

tokens_with_user()

ttl()

Callbacks

can_change_email?(t)

can_change_password?(t)

login(t, t)

provider_name()

Functions

authenticate(email, password)

can_change_email?(user)

can_change_password?(user)

can_reset_password?(user)

fetch_user(email)

generate_access_token(user, ttl \\ nil)

generate_refresh_token(user, ttl \\ nil)

generate_tokens(user)

has_password?(user)

implementation()

login(email, password)

provider_name()