Struct Scram

pub struct Scram<S: ScramProvider> { /* private fields */ }

Available on crate feature scram only.

A struct for the SASL SCRAM-* and SCRAM-*-PLUS mechanisms.

Implementations

impl<S: ScramProvider> Scram<S>

pub fn new<N: Into<String>, P: Into<Password>>( username: N, password: P, channel_binding: ChannelBinding, ) -> Result<Scram<S>, Error>

Constructs a new struct for authenticating using the SASL SCRAM-* and SCRAM-*-PLUS mechanisms, depending on the passed channel binding.

It is recommended that instead you use a Credentials struct and turn it into the requested mechanism using from_credentials.

pub fn with_first_extensions(self, extensions: String) -> Self

Sets extension data to be inserted into the client’s first message. Extension data must be in the format of a comma separated list of SCRAM extensions to be used e.g. foo=true,bar=baz If not called, no extensions will be used for the clients first message.

pub fn with_final_extensions(self, extensions: String) -> Self

Sets extension data to be inserted into the client’s final message. Extension data must be in the format of a comma separated list of SCRAM extensions to be used e.g. foo=true,bar=baz If not called, no extensions will be used for the clients final message.

Trait Implementations

impl<S: ScramProvider> Mechanism for Scram<S>

fn name(&self) -> &str

The name of the mechanism.

fn from_credentials( credentials: Credentials, ) -> Result<Scram<S>, MechanismError>

Creates this mechanism from Credentials.

fn initial(&mut self) -> Vec<u8>

Provides initial payload of the SASL mechanism.

fn response(&mut self, challenge: &[u8]) -> Result<Vec<u8>, MechanismError>

Creates a response to the SASL challenge.

fn success(&mut self, data: &[u8]) -> Result<(), MechanismError>

Verifies the server success response, if there is one.