ockam_api 0.49.0

Ockam's request-response API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

use std::path::PathBuf;

use ockam_core::async_trait;
use ockam_core::Result;

use crate::NamedVault;

/// This trait allows vaults to be defined with a name and a path
/// in order to make it possible to store identity keys in different databases on disk (or in a KMS)
#[async_trait]
pub trait VaultsRepository: Send + Sync + 'static {
    /// Store a new vault path with an associated name
    async fn store_vault(&self, name: &str, path: PathBuf, is_kms: bool) -> Result<NamedVault>;

    /// Delete a vault given its name
    async fn delete_vault(&self, name: &str) -> Result<()>;

    /// Return a vault by name
    async fn get_named_vault(&self, name: &str) -> Result<Option<NamedVault>>;

    /// Return all vaults
    async fn get_named_vaults(&self) -> Result<Vec<NamedVault>>;

    /// Return the default vault
    async fn get_default_vault(&self) -> Result<Option<NamedVault>>;

    /// Set a vault as the default one. Any previous default vault is unset
    async fn set_as_default(&self, name: &str) -> Result<()>;

    async fn is_default(&self, name: &str) -> Result<bool>;
}