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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use ockam_core::compat::sync::Arc;

use crate::purpose_keys::storage::PurposeKeysRepository;
use crate::{
    ChangeHistoryRepository, IdentitiesKeys, PurposeKeyCreation, PurposeKeyVerification, Vault,
};

/// This struct supports all the services related to identities
#[derive(Clone)]
pub struct PurposeKeys {
    vault: Vault,
    change_history_repository: Arc<dyn ChangeHistoryRepository>,
    identity_keys: Arc<IdentitiesKeys>,
    repository: Arc<dyn PurposeKeysRepository>,
}

impl PurposeKeys {
    /// Create a new identities module
    pub fn new(
        vault: Vault,
        change_history_repository: Arc<dyn ChangeHistoryRepository>,
        identity_keys: Arc<IdentitiesKeys>,
        repository: Arc<dyn PurposeKeysRepository>,
    ) -> Self {
        Self {
            vault,
            change_history_repository,
            identity_keys,
            repository,
        }
    }

    /// Return [`PurposeKeysRepository`] instance
    pub fn repository(&self) -> Arc<dyn PurposeKeysRepository> {
        self.repository.clone()
    }

    /// Create [`PurposeKeyCreation`]
    pub fn purpose_keys_creation(&self) -> Arc<PurposeKeyCreation> {
        Arc::new(PurposeKeyCreation::new(
            self.vault.clone(),
            self.change_history_repository.clone(),
            self.identity_keys.clone(),
            self.repository.clone(),
        ))
    }

    /// Create [`PurposeKeyVerification`]
    pub fn purpose_keys_verification(&self) -> Arc<PurposeKeyVerification> {
        Arc::new(PurposeKeyVerification::new(
            self.vault.verifying_vault.clone(),
            self.change_history_repository.clone(),
        ))
    }
}

#[cfg(test)]
mod tests {
    use ockam_core::Result;

    use crate::{identities, Purpose};

    #[tokio::test]
    async fn create_purpose_keys() -> Result<()> {
        let identities = identities().await?;
        let identities_creation = identities.identities_creation();
        let purpose_keys = identities.purpose_keys();

        let identifier = identities_creation.create_identity().await?;
        let credentials_key = purpose_keys
            .purpose_keys_creation()
            .create_credential_purpose_key(&identifier)
            .await?;
        let secure_channel_key = purpose_keys
            .purpose_keys_creation()
            .create_secure_channel_purpose_key(&identifier)
            .await?;

        let credentials_key = purpose_keys
            .purpose_keys_verification()
            .verify_purpose_key_attestation(Some(&identifier), credentials_key.attestation())
            .await?;
        let secure_channel_key = purpose_keys
            .purpose_keys_verification()
            .verify_purpose_key_attestation(Some(&identifier), secure_channel_key.attestation())
            .await?;

        assert_eq!(identifier, credentials_key.subject);
        assert_eq!(identifier, secure_channel_key.subject);

        Ok(())
    }

    #[tokio::test]
    async fn test_purpose_keys_are_persisted() -> Result<()> {
        let identities = identities().await?;
        let identities_creation = identities.identities_creation();
        let purpose_keys = identities.purpose_keys();

        let identifier = identities_creation.create_identity().await?;

        let credentials_key = purpose_keys
            .purpose_keys_creation()
            .create_credential_purpose_key(&identifier)
            .await?;

        assert!(purpose_keys
            .repository()
            .get_purpose_key(&identifier, Purpose::Credentials)
            .await?
            .is_some());
        assert!(purpose_keys
            .repository()
            .get_purpose_key(&identifier, Purpose::SecureChannel)
            .await?
            .is_none());

        let secure_channel_key = purpose_keys
            .purpose_keys_creation()
            .create_secure_channel_purpose_key(&identifier)
            .await?;

        let key = purpose_keys
            .repository()
            .get_purpose_key(&identifier, Purpose::Credentials)
            .await?
            .unwrap();
        purpose_keys
            .purpose_keys_verification()
            .verify_purpose_key_attestation(Some(&identifier), &key)
            .await
            .unwrap();
        assert_eq!(&key, credentials_key.attestation());

        let key = purpose_keys
            .repository()
            .get_purpose_key(&identifier, Purpose::SecureChannel)
            .await?
            .unwrap();
        purpose_keys
            .purpose_keys_verification()
            .verify_purpose_key_attestation(Some(&identifier), &key)
            .await
            .unwrap();
        assert_eq!(&key, secure_channel_key.attestation());

        let credentials_key2 = purpose_keys
            .purpose_keys_creation()
            .create_credential_purpose_key(&identifier)
            .await?;

        let key = purpose_keys
            .repository()
            .get_purpose_key(&identifier, Purpose::Credentials)
            .await?
            .unwrap();
        purpose_keys
            .purpose_keys_verification()
            .verify_purpose_key_attestation(Some(&identifier), &key)
            .await
            .unwrap();
        assert_eq!(&key, credentials_key2.attestation());

        Ok(())
    }
}