Skip to main content

RsaPrivateKey

pkcs1::private_key

Struct RsaPrivateKey

pub struct RsaPrivateKey<U> {
    pub modulus: U,
    pub public_exponent: U,
    pub private_exponent: U,
    pub prime1: U,
    pub prime2: U,
    pub exponent1: U,
    pub exponent2: U,
    pub coefficient: U,
    pub other_prime_infos: Option<OtherPrimeInfos<U>>,
}

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
}

OtherPrimeInfos ::= SEQUENCE SIZE(1..MAX) OF OtherPrimeInfo

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

Fields§

§modulus: U

n: RSA modulus.

§public_exponent: U

e: RSA public exponent.

§private_exponent: U

d: RSA private exponent.

§prime1: U

p: first prime factor of n.

§prime2: U

q: Second prime factor of n.

§exponent1: U

First exponent: d mod (p-1).

§exponent2: U

Second exponent: d mod (q-1).

§coefficient: U

CRT coefficient: (inverse of q) mod p.

§other_prime_infos: Option<OtherPrimeInfos<U>>

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

Implementations§

impl<U> RsaPrivateKey<U>
where U: AsUintRef,

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

Get the public key that corresponds to this RsaPrivateKey.

impl<U> RsaPrivateKey<U>

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§

impl<U: Clone> Clone for RsaPrivateKey<U>

fn clone(&self) -> RsaPrivateKey<U>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<U> Debug for RsaPrivateKey<U>
where U: Debug,

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

Formats the value using the given formatter. Read more

impl<'a, U> DecodeValue<'a> for RsaPrivateKey<U>
where U: Decode<'a, Error = Error>,

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<U> EncodeValue for RsaPrivateKey<U>
where U: Encode,

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<'a, U> From<&'a RsaPrivateKey<U>> for RsaPublicKeyRef<'a>
where U: AsUintRef,

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

Converts to this type from the input type.

impl<U> PemLabel for RsaPrivateKey<U>

Available on crate feature pem only.

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.

impl<'a, U> TryFrom<&'a [u8]> for RsaPrivateKey<U>
where U: Decode<'a, Error = Error>,

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, U> TryFrom<&'a OctetStringRef> for RsaPrivateKey<U>
where U: Decode<'a, Error = Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &'a OctetStringRef) -> Result<Self>

Performs the conversion.

impl<U> TryFrom<&RsaPrivateKey<U>> for SecretDocument
where U: Encode,

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<U> TryFrom<RsaPrivateKey<U>> for SecretDocument
where U: Encode,

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<U> Sequence<'_> for RsaPrivateKey<U>

Auto Trait Implementations§

impl<U> Freeze for RsaPrivateKey<U>
where U: Freeze,

impl<U> RefUnwindSafe for RsaPrivateKey<U>
where U: RefUnwindSafe,

impl<U> Send for RsaPrivateKey<U>
where U: Send,

impl<U> Sync for RsaPrivateKey<U>
where U: Sync,

impl<U> Unpin for RsaPrivateKey<U>
where U: Unpin,

impl<U> UnsafeUnpin for RsaPrivateKey<U>
where U: UnsafeUnpin,

impl<U> UnwindSafe for RsaPrivateKey<U>
where U: 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>

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>

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