• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

randombit / botan / 16225201637

11 Jul 2025 04:45PM UTC coverage: 90.583% (+0.009%) from 90.574%
16225201637

Pull #4880

github

web-flow
Merge 3a965d6b5 into 8cd70aa22
Pull Request #4880: Refactor: Cipher_Mode::finish_msg() using std::span

99158 of 109466 relevant lines covered (90.58%)

12399154.95 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.19
/src/tests/test_modes.cpp
1
/*
2
* (C) 2014,2015,2017 Jack Lloyd
3
* (C) 2016 Daniel Neus, Rohde & Schwarz Cybersecurity
4
* (C) 2018 Ribose Inc
5
*
6
* Botan is released under the Simplified BSD License (see license.txt)
7
*/
8

9
#include "tests.h"
10

11
#if defined(BOTAN_HAS_CIPHER_MODES)
12
   #include <botan/cipher_mode.h>
13
#endif
14

15
namespace Botan_Tests {
16

17
#if defined(BOTAN_HAS_CIPHER_MODES)
18

19
class Cipher_Mode_Tests final : public Text_Based_Test {
×
20
   public:
21
      Cipher_Mode_Tests() : Text_Based_Test("modes", "Key,Nonce,In,Out") {}
2✔
22

23
      std::vector<std::string> possible_providers(const std::string& algo) override {
1,245✔
24
         return provider_filter(Botan::Cipher_Mode::providers(algo));
1,245✔
25
      }
26

27
      Test::Result run_one_test(const std::string& algo, const VarMap& vars) override {
1,245✔
28
         const std::vector<uint8_t> key = vars.get_req_bin("Key");
1,245✔
29
         const std::vector<uint8_t> nonce = vars.get_req_bin("Nonce");
1,245✔
30
         const std::vector<uint8_t> input = vars.get_req_bin("In");
1,245✔
31
         const std::vector<uint8_t> expected = vars.get_req_bin("Out");
1,245✔
32

33
         Test::Result result(algo);
2,490✔
34

35
         const std::vector<std::string> providers = possible_providers(algo);
1,245✔
36

37
         if(providers.empty()) {
1,245✔
38
            result.note_missing("cipher mode " + algo);
×
39
            return result;
×
40
         }
41

42
         for(auto&& provider_ask : providers) {
2,490✔
43
            auto enc = Botan::Cipher_Mode::create(algo, Botan::Cipher_Dir::Encryption, provider_ask);
1,245✔
44

45
            auto dec = Botan::Cipher_Mode::create(algo, Botan::Cipher_Dir::Decryption, provider_ask);
1,245✔
46

47
            if(!enc || !dec) {
1,245✔
48
               if(enc) {
×
49
                  result.test_failure("Provider " + provider_ask + " has encrypt but not decrypt");
×
50
               }
51
               if(dec) {
×
52
                  result.test_failure("Provider " + provider_ask + " has decrypt but not encrypt");
×
53
               }
54
               result.note_missing(algo);
×
55
               return result;
×
56
            }
57

58
            result.test_eq("enc and dec granularity is the same", enc->update_granularity(), dec->update_granularity());
1,245✔
59

60
            result.test_gt("update granularity is non-zero", enc->update_granularity(), 0);
1,245✔
61

62
            result.test_eq(
1,245✔
63
               "enc and dec ideal granularity is the same", enc->ideal_granularity(), dec->ideal_granularity());
1,245✔
64

65
            result.test_gt(
1,245✔
66
               "ideal granularity is at least update granularity", enc->ideal_granularity(), enc->update_granularity());
1,245✔
67

68
            result.confirm("ideal granularity is a multiple of update granularity",
2,490✔
69
                           enc->ideal_granularity() % enc->update_granularity() == 0);
1,245✔
70

71
            try {
1,245✔
72
               test_mode(result, algo, provider_ask, "encryption", *enc, key, nonce, input, expected, this->rng());
2,490✔
73
            } catch(Botan::Exception& e) {
×
74
               result.test_failure("Encryption tests failed", e.what());
×
75
            }
×
76

77
            try {
1,245✔
78
               test_mode(result, algo, provider_ask, "decryption", *dec, key, nonce, expected, input, this->rng());
2,490✔
79
            } catch(Botan::Exception& e) {
×
80
               result.test_failure("Decryption tests failed", e.what());
×
81
            }
×
82
         }
2,490✔
83

84
         return result;
85
      }
6,225✔
86

87
   private:
88
      static void test_mode(Test::Result& result,
2,490✔
89
                            const std::string& algo,
90
                            const std::string& provider,
91
                            const std::string& direction,
92
                            Botan::Cipher_Mode& mode,
93
                            const std::vector<uint8_t>& key,
94
                            const std::vector<uint8_t>& nonce,
95
                            const std::vector<uint8_t>& input,
96
                            const std::vector<uint8_t>& expected,
97
                            Botan::RandomNumberGenerator& rng) {
98
         const bool is_cbc = (algo.find("/CBC") != std::string::npos);
2,490✔
99
         const bool is_ctr = (algo.find("CTR") != std::string::npos);
2,490✔
100

101
         result.test_eq("name", mode.name(), algo);
4,980✔
102

103
         // Some modes report base even if got from another provider
104
         if(mode.provider() != "base") {
2,490✔
105
            result.test_eq("provider", mode.provider(), provider);
×
106
         }
107

108
         result.test_eq("mode not authenticated", mode.authenticated(), false);
2,490✔
109

110
         const size_t update_granularity = mode.update_granularity();
2,490✔
111
         const size_t min_final_bytes = mode.minimum_final_size();
2,490✔
112

113
         // FFI currently requires this, so assure it is true for all modes
114
         result.test_gt("buffer sizes ok", mode.ideal_granularity(), min_final_bytes);
2,490✔
115

116
         result.test_eq("key not set", mode.has_keying_material(), false);
2,490✔
117

118
         result.test_throws("Unkeyed object throws", [&]() {
4,980✔
119
            Botan::secure_vector<uint8_t> bad(min_final_bytes);
2,490✔
120
            mode.finish(bad);
2,490✔
121
         });
×
122

123
         if(is_cbc) {
2,490✔
124
            // can't test equal due to CBC padding
125

126
            if(direction == "encryption") {
658✔
127
               result.test_lte("output_length", mode.output_length(input.size()), expected.size());
658✔
128
            } else {
129
               result.test_gte("output_length", mode.output_length(input.size()), expected.size());
658✔
130
            }
131
         } else {
132
            // assume all other modes are not expanding (currently true)
133
            result.test_eq("output_length", mode.output_length(input.size()), expected.size());
3,664✔
134
         }
135

136
         result.confirm("default nonce size is allowed", mode.valid_nonce_length(mode.default_nonce_length()));
4,980✔
137

138
         // Test that disallowed nonce sizes result in an exception
139
         static constexpr size_t large_nonce_size = 65000;
2,490✔
140
         result.test_eq("Large nonce not allowed", mode.valid_nonce_length(large_nonce_size), false);
2,490✔
141
         result.test_throws("Large nonce causes exception", [&mode]() { mode.start(nullptr, large_nonce_size); });
7,470✔
142

143
         Botan::secure_vector<uint8_t> garbage = rng.random_vec(update_granularity);
2,490✔
144
         Botan::secure_vector<uint8_t> ultimate_garbage = rng.random_vec(min_final_bytes);
2,490✔
145

146
         // Test to make sure reset() resets what we need it to
147
         result.test_throws("Cannot process data (update) until key is set", [&]() { mode.update(garbage); });
7,470✔
148
         result.test_throws("Cannot process data (finish) until key is set", [&]() { mode.finish(ultimate_garbage); });
7,470✔
149

150
         mode.set_key(mutate_vec(key, rng));
2,490✔
151

152
         if(is_ctr == false) {
2,490✔
153
            result.test_throws("Cannot process data until nonce is set", [&]() { mode.update(garbage); });
9,944✔
154
         }
155

156
         mode.start(mutate_vec(nonce, rng));
2,490✔
157
         mode.reset();
2,490✔
158

159
         if(is_ctr == false) {
2,490✔
160
            result.test_throws("Cannot process data until nonce is set (after start/reset)",
7,458✔
161
                               [&]() { mode.update(garbage); });
4,972✔
162
         }
163

164
         mode.start(mutate_vec(nonce, rng));
2,490✔
165
         mode.update(garbage);
2,490✔
166

167
         mode.reset();
2,490✔
168

169
         mode.set_key(key);
2,490✔
170
         result.test_eq("key is set", mode.has_keying_material(), true);
2,490✔
171
         mode.start(nonce);
2,490✔
172

173
         Botan::secure_vector<uint8_t> buf;
2,490✔
174

175
         buf.assign(input.begin(), input.end());
2,490✔
176
         mode.finish(buf);
2,490✔
177
         result.test_eq(direction + " all-in-one", buf, expected);
4,980✔
178

179
         // additionally test update() and process() if possible
180
         if(input.size() >= update_granularity + min_final_bytes) {
2,490✔
181
            const size_t max_blocks_to_process = (input.size() - min_final_bytes) / update_granularity;
2,165✔
182
            const size_t bytes_to_process = max_blocks_to_process * update_granularity;
2,165✔
183

184
            // test update, 1 block at a time
185
            if(max_blocks_to_process > 1) {
2,165✔
186
               Botan::secure_vector<uint8_t> block(update_granularity);
1,785✔
187
               buf.clear();
1,785✔
188

189
               mode.start(nonce);
1,785✔
190
               for(size_t i = 0; i != max_blocks_to_process; ++i) {
15,425✔
191
                  block.assign(input.data() + i * update_granularity, input.data() + (i + 1) * update_granularity);
13,640✔
192

193
                  mode.update(block);
13,640✔
194
                  buf += block;
13,640✔
195
               }
196

197
               Botan::secure_vector<uint8_t> last_bits(input.data() + bytes_to_process, input.data() + input.size());
1,785✔
198
               mode.finish(last_bits);
1,785✔
199
               buf += last_bits;
1,785✔
200

201
               result.test_eq(direction + " update-1", buf, expected);
3,570✔
202
            }
3,570✔
203

204
            // test update with maximum length input
205
            buf.assign(input.data(), input.data() + bytes_to_process);
2,165✔
206
            Botan::secure_vector<uint8_t> last_bits(input.data() + bytes_to_process, input.data() + input.size());
2,165✔
207

208
            mode.start(nonce);
2,165✔
209
            mode.update(buf);
2,165✔
210
            mode.finish(last_bits);
2,165✔
211

212
            buf += last_bits;
2,165✔
213

214
            result.test_eq(direction + " update-all", buf, expected);
4,330✔
215

216
            // test process with maximum length input
217
            mode.start(nonce);
2,165✔
218
            buf.assign(input.begin(), input.end());
2,165✔
219

220
            const size_t bytes_written = mode.process(buf.data(), bytes_to_process);
2,165✔
221

222
            result.test_eq("correct number of bytes processed", bytes_written, bytes_to_process);
2,165✔
223

224
            mode.finish(buf, bytes_to_process);
2,165✔
225
            result.test_eq(direction + " process", buf, expected);
4,330✔
226
         }
2,165✔
227

228
         mode.clear();
2,490✔
229
         result.test_eq("key is not set", mode.has_keying_material(), false);
2,490✔
230

231
         result.test_throws("Unkeyed object throws after clear", [&]() {
7,470✔
232
            Botan::secure_vector<uint8_t> bad(min_final_bytes);
2,490✔
233
            mode.finish(bad);
2,490✔
234
         });
×
235
      }
7,290✔
236
};
237

238
BOTAN_REGISTER_SMOKE_TEST("modes", "cipher_modes", Cipher_Mode_Tests);
239

240
class Cipher_Mode_IV_Carry_Tests final : public Test {
×
241
   public:
242
      std::vector<Test::Result> run() override {
1✔
243
         std::vector<Test::Result> results;
1✔
244
         results.push_back(test_cbc_iv_carry());
2✔
245
         results.push_back(test_cfb_iv_carry());
2✔
246
         results.push_back(test_ctr_iv_carry());
2✔
247
         return results;
1✔
248
      }
×
249

250
   private:
251
      static Test::Result test_cbc_iv_carry() {
1✔
252
         Test::Result result("CBC IV carry");
1✔
253

254
   #if defined(BOTAN_HAS_MODE_CBC) && defined(BOTAN_HAS_AES)
255
         std::unique_ptr<Botan::Cipher_Mode> enc(
1✔
256
            Botan::Cipher_Mode::create("AES-128/CBC/PKCS7", Botan::Cipher_Dir::Encryption));
1✔
257
         std::unique_ptr<Botan::Cipher_Mode> dec(
1✔
258
            Botan::Cipher_Mode::create("AES-128/CBC/PKCS7", Botan::Cipher_Dir::Decryption));
1✔
259

260
         const std::vector<uint8_t> key(16, 0xAA);
1✔
261
         const std::vector<uint8_t> iv(16, 0xAA);
1✔
262

263
         Botan::secure_vector<uint8_t> msg1 =
1✔
264
            Botan::hex_decode_locked("446F6E27742075736520706C61696E20434243206D6F6465");
1✔
265
         Botan::secure_vector<uint8_t> msg2 = Botan::hex_decode_locked("49562063617272796F766572");
1✔
266
         Botan::secure_vector<uint8_t> msg3 = Botan::hex_decode_locked("49562063617272796F76657232");
1✔
267

268
         enc->set_key(key);
1✔
269
         dec->set_key(key);
1✔
270

271
         enc->start(iv);
1✔
272
         enc->finish(msg1);
1✔
273
         result.test_eq("First ciphertext", msg1, "9BDD7300E0CB61CA71FFF957A71605DB6836159C36781246A1ADF50982757F4B");
1✔
274

275
         enc->start();
1✔
276
         enc->finish(msg2);
1✔
277

278
         result.test_eq("Second ciphertext", msg2, "AA8D682958A4A044735DAC502B274DB2");
1✔
279

280
         enc->start();
1✔
281
         enc->finish(msg3);
1✔
282

283
         result.test_eq("Third ciphertext", msg3, "1241B9976F73051BCF809525D6E86C25");
1✔
284

285
         dec->start(iv);
1✔
286
         dec->finish(msg1);
1✔
287

288
         dec->start();
1✔
289
         dec->finish(msg2);
1✔
290

291
         dec->start();
1✔
292
         dec->finish(msg3);
1✔
293
         result.test_eq("Third plaintext", msg3, "49562063617272796F76657232");
1✔
294

295
   #endif
296
         return result;
1✔
297
      }
7✔
298

299
      static Test::Result test_cfb_iv_carry() {
1✔
300
         Test::Result result("CFB IV carry");
1✔
301
   #if defined(BOTAN_HAS_MODE_CFB) && defined(BOTAN_HAS_AES)
302
         std::unique_ptr<Botan::Cipher_Mode> enc(
1✔
303
            Botan::Cipher_Mode::create("AES-128/CFB(8)", Botan::Cipher_Dir::Encryption));
1✔
304
         std::unique_ptr<Botan::Cipher_Mode> dec(
1✔
305
            Botan::Cipher_Mode::create("AES-128/CFB(8)", Botan::Cipher_Dir::Decryption));
1✔
306

307
         const std::vector<uint8_t> key(16, 0xAA);
1✔
308
         const std::vector<uint8_t> iv(16, 0xAB);
1✔
309

310
         Botan::secure_vector<uint8_t> msg1 = Botan::hex_decode_locked("ABCDEF01234567");
1✔
311
         Botan::secure_vector<uint8_t> msg2 = Botan::hex_decode_locked("0000123456ABCDEF");
1✔
312
         Botan::secure_vector<uint8_t> msg3 = Botan::hex_decode_locked("012345");
1✔
313

314
         enc->set_key(key);
1✔
315
         dec->set_key(key);
1✔
316

317
         enc->start(iv);
1✔
318
         enc->finish(msg1);
1✔
319
         result.test_eq("First ciphertext", msg1, "a51522387c4c9b");
1✔
320

321
         enc->start();
1✔
322
         enc->finish(msg2);
1✔
323

324
         result.test_eq("Second ciphertext", msg2, "105457dc2e0649d4");
1✔
325

326
         enc->start();
1✔
327
         enc->finish(msg3);
1✔
328

329
         result.test_eq("Third ciphertext", msg3, "53bd65");
1✔
330

331
         dec->start(iv);
1✔
332
         dec->finish(msg1);
1✔
333
         result.test_eq("First plaintext", msg1, "ABCDEF01234567");
1✔
334

335
         dec->start();
1✔
336
         dec->finish(msg2);
1✔
337
         result.test_eq("Second plaintext", msg2, "0000123456ABCDEF");
1✔
338

339
         dec->start();
1✔
340
         dec->finish(msg3);
1✔
341
         result.test_eq("Third plaintext", msg3, "012345");
1✔
342
   #endif
343
         return result;
1✔
344
      }
7✔
345

346
      static Test::Result test_ctr_iv_carry() {
1✔
347
         Test::Result result("CTR IV carry");
1✔
348
   #if defined(BOTAN_HAS_CTR_BE) && defined(BOTAN_HAS_AES)
349

350
         std::unique_ptr<Botan::Cipher_Mode> enc(
1✔
351
            Botan::Cipher_Mode::create("AES-128/CTR-BE", Botan::Cipher_Dir::Encryption));
1✔
352
         std::unique_ptr<Botan::Cipher_Mode> dec(
1✔
353
            Botan::Cipher_Mode::create("AES-128/CTR-BE", Botan::Cipher_Dir::Decryption));
1✔
354

355
         const std::vector<uint8_t> key = Botan::hex_decode("2B7E151628AED2A6ABF7158809CF4F3C");
1✔
356
         const std::vector<uint8_t> iv = Botan::hex_decode("F0F1F2F3F4F5F6F7F8F9FAFBFCFDFEFF");
1✔
357

358
         enc->set_key(key);
1✔
359
         dec->set_key(key);
1✔
360

361
         const std::vector<std::string> exp_ciphertext = {
1✔
362
            "EC",
363
            "8CDF",
364
            "739860",
365
            "7CB0F2D2",
366
            "1675EA9EA1",
367
            "E4362B7C3C67",
368
            "73516318A077D7",
369
            "FC5073AE6A2CC378",
370
            "7889374FBEB4C81B17",
371
            "BA6C44E89C399FF0F198C",
372
         };
1✔
373

374
         for(size_t i = 1; i != 10; ++i) {
10✔
375
            if(i == 1) {
9✔
376
               enc->start(iv);
1✔
377
               dec->start(iv);
1✔
378
            } else {
379
               enc->start();
8✔
380
               dec->start();
8✔
381
            }
382

383
            Botan::secure_vector<uint8_t> msg(i, 0);
9✔
384
            enc->finish(msg);
9✔
385

386
            result.test_eq("Ciphertext", msg, exp_ciphertext[i - 1].c_str());
9✔
387

388
            dec->finish(msg);
9✔
389

390
            for(size_t j = 0; j != msg.size(); ++j) {
54✔
391
               result.test_eq("Plaintext zeros", static_cast<size_t>(msg[j]), 0);
90✔
392
            }
393
         }
9✔
394
   #endif
395
         return result;
2✔
396
      }
5✔
397
};
398

399
BOTAN_REGISTER_TEST("modes", "iv_carryover", Cipher_Mode_IV_Carry_Tests);
400

401
#endif
402

403
}  // namespace Botan_Tests
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc