pub struct PKeyRef<T>(/* private fields */);
Expand description
Reference to PKey
.
Implementations§
source§impl<T> PKeyRef<T>
impl<T> 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
.
source§impl<T> PKeyRef<T>where
T: HasPublic,
impl<T> PKeyRef<T>where
T: HasPublic,
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
.
source§impl<T> PKeyRef<T>where
T: HasPrivate,
impl<T> PKeyRef<T>where
T: HasPrivate,
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
.