Struct rsa::RsaPrivateKey

pub struct RsaPrivateKey { /* private fields */ }

Represents a whole RSA key, public and private parts.

Implementations

impl RsaPrivateKey

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

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

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

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>

Constructs an RSA key pair from the individual components.

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

Performs some calculations to speed up private key operations.

pub fn clear_precomputed(&mut self)

Clears precomputed values by setting to None

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

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

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

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

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

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

pub fn d(&self) -> &BigUint

Returns the private exponent of the key.

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

Returns the prime factors.

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

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>( &self, padding: P, ciphertext: &[u8] ) -> Result<Vec<u8>>

Decrypt the given message.

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

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

Sign the given digest.

pub fn sign_with_rng<R: CryptoRngCore, S: SignatureScheme>( &self, rng: &mut R, padding: S, digest_in: &[u8] ) -> Result<Vec<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 for a standard RSASSA-PSS signature, or Pss::new_blinded for RSA-BSSA blind signatures.

Methods from Deref<Target = RsaPublicKey>

pub const MIN_PUB_EXPONENT: u64 = 2u64

pub const MAX_PUB_EXPONENT: u64 = 8_589_934_591u64

pub const MAX_SIZE: usize = 4_096usize

Trait Implementations

impl<D> AsRef<RsaPrivateKey> for BlindedSigningKey<D>where D: Digest,

fn as_ref(&self) -> &RsaPrivateKey

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

impl<D> AsRef<RsaPrivateKey> for SigningKey<D>where D: Digest,

fn as_ref(&self) -> &RsaPrivateKey

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

impl<D> AsRef<RsaPrivateKey> for SigningKey<D>where D: Digest,

fn as_ref(&self) -> &RsaPrivateKey

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

Formats the value using the given formatter.

impl DecodePrivateKey for RsaPrivateKey

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

Deserialize PKCS#8 private key from ASN.1 DER-encoded data (binary format).

fn from_pkcs8_pem(s: &str) -> Result<Self, Error>

Deserialize PKCS#8-encoded private key from PEM.

fn read_pkcs8_der_file(path: impl AsRef<Path>) -> Result<Self, Error>

Load PKCS#8 private key from an ASN.1 DER-encoded file on the local filesystem (binary format).

fn read_pkcs8_pem_file(path: impl AsRef<Path>) -> Result<Self, Error>

Load PKCS#8 private key from a PEM-encoded file on the local filesystem.

impl Deref for RsaPrivateKey

type Target = RsaPublicKey

The resulting type after dereferencing.

fn deref(&self) -> &RsaPublicKey

Dereferences the value.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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>

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

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

Serialize this private key as PEM-encoded PKCS#8 with the given [LineEnding].

fn write_pkcs8_der_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write ASN.1 DER-encoded PKCS#8 private key to the given path

fn write_pkcs8_pem_file( &self, path: impl AsRef<Path>, line_ending: LineEnding ) -> Result<(), Error>

Write ASN.1 DER-encoded PKCS#8 private key to the given path

impl From<&RsaPrivateKey> for RsaPublicKey

fn from(private_key: &RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<D> From<BlindedSigningKey<D>> for RsaPrivateKeywhere D: Digest,

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

Converts to this type from the input type.

impl<D> From<RsaPrivateKey> for BlindedSigningKey<D>where D: Digest,

fn from(key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl From<RsaPrivateKey> for RsaPublicKey

fn from(private_key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<D> From<RsaPrivateKey> for SigningKey<D>where D: Digest,

fn from(key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<D> From<RsaPrivateKey> for SigningKey<D>where D: Digest,

fn from(key: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl<D> From<SigningKey<D>> for RsaPrivateKeywhere D: Digest,

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

Converts to this type from the input type.

impl<D> From<SigningKey<D>> for RsaPrivateKeywhere D: Digest,

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

Converts to this type from the input type.

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

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

Performs the conversion.

impl Zeroize for RsaPrivateKey

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