Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support SCRAM-SHA-512 and SCRAM-SHA-512-PLUS #48

Merged
merged 1 commit into from
Aug 17, 2024
Merged

feat: support SCRAM-SHA-512 and SCRAM-SHA-512-PLUS #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/mechanisms/scram/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ use thiserror::Error;

#[cfg(feature = "scram-sha-2")]
pub type ScramSha256Client<const N: usize> = ScramClient<sha2::Sha256, N>;
// #[cfg(feature = "scram-sha-2")]
// pub type ScramSha512Client<const N: usize> = ScramClient<sha2::Sha512, N>;
#[cfg(feature = "scram-sha-2")]
pub type ScramSha512Client<const N: usize> = ScramClient<sha2::Sha512, N>;

#[cfg(feature = "scram-sha-1")]
pub type ScramSha1Client<const N: usize> = ScramClient<sha1::Sha1, N>;
Expand Down
105 changes: 105 additions & 0 deletions src/mechanisms/scram/mechinfo.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,111 @@ mod scram_sha256 {
#[cfg(feature = "scram-sha-2")]
pub use scram_sha256::*;

#[cfg(feature = "scram-sha-2")]
mod scram_sha512 {
use super::{
client, server, Authentication, Box, Matches, Mechanism, Mechname, Named, SASLError,
Selection, Selector, Side, NONCE_LEN,
};

#[cfg_attr(
feature = "registry_static",
linkme::distributed_slice(crate::registry::MECHANISMS)
)]
pub static SCRAM_SHA512: Mechanism = Mechanism {
mechanism: Mechname::const_new(b"SCRAM-SHA-512"),
priority: 600,
client: Some(|| Ok(Box::new(client::ScramSha512Client::<NONCE_LEN>::new(true)))),
server: Some(|sasl| {
let can_cb = sasl
.mech_list()
.any(|m| m.mechanism.as_str() == "SCRAM-SHA-512-PLUS");
Ok(Box::new(server::ScramSha512Server::<NONCE_LEN>::new(
can_cb,
)))
}),
first: Side::Client,
select: |cb| {
Some(if cb {
Selection::Nothing(Box::new(ScramSelector512::No))
} else {
Matches::<Select512>::name()
})
},
offer: |_| true,
};

struct Select512;
impl Named for Select512 {
fn mech() -> &'static Mechanism {
&SCRAM_SHA512
}
}

#[derive(Copy, Clone, Debug)]
enum ScramSelector512 {
/// No SCRAM-SHA512 found yet
No,
/// Only SCRAM-SHA512 but not -PLUS found
Bare,
/// SCRAM-SHA512-PLUS found.
Plus,
}
impl Selector for ScramSelector512 {
fn select(&mut self, mechname: &Mechname) -> Option<&'static Mechanism> {
if *mechname == *SCRAM_SHA512.mechanism {
*self = match *self {
Self::No => Self::Bare,
x => x,
}
} else if *mechname == *SCRAM_SHA512_PLUS.mechanism {
*self = Self::Plus;
}
None
}

fn done(&mut self) -> Option<&'static Mechanism> {
match self {
Self::No => None,
_ => Some(&SCRAM_SHA512),
}
}

fn finalize(&mut self) -> Result<Box<dyn Authentication>, SASLError> {
Ok(Box::new(match self {
Self::Bare => client::ScramSha512Client::<NONCE_LEN>::new(false),
Self::Plus => client::ScramSha512Client::<NONCE_LEN>::new(true),
Self::No => unreachable!(),
}))
}
}

pub static SCRAM_SHA512_PLUS: Mechanism = Mechanism {
mechanism: Mechname::const_new(b"SCRAM-SHA-512-PLUS"),
priority: 700,
client: Some(|| Ok(Box::new(client::ScramSha512Client::<NONCE_LEN>::new_plus()))),
server: Some(|_sasl| Ok(Box::new(server::ScramSha512Server::<NONCE_LEN>::new_plus()))),
first: Side::Client,
select: |cb| {
if cb {
Some(Matches::<Select512Plus>::name())
} else {
None
}
},
offer: |_| true,
};

struct Select512Plus;
impl Named for Select512Plus {
fn mech() -> &'static Mechanism {
&SCRAM_SHA512_PLUS
}
}
}
#[cfg(feature = "scram-sha-2")]
pub use scram_sha512::*;

#[cfg(test)]
mod tests {
use super::*;
Expand Down
4 changes: 2 additions & 2 deletions src/mechanisms/scram/server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ const DEFAULT_SALT_LEN: usize = 32;
pub type ScramSha1Server<const N: usize> = ScramServer<sha1::Sha1, N>;
#[cfg(feature = "scram-sha-2")]
pub type ScramSha256Server<const N: usize> = ScramServer<sha2::Sha256, N>;
// #[cfg(feature = "scram-sha-2")]
// pub type ScramSha512Server<const N: usize> = ScramServer<sha2::Sha512, N>;
#[cfg(feature = "scram-sha-2")]
pub type ScramSha512Server<const N: usize> = ScramServer<sha2::Sha512, N>;

#[derive(Debug, Error)]
pub enum ScramServerError {
Expand Down
6 changes: 6 additions & 0 deletions src/registry.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@ mod config {

pub(crate) fn credentials(authzid: bool) -> Self {
static CRED_AUTHZID: &[Mechanism] = &[
#[cfg(feature = "scram-sha-2")]
crate::mechanisms::scram::SCRAM_SHA512,
#[cfg(feature = "scram-sha-2")]
crate::mechanisms::scram::SCRAM_SHA256,
#[cfg(feature = "scram-sha-1")]
Expand All @@ -163,6 +165,8 @@ mod config {
];

static CRED: &[Mechanism] = &[
#[cfg(feature = "scram-sha-2")]
crate::mechanisms::scram::SCRAM_SHA512,
#[cfg(feature = "scram-sha-2")]
crate::mechanisms::scram::SCRAM_SHA256,
#[cfg(feature = "scram-sha-1")]
Expand Down Expand Up @@ -190,6 +194,8 @@ mod config {
impl Default for Registry {
fn default() -> Self {
static BUILTIN: &[Mechanism] = &[
#[cfg(feature = "scram-sha-2")]
crate::mechanisms::scram::SCRAM_SHA512,
#[cfg(feature = "scram-sha-2")]
crate::mechanisms::scram::SCRAM_SHA256,
#[cfg(feature = "scram-sha-1")]
Expand Down