Struct jwt_compact::alg::RsaPrivateKey

pub struct RsaPrivateKey { /* fields omitted */ }

This is supported on crate feature with_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: Rng, 

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: Rng, 

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

Performs some calculations to speed up private key operations.

pub fn d(&self) -> &BigUint

Returns the private exponent of the key.

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

Returns the prime factors.

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

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, Global>, Error>

Decrypt the given message.

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

Decrypt the given message.

Uses rng to blind the decryption process.

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

Sign the given digest.

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

Sign the given digest.

Use rng for blinding.

Trait Implementations

impl Clone for RsaPrivateKey

pub 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

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

Formats the value using the given formatter.

impl Deref for RsaPrivateKey

type Target = RsaPublicKey

The resulting type after dereferencing.

pub fn deref(&self) -> &RsaPublicKey

Dereferences the value.

impl Drop for RsaPrivateKey

pub fn drop(&mut self)

Executes the destructor for this type.

impl<'_> From<&'_ RsaPrivateKey> for RsaPublicKey

pub fn from(private_key: &RsaPrivateKey) -> RsaPublicKey

Performs the conversion.

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>

Performs the conversion.

impl From<RsaPrivateKey> for RsaPublicKey

pub fn from(private_key: RsaPrivateKey) -> RsaPublicKey

Performs the conversion.

impl FromRsaPrivateKey for RsaPrivateKey

pub fn from_pkcs1_private_key(
    pkcs1_key: RsaPrivateKey<'_>
) -> Result<RsaPrivateKey, Error>

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

impl PartialEq<RsaPrivateKey> for RsaPrivateKey

pub 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

pub fn n(&self) -> &BigUint

Returns the modulus of the key.

pub 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

pub fn n(&self) -> &BigUint

Returns the modulus of the key.

pub 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 ToRsaPrivateKey for RsaPrivateKey

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

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

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

pub 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