Skip to main content

AuthHandler

Struct AuthHandler 

Source
pub struct AuthHandler { /* private fields */ }
Expand description

Handles client-facing authentication interception

Implementations§

Source§

impl AuthHandler

Source

pub fn new( username: Option<String>, password: Option<String>, ) -> Result<Self, ValidationError>

Create a new auth handler with optional credentials

§Authentication behavior:
  • None, None → Auth disabled (allows all connections)
  • Some(user), Some(pass) → Auth enabled with validation
  • Some(user), None or None, Some(pass) → Auth disabled (both must be provided)
§Errors

Returns Err if either username or password is explicitly provided but empty/whitespace. This prevents misconfiguration where empty credentials would silently disable auth, which is a critical security vulnerability.

§Security

If you explicitly set credentials in config and they’re empty, the proxy will refuse to start rather than silently running with no authentication.

Source

pub fn with_users( user_list: Vec<(String, String)>, ) -> Result<Self, ValidationError>

Create a new auth handler with multiple users

§Errors

Returns Err if any username or password is empty/whitespace.

Source

pub fn is_enabled(&self) -> bool

Check if authentication is enabled

Source

pub fn validate_credentials(&self, username: &str, password: &str) -> bool

Validate client credentials

If auth is disabled (no users configured), returns true for all credentials

Source

pub async fn handle_auth_command<W>( &self, auth_action: AuthAction<'_>, writer: &mut W, stored_username: Option<&str>, ) -> Result<(usize, bool)>
where W: AsyncWriteExt + Unpin,

Handle an auth command - writes response to client and returns (bytes_written, auth_success) This is the ONE place where auth interception happens.

§Errors

Returns any I/O error from writing the NNTP auth response to the client.

Source

pub const fn user_response(&self) -> &'static [u8]

Get the AUTHINFO USER response

Source

pub const fn pass_response(&self) -> &'static [u8]

Get the AUTHINFO PASS response

Trait Implementations§

Source§

impl Debug for AuthHandler

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AuthHandler

Source§

fn default() -> AuthHandler

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scope for T

Source§

fn with<F, R>(self, f: F) -> R
where Self: Sized, F: FnOnce(Self) -> R,

Scoped with ownership.
Source§

fn with_ref<F, R>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Scoped with reference.
Source§

fn with_mut<F, R>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Scoped with mutable reference.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Value for T
where T: Send + Sync + 'static,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more