Struct pkcs5::pbes2::Parameters

pub struct Parameters<'a> {
    pub kdf: Kdf<'a>,
    pub encryption: EncryptionScheme<'a>,
}

Password-Based Encryption Scheme 2 parameters as defined in RFC 8018 Appendix A.4.

 PBES2-params ::= SEQUENCE {
      keyDerivationFunc AlgorithmIdentifier {{PBES2-KDFs}},
      encryptionScheme AlgorithmIdentifier {{PBES2-Encs}} }

Fields

kdf: Kdf<'a>

Key derivation function

encryption: EncryptionScheme<'a>

Encryption scheme

Implementations

impl<'a> Parameters<'a>

pub fn pbkdf2_sha256_aes128cbc(
    pbkdf2_iterations: u16,
    pbkdf2_salt: &'a [u8],
    aes_iv: &'a [u8; 16]
) -> Result<Self, CryptoError>

Initialize PBES2 parameters using PBKDF2-SHA256 as the password-based key derivation algorithm and AES-128-CBC as the symmetric cipher.

pub fn pbkdf2_sha256_aes256cbc(
    pbkdf2_iterations: u16,
    pbkdf2_salt: &'a [u8],
    aes_iv: &'a [u8; 16]
) -> Result<Self, CryptoError>

Initialize PBES2 parameters using PBKDF2-SHA256 as the password-based key derivation algorithm and AES-128-CBC as the symmetric cipher.

pub fn decrypt(
    &self,
    password: impl AsRef<[u8]>,
    ciphertext: &[u8]
) -> Result<Vec<u8>, CryptoError>

This is supported on crate features alloc and pbes2 only.

Attempt to decrypt the given ciphertext, allocating and returning a byte vector containing the plaintext.

pub fn decrypt_in_place<'b>(
    &self,
    password: impl AsRef<[u8]>,
    buffer: &'b mut [u8]
) -> Result<&'b [u8], CryptoError>

This is supported on crate feature pbes2 only.

Attempt to decrypt the given ciphertext in-place using a key derived from the provided password and this scheme’s parameters.

Returns an error if the algorithm specified in this scheme’s parameters is unsupported, or if the ciphertext is malformed (e.g. not a multiple of a block mode’s padding)

pub fn encrypt(
    &self,
    password: impl AsRef<[u8]>,
    plaintext: &[u8]
) -> Result<Vec<u8>, CryptoError>

This is supported on crate features alloc and pbes2 only.

Encrypt the given plaintext, allocating and returning a vector containing the ciphertext.

pub fn encrypt_in_place<'b>(
    &self,
    password: impl AsRef<[u8]>,
    buffer: &'b mut [u8],
    pos: usize
) -> Result<&'b [u8], CryptoError>

This is supported on crate feature pbes2 only.

Encrypt the given plaintext in-place using a key derived from the provided password and this scheme’s parameters, writing the ciphertext into the same buffer.

Trait Implementations

impl<'a> Clone for Parameters<'a>

fn clone(&self) -> Parameters<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Parameters<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Parameters<'a>

impl<'a> From<Parameters<'a>> for EncryptionScheme<'a>

fn from(params: Parameters<'a>) -> EncryptionScheme<'a>

Performs the conversion.

impl<'a> Message<'a> for Parameters<'a>

fn fields<F, T>(&self, f: F) -> Result<T> where
    F: FnOnce(&[&dyn Encodable]) -> Result<T>, 

Call the provided function with a slice of Encodable trait objects representing the fields of this message.

impl<'a> PartialEq<Parameters<'a>> for Parameters<'a>

fn eq(&self, other: &Parameters<'a>) -> bool

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

fn ne(&self, other: &Parameters<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for Parameters<'a>

impl<'a> StructuralPartialEq for Parameters<'a>

impl<'a> TryFrom<Any<'a>> for Parameters<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: Any<'a>) -> Result<Self>

Performs the conversion.