xmpp-rs/sasl/src/lib.rs

47 lines
1.1 KiB
Rust
Raw Normal View History

2017-02-27 15:08:09 +00:00
//! Provides the `SaslMechanism` trait and some implementations.
extern crate openssl;
extern crate base64;
pub mod error;
/// A struct containing SASL credentials.
pub struct SaslCredentials {
pub username: String,
pub secret: SaslSecret,
pub channel_binding: Option<Vec<u8>>,
}
/// Represents a SASL secret, like a password.
pub enum SaslSecret {
/// No extra data needed.
None,
/// Password required.
Password(String),
}
pub trait SaslMechanism {
/// The name of the mechanism.
fn name(&self) -> &str;
/// Creates this mechanism from `SaslCredentials`.
fn from_credentials(credentials: SaslCredentials) -> Result<Self, String> where Self: Sized;
/// Provides initial payload of the SASL mechanism.
fn initial(&mut self) -> Result<Vec<u8>, String> {
Ok(Vec::new())
}
/// Creates a response to the SASL challenge.
fn response(&mut self, _challenge: &[u8]) -> Result<Vec<u8>, String> {
Ok(Vec::new())
}
/// Verifies the server success response, if there is one.
fn success(&mut self, _data: &[u8]) -> Result<(), String> {
Ok(())
}
}
pub mod mechanisms;