Struct RsaPrivateKey

pub struct RsaPrivateKey<T>
where
    T: UnsignedModularInt,
{ /* private fields */ }

Represents a whole RSA key, public and private parts.

Implementations

impl<T: UnsignedModularInt> RsaPrivateKey<T>

pub fn new<R: CryptoRngCore>( rng: &mut R, bit_size: usize, ) -> Result<RsaPrivateKey<T>>

Generate a new Rsa key pair of the given bit size using the passed in rng.

pub fn new_with_exp<R: CryptoRngCore>( rng: &mut R, bit_size: usize, exp: T, ) -> Result<RsaPrivateKey<T>>

Generate a new RSA key pair of the given bit size and the public exponent using the passed in rng.

Unless you have specific needs, you should use RsaPrivateKey::new instead.

pub fn from_components(n: T, e: T, d: T, primes: [T; 4]) -> Result<Self>

Constructs an RSA key pair from individual components:

• n: RSA modulus
• e: public exponent (i.e. encrypting exponent)
• d: private exponent (i.e. decrypting exponent)
• primes: prime factors of n: typically two primes p and q. More than two primes can be provided for multiprime RSA, however this is generally not recommended. If no primes are provided, a prime factor recovery algorithm will be employed to attempt to recover the factors (as described in NIST SP 800-56B Revision 2 Appendix C.2). This algorithm only works if there are just two prime factors p and q (as opposed to multiprime), and e is between 2^16 and 2^256.

pub fn from_p_q(p: T, q: T, public_exponent: T) -> Result<Self>

Constructs an RSA key pair from its two primes p and q.

This will rebuild the private exponent and the modulus.

Private exponent will be rebuilt using the method defined in NIST 800-56B Section 6.2.1.

pub fn from_primes(primes: [T; 4], public_exponent: T) -> Result<Self>

Constructs an RSA key pair from its primes.

This will rebuild the private exponent and the modulus.

pub fn to_public_key(&self) -> RsaPublicKey<T>

Get the public key from the private key, cloning n and e.

Generally this is not needed since RsaPrivateKey implements the PublicKey trait, but it can occasionally be useful to discard the private information entirely.

pub fn precompute(&mut self) -> Result<()>

Performs some calculations to speed up private key operations.

pub fn clear_precomputed(&mut self)

Clears precomputed values by setting to None

pub fn crt_coefficient(&self) -> Option<T>

Compute CRT coefficient: (1/q) mod p.

pub fn validate(&self) -> Result<()>

Performs basic sanity checks on the key. Returns Ok(()) if everything is good, otherwise an appropriate error.

pub fn decrypt<P: PaddingScheme<T>>( &self, padding: P, ciphertext: &[u8], storage: &mut [u8], ) -> Result<&[u8]>

Decrypt the given message.

pub fn decrypt_blinded<R: CryptoRngCore, P: PaddingScheme<T>>( &self, rng: &mut R, padding: P, ciphertext: &[u8], storage: &mut [u8], ) -> Result<&[u8]>

Decrypt the given message.

Uses rng to blind the decryption process.

pub fn sign<S: SignatureScheme<T>>( &self, padding: S, digest_in: &[u8], storage: &mut [u8], ) -> Result<&[u8]>

Sign the given digest.

pub fn sign_with_rng<R: CryptoRngCore, S: SignatureScheme<T>>( &self, rng: &mut R, padding: S, digest_in: &[u8], storage: &mut [u8], ) -> Result<&[u8]>

Sign the given digest using the provided rng, which is used in the following ways depending on the SignatureScheme:

• Pkcs1v15Sign padding: uses the RNG to mask the private key operation with random blinding, which helps mitigate sidechannel attacks.
• Pss always requires randomness. Use [Pss::new][crate::Pss::new] for a standard RSASSA-PSS signature, or [Pss::new_blinded][crate::Pss::new_blinded] for RSA-BSSA blind signatures.

Trait Implementations

impl<D, T> AsRef<RsaPrivateKey<T>> for BlindedSigningKey<D, T>

where D: Digest, T: UnsignedModularInt,

fn as_ref(&self) -> &RsaPrivateKey<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<D, T> AsRef<RsaPrivateKey<T>> for SigningKey<D, T>

where T: UnsignedModularInt,

fn as_ref(&self) -> &RsaPrivateKey<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: UnsignedModularInt> AsRef<RsaPublicKey<T>> for RsaPrivateKey<T>

fn as_ref(&self) -> &RsaPublicKey<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for RsaPrivateKey<T>

where T: UnsignedModularInt + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for RsaPrivateKey<T>

where T: UnsignedModularInt + Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for RsaPrivateKey<T>

where T: UnsignedModularInt,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: UnsignedModularInt> Drop for RsaPrivateKey<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: UnsignedModularInt> From<&RsaPrivateKey<T>> for RsaPublicKey<T>

fn from(private_key: &RsaPrivateKey<T>) -> Self

Converts to this type from the input type.

impl<D, T> From<BlindedSigningKey<D, T>> for RsaPrivateKey<T>

where D: Digest, T: UnsignedModularInt,

fn from(key: BlindedSigningKey<D, T>) -> Self

Converts to this type from the input type.

impl<D, T> From<RsaPrivateKey<T>> for BlindedSigningKey<D, T>

where D: Digest, T: UnsignedModularInt,

fn from(key: RsaPrivateKey<T>) -> Self

Converts to this type from the input type.

impl<T: UnsignedModularInt> From<RsaPrivateKey<T>> for RsaPublicKey<T>

fn from(private_key: RsaPrivateKey<T>) -> Self

Converts to this type from the input type.

impl<D, T> From<RsaPrivateKey<T>> for SigningKey<D, T>

where T: UnsignedModularInt,

fn from(key: RsaPrivateKey<T>) -> Self

Converts to this type from the input type.

impl<D, T> From<SigningKey<D, T>> for RsaPrivateKey<T>

where T: UnsignedModularInt,

fn from(key: SigningKey<D, T>) -> Self

Converts to this type from the input type.

impl<T: UnsignedModularInt> Hash for RsaPrivateKey<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: UnsignedModularInt> PartialEq for RsaPrivateKey<T>

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<T: UnsignedModularInt> PrivateKeyParts<T> for RsaPrivateKey<T>

fn d(&self) -> &T

Returns the private exponent of the key.

fn primes(&self) -> &[T]

Returns the prime factors.

fn dp(&self) -> Option<&T>

Returns the precomputed dp value, D mod (P-1)

fn dq(&self) -> Option<&T>

Returns the precomputed dq value, D mod (Q-1)

fn qinv(&self) -> Option<&MontyForm<T>>

Returns the precomputed qinv value, Q^-1 mod P

fn crt_values(&self) -> Option<&[CrtValue<T>]>

Returns an iterator over the CRT Values

fn p_params(&self) -> Option<&MontyParams<T>>

Returns the params for p if precomupted.

fn q_params(&self) -> Option<&MontyParams<T>>

Returns the params for q if precomupted.

impl<T: UnsignedModularInt> PublicKeyParts<T> for RsaPrivateKey<T>

fn n(&self) -> &T

Returns the modulus of the key.

fn e(&self) -> &T

Returns the public exponent of the key.

fn n_params(&self) -> &MontyParams<T>

Returns the parameters for montgomery operations.

fn size(&self) -> usize

Returns the modulus size in bytes. Raw signatures and ciphertexts for or by this public key will have the same size.

fn n_bits_precision(&self) -> u32

Returns precision (in bits) of n.

impl<T> Serialize for RsaPrivateKey<T>

where T: UnsignedModularInt,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

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

where T: UnsignedModularInt,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(private_key_info: PrivateKeyInfoRef<'_>) -> Result<Self>

Performs the conversion.

impl<T: UnsignedModularInt> Eq for RsaPrivateKey<T>

impl<T: UnsignedModularInt> ZeroizeOnDrop for RsaPrivateKey<T>