Struct pkcs5::pbes2::Parameters

source · [−]

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

Expand description

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

source

impl<'a> Parameters<'a>

source

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

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

source

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

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

source

pub fn scrypt_aes128cbc(
 params: Params,
 salt: &'a [u8 ],
 aes_iv: &'a [u8 ; 16]
) -> Result<Self>

Available on crate feature scrypt only.

Initialize PBES2 parameters using scrypt as the password-based key derivation function and AES-128-CBC as the symmetric cipher.

For more information on scrypt parameters, see documentation for the scrypt::Params struct.

source

pub fn scrypt_aes256cbc(
 params: Params,
 salt: &'a [u8 ],
 aes_iv: &'a [u8 ; 16]
) -> Result<Self>

Available on crate feature scrypt only.

Initialize PBES2 parameters using scrypt as the password-based key derivation function and AES-256-CBC as the symmetric cipher.

For more information on scrypt parameters, see documentation for the scrypt::Params struct.

When in doubt, use Default::default() as the scrypt::Params. This also avoids the need to import the type from the scrypt crate.

source

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

Available on crate features alloc and pbes2 only.

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

source

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

Available 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)

source

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

Available on crate features alloc and pbes2 only.

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

source

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

Available 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.