View Source Charon.AuthFlow.Stage (Charon v0.0.3-alpha)

A stage in an authentication flow. A stage consists of challenges, one of which has to be passed in order to pass the stage.

Link to this section Summary

Types

A set of authentication challenges, mapped to their names.

t()

A stage in an authentication flow. A stage consists of challenges, one of which has to be passed in order to pass the stage.

Functions

Get a challenge from a stage.

Create a challenge set from a list of Charon.AuthChallenge implementing modules.

Link to this section Types

@type challenge_set() :: %{required(String.t()) => Charon.AuthChallenge.t()}

A set of authentication challenges, mapped to their names.

@type t() :: %Charon.AuthFlow.Stage{challenges: challenge_set()}

A stage in an authentication flow. A stage consists of challenges, one of which has to be passed in order to pass the stage.

Link to this section Functions

Link to this function

get_challenge(stage, name)

View Source
@spec get_challenge(t(), String.t()) :: Charon.AuthChallenge.t() | nil

Get a challenge from a stage.

Link to this function

list_to_challenge_set(challenge_list)

View Source
@spec list_to_challenge_set([Charon.AuthChallenge.t()]) :: challenge_set()

Create a challenge set from a list of Charon.AuthChallenge implementing modules.