Struct jwt_compact::alg::RsaPrivateKey

pub struct RsaPrivateKey { /* private fields */ }

Available on crate feature rsa only.

Represents a whole RSA key, public and private parts.

Implementations

impl RsaPrivateKey

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

where R: CryptoRngCore + ?Sized,

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

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

where R: CryptoRngCore + ?Sized,

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: BigUint, e: BigUint, d: BigUint, primes: Vec<BigUint>, ) -> Result<RsaPrivateKey, Error>

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

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<BigUint>, public_exponent: BigUint, ) -> Result<RsaPrivateKey, Error>

Constructs an RSA key pair from its primes.

This will rebuild the private exponent and the modulus.

pub fn to_public_key(&self) -> RsaPublicKey

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

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

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

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

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

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

where P: PaddingScheme,

Decrypt the given message.

pub fn decrypt_blinded<R, P>( &self, rng: &mut R, padding: P, ciphertext: &[u8], ) -> Result<Vec<u8>, Error>

where R: CryptoRngCore, P: PaddingScheme,

Decrypt the given message.

Uses rng to blind the decryption process.

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

where S: SignatureScheme,

Sign the given digest.

pub fn sign_with_rng<R, S>( &self, rng: &mut R, padding: S, digest_in: &[u8], ) -> Result<Vec<u8>, Error>

where R: CryptoRngCore, S: SignatureScheme,

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 AsRef<RsaPublicKey> for RsaPrivateKey

fn as_ref(&self) -> &RsaPublicKey

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

impl Clone for RsaPrivateKey

fn clone(&self) -> RsaPrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RsaPrivateKey

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

Formats the value using the given formatter.

impl Drop for RsaPrivateKey

fn drop(&mut self)

Executes the destructor for this type.

impl EncodePrivateKey for RsaPrivateKey

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

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

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

⚠ Warning. Contrary to RFC 7518, this implementation does not set dp, dq, and qi fields in the JWK root object, as well as d and t fields for additional factors (i.e., in the oth array).

fn from(key: &'a RsaPrivateKey) -> JsonWebKey<'a>

Converts to this type from the input type.

impl From<&RsaPrivateKey> for RsaPublicKey

fn from(private_key: &RsaPrivateKey) -> RsaPublicKey

Converts to this type from the input type.

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

where D: Digest,

fn from(key: BlindedSigningKey<D>) -> RsaPrivateKey

Converts to this type from the input type.

impl From<RsaPrivateKey> for RsaPublicKey

fn from(private_key: RsaPrivateKey) -> RsaPublicKey

Converts to this type from the input type.

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

where D: Digest,

fn from(key: SigningKey<D>) -> RsaPrivateKey

Converts to this type from the input type.

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

where D: Digest,

fn from(key: SigningKey<D>) -> RsaPrivateKey

Converts to this type from the input type.

impl Hash for RsaPrivateKey

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

where H: Hasher,

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 PartialEq for RsaPrivateKey

fn eq(&self, other: &RsaPrivateKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PrivateKeyParts for RsaPrivateKey

fn d(&self) -> &BigUint

Returns the private exponent of the key.

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

Returns the prime factors.

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

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

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

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

fn qinv(&self) -> Option<&BigInt>

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

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

Returns an iterator over the CRT Values

impl PublicKeyParts for RsaPrivateKey

fn n(&self) -> &BigUint

Returns the modulus of the key.

fn e(&self) -> &BigUint

Returns the public exponent of the key.

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.

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

⚠ Warning. Contrary to RFC 7518 (at least, in spirit), this conversion ignores dp, dq, and qi fields from JWK, as well as d and t fields for additional factors.

type Error = JwkError

The type returned in the event of a conversion error.

fn try_from(jwk: &JsonWebKey<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<PrivateKeyInfo<'_>> for RsaPrivateKey

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<RsaPrivateKey> for StrongKey<RsaPrivateKey>

type Error = WeakKeyError<RsaPrivateKey>

The type returned in the event of a conversion error.

fn try_from(key: RsaPrivateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for RsaPrivateKey

impl ZeroizeOnDrop for RsaPrivateKey