Struct rsa::RsaPrivateKey

source · [−]

pub struct RsaPrivateKey { /* private fields */ }

Expand description

Represents a whole RSA key, public and private parts.

Implementations

source

impl RsaPrivateKey

source

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

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

source

pub fn new_with_exp<R: Rng>(
 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.

source

pub fn from_components(
 n: BigUint,
 e: BigUint,
 d: BigUint,
 primes: Vec<BigUint>
) -> RsaPrivateKey

Constructs an RSA key pair from the individual components.

source

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.

source

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

Performs some calculations to speed up private key operations.

source

pub fn d(&self) -> &BigUint

Returns the private exponent of the key.

source

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

Returns the prime factors.

source

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

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

source

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

Decrypt the given message.

source

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

Decrypt the given message.

Uses rng to blind the decryption process.

source

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

Sign the given digest.

source

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

Sign the given digest.

Use rng for blinding.

Trait Implementations

source

impl Clone for RsaPrivateKey

source

fn clone(&self) -> RsaPrivateKey

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for RsaPrivateKey

source

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

Formats the value using the given formatter. Read more

source

impl Deref for RsaPrivateKey

type Target = RsaPublicKey

The resulting type after dereferencing.

source

fn deref(&self) -> &RsaPublicKey

Dereferences the value.

source

impl Drop for RsaPrivateKey

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl From<&'_ RsaPrivateKey> for RsaPublicKey

source

fn from(private_key: &RsaPrivateKey) -> Self

Converts to this type from the input type.

source

impl From<RsaPrivateKey> for RsaPublicKey

source

fn from(private_key: RsaPrivateKey) -> Self

Converts to this type from the input type.

source

impl FromRsaPrivateKey for RsaPrivateKey

source

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

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

source

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

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

source

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

Deserialize PKCS#1-encoded private key from PEM. Read more

source

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

source

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

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

source

impl PartialEq<RsaPrivateKey> for RsaPrivateKey

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl PublicKeyParts for RsaPrivateKey

source

fn n(&self) -> &BigUint

Returns the modulus of the key.

source

fn e(&self) -> &BigUint

Returns the public exponent of the key.

source

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. Read more

source

impl<'a> PublicKeyParts for &'a RsaPrivateKey

source

fn n(&self) -> &BigUint

Returns the modulus of the key.

source

fn e(&self) -> &BigUint

Returns the public exponent of the key.

source

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. Read more

source

impl ToRsaPrivateKey for RsaPrivateKey

source

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

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

source

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

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

source

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.

source

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

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

source

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

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

source

impl Zeroize for RsaPrivateKey

source

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. Read more

source

impl Eq for RsaPrivateKey

Auto Trait Implementations

impl RefUnwindSafe for RsaPrivateKey

impl Send for RsaPrivateKey

impl Sync for RsaPrivateKey

impl Unpin for RsaPrivateKey

impl UnwindSafe for RsaPrivateKey

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<K> FromPrivateKey for K where
K: FromRsaPrivateKey,

source

fn from_pkcs8_private_key_info(
pkcs8_key: PrivateKeyInfo<'_>
) -> Result<K, Error>

Parse the PrivateKeyInfo from a PKCS#8-encoded document.

source

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

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

source

fn from_pkcs8_doc(doc: &PrivateKeyDocument) -> Result<Self, Error>

Deserialize PKCS#8 private key from a PrivateKeyDocument.

source

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

Deserialize PKCS#8-encoded private key from PEM. Read more

source

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

source

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.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<K> ToPrivateKey for K where
K: ToRsaPrivateKey,

source

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

Serialize a PrivateKeyDocument containing a PKCS#8-encoded private key.

source

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

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

source

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

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

source

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

source

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

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Struct rsa::RsaPrivateKey

Implementations

impl RsaPrivateKey

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

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

pub fn from_components( n: BigUint, e: BigUint, d: BigUint, primes: Vec<BigUint>) -> RsaPrivateKey

pub fn to_public_key(&self) -> RsaPublicKey

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

pub fn d(&self) -> &BigUint

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

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

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

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

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

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

Trait Implementations

impl Clone for RsaPrivateKey

fn clone(&self) -> RsaPrivateKey

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

impl Debug for RsaPrivateKey

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

impl Deref for RsaPrivateKey

type Target = RsaPublicKey

fn deref(&self) -> &RsaPublicKey

impl Drop for RsaPrivateKey

fn drop(&mut self)

impl From<&'_ RsaPrivateKey> for RsaPublicKey

fn from(private_key: &RsaPrivateKey) -> Self

impl From<RsaPrivateKey> for RsaPublicKey

fn from(private_key: RsaPrivateKey) -> Self

impl FromRsaPrivateKey for RsaPrivateKey

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

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

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

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

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

impl PartialEq<RsaPrivateKey> for RsaPrivateKey

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

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

impl PublicKeyParts for RsaPrivateKey

fn n(&self) -> &BigUint

fn e(&self) -> &BigUint

fn size(&self) -> usize

impl<'a> PublicKeyParts for &'a RsaPrivateKey

fn n(&self) -> &BigUint

fn e(&self) -> &BigUint

fn size(&self) -> usize

impl ToRsaPrivateKey for RsaPrivateKey

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

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

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

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

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

impl Zeroize for RsaPrivateKey

fn zeroize(&mut self)

impl Eq for RsaPrivateKey

Auto Trait Implementations

impl RefUnwindSafe for RsaPrivateKey

impl Send for RsaPrivateKey

impl Sync for RsaPrivateKey

impl Unpin for RsaPrivateKey

impl UnwindSafe for RsaPrivateKey

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<K> FromPrivateKey for K where K: FromRsaPrivateKey,

fn from_pkcs8_private_key_info( pkcs8_key: PrivateKeyInfo<'_>) -> Result<K, Error>

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

fn from_pkcs8_doc(doc: &PrivateKeyDocument) -> Result<Self, Error>

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

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

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

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

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

pub fn from_components(
n: BigUint,
e: BigUint,
d: BigUint,
primes: Vec<BigUint>
) -> RsaPrivateKey

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<K> FromPrivateKey for K where
K: FromRsaPrivateKey,

fn from_pkcs8_private_key_info(
pkcs8_key: PrivateKeyInfo<'_>
) -> Result<K, Error>

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<K> ToPrivateKey for K where
K: ToRsaPrivateKey,

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,