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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
use anyhow::{anyhow, bail, Result};
use chacha20poly1305::{
    aead::{Aead, NewAead},
    ChaCha20Poly1305, Key, Nonce,
};
use log::{debug, trace};
use rand_core::OsRng;
use serde::{de::DeserializeOwned, Serialize};
use std::{
    any,
    fs::{self, File},
    io::Read,
    path::Path,
};
use x25519_dalek::{SharedSecret, StaticSecret};

/// Add functions to the crypto secret key to make it easier to use.
pub trait StaticSecretExt {
    /// Check whether there is a file containing the crypto keys.
    fn verify_file<P>(file: P) -> bool
    where
        P: AsRef<Path>;

    /// Generate a new secret key with the OS random number generator.
    fn new_with_os_rand() -> StaticSecret;

    /// Try to load the crypto keys from our file on the disk.
    fn from_file<P>(file: P) -> Result<StaticSecret>
    where
        P: AsRef<Path>;

    /// Save the crypto keys to the file on the disk.
    fn save<P>(&self, file: P) -> Result<()>
    where
        P: AsRef<Path>;

    /// Try to load the crypto key or generate a new one.
    fn from_file_or_generate<P>(file: P) -> Result<StaticSecret>
    where
        P: AsRef<Path>,
    {
        if Self::verify_file(&file) {
            // The file exists, open it
            Self::from_file(file)
        } else {
            // The file doesn't exist, generate a new one and save it
            let key = Self::new_with_os_rand();
            key.save(file)?;

            Ok(key)
        }
    }
}

impl StaticSecretExt for StaticSecret {
    fn verify_file<P>(file: P) -> bool
    where
        P: AsRef<Path>,
    {
        // Get the generic as the actual reference so it's traits can be used
        let file = file.as_ref();

        debug!("Verifying file \"{}\"", file.display());

        // TODO: add more checks
        file.is_file()
    }

    fn new_with_os_rand() -> StaticSecret {
        // Get the generic as the actual reference so it's traits can be used
        debug!("Generating new secret key");

        // Generate a secret key
        StaticSecret::new(OsRng)
    }

    fn from_file<P>(file: P) -> Result<StaticSecret>
    where
        P: AsRef<Path>,
    {
        // Get the generic as the actual reference so it's traits can be used
        let file = file.as_ref();

        debug!("Loading secret key from file \"{}\"", file.display());

        // Cannot load from disk if the file is not a valid one
        if !Self::verify_file(file) {
            bail!("Reading crypto keys from file {:?} failed", file);
        }

        // Read the file
        let mut f = File::open(file)
            .map_err(|err| anyhow!("Reading crypto keys from file {:?} failed: {}", file, err))?;

        // Read exactly the bytes from the file
        let mut bytes = [0; 32];
        f.read_exact(&mut bytes).map_err(|err| {
            anyhow!(
                "Crypto keys file {:?} has wrong size, it might be corrupt: {}",
                file,
                err
            )
        })?;

        // Try to construct the secret key from the bytes
        Ok(StaticSecret::from(bytes))
    }

    fn save<P>(&self, file: P) -> Result<()>
    where
        P: AsRef<Path>,
    {
        // Get the generic as the actual reference so it's traits can be used
        let file = file.as_ref();

        debug!("Saving secret key to file \"{}\"", file.display());

        // Try to write the keys as raw bytes to the disk
        fs::write(file, self.to_bytes())
            .map_err(|err| anyhow!("Could not write crypto keys to file {:?}: {}", file, err))
    }
}

/// Encrypt a serializable object into a chacha20poly1305 encoded JSON string.
pub fn encrypt<T>(shared_secret_key: &SharedSecret, obj: &T) -> Result<Vec<u8>>
where
    T: Serialize,
{
    trace!("Encrypting \"{}\" into bytes", any::type_name::<T>());

    // TODO exchange nonce messages
    let nonce = Nonce::from_slice(b"unique nonce");

    // Serialize the object into a JSON byte array
    let json = serde_json::to_vec(obj)?;

    cipher(shared_secret_key)
        // Encrypt the message
        .encrypt(nonce, json.as_slice())
        .map_err(|err| anyhow!("Encrypting message: {}", err))
}

/// Decrypt a chacha20poly1305 encoded JSON string into an object.
pub fn decrypt<T>(shared_secret_key: &SharedSecret, cipher_bytes: &[u8]) -> Result<T>
where
    T: DeserializeOwned,
{
    trace!("Trying to decrypt bytes into \"{}\"", any::type_name::<T>());

    // TODO exchange nonce messages
    let nonce = Nonce::from_slice(b"unique nonce");

    cipher(shared_secret_key)
        // Decrypt the message
        .decrypt(nonce, cipher_bytes)
        .map_err(|err| anyhow!("Decrypting message: {}", err))
        // Try to convert it to a JSON object
        .map(|bytes| {
            serde_json::from_slice(&bytes).map_err(|err| {
                trace!(
                    "JSON resulting in error \"{}\":\n{}",
                    err,
                    String::from_utf8_lossy(&bytes)
                );

                anyhow!("Decrypted JSON is invalid: {}", err)
            })
        })?
}

/// Create a cipher from the shared secret key of a client and the server.
fn cipher(shared_secret_key: &SharedSecret) -> ChaCha20Poly1305 {
    let key = Key::from_slice(shared_secret_key.as_bytes());

    ChaCha20Poly1305::new(key)
}

#[cfg(test)]
mod tests {
    use crate::crypto::{self, StaticSecretExt};
    use anyhow::Result;
    use rand_core::OsRng;
    use serde::{Deserialize, Serialize};
    use x25519_dalek::{EphemeralSecret, PublicKey, StaticSecret};

    #[derive(Serialize, Deserialize, Eq, PartialEq, Debug)]
    struct TestObject {
        string: String,
        int: i64,
        vec: Vec<String>,
    }

    #[test]
    fn default() -> Result<()> {
        // Create a temporary directory for the test database
        let dir = tempfile::tempdir()?;
        // Create the temporary file to save the key in
        let file = dir.path().join("key");

        // Try to load the file, which will fail and generate a new file
        StaticSecret::from_file_or_generate(file)?;

        Ok(())
    }

    #[test]
    fn verify() {
        // A non-existing file means it's not a valid file for the keys
        assert_eq!(
            StaticSecret::verify_file("/definitily/should/not/exist"),
            false
        );
    }

    #[test]
    fn save_and_load() -> Result<()> {
        // Create a temporary directory for the test database
        let dir = tempfile::tempdir()?;
        // Create the temporary file to save the key in
        let file = dir.path().join("key");

        // Generate a new pair of keys.
        let secret = StaticSecret::new_with_os_rand();

        // Save the secret key
        secret.save(&file)?;

        // Load the saved secret key from disk
        let disk_secret = StaticSecret::from_file(file)?;

        // Check if they are the same
        assert_eq!(secret.to_bytes(), disk_secret.to_bytes());

        // Close the directory
        dir.close()?;

        Ok(())
    }

    #[test]
    fn encrypt_decrypt() -> Result<()> {
        // Generate a new shared key
        let alice_secret = EphemeralSecret::new(OsRng);
        let bob_secret = EphemeralSecret::new(OsRng);
        let bob_public = PublicKey::from(&bob_secret);
        let shared_secret = alice_secret.diffie_hellman(&bob_public);

        let obj = TestObject {
            string: "HI".to_string(),
            int: 1234,
            vec: vec!["Hi!".to_string(), "there".to_string()],
        };

        // Encrypt the object
        let cipher_bytes = crypto::encrypt(&shared_secret, &obj)?;

        // Decrypt the encrypted string
        let decrypted: TestObject = crypto::decrypt(&shared_secret, &cipher_bytes)?;

        assert_eq!(obj, decrypted);

        Ok(())
    }
}