Enum bonsaidb::core::connection::Authentication

pub enum Authentication {
    Token {
        id: u64,
        now: LimitedResolutionTimestamp<Nanoseconds, BonsaiEpoch>,
        now_hash: Bytes,
        algorithm: TokenChallengeAlgorithm,
    },
    TokenChallengeResponse(Bytes),
    Password {
        user: NamedReference<'static, u64>,
        password: SensitiveString,
    },
}

Authentication methods.

Variants

Token

Fields

id: u64

The unique token id.

now: LimitedResolutionTimestamp<Nanoseconds, BonsaiEpoch>

The current timestamp of the authenticating device. This must be within 5 minutes of the server’s time for token authentication to succeed.

now_hash: Bytes

The hash of now, using the private token as key matter.

algorithm: TokenChallengeAlgorithm

The token challenge algorithm used to generate now_hash.

Initialize token-based authentication.

TokenChallengeResponse(Bytes)

A response to the server’s token authentication challenge.

Password

Fields

user: NamedReference<'static, u64>

The username or the user id to authenticate as.

password: SensitiveString

The password of the user.

Authenticate a user with a password.

Implementations

impl Authentication

pub fn password<'user, UsernameOrId>( user: UsernameOrId, password: SensitiveString ) -> Result<Authentication, Error>

where UsernameOrId: Nameable<'user, u64>,

Returns an authentication instance for this user and password.

pub fn token(id: u64, token: &SensitiveString) -> Result<Authentication, Error>

Returns a token authentication initialization instance for this token.

Trait Implementations

impl Clone for Authentication

fn clone(&self) -> Authentication

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Authentication

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Authentication

fn deserialize<__D>( __deserializer: __D ) -> Result<Authentication, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Authentication

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

where __S: Serializer,

Serialize this value into the given Serde serializer.