Skip to main content

SecretString

Struct SecretString 

Source
pub struct SecretString(/* private fields */);
Expand description

A string wrapper that masks its value when printed via Debug or Display, to prevent secrets (API keys, tokens, passwords, …) from accidentally ending up in logs or error messages.

The real value is reachable only through expose_secret, which is what makes an audit of where a secret escapes a grep rather than a reading of every call site.

This is the Rust analogue of upstream’s SecretString, which upstream #8127 rewrote from a str subclass into a wrapper for the same reason: the subclass masked repr() while every other path — str(), f-strings, concatenation, JSON encoding — silently produced the secret. Rust has no implicit string coercions, so Debug and Display are the equivalent surface, and both are masked here.

§It deliberately does not implement Serialize

A Serialize impl would put the secret in cleartext into anything a caller encodes a config struct into — a log line, a checkpoint, an HTTP body — with no call site to audit, which is the whole failure the type exists to prevent. Upstream reached the same conclusion from the other side: since #8127 a SecretString rejects JSON encoding rather than exposing its value.

A masked Serialize is not the alternative: it would round-trip "***" back as the value and silently replace the secret with the mask. So #[derive(Serialize)] on a struct holding one fails to compile — at which point the author decides what to write instead, which is the point. Deserialize is kept: reading a secret in from a config file is what the type is for.

Implementations§

Source§

impl SecretString

Source

pub fn new(value: impl Into<String>) -> SecretString

Wrap value as a SecretString.

Source

pub fn expose_secret(&self) -> &str

Return the real, unmasked value.

Named to match upstream’s get_secret_value() / the common Rust secrecy-crate convention, and to make call sites grep-able for audits of where secrets are actually exposed.

Trait Implementations§

Source§

impl Clone for SecretString

Source§

fn clone(&self) -> SecretString

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SecretString

Source§

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

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

impl<'de> Deserialize<'de> for SecretString

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<SecretString, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for SecretString

Source§

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

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

impl Eq for SecretString

Source§

impl From<&str> for SecretString

Source§

fn from(value: &str) -> SecretString

Converts to this type from the input type.
Source§

impl From<String> for SecretString

Source§

fn from(value: String) -> SecretString

Converts to this type from the input type.
Source§

impl PartialEq for SecretString

Source§

fn eq(&self, other: &SecretString) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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, !>

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