Struct rsa::RsaPrivateKey

pub struct RsaPrivateKey { /* fields omitted */ }

Represents a whole RSA key, public and private parts.

Implementations

impl RsaPrivateKey

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

This is supported on crate feature alloc only.

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

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

This is supported on crate feature alloc 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 from_components(
    n: BigUint,
    e: BigUint,
    d: BigUint,
    primes: Vec<BigUint>
) -> RsaPrivateKey

This is supported on crate feature alloc only.

Constructs an RSA key pair from the individual components.

pub fn to_public_key(&self) -> RsaPublicKey

This is supported 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 occationally be useful to discard the private information entirely.

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

This is supported on crate feature alloc only.

Performs some calculations to speed up private key operations.

pub fn d(&self) -> &BigUint

This is supported on crate feature alloc only.

Returns the private exponent of the key.

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

This is supported on crate feature alloc only.

Returns the prime factors.

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

This is supported on crate feature alloc only.

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

This is supported on crate feature alloc only.

Decrypt the given message.

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

This is supported on crate feature alloc only.

Decrypt the given message.

Uses rng to blind the decryption process.

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

This is supported on crate feature alloc only.

Sign the given digest.

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

This is supported on crate feature alloc only.

Sign the given digest.

Use rng for blinding.

Methods from Deref<Target = RsaPublicKey>

Trait Implementations

impl Clone for RsaPrivateKey

This is supported on crate feature alloc only.

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

This is supported on crate feature alloc only.

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

Formats the value using the given formatter.

impl Deref for RsaPrivateKey

This is supported on crate feature alloc only.

type Target = RsaPublicKey

The resulting type after dereferencing.

fn deref(&self) -> &RsaPublicKey

Dereferences the value.

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

This is supported on crate feature alloc only.

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

This is supported on crate feature alloc only.

fn drop(&mut self)

Executes the destructor for this type.

impl From<&'_ RsaPrivateKey> for RsaPublicKey

This is supported on crate feature alloc only.

fn from(private_key: &RsaPrivateKey) -> Self

Performs the conversion.

impl From<RsaPrivateKey> for RsaPublicKey

This is supported on crate feature alloc only.

fn from(private_key: RsaPrivateKey) -> Self

Performs the conversion.

impl FromRsaPrivateKey for RsaPrivateKey

This is supported on crate feature alloc only.

fn from_pkcs1_private_key(pkcs1_key: RsaPrivateKey<'_>) -> Result<Self>

Parse the RsaPrivateKey from a PKCS#1-encoded document.

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

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

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

Deserialize PKCS#1-encoded private key from PEM.

fn read_pkcs1_der_file(path: &Path) -> Result<Self, Error>

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

fn read_pkcs1_pem_file(path: &Path) -> Result<Self, Error>

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

impl PartialEq<RsaPrivateKey> for RsaPrivateKey

This is supported on crate feature alloc only.

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

This is supported on crate feature alloc only.

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

This is supported on crate feature alloc only.

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

This is supported on crate feature alloc only.

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

Serialize this value into the given Serde serializer.

impl ToRsaPrivateKey for RsaPrivateKey

This is supported on crate feature alloc only.

fn to_pkcs1_der(&self) -> Result<RsaPrivateKeyDocument>

Serialize a RsaPrivateKeyDocument containing a PKCS#1-encoded private key.

fn to_pkcs1_pem(&self) -> Result<Zeroizing<String>, Error>

Serialize this private key as PEM-encoded PKCS#1.

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

Serialize this private key as PEM-encoded PKCS#1 with the given LineEnding.

fn write_pkcs1_der_file(&self, path: &Path) -> Result<(), Error>

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

fn write_pkcs1_pem_file(&self, path: &Path) -> Result<(), Error>

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

impl Zeroize for RsaPrivateKey

This is supported on crate feature alloc only.

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

This is supported on crate feature alloc only.