mirror of
https://github.com/neondatabase/neon.git
synced 2026-01-16 09:52:54 +00:00
b3ec6e0661
This will replace the vague (and incorrect) "Internal error" with a nice and helpful authentication error, e.g. "password doesn't match".
74 lines
2.3 KiB
Rust
74 lines
2.3 KiB
Rust
//! Simple Authentication and Security Layer.
|
|
//!
|
|
//! RFC: <https://datatracker.ietf.org/doc/html/rfc4422>.
|
|
//!
|
|
//! Reference implementation:
|
|
//! * <https://github.com/postgres/postgres/blob/94226d4506e66d6e7cbf4b391f1e7393c1962841/src/backend/libpq/auth-sasl.c>
|
|
//! * <https://github.com/postgres/postgres/blob/94226d4506e66d6e7cbf4b391f1e7393c1962841/src/interfaces/libpq/fe-auth.c>
|
|
|
|
mod channel_binding;
|
|
mod messages;
|
|
mod stream;
|
|
|
|
use crate::error::UserFacingError;
|
|
use std::io;
|
|
use thiserror::Error;
|
|
|
|
pub use channel_binding::ChannelBinding;
|
|
pub use messages::FirstMessage;
|
|
pub use stream::SaslStream;
|
|
|
|
/// Fine-grained auth errors help in writing tests.
|
|
#[derive(Error, Debug)]
|
|
pub enum Error {
|
|
#[error("Failed to authenticate client: {0}")]
|
|
AuthenticationFailed(&'static str),
|
|
|
|
#[error("Channel binding failed: {0}")]
|
|
ChannelBindingFailed(&'static str),
|
|
|
|
#[error("Unsupported channel binding method: {0}")]
|
|
ChannelBindingBadMethod(Box<str>),
|
|
|
|
#[error("Bad client message")]
|
|
BadClientMessage,
|
|
|
|
#[error(transparent)]
|
|
Io(#[from] io::Error),
|
|
}
|
|
|
|
impl UserFacingError for Error {
|
|
fn to_string_client(&self) -> String {
|
|
use Error::*;
|
|
match self {
|
|
// This constructor contains the reason why auth has failed.
|
|
AuthenticationFailed(s) => s.to_string(),
|
|
// TODO: add support for channel binding
|
|
ChannelBindingFailed(_) => "channel binding is not supported yet".to_string(),
|
|
ChannelBindingBadMethod(m) => format!("unsupported channel binding method {m}"),
|
|
_ => "authentication protocol violation".to_string(),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A convenient result type for SASL exchange.
|
|
pub type Result<T> = std::result::Result<T, Error>;
|
|
|
|
/// A result of one SASL exchange.
|
|
pub enum Step<T, R> {
|
|
/// We should continue exchanging messages.
|
|
Continue(T),
|
|
/// The client has been authenticated successfully.
|
|
Authenticated(R),
|
|
}
|
|
|
|
/// Every SASL mechanism (e.g. [SCRAM](crate::scram)) is expected to implement this trait.
|
|
pub trait Mechanism: Sized {
|
|
/// What's produced as a result of successful authentication.
|
|
type Output;
|
|
|
|
/// Produce a server challenge to be sent to the client.
|
|
/// This is how this method is called in PostgreSQL (`libpq/sasl.h`).
|
|
fn exchange(self, input: &str) -> Result<(Step<Self, Self::Output>, String)>;
|
|
}
|