Struct SecretKey 

pub struct SecretKey(pub RsaPrivateKey);

An RSA secret key

Tuple Fields

0: RsaPrivateKey

Implementations

impl SecretKey

pub fn new(f0: RsaPrivateKey) -> Self

Constructs a new SecretKey.

impl SecretKey

pub fn to_der(&self) -> Result<Vec<u8>, Error>

pub fn from_der(der: &[u8]) -> Result<Self, Error>

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

pub fn from_pem(pem: &str) -> Result<Self, Error>

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

pub fn blind_sign<R: CryptoRng + RngCore>( &self, rng: &mut R, blind_msg: impl AsRef<[u8]>, _options: &Options, ) -> Result<BlindSignature, Error>

Sign a blinded message

Methods from Deref<Target = RsaPrivateKey>

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

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

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

where P: PaddingScheme,

Decrypt the given message.

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

where R: CryptoRngCore, P: PaddingScheme,

Decrypt the given message.

Uses rng to blind the decryption process.

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

where S: SignatureScheme,

Sign the given digest.

pub fn sign_with_rng<R, S>( &self, rng: &mut R, padding: S, digest_in: &[u8], ) -> Result<Vec<u8>, Error>

where R: CryptoRngCore, S: SignatureScheme,

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 AsRef<RsaPrivateKey> for SecretKey

fn as_ref(&self) -> &RsaPrivateKey

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

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Deref for SecretKey

type Target = RsaPrivateKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for SecretKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RsaPrivateKey> for SecretKey

fn from(value: RsaPrivateKey) -> Self

Converts to this type from the input type.

impl From<SecretKey> for RsaPrivateKey

fn from(value: SecretKey) -> Self

Converts to this type from the input type.

impl Serialize for SecretKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.