Struct bitwarden_crypto::Sensitive

pub struct Sensitive<V: Zeroize> { /* private fields */ }

Wrapper for sensitive values which makes a best effort to enforce zeroization of the inner value on drop. The inner value exposes a Sensitive::expose method which returns a reference to the inner value. Care must be taken to avoid accidentally exposing the inner value through copying or cloning.

Internally Sensitive contains a Box which ensures the value is placed on the heap. It implements the Drop trait which calls zeroize on the inner value.

Implementations

impl<V: Zeroize> Sensitive<V>

pub fn new(value: Box<V>) -> Self

Create a new Sensitive value. In an attempt to avoid accidentally placing this on the stack it only accepts a Box value. The rust compiler should be able to optimize away the initial stack allocation presuming the value is not used before being boxed.

pub fn expose(&self) -> &V

Expose the inner value. By exposing the inner value, you take responsibility for ensuring that any copy of the value is zeroized.

pub fn expose_mut(&mut self) -> &mut V

Expose the inner value mutable. By exposing the inner value, you take responsibility for ensuring that any copy of the value is zeroized.

impl Sensitive<String>

pub fn decode_base64<T: Engine>( self, engine: T ) -> Result<SensitiveVec, CryptoError>

impl Sensitive<Vec<u8>>

pub fn encode_base64<T: Engine>(self, engine: T) -> SensitiveString

impl<V: Zeroize> Sensitive<V>

pub fn test<T: ?Sized>(value: &'static T) -> Self

where &'static T: Into<V>,

Trait Implementations

impl<V: Clone + Zeroize> Clone for Sensitive<V>

fn clone(&self) -> Sensitive<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Zeroize + Serialize> Debug for Sensitive<V>

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

Formats the value using the given formatter.

impl<V: Zeroize + Default> Default for Sensitive<V>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, V: Zeroize + Deserialize<'de>> Deserialize<'de> for Sensitive<V>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<V: Zeroize> Drop for Sensitive<V>

fn drop(&mut self)

Executes the destructor for this type.

impl<const N: usize> From<Sensitive<[u8; N]>> for SensitiveVec

Helper to convert a Sensitive<[u8, N]> to a SensitiveVec.

fn from(sensitive: Sensitive<[u8; N]>) -> Self

Converts to this type from the input type.

impl From<Sensitive<String>> for SensitiveVec

fn from(s: SensitiveString) -> Self

Converts to this type from the input type.

impl<V: Zeroize + JsonSchema> JsonSchema for Sensitive<V>

Transparently expose the inner value for serialization

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<V: PartialEq + Zeroize> PartialEq for Sensitive<V>

fn eq(&self, other: &Sensitive<V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<V: Zeroize + Serialize> Serialize for Sensitive<V>

Unfortunately once we serialize a SensitiveString we can’t control the future memory.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<Sensitive<String>> for DeviceKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: SensitiveString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Sensitive<String>> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: SensitiveString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Sensitive<Vec<u8>>> for SensitiveString

Helper to convert a Sensitive<Vec<u8>> to a Sensitive<String>, care is taken to ensure any intermediate copies are zeroed to avoid leaking sensitive data.

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(v: SensitiveVec) -> Result<Self, CryptoError>

Performs the conversion.

impl TryFrom<Sensitive<Vec<u8>>> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: SensitiveVec) -> Result<Self, Self::Error>

Performs the conversion.

impl<V: Zeroize> Zeroize for Sensitive<V>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<V: Zeroize> StructuralPartialEq for Sensitive<V>