[][src]Struct openssl::rsa::Rsa

pub struct Rsa<T>(_, _);

An RSA key.

Methods

impl Rsa<Public>[src]

pub fn from_public_components(
    n: BigNum,
    e: BigNum
) -> Result<Rsa<Public>, ErrorStack>
[src]

Creates a new RSA key with only public components.

n is the modulus common to both public and private key. e is the public exponent.

This corresponds to RSA_new and uses RSA_set0_key.

pub fn public_key_from_pem(pem: &[u8]) -> Result<Rsa<Public>, ErrorStack>[src]

Decodes a PEM-encoded SubjectPublicKeyInfo structure containing an RSA key.

The input should have a header of -----BEGIN PUBLIC KEY-----.

This corresponds to PEM_read_bio_RSA_PUBKEY.

pub fn public_key_from_pem_pkcs1(pem: &[u8]) -> Result<Rsa<Public>, ErrorStack>[src]

Decodes a PEM-encoded PKCS#1 RSAPublicKey structure.

The input should have a header of -----BEGIN RSA PUBLIC KEY-----.

This corresponds to PEM_read_bio_RSAPublicKey.

pub fn public_key_from_der(der: &[u8]) -> Result<Rsa<Public>, ErrorStack>[src]

Decodes a DER-encoded SubjectPublicKeyInfo structure containing an RSA key.

This corresponds to d2i_RSA_PUBKEY.

pub fn public_key_from_der_pkcs1(der: &[u8]) -> Result<Rsa<Public>, ErrorStack>[src]

Decodes a DER-encoded PKCS#1 RSAPublicKey structure.

This corresponds to d2i_RSAPublicKey.

impl Rsa<Private>[src]

pub fn from_private_components(
    n: BigNum,
    e: BigNum,
    d: BigNum,
    p: BigNum,
    q: BigNum,
    dmp1: BigNum,
    dmq1: BigNum,
    iqmp: BigNum
) -> Result<Rsa<Private>, ErrorStack>
[src]

Creates a new RSA key with private components (public components are assumed).

This a convenience method over Rsa::build(n, e, d)?.set_factors(p, q)?.set_crt_params(dmp1, dmq1, iqmp)?.build()

pub fn generate(bits: u32) -> Result<Rsa<Private>, ErrorStack>[src]

Generates a public/private key pair with the specified size.

The public exponent will be 65537.

This corresponds to RSA_generate_key_ex.

pub fn generate_with_e(
    bits: u32,
    e: &BigNumRef
) -> Result<Rsa<Private>, ErrorStack>
[src]

Generates a public/private key pair with the specified size and a custom exponent.

Unless you have specific needs and know what you're doing, use Rsa::generate instead.

This corresponds to RSA_generate_key_ex.

pub fn private_key_from_pem(pem: &[u8]) -> Result<Rsa<Private>, ErrorStack>[src]

Deserializes a private key from a PEM-encoded PKCS#1 RSAPrivateKey structure.

This corresponds to PEM_read_bio_RSAPrivateKey.

pub fn private_key_from_pem_passphrase(
    pem: &[u8],
    passphrase: &[u8]
) -> Result<Rsa<Private>, ErrorStack>
[src]

Deserializes a private key from a PEM-encoded encrypted PKCS#1 RSAPrivateKey structure.

This corresponds to PEM_read_bio_RSAPrivateKey.

pub fn private_key_from_pem_callback<F>(
    pem: &[u8],
    callback: F
) -> Result<Rsa<Private>, ErrorStack> where
    F: FnOnce(&mut [u8]) -> Result<usize, ErrorStack>, 
[src]

Deserializes a private key from a PEM-encoded encrypted PKCS#1 RSAPrivateKey structure.

The callback should fill the password into the provided buffer and return its length.

This corresponds to PEM_read_bio_RSAPrivateKey.

pub fn private_key_from_der(der: &[u8]) -> Result<Rsa<Private>, ErrorStack>[src]

Decodes a DER-encoded PKCS#1 RSAPrivateKey structure.

This corresponds to d2i_RSAPrivateKey.

Methods from Deref<Target = RsaRef<T>>

pub fn private_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>[src]

Serializes the private key to a PEM-encoded PKCS#1 RSAPrivateKey structure.

The output will have a header of -----BEGIN RSA PRIVATE KEY-----.

This corresponds to PEM_write_bio_RSAPrivateKey.

pub fn private_key_to_pem_passphrase(
    &self,
    cipher: Cipher,
    passphrase: &[u8]
) -> Result<Vec<u8>, ErrorStack>
[src]

Serializes the private key to a PEM-encoded encrypted PKCS#1 RSAPrivateKey structure.

The output will have a header of -----BEGIN RSA PRIVATE KEY-----.

This corresponds to PEM_write_bio_RSAPrivateKey.

pub fn private_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>[src]

Serializes the private key to a DER-encoded PKCS#1 RSAPrivateKey structure.

This corresponds to i2d_RSAPrivateKey.

pub fn private_decrypt(
    &self,
    from: &[u8],
    to: &mut [u8],
    padding: Padding
) -> Result<usize, ErrorStack>
[src]

Decrypts data using the private key, returning the number of decrypted bytes.

Panics

Panics if self has no private components, or if to is smaller than self.size().

pub fn private_encrypt(
    &self,
    from: &[u8],
    to: &mut [u8],
    padding: Padding
) -> Result<usize, ErrorStack>
[src]

Encrypts data using the private key, returning the number of encrypted bytes.

Panics

Panics if self has no private components, or if to is smaller than self.size().

pub fn d(&self) -> &BigNumRef[src]

Returns a reference to the private exponent of the key.

This corresponds to RSA_get0_key.

pub fn p(&self) -> Option<&BigNumRef>[src]

Returns a reference to the first factor of the exponent of the key.

This corresponds to RSA_get0_factors.

pub fn q(&self) -> Option<&BigNumRef>[src]

Returns a reference to the second factor of the exponent of the key.

This corresponds to RSA_get0_factors.

pub fn dmp1(&self) -> Option<&BigNumRef>[src]

Returns a reference to the first exponent used for CRT calculations.

This corresponds to RSA_get0_crt_params.

pub fn dmq1(&self) -> Option<&BigNumRef>[src]

Returns a reference to the second exponent used for CRT calculations.

This corresponds to RSA_get0_crt_params.

pub fn iqmp(&self) -> Option<&BigNumRef>[src]

Returns a reference to the coefficient used for CRT calculations.

This corresponds to RSA_get0_crt_params.

pub fn check_key(&self) -> Result<bool, ErrorStack>[src]

Validates RSA parameters for correctness

This corresponds to RSA_check_key.

pub fn public_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>[src]

Serializes the public key into a PEM-encoded SubjectPublicKeyInfo structure.

The output will have a header of -----BEGIN PUBLIC KEY-----.

This corresponds to PEM_write_bio_RSA_PUBKEY.

pub fn public_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>[src]

Serializes the public key into a DER-encoded SubjectPublicKeyInfo structure.

This corresponds to i2d_RSA_PUBKEY.

pub fn public_key_to_pem_pkcs1(&self) -> Result<Vec<u8>, ErrorStack>[src]

Serializes the public key into a PEM-encoded PKCS#1 RSAPublicKey structure.

The output will have a header of -----BEGIN RSA PUBLIC KEY-----.

This corresponds to PEM_write_bio_RSAPublicKey.

pub fn public_key_to_der_pkcs1(&self) -> Result<Vec<u8>, ErrorStack>[src]

Serializes the public key into a DER-encoded PKCS#1 RSAPublicKey structure.

This corresponds to i2d_RSAPublicKey.

pub fn size(&self) -> u32[src]

Returns the size of the modulus in bytes.

This corresponds to RSA_size.

pub fn public_decrypt(
    &self,
    from: &[u8],
    to: &mut [u8],
    padding: Padding
) -> Result<usize, ErrorStack>
[src]

Decrypts data using the public key, returning the number of decrypted bytes.

Panics

Panics if to is smaller than self.size().

pub fn public_encrypt(
    &self,
    from: &[u8],
    to: &mut [u8],
    padding: Padding
) -> Result<usize, ErrorStack>
[src]

Encrypts data using the public key, returning the number of encrypted bytes.

Panics

Panics if to is smaller than self.size().

pub fn n(&self) -> &BigNumRef[src]

Returns a reference to the modulus of the key.

This corresponds to RSA_get0_key.

pub fn e(&self) -> &BigNumRef[src]

Returns a reference to the public exponent of the key.

This corresponds to RSA_get0_key.

Trait Implementations

impl<T> Send for Rsa<T>[src]

impl<T> Drop for Rsa<T>[src]

impl<T> Sync for Rsa<T>[src]

impl<T> Clone for Rsa<T>[src]

impl<T> AsRef<RsaRef<T>> for Rsa<T>[src]

impl<T> DerefMut for Rsa<T>[src]

impl<T> Deref for Rsa<T>[src]

type Target = RsaRef<T>

The resulting type after dereferencing.

impl<T> Debug for Rsa<T>[src]

impl<T> Borrow<RsaRef<T>> for Rsa<T>[src]

impl<T> ForeignType for Rsa<T>[src]

type CType = RSA

The raw C type.

type Ref = RsaRef<T>

The type representing a reference to this type.

Auto Trait Implementations

impl<T> Unpin for Rsa<T> where
    T: Unpin

impl<T> UnwindSafe for Rsa<T> where
    T: UnwindSafe

impl<T> RefUnwindSafe for Rsa<T> where
    T: RefUnwindSafe

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]