zopp-crypto 0.1.1

Zero-knowledge cryptographic primitives for zopp secrets manager
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
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
use chacha20poly1305::{aead::Aead, KeyInit};
use rand_core::RngCore;
use sha2::{Digest, Sha256};
use thiserror::Error;
use x25519_dalek::{PublicKey, StaticSecret};
use zeroize::Zeroizing;

#[derive(zeroize::Zeroize, zeroize::ZeroizeOnDrop)]
#[allow(dead_code)]
pub struct MasterKey(Zeroizing<[u8; 32]>);

#[derive(Debug, Error)]
pub enum KdfError {
    #[error("invalid kdf parameters")]
    InvalidParams(argon2::Error),
    #[error("key derivation failed")]
    DerivationFailed(argon2::Error),
}

const MIB: u32 = 1024;
const MEMORY_COST_KIB: u32 = 64 * MIB;

/// Derive master key from passphrase
pub fn derive_master_key(pass: &str, salt: &[u8]) -> Result<MasterKey, KdfError> {
    let mut key = Zeroizing::new([0u8; 32]);

    let params =
        argon2::Params::new(MEMORY_COST_KIB, 3, 1, None).map_err(KdfError::InvalidParams)?;

    let argon2 = argon2::Argon2::new(argon2::Algorithm::Argon2id, argon2::Version::V0x13, params);

    argon2
        .hash_password_into(pass.as_bytes(), salt, key.as_mut())
        .map_err(KdfError::DerivationFailed)?;

    Ok(MasterKey(key))
}

#[derive(zeroize::Zeroize, zeroize::ZeroizeOnDrop)]
pub struct Dek(Zeroizing<[u8; 32]>);
impl Dek {
    pub fn as_bytes(&self) -> &[u8; 32] {
        &self.0
    }

    pub fn from_bytes(bytes: &[u8; 32]) -> Result<Self, &'static str> {
        Ok(Dek(Zeroizing::new(*bytes)))
    }
}

/// Generate new DEK for an environment
pub fn generate_dek() -> Dek {
    let mut key = Zeroizing::new([0u8; 32]);
    rand_core::OsRng.fill_bytes(key.as_mut());
    Dek(key)
}

pub struct Nonce(pub [u8; 24]);
pub struct Ciphertext(pub Vec<u8>);

#[derive(Debug, Error)]
pub enum EncryptError {
    #[error("AEAD encryption failed")]
    AeadFailed(chacha20poly1305::aead::Error),
}

/// AEAD encrypt
pub fn encrypt(
    plaintext: &[u8],
    dek: &Dek,
    aad: &[u8],
) -> Result<(Nonce, Ciphertext), EncryptError> {
    let key = chacha20poly1305::Key::from(*dek.as_bytes());
    let cipher = chacha20poly1305::XChaCha20Poly1305::new(&key);

    let mut nonce_bytes = [0u8; 24];
    rand_core::OsRng.fill_bytes(&mut nonce_bytes);

    let nonce = chacha20poly1305::XNonce::from(nonce_bytes);
    let ct = cipher
        .encrypt(
            &nonce,
            chacha20poly1305::aead::Payload {
                msg: plaintext,
                aad,
            },
        )
        .map_err(EncryptError::AeadFailed)?;

    Ok((Nonce(nonce_bytes), Ciphertext(ct)))
}

#[derive(Debug, Error)]
pub enum DecryptError {
    #[error("AEAD decryption failed")]
    AeadFailed(chacha20poly1305::aead::Error),
}

/// AEAD decrypt
pub fn decrypt(
    ciphertext: &[u8],
    nonce: &Nonce,
    dek: &Dek,
    aad: &[u8],
) -> Result<Zeroizing<Vec<u8>>, DecryptError> {
    let key = chacha20poly1305::Key::from(*dek.as_bytes());
    let cipher = chacha20poly1305::XChaCha20Poly1305::new(&key);

    let nonce = chacha20poly1305::XNonce::from(nonce.0);

    let pt = cipher
        .decrypt(
            &nonce,
            chacha20poly1305::aead::Payload {
                msg: ciphertext,
                aad,
            },
        )
        .map_err(DecryptError::AeadFailed)?;

    Ok(Zeroizing::new(pt))
}

// ──────────────────────────────────────────────────────────────────────────────
// X25519 keypairs for principals (devices)
// ──────────────────────────────────────────────────────────────────────────────

/// Principal keypair (X25519)
pub struct Keypair {
    secret: StaticSecret,
    public: PublicKey,
}

impl Keypair {
    /// Generate a new random X25519 keypair
    pub fn generate() -> Self {
        let secret = StaticSecret::random_from_rng(rand_core::OsRng);
        let public = PublicKey::from(&secret);
        Self { secret, public }
    }

    /// Construct keypair from secret key bytes (e.g., from config file)
    pub fn from_secret_bytes(bytes: &[u8; 32]) -> Self {
        let secret = StaticSecret::from(*bytes);
        let public = PublicKey::from(&secret);
        Self { secret, public }
    }

    /// Get the secret key as bytes (for storage)
    pub fn secret_key_bytes(&self) -> [u8; 32] {
        self.secret.to_bytes()
    }

    /// Get the public key
    pub fn public_key(&self) -> &PublicKey {
        &self.public
    }

    /// Get the public key as bytes (for storage)
    pub fn public_key_bytes(&self) -> [u8; 32] {
        *self.public.as_bytes()
    }

    /// Derive shared secret with another principal's public key (ECDH)
    pub fn shared_secret(&self, their_public: &PublicKey) -> SharedSecret {
        let secret_bytes = self.secret.diffie_hellman(their_public);
        SharedSecret(Zeroizing::new(*secret_bytes.as_bytes()))
    }
}

impl zeroize::ZeroizeOnDrop for Keypair {}

/// Shared secret derived from ECDH
#[derive(zeroize::Zeroize, zeroize::ZeroizeOnDrop)]
pub struct SharedSecret(Zeroizing<[u8; 32]>);

impl SharedSecret {
    fn as_bytes(&self) -> &[u8; 32] {
        &self.0
    }
}

/// Construct a public key from bytes (e.g., from database)
pub fn public_key_from_bytes(bytes: &[u8]) -> Result<PublicKey, &'static str> {
    if bytes.len() != 32 {
        return Err("public key must be 32 bytes");
    }
    let mut array = [0u8; 32];
    array.copy_from_slice(bytes);
    Ok(PublicKey::from(array))
}

#[derive(Debug, Error)]
pub enum WrapError {
    #[error("AEAD encryption failed")]
    AeadFailed(chacha20poly1305::aead::Error),
}

/// Wrap a key (e.g., KEK or DEK) using a shared secret
pub fn wrap_key(
    key: &[u8],
    shared_secret: &SharedSecret,
    aad: &[u8],
) -> Result<(Nonce, Ciphertext), WrapError> {
    let cipher_key = chacha20poly1305::Key::from(*shared_secret.as_bytes());
    let cipher = chacha20poly1305::XChaCha20Poly1305::new(&cipher_key);

    let mut nonce_bytes = [0u8; 24];
    rand_core::OsRng.fill_bytes(&mut nonce_bytes);

    let nonce = chacha20poly1305::XNonce::from(nonce_bytes);
    let ct = cipher
        .encrypt(&nonce, chacha20poly1305::aead::Payload { msg: key, aad })
        .map_err(WrapError::AeadFailed)?;

    Ok((Nonce(nonce_bytes), Ciphertext(ct)))
}

#[derive(Debug, Error)]
pub enum UnwrapError {
    #[error("AEAD decryption failed")]
    AeadFailed(chacha20poly1305::aead::Error),
}

/// Unwrap a key using a shared secret
pub fn unwrap_key(
    wrapped: &[u8],
    nonce: &Nonce,
    shared_secret: &SharedSecret,
    aad: &[u8],
) -> Result<Zeroizing<Vec<u8>>, UnwrapError> {
    let cipher_key = chacha20poly1305::Key::from(*shared_secret.as_bytes());
    let cipher = chacha20poly1305::XChaCha20Poly1305::new(&cipher_key);

    let nonce = chacha20poly1305::XNonce::from(nonce.0);

    let pt = cipher
        .decrypt(
            &nonce,
            chacha20poly1305::aead::Payload { msg: wrapped, aad },
        )
        .map_err(UnwrapError::AeadFailed)?;

    Ok(Zeroizing::new(pt))
}

// ──────────────────────────────────────────────────────────────────────────────
// Hashing utilities
// ──────────────────────────────────────────────────────────────────────────────

/// Hash data with SHA256 (for invite secret lookup, etc.)
pub fn hash_sha256(data: &[u8]) -> [u8; 32] {
    let mut hasher = Sha256::new();
    hasher.update(data);
    hasher.finalize().into()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn crypto_round_trip_basic() {
        let salt = b"not_random_salt_just_for_test";
        let master = derive_master_key("password", salt).unwrap();
        let dek = generate_dek();

        let plaintext = b"super-secret";
        let aad = b"project:foo|env:dev|key:DB_PASSWORD";

        let (nonce, ct) = encrypt(plaintext, &dek, aad).unwrap();
        let decrypted = decrypt(&ct.0, &nonce, &dek, aad).unwrap();

        assert_eq!(plaintext, &decrypted[..]);
        drop(master);
    }

    #[test]
    fn decrypt_fails_on_tamper() {
        let dek = generate_dek();
        let (nonce, mut ct) = encrypt(b"hello", &dek, b"aad").unwrap();

        // flip a bit
        ct.0[0] ^= 0x01;
        assert!(decrypt(&ct.0, &nonce, &dek, b"aad").is_err());

        // wrong AAD
        let (nonce2, ct2) = encrypt(b"hello", &dek, b"aad").unwrap();
        assert!(decrypt(&ct2.0, &nonce2, &dek, b"other").is_err());
    }

    #[test]
    fn tampering_ciphertext_fails() {
        let dek = generate_dek();
        let (nonce, mut ct) = encrypt(b"hello", &dek, b"aad").unwrap();

        // Flip a bit in ciphertext
        ct.0[0] ^= 0x01;

        assert!(decrypt(&ct.0, &nonce, &dek, b"aad").is_err());
    }

    #[test]
    fn tampering_nonce_fails() {
        let dek = generate_dek();
        let (nonce, ct) = encrypt(b"hello", &dek, b"aad").unwrap();

        let mut bad_nonce = nonce;
        bad_nonce.0[0] ^= 0x01;

        assert!(decrypt(&ct.0, &bad_nonce, &dek, b"aad").is_err());
    }

    #[test]
    fn tampering_aad_fails() {
        let dek = generate_dek();
        let (nonce, ct) = encrypt(b"hello", &dek, b"good-aad").unwrap();

        assert!(decrypt(&ct.0, &nonce, &dek, b"bad-aad").is_err());
    }

    #[test]
    fn empty_plaintext_ok() {
        let dek = generate_dek();
        let (nonce, ct) = encrypt(b"", &dek, b"aad").unwrap();
        let dec = decrypt(&ct.0, &nonce, &dek, b"aad").unwrap();
        assert_eq!(dec.len(), 0);
    }

    #[test]
    fn kdf_fails_on_short_salt() {
        assert!(derive_master_key("pwd", b"short").is_err());
    }

    #[test]
    fn sensitive_types_impl_zeroize() {
        fn assert_zeroize<T: zeroize::Zeroize>() {}
        assert_zeroize::<Dek>();
        assert_zeroize::<MasterKey>();
        assert_zeroize::<SharedSecret>();
    }

    // ───────────────────────────── X25519 Tests ─────────────────────────────

    #[test]
    fn keypair_generation() {
        let kp = Keypair::generate();
        let pk_bytes = kp.public_key_bytes();
        assert_eq!(pk_bytes.len(), 32);
    }

    #[test]
    fn public_key_roundtrip() {
        let kp = Keypair::generate();
        let bytes = kp.public_key_bytes();
        let pk = public_key_from_bytes(&bytes).unwrap();
        assert_eq!(pk.as_bytes(), &bytes);
    }

    #[test]
    fn public_key_from_bytes_validates_length() {
        assert!(public_key_from_bytes(&[0u8; 31]).is_err());
        assert!(public_key_from_bytes(&[0u8; 33]).is_err());
        assert!(public_key_from_bytes(&[0u8; 32]).is_ok());
    }

    #[test]
    fn ecdh_shared_secret_is_symmetric() {
        let alice = Keypair::generate();
        let bob = Keypair::generate();

        let alice_shared = alice.shared_secret(bob.public_key());
        let bob_shared = bob.shared_secret(alice.public_key());

        // Both parties should derive the same shared secret
        assert_eq!(alice_shared.as_bytes(), bob_shared.as_bytes());
    }

    #[test]
    fn key_wrap_unwrap_roundtrip() {
        let alice = Keypair::generate();
        let bob = Keypair::generate();

        // Alice wraps a key for Bob
        let kek = b"workspace-key-encryption-key-32b";
        let shared = alice.shared_secret(bob.public_key());
        let aad = b"workspace:uuid-here";
        let (nonce, wrapped) = wrap_key(kek, &shared, aad).unwrap();

        // Bob unwraps the key
        let bob_shared = bob.shared_secret(alice.public_key());
        let unwrapped = unwrap_key(&wrapped.0, &nonce, &bob_shared, aad).unwrap();

        assert_eq!(&unwrapped[..], kek);
    }

    #[test]
    fn key_unwrap_fails_with_wrong_key() {
        let alice = Keypair::generate();
        let bob = Keypair::generate();
        let eve = Keypair::generate();

        let kek = b"secret-key";
        let shared = alice.shared_secret(bob.public_key());
        let (nonce, wrapped) = wrap_key(kek, &shared, b"aad").unwrap();

        // Eve shouldn't be able to unwrap
        let eve_shared = eve.shared_secret(alice.public_key());
        assert!(unwrap_key(&wrapped.0, &nonce, &eve_shared, b"aad").is_err());
    }

    #[test]
    fn key_unwrap_fails_with_tampered_ciphertext() {
        let alice = Keypair::generate();
        let bob = Keypair::generate();

        let kek = b"secret-key";
        let shared = alice.shared_secret(bob.public_key());
        let (nonce, mut wrapped) = wrap_key(kek, &shared, b"aad").unwrap();

        // Tamper with ciphertext
        wrapped.0[0] ^= 0x01;

        let bob_shared = bob.shared_secret(alice.public_key());
        assert!(unwrap_key(&wrapped.0, &nonce, &bob_shared, b"aad").is_err());
    }

    #[test]
    fn key_unwrap_fails_with_wrong_aad() {
        let alice = Keypair::generate();
        let bob = Keypair::generate();

        let kek = b"secret-key";
        let shared = alice.shared_secret(bob.public_key());
        let (nonce, wrapped) = wrap_key(kek, &shared, b"good-aad").unwrap();

        let bob_shared = bob.shared_secret(alice.public_key());
        assert!(unwrap_key(&wrapped.0, &nonce, &bob_shared, b"bad-aad").is_err());
    }
}