Enum SaslMechanism 

pub enum SaslMechanism {
    Plain,
    ScramSha256,
    ScramSha512,
    OAuthBearer,
    Gssapi,
}

Variants

Plain

ScramSha256

ScramSha512

OAuthBearer

SASL/OAUTHBEARER (KIP-255 / RFC 7628). The broker’s configured token validator validates the bearer token.

Gssapi

SASL/GSSAPI (Kerberos, RFC 4752). The GSS provider drives context establishment and the RFC 4752 security-layer negotiation from the broker’s configured service keytab.

The variant exists in every build, because metadata records persist it. The provider needs the gssapi Cargo feature; see SaslMechanism::is_available.

Implementations

impl SaslMechanism

pub const ALL: [Self; 5]

Every mechanism, in declaration order.

pub fn wire_name(self) -> &'static str

pub fn from_wire(s: &str) -> Option<Self>

pub fn is_scram(self) -> bool

true for the SCRAM mechanisms, SHA-256 and SHA-512.

The handshake and authenticate code uses this where it treats both the same way at the dispatch level.

pub const fn is_available(self) -> bool

true when this build can run the mechanism.

GSSAPI needs the gssapi Cargo feature on a native target. Every other mechanism is always available.

pub fn available() -> impl Iterator<Item = Self>

The mechanisms this build can run, in declaration order.

pub const fn require_available(self) -> Result<Self, AuthError>

Returns self when this build can run the mechanism.

Errors

AuthError::UnsupportedMechanism when SaslMechanism::is_available is false. A broker answers that with Kafka’s UNSUPPORTED_SASL_MECHANISM (error code 33), as it does for a mechanism the listener has not enabled.

Trait Implementations

impl Clone for SaslMechanism

fn clone(&self) -> SaslMechanism

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SaslMechanism

impl Debug for SaslMechanism

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SaslMechanism

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SaslMechanism

impl<'_derivative_strum> From<&'_derivative_strum SaslMechanism> for &'static str

fn from(x: &'_derivative_strum SaslMechanism) -> &'static str

Converts to this type from the input type.

impl From<SaslMechanism> for &'static str

fn from(x: SaslMechanism) -> &'static str

Converts to this type from the input type.

impl FromStr for SaslMechanism

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SaslMechanism, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for SaslMechanism

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SaslMechanism

fn eq(&self, other: &SaslMechanism) -> 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 Serialize for SaslMechanism

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SaslMechanism

impl TryFrom<&str> for SaslMechanism

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<SaslMechanism, <Self as TryFrom<&str>>::Error>

Performs the conversion.