• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In
Build has been canceled!

randombit / botan / 15654190339

14 Jun 2025 04:56PM UTC coverage: 90.571% (-0.01%) from 90.585%
15654190339

push

github

web-flow
Merge pull request #4912 from randombit/jack/clang-tidy-headers-part-2

Further clang-tidy fixes in header files

98789 of 109074 relevant lines covered (90.57%)

12363815.23 hits per line

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

95.45
/src/tests/test_dilithium.cpp
1
/*
2
 * Tests for Crystals Dilithium
3
 * - KAT tests using the KAT vectors from
4
 *   https://csrc.nist.gov/CSRC/media/Projects/post-quantum-cryptography/documents/round-3/submissions/Dilithium-Round3.zip
5
 *
6
 * (C) 2022,2023 Jack Lloyd
7
 * (C) 2022 Manuel Glaser, Michael Boric, René Meusel - Rohde & Schwarz Cybersecurity
8
 *
9
 * Botan is released under the Simplified BSD License (see license.txt)
10
 */
11

12
#include "test_rng.h"
13
#include "tests.h"
14

15
#if defined(BOTAN_HAS_DILITHIUM_COMMON)
16
   #include <botan/dilithium.h>
17
   #include <botan/hash.h>
18
   #include <botan/pk_algs.h>
19
   #include <botan/pubkey.h>
20
   #include <botan/internal/fmt.h>
21
   #include <algorithm>
22

23
   #include "test_pubkey.h"
24
#endif
25

26
namespace Botan_Tests {
27

28
#if defined(BOTAN_HAS_DILITHIUM_COMMON) && defined(BOTAN_HAS_AES) && defined(BOTAN_HAS_SHA3)
29

30
template <typename DerivedT>
31
class Dilithium_KAT_Tests : public Text_Based_Test {
×
32
   public:
33
      // NOLINTNEXTLINE(*crtp-constructor-accessibility)
34
      Dilithium_KAT_Tests() : Text_Based_Test(DerivedT::test_vector, "Seed,Msg,HashPk,HashSk,HashSig", "Sig") {}
36✔
35

36
      Test::Result run_one_test(const std::string& name, const VarMap& vars) override {
1,350✔
37
         Test::Result result(name);
1,350✔
38

39
         // read input from test file
40
         const auto ref_seed = vars.get_req_bin("Seed");
2,700✔
41
         const auto ref_msg = vars.get_req_bin("Msg");
2,700✔
42
         const auto ref_pk_hash = vars.get_req_bin("HashPk");
2,700✔
43
         const auto ref_sk_hash = vars.get_req_bin("HashSk");
2,700✔
44
         const auto ref_sig_hash = vars.get_req_bin("HashSig");
2,700✔
45
         const auto ref_sig = vars.get_opt_bin("Sig");
2,700✔
46

47
         auto sha3_256 = Botan::HashFunction::create_or_throw("SHA-3(256)");
1,350✔
48

49
         auto dilithium_test_rng = std::make_unique<CTR_DRBG_AES256>(ref_seed);
1,350✔
50

51
         Botan::Dilithium_PrivateKey priv_key(*dilithium_test_rng, DerivedT::mode);
1,350✔
52

53
         result.test_eq(
5,400✔
54
            "generated expected private key hash", sha3_256->process(priv_key.private_key_bits()), ref_sk_hash);
1,350✔
55

56
         result.test_eq(
5,400✔
57
            "generated expected public key hash", sha3_256->process(priv_key.public_key_bits()), ref_pk_hash);
1,350✔
58

59
         auto signer = Botan::PK_Signer(priv_key, *dilithium_test_rng, DerivedT::sign_param);
1,350✔
60
         auto signature = signer.sign_message(ref_msg.data(), ref_msg.size(), *dilithium_test_rng);
2,700✔
61

62
         result.test_eq("generated expected signature hash", sha3_256->process(signature), ref_sig_hash);
4,050✔
63
         if(!ref_sig.empty()) {
1,350✔
64
            result.test_eq("generated expected signature", signature, ref_sig);
24✔
65
         }
66

67
         Botan::Dilithium_PublicKey pub_key(priv_key.public_key_bits(), DerivedT::mode);
2,700✔
68
         auto verifier = Botan::PK_Verifier(pub_key, "");
1,350✔
69
         verifier.update(ref_msg.data(), ref_msg.size());
1,350✔
70
         result.confirm("signature verifies", verifier.check_signature(signature.data(), signature.size()));
2,700✔
71

72
         // test validating incorrect wrong signature
73
         auto mutated_signature = Test::mutate_vec(signature, this->rng());
1,350✔
74
         result.confirm("invalid signature rejected",
1,350✔
75
                        !verifier.check_signature(mutated_signature.data(), mutated_signature.size()));
1,350✔
76

77
         verifier.update(ref_msg.data(), ref_msg.size());
1,350✔
78
         result.confirm("signature verifies", verifier.check_signature(signature.data(), signature.size()));
2,700✔
79

80
         return result;
1,350✔
81
      }
12,162✔
82
};
83

84
   // NOLINTNEXTLINE(*-macro-usage)
85
   #define REGISTER_DILITHIUM_KAT_TEST(m, rand)                                          \
86
      class DILITHIUM##m##rand final : public Dilithium_KAT_Tests<DILITHIUM##m##rand> {  \
87
         public:                                                                         \
88
            constexpr static auto test_vector = "pubkey/dilithium_" #m "_" #rand ".vec"; \
89
            constexpr static auto mode = Botan::DilithiumMode::Dilithium##m;             \
90
            constexpr static auto sign_param = #rand;                                    \
91
      };                                                                                 \
92
      BOTAN_REGISTER_TEST("pubkey", "dilithium_kat_" #m "_" #rand, DILITHIUM##m##rand)
93

94
   // NOLINTNEXTLINE(*-macro-usage)
95
   #define REGISTER_ML_DSA_KAT_TEST(m, rand)                                          \
96
      class ML_DSA##m##rand final : public Dilithium_KAT_Tests<ML_DSA##m##rand> {     \
97
         public:                                                                      \
98
            constexpr static auto test_vector = "pubkey/ml-dsa-" #m "_" #rand ".vec"; \
99
            constexpr static auto mode = Botan::DilithiumMode::ML_DSA_##m;            \
100
            constexpr static auto sign_param = #rand;                                 \
101
      };                                                                              \
102
      BOTAN_REGISTER_TEST("pubkey", "ml-dsa_kat_" #m "_" #rand, ML_DSA##m##rand)
103

104
   #if defined(BOTAN_HAS_DILITHIUM)
105
REGISTER_DILITHIUM_KAT_TEST(4x4, Deterministic);
1✔
106
REGISTER_DILITHIUM_KAT_TEST(6x5, Deterministic);
1✔
107
REGISTER_DILITHIUM_KAT_TEST(8x7, Deterministic);
1✔
108
REGISTER_DILITHIUM_KAT_TEST(4x4, Randomized);
1✔
109
REGISTER_DILITHIUM_KAT_TEST(6x5, Randomized);
1✔
110
REGISTER_DILITHIUM_KAT_TEST(8x7, Randomized);
1✔
111
   #endif
112

113
   #if defined(BOTAN_HAS_DILITHIUM_AES)
114
REGISTER_DILITHIUM_KAT_TEST(4x4_AES, Deterministic);
1✔
115
REGISTER_DILITHIUM_KAT_TEST(6x5_AES, Deterministic);
1✔
116
REGISTER_DILITHIUM_KAT_TEST(8x7_AES, Deterministic);
1✔
117
REGISTER_DILITHIUM_KAT_TEST(4x4_AES, Randomized);
1✔
118
REGISTER_DILITHIUM_KAT_TEST(6x5_AES, Randomized);
1✔
119
REGISTER_DILITHIUM_KAT_TEST(8x7_AES, Randomized);
1✔
120
   #endif
121

122
   #if defined(BOTAN_HAS_ML_DSA)
123
REGISTER_ML_DSA_KAT_TEST(4x4, Deterministic);
1✔
124
REGISTER_ML_DSA_KAT_TEST(6x5, Deterministic);
1✔
125
REGISTER_ML_DSA_KAT_TEST(8x7, Deterministic);
1✔
126
REGISTER_ML_DSA_KAT_TEST(4x4, Randomized);
1✔
127
REGISTER_ML_DSA_KAT_TEST(6x5, Randomized);
1✔
128
REGISTER_ML_DSA_KAT_TEST(8x7, Randomized);
1✔
129
   #endif
130

131
class DilithiumRoundtripTests final : public Test {
×
132
   public:
133
      static Test::Result run_roundtrip(
18✔
134
         const char* test_name, Botan::DilithiumMode mode, bool randomized, size_t strength, size_t psid) {
135
         Test::Result result(test_name);
18✔
136
         if(!mode.is_available()) {
18✔
137
            result.note_missing(mode.to_string());
×
138
            return result;
×
139
         }
140

141
         auto rng = Test::new_rng(test_name);
18✔
142

143
         auto sign = [randomized, &rng](const auto& private_key, const auto& msg) {
72✔
144
            const std::string param = (randomized) ? "Randomized" : "Deterministic";
81✔
145
            auto signer = Botan::PK_Signer(private_key, *rng, param);
54✔
146
            return signer.sign_message(msg, *rng);
54✔
147
         };
72✔
148

149
         auto verify = [](const auto& public_key, const auto& msg, const auto& signature) {
288✔
150
            auto verifier = Botan::PK_Verifier(public_key, "");
270✔
151
            verifier.update(msg);
270✔
152
            return verifier.check_signature(signature);
540✔
153
         };
270✔
154

155
         const std::string msg = "The quick brown fox jumps over the lazy dog.";
18✔
156
         const std::vector<uint8_t> msgvec(msg.data(), msg.data() + msg.size());
18✔
157

158
         Botan::Dilithium_PrivateKey priv_key(*rng, mode);
18✔
159
         const Botan::Dilithium_PublicKey& pub_key = priv_key;
18✔
160

161
         result.test_eq("key strength", priv_key.estimated_strength(), strength);
18✔
162
         result.test_eq("key length", priv_key.key_length(), psid);
18✔
163
         result.test_eq("key strength", pub_key.estimated_strength(), strength);
18✔
164
         result.test_eq("key length", pub_key.key_length(), psid);
18✔
165

166
         const auto sig_before_codec = sign(priv_key, msgvec);
18✔
167

168
         const auto priv_key_encoded = priv_key.private_key_bits();
18✔
169
         const auto pub_key_encoded = priv_key.public_key_bits();
18✔
170

171
         Botan::Dilithium_PrivateKey priv_key_decoded(priv_key_encoded, mode);
18✔
172
         Botan::Dilithium_PublicKey pub_key_decoded(pub_key_encoded, mode);
18✔
173

174
         const auto sig_after_codec = sign(priv_key_decoded, msgvec);
18✔
175

176
         result.confirm("Pubkey: before,   Sig: before", verify(pub_key, msgvec, sig_before_codec));
36✔
177
         result.confirm("Pubkey: before,   Sig: after", verify(pub_key, msgvec, sig_after_codec));
36✔
178
         result.confirm("Pubkey: after,    Sig: after", verify(pub_key_decoded, msgvec, sig_after_codec));
36✔
179
         result.confirm("Pubkey: after,    Sig: before", verify(pub_key_decoded, msgvec, sig_before_codec));
36✔
180
         result.confirm("Pubkey: recalc'ed Sig: before", verify(priv_key_decoded, msgvec, sig_before_codec));
36✔
181
         result.confirm("Pubkey: recalc'ed Sig: after", verify(priv_key_decoded, msgvec, sig_after_codec));
36✔
182

183
         auto tampered_msgvec = msgvec;
18✔
184
         tampered_msgvec.front() = 'X';
18✔
185
         result.confirm("Pubkey: before,   Broken Sig: before", !verify(pub_key, tampered_msgvec, sig_before_codec));
36✔
186
         result.confirm("Pubkey: before,   Broken Sig: after", !verify(pub_key, tampered_msgvec, sig_after_codec));
36✔
187
         result.confirm("Pubkey: after,    Broken Sig: after",
18✔
188
                        !verify(pub_key_decoded, tampered_msgvec, sig_after_codec));
18✔
189
         result.confirm("Pubkey: after,    Broken Sig: before",
18✔
190
                        !verify(pub_key_decoded, tampered_msgvec, sig_before_codec));
18✔
191
         result.confirm("Pubkey: recalc'ed Sig: before", !verify(priv_key_decoded, tampered_msgvec, sig_before_codec));
36✔
192
         result.confirm("Pubkey: recalc'ed Sig: after", !verify(priv_key_decoded, tampered_msgvec, sig_after_codec));
36✔
193

194
         // decoding via generic pk_algs.h
195
         const auto generic_pubkey_decoded = Botan::load_public_key(pub_key.algorithm_identifier(), pub_key_encoded);
18✔
196
         const auto generic_privkey_decoded =
18✔
197
            Botan::load_private_key(priv_key.algorithm_identifier(), priv_key_encoded);
18✔
198

199
         result.test_not_null("generic pubkey", generic_pubkey_decoded);
18✔
200
         result.test_not_null("generic privkey", generic_privkey_decoded);
18✔
201

202
         const auto sig_after_generic_codec = sign(*generic_privkey_decoded, msgvec);
18✔
203

204
         result.confirm("verification with generic public key",
36✔
205
                        verify(*generic_pubkey_decoded, msgvec, sig_before_codec));
18✔
206
         result.confirm("verification of signature with generic private key",
36✔
207
                        verify(*generic_pubkey_decoded, msgvec, sig_after_generic_codec));
18✔
208
         result.confirm("verification with generic private key",
36✔
209
                        verify(*generic_privkey_decoded, msgvec, sig_before_codec));
18✔
210

211
         return result;
18✔
212
      }
162✔
213

214
      std::vector<Test::Result> run() override {
1✔
215
         return {
1✔
216
            run_roundtrip("Dilithium_4x4_Common", Botan::DilithiumMode::Dilithium4x4, false, 128, 44),
217
            run_roundtrip("Dilithium_6x5_Common", Botan::DilithiumMode::Dilithium6x5, false, 192, 65),
218
            run_roundtrip("Dilithium_8x7_Common", Botan::DilithiumMode::Dilithium8x7, false, 256, 87),
219
            run_roundtrip("Dilithium_4x4_Common_Randomized", Botan::DilithiumMode::Dilithium4x4, true, 128, 44),
220
            run_roundtrip("Dilithium_6x5_Common_Randomized", Botan::DilithiumMode::Dilithium6x5, true, 192, 65),
221
            run_roundtrip("Dilithium_8x7_Common_Randomized", Botan::DilithiumMode::Dilithium8x7, true, 256, 87),
222
            run_roundtrip("Dilithium_4x4_AES", Botan::DilithiumMode::Dilithium4x4_AES, false, 128, 44),
223
            run_roundtrip("Dilithium_6x5_AES", Botan::DilithiumMode::Dilithium6x5_AES, false, 192, 65),
224
            run_roundtrip("Dilithium_8x7_AES", Botan::DilithiumMode::Dilithium8x7_AES, false, 256, 87),
225
            run_roundtrip("Dilithium_4x4_AES_Randomized", Botan::DilithiumMode::Dilithium4x4_AES, true, 128, 44),
226
            run_roundtrip("Dilithium_6x5_AES_Randomized", Botan::DilithiumMode::Dilithium6x5_AES, true, 192, 65),
227
            run_roundtrip("Dilithium_8x7_AES_Randomized", Botan::DilithiumMode::Dilithium8x7_AES, true, 256, 87),
228
            run_roundtrip("ML-DSA_4x4", Botan::DilithiumMode::ML_DSA_4x4, false, 128, 44),
229
            run_roundtrip("ML-DSA_6x5", Botan::DilithiumMode::ML_DSA_6x5, false, 192, 65),
230
            run_roundtrip("ML-DSA_8x7", Botan::DilithiumMode::ML_DSA_8x7, false, 256, 87),
231
            run_roundtrip("ML-DSA_4x4_Randomized", Botan::DilithiumMode::ML_DSA_4x4, true, 128, 44),
232
            run_roundtrip("ML-DSA_6x5_Randomized", Botan::DilithiumMode::ML_DSA_6x5, true, 192, 65),
233
            run_roundtrip("ML-DSA_8x7_Randomized", Botan::DilithiumMode::ML_DSA_8x7, true, 256, 87),
234
         };
19✔
235
      }
2✔
236
};
237

238
BOTAN_REGISTER_TEST("pubkey", "dilithium_roundtrips", DilithiumRoundtripTests);
239

240
class Dilithium_Keygen_Tests final : public PK_Key_Generation_Test {
×
241
   public:
242
      std::vector<std::string> keygen_params() const override {
1✔
243
         std::vector<std::string> all_instances = {
1✔
244
            "Dilithium-4x4-AES-r3",
245
            "Dilithium-6x5-AES-r3",
246
            "Dilithium-8x7-AES-r3",
247
            "Dilithium-4x4-r3",
248
            "Dilithium-6x5-r3",
249
            "Dilithium-8x7-r3",
250
            "ML-DSA-4x4",
251
            "ML-DSA-6x5",
252
            "ML-DSA-8x7",
253
         };
1✔
254
         std::vector<std::string> available_instances;
1✔
255
         std::copy_if(all_instances.begin(),
1✔
256
                      all_instances.end(),
257
                      std::back_inserter(available_instances),
258
                      [](const std::string& instance) { return Botan::DilithiumMode(instance).is_available(); });
9✔
259
         return available_instances;
1✔
260
      }
1✔
261

262
      std::string algo_name(std::string_view param) const override {
9✔
263
         if(param.starts_with("Dilithium-")) {
9✔
264
            return "Dilithium";
6✔
265
         } else {
266
            return "ML-DSA";
3✔
267
         }
268
      }
269

270
      std::string algo_name() const override { throw Test_Error("No default algo name set for Dilithium"); }
×
271

272
      std::unique_ptr<Botan::Public_Key> public_key_from_raw(std::string_view keygen_params,
9✔
273
                                                             std::string_view /* provider */,
274
                                                             std::span<const uint8_t> raw_pk) const override {
275
         return std::make_unique<Botan::Dilithium_PublicKey>(raw_pk, Botan::DilithiumMode(keygen_params));
9✔
276
      }
277
};
278

279
BOTAN_REGISTER_TEST("pubkey", "dilithium_keygen", Dilithium_Keygen_Tests);
280

281
#endif
282

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