Struct pkcs1::RsaPrivateKey

source ·
pub struct RsaPrivateKey<'a> {
    pub modulus: UintRef<'a>,
    pub public_exponent: UintRef<'a>,
    pub private_exponent: UintRef<'a>,
    pub prime1: UintRef<'a>,
    pub prime2: UintRef<'a>,
    pub exponent1: UintRef<'a>,
    pub exponent2: UintRef<'a>,
    pub coefficient: UintRef<'a>,
    pub other_prime_infos: Option<OtherPrimeInfos<'a>>,
}
Expand description

PKCS#1 RSA Private Keys as defined in RFC 8017 Appendix 1.2.

ASN.1 structure containing a serialized RSA private key:

RSAPrivateKey ::= SEQUENCE {
    version           Version,
    modulus           INTEGER,  -- n
    publicExponent    INTEGER,  -- e
    privateExponent   INTEGER,  -- d
    prime1            INTEGER,  -- p
    prime2            INTEGER,  -- q
    exponent1         INTEGER,  -- d mod (p-1)
    exponent2         INTEGER,  -- d mod (q-1)
    coefficient       INTEGER,  -- (inverse of q) mod p
    otherPrimeInfos   OtherPrimeInfos OPTIONAL
}

Note: the version field is selected automatically based on the absence or presence of the other_prime_infos field.

Fields§

§modulus: UintRef<'a>

n: RSA modulus.

§public_exponent: UintRef<'a>

e: RSA public exponent.

§private_exponent: UintRef<'a>

d: RSA private exponent.

§prime1: UintRef<'a>

p: first prime factor of n.

§prime2: UintRef<'a>

q: Second prime factor of n.

§exponent1: UintRef<'a>

First exponent: d mod (p-1).

§exponent2: UintRef<'a>

Second exponent: d mod (q-1).

§coefficient: UintRef<'a>

CRT coefficient: (inverse of q) mod p.

§other_prime_infos: Option<OtherPrimeInfos<'a>>

Additional primes r_3, …, r_u, in order, if this is a multi-prime RSA key (i.e. version is multi).

Implementations§

source§

impl<'a> RsaPrivateKey<'a>

source

pub fn public_key(&self) -> RsaPublicKey<'a>

Get the public key that corresponds to this RsaPrivateKey.

source

pub fn version(&self) -> Version

Get the Version for this key.

Determined by the presence or absence of the RsaPrivateKey::other_prime_infos field.

Trait Implementations§

source§

impl<'a> Clone for RsaPrivateKey<'a>

source§

fn clone(&self) -> RsaPrivateKey<'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
source§

impl Debug for RsaPrivateKey<'_>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> DecodeValue<'a> for RsaPrivateKey<'a>

source§

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

Attempt to decode this message using the provided Reader.
source§

impl EncodeValue for RsaPrivateKey<'_>

source§

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

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

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

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

fn header(&self) -> Result<Header, Error>where Self: Tagged,

Get the Header used to encode this value.
source§

impl<'a> From<&RsaPrivateKey<'a>> for RsaPublicKey<'a>

source§

fn from(private_key: &RsaPrivateKey<'a>) -> RsaPublicKey<'a>

Converts to this type from the input type.
source§

impl<'a> From<RsaPrivateKey<'a>> for RsaPublicKey<'a>

source§

fn from(private_key: RsaPrivateKey<'a>) -> RsaPublicKey<'a>

Converts to this type from the input type.
source§

impl PemLabel for RsaPrivateKey<'_>

Available on crate feature pem only.
source§

const PEM_LABEL: &'static str = "RSA 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.
source§

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

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl TryFrom<&RsaPrivateKey<'_>> for SecretDocument

Available on crate feature alloc only.
§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(private_key: &RsaPrivateKey<'_>) -> Result<SecretDocument>

Performs the conversion.
source§

impl TryFrom<RsaPrivateKey<'_>> for SecretDocument

Available on crate feature alloc only.
§

type Error = Error

The type returned in the event of a conversion error.
source§

fn try_from(private_key: RsaPrivateKey<'_>) -> Result<SecretDocument>

Performs the conversion.
source§

impl<'a> Sequence<'a> for RsaPrivateKey<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for RsaPrivateKey<'a>

§

impl<'a> Send for RsaPrivateKey<'a>

§

impl<'a> Sync for RsaPrivateKey<'a>

§

impl<'a> Unpin for RsaPrivateKey<'a>

§

impl<'a> UnwindSafe for RsaPrivateKey<'a>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

fn can_decode(tag: Tag) -> bool

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

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

source§

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

Attempt to decode this message using the provided decoder.
source§

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

Parse Self from the provided DER-encoded byte slice.
source§

impl<T> DecodePem for Twhere T: DecodeOwned + PemLabel,

source§

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

Try to decode this type from PEM.
source§

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

source§

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

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

source§

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

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

source§

fn encode_to_slice<'a>(&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.
source§

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

Available on crate feature alloc only.
Encode this message as ASN.1 DER, appending it to the provided byte vector.
source§

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

Available on crate feature alloc only.
Encode this type as DER, returning a byte vector.
source§

impl<T> EncodePem for Twhere T: Encode + PemLabel,

source§

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

Try to encode this type as PEM.
source§

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

source§

const TAG: Tag = Tag::Sequence

ASN.1 tag
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

source§

impl<T> Tagged for Twhere T: FixedTag,

source§

fn tag(&self) -> Tag

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

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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