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

use ockam_core::compat::sync::Arc;
#[cfg(feature = "storage")]
use ockam_core::Result;
#[cfg(feature = "storage")]
use ockam_node::database::SqlxDatabase;
use ockam_vault::storage::SecretsRepository;
#[cfg(feature = "storage")]
use ockam_vault::storage::SecretsSqlxDatabase;
use ockam_vault::{
    SoftwareVaultForSecureChannels, SoftwareVaultForSigning, SoftwareVaultForVerifyingSignatures,
    VaultForSecureChannels, VaultForSigning, VaultForVerifyingSignatures,
};

/// Vault
#[derive(Clone)]
pub struct Vault {
    /// Vault used for Identity Keys
    pub identity_vault: Arc<dyn VaultForSigning>,
    /// Vault used for Secure Channels
    pub secure_channel_vault: Arc<dyn VaultForSecureChannels>,
    /// Vault used for signing Credentials
    pub credential_vault: Arc<dyn VaultForSigning>,
    /// Vault used for verifying signature and sha256
    pub verifying_vault: Arc<dyn VaultForVerifyingSignatures>,
}

impl Vault {
    /// Constructor
    pub fn new(
        identity_vault: Arc<dyn VaultForSigning>,
        secure_channel_vault: Arc<dyn VaultForSecureChannels>,
        credential_vault: Arc<dyn VaultForSigning>,
        verifying_vault: Arc<dyn VaultForVerifyingSignatures>,
    ) -> Self {
        Self {
            identity_vault,
            secure_channel_vault,
            credential_vault,
            verifying_vault,
        }
    }

    /// Create Software implementation Vault with an in-memory storage
    #[cfg(feature = "storage")]
    pub async fn create() -> Result<Self> {
        Ok(Self::new(
            Self::create_identity_vault().await?,
            Self::create_secure_channel_vault().await?,
            Self::create_credential_vault().await?,
            Self::create_verifying_vault(),
        ))
    }

    /// Create [`SoftwareVaultForSigning`] with an in-memory storage
    #[cfg(feature = "storage")]
    pub async fn create_identity_vault() -> Result<Arc<dyn VaultForSigning>> {
        Ok(Arc::new(SoftwareVaultForSigning::new(Arc::new(
            SecretsSqlxDatabase::create().await?,
        ))))
    }

    /// Create [`SoftwareSecureChannelVault`] with an in-memory storage
    #[cfg(feature = "storage")]
    pub async fn create_secure_channel_vault() -> Result<Arc<dyn VaultForSecureChannels>> {
        Ok(Arc::new(SoftwareVaultForSecureChannels::new(Arc::new(
            SecretsSqlxDatabase::create().await?,
        ))))
    }

    /// Create [`SoftwareVaultForSigning`] with an in-memory storage
    #[cfg(feature = "storage")]
    pub async fn create_credential_vault() -> Result<Arc<dyn VaultForSigning>> {
        Ok(Arc::new(SoftwareVaultForSigning::new(Arc::new(
            SecretsSqlxDatabase::create().await?,
        ))))
    }

    /// Create [`SoftwareVaultForVerifyingSignatures`]
    pub fn create_verifying_vault() -> Arc<dyn VaultForVerifyingSignatures> {
        Arc::new(SoftwareVaultForVerifyingSignatures {})
    }
}

impl Vault {
    /// Create Software Vaults and persist them to a sql database
    #[cfg(feature = "storage")]
    pub fn create_with_database(database: SqlxDatabase) -> Vault {
        Self::create_with_secrets_repository(Arc::new(SecretsSqlxDatabase::new(database)))
    }

    /// Create Software Vaults with a given secrets repository
    pub fn create_with_secrets_repository(repository: Arc<dyn SecretsRepository>) -> Vault {
        Self::new(
            Arc::new(SoftwareVaultForSigning::new(repository.clone())),
            Arc::new(SoftwareVaultForSecureChannels::new(repository.clone())),
            Arc::new(SoftwareVaultForSigning::new(repository.clone())),
            Arc::new(SoftwareVaultForVerifyingSignatures {}),
        )
    }
}