|
| 1 | +//! Benchmarks for message decryption, |
| 2 | +//! comparing decryption of symmetrically-encrypted messages |
| 3 | +//! to decryption of asymmetrically-encrypted messages. |
| 4 | +//! |
| 5 | +//! Call with |
| 6 | +//! |
| 7 | +//! ```text |
| 8 | +//! cargo bench --bench decrypting --features="internals" |
| 9 | +//! ``` |
| 10 | +//! |
| 11 | +//! or, if you want to only run e.g. the 'Decrypt a symmetrically encrypted message' benchmark: |
| 12 | +//! |
| 13 | +//! ```text |
| 14 | +//! cargo bench --bench decrypting --features="internals" -- 'Decrypt a symmetrically encrypted message' |
| 15 | +//! ``` |
| 16 | +//! |
| 17 | +//! You can also pass a substring. |
| 18 | +//! So, you can run all 'Decrypt and parse' benchmarks with: |
| 19 | +//! |
| 20 | +//! ```text |
| 21 | +//! cargo bench --bench decrypting --features="internals" -- 'Decrypt and parse' |
| 22 | +//! ``` |
| 23 | +//! |
| 24 | +//! Symmetric decryption has to try out all known secrets, |
| 25 | +//! You can benchmark this by adapting the `NUM_SECRETS` variable. |
| 26 | +
|
| 27 | +use std::hint::black_box; |
| 28 | + |
| 29 | +use criterion::{Criterion, criterion_group, criterion_main}; |
| 30 | +use deltachat::internals_for_benches::create_broadcast_secret; |
| 31 | +use deltachat::internals_for_benches::create_dummy_keypair; |
| 32 | +use deltachat::internals_for_benches::save_broadcast_secret; |
| 33 | +use deltachat::{ |
| 34 | + Events, |
| 35 | + chat::ChatId, |
| 36 | + config::Config, |
| 37 | + context::Context, |
| 38 | + internals_for_benches::key_from_asc, |
| 39 | + internals_for_benches::parse_and_get_text, |
| 40 | + internals_for_benches::store_self_keypair, |
| 41 | + pgp::{KeyPair, decrypt, pk_encrypt, symm_encrypt_message}, |
| 42 | + stock_str::StockStrings, |
| 43 | +}; |
| 44 | +use rand::{Rng, rng}; |
| 45 | +use tempfile::tempdir; |
| 46 | + |
| 47 | +const NUM_SECRETS: usize = 500; |
| 48 | + |
| 49 | +async fn create_context() -> Context { |
| 50 | + let dir = tempdir().unwrap(); |
| 51 | + let dbfile = dir.path().join("db.sqlite"); |
| 52 | + let context = Context::new(dbfile.as_path(), 100, Events::new(), StockStrings::new()) |
| 53 | + .await |
| 54 | + .unwrap(); |
| 55 | + |
| 56 | + context |
| 57 | + .set_config(Config::ConfiguredAddr, Some("bob@example.net")) |
| 58 | + .await |
| 59 | + .unwrap(); |
| 60 | + let secret = key_from_asc(include_str!("../test-data/key/bob-secret.asc")).unwrap(); |
| 61 | + let public = secret.signed_public_key(); |
| 62 | + let key_pair = KeyPair { public, secret }; |
| 63 | + store_self_keypair(&context, &key_pair) |
| 64 | + .await |
| 65 | + .expect("Failed to save key"); |
| 66 | + |
| 67 | + context |
| 68 | +} |
| 69 | + |
| 70 | +fn criterion_benchmark(c: &mut Criterion) { |
| 71 | + let mut group = c.benchmark_group("Decrypt"); |
| 72 | + |
| 73 | + // =========================================================================================== |
| 74 | + // Benchmarks for decryption only, without any other parsing |
| 75 | + // =========================================================================================== |
| 76 | + |
| 77 | + group.sample_size(10); |
| 78 | + |
| 79 | + group.bench_function("Decrypt a symmetrically encrypted message", |b| { |
| 80 | + let plain = generate_plaintext(); |
| 81 | + let secrets = generate_secrets(); |
| 82 | + let encrypted = tokio::runtime::Runtime::new().unwrap().block_on(async { |
| 83 | + let secret = secrets[NUM_SECRETS / 2].clone(); |
| 84 | + symm_encrypt_message( |
| 85 | + plain.clone(), |
| 86 | + create_dummy_keypair("alice@example.org").unwrap().secret, |
| 87 | + black_box(&secret), |
| 88 | + true, |
| 89 | + ) |
| 90 | + .await |
| 91 | + .unwrap() |
| 92 | + }); |
| 93 | + |
| 94 | + b.iter(|| { |
| 95 | + let mut msg = |
| 96 | + decrypt(encrypted.clone().into_bytes(), &[], black_box(&secrets)).unwrap(); |
| 97 | + let decrypted = msg.as_data_vec().unwrap(); |
| 98 | + |
| 99 | + assert_eq!(black_box(decrypted), plain); |
| 100 | + }); |
| 101 | + }); |
| 102 | + |
| 103 | + group.bench_function("Decrypt a public-key encrypted message", |b| { |
| 104 | + let plain = generate_plaintext(); |
| 105 | + let key_pair = create_dummy_keypair("alice@example.org").unwrap(); |
| 106 | + let secrets = generate_secrets(); |
| 107 | + let encrypted = tokio::runtime::Runtime::new().unwrap().block_on(async { |
| 108 | + pk_encrypt( |
| 109 | + plain.clone(), |
| 110 | + vec![black_box(key_pair.public.clone())], |
| 111 | + Some(key_pair.secret.clone()), |
| 112 | + true, |
| 113 | + true, |
| 114 | + ) |
| 115 | + .await |
| 116 | + .unwrap() |
| 117 | + }); |
| 118 | + |
| 119 | + b.iter(|| { |
| 120 | + let mut msg = decrypt( |
| 121 | + encrypted.clone().into_bytes(), |
| 122 | + std::slice::from_ref(&key_pair.secret), |
| 123 | + black_box(&secrets), |
| 124 | + ) |
| 125 | + .unwrap(); |
| 126 | + let decrypted = msg.as_data_vec().unwrap(); |
| 127 | + |
| 128 | + assert_eq!(black_box(decrypted), plain); |
| 129 | + }); |
| 130 | + }); |
| 131 | + |
| 132 | + // =========================================================================================== |
| 133 | + // Benchmarks for the whole parsing pipeline, incl. decryption (but excl. receive_imf()) |
| 134 | + // =========================================================================================== |
| 135 | + |
| 136 | + let rt = tokio::runtime::Runtime::new().unwrap(); |
| 137 | + let mut secrets = generate_secrets(); |
| 138 | + |
| 139 | + // "secret" is the shared secret that was used to encrypt text_symmetrically_encrypted.eml. |
| 140 | + // Put it into the middle of our secrets: |
| 141 | + secrets[NUM_SECRETS / 2] = "secret".to_string(); |
| 142 | + |
| 143 | + let context = rt.block_on(async { |
| 144 | + let context = create_context().await; |
| 145 | + for (i, secret) in secrets.iter().enumerate() { |
| 146 | + save_broadcast_secret(&context, ChatId::new(10 + i as u32), secret) |
| 147 | + .await |
| 148 | + .unwrap(); |
| 149 | + } |
| 150 | + context |
| 151 | + }); |
| 152 | + |
| 153 | + group.bench_function("Decrypt and parse a symmetrically encrypted message", |b| { |
| 154 | + b.to_async(&rt).iter(|| { |
| 155 | + let ctx = context.clone(); |
| 156 | + async move { |
| 157 | + let text = parse_and_get_text( |
| 158 | + &ctx, |
| 159 | + include_bytes!("../test-data/message/text_symmetrically_encrypted.eml"), |
| 160 | + ) |
| 161 | + .await |
| 162 | + .unwrap(); |
| 163 | + assert_eq!(text, "Symmetrically encrypted message"); |
| 164 | + } |
| 165 | + }); |
| 166 | + }); |
| 167 | + |
| 168 | + group.bench_function("Decrypt and parse a public-key encrypted message", |b| { |
| 169 | + b.to_async(&rt).iter(|| { |
| 170 | + let ctx = context.clone(); |
| 171 | + async move { |
| 172 | + let text = parse_and_get_text( |
| 173 | + &ctx, |
| 174 | + include_bytes!("../test-data/message/text_from_alice_encrypted.eml"), |
| 175 | + ) |
| 176 | + .await |
| 177 | + .unwrap(); |
| 178 | + assert_eq!(text, "hi"); |
| 179 | + } |
| 180 | + }); |
| 181 | + }); |
| 182 | + |
| 183 | + group.finish(); |
| 184 | +} |
| 185 | + |
| 186 | +fn generate_secrets() -> Vec<String> { |
| 187 | + let secrets: Vec<String> = (0..NUM_SECRETS) |
| 188 | + .map(|_| create_broadcast_secret()) |
| 189 | + .collect(); |
| 190 | + secrets |
| 191 | +} |
| 192 | + |
| 193 | +fn generate_plaintext() -> Vec<u8> { |
| 194 | + let mut plain: Vec<u8> = vec![0; 500]; |
| 195 | + rng().fill(&mut plain[..]); |
| 196 | + plain |
| 197 | +} |
| 198 | + |
| 199 | +criterion_group!(benches, criterion_benchmark); |
| 200 | +criterion_main!(benches); |
0 commit comments