Skip to main content

RootKey

Struct RootKey 

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

A root identity key.

This is the primary key that defines an agent’s identity. It should be stored securely and used sparingly.

§Security

  • The inner SigningKey automatically zeroizes secret key bytes on drop (via ed25519-dalek’s zeroize feature).
  • The Debug implementation only shows the DID (public info) to prevent accidental exposure of key material in logs.

Implementations§

Source§

impl RootKey

Source

pub fn generate() -> RootKey

Generate a new random root key.

Source

pub fn from_bytes(bytes: &[u8; 32]) -> Result<RootKey, Error>

Create from existing bytes.

§Security

The caller should zeroize the source bytes after this call if they are no longer needed.

Source

pub fn did(&self) -> Did

Get the DID for this root key.

Source

pub fn verifying_key(&self) -> VerifyingKey

Get the public verifying key.

Source

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

Sign a message.

Source

pub fn to_bytes(&self) -> [u8; 32]

Get the secret key bytes.

§Security Warning

This returns raw secret key material. The caller is responsible for:

  • Storing the bytes securely
  • Zeroizing the bytes when no longer needed
  • Not logging or printing these bytes

Trait Implementations§

Source§

impl Debug for RootKey

Source§

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

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