Struct hc_seed_bundle::UnlockedSeedBundle

pub struct UnlockedSeedBundle { /* private fields */ }

This is the main struct for interacting with SeedBundles.

To create an UnlockedSeedBundle:

• A new random bundle: UnlockedSeedBundle::new_random
• Derived from an existing bundle: UnlockedSeedBundle::derive
• Unlock encrypted bundle bytes: UnlockedSeedBundle::from_locked

Once unlocked, you can get or set associated app data, or sign messages.

To “lock” (generate encrypted binary seed bundle representation), use UnlockedSeedBundle::lock and supply the desired SeedCiphers.

Implementations

impl UnlockedSeedBundle

pub async fn new_random() -> SodokenResult<Self>

Construct a new random seed SeedBundle.

pub async fn from_locked(bytes: &[u8]) -> SodokenResult<Vec<LockedSeedCipher>>

Decode locked SeedBundle bytes into a list of LockedSeedCiphers to be used for decrypting the bundle.

pub fn get_seed(&self) -> BufReadSized<32>

Get the actual seed tracked by this seed bundle.

pub fn derive( &self, index: u32 ) -> impl Future<Output = SodokenResult<Self>> + 'static + Send

Derive a new sub SeedBundle by given index.

pub fn get_sign_pub_key( &self ) -> BufReadSized<{ sodoken::sign::PUBLICKEYBYTES }>

Get the signature pub key generated by this seed.

pub fn sign_detached<M>( &self, message: M ) -> impl Future<Output = SodokenResult<BufReadSized<{ sodoken::sign::BYTES }>>> + 'static + Send

where M: Into<BufRead> + 'static + Send,

Sign some data with the secret key generated by this seed.

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

Get the raw appData bytes.

pub fn set_app_data_bytes<B>(&mut self, app_data: B)

where B: Into<Arc<[u8]>>,

Set the raw appData bytes.

pub fn get_app_data<T>(&self) -> SodokenResult<T>

where T: 'static + for<'de> Deserialize<'de>,

Get the decoded appData bytes by type.

pub fn set_app_data<T>(&mut self, t: &T) -> SodokenResult<()>

where T: Serialize,

Set the encoded appData bytes by type.

pub fn lock(&self) -> SeedCipherBuilder

Get a SeedCipherBuilder that will allow us to lock this bundle.

Trait Implementations

impl Clone for UnlockedSeedBundle

fn clone(&self) -> UnlockedSeedBundle

Returns a copy of the value.

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

Performs copy-assignment from source.