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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use crate::NamedIdentity;
use ockam::identity::Identifier;
use ockam_core::async_trait;
use ockam_core::Result;

/// The identities repository stores metadata about identities
/// which change history have been stored in the ChangeHistoryRepository.
///
/// It allows to:
///
///  - associate a user name to an identity
///  - set one (and one only) identity as the default identity
///  - associate a vault name to an identity so that we know where the identity private keys can be found
///
/// By default the get/delete functions use the identity name as a parameter.
/// When they use the identity identifier instead, this is indicated in the function name:
/// e.g. get_named_identity_by_identifier()
///
#[async_trait]
pub trait IdentitiesRepository: Send + Sync + 'static {
    /// Associate a name to an identity
    async fn store_named_identity(
        &self,
        identifier: &Identifier,
        name: &str,
        vault_name: &str,
    ) -> Result<NamedIdentity>;

    /// Delete an identity given its name and return its identifier
    async fn delete_identity(&self, name: &str) -> Result<Option<Identifier>>;

    /// Delete an identity given its identifier and return its name
    async fn delete_identity_by_identifier(
        &self,
        identifier: &Identifier,
    ) -> Result<Option<String>>;

    /// Return the identifier associated to a named identity
    async fn get_identifier(&self, name: &str) -> Result<Option<Identifier>>;

    /// Return the name associated to an identifier
    async fn get_identity_name_by_identifier(
        &self,
        identifier: &Identifier,
    ) -> Result<Option<String>>;

    /// Return the named identity with a specific name
    async fn get_named_identity(&self, name: &str) -> Result<Option<NamedIdentity>>;

    /// Return the named identity associated to an identifier
    async fn get_named_identity_by_identifier(
        &self,
        identifier: &Identifier,
    ) -> Result<Option<NamedIdentity>>;

    /// Return identities which have been given a name
    async fn get_named_identities(&self) -> Result<Vec<NamedIdentity>>;

    /// Set an identity as the default one, given its name
    async fn set_as_default(&self, name: &str) -> Result<()>;

    /// Set an identity as the default one, given its identifier
    async fn set_as_default_by_identifier(&self, identifier: &Identifier) -> Result<()>;

    /// Return the default named identity
    async fn get_default_named_identity(&self) -> Result<Option<NamedIdentity>>;
}