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

randombit / botan / 11345152100

15 Oct 2024 11:31AM UTC coverage: 91.146% (+0.02%) from 91.131%
11345152100

Pull #4270

github

web-flow
Merge 041fb0a91 into 7dd590598
Pull Request #4270: PQC: ML-DSA

90747 of 99562 relevant lines covered (91.15%)

9029457.78 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

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

25
namespace Botan_Tests {
26

27
#if defined(BOTAN_HAS_DILITHIUM_COMMON) && defined(BOTAN_HAS_AES)
28

29
template <typename DerivedT>
30
class Dilithium_KAT_Tests : public Text_Based_Test {
×
31
   public:
32
      Dilithium_KAT_Tests() : Text_Based_Test(DerivedT::test_vector, "Seed,Msg,HashPk,HashSk,HashSig", "Sig") {}
36✔
33

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

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

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

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

49
         Botan::Dilithium_PrivateKey priv_key(*dilithium_test_rng, DerivedT::mode);
1,350✔
50

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

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

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

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

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

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

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

78
         return result;
1,350✔
79
      }
12,162✔
80
};
81

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

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

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

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

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

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

139
         auto rng = Test::new_rng(test_name);
18✔
140

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

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

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

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

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

164
         const auto sig_before_codec = sign(priv_key, msgvec);
18✔
165

166
         const auto priv_key_encoded = priv_key.private_key_bits();
18✔
167
         const auto pub_key_encoded = priv_key.public_key_bits();
18✔
168

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

172
         const auto sig_after_codec = sign(priv_key_decoded, msgvec);
18✔
173

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

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

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

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

200
         const auto sig_after_generic_codec = sign(*generic_privkey_decoded, msgvec);
18✔
201

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

209
         return result;
18✔
210
      }
162✔
211

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

236
BOTAN_REGISTER_TEST("pubkey", "dilithium_roundtrips", DilithiumRoundtripTests);
237

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

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

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

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

277
BOTAN_REGISTER_TEST("pubkey", "dilithium_keygen", Dilithium_Keygen_Tests);
278

279
#endif
280

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