Struct openssl::pkey::PKey

This function will automatically attempt to detect the underlying key format, and supports the unencrypted PKCS#8 PrivateKeyInfo structures as well as key type specific formats.

This corresponds to d2i_AutoPrivateKey.

source

pub fn private_key_from_pkcs8(der: &[u8]) -> Result<PKey<Private>, ErrorStack>

Deserializes a DER-formatted PKCS#8 unencrypted private key.

This method is mainly for interoperability reasons. Encrypted keyfiles should be preferred.

source

pub fn private_key_from_pkcs8_callback<F>(
 der: &[u8],
 callback: F
) -> Result<PKey<Private>, ErrorStack> where
 F: FnOnce(&mut [u8]) -> Result<usize, ErrorStack>,

Deserializes a DER-formatted PKCS#8 private key, using a callback to retrieve the password if the key is encrpyted.

The callback should copy the password into the provided buffer and return the number of bytes written.

source

pub fn private_key_from_pkcs8_passphrase(
der: &[u8],
passphrase: &[u8]
) -> Result<PKey<Private>, ErrorStack>

Deserializes a DER-formatted PKCS#8 private key, using the supplied password if the key is encrypted.

Panics

Panics if passphrase contains an embedded null.

source

impl PKey<Public>

source

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

Decodes a PEM-encoded SubjectPublicKeyInfo structure.

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

This corresponds to PEM_read_bio_PUBKEY.

source

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

Decodes a DER-encoded SubjectPublicKeyInfo structure.

This corresponds to d2i_PUBKEY.

Methods from Deref<Target = PKeyRef<T>>

source

pub fn rsa(&self) -> Result<Rsa<T>, ErrorStack>

Returns a copy of the internal RSA key.

This corresponds to EVP_PKEY_get1_RSA.

source

pub fn dsa(&self) -> Result<Dsa<T>, ErrorStack>

Returns a copy of the internal DSA key.

This corresponds to EVP_PKEY_get1_DSA.

source

pub fn dh(&self) -> Result<Dh<T>, ErrorStack>

Returns a copy of the internal DH key.

This corresponds to EVP_PKEY_get1_DH.

source

pub fn ec_key(&self) -> Result<EcKey<T>, ErrorStack>

Returns a copy of the internal elliptic curve key.

This corresponds to EVP_PKEY_get1_EC_KEY.

source

pub fn id(&self) -> Id

Returns the Id that represents the type of this key.

This corresponds to EVP_PKEY_id.

source

pub fn size(&self) -> usize

Returns the maximum size of a signature in bytes.

This corresponds to EVP_PKEY_size.

source

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

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

source

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

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

This corresponds to i2d_PUBKEY.

source

pub fn bits(&self) -> u32

Returns the size of the key.

This corresponds to the bit length of the modulus of an RSA key, and the bit length of the group order for an elliptic curve key, for example.

source

pub fn public_eq(&self, other: &PKeyRef) -> bool where
U: HasPublic,

Compares the public component of this key with another.

source

pub fn private_key_to_pem_pkcs8(&self) -> Result<Vec<u8>, ErrorStack>

Serializes the private key to a PEM-encoded PKCS#8 PrivateKeyInfo structure.

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

This corresponds to PEM_write_bio_PKCS8PrivateKey.

source

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

Serializes the private key to a PEM-encoded PKCS#8 EncryptedPrivateKeyInfo structure.

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

This corresponds to PEM_write_bio_PKCS8PrivateKey.

source

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

Serializes the private key to a DER-encoded key type specific format.

This corresponds to i2d_PrivateKey.

Trait Implementations

source

impl<T> AsRef<PKeyRef<T>> for PKey<T>

source

fn as_ref(&self) -> &PKeyRef<T>

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

source

impl<T> Borrow<PKeyRef<T>> for PKey<T>

source

fn borrow(&self) -> &PKeyRef<T>

Immutably borrows from an owned value. Read more

source

impl<T> Clone for PKey<T>

source

fn clone(&self) -> PKey<T>

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<T> Debug for PKey<T>

source

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

Formats the value using the given formatter. Read more

source

impl<T> Deref for PKey<T>

type Target = PKeyRef<T>

The resulting type after dereferencing.

source

fn deref(&self) -> &PKeyRef<T>

Dereferences the value.

source

impl<T> DerefMut for PKey<T>

source

fn deref_mut(&mut self) -> &mut PKeyRef<T>

Mutably dereferences the value.

source

impl<T> Drop for PKey<T>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<T> ForeignType for PKey<T>

type CType = EVP_PKEY

The raw C type.

type Ref = PKeyRef<T>

The type representing a reference to this type.

source

unsafe fn from_ptr(ptr: *mut EVP_PKEY) -> PKey<T>

Constructs an instance of this type from its raw type.

source

fn as_ptr(&self) -> *mut EVP_PKEY

Returns a raw pointer to the wrapped value.

source

impl<T> TryFrom<Dh<T>> for PKey<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>

Performs the conversion.

source

impl<T> TryFrom<Dsa<T>> for PKey<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(dsa: Dsa<T>) -> Result<PKey<T>, ErrorStack>

Performs the conversion.

source

impl<T> TryFrom<EcKey<T>> for PKey<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(ec_key: EcKey<T>) -> Result<PKey<T>, ErrorStack>

Performs the conversion.

source

impl<T> TryFrom<PKey<T>> for EcKey<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(pkey: PKey<T>) -> Result<EcKey<T>, ErrorStack>

Performs the conversion.

source

impl<T> TryFrom<PKey<T>> for Rsa<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(pkey: PKey<T>) -> Result<Rsa<T>, ErrorStack>

Performs the conversion.

source

impl<T> TryFrom<PKey<T>> for Dsa<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(pkey: PKey<T>) -> Result<Dsa<T>, ErrorStack>

Performs the conversion.

source

impl<T> TryFrom<PKey<T>> for Dh<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(pkey: PKey<T>) -> Result<Dh<T>, ErrorStack>

Performs the conversion.

source

impl<T> TryFrom<Rsa<T>> for PKey<T>

type Error = ErrorStack

The type returned in the event of a conversion error.

source

fn try_from(rsa: Rsa<T>) -> Result<PKey<T>, ErrorStack>

Performs the conversion.

source

impl<T> Send for PKey<T>

source

impl<T> Sync for PKey<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for PKey<T> where
T: RefUnwindSafe,

impl<T> Unpin for PKey<T> where
T: Unpin,

impl<T> UnwindSafe for PKey<T> where
T: UnwindSafe,

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

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

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.

Struct openssl::pkey::PKey

Implementations

impl<T> PKey<T>

pub fn from_rsa(rsa: Rsa<T>) -> Result<PKey<T>, ErrorStack>

pub fn from_dsa(dsa: Dsa<T>) -> Result<PKey<T>, ErrorStack>

pub fn from_dh(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>

pub fn from_ec_key(ec_key: EcKey<T>) -> Result<PKey<T>, ErrorStack>

impl PKey<Private>

pub fn hmac(key: &[u8]) -> Result<PKey<Private>, ErrorStack>

pub fn cmac(cipher: &Cipher, key: &[u8]) -> Result<PKey<Private>, ErrorStack>

pub fn generate_x25519() -> Result<PKey<Private>, ErrorStack>

pub fn generate_x448() -> Result<PKey<Private>, ErrorStack>

pub fn generate_ed25519() -> Result<PKey<Private>, ErrorStack>

pub fn generate_ed448() -> Result<PKey<Private>, ErrorStack>

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

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

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

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

pub fn private_key_from_pkcs8(der: &[u8]) -> Result<PKey<Private>, ErrorStack>

pub fn private_key_from_pkcs8_callback<F>( der: &[u8], callback: F) -> Result<PKey<Private>, ErrorStack> where F: FnOnce(&mut [u8]) -> Result<usize, ErrorStack>,

pub fn private_key_from_pkcs8_passphrase( der: &[u8], passphrase: &[u8]) -> Result<PKey<Private>, ErrorStack>

impl PKey<Public>

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

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

Methods from Deref<Target = PKeyRef<T>>

pub fn rsa(&self) -> Result<Rsa<T>, ErrorStack>

pub fn dsa(&self) -> Result<Dsa<T>, ErrorStack>

pub fn dh(&self) -> Result<Dh<T>, ErrorStack>

pub fn ec_key(&self) -> Result<EcKey<T>, ErrorStack>

pub fn id(&self) -> Id

pub fn size(&self) -> usize

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

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

pub fn bits(&self) -> u32

pub fn public_eq<U>(&self, other: &PKeyRef<U>) -> bool where U: HasPublic,

pub fn private_key_to_pem_pkcs8(&self) -> Result<Vec<u8>, ErrorStack>

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

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

Trait Implementations

impl<T> AsRef<PKeyRef<T>> for PKey<T>

fn as_ref(&self) -> &PKeyRef<T>

impl<T> Borrow<PKeyRef<T>> for PKey<T>

fn borrow(&self) -> &PKeyRef<T>

impl<T> Clone for PKey<T>

fn clone(&self) -> PKey<T>

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

impl<T> Debug for PKey<T>

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

impl<T> Deref for PKey<T>

type Target = PKeyRef<T>

fn deref(&self) -> &PKeyRef<T>

impl<T> DerefMut for PKey<T>

fn deref_mut(&mut self) -> &mut PKeyRef<T>

impl<T> Drop for PKey<T>

fn drop(&mut self)

impl<T> ForeignType for PKey<T>

type CType = EVP_PKEY

type Ref = PKeyRef<T>

unsafe fn from_ptr(ptr: *mut EVP_PKEY) -> PKey<T>

fn as_ptr(&self) -> *mut EVP_PKEY

impl<T> TryFrom<Dh<T>> for PKey<T>

type Error = ErrorStack

fn try_from(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>

impl<T> TryFrom<Dsa<T>> for PKey<T>

type Error = ErrorStack

fn try_from(dsa: Dsa<T>) -> Result<PKey<T>, ErrorStack>

impl<T> TryFrom<EcKey<T>> for PKey<T>

type Error = ErrorStack

fn try_from(ec_key: EcKey<T>) -> Result<PKey<T>, ErrorStack>

impl<T> TryFrom<PKey<T>> for EcKey<T>

type Error = ErrorStack

fn try_from(pkey: PKey<T>) -> Result<EcKey<T>, ErrorStack>

impl<T> TryFrom<PKey<T>> for Rsa<T>

type Error = ErrorStack

fn try_from(pkey: PKey<T>) -> Result<Rsa<T>, ErrorStack>

impl<T> TryFrom<PKey<T>> for Dsa<T>

type Error = ErrorStack

fn try_from(pkey: PKey<T>) -> Result<Dsa<T>, ErrorStack>

impl<T> TryFrom<PKey<T>> for Dh<T>

type Error = ErrorStack

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

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

pub fn private_key_from_pkcs8_callback<F>(
der: &[u8],
callback: F
) -> Result<PKey<Private>, ErrorStack> where
F: FnOnce(&mut [u8]) -> Result<usize, ErrorStack>,

pub fn private_key_from_pkcs8_passphrase(
der: &[u8],
passphrase: &[u8]
) -> Result<PKey<Private>, ErrorStack>

pub fn public_eq<U>(&self, other: &PKeyRef<U>) -> bool where
U: HasPublic,

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

impl<T> RefUnwindSafe for PKey<T> where
T: RefUnwindSafe,

impl<T> Unpin for PKey<T> where
T: Unpin,

impl<T> UnwindSafe for PKey<T> where
T: UnwindSafe,

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<T, U> Into<U> for T where
U: From<T>,

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

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

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