Struct PKey
pub struct PKey<T>(/* private fields */);Expand description
A public or private key.
Implementations§
§impl<T> PKey<T>
impl<T> PKey<T>
pub 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_assign_RSA.
pub 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_assign_EC_KEY.
§impl PKey<Private>
impl PKey<Private>
pub 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.
pub 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.
pub 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.
pub 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 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.
pub 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.
pub 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.
pub 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.
§impl PKey<Public>
impl PKey<Public>
pub 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.
pub 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.
Methods from Deref<Target = PKeyRef<T>>§
pub 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.
pub 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.
pub 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.
pub 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.
pub 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.
pub fn size(&self) -> usize
pub fn size(&self) -> usize
Returns the maximum size of a signature in bytes.
This corresponds to EVP_PKEY_size.
pub 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.
pub 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.
pub 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.
pub 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.
pub 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.
pub 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.
pub 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.
pub fn private_key_to_der_pkcs8(&self) -> Result<Vec<u8>, ErrorStack>
pub fn private_key_to_der_pkcs8(&self) -> Result<Vec<u8>, ErrorStack>
Serializes the private key to a DER-encoded PKCS#8 PrivateKeyInfo structure.
This corresponds to i2d_PKCS8PrivateKey_bio.
pub fn private_key_to_der_pkcs8_passphrase(
&self,
cipher: Cipher,
passphrase: &[u8],
) -> Result<Vec<u8>, ErrorStack>
pub fn private_key_to_der_pkcs8_passphrase( &self, cipher: Cipher, passphrase: &[u8], ) -> Result<Vec<u8>, ErrorStack>
Serializes the private key to a DER-encoded PKCS#8 EncryptedPrivateKeyInfo structure.
This corresponds to i2d_PKCS8PrivateKey_bio.
Trait Implementations§
§impl<T> ForeignType for PKey<T>
impl<T> ForeignType for PKey<T>
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§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Policy that returns Action::Follow only if self and other return
Action::Follow. Read more