Struct openssl::pkey::PKeyRef

source · [−]

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

Expand description

Reference to PKey.

Implementations

source

impl<T> 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

impl<T> PKeyRef<T> where
T: HasPublic,

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 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: X25519, ED25519, X448 or ED448

This corresponds to EVP_PKEY_get_raw_public_key.

source

impl<T> PKeyRef<T> where
T: HasPrivate,

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.

source

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: HMAC, X25519, ED25519, X448 or ED448

This corresponds to EVP_PKEY_get_raw_private_key.

source

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.

Panics

Panics if passphrase contains an embedded null.

Trait Implementations

source

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

source

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

Performs the conversion.

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> ForeignTypeRef for PKeyRef<T>

type CType = EVP_PKEY

The raw C type.

source

unsafe fn from_ptr<'a>(ptr: *mut Self::CType) -> &'a Self

Constructs a shared instance of this type from its raw type.

source

unsafe fn from_ptr_mut<'a>(ptr: *mut Self::CType) -> &'a mut Self

Constructs a mutable reference of this type from its raw type.

source

fn as_ptr(&self) -> *mut Self::CType

Returns a raw pointer to the wrapped value.

source

impl<T> ToOwned for PKeyRef<T>

type Owned = PKey<T>

The resulting type after obtaining ownership.

source

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

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T> Send for PKeyRef<T>

source

impl<T> Sync for PKeyRef<T>

Auto Trait Implementations

impl<T> !RefUnwindSafe for PKeyRef<T>

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

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

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub 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

pub 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

pub 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

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub 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

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct openssl::pkey::PKeyRef

Implementations

impl<T> 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

impl<T> PKeyRef<T> where T: HasPublic,

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 raw_public_key(&self) -> Result<Vec<u8>, ErrorStack>

impl<T> PKeyRef<T> where T: HasPrivate,

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>

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

pub fn private_key_to_pkcs8_passphrase( &self, cipher: Cipher, passphrase: &[u8]) -> 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> ForeignTypeRef for PKeyRef<T>

type CType = EVP_PKEY

unsafe fn from_ptr<'a>(ptr: *mut Self::CType) -> &'a Self

unsafe fn from_ptr_mut<'a>(ptr: *mut Self::CType) -> &'a mut Self

fn as_ptr(&self) -> *mut Self::CType

impl<T> ToOwned for PKeyRef<T>

type Owned = PKey<T>

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

fn clone_into(&self, target: &mut Self::Owned)

impl<T> Send for PKeyRef<T>

impl<T> Sync for PKeyRef<T>

Auto Trait Implementations

impl<T> !RefUnwindSafe for PKeyRef<T>

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

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

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> PKeyRef<T> where
T: HasPublic,

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

impl<T> PKeyRef<T> where
T: HasPrivate,

pub fn private_key_to_pem_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>

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

impl<T> UnwindSafe for PKeyRef<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, U> TryFrom<U> for T where
U: Into<T>,

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