Enum pkcs5::EncryptionScheme

source · [−]

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

Expand description

Supported PKCS#5 password-based encryption schemes.

Variants (Non-exhaustive)

This enum is marked as 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(Algorithm)`

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

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

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)

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.

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 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<&Algorithm>

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

impl<'a> DecodeValue<'a> for EncryptionScheme<'a>

fn decode_value<R: Reader<'a>>(decoder: &mut R, header: Header) -> Result<Self>

Attempt to decode this message using the provided Reader.

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

fn from(alg: Algorithm) -> EncryptionScheme<'a>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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 ==. Read more

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

This method tests for !=.

impl<'a> Sequence<'a> for EncryptionScheme<'a>

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

Call the provided function with a slice of Encode trait objects representing the fields of this SEQUENCE. Read more

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> Eq for EncryptionScheme<'a>

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

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

Auto Trait Implementations

impl<'a> RefUnwindSafe for EncryptionScheme<'a>

impl<'a> Send for EncryptionScheme<'a>

impl<'a> Sync for EncryptionScheme<'a>

impl<'a> Unpin for EncryptionScheme<'a>

impl<'a> UnwindSafe for EncryptionScheme<'a>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<'a, T> Choice<'a> for T where
T: Decode<'a> + FixedTag,

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?

impl<'a, T> Decode<'a> for T where
T: DecodeValue<'a> + FixedTag,

fn decode<R>(reader: &mut R) -> Result<T, Error> where
R: Reader<'a>,

Attempt to decode this message using the provided decoder.

fn from_der(bytes: &'a [u8 ]) -> Result<Self, Error>

Parse Self from the provided DER-encoded byte slice.

impl<T> Encode for T where
T: EncodeValue + Tagged,

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

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

fn encode(&self, writer: &mut dyn Writer) -> Result<(), Error>

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

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. Read more

impl<'a, M> EncodeValue for M where
M: Sequence<'a>,

fn value_len(&self) -> Result<Length, Error>

Compute the length of this value (sans [Tag]+Length header) when encoded as ASN.1 DER. Read more

fn encode_value(&self, writer: &mut dyn Writer) -> Result<(), Error>

Encode value (sans [Tag]+Length header) as ASN.1 DER using the provided Writer. Read more

Get the Header used to encode this value.

impl<'a, M> FixedTag for M where
M: Sequence<'a>,

const TAG: Tag = Tag::Sequence

ASN.1 tag

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Tagged for T where
T: FixedTag,

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DecodeOwned for T where
T: for<'a> Decode<'a>,