Skip to main content

KeyPair

Struct KeyPair 

Source
pub struct KeyPair {
    pub public: PublicKey,
    pub secret: SecretKey,
}
Expand description

A cryptographic key pair for the age protocol.

Contains a PublicKey and a SecretKey, both guaranteed to be valid age keys. The Debug implementation redacts the secret key value while displaying the public key in full.

§Obtaining a KeyPair

Use build_keypair to generate a fresh key pair:

use age_setup::build_keypair;

let kp = build_keypair()?;
println!("Public: {}", kp.public);

§Debug Safety

The debug representation does not leak the secret key:

use age_setup::build_keypair;

let kp = build_keypair()?;
let debug_str = format!("{:?}", kp);
assert!(debug_str.contains(kp.public.expose()));
assert!(!debug_str.contains(kp.secret.expose_secret()));

§See Also

Fields§

§public: PublicKey

The public key component.

§secret: SecretKey

The secret key component (redacted in debug output).

Trait Implementations§

Source§

impl Debug for KeyPair

Source§

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

Formats the value using the given formatter. Read more

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> 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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V