Struct GenericRsaPrivateKey 

pub struct GenericRsaPrivateKey<T, M>
where
    T: UnsignedModularInt + Zeroize,
    M: ModulusParams<Modulus = T>,
{ /* private fields */ }

Generic RSA private key — heapless-compatible value type.

Holds the public components plus the secret exponent d — the raw (n, e, d) form. primes and the precomputed CRT values are alloc-gated; key generation is behind the keygen feature.

Implementations

impl<T, M> GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize + RawPrivateKeyConstructible, M: ModulusParams<Modulus = T>,

pub fn from_public_and_d( pubkey_components: GenericRsaPublicKey<T, M>, d: T, ) -> Self

Construct from an already-built public key and the private exponent d. No validation and no CRT precompute — the caller owns the e·d ≡ 1 mod λ(n) relationship. For validated keys use the alloc-side RsaPrivateKey::from_components.

impl<T, M> GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,

pub fn as_public(&self) -> &GenericRsaPublicKey<T, M>

Borrow the public-key components.

impl GenericRsaPrivateKey<BoxedUint, BoxedMontyParams>

pub fn new<R: CryptoRng + ?Sized>(rng: &mut R, bit_size: usize) -> Result<Self>

Available on crate features alloc and keygen only.

Generate a new RSA key pair with a modulus of the given bit size using the passed in rng.

Errors

• If bit_size is lower than the minimum 1024-bits.

pub fn new_unchecked<R: CryptoRng + ?Sized>( rng: &mut R, bit_size: usize, ) -> Result<Self>

Available on crate features alloc and hazmat and keygen only.

Generate a new RSA key pair of the given bit size.

#⚠️Warning: Hazmat! This version does not apply minimum key size checks, and as such may generate keys which are insecure!

pub fn new_with_exp<R: CryptoRng + ?Sized>( rng: &mut R, bit_size: usize, exp: BoxedUint, ) -> Result<RsaPrivateKey>

Available on crate features alloc and keygen only.

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 new_with_exp_unchecked<R: CryptoRng + ?Sized>( rng: &mut R, bit_size: usize, exp: BoxedUint, ) -> Result<RsaPrivateKey>

Available on crate features alloc and hazmat and keygen only.

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.

#⚠️Warning: Hazmat! This version does not apply minimum key size checks, and as such may generate keys which are insecure!

pub fn from_components_with_large_exponent( n: BoxedUint, e: BoxedUint, d: BoxedUint, primes: Vec<BoxedUint>, ) -> Result<RsaPrivateKey>

Available on crate features alloc and hazmat only.

Constructs an RSA key pair from individual components, accepting exponents outside the normal size bounds.

See RsaPrivateKey::from_components for an explanation on the parameters.

⚠️ Warning: Hazmat!

This method accepts public exponents outside the standard bounds (2 ≤ e ≤ 2^33-1), but still performs full cryptographic validation to ensure the key is mathematically correct (i.e., verifies that de ≡ 1 mod λ(n)).

Note: This method is dangerous as it can be used as a DOS vector if used with untrusted input https://www.imperialviolet.org/2012/03/17/rsados.html

This is intended for interoperating with systems that use non-standard exponents or loading legacy keys. Use RsaPrivateKey::from_components for standard key construction.

pub fn from_components( n: BoxedUint, e: BoxedUint, d: BoxedUint, primes: Vec<BoxedUint>, ) -> Result<RsaPrivateKey>

Available on crate feature alloc only.

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: BoxedUint, q: BoxedUint, public_exponent: BoxedUint, ) -> Result<RsaPrivateKey>

Available on crate feature alloc only.

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: Vec<BoxedUint>, public_exponent: BoxedUint, ) -> Result<RsaPrivateKey>

Available on crate feature alloc only.

Constructs an RSA key pair from its primes.

This will rebuild the private exponent and the modulus.

pub fn as_public_key(&self) -> &RsaPublicKey

Available on crate feature alloc only.

Get the public key from the private key.

Specific alternative to AsRef::as_ref.

pub fn to_public_key(&self) -> RsaPublicKey

Available on crate feature alloc only.

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

Available on crate feature alloc only.

Performs some calculations to speed up private key operations.

pub fn clear_precomputed(&mut self)

Available on crate feature alloc only.

Clears precomputed values by setting to None

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

Available on crate feature alloc only.

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

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

Available on crate feature alloc only.

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

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

Available on crate feature alloc only.

Decrypt the given message.

pub fn decrypt_blinded<R: CryptoRng + ?Sized, P: PaddingScheme>( &self, rng: &mut R, padding: P, ciphertext: &[u8], ) -> Result<Vec<u8>>

Available on crate feature alloc only.

Decrypt the given message.

Uses rng to blind the decryption process.

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

Available on crate feature alloc only.

Sign the given digest.

pub fn sign_with_rng<R: CryptoRng + ?Sized, S: SignatureScheme>( &self, rng: &mut R, padding: S, digest_in: &[u8], ) -> Result<Vec<u8>>

Available on crate feature alloc only.

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 for a standard RSASSA-PSS signature, or Pss::new_blinded for RSA-BSSA blind signatures.

Trait Implementations

impl<D> AsRef<GenericRsaPrivateKey<BoxedUint, BoxedMontyParams>> for BlindedSigningKey<D>

where D: Digest,

Available on crate feature alloc only.

fn as_ref(&self) -> &RsaPrivateKey

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

impl<D, T, M> AsRef<GenericRsaPrivateKey<T, M>> for GenericSigningKey<D, T, M>

where D: Digest, T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,

fn as_ref(&self) -> &GenericRsaPrivateKey<T, M>

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

impl<D, T, M> AsRef<GenericRsaPrivateKey<T, M>> for GenericSigningKey<D, T, M>

where D: Digest, T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,

fn as_ref(&self) -> &GenericRsaPrivateKey<T, M>

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

impl<T, M> Clone for GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize + Clone, M: ModulusParams<Modulus = T> + Clone, M::MontgomeryForm: Clone,

Available on crate feature alloc only.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, M> Debug for GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>, GenericRsaPublicKey<T, M>: Debug,

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

Formats the value using the given formatter.

impl<T, M> Drop for GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<&GenericRsaPrivateKey<BoxedUint, BoxedMontyParams>> for GenericRsaPublicKey<BoxedUint, BoxedMontyParams>

Available on crate feature alloc only.

fn from(private_key: &RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<D> From<GenericRsaPrivateKey<BoxedUint, BoxedMontyParams>> for SigningKey<D>

where D: Digest + AssociatedOid,

Available on crate feature alloc only.

fn from(key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<D> From<GenericRsaPrivateKey<BoxedUint, BoxedMontyParams>> for BlindedSigningKey<D>

where D: Digest,

Available on crate feature alloc only.

fn from(key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<D> From<GenericRsaPrivateKey<BoxedUint, BoxedMontyParams>> for SigningKey<D>

where D: Digest,

Available on crate feature alloc only.

fn from(key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl From<GenericRsaPrivateKey<BoxedUint, BoxedMontyParams>> for GenericRsaPublicKey<BoxedUint, BoxedMontyParams>

Available on crate feature alloc only.

fn from(private_key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<T, M> PrivateKeyParts<T> for GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,

fn d(&self) -> &T

Returns the private exponent of the key.

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

Available on crate feature alloc only.

Returns the prime factors of the modulus. Returns &[] for keys that don’t store factors.

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

Available on crate feature alloc only.

Returns the precomputed dp = d mod (p - 1) value, if available. None for keys that didn’t precompute CRT.

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

Available on crate feature alloc only.

Returns the precomputed dq = d mod (q - 1) value, if available.

fn qinv(&self) -> Option<&<Self::MontyParams as ModulusParams>::MontgomeryForm>

Available on crate feature alloc only.

Returns the precomputed qinv = q^-1 mod p value, if available.

fn p_params(&self) -> Option<&Self::MontyParams>

Available on crate feature alloc only.

Returns the Montgomery parameters for p, if available.

fn q_params(&self) -> Option<&Self::MontyParams>

Available on crate feature alloc only.

Returns the Montgomery parameters for q, if available.

impl<T, M> PublicKeyParts<T> for GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,

type MontyParams = M

Montgomery parameter type matching this modulus type.

fn n(&self) -> &NonZero<T>

Returns the modulus of the key.

fn e(&self) -> &T

Returns the public exponent of the key.

fn n_params(&self) -> &Self::MontyParams

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.

fn n_bytes(&self) -> Box<[u8]>

Available on crate feature alloc only.

Returns the big endian serialization of the modulus of the key

fn e_bytes(&self) -> Box<[u8]>

Available on crate feature alloc only.

Returns the big endian serialization of the public exponent of the key

impl<T, M> Zeroize for GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<T, M> ZeroizeOnDrop for GenericRsaPrivateKey<T, M>

where T: UnsignedModularInt + Zeroize, M: ModulusParams<Modulus = T>,