ockam_identity 0.134.0

Ockam is a library for building devices that communicate securely, privately and trustfully with cloud services and other devices.
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use ockam_core::compat::sync::Arc;
#[cfg(feature = "storage")]
use ockam_core::Result;
use ockam_vault::storage::SecretsRepository;

use crate::identities::ChangeHistoryRepository;
use crate::purpose_keys::storage::PurposeKeysRepository;
use crate::secure_channel::SecureChannelRegistry;
use crate::secure_channels::SecureChannels;
use crate::{
    CredentialRepository, IdentitiesBuilder, IdentityAttributesRepository, SecureChannelRepository,
    Vault,
};

/// This struct supports all the services related to secure channels
#[derive(Clone)]
pub struct SecureChannelsBuilder {
    // FIXME: This is very strange dependency
    pub(crate) identities_builder: IdentitiesBuilder,
    pub(crate) registry: SecureChannelRegistry,
    pub(crate) secure_channel_repository: Arc<dyn SecureChannelRepository>,
}

/// Create default, in-memory, secure channels (mostly for examples and testing)
#[cfg(feature = "storage")]
pub async fn secure_channels() -> Result<Arc<SecureChannels>> {
    Ok(SecureChannels::builder().await?.build())
}

impl SecureChannelsBuilder {
    /// With Software Vault with given secrets repository
    pub fn with_secrets_repository(mut self, repository: Arc<dyn SecretsRepository>) -> Self {
        self.identities_builder = self.identities_builder.with_secrets_repository(repository);
        self
    }

    /// Set [`Vault`]
    pub fn with_vault(mut self, vault: Vault) -> Self {
        self.identities_builder = self.identities_builder.with_vault(vault);
        self
    }

    /// Set a specific identities repository
    pub fn with_change_history_repository(
        mut self,
        repository: Arc<dyn ChangeHistoryRepository>,
    ) -> Self {
        self.identities_builder = self
            .identities_builder
            .with_change_history_repository(repository);
        self
    }

    /// Set a specific identity attributes repository
    pub fn with_identity_attributes_repository(
        mut self,
        repository: Arc<dyn IdentityAttributesRepository>,
    ) -> Self {
        self.identities_builder = self
            .identities_builder
            .with_identity_attributes_repository(repository);
        self
    }

    /// Set a specific purpose keys repository
    pub fn with_purpose_keys_repository(
        mut self,
        repository: Arc<dyn PurposeKeysRepository>,
    ) -> Self {
        self.identities_builder = self
            .identities_builder
            .with_purpose_keys_repository(repository);
        self
    }

    /// Set a specific cached credentials repository
    pub fn with_cached_credential_repository(
        mut self,
        repository: Arc<dyn CredentialRepository>,
    ) -> Self {
        self.identities_builder = self
            .identities_builder
            .with_cached_credential_repository(repository);
        self
    }

    /// Set a specific secure channels repository
    pub fn with_secure_channel_repository(
        mut self,
        repository: Arc<dyn SecureChannelRepository>,
    ) -> Self {
        self.secure_channel_repository = repository;
        self
    }

    /// Set a specific channel registry
    pub fn with_secure_channels_registry(mut self, registry: SecureChannelRegistry) -> Self {
        self.registry = registry;
        self
    }

    /// Return the vault used by this builder
    /// Build secure channels
    pub fn build(self) -> Arc<SecureChannels> {
        let identities = self.identities_builder.build();
        Arc::new(SecureChannels::new(
            identities,
            self.registry,
            self.secure_channel_repository,
        ))
    }
}