Struct rsa::RsaPrivateKey

pub struct RsaPrivateKey { /* private fields */ }

Represents a whole RSA key, public and private parts.

Implementations

impl RsaPrivateKey

pub fn new<R: RngCore + CryptoRng>(
    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: RngCore + CryptoRng>(
    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>
) -> 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 occationally 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 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 approriate error.

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

Decrypt the given message.

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

Decrypt the given message.

Uses rng to blind the decryption process.

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

Sign the given digest.

pub fn sign_blinded<R: RngCore + CryptoRng>(
    &self,
    rng: &mut R,
    padding: PaddingScheme,
    digest_in: &[u8]
) -> Result<Vec<u8>>

Sign the given digest.

Use rng for blinding.

Trait Implementations

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_doc(doc: &PrivateKeyDocument) -> Result<Self, Error>

Deserialize PKCS#8 private key from a PrivateKeyDocument.

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

Serialize a PrivateKeyDocument 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 From<RsaPrivateKey> for RsaPublicKey

fn from(private_key: RsaPrivateKey) -> 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 !=.

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<'a> PublicKeyParts for &'a 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