Struct btlib_tests::InMemCredStore

pub struct InMemCredStore { /* private fields */ }

A credential store that keeps all credential in memory. Thus these credentials will be lost when this struct is dropped.

Implementations

impl InMemCredStore

pub fn new() -> Result<Self>

Trait Implementations

impl CredStore for InMemCredStore

type CredHandle = Arc<ConcreteCreds>

The type of the credential handle returned by this store.

type ExportedCreds = ExportedCreds

The type of the exported credentials returned by this store.

fn node_creds(&self) -> Result<Self::CredHandle>

Returns the node credentials. If credentials haven’t been generated, they are generated stored and returned.

fn root_creds(&self, password: &str) -> Result<Self::CredHandle>

Returns the root credentials. If no root credentials have been generated, or the provided password is incorrect, then an error is returned.

fn storage_key(&self) -> Result<AsymKeyPub<Encrypt>>

Returns a public key which can be used to encrypt data intended only to be accessed by this node. The returned key can be given as the new_parent parameter to the [CredStore::export_root_creds] method.

fn export_root_creds( &self, root_creds: &Self::CredHandle, _password: &str, _new_parent: &AsymKeyPub<Encrypt> ) -> Result<Self::ExportedCreds>

Exports the root credentials. These can be serialized and persisted external to the application and later loaded and deserialized and passed to the [CredStoreMut::import_root_creds] method. The password argument must match the value provided when the [CredStore::root_creds] method was called. The new_parent argument is the public key of the node that is to import the root key, which can be obtained using the [CredStoreMut::gen_root_creds] method on the importing node.

impl CredStoreMut for InMemCredStore

fn gen_root_creds(&self, password: &str) -> Result<Self::CredHandle>

Generates the root credentials and protects them using the given password. If the root credentials have already been generated then an error is returned.

fn import_root_creds( &self, password: &str, exported: Self::ExportedCreds ) -> Result<Self::CredHandle>

Imports root credentials that were previously created with [CredStore::export_root_creds]. The provided password must match the value that was given to that method.

fn assign_node_writecap( &self, handle: &mut Self::CredHandle, writecap: Writecap ) -> Result<()>

Assigns the given [Writecap] to the node credentials referred to by the given handle. This method is responsible for committing the given [Writecap] to durable storage.

fn assign_root_writecap( &self, handle: &mut Self::CredHandle, writecap: Writecap ) -> Result<()>

Assigns writecap to the root credentials referred to by handle. This method is responsible for committing the given [Writecap] to durable storage.

fn provision_root( &self, password: &str, expires: Epoch ) -> Result<Self::CredHandle, Error>

Generates new root credentials protected by password and issues them a self-signed [Writecap] which expires after valid_for. The newly generated root credentials are returned.

fn provision_node_start(&self) -> Result<Principal, Error>

Begin the provisioning process for a node by generating a new set of node credentials. The [Principal] of the newly generated credentials is returned. This [Principal] may then be transmitted to a root node which can use it to issue a [Writecap] to this node.

fn provision_node_finish( &self, writecap: Writecap ) -> Result<Self::CredHandle, Error>

Assigns the given [Writecap] to the node credentials and commits it to durable storage. A handle to the node credentials is returned.