Struct ScramClientFirst 

pub struct ScramClientFirst {
    pub gs2_header: String,
    pub authzid: Option<String>,
    pub username: String,
    pub nonce: String,
    pub extensions: Vec<(String, String)>,
    pub bare: String,
}

A parsed SCRAM client-first message.

Fields

gs2_header: String

The GS2 header exactly as the client sent it, n,, or n,a=<authzid>,.

authzid: Option<String>

The decoded GS2 authorization id, None when the header carries none.

username: String

The decoded SCRAM username (n=), with =2C and =3D unescaped.

nonce: String

The client nonce (r=).

extensions: Vec<(String, String)>

The SCRAM extensions after the nonce, in the order the client sent them, for example ("tokenauth", "true").

bare: String

client-first-message-bare as Kafka’s ClientFirstMessage.clientFirstMessageBare rebuilds it, the first part of the AuthMessage both sides sign: n=<saslname as sent>,r=<nonce>, then ,<key>=<value> for each distinct extension key. A reserved m= attribute is dropped, and a repeated key keeps its last value, as the map that ScramExtensions builds does.

Kafka iterates that map through Map.copyOf, whose order is fixed for one entry but randomized per JVM for two or more, so no order matches Kafka every time for a client that sends several distinct extensions. The keys keep the order in which the client first sent them, which is the order Kafka’s own client signs.

Implementations

impl ScramClientFirst

pub fn parse(bytes: &[u8]) -> Result<Self, AuthError>

Parse a client-first message.

Errors

AuthError::MalformedMessage when the message is not UTF-8, has a GS2 header other than n,, or n,a=<authzid>,, or does not follow Kafka’s client-first grammar.

pub fn extension(&self, key: &str) -> Option<&str>

The value of extension key, if the client sent it.

When the client sent key more than once, the last value wins, as in the map that Kafka’s ScramExtensions builds.

pub fn token_authenticated(&self) -> bool

True when the client sent tokenauth=true, Kafka’s ScramExtensions.tokenAuthenticated.

Trait Implementations

impl Clone for ScramClientFirst

fn clone(&self) -> ScramClientFirst

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScramClientFirst

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

Formats the value using the given formatter.

impl Eq for ScramClientFirst

impl PartialEq for ScramClientFirst

fn eq(&self, other: &ScramClientFirst) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScramClientFirst