Skip to main content

EncryptedPrivateKeyInfo

Struct EncryptedPrivateKeyInfo

pub struct EncryptedPrivateKeyInfo<Data> {
    pub encryption_algorithm: EncryptionScheme,
    pub encrypted_data: Data,
}

Available on crate feature pkcs5 only.

Expand description

PKCS#8 EncryptedPrivateKeyInfo.

ASN.1 structure containing a PKCS#5 EncryptionScheme identifier for a password-based symmetric encryption scheme and encrypted private key data.

§Schema

Structure described in RFC 5208 Section 6:

EncryptedPrivateKeyInfo ::= SEQUENCE {
  encryptionAlgorithm  EncryptionAlgorithmIdentifier,
  encryptedData        EncryptedData }

EncryptionAlgorithmIdentifier ::= AlgorithmIdentifier

EncryptedData ::= OCTET STRING

Fields§

§encryption_algorithm: EncryptionScheme

Algorithm identifier describing a password-based symmetric encryption scheme used to encrypt the encrypted_data field.

§encrypted_data: Data

Private key data

Implementations§

impl<'a, Data> EncryptedPrivateKeyInfo<Data>
where Data: DecodeValue<'a, Error = Error> + EncodeValue + FixedTag + 'a + AsRef<[u8]>,

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

Available on crate feature encryption only.

Attempt to decrypt this encrypted private key using the provided password to derive an encryption key.

§Errors

Returns errors in the event the file could not be decrypted successfully.
Returns errors if the file decrypted but the resulting plaintext failed to decode.

Trait Implementations§

impl<Data: Clone> Clone for EncryptedPrivateKeyInfo<Data>

fn clone(&self) -> EncryptedPrivateKeyInfo<Data>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<Data> Debug for EncryptedPrivateKeyInfo<Data>

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

Formats the value using the given formatter. Read more

impl<'a, Data> DecodeValue<'a> for EncryptedPrivateKeyInfo<Data>
where Data: DecodeValue<'a, Error = Error> + FixedTag + 'a,

type Error = Error

Type returned in the event of a decoding error.

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

Attempt to decode this value using the provided Reader. Read more

impl<Data> EncodeValue for EncryptedPrivateKeyInfo<Data>
where Data: EncodeValue + FixedTag,

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

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

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

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

Get the Header used to encode this value. Read more

impl<Data: PartialEq> PartialEq for EncryptedPrivateKeyInfo<Data>

fn eq(&self, other: &EncryptedPrivateKeyInfo<Data>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Data> PemLabel for EncryptedPrivateKeyInfo<Data>

Available on crate feature pem only.

const PEM_LABEL: &'static str = "ENCRYPTED PRIVATE KEY"

Expected PEM type label for a given document, e.g. "PRIVATE KEY"

fn validate_pem_label(actual: &str) -> Result<(), Error>

Validate that a given label matches the expected label.

impl<'a, Data> TryFrom<&'a [u8]> for EncryptedPrivateKeyInfo<Data>
where Data: DecodeValue<'a, Error = Error> + EncodeValue + FixedTag + 'a,

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, Data> TryFrom<&EncryptedPrivateKeyInfo<Data>> for SecretDocument
where Data: DecodeValue<'a, Error = Error> + EncodeValue + FixedTag + 'a,

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( encrypted_private_key: &EncryptedPrivateKeyInfo<Data>, ) -> Result<SecretDocument>

Performs the conversion.

impl<'a, Data> TryFrom<EncryptedPrivateKeyInfo<Data>> for SecretDocument
where Data: DecodeValue<'a, Error = Error> + EncodeValue + FixedTag + 'a,

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( encrypted_private_key: EncryptedPrivateKeyInfo<Data>, ) -> Result<SecretDocument>

Performs the conversion.

impl<Data: Eq> Eq for EncryptedPrivateKeyInfo<Data>

impl<'a, Data> Sequence<'a> for EncryptedPrivateKeyInfo<Data>
where Data: DecodeValue<'a, Error = Error> + EncodeValue + FixedTag + 'a,

impl<Data> StructuralPartialEq for EncryptedPrivateKeyInfo<Data>

Auto Trait Implementations§

impl<Data> Freeze for EncryptedPrivateKeyInfo<Data>
where Data: Freeze,

impl<Data> RefUnwindSafe for EncryptedPrivateKeyInfo<Data>
where Data: RefUnwindSafe,

impl<Data> Send for EncryptedPrivateKeyInfo<Data>
where Data: Send,

impl<Data> Sync for EncryptedPrivateKeyInfo<Data>
where Data: Sync,

impl<Data> Unpin for EncryptedPrivateKeyInfo<Data>
where Data: Unpin,

impl<Data> UnsafeUnpin for EncryptedPrivateKeyInfo<Data>
where Data: UnsafeUnpin,

impl<Data> UnwindSafe for EncryptedPrivateKeyInfo<Data>
where Data: UnwindSafe,

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,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

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

type Error = <T as DecodeValue<'a>>::Error

Type returned in the event of a decoding error.

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

Attempt to decode this TLV message using the provided decoder. Read more

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

Parse Self from the provided DER-encoded byte slice. Read more

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

Parse Self from the provided DER-encoded byte slice. Read more

impl<T> DecodePem for T
where T: DecodeOwned<Error = Error> + PemLabel,

fn from_pem(pem: impl AsRef<[u8]>) -> Result<T, Error>

Try to decode this type from PEM. Read more

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

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

Compute the length of this TLV object in bytes when encoded as ASN.1 DER. Read more

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

Encode this TLV object as ASN.1 DER using the provided Writer. Read more

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

Encode this TLV object to the provided byte slice, returning a sub-slice containing the encoded message. Read more

fn encode_to_vec(&self, buf: &mut Vec<u8>) -> Result<Length, Error>

Available on crate feature alloc only.

Encode this TLV object as ASN.1 DER, appending it to the provided byte vector. Read more

fn to_der(&self) -> Result<Vec<u8>, Error>

Available on crate feature alloc only.

Encode this TLV object as ASN.1 DER, returning a byte vector. Read more

impl<T> EncodePem for T
where T: Encode + PemLabel + ?Sized,

fn to_pem(&self, line_ending: LineEnding) -> Result<String, Error>

Try to encode this type as PEM. Read more

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

const TAG: Tag = Tag::Sequence

ASN.1 tag

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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> IsConstructed for T
where T: FixedTag + ?Sized,

const CONSTRUCTED: bool

ASN.1 constructed bit

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tagged for T
where T: FixedTag + ?Sized,

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)

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.

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.

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