Skip to main content

UnlockedMasterSeed

Struct UnlockedMasterSeed 

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

A live, in-memory account root whose BIP-39 entropy has been decrypted and is ready to (a) reconstruct the wallet MasterKey app-side, (b) derive the dig-identity signing key + profile DEK in-crate, and (c) render the 24-word recovery phrase for the user.

Obtained from crate::Session::enroll_master_seed, crate::Session::enroll_from_recovery_phrase or crate::Session::unlock_master_seed. The entropy lives in a Zeroizing buffer wiped when this value drops. The type deliberately does not implement Clone and its Debug impl redacts the secret.

§Boundaries

An UnlockedMasterSeed must never cross an IPC boundary: it holds the root wallet secret and belongs solely to the user-app process that owns the identity (dig_ecosystem #908). It stays user-side; this crate crosses no engine/IPC boundary.

Implementations§

Source§

impl UnlockedMasterSeed

Source

pub fn master_seed(&self) -> Zeroizing<[u8; 64]>

The expanded 64-byte master HD seed.

This is the value an app-tier consumer feeds to wallet-backend’s MasterKey::from_seed_bytes to reconstruct the wallet master key (MasterKey::from_seed_bytes(handle.master_seed().to_vec())). It is byte-identical to what Sage and every standard Chia wallet derive from the same 24 words, so the wallet addresses match.

The returned buffer is Zeroizing, so the caller’s copy is wiped on drop — it is the caller’s responsibility to keep it zeroizing all the way into from_seed_bytes (whose parameter is itself moved into a Zeroizing buffer).

A primitive byte array is returned (never a wallet-backend type) to keep dig-session free of any upward @10 -> @20 dependency edge.

Source

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

The RECOVERY_PHRASE_WORDS-word BIP-39 recovery phrase for this account, space-separated and lowercase.

Takes &self: showing the user their phrase must not cost them their session, so the handle stays usable afterwards. Typing these words into Sage — or into Session::enroll_from_recovery_phrase on a new machine — reproduces this exact account.

§Never log this (the type will NOT stop you)

The returned String is Zeroizing, so its heap buffer is wiped on drop — but Zeroizing<String> derefs to String, so info!("{phrase}") compiles without complaint. And dig-logging’s BIP-39 redactor runs at bundle time, not at write time: a logged phrase sits in plaintext on disk until (and unless) a bundle is built. Treat that redactor as a last-resort scrub, never as protection.

Source

pub fn public_key(&self) -> [u8; 48]

The 48-byte compressed BLS12-381 G1 dig-identity public key derived from the expanded master seed at the canonical hardened path m/12381'/8444'/9'/0'.

Byte-identical to dig_identity::public_key_bytes(derive_identity_sk(master_secret_key_from_seed(master_seed))), so signatures produced here verify against the published DID identity.

Source

pub fn sign(&self, msg: &[u8]) -> [u8; 96]

Sign msg with the dig-identity key derived from the master seed, returning the 96-byte G2 AugScheme signature.

The signature verifies under public_key.

Source

pub fn derive_symmetric_key(&self, label: &[u8]) -> Zeroizing<[u8; 32]>

Derive a per-profile symmetric key (DEK) bound to label.

The identity scalar is re-derived from the expanded master seed and fed to the frozen HKDF construction shared with every other DEK path ([derive_symmetric_key_from_scalar]): HKDF-SHA256(ikm = IDENTITY_IKM_VERSION || identity_scalar, salt = DEK_SALT, info = label) → SYMMETRIC_KEY_LEN bytes. The HKDF is never duplicated, so all paths stay byte-compatible for one root.

The returned key and all intermediates are wrapped in Zeroizing.

Source

pub fn profile_public_key(&self, profile_ix: u32) -> [u8; 48]

The 48-byte compressed BLS12-381 G1 dig-identity public key for the profile at profile_ix, derived from the expanded master seed at m/12381'/8444'/9'/{profile_ix}' via dig_identity::derive_identity_sk_at.

§profile_ix == 0 is byte-identical to public_key

derive_identity_sk_at(master, 0) == derive_identity_sk(master) (adversarial-confirmed in dig-identity 0.5.0), so profile_public_key(0) == public_key() byte-for-byte — the default path is exactly profile 0. Each profile_ix yields a distinct, deterministic key.

Source

pub fn profile_sign(&self, profile_ix: u32, msg: &[u8]) -> [u8; 96]

Sign msg with the profile at profile_ix’s derived identity key, returning the 96-byte G2 AugScheme signature.

The signature verifies under profile_public_key(profile_ix). profile_sign(0, msg) == sign(msg) byte-for-byte.

Source

pub fn profile_derive_symmetric_key( &self, profile_ix: u32, label: &[u8], ) -> Zeroizing<[u8; 32]>

Derive the profile at profile_ix’s per-profile symmetric key (DEK) bound to label.

The profile’s identity scalar is derived from the expanded master seed via dig_identity::derive_identity_sk_at and fed to the SAME frozen HKDF construction as every other DEK path ([derive_symmetric_key_from_scalar]) — the HKDF is never duplicated, so all paths stay byte-compatible for the same underlying scalar.

§profile_ix == 0 is byte-identical to

derive_symmetric_key

Because derive_identity_sk_at(master, 0) == derive_identity_sk(master), profile_derive_symmetric_key(0, label) == derive_symmetric_key(label) byte-for-byte. Each profile_ix yields a distinct, deterministic DEK.

The returned key and all intermediates are wrapped in Zeroizing.

Source

pub fn signing_fn(&self) -> IdentitySigningFn

Produce a standalone signing primitive that signs with this identity’s key — a plain callable carrying no dig-session or identity type.

The closure owns its own zeroizing copy of the entropy, so it keeps working after this handle is dropped and wipes its copy when the closure itself is dropped. This is how a downstream stays identity-agnostic while still being able to sign (dig_ecosystem #908).

Trait Implementations§

Source§

impl Debug for UnlockedMasterSeed

Redacting Debug: shows the type name only, never the secret.

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

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
Source§

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

Source§

fn vzip(self) -> V