Skip to main content

UserKey

Struct UserKey 

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

A user-level ed25519 keypair. Root of trust for an agent mesh.

The private half is held in memory by this struct and zeroized on drop. Use save to persist to disk (refuses to overwrite existing files) and load to rehydrate.

Implementations§

Source§

impl UserKey

Source

pub fn generate() -> Self

Generate a fresh user key from the operating system RNG.

Source

pub fn public(&self) -> UserPublic

Public verifying half of the key — safe to share with peers.

Source

pub fn fingerprint(&self) -> Fingerprint

BLAKE3 fingerprint of the public key bytes.

Source

pub fn sign(&self, message: &[u8]) -> Signature

Sign an arbitrary message with the user’s root key.

In practice this is called sparingly — typically just to issue agent certificates and the one-time GitHub binding.

Source

pub fn save(&self, path: &Path) -> Result<()>

Save the private key to disk in PKCS#8 PEM format.

Refuses to overwrite an existing file (returns MeshError::Io with AlreadyExists). On Unix systems the resulting file is chmod 0600. The parent directory is created if it doesn’t exist.

Source

pub fn load(path: &Path) -> Result<Self>

Load a private key previously written by save.

Trait Implementations§

Source§

impl Debug for UserKey

Source§

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

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

impl Drop for UserKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,