Struct PrivateKeyInfo 

pub struct PrivateKeyInfo<Params, Key, PubKey> {
    pub algorithm: AlgorithmIdentifier<Params>,
    pub private_key: Key,
    pub public_key: Option<PubKey>,
}

PKCS#8 PrivateKeyInfo.

ASN.1 structure containing an AlgorithmIdentifier, private key data in an algorithm specific format, and optional attributes (ignored by this implementation).

Supports PKCS#8 v1 as described in RFC 5208 and PKCS#8 v2 as described in RFC 5958. PKCS#8 v2 keys include an additional public key field.

PKCS#8 v1 PrivateKeyInfo

Described in RFC 5208 Section 5:

PrivateKeyInfo ::= SEQUENCE {
        version                   Version,
        privateKeyAlgorithm       PrivateKeyAlgorithmIdentifier,
        privateKey                PrivateKey,
        attributes           [0]  IMPLICIT Attributes OPTIONAL }

Version ::= INTEGER

PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier

PrivateKey ::= OCTET STRING

Attributes ::= SET OF Attribute

PKCS#8 v2 OneAsymmetricKey

PKCS#8 OneAsymmetricKey as described in RFC 5958 Section 2:

PrivateKeyInfo ::= OneAsymmetricKey

OneAsymmetricKey ::= SEQUENCE {
    version                   Version,
    privateKeyAlgorithm       PrivateKeyAlgorithmIdentifier,
    privateKey                PrivateKey,
    attributes            [0] Attributes OPTIONAL,
    ...,
    [[2: publicKey        [1] PublicKey OPTIONAL ]],
    ...
  }

Version ::= INTEGER { v1(0), v2(1) } (v1, ..., v2)

PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier

PrivateKey ::= OCTET STRING

Attributes ::= SET OF Attribute

PublicKey ::= BIT STRING

Fields

algorithm: AlgorithmIdentifier<Params>

X.509 AlgorithmIdentifier for the private key type.

private_key: Key

Private key data. Exact content format is different between algorithms.

public_key: Option<PubKey>

Public key data, optionally available if version is V2.

Implementations

impl<Params, Key, PubKey> PrivateKeyInfo<Params, Key, PubKey>

pub fn new(algorithm: AlgorithmIdentifier<Params>, private_key: Key) -> Self

Create a new PKCS#8 PrivateKeyInfo message.

This is a helper method which initializes attributes and public_key to None, helpful if you aren’t using those.

pub fn version(&self) -> Version

Get the PKCS#8 Version for this structure.

Version::V1 if public_key is None, Version::V2 if Some.

impl<'a, Params, Key, PubKey> PrivateKeyInfo<Params, Key, PubKey>

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a + EncodeValue, PubKey: DecodeValue<'a, Error = Error> + FixedTag + 'a + BitStringLike,

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

Available on crate feature getrandom only.

Encrypt this private key using an encryption key derived from the provided password.

Uses the following algorithms for encryption:

• PBKDF: scrypt with default parameters:
  • log₂(N): 15
  • r: 8
  • p: 1
• Cipher: AES-256-CBC (best available option for PKCS#5 encryption)

Errors

• Propagates errors from calling Encode::to_der on Self.
• Returns errors in the event encryption failed.

pub fn encrypt_with_rng<R: TryCryptoRng>( &self, rng: &mut R, password: impl AsRef<[u8]>, ) -> Result<SecretDocument>

Available on crate feature encryption only.

Encrypt this private key using an encryption key derived from the provided password.

This function allows the RNG used to derive the salt/IV to be specified directly.

Errors

• Propagates errors from calling Encode::to_der on Self.
• Returns errors in the event encryption failed.

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

Available on crate feature encryption only.

Encrypt this private key using a symmetric encryption key derived from the provided password and pbes2::Parameters.

Errors

• Propagates errors from calling Encode::to_der on Self.
• Returns errors in the event encryption failed.

Trait Implementations

impl<Params: Clone, Key: Clone, PubKey: Clone> Clone for PrivateKeyInfo<Params, Key, PubKey>

fn clone(&self) -> PrivateKeyInfo<Params, Key, PubKey>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Params, Key, PubKey> CtEq for PrivateKeyInfo<Params, Key, PubKey>

where Params: Eq, Key: PartialEq + AsRef<[u8]>, PubKey: PartialEq,

Available on crate feature ctutils only.

fn ct_eq(&self, other: &Self) -> Choice

Determine if self is equal to other in constant-time.

fn ct_ne(&self, other: &Rhs) -> Choice

Determine if self is NOT equal to other in constant-time.

impl<Params, Key, PubKey> Debug for PrivateKeyInfo<Params, Key, PubKey>

where Params: Debug, PubKey: Debug,

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

Formats the value using the given formatter.

impl<'a, Params, Key, PubKey> DecodeValue<'a> for PrivateKeyInfo<Params, Key, PubKey>

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a, PubKey: 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.

impl<'a, Params, Key, PubKey> EncodeValue for PrivateKeyInfo<Params, Key, PubKey>

where Params: Choice<'a, Error = Error> + Encode, Key: EncodeValue + FixedTag, PubKey: BitStringLike,

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

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

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

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

fn header(&self) -> Result<Header, Error>

where Self: Tagged,

Get the Header used to encode this value.

impl<Params, Key, PubKey> PartialEq for PrivateKeyInfo<Params, Key, PubKey>

where Params: Eq, Key: PartialEq + AsRef<[u8]>, PubKey: PartialEq,

Available on crate feature ctutils only.

fn eq(&self, other: &Self) -> bool

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

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<Params, Key, PubKey> PemLabel for PrivateKeyInfo<Params, Key, PubKey>

Available on crate feature pem only.

const PEM_LABEL: &'static str = "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, Params, Key, PubKey> TryFrom<&'a [u8]> for PrivateKeyInfo<Params, Key, PubKey>

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a + EncodeValue, PubKey: DecodeValue<'a, Error = Error> + FixedTag + 'a + BitStringLike,

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, Params, Key, PubKey> TryFrom<&PrivateKeyInfo<Params, Key, PubKey>> for SecretDocument

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a + EncodeValue, PubKey: DecodeValue<'a, Error = Error> + FixedTag + 'a + BitStringLike,

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( private_key: &PrivateKeyInfo<Params, Key, PubKey>, ) -> Result<SecretDocument>

Performs the conversion.

impl<'a, Params, Key, PubKey> TryFrom<PrivateKeyInfo<Params, Key, PubKey>> for SecretDocument

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a + EncodeValue, PubKey: DecodeValue<'a, Error = Error> + FixedTag + 'a + BitStringLike,

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( private_key: PrivateKeyInfo<Params, Key, PubKey>, ) -> Result<SecretDocument>

Performs the conversion.

impl<Params, Key, PubKey> Eq for PrivateKeyInfo<Params, Key, PubKey>

where Params: Eq, Key: AsRef<[u8]> + Eq, PubKey: Eq,

Available on crate feature ctutils only.

impl<'a, Params, Key, PubKey> Sequence<'a> for PrivateKeyInfo<Params, Key, PubKey>

where Params: Choice<'a, Error = Error> + Encode, Key: DecodeValue<'a, Error = Error> + FixedTag + 'a + EncodeValue, PubKey: DecodeValue<'a, Error = Error> + FixedTag + 'a + BitStringLike,