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

randombit / botan / 13489630701

24 Feb 2025 02:31AM UTC coverage: 91.692% (-0.002%) from 91.694%
13489630701

Pull #4712

github

web-flow
Merge 9b107f966 into 3db6e2f01
Pull Request #4712: Add EC_Group::hash_to_curve_supported

95826 of 104509 relevant lines covered (91.69%)

11307776.54 hits per line

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

86.51
/src/lib/pubkey/ec_group/ec_group.cpp
1
/*
2
* ECC Domain Parameters
3
*
4
* (C) 2007 Falko Strenzke, FlexSecure GmbH
5
* (C) 2008,2018,2024 Jack Lloyd
6
* (C) 2018 Tobias Niemann
7
*
8
* Botan is released under the Simplified BSD License (see license.txt)
9
*/
10

11
#include <botan/ec_group.h>
12

13
#include <botan/ber_dec.h>
14
#include <botan/der_enc.h>
15
#include <botan/mutex.h>
16
#include <botan/numthry.h>
17
#include <botan/pem.h>
18
#include <botan/reducer.h>
19
#include <botan/rng.h>
20
#include <botan/internal/ec_inner_data.h>
21
#include <botan/internal/fmt.h>
22
#include <botan/internal/primality.h>
23
#include <vector>
24

25
namespace Botan {
26

27
class EC_Group_Data_Map final {
28
   public:
29
      EC_Group_Data_Map() = default;
30

31
      size_t clear() {
1,770✔
32
         lock_guard_type<mutex_type> lock(m_mutex);
1,770✔
33
         size_t count = m_registered_curves.size();
1,770✔
34
         m_registered_curves.clear();
1,770✔
35
         return count;
1,770✔
36
      }
1,770✔
37

38
      std::shared_ptr<EC_Group_Data> lookup(const OID& oid) {
21,785✔
39
         lock_guard_type<mutex_type> lock(m_mutex);
21,785✔
40

41
         for(auto i : m_registered_curves) {
149,084✔
42
            if(i->oid() == oid) {
147,894✔
43
               return i;
20,595✔
44
            }
45
         }
147,894✔
46

47
         // Not found, check hardcoded data
48
         std::shared_ptr<EC_Group_Data> data = EC_Group::EC_group_info(oid);
1,190✔
49

50
         if(data) {
1,190✔
51
            m_registered_curves.push_back(data);
1,138✔
52
            return data;
1,138✔
53
         }
54

55
         // Nope, unknown curve
56
         return std::shared_ptr<EC_Group_Data>();
52✔
57
      }
22,975✔
58

59
      std::shared_ptr<EC_Group_Data> lookup_or_create(const BigInt& p,
41✔
60
                                                      const BigInt& a,
61
                                                      const BigInt& b,
62
                                                      const BigInt& g_x,
63
                                                      const BigInt& g_y,
64
                                                      const BigInt& order,
65
                                                      const BigInt& cofactor,
66
                                                      const OID& oid,
67
                                                      EC_Group_Source source) {
68
         BOTAN_ASSERT_NOMSG(oid.has_value());
41✔
69

70
         lock_guard_type<mutex_type> lock(m_mutex);
41✔
71

72
         for(auto i : m_registered_curves) {
790✔
73
            if(i->oid() == oid) {
782✔
74
               /*
75
               * If both OID and params are the same then we are done, just return
76
               * the already registered curve obj.
77
               *
78
               * First verify that the params match, to catch an application
79
               * that is attempting to register a EC_Group under the same OID as
80
               * another group currently in use
81
               */
82
               if(!i->params_match(p, a, b, g_x, g_y, order, cofactor)) {
33✔
83
                  throw Invalid_Argument("Attempting to register a curve using OID " + oid.to_string() +
×
84
                                         " but a distinct curve is already registered using that OID");
×
85
               }
86

87
               return i;
33✔
88
            }
89

90
            /*
91
            * If the same curve was previously created without an OID but is now
92
            * being registered again using an OID, save that OID.
93
            *
94
            * TODO(Botan4) remove this block; this situation won't be possible since
95
            * we will require all groups to have an OID
96
            */
97
            if(i->oid().empty() && i->params_match(p, a, b, g_x, g_y, order, cofactor)) {
749✔
98
               i->set_oid(oid);
×
99
               return i;
×
100
            }
101
         }
782✔
102

103
         /*
104
         * Not found in current list, so we need to create a new entry
105
         */
106
         auto new_group = [&] {
×
107
            if(auto g = EC_Group::EC_group_info(oid); g != nullptr) {
8✔
108
               /*
109
               * This turned out to be the OID of one of the builtin groups. Verify
110
               * that all of the provided parameters match that builtin group.
111
               */
112
               BOTAN_ARG_CHECK(g->params_match(p, a, b, g_x, g_y, order, cofactor),
×
113
                               "Attempting to register an EC group under OID of hardcoded group");
114

115
               return g;
×
116
            } else {
117
               /*
118
               * This path is taken for an application registering a new EC_Group with an OID specified
119
               */
120
               return EC_Group_Data::create(p, a, b, g_x, g_y, order, cofactor, oid, source);
8✔
121
            }
8✔
122
         }();
8✔
123

124
         m_registered_curves.push_back(new_group);
8✔
125
         return new_group;
8✔
126
      }
49✔
127

128
      std::shared_ptr<EC_Group_Data> lookup_or_create_without_oid(const BigInt& p,
59✔
129
                                                                  const BigInt& a,
130
                                                                  const BigInt& b,
131
                                                                  const BigInt& g_x,
132
                                                                  const BigInt& g_y,
133
                                                                  const BigInt& order,
134
                                                                  const BigInt& cofactor,
135
                                                                  EC_Group_Source source) {
136
         lock_guard_type<mutex_type> lock(m_mutex);
59✔
137

138
         for(auto i : m_registered_curves) {
716✔
139
            if(i->params_match(p, a, b, g_x, g_y, order, cofactor)) {
708✔
140
               return i;
51✔
141
            }
142
         }
708✔
143

144
         // Try to use the order as a hint to look up the group id
145
         const OID oid_from_order = EC_Group::EC_group_identity_from_order(order);
8✔
146
         if(oid_from_order.has_value()) {
8✔
147
            auto new_group = EC_Group::EC_group_info(oid_from_order);
6✔
148

149
            // Have to check all params in the (unlikely/malicious) event of an order collision
150
            if(new_group && new_group->params_match(p, a, b, g_x, g_y, order, cofactor)) {
6✔
151
               m_registered_curves.push_back(new_group);
5✔
152
               return new_group;
5✔
153
            }
154
         }
6✔
155

156
         /*
157
         * At this point we have failed to identify the group; it is not any of
158
         * the builtin values, nor is it a group that the user had previously
159
         * registered explicitly. We create the group data without an OID.
160
         *
161
         * TODO(Botan4) remove this; throw an exception instead
162
         */
163
         auto new_group = EC_Group_Data::create(p, a, b, g_x, g_y, order, cofactor, OID(), source);
3✔
164
         m_registered_curves.push_back(new_group);
3✔
165
         return new_group;
3✔
166
      }
70✔
167

168
   private:
169
      mutex_type m_mutex;
170
      // TODO(Botan4): Once OID is required we could make this into a map
171
      std::vector<std::shared_ptr<EC_Group_Data>> m_registered_curves;
172
};
173

174
//static
175
EC_Group_Data_Map& EC_Group::ec_group_data() {
23,655✔
176
   /*
177
   * This exists purely to ensure the allocator is constructed before g_ec_data,
178
   * which ensures that its destructor runs after ~g_ec_data is complete.
179
   */
180

181
   static Allocator_Initializer g_init_allocator;
23,655✔
182
   static EC_Group_Data_Map g_ec_data;
23,655✔
183
   return g_ec_data;
23,655✔
184
}
185

186
//static
187
size_t EC_Group::clear_registered_curve_data() {
1,770✔
188
   return ec_group_data().clear();
1,770✔
189
}
190

191
//static
192
std::shared_ptr<EC_Group_Data> EC_Group::load_EC_group_info(const char* p_str,
1,144✔
193
                                                            const char* a_str,
194
                                                            const char* b_str,
195
                                                            const char* g_x_str,
196
                                                            const char* g_y_str,
197
                                                            const char* order_str,
198
                                                            const OID& oid) {
199
   BOTAN_ARG_CHECK(oid.has_value(), "EC_Group::load_EC_group_info OID must be set");
1,144✔
200

201
   const BigInt p(p_str);
1,144✔
202
   const BigInt a(a_str);
1,144✔
203
   const BigInt b(b_str);
1,144✔
204
   const BigInt g_x(g_x_str);
1,144✔
205
   const BigInt g_y(g_y_str);
1,144✔
206
   const BigInt order(order_str);
1,144✔
207
   const BigInt cofactor(1);  // implicit
1,144✔
208

209
   return EC_Group_Data::create(p, a, b, g_x, g_y, order, cofactor, oid, EC_Group_Source::Builtin);
2,288✔
210
}
1,144✔
211

212
//static
213
std::pair<std::shared_ptr<EC_Group_Data>, bool> EC_Group::BER_decode_EC_group(std::span<const uint8_t> bits,
6,392✔
214
                                                                              EC_Group_Source source) {
215
   BER_Decoder ber(bits);
6,392✔
216

217
   auto next_obj_type = ber.peek_next_object().type_tag();
6,392✔
218

219
   if(next_obj_type == ASN1_Type::ObjectId) {
6,384✔
220
      OID oid;
6,050✔
221
      ber.decode(oid);
6,050✔
222

223
      auto data = ec_group_data().lookup(oid);
6,008✔
224
      if(!data) {
6,008✔
225
         throw Decoding_Error(fmt("Unknown namedCurve OID '{}'", oid.to_string()));
104✔
226
      }
227

228
      return std::make_pair(data, false);
5,956✔
229
   } else if(next_obj_type == ASN1_Type::Sequence) {
6,436✔
230
      BigInt p, a, b, order, cofactor;
331✔
231
      std::vector<uint8_t> base_pt;
331✔
232
      std::vector<uint8_t> seed;
331✔
233

234
      ber.start_sequence()
331✔
235
         .decode_and_check<size_t>(1, "Unknown ECC param version code")
639✔
236
         .start_sequence()
309✔
237
         .decode_and_check(OID("1.2.840.10045.1.1"), "Only prime ECC fields supported")
618✔
238
         .decode(p)
308✔
239
         .end_cons()
308✔
240
         .start_sequence()
582✔
241
         .decode_octet_string_bigint(a)
308✔
242
         .decode_octet_string_bigint(b)
307✔
243
         .decode_optional_string(seed, ASN1_Type::BitString, ASN1_Type::BitString)
305✔
244
         .end_cons()
305✔
245
         .decode(base_pt, ASN1_Type::OctetString)
302✔
246
         .decode(order)
295✔
247
         .decode(cofactor)
294✔
248
         .end_cons()
294✔
249
         .verify_end();
293✔
250

251
      if(p.bits() < 112 || p.bits() > 521 || p.is_negative()) {
293✔
252
         throw Decoding_Error("ECC p parameter is invalid size");
134✔
253
      }
254

255
      // TODO(Botan4) we can remove this check since we'll only accept pre-registered groups
256
      auto mod_p = Modular_Reducer::for_public_modulus(p);
159✔
257
      if(!is_bailie_psw_probable_prime(p, mod_p)) {
159✔
258
         throw Decoding_Error("ECC p parameter is not a prime");
32✔
259
      }
260

261
      if(a.is_negative() || a >= p) {
254✔
262
         throw Decoding_Error("Invalid ECC a parameter");
9✔
263
      }
264

265
      if(b <= 0 || b >= p) {
236✔
266
         throw Decoding_Error("Invalid ECC b parameter");
55✔
267
      }
268

269
      if(order.is_negative() || order.is_zero() || order >= 2 * p) {
351✔
270
         throw Decoding_Error("Invalid ECC group order");
2✔
271
      }
272

273
      // TODO(Botan4) we can remove this check since we'll only accept pre-registered groups
274
      auto mod_order = Modular_Reducer::for_public_modulus(order);
61✔
275
      if(!is_bailie_psw_probable_prime(order, mod_order)) {
61✔
276
         throw Decoding_Error("Invalid ECC order parameter");
×
277
      }
278

279
      // TODO(Botan4) Require cofactor == 1
280
      if(cofactor <= 0 || cofactor >= 16) {
120✔
281
         throw Decoding_Error("Invalid ECC cofactor parameter");
3✔
282
      }
283

284
      const size_t p_bytes = p.bytes();
58✔
285
      if(base_pt.size() != 1 + p_bytes && base_pt.size() != 1 + 2 * p_bytes) {
58✔
286
         throw Decoding_Error("Invalid ECC base point encoding");
×
287
      }
288

289
      auto [g_x, g_y] = [&]() {
61✔
290
         const uint8_t hdr = base_pt[0];
58✔
291

292
         if(hdr == 0x04 && base_pt.size() == 1 + 2 * p_bytes) {
58✔
293
            BigInt x = BigInt::decode(&base_pt[1], p_bytes);
57✔
294
            BigInt y = BigInt::decode(&base_pt[p_bytes + 1], p_bytes);
57✔
295

296
            if(x < p && y < p) {
57✔
297
               return std::make_pair(x, y);
57✔
298
            }
299
         } else if((hdr == 0x02 || hdr == 0x03) && base_pt.size() == 1 + p_bytes) {
58✔
300
            // TODO(Botan4) remove this branch; we won't support compressed points
301
            BigInt x = BigInt::decode(&base_pt[1], p_bytes);
×
302
            BigInt y = sqrt_modulo_prime(((x * x + a) * x + b) % p, p);
×
303

304
            if(x < p && y >= 0) {
×
305
               const bool y_mod_2 = (hdr & 0x01) == 1;
×
306
               if(y.get_bit(0) != y_mod_2) {
×
307
                  y = p - y;
×
308
               }
309

310
               return std::make_pair(x, y);
×
311
            }
312
         }
×
313

314
         throw Decoding_Error("Invalid ECC base point encoding");
1✔
315
      }();
58✔
316

317
      // TODO(Botan4) we can remove this check since we'll only accept pre-registered groups
318
      auto y2 = mod_p.square(g_y);
57✔
319
      auto x3_ax_b = mod_p.reduce(mod_p.cube(g_x) + mod_p.multiply(a, g_x) + b);
57✔
320
      if(y2 != x3_ax_b) {
57✔
321
         throw Decoding_Error("Invalid ECC base point");
×
322
      }
323

324
      auto data = ec_group_data().lookup_or_create_without_oid(p, a, b, g_x, g_y, order, cofactor, source);
57✔
325
      return std::make_pair(data, true);
57✔
326
   } else if(next_obj_type == ASN1_Type::Null) {
2,038✔
327
      throw Decoding_Error("Decoding ImplicitCA ECC parameters is not supported");
1✔
328
   } else {
329
      throw Decoding_Error(
2✔
330
         fmt("Unexpected tag {} while decoding ECC domain params", asn1_tag_to_string(next_obj_type)));
4✔
331
   }
332
}
6,392✔
333

334
EC_Group::EC_Group() = default;
×
335

336
EC_Group::~EC_Group() = default;
133,979✔
337

338
EC_Group::EC_Group(const EC_Group&) = default;
48,653✔
339

340
EC_Group& EC_Group::operator=(const EC_Group&) = default;
×
341

342
// Internal constructor
343
EC_Group::EC_Group(std::shared_ptr<EC_Group_Data>&& data) : m_data(std::move(data)) {}
15,728✔
344

345
//static
346
bool EC_Group::supports_named_group(std::string_view name) {
14,958✔
347
   return EC_Group::known_named_groups().contains(std::string(name));
14,958✔
348
}
349

350
//static
351
bool EC_Group::supports_application_specific_group() {
27✔
352
#if defined(BOTAN_HAS_LEGACY_EC_POINT) || defined(BOTAN_HAS_PCURVES_GENERIC)
353
   return true;
27✔
354
#else
355
   return false;
356
#endif
357
}
358

359
//static
360
EC_Group EC_Group::from_OID(const OID& oid) {
71✔
361
   auto data = ec_group_data().lookup(oid);
71✔
362

363
   if(!data) {
71✔
364
      throw Invalid_Argument(fmt("No EC_Group associated with OID '{}'", oid.to_string()));
×
365
   }
366

367
   return EC_Group(std::move(data));
71✔
368
}
71✔
369

370
//static
371
EC_Group EC_Group::from_name(std::string_view name) {
15,657✔
372
   std::shared_ptr<EC_Group_Data> data;
15,657✔
373

374
   if(auto oid = OID::from_name(name)) {
15,657✔
375
      data = ec_group_data().lookup(oid.value());
31,314✔
376
   }
×
377

378
   if(!data) {
15,657✔
379
      throw Invalid_Argument(fmt("Unknown EC_Group '{}'", name));
×
380
   }
381

382
   return EC_Group(std::move(data));
15,657✔
383
}
15,657✔
384

385
EC_Group::EC_Group(std::string_view str) {
49✔
386
   if(str.empty()) {
49✔
387
      return;  // no initialization / uninitialized
388
   }
389

390
   try {
49✔
391
      const OID oid = OID::from_string(str);
49✔
392
      if(oid.has_value()) {
49✔
393
         m_data = ec_group_data().lookup(oid);
49✔
394
      }
395
   } catch(...) {}
49✔
396

397
   if(m_data == nullptr) {
49✔
398
      if(str.size() > 30 && str.substr(0, 29) == "-----BEGIN EC PARAMETERS-----") {
×
399
         // OK try it as PEM ...
400
         const auto ber = PEM_Code::decode_check_label(str, "EC PARAMETERS");
×
401

402
         auto data = BER_decode_EC_group(ber, EC_Group_Source::ExternalSource);
×
403
         this->m_data = data.first;
×
404
         this->m_explicit_encoding = data.second;
×
405
      }
×
406
   }
407

408
   if(m_data == nullptr) {
49✔
409
      throw Invalid_Argument(fmt("Unknown ECC group '{}'", str));
×
410
   }
411
}
×
412

413
//static
414
EC_Group EC_Group::from_PEM(std::string_view pem) {
1✔
415
   const auto ber = PEM_Code::decode_check_label(pem, "EC PARAMETERS");
1✔
416
   return EC_Group(ber);
1✔
417
}
1✔
418

419
EC_Group::EC_Group(const BigInt& p,
4✔
420
                   const BigInt& a,
421
                   const BigInt& b,
422
                   const BigInt& base_x,
423
                   const BigInt& base_y,
424
                   const BigInt& order,
425
                   const BigInt& cofactor,
426
                   const OID& oid) {
4✔
427
   if(oid.has_value()) {
4✔
428
      m_data = ec_group_data().lookup_or_create(
4✔
429
         p, a, b, base_x, base_y, order, cofactor, oid, EC_Group_Source::ExternalSource);
2✔
430
   } else {
431
      m_data = ec_group_data().lookup_or_create_without_oid(
4✔
432
         p, a, b, base_x, base_y, order, cofactor, EC_Group_Source::ExternalSource);
2✔
433
   }
434
}
4✔
435

436
EC_Group::EC_Group(const OID& oid,
48✔
437
                   const BigInt& p,
438
                   const BigInt& a,
439
                   const BigInt& b,
440
                   const BigInt& base_x,
441
                   const BigInt& base_y,
442
                   const BigInt& order) {
48✔
443
   BOTAN_ARG_CHECK(oid.has_value(), "An OID is required for creating an EC_Group");
48✔
444

445
   // TODO(Botan4) remove this and require 192 bits minimum
446
#if defined(BOTAN_DISABLE_DEPRECATED_FEATURES)
447
   constexpr size_t p_bits_lower_bound = 192;
448
#else
449
   constexpr size_t p_bits_lower_bound = 128;
48✔
450
#endif
451

452
   BOTAN_ARG_CHECK(p.bits() >= p_bits_lower_bound, "EC_Group p too small");
48✔
453
   BOTAN_ARG_CHECK(p.bits() <= 521, "EC_Group p too large");
48✔
454

455
   if(p.bits() == 521) {
48✔
456
      const auto p521 = BigInt::power_of_2(521) - 1;
2✔
457
      BOTAN_ARG_CHECK(p == p521, "EC_Group with p of 521 bits must be 2**521-1");
1✔
458
   } else if(p.bits() == 239) {
48✔
459
      const auto x962_p239 = []() {
18✔
460
         BigInt p239;
3✔
461
         for(size_t i = 0; i != 239; ++i) {
720✔
462
            if(i < 47 || ((i >= 94) && (i != 143))) {
717✔
463
               p239.set_bit(i);
1,290✔
464
            }
465
         }
466
         return p239;
3✔
467
      }();
3✔
468

469
      BOTAN_ARG_CHECK(p == x962_p239, "EC_Group with p of 239 bits must be the X9.62 prime");
3✔
470
   } else {
3✔
471
      BOTAN_ARG_CHECK(p.bits() % 32 == 0, "EC_Group p must be a multiple of 32 bits");
44✔
472
   }
473

474
   BOTAN_ARG_CHECK(p % 4 == 3, "EC_Group p must be congruent to 3 modulo 4");
45✔
475

476
   BOTAN_ARG_CHECK(a >= 0 && a < p, "EC_Group a is invalid");
86✔
477
   BOTAN_ARG_CHECK(b > 0 && b < p, "EC_Group b is invalid");
86✔
478
   BOTAN_ARG_CHECK(base_x >= 0 && base_x < p, "EC_Group base_x is invalid");
86✔
479
   BOTAN_ARG_CHECK(base_y >= 0 && base_y < p, "EC_Group base_y is invalid");
86✔
480
   BOTAN_ARG_CHECK(p.bits() == order.bits(), "EC_Group p and order must have the same number of bits");
43✔
481

482
   auto mod_p = Modular_Reducer::for_public_modulus(p);
40✔
483
   BOTAN_ARG_CHECK(is_bailie_psw_probable_prime(p, mod_p), "EC_Group p is not prime");
40✔
484

485
   auto mod_order = Modular_Reducer::for_public_modulus(order);
40✔
486
   BOTAN_ARG_CHECK(is_bailie_psw_probable_prime(order, mod_order), "EC_Group order is not prime");
40✔
487

488
   // This catches someone "ignoring" a cofactor and just trying to
489
   // provide the subgroup order
490
   BOTAN_ARG_CHECK((p - order).abs().bits() <= (p.bits() / 2) + 1, "Hasse bound invalid");
40✔
491

492
   // Check that 4*a^3 + 27*b^2 != 0
493
   const auto discriminant = mod_p.reduce(mod_p.multiply(4, mod_p.cube(a)) + mod_p.multiply(27, mod_p.square(b)));
41✔
494
   BOTAN_ARG_CHECK(discriminant != 0, "EC_Group discriminant is invalid");
40✔
495

496
   // Check that the generator (base_x,base_y) is on the curve; y^2 = x^3 + a*x + b
497
   auto y2 = mod_p.square(base_y);
40✔
498
   auto x3_ax_b = mod_p.reduce(mod_p.cube(base_x) + mod_p.multiply(a, base_x) + b);
40✔
499
   BOTAN_ARG_CHECK(y2 == x3_ax_b, "EC_Group generator is not on the curve");
40✔
500

501
   BigInt cofactor(1);
39✔
502

503
   m_data =
39✔
504
      ec_group_data().lookup_or_create(p, a, b, base_x, base_y, order, cofactor, oid, EC_Group_Source::ExternalSource);
39✔
505
}
130✔
506

507
EC_Group::EC_Group(std::span<const uint8_t> ber) {
6,392✔
508
   auto data = BER_decode_EC_group(ber, EC_Group_Source::ExternalSource);
6,392✔
509
   m_data = data.first;
6,013✔
510
   m_explicit_encoding = data.second;
6,013✔
511
}
6,392✔
512

513
const EC_Group_Data& EC_Group::data() const {
123,566✔
514
   if(m_data == nullptr) {
123,566✔
515
      throw Invalid_State("EC_Group uninitialized");
×
516
   }
517
   return *m_data;
123,566✔
518
}
519

520
size_t EC_Group::get_p_bits() const {
1,282✔
521
   return data().p_bits();
1,282✔
522
}
523

524
size_t EC_Group::get_p_bytes() const {
13,654✔
525
   return data().p_bytes();
13,654✔
526
}
527

528
size_t EC_Group::get_order_bits() const {
1,143✔
529
   return data().order_bits();
1,143✔
530
}
531

532
size_t EC_Group::get_order_bytes() const {
31,292✔
533
   return data().order_bytes();
31,292✔
534
}
535

536
const BigInt& EC_Group::get_p() const {
26,578✔
537
   return data().p();
26,578✔
538
}
539

540
const BigInt& EC_Group::get_a() const {
435✔
541
   return data().a();
435✔
542
}
543

544
const BigInt& EC_Group::get_b() const {
323✔
545
   return data().b();
323✔
546
}
547

548
#if defined(BOTAN_HAS_LEGACY_EC_POINT)
549
const EC_Point& EC_Group::get_base_point() const {
677✔
550
   return data().base_point();
677✔
551
}
552

553
const EC_Point& EC_Group::generator() const {
×
554
   return data().base_point();
×
555
}
556

557
bool EC_Group::verify_public_element(const EC_Point& point) const {
×
558
   //check that public point is not at infinity
559
   if(point.is_zero()) {
×
560
      return false;
561
   }
562

563
   //check that public point is on the curve
564
   if(point.on_the_curve() == false) {
×
565
      return false;
566
   }
567

568
   //check that public point has order q
569
   if((point * get_order()).is_zero() == false) {
×
570
      return false;
571
   }
572

573
   if(has_cofactor()) {
×
574
      if((point * get_cofactor()).is_zero()) {
×
575
         return false;
576
      }
577
   }
578

579
   return true;
580
}
581

582
#endif
583

584
const BigInt& EC_Group::get_order() const {
7,897✔
585
   return data().order();
7,897✔
586
}
587

588
const BigInt& EC_Group::get_g_x() const {
979✔
589
   return data().g_x();
979✔
590
}
591

592
const BigInt& EC_Group::get_g_y() const {
979✔
593
   return data().g_y();
979✔
594
}
595

596
const BigInt& EC_Group::get_cofactor() const {
155✔
597
   return data().cofactor();
155✔
598
}
599

600
bool EC_Group::has_cofactor() const {
11,805✔
601
   return data().has_cofactor();
11,805✔
602
}
603

604
bool EC_Group::hash_to_curve_supported() const {
49✔
605
   return data().hash_to_curve_supported();
49✔
606
}
607

608
const OID& EC_Group::get_curve_oid() const {
24,857✔
609
   return data().oid();
24,857✔
610
}
611

612
EC_Group_Source EC_Group::source() const {
134✔
613
   return data().source();
134✔
614
}
615

616
EC_Group_Engine EC_Group::engine() const {
2✔
617
   return data().engine();
2✔
618
}
619

620
std::vector<uint8_t> EC_Group::DER_encode() const {
1,325✔
621
   const auto& der_named_curve = data().der_named_curve();
1,325✔
622
   // TODO(Botan4) this can be removed because an OID will always be defined
623
   if(der_named_curve.empty()) {
1,325✔
624
      throw Encoding_Error("Cannot encode EC_Group as OID because OID not set");
×
625
   }
626

627
   return der_named_curve;
1,325✔
628
}
629

630
std::vector<uint8_t> EC_Group::DER_encode(EC_Group_Encoding form) const {
1,267✔
631
   if(form == EC_Group_Encoding::Explicit) {
1,267✔
632
      std::vector<uint8_t> output;
31✔
633
      DER_Encoder der(output);
31✔
634
      const size_t ecpVers1 = 1;
31✔
635
      const OID curve_type("1.2.840.10045.1.1");  // prime field
31✔
636

637
      const size_t p_bytes = get_p_bytes();
31✔
638

639
      const auto generator = EC_AffinePoint::generator(*this).serialize_uncompressed();
31✔
640

641
      der.start_sequence()
31✔
642
         .encode(ecpVers1)
31✔
643
         .start_sequence()
31✔
644
         .encode(curve_type)
31✔
645
         .encode(get_p())
31✔
646
         .end_cons()
31✔
647
         .start_sequence()
31✔
648
         .encode(get_a().serialize(p_bytes), ASN1_Type::OctetString)
31✔
649
         .encode(get_b().serialize(p_bytes), ASN1_Type::OctetString)
62✔
650
         .end_cons()
31✔
651
         .encode(generator, ASN1_Type::OctetString)
31✔
652
         .encode(get_order())
31✔
653
         .encode(get_cofactor())
31✔
654
         .end_cons();
31✔
655
      return output;
31✔
656
   } else if(form == EC_Group_Encoding::NamedCurve) {
1,267✔
657
      return this->DER_encode();
1,236✔
658
   } else if(form == EC_Group_Encoding::ImplicitCA) {
×
659
      return {0x00, 0x05};
×
660
   } else {
661
      throw Internal_Error("EC_Group::DER_encode: Unknown encoding");
×
662
   }
663
}
664

665
std::string EC_Group::PEM_encode() const {
1✔
666
   const std::vector<uint8_t> der = DER_encode(EC_Group_Encoding::Explicit);
1✔
667
   return PEM_Code::encode(der, "EC PARAMETERS");
1✔
668
}
1✔
669

670
bool EC_Group::operator==(const EC_Group& other) const {
48✔
671
   if(m_data == other.m_data) {
48✔
672
      return true;  // same shared rep
673
   }
674

675
   return (get_p() == other.get_p() && get_a() == other.get_a() && get_b() == other.get_b() &&
×
676
           get_g_x() == other.get_g_x() && get_g_y() == other.get_g_y() && get_order() == other.get_order() &&
×
677
           get_cofactor() == other.get_cofactor());
×
678
}
679

680
bool EC_Group::verify_group(RandomNumberGenerator& rng, bool strong) const {
134✔
681
   const bool is_builtin = source() == EC_Group_Source::Builtin;
134✔
682

683
   if(is_builtin && !strong) {
134✔
684
      return true;
685
   }
686

687
   // TODO(Botan4) this can probably all be removed once the deprecated EC_Group
688
   // constructor is removed, since at that point it no longer becomes possible
689
   // to create an EC_Group which fails to satisfy these conditions
690

691
   const BigInt& p = get_p();
28✔
692
   const BigInt& a = get_a();
28✔
693
   const BigInt& b = get_b();
28✔
694
   const BigInt& order = get_order();
28✔
695

696
   if(p <= 3 || order <= 0) {
56✔
697
      return false;
×
698
   }
699
   if(a < 0 || a >= p) {
56✔
700
      return false;
×
701
   }
702
   if(b <= 0 || b >= p) {
56✔
703
      return false;
×
704
   }
705

706
   const size_t test_prob = 128;
28✔
707
   const bool is_randomly_generated = is_builtin;
28✔
708

709
   //check if field modulus is prime
710
   if(!is_prime(p, rng, test_prob, is_randomly_generated)) {
28✔
711
      return false;
712
   }
713

714
   //check if order is prime
715
   if(!is_prime(order, rng, test_prob, is_randomly_generated)) {
28✔
716
      return false;
717
   }
718

719
   //compute the discriminant: 4*a^3 + 27*b^2 which must be nonzero
720
   auto mod_p = Modular_Reducer::for_public_modulus(p);
28✔
721

722
   const BigInt discriminant = mod_p.reduce(mod_p.multiply(4, mod_p.cube(a)) + mod_p.multiply(27, mod_p.square(b)));
28✔
723

724
   if(discriminant == 0) {
28✔
725
      return false;
726
   }
727

728
   //check for valid cofactor
729
   if(get_cofactor() < 1) {
28✔
730
      return false;
731
   }
732

733
#if defined(BOTAN_HAS_LEGACY_EC_POINT)
734
   const EC_Point& base_point = get_base_point();
28✔
735
   //check if the base point is on the curve
736
   if(!base_point.on_the_curve()) {
28✔
737
      return false;
738
   }
739
   if((base_point * get_cofactor()).is_zero()) {
56✔
740
      return false;
741
   }
742
   //check if order of the base point is correct
743
   if(!(base_point * order).is_zero()) {
28✔
744
      return false;
745
   }
746
#endif
747

748
   // check the Hasse bound (roughly)
749
   if((p - get_cofactor() * order).abs().bits() > (p.bits() / 2) + 1) {
28✔
750
      return false;
751
   }
752

753
   return true;
754
}
56✔
755

756
EC_Group::Mul2Table::Mul2Table(const EC_AffinePoint& h) : m_tbl(h._group()->make_mul2_table(h._inner())) {}
13,248✔
757

758
EC_Group::Mul2Table::~Mul2Table() = default;
13,248✔
759

760
std::optional<EC_AffinePoint> EC_Group::Mul2Table::mul2_vartime(const EC_Scalar& x, const EC_Scalar& y) const {
2,121✔
761
   auto pt = m_tbl->mul2_vartime(x._inner(), y._inner());
2,121✔
762
   if(pt) {
2,121✔
763
      return EC_AffinePoint::_from_inner(std::move(pt));
4,242✔
764
   } else {
765
      return {};
×
766
   }
767
}
2,121✔
768

769
bool EC_Group::Mul2Table::mul2_vartime_x_mod_order_eq(const EC_Scalar& v,
22,982✔
770
                                                      const EC_Scalar& x,
771
                                                      const EC_Scalar& y) const {
772
   return m_tbl->mul2_vartime_x_mod_order_eq(v._inner(), x._inner(), y._inner());
22,982✔
773
}
774

775
bool EC_Group::Mul2Table::mul2_vartime_x_mod_order_eq(const EC_Scalar& v,
22,810✔
776
                                                      const EC_Scalar& c,
777
                                                      const EC_Scalar& x,
778
                                                      const EC_Scalar& y) const {
779
   return this->mul2_vartime_x_mod_order_eq(v, c * x, c * y);
22,810✔
780
}
781

782
}  // namespace Botan
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