Enum pkcs5::EncryptionScheme

#[non_exhaustive]pub enum EncryptionScheme<'a> {
    Pbes1(Parameters),
    Pbes2(Parameters<'a>),
}

Supported PKCS#5 password-based encryption schemes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Pbes1(Parameters)

Password-Based Encryption Scheme 1 as defined in RFC 8018 Section 6.1.

Pbes2(Parameters<'a>)

Password-Based Encryption Scheme 2 as defined in RFC 8018 Section 6.2.

Implementations

impl<'a> EncryptionScheme<'a>

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 ciphertext in-place using a key derived from the provided password and this scheme's parameters.

pub fn oid(&self) -> ObjectIdentifier

Get the ObjectIdentifier (a.k.a OID) for this algorithm.

pub fn pbes1(&self) -> Option<&Parameters>

Get pbes1::Parameters if it is the selected algorithm.

pub fn pbes2(&self) -> Option<&Parameters<'a>>

Get pbes2::Parameters if it is the selected algorithm.

Trait Implementations

impl<'a> Clone for EncryptionScheme<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EncryptionScheme<'a>

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

Formats the value using the given formatter.

impl<'a> Encodable for EncryptionScheme<'a>

fn encoded_len(&self) -> Result<Length>

Compute the length of this value in bytes when encoded as ASN.1 DER.

fn encode(&self, encoder: &mut Encoder<'_>) -> Result<()>

Encode this value as ASN.1 DER using the provided Encoder.

pub fn encode_to_slice(&self, buf: &'a mut [u8]) -> Result<&'a [u8], Error>

Encode this value to the provided byte slice, returning a sub-slice containing the encoded message.

impl<'a> Eq for EncryptionScheme<'a>

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<'a> PartialEq<EncryptionScheme<'a>> for EncryptionScheme<'a>

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

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

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

This method tests for !=.

impl<'a> StructuralEq for EncryptionScheme<'a>

impl<'a> StructuralPartialEq for EncryptionScheme<'a>

impl<'a> TryFrom<&'a [u8]> for EncryptionScheme<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &'a [u8]) -> Result<EncryptionScheme<'a>>

Performs the conversion.

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for EncryptionScheme<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<EncryptionScheme<'_>>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.