Struct lock_keeper::crypto::secure_structs::SecureString

pub struct SecureString {
    string: String,
}

Wrapper around a String that hold sensitive/secret data. All the bytes are zeroized (zeroed out) whenever the value is dropped.

This type should be used anytime you need a String that holds sensitive or secret information.

Note: We purposely restrict the API to minimize accidental leaking and copying of data. Think carefully before adding new methods!

Fields

string: String

Implementations

impl SecureString

pub fn from_str_slice(string: &str) -> SecureString

Useful function for converting our test KMS_ARN into a SecureString. This should only be used in non-production code! As of the writing of this doc-string, there is no reason to use this in prod code.

pub fn from_string(string: String) -> SecureString

Convert an existing string to a SecureString by taking ownership of its data; this ensures no copies are made.

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Trait Implementations

impl AsRef<str> for SecureString

fn as_ref(&self) -> &str

Access underlying bytes of this secure string.

Warning: Think very carefully before cloning the underlying &str, as there is no guarantee they are getting zeroized once you clone them like this.

impl Clone for SecureString

fn clone(&self) -> SecureString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecureString

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

Formats the value using the given formatter.

impl Default for SecureString

fn default() -> SecureString

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecureString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecureString

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for SecureString

fn eq(&self, other: &SecureString) -> 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 Serialize for SecureString

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SecureString

impl StructuralPartialEq for SecureString