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

randombit / botan / 5123321399

30 May 2023 04:06PM UTC coverage: 92.213% (+0.004%) from 92.209%
5123321399

Pull #3558

github

web-flow
Merge dd72f7389 into 057bcbc35
Pull Request #3558: Add braces around all if/else statements

75602 of 81986 relevant lines covered (92.21%)

11859779.3 hits per line

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

92.79
/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") {}
3✔
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,492✔
43
            auto enc = Botan::Cipher_Mode::create(algo, Botan::Cipher_Dir::Encryption, provider_ask);
1,247✔
44

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

47
            if(!enc || !dec) {
1,247✔
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,247✔
59

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

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

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

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

71
            try {
1,247✔
72
               test_mode(result, algo, provider_ask, "encryption", *enc, key, nonce, input, expected);
2,494✔
73
            } catch(Botan::Exception& e) { result.test_failure("Encryption tests failed", e.what()); }
×
74

75
            try {
1,247✔
76
               test_mode(result, algo, provider_ask, "decryption", *dec, key, nonce, expected, input);
2,494✔
77
            } catch(Botan::Exception& e) { result.test_failure("Decryption tests failed", e.what()); }
×
78
         }
2,494✔
79

80
         return result;
81
      }
6,225✔
82

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

96
         result.test_eq("name", mode.name(), algo);
4,988✔
97

98
         // Some modes report base even if got from another provider
99
         if(mode.provider() != "base") {
2,494✔
100
            result.test_eq("provider", mode.provider(), provider);
×
101
         }
102

103
         result.test_eq("mode not authenticated", mode.authenticated(), false);
2,494✔
104

105
         const size_t update_granularity = mode.update_granularity();
2,494✔
106
         const size_t min_final_bytes = mode.minimum_final_size();
2,494✔
107

108
         // FFI currently requires this, so assure it is true for all modes
109
         result.test_gt("buffer sizes ok", mode.ideal_granularity(), min_final_bytes);
2,494✔
110

111
         result.test_eq("key not set", mode.has_keying_material(), false);
2,494✔
112

113
         result.test_throws("Unkeyed object throws", [&]() {
4,988✔
114
            Botan::secure_vector<uint8_t> bad(update_granularity);
2,494✔
115
            mode.finish(bad);
2,494✔
116
         });
×
117

118
         if(is_cbc) {
2,494✔
119
            // can't test equal due to CBC padding
120

121
            if(direction == "encryption") {
658✔
122
               result.test_lte("output_length", mode.output_length(input.size()), expected.size());
658✔
123
            } else {
124
               result.test_gte("output_length", mode.output_length(input.size()), expected.size());
658✔
125
            }
126
         } else {
127
            // assume all other modes are not expanding (currently true)
128
            result.test_eq("output_length", mode.output_length(input.size()), expected.size());
3,672✔
129
         }
130

131
         result.confirm("default nonce size is allowed", mode.valid_nonce_length(mode.default_nonce_length()));
4,988✔
132

133
         // Test that disallowed nonce sizes result in an exception
134
         static constexpr size_t large_nonce_size = 65000;
2,494✔
135
         result.test_eq("Large nonce not allowed", mode.valid_nonce_length(large_nonce_size), false);
2,494✔
136
         result.test_throws("Large nonce causes exception", [&mode]() { mode.start(nullptr, large_nonce_size); });
7,482✔
137

138
         Botan::secure_vector<uint8_t> garbage = Test::rng().random_vec(update_granularity);
2,494✔
139

140
         // Test to make sure reset() resets what we need it to
141
         result.test_throws("Cannot process data (update) until key is set", [&]() { mode.update(garbage); });
7,482✔
142
         result.test_throws("Cannot process data (finish) until key is set", [&]() { mode.finish(garbage); });
7,482✔
143

144
         mode.set_key(mutate_vec(key));
2,494✔
145

146
         if(is_ctr == false) {
2,494✔
147
            result.test_throws("Cannot process data until nonce is set", [&]() { mode.update(garbage); });
9,944✔
148
         }
149

150
         mode.start(mutate_vec(nonce));
2,494✔
151
         mode.reset();
2,494✔
152

153
         if(is_ctr == false) {
2,494✔
154
            result.test_throws("Cannot process data until nonce is set (after start/reset)",
7,458✔
155
                               [&]() { mode.update(garbage); });
2,486✔
156
         }
157

158
         mode.start(mutate_vec(nonce));
2,494✔
159
         mode.update(garbage);
2,494✔
160

161
         mode.reset();
2,494✔
162

163
         mode.set_key(key);
2,494✔
164
         result.test_eq("key is set", mode.has_keying_material(), true);
2,494✔
165
         mode.start(nonce);
2,494✔
166

167
         Botan::secure_vector<uint8_t> buf;
2,494✔
168

169
         buf.assign(input.begin(), input.end());
2,494✔
170
         mode.finish(buf);
2,494✔
171
         result.test_eq(direction + " all-in-one", buf, expected);
2,494✔
172

173
         // additionally test update() and process() if possible
174
         if(input.size() >= update_granularity + min_final_bytes) {
2,494✔
175
            const size_t max_blocks_to_process = (input.size() - min_final_bytes) / update_granularity;
2,169✔
176
            const size_t bytes_to_process = max_blocks_to_process * update_granularity;
2,169✔
177

178
            // test update, 1 block at a time
179
            if(max_blocks_to_process > 1) {
2,169✔
180
               Botan::secure_vector<uint8_t> block(update_granularity);
1,789✔
181
               buf.clear();
1,789✔
182

183
               mode.start(nonce);
1,789✔
184
               for(size_t i = 0; i != max_blocks_to_process; ++i) {
15,605✔
185
                  block.assign(input.data() + i * update_granularity, input.data() + (i + 1) * update_granularity);
13,816✔
186

187
                  mode.update(block);
13,816✔
188
                  buf += block;
13,816✔
189
               }
190

191
               Botan::secure_vector<uint8_t> last_bits(input.data() + bytes_to_process, input.data() + input.size());
1,789✔
192
               mode.finish(last_bits);
1,789✔
193
               buf += last_bits;
1,789✔
194

195
               result.test_eq(direction + " update-1", buf, expected);
3,578✔
196
            }
3,578✔
197

198
            // test update with maximum length input
199
            buf.assign(input.data(), input.data() + bytes_to_process);
2,169✔
200
            Botan::secure_vector<uint8_t> last_bits(input.data() + bytes_to_process, input.data() + input.size());
2,169✔
201

202
            mode.start(nonce);
2,169✔
203
            mode.update(buf);
2,169✔
204
            mode.finish(last_bits);
2,169✔
205

206
            buf += last_bits;
2,169✔
207

208
            result.test_eq(direction + " update-all", buf, expected);
2,169✔
209

210
            // test process with maximum length input
211
            mode.start(nonce);
4,338✔
212
            buf.assign(input.begin(), input.end());
2,169✔
213

214
            const size_t bytes_written = mode.process(buf.data(), bytes_to_process);
2,169✔
215

216
            result.test_eq("correct number of bytes processed", bytes_written, bytes_to_process);
2,169✔
217

218
            mode.finish(buf, bytes_to_process);
2,169✔
219
            result.test_eq(direction + " process", buf, expected);
4,338✔
220
         }
2,169✔
221

222
         mode.clear();
2,494✔
223
         result.test_eq("key is not set", mode.has_keying_material(), false);
2,494✔
224

225
         result.test_throws("Unkeyed object throws after clear", [&]() {
7,482✔
226
            Botan::secure_vector<uint8_t> bad(update_granularity);
2,494✔
227
            mode.finish(bad);
2,494✔
228
         });
×
229
      }
4,988✔
230
};
231

232
BOTAN_REGISTER_SMOKE_TEST("modes", "cipher_modes", Cipher_Mode_Tests);
233

234
class Cipher_Mode_IV_Carry_Tests final : public Test {
×
235
   public:
236
      std::vector<Test::Result> run() override {
1✔
237
         std::vector<Test::Result> results;
1✔
238
         results.push_back(test_cbc_iv_carry());
2✔
239
         results.push_back(test_cfb_iv_carry());
2✔
240
         results.push_back(test_ctr_iv_carry());
2✔
241
         return results;
1✔
242
      }
×
243

244
   private:
245
      static Test::Result test_cbc_iv_carry() {
1✔
246
         Test::Result result("CBC IV carry");
1✔
247

248
   #if defined(BOTAN_HAS_MODE_CBC) && defined(BOTAN_HAS_AES)
249
         std::unique_ptr<Botan::Cipher_Mode> enc(
1✔
250
            Botan::Cipher_Mode::create("AES-128/CBC/PKCS7", Botan::Cipher_Dir::Encryption));
1✔
251
         std::unique_ptr<Botan::Cipher_Mode> dec(
1✔
252
            Botan::Cipher_Mode::create("AES-128/CBC/PKCS7", Botan::Cipher_Dir::Decryption));
1✔
253

254
         const std::vector<uint8_t> key(16, 0xAA);
1✔
255
         const std::vector<uint8_t> iv(16, 0xAA);
1✔
256

257
         Botan::secure_vector<uint8_t> msg1 =
1✔
258
            Botan::hex_decode_locked("446F6E27742075736520706C61696E20434243206D6F6465");
1✔
259
         Botan::secure_vector<uint8_t> msg2 = Botan::hex_decode_locked("49562063617272796F766572");
1✔
260
         Botan::secure_vector<uint8_t> msg3 = Botan::hex_decode_locked("49562063617272796F76657232");
1✔
261

262
         enc->set_key(key);
1✔
263
         dec->set_key(key);
1✔
264

265
         enc->start(iv);
1✔
266
         enc->finish(msg1);
1✔
267
         result.test_eq("First ciphertext", msg1, "9BDD7300E0CB61CA71FFF957A71605DB6836159C36781246A1ADF50982757F4B");
1✔
268

269
         enc->start();
1✔
270
         enc->finish(msg2);
1✔
271

272
         result.test_eq("Second ciphertext", msg2, "AA8D682958A4A044735DAC502B274DB2");
1✔
273

274
         enc->start();
1✔
275
         enc->finish(msg3);
1✔
276

277
         result.test_eq("Third ciphertext", msg3, "1241B9976F73051BCF809525D6E86C25");
1✔
278

279
         dec->start(iv);
1✔
280
         dec->finish(msg1);
1✔
281

282
         dec->start();
1✔
283
         dec->finish(msg2);
1✔
284

285
         dec->start();
1✔
286
         dec->finish(msg3);
1✔
287
         result.test_eq("Third plaintext", msg3, "49562063617272796F76657232");
1✔
288

289
   #endif
290
         return result;
1✔
291
      }
7✔
292

293
      static Test::Result test_cfb_iv_carry() {
1✔
294
         Test::Result result("CFB IV carry");
1✔
295
   #if defined(BOTAN_HAS_MODE_CFB) && defined(BOTAN_HAS_AES)
296
         std::unique_ptr<Botan::Cipher_Mode> enc(
1✔
297
            Botan::Cipher_Mode::create("AES-128/CFB(8)", Botan::Cipher_Dir::Encryption));
1✔
298
         std::unique_ptr<Botan::Cipher_Mode> dec(
1✔
299
            Botan::Cipher_Mode::create("AES-128/CFB(8)", Botan::Cipher_Dir::Decryption));
1✔
300

301
         const std::vector<uint8_t> key(16, 0xAA);
1✔
302
         const std::vector<uint8_t> iv(16, 0xAB);
1✔
303

304
         Botan::secure_vector<uint8_t> msg1 = Botan::hex_decode_locked("ABCDEF01234567");
1✔
305
         Botan::secure_vector<uint8_t> msg2 = Botan::hex_decode_locked("0000123456ABCDEF");
1✔
306
         Botan::secure_vector<uint8_t> msg3 = Botan::hex_decode_locked("012345");
1✔
307

308
         enc->set_key(key);
1✔
309
         dec->set_key(key);
1✔
310

311
         enc->start(iv);
1✔
312
         enc->finish(msg1);
1✔
313
         result.test_eq("First ciphertext", msg1, "a51522387c4c9b");
1✔
314

315
         enc->start();
1✔
316
         enc->finish(msg2);
1✔
317

318
         result.test_eq("Second ciphertext", msg2, "105457dc2e0649d4");
1✔
319

320
         enc->start();
1✔
321
         enc->finish(msg3);
1✔
322

323
         result.test_eq("Third ciphertext", msg3, "53bd65");
1✔
324

325
         dec->start(iv);
1✔
326
         dec->finish(msg1);
1✔
327
         result.test_eq("First plaintext", msg1, "ABCDEF01234567");
1✔
328

329
         dec->start();
1✔
330
         dec->finish(msg2);
1✔
331
         result.test_eq("Second plaintext", msg2, "0000123456ABCDEF");
1✔
332

333
         dec->start();
1✔
334
         dec->finish(msg3);
1✔
335
         result.test_eq("Third plaintext", msg3, "012345");
1✔
336
   #endif
337
         return result;
1✔
338
      }
7✔
339

340
      static Test::Result test_ctr_iv_carry() {
1✔
341
         Test::Result result("CTR IV carry");
1✔
342
   #if defined(BOTAN_HAS_CTR_BE) && defined(BOTAN_HAS_AES)
343

344
         std::unique_ptr<Botan::Cipher_Mode> enc(
1✔
345
            Botan::Cipher_Mode::create("AES-128/CTR-BE", Botan::Cipher_Dir::Encryption));
1✔
346
         std::unique_ptr<Botan::Cipher_Mode> dec(
1✔
347
            Botan::Cipher_Mode::create("AES-128/CTR-BE", Botan::Cipher_Dir::Decryption));
1✔
348

349
         const std::vector<uint8_t> key = Botan::hex_decode("2B7E151628AED2A6ABF7158809CF4F3C");
1✔
350
         const std::vector<uint8_t> iv = Botan::hex_decode("F0F1F2F3F4F5F6F7F8F9FAFBFCFDFEFF");
1✔
351

352
         enc->set_key(key);
1✔
353
         dec->set_key(key);
1✔
354

355
         const std::vector<std::string> exp_ciphertext = {
1✔
356
            "EC",
357
            "8CDF",
358
            "739860",
359
            "7CB0F2D2",
360
            "1675EA9EA1",
361
            "E4362B7C3C67",
362
            "73516318A077D7",
363
            "FC5073AE6A2CC378",
364
            "7889374FBEB4C81B17",
365
            "BA6C44E89C399FF0F198C",
366
         };
11✔
367

368
         for(size_t i = 1; i != 10; ++i) {
10✔
369
            if(i == 1) {
9✔
370
               enc->start(iv);
1✔
371
               dec->start(iv);
1✔
372
            } else {
373
               enc->start();
8✔
374
               dec->start();
8✔
375
            }
376

377
            Botan::secure_vector<uint8_t> msg(i, 0);
9✔
378
            enc->finish(msg);
9✔
379

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

382
            dec->finish(msg);
9✔
383

384
            for(size_t j = 0; j != msg.size(); ++j) {
54✔
385
               result.test_eq("Plaintext zeros", static_cast<size_t>(msg[j]), 0);
90✔
386
            }
387
         }
9✔
388
   #endif
389
         return result;
2✔
390
      }
5✔
391
};
392

393
BOTAN_REGISTER_TEST("modes", "iv_carryover", Cipher_Mode_IV_Carry_Tests);
394

395
#endif
396

397
}  // 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

© 2025 Coveralls, Inc