pub struct PKey<T>(/* private fields */);
Expand description
A public or private key.
Implementations§
source§impl<T> PKey<T>
impl<T> PKey<T>
sourcepub fn from_rsa(rsa: Rsa<T>) -> Result<PKey<T>, ErrorStack>
pub fn from_rsa(rsa: Rsa<T>) -> Result<PKey<T>, ErrorStack>
Creates a new PKey
containing an RSA key.
This corresponds to EVP_PKEY_set1_RSA
.
sourcepub fn from_dsa(dsa: Dsa<T>) -> Result<PKey<T>, ErrorStack>
pub fn from_dsa(dsa: Dsa<T>) -> Result<PKey<T>, ErrorStack>
Creates a new PKey
containing a DSA key.
This corresponds to EVP_PKEY_set1_DSA
.
sourcepub fn from_dh(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>
pub fn from_dh(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>
Creates a new PKey
containing a Diffie-Hellman key.
This corresponds to EVP_PKEY_set1_DH
.
sourcepub fn from_dhx(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>
pub fn from_dhx(dh: Dh<T>) -> Result<PKey<T>, ErrorStack>
Creates a new PKey
containing a Diffie-Hellman key with type DHX.
sourcepub fn from_ec_key(ec_key: EcKey<T>) -> Result<PKey<T>, ErrorStack>
pub fn from_ec_key(ec_key: EcKey<T>) -> Result<PKey<T>, ErrorStack>
Creates a new PKey
containing an elliptic curve key.
This corresponds to EVP_PKEY_set1_EC_KEY
.
source§impl PKey<Private>
impl PKey<Private>
sourcepub fn hmac(key: &[u8]) -> Result<PKey<Private>, ErrorStack>
pub fn hmac(key: &[u8]) -> Result<PKey<Private>, ErrorStack>
Creates a new PKey
containing an HMAC key.
§Note
To compute HMAC values, use the sign
module.
This corresponds to EVP_PKEY_new_mac_key
.
sourcepub fn cmac(cipher: &Cipher, key: &[u8]) -> Result<PKey<Private>, ErrorStack>
pub fn cmac(cipher: &Cipher, key: &[u8]) -> Result<PKey<Private>, ErrorStack>
Creates a new PKey
containing a CMAC key.
Requires OpenSSL 1.1.0 or newer.
§Note
To compute CMAC values, use the sign
module.
sourcepub fn generate_x25519() -> Result<PKey<Private>, ErrorStack>
pub fn generate_x25519() -> Result<PKey<Private>, ErrorStack>
Generates a new private X25519 key.
To import a private key from raw bytes see PKey::private_key_from_raw_bytes
.
§Examples
use openssl::pkey::{PKey, Id};
use openssl::derive::Deriver;
let public = // ...
let public_key = PKey::public_key_from_raw_bytes(public, Id::X25519)?;
let key = PKey::generate_x25519()?;
let mut deriver = Deriver::new(&key)?;
deriver.set_peer(&public_key)?;
let secret = deriver.derive_to_vec()?;
assert_eq!(secret.len(), 32);
sourcepub fn generate_x448() -> Result<PKey<Private>, ErrorStack>
pub fn generate_x448() -> Result<PKey<Private>, ErrorStack>
Generates a new private X448 key.
To import a private key from raw bytes see PKey::private_key_from_raw_bytes
.
§Examples
use openssl::pkey::{PKey, Id};
use openssl::derive::Deriver;
let public = // ...
let public_key = PKey::public_key_from_raw_bytes(public, Id::X448)?;
let key = PKey::generate_x448()?;
let mut deriver = Deriver::new(&key)?;
deriver.set_peer(&public_key)?;
let secret = deriver.derive_to_vec()?;
assert_eq!(secret.len(), 56);
sourcepub fn generate_ed25519() -> Result<PKey<Private>, ErrorStack>
pub fn generate_ed25519() -> Result<PKey<Private>, ErrorStack>
Generates a new private Ed25519 key.
To import a private key from raw bytes see PKey::private_key_from_raw_bytes
.
§Examples
use openssl::pkey::{PKey, Id};
use openssl::sign::Signer;
let key = PKey::generate_ed25519()?;
let public_key = key.raw_public_key()?;
let mut signer = Signer::new_without_digest(&key)?;
let digest = // ...
let signature = signer.sign_oneshot_to_vec(digest)?;
assert_eq!(signature.len(), 64);
sourcepub fn generate_ed448() -> Result<PKey<Private>, ErrorStack>
pub fn generate_ed448() -> Result<PKey<Private>, ErrorStack>
Generates a new private Ed448 key.
To import a private key from raw bytes see PKey::private_key_from_raw_bytes
.
§Examples
use openssl::pkey::{PKey, Id};
use openssl::sign::Signer;
let key = PKey::generate_ed448()?;
let public_key = key.raw_public_key()?;
let mut signer = Signer::new_without_digest(&key)?;
let digest = // ...
let signature = signer.sign_oneshot_to_vec(digest)?;
assert_eq!(signature.len(), 114);
sourcepub fn private_key_from_pem(pem: &[u8]) -> Result<PKey<Private>, ErrorStack>
pub fn private_key_from_pem(pem: &[u8]) -> Result<PKey<Private>, ErrorStack>
Deserializes a private key from a PEM-encoded key type specific format.
This corresponds to PEM_read_bio_PrivateKey
.
sourcepub fn private_key_from_pem_passphrase(
pem: &[u8],
passphrase: &[u8],
) -> Result<PKey<Private>, ErrorStack>
pub fn private_key_from_pem_passphrase( pem: &[u8], passphrase: &[u8], ) -> Result<PKey<Private>, ErrorStack>
Deserializes a private key from a PEM-encoded encrypted key type specific format.
This corresponds to PEM_read_bio_PrivateKey
.
sourcepub fn private_key_from_pem_callback<F>(
pem: &[u8],
callback: F,
) -> Result<PKey<Private>, ErrorStack>
pub fn private_key_from_pem_callback<F>( pem: &[u8], callback: F, ) -> Result<PKey<Private>, ErrorStack>
Deserializes a private key from a PEM-encoded encrypted key type specific format.
The callback should fill the password into the provided buffer and return its length.
This corresponds to PEM_read_bio_PrivateKey
.
sourcepub fn private_key_from_der(der: &[u8]) -> Result<PKey<Private>, ErrorStack>
pub fn private_key_from_der(der: &[u8]) -> Result<PKey<Private>, ErrorStack>
Decodes a DER-encoded private key.
This function will attempt to automatically 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
.
sourcepub fn private_key_from_pkcs8(der: &[u8]) -> Result<PKey<Private>, ErrorStack>
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.
sourcepub fn private_key_from_pkcs8_callback<F>(
der: &[u8],
callback: F,
) -> Result<PKey<Private>, ErrorStack>
pub fn private_key_from_pkcs8_callback<F>( der: &[u8], callback: F, ) -> Result<PKey<Private>, ErrorStack>
Deserializes a DER-formatted PKCS#8 private key, using a callback to retrieve the password if the key is encrypted.
The callback should copy the password into the provided buffer and return the number of bytes written.
This corresponds to d2i_PKCS8PrivateKey_bio
.
sourcepub fn private_key_from_pkcs8_passphrase(
der: &[u8],
passphrase: &[u8],
) -> Result<PKey<Private>, ErrorStack>
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.
This corresponds to d2i_PKCS8PrivateKey_bio
.
sourcepub fn private_key_from_raw_bytes(
bytes: &[u8],
key_type: Id,
) -> Result<PKey<Private>, ErrorStack>
pub fn private_key_from_raw_bytes( bytes: &[u8], key_type: Id, ) -> Result<PKey<Private>, ErrorStack>
Creates a private key from its raw byte representation
Algorithm types that support raw private keys are HMAC, X25519, ED25519, X448 or ED448
This corresponds to EVP_PKEY_new_raw_private_key
.
source§impl PKey<Public>
impl PKey<Public>
sourcepub fn public_key_from_pem(pem: &[u8]) -> Result<PKey<Public>, ErrorStack>
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
.
sourcepub fn public_key_from_pem_passphrase(
pem: &[u8],
passphrase: &[u8],
) -> Result<PKey<Public>, ErrorStack>
pub fn public_key_from_pem_passphrase( pem: &[u8], passphrase: &[u8], ) -> Result<PKey<Public>, ErrorStack>
Decodes a PEM-encoded SubjectPublicKeyInfo structure.
This corresponds to PEM_read_bio_PUBKEY
.
sourcepub fn public_key_from_pem_callback<F>(
pem: &[u8],
callback: F,
) -> Result<PKey<Public>, ErrorStack>
pub fn public_key_from_pem_callback<F>( pem: &[u8], callback: F, ) -> Result<PKey<Public>, ErrorStack>
Decodes a PEM-encoded SubjectPublicKeyInfo structure.
The callback should fill the password into the provided buffer and return its length.
This corresponds to PEM_read_bio_PrivateKey
.
sourcepub fn public_key_from_der(der: &[u8]) -> Result<PKey<Public>, ErrorStack>
pub fn public_key_from_der(der: &[u8]) -> Result<PKey<Public>, ErrorStack>
Decodes a DER-encoded SubjectPublicKeyInfo structure.
This corresponds to d2i_PUBKEY
.
sourcepub fn public_key_from_raw_bytes(
bytes: &[u8],
key_type: Id,
) -> Result<PKey<Public>, ErrorStack>
pub fn public_key_from_raw_bytes( bytes: &[u8], key_type: Id, ) -> Result<PKey<Public>, ErrorStack>
Creates a public key from its raw byte representation
Algorithm types that support raw public keys are X25519, ED25519, X448 or ED448
This corresponds to EVP_PKEY_new_raw_public_key
.
Methods from Deref<Target = PKeyRef<T>>§
sourcepub fn rsa(&self) -> Result<Rsa<T>, ErrorStack>
pub fn rsa(&self) -> Result<Rsa<T>, ErrorStack>
Returns a copy of the internal RSA key.
This corresponds to EVP_PKEY_get1_RSA
.
sourcepub fn dsa(&self) -> Result<Dsa<T>, ErrorStack>
pub fn dsa(&self) -> Result<Dsa<T>, ErrorStack>
Returns a copy of the internal DSA key.
This corresponds to EVP_PKEY_get1_DSA
.
sourcepub fn dh(&self) -> Result<Dh<T>, ErrorStack>
pub fn dh(&self) -> Result<Dh<T>, ErrorStack>
Returns a copy of the internal DH key.
This corresponds to EVP_PKEY_get1_DH
.
sourcepub fn ec_key(&self) -> Result<EcKey<T>, ErrorStack>
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
.
sourcepub fn id(&self) -> Id
pub fn id(&self) -> Id
Returns the Id
that represents the type of this key.
This corresponds to EVP_PKEY_id
.
sourcepub fn size(&self) -> usize
pub fn size(&self) -> usize
Returns the maximum size of a signature in bytes.
This corresponds to EVP_PKEY_size
.
sourcepub fn public_key_to_pem(&self) -> Result<Vec<u8>, ErrorStack>
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
.
sourcepub fn public_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>
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
.
sourcepub fn bits(&self) -> u32
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.
This corresponds to EVP_PKEY_bits
.
sourcepub fn security_bits(&self) -> u32
pub fn security_bits(&self) -> u32
Returns the number of security bits.
Bits of security is defined in NIST SP800-57.
This corresponds to EVP_PKEY_security_bits
.
sourcepub fn public_eq<U>(&self, other: &PKeyRef<U>) -> boolwhere
U: HasPublic,
pub fn public_eq<U>(&self, other: &PKeyRef<U>) -> boolwhere
U: HasPublic,
Compares the public component of this key with another.
This corresponds to EVP_PKEY_cmp
.
sourcepub fn raw_public_key(&self) -> Result<Vec<u8>, ErrorStack>
pub fn raw_public_key(&self) -> Result<Vec<u8>, ErrorStack>
Raw byte representation of a public key.
This function only works for algorithms that support raw public keys.
Currently this is: Id::X25519
, Id::ED25519
, Id::X448
or Id::ED448
.
This corresponds to EVP_PKEY_get_raw_public_key
.
sourcepub fn private_key_to_pem_pkcs8(&self) -> Result<Vec<u8>, ErrorStack>
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
.
sourcepub fn private_key_to_pem_pkcs8_passphrase(
&self,
cipher: Cipher,
passphrase: &[u8],
) -> Result<Vec<u8>, ErrorStack>
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
.
sourcepub fn private_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>
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
.
sourcepub fn raw_private_key(&self) -> Result<Vec<u8>, ErrorStack>
pub fn raw_private_key(&self) -> Result<Vec<u8>, ErrorStack>
Raw byte representation of a private key.
This function only works for algorithms that support raw private keys.
Currently this is: Id::HMAC
, Id::X25519
, Id::ED25519
, Id::X448
or Id::ED448
.
This corresponds to EVP_PKEY_get_raw_private_key
.
sourcepub fn private_key_to_pkcs8(&self) -> Result<Vec<u8>, ErrorStack>
pub fn private_key_to_pkcs8(&self) -> Result<Vec<u8>, ErrorStack>
Serializes a private key into an unencrypted DER-formatted PKCS#8
This corresponds to i2d_PKCS8PrivateKey_bio
.
sourcepub fn private_key_to_pkcs8_passphrase(
&self,
cipher: Cipher,
passphrase: &[u8],
) -> Result<Vec<u8>, ErrorStack>
pub fn private_key_to_pkcs8_passphrase( &self, cipher: Cipher, passphrase: &[u8], ) -> Result<Vec<u8>, ErrorStack>
Serializes a private key into a DER-formatted PKCS#8, using the supplied password to encrypt the key.
This corresponds to i2d_PKCS8PrivateKey_bio
.
Trait Implementations§
source§impl<T> ForeignType for PKey<T>
impl<T> ForeignType for PKey<T>
source§impl<T> TryFrom<Dh<T>> for PKey<T>
impl<T> TryFrom<Dh<T>> for PKey<T>
§type Error = ErrorStack
type Error = ErrorStack
source§impl<T> TryFrom<Dsa<T>> for PKey<T>
impl<T> TryFrom<Dsa<T>> for PKey<T>
§type Error = ErrorStack
type Error = ErrorStack
source§impl<T> TryFrom<EcKey<T>> for PKey<T>
impl<T> TryFrom<EcKey<T>> for PKey<T>
§type Error = ErrorStack
type Error = ErrorStack
source§impl<T> TryFrom<PKey<T>> for Dh<T>
impl<T> TryFrom<PKey<T>> for Dh<T>
§type Error = ErrorStack
type Error = ErrorStack
source§impl<T> TryFrom<PKey<T>> for Dsa<T>
impl<T> TryFrom<PKey<T>> for Dsa<T>
§type Error = ErrorStack
type Error = ErrorStack
source§impl<T> TryFrom<PKey<T>> for EcKey<T>
impl<T> TryFrom<PKey<T>> for EcKey<T>
§type Error = ErrorStack
type Error = ErrorStack
source§impl<T> TryFrom<PKey<T>> for Rsa<T>
impl<T> TryFrom<PKey<T>> for Rsa<T>
§type Error = ErrorStack
type Error = ErrorStack
source§impl<T> TryFrom<Rsa<T>> for PKey<T>
impl<T> TryFrom<Rsa<T>> for PKey<T>
§type Error = ErrorStack
type Error = ErrorStack
impl<T> Send for PKey<T>
impl<T> Sync for PKey<T>
Auto Trait Implementations§
impl<T> Freeze for PKey<T>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)