Skip to main content

PrivateKey

Struct PrivateKey 

Source
pub struct PrivateKey { /* private fields */ }
Expand description

An owned private key.

Private key bytes are zeroized on drop to prevent key material from lingering in heap memory. Clone is deliberately not derived — cloning private keys should be an explicit operation via from_bytes.

Implementations§

Source§

impl PrivateKey

Source

pub fn new(algorithm: Algorithm, bytes: Vec<u8>) -> Result<Self>

Creates a new PrivateKey from an owned Vec<u8> after validating key size.

Source

pub fn from_bytes(algorithm: Algorithm, bytes: &[u8]) -> Result<Self>

Creates a new PrivateKey by copying the provided bytes after validation.

Source

pub fn algorithm(&self) -> Algorithm

Returns the algorithm.

Source

pub fn bytes(&self) -> &[u8]

Returns the raw key bytes.

Source

pub fn key_type(&self) -> KeyType

Returns the key type (always Private).

Source

pub fn into_bytes(self) -> Zeroizing<Vec<u8>>

Extracts the inner byte vector wrapped in Zeroizing so the key material is automatically zeroized when the returned value is dropped.

Source

pub fn from_pkcs8(der: &[u8]) -> Result<Self>

Decode a PKCS8 DER-encoded private key into an owned PrivateKey.

Source

pub fn encode_pkcs8_to(&self, out: &mut Vec<u8>)

Encode this private key as PKCS8 DER into the given buffer.

Source

pub fn encode_der_to(&self, out: &mut Vec<u8>)

Encode this private key as DER into the given buffer.

Source

pub fn to_pkcs8(&self) -> Zeroizing<Vec<u8>>

Encode this private key as PKCS8 DER, returning a Zeroizing<Vec<u8>>. The returned wrapper automatically zeroizes the DER bytes on drop.

Source

pub fn to_der(&self) -> Zeroizing<Vec<u8>>

Encode this private key as DER, returning a Zeroizing<Vec<u8>>. The returned wrapper automatically zeroizes the DER bytes on drop.

Source

pub fn from_pem(pem: &str) -> Result<Self>

Decode a PEM-encoded private key into an owned PrivateKey.

Source

pub fn to_pem(&self) -> Zeroizing<String>

Encode this private key as PEM, returning a Zeroizing<String>. The returned wrapper automatically zeroizes the PEM string on drop.

Source

pub fn as_key_ref(&self) -> PrivateKeyRef<'_>

Returns a borrowed PrivateKeyRef.

Trait Implementations§

Source§

impl AsRef<[u8]> for PrivateKey

Source§

fn as_ref(&self) -> &[u8]

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

impl Clone for PrivateKey

Source§

fn clone(&self) -> Self

Explicitly clone a private key. The cloned copy is also zeroized on drop.

1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PrivateKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for PrivateKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl From<PrivateKey> for Key

Source§

fn from(key: PrivateKey) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PrivateKeyRef<'a>> for PrivateKey

Source§

fn from(key: PrivateKeyRef<'a>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for PrivateKey

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Zeroize for PrivateKey

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.
Source§

impl Eq for PrivateKey

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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,

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.