Struct pwbox::PwBox

pub struct PwBox<K, C> { /* fields omitted */ }

Password-encrypted data.

See also

See the crate docs for an example of usage. See ErasedPwBox for serialization details.

Implementations

impl<K: DeriveKey + Default, C: Cipher> PwBox<K, C>

pub fn new<R: RngCore + CryptoRng>(
    rng: &mut R,
    password: impl AsRef<[u8]>,
    message: impl AsRef<[u8]>
) -> Result<Self>

Creates a new box by using default settings of the supplied KDF.

impl<K: DeriveKey, C: Cipher> PwBox<K, C>

pub fn len(&self) -> usize

Returns the byte size of the encrypted data stored in this box.

pub fn open_into(
    &self,
    output: impl AsMut<[u8]>,
    password: impl AsRef<[u8]>
) -> Result<(), Error>

Decrypts the box into the specified container.

This method should be preferred to open() if the output type implements zeroing on drop (e.g., cryptographic secrets from sodiumoxide).

pub fn open(&self, password: impl AsRef<[u8]>) -> Result<SensitiveData, Error>

Decrypts the box and returns its contents. The returned container is zeroed on drop and derefs to a byte slice.

Trait Implementations

impl<K: Debug, C: Debug> Debug for PwBox<K, C>

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

Formats the value using the given formatter.