Skip to main content

CredentialProbe

Struct CredentialProbe 

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

Answers “is this credential the one we present?” without handing the credential itself to the caller.

#1270: the NATS monitoring endpoint reports authorized_user per connection. A current nats-server hides that field for token-authenticated connections, but that is the broker build’s behaviour, not a guarantee this side can lean on — a consumer of /connz has to treat the value as possibly being the fleet-wide secret. The one question it may safely answer about it is whether it equals the credential this process already holds, and that answer is enough to label a connection (“still on the shared token”) without ever storing or serving the value.

Constructed once and reused: [resolve_token] hits the Windows registry, and the caller compares against every connection on the broker.

Implementations§

Source§

impl CredentialProbe

Source

pub fn for_role(role: NatsRole) -> Self

Resolve the credential role would present, exactly as connect does.

Source

pub fn from_token(token: Option<String>) -> Self

Build a probe around an explicitly-supplied token.

The production path is Self::for_role; this exists so callers can be tested against a known credential without a Windows registry to write to — and, on a developer’s machine, without accidentally probing the real fleet token that for_role would find there.

Source

pub fn from_user(name: impl Into<String>) -> Self

Build a probe for a process that authenticates as a named user.

Nothing constructs this in production yet — connect cannot present a user (#1266). It exists so the consumers of CredentialKind::User are testable now rather than written blind later.

Source

pub fn kind(&self) -> CredentialKind

Which shape of credential this process presents.

Source

pub fn is_ours(&self, candidate: &str) -> bool

Whether candidate is the secret this process presents.

Only ever true for a token. A user’s secret is its password, which authorized_user never carries — matching a username here would mean “this connection is on the same account”, a different and much weaker statement than the one callers use this for.

A plain comparison: candidate comes from the broker’s own report of connections it already authenticated, not from an attacker-chosen input, so there is no oracle to time.

Trait Implementations§

Source§

impl Debug for CredentialProbe

Hand-written so a stray {:?} in a log line cannot print the credential. A username is not a secret and is shown; a token never is.

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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> 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