Enum kanidm_proto::v1::AuthStep

pub enum AuthStep {
    Init(String),
    Init2 {
        username: String,
        issue: AuthIssueSession,
        privileged: bool,
    },
    Begin(AuthMech),
    Cred(AuthCredential),
}

Authentication to Kanidm is a stepped process.

The session is first initialised with the requested username.

In response the list of supported authentication mechanisms is provided.

The user chooses the authentication mechanism to proceed with.

The server responds with a challenge that the user provides a credential to satisfy. This challenge and response process continues until a credential fails to validate, an error occurs, or successful authentication is complete.

Variants

Init(String)

Initialise a new authentication session

Init2

Initialise a new authentication session with extra flags for requesting different types of session tokens or immediate access to privileges.

Fields

username: String

issue: AuthIssueSession

privileged: bool

If true, the session will have r/w access.

Begin(AuthMech)

Request the named authentication mechanism to proceed

Cred(AuthCredential)

Provide a credential in response to a challenge

Trait Implementations

impl Debug for AuthStep

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthStep

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthStep

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for AuthStep

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the [ToSchema::schema].