Struct Passphrase 

pub struct Passphrase(SecretBox<str>);

A secret passphrase

The passphrase is held by a [SecretString], which guarantees zeroing of memory on destruct.

Tuple Fields

0: SecretBox<str>

Implementations

impl Passphrase

pub const DEFAULT_LENGTH: usize = 30usize

The default passphrase length.

pub fn new(passphrase: String) -> Passphrase

Creates a new Passphrase from owned String

Examples

use signstar_crypto::passphrase::Passphrase;

let passphrase = Passphrase::new("passphrase".to_string());

pub fn generate(length: Option<usize>) -> Passphrase

Generates a new Passphrase.

The generated passphrase will consist of alphanumeric characters. The length of the passphrase can be adjusted using length, but is guaranteed to be at least Self::DEFAULT_LENGTH characters long.

Examples

use signstar_crypto::passphrase::Passphrase;

let passphrase = Passphrase::generate(None);
println!("{}", passphrase.expose_borrowed());

pub fn expose_owned(&self) -> String

Exposes the secret passphrase as owned String

pub fn expose_borrowed(&self) -> &str

Exposes the secret passphrase as borrowed str

Trait Implementations

impl Clone for Passphrase

fn clone(&self) -> Passphrase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Passphrase

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

Formats the value using the given formatter.

impl Default for Passphrase

fn default() -> Passphrase

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Passphrase

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Passphrase

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

Formats the value using the given formatter.

impl FromStr for Passphrase

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Passphrase, <Passphrase as FromStr>::Err>

Parses a string s to return a value of this type.

impl Serialize for Passphrase

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

where S: Serializer,

Serializes a Passphrase.

Warning

This may be used to write a passphrase to file! Take precautions so that passphrases can not leak to the environment.