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

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_with_rng<R>( &self, rng: &mut R, password: impl AsRef<[u8]>, ) -> Result<SecretDocument, Error>

where R: TryCryptoRng,

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

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

where Params: Clone, Key: Clone, PubKey: Clone,

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

where Params: Debug, PubKey: Debug,

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

Formats the value using the given formatter.

impl DecodePrivateKey for PrivateKeyInfo<Any, OctetString, BitString>

fn from_pkcs8_der( bytes: &[u8], ) -> Result<PrivateKeyInfo<Any, OctetString, BitString>, Error>

Deserialize PKCS#8 private key from ASN.1 DER-encoded data (binary format).

fn from_pkcs8_pem( pem: &str, ) -> Result<PrivateKeyInfo<Any, OctetString, BitString>, Error>

Deserialize PKCS#8-encoded private key from PEM.

fn from_pkcs8_encrypted_der( bytes: &[u8], password: impl AsRef<[u8]>, ) -> Result<Self, Error>

Deserialize encrypted PKCS#8 private key from ASN.1 DER-encoded data (binary format) and attempt to decrypt it using the provided password.

fn from_pkcs8_encrypted_pem( s: &str, password: impl AsRef<[u8]>, ) -> Result<Self, Error>

Deserialize encrypted PKCS#8-encoded private key from PEM and attempt to decrypt it using the provided password.

fn read_pkcs8_der_file(path: impl AsRef<Path>) -> Result<Self, Error>

Load PKCS#8 private key from an ASN.1 DER-encoded file (binary format) on the local filesystem.

fn read_pkcs8_pem_file(path: impl AsRef<Path>) -> Result<Self, Error>

Load PKCS#8 private key from a PEM-encoded file on the local filesystem.

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: &mut R, _header: Header, ) -> Result<PrivateKeyInfo<Params, Key, PubKey>, Error>

where R: Reader<'a>,

Attempt to decode this value using the provided Reader.

impl EncodePrivateKey for PrivateKeyInfo<Any, OctetString, BitString>

fn to_pkcs8_der(&self) -> Result<SecretDocument, Error>

Serialize a SecretDocument containing a PKCS#8-encoded private key.

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

Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.

fn write_pkcs8_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write ASN.1 DER-encoded PKCS#8 private key to the given path.

fn write_pkcs8_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding, ) -> Result<(), Error>

Write ASN.1 PEM-encoded PKCS#8 private key to the given path.

impl EncodePrivateKey for PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>

fn to_pkcs8_der(&self) -> Result<SecretDocument, Error>

Serialize a SecretDocument containing a PKCS#8-encoded private key.

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

Serialize this private key as PEM-encoded PKCS#8 with the given LineEnding.

fn write_pkcs8_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write ASN.1 DER-encoded PKCS#8 private key to the given path.

fn write_pkcs8_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding, ) -> Result<(), Error>

Write ASN.1 PEM-encoded PKCS#8 private key to the given path.

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

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<(), Error>

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 OwnedToRef for PrivateKeyInfo<Any, OctetString, BitString>

type Borrowed<'a> = PrivateKeyInfo<AnyRef<'a>, &'a OctetStringRef, BitStringRef<'a>>

The resulting type referencing back to Self

fn owned_to_ref( &self, ) -> <PrivateKeyInfo<Any, OctetString, BitString> as OwnedToRef>::Borrowed<'_>

Creates a new object referencing back to the self for storage

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> RefToOwned<'a> for PrivateKeyInfo<AnyRef<'a>, &'a OctetStringRef, BitStringRef<'a>>

type Owned = PrivateKeyInfo<Any, OctetString, BitString>

The resulting type after obtaining ownership.

fn ref_to_owned( &self, ) -> <PrivateKeyInfo<AnyRef<'a>, &'a OctetStringRef, BitStringRef<'a>> as RefToOwned<'a>>::Owned

Creates a new object taking ownership of the data

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,

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

Performs the conversion.

impl<C> TryFrom<PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>> for SecretKey<C>

where C: AssociatedOid + Curve + ValidatePublicKey, <C as Curve>::FieldBytesSize: ModulusSize,

type Error = Error

The type returned in the event of a conversion error.

fn try_from( private_key_info: PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>, ) -> Result<SecretKey<C>, Error>

Performs the conversion.

impl<D> TryFrom<PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>> for SigningKey<D>

where D: Digest + AssociatedOid,

Available on crate feature encoding only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( private_key_info: PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>, ) -> Result<SigningKey<D>, Error>

Performs the conversion.

impl TryFrom<PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>> for RsaPrivateKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from( private_key_info: PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>, ) -> Result<RsaPrivateKey, Error>

Performs the conversion.

impl<C> TryFrom<PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>> for SigningKey<C>

where C: EcdsaCurve + AssociatedOid + CurveArithmetic, <C as CurveArithmetic>::AffinePoint: FromSec1Point<C> + ToSec1Point<C>, <C as Curve>::FieldBytesSize: ModulusSize, <C as CurveArithmetic>::Scalar: Invert<Output = CtOption<<C as CurveArithmetic>::Scalar>>,

Available on crate feature pkcs8 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from( private_key_info: PrivateKeyInfo<AnyRef<'_>, &OctetStringRef, BitStringRef<'_>>, ) -> Result<SigningKey<C>, Error>

Performs the conversion.