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

randombit / botan / 5111374265

29 May 2023 11:19AM UTC coverage: 92.227% (+0.5%) from 91.723%
5111374265

push

github

randombit
Next release will be 3.1.0. Update release notes

75588 of 81959 relevant lines covered (92.23%)

11886470.91 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
               if(dec)
×
51
                  result.test_failure("Provider " + provider_ask + " has decrypt but not encrypt");
×
52
               result.note_missing(algo);
×
53
               return result;
×
54
            }
55

56
            result.test_eq("enc and dec granularity is the same", enc->update_granularity(), dec->update_granularity());
1,247✔
57

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

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

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

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

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

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

78
         return result;
79
      }
6,225✔
80

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

94
         result.test_eq("name", mode.name(), algo);
4,988✔
95

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

101
         result.test_eq("mode not authenticated", mode.authenticated(), false);
2,494✔
102

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

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

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

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

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

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

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

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

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

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

142
         mode.set_key(mutate_vec(key));
2,494✔
143

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

148
         mode.start(mutate_vec(nonce));
2,494✔
149
         mode.reset();
2,494✔
150

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

156
         mode.start(mutate_vec(nonce));
2,494✔
157
         mode.update(garbage);
2,494✔
158

159
         mode.reset();
2,494✔
160

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

165
         Botan::secure_vector<uint8_t> buf;
2,494✔
166

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

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

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

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

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

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

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

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

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

204
            buf += last_bits;
2,169✔
205

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

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

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

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

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

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

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

230
BOTAN_REGISTER_SMOKE_TEST("modes", "cipher_modes", Cipher_Mode_Tests);
231

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

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

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

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

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

260
         enc->set_key(key);
1✔
261
         dec->set_key(key);
1✔
262

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

267
         enc->start();
1✔
268
         enc->finish(msg2);
1✔
269

270
         result.test_eq("Second ciphertext", msg2, "AA8D682958A4A044735DAC502B274DB2");
1✔
271

272
         enc->start();
1✔
273
         enc->finish(msg3);
1✔
274

275
         result.test_eq("Third ciphertext", msg3, "1241B9976F73051BCF809525D6E86C25");
1✔
276

277
         dec->start(iv);
1✔
278
         dec->finish(msg1);
1✔
279

280
         dec->start();
1✔
281
         dec->finish(msg2);
1✔
282

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

287
   #endif
288
         return result;
1✔
289
      }
7✔
290

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

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

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

306
         enc->set_key(key);
1✔
307
         dec->set_key(key);
1✔
308

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

313
         enc->start();
1✔
314
         enc->finish(msg2);
1✔
315

316
         result.test_eq("Second ciphertext", msg2, "105457dc2e0649d4");
1✔
317

318
         enc->start();
1✔
319
         enc->finish(msg3);
1✔
320

321
         result.test_eq("Third ciphertext", msg3, "53bd65");
1✔
322

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

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

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

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

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

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

350
         enc->set_key(key);
1✔
351
         dec->set_key(key);
1✔
352

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

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

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

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

380
            dec->finish(msg);
9✔
381

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

390
BOTAN_REGISTER_TEST("modes", "iv_carryover", Cipher_Mode_IV_Carry_Tests);
391

392
#endif
393

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