iota-sdk 1.0.1

The IOTA SDK provides developers with a seamless experience to develop on IOTA by providing account abstractions and clients to interact with node APIs.
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

// Copyright 2022 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

//! The `StorageAdapter` implementation for `StrongholdAdapter`.

use async_trait::async_trait;
use crypto::ciphers::{chacha::XChaCha20Poly1305, traits::Aead};
use iota_stronghold::{
    procedures::{self, AeadCipher},
    Location,
};
use zeroize::Zeroizing;

use super::{
    common::{PRIVATE_DATA_CLIENT_PATH, SECRET_VAULT_PATH, USERDATA_STORE_KEY_RECORD_PATH},
    StrongholdAdapter,
};
use crate::client::{storage::StorageAdapter, stronghold::Error};

#[async_trait]
impl StorageAdapter for StrongholdAdapter {
    type Error = Error;

    async fn get_bytes(&self, key: &str) -> Result<Option<Vec<u8>>, Self::Error> {
        let stronghold_client = self.stronghold.lock().await.get_client(PRIVATE_DATA_CLIENT_PATH)?;

        let mut data = match stronghold_client.store().get(key.as_bytes())? {
            Some(data) => data,
            None => return Ok(None),
        };

        let store_key_location = Location::generic(SECRET_VAULT_PATH, USERDATA_STORE_KEY_RECORD_PATH);

        let decrypted_value = stronghold_client.execute_procedure(procedures::AeadDecrypt {
            cipher: AeadCipher::XChaCha20Poly1305,
            associated_data: Vec::new(),
            nonce: data.drain(..XChaCha20Poly1305::NONCE_LENGTH).collect(),
            tag: data.drain(..XChaCha20Poly1305::TAG_LENGTH).collect(),
            ciphertext: data,
            key: store_key_location,
        })?;

        Ok(Some(decrypted_value))
    }

    async fn set_bytes(&self, key: &str, record: &[u8]) -> Result<(), Self::Error> {
        let stronghold_client = self.stronghold.lock().await.get_client(PRIVATE_DATA_CLIENT_PATH)?;
        let store_key_location = Location::generic(SECRET_VAULT_PATH, USERDATA_STORE_KEY_RECORD_PATH);

        // Generate and store encryption key if not existent yet.
        if !stronghold_client.record_exists(&store_key_location)? {
            let mut key = Zeroizing::new(vec![0_u8; 32]);
            crypto::utils::rand::fill(key.as_mut())?;
            let vault_path = store_key_location.vault_path();
            let vault = stronghold_client.vault(vault_path);
            vault.write_secret(store_key_location.clone(), key)?;
        }

        let mut nonce = [0; XChaCha20Poly1305::NONCE_LENGTH];
        crypto::utils::rand::fill(&mut nonce)?;

        let encrypted_value = stronghold_client.execute_procedure(procedures::AeadEncrypt {
            cipher: AeadCipher::XChaCha20Poly1305,
            associated_data: Vec::new(),
            nonce: nonce.to_vec(),
            plaintext: record.to_vec(),
            key: store_key_location,
        })?;

        // The value is assumed to be `nonce || tag || ciphertext`
        let final_data = [nonce.to_vec(), encrypted_value].concat();

        stronghold_client
            .store()
            .insert(key.as_bytes().to_vec(), final_data, None)?;
        Ok(())
    }

    async fn delete(&self, key: &str) -> Result<(), Self::Error> {
        self.stronghold
            .lock()
            .await
            .get_client(PRIVATE_DATA_CLIENT_PATH)?
            .store()
            .delete(key.as_bytes())?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {

    #[tokio::test]
    async fn test_stronghold_db() {
        use std::fs;

        use super::StrongholdAdapter;
        use crate::client::storage::StorageAdapter;

        let snapshot_path = "test_stronghold_db.stronghold";

        fs::remove_file(snapshot_path).unwrap_or(());

        let stronghold = StrongholdAdapter::builder()
            .password("drowssap".to_owned())
            .build(snapshot_path)
            .unwrap();

        assert!(matches!(stronghold.get::<String>("test-0").await, Ok(None)));
        assert!(matches!(stronghold.get::<String>("test-1").await, Ok(None)));
        assert!(matches!(stronghold.get::<String>("test-2").await, Ok(None)));

        assert!(matches!(stronghold.set("test-0", "test-0").await, Ok(())));
        assert!(matches!(stronghold.set("test-1", "test-1").await, Ok(())));
        assert!(matches!(stronghold.set("test-2", "test-2").await, Ok(())));

        assert!(matches!(stronghold.get::<String>("test-0").await, Ok(Some(s)) if s == "test-0"));
        assert!(matches!(stronghold.get::<String>("test-1").await, Ok(Some(s)) if s == "test-1"));
        assert!(matches!(stronghold.get::<String>("test-2").await, Ok(Some(s)) if s == "test-2"));

        assert!(matches!(stronghold.delete("test-0").await, Ok(())));
        assert!(matches!(stronghold.delete("test-1").await, Ok(())));
        assert!(matches!(stronghold.delete("test-2").await, Ok(())));

        assert!(matches!(stronghold.get::<String>("test-0").await, Ok(None)));
        assert!(matches!(stronghold.get::<String>("test-1").await, Ok(None)));
        assert!(matches!(stronghold.get::<String>("test-2").await, Ok(None)));

        fs::remove_file(snapshot_path).unwrap();
    }
}