11#include <botan/ec_group.h>
12#include <botan/internal/point_mul.h>
13#include <botan/internal/primality.h>
14#include <botan/ber_dec.h>
15#include <botan/der_enc.h>
17#include <botan/reducer.h>
18#include <botan/mutex.h>
24class EC_Group_Data
final
28 EC_Group_Data(
const BigInt& p,
34 const BigInt& cofactor,
38 m_base_point(m_curve, g_x, g_y),
44 m_base_mult(m_base_point, m_mod_order),
47 m_order_bits(order.bits()),
48 m_a_is_minus_3(a == p - 3),
49 m_a_is_zero(a.is_zero()),
54 bool match(
const BigInt& p,
const BigInt& a,
const BigInt& b,
55 const BigInt& g_x,
const BigInt& g_y,
56 const BigInt& order,
const BigInt& cofactor)
const
58 return (this->p() == p &&
61 this->order() == order &&
62 this->cofactor() == cofactor &&
67 void set_oid(
const OID& oid)
73 const OID& oid()
const {
return m_oid; }
74 const BigInt& p()
const {
return m_curve.get_p(); }
75 const BigInt& a()
const {
return m_curve.get_a(); }
76 const BigInt& b()
const {
return m_curve.get_b(); }
77 const BigInt& order()
const {
return m_order; }
78 const BigInt& cofactor()
const {
return m_cofactor; }
79 const BigInt& g_x()
const {
return m_g_x; }
80 const BigInt& g_y()
const {
return m_g_y; }
82 size_t p_bits()
const {
return m_p_bits; }
83 size_t p_bytes()
const {
return (m_p_bits + 7) / 8; }
85 size_t order_bits()
const {
return m_order_bits; }
86 size_t order_bytes()
const {
return (m_order_bits + 7) / 8; }
88 const CurveGFp& curve()
const {
return m_curve; }
89 const PointGFp& base_point()
const {
return m_base_point; }
91 bool a_is_minus_3()
const {
return m_a_is_minus_3; }
92 bool a_is_zero()
const {
return m_a_is_zero; }
94 BigInt mod_order(
const BigInt& x)
const {
return m_mod_order.reduce(x); }
96 BigInt square_mod_order(
const BigInt& x)
const
98 return m_mod_order.square(x);
101 BigInt multiply_mod_order(
const BigInt& x,
const BigInt& y)
const
103 return m_mod_order.multiply(x, y);
106 BigInt multiply_mod_order(
const BigInt& x,
const BigInt& y,
const BigInt& z)
const
108 return m_mod_order.multiply(m_mod_order.multiply(x, y), z);
111 BigInt inverse_mod_order(
const BigInt& x)
const
116 PointGFp blinded_base_point_multiply(
const BigInt& k,
117 RandomNumberGenerator& rng,
118 std::vector<BigInt>& ws)
const
120 return m_base_mult.mul(k, rng, m_order, ws);
127 PointGFp m_base_point;
133 Modular_Reducer m_mod_order;
134 PointGFp_Base_Point_Precompute m_base_mult;
143class EC_Group_Data_Map
final
146 EC_Group_Data_Map() {}
150 lock_guard_type<mutex_type> lock(m_mutex);
151 size_t count = m_registered_curves.size();
152 m_registered_curves.clear();
156 std::shared_ptr<EC_Group_Data>
lookup(
const OID& oid)
158 lock_guard_type<mutex_type> lock(m_mutex);
160 for(
auto i : m_registered_curves)
171 m_registered_curves.push_back(data);
176 return std::shared_ptr<EC_Group_Data>();
179 std::shared_ptr<EC_Group_Data> lookup_or_create(
const BigInt& p,
185 const BigInt& cofactor,
189 lock_guard_type<mutex_type> lock(m_mutex);
191 for(
auto i : m_registered_curves)
197 if(!i->match(p, a, b, g_x, g_y, order, cofactor))
198 throw Invalid_Argument(
"Attempting to register a curve using OID " + oid.to_string() +
199 " but another curve is already registered using that OID");
202 else if(i->oid().has_value())
206 if(i->match(p, a, b, g_x, g_y, order, cofactor))
212 if(oid.empty() ==
false)
214 if(i->oid().empty() ==
true)
220 throw Invalid_Argument(
"Cannot register ECC group with OID " + oid.to_string() +
221 " already registered using " + i->oid().to_string());
237 m_registered_curves.push_back(data);
243 std::shared_ptr<EC_Group_Data> d =
244 std::make_shared<EC_Group_Data>(p, a, b, g_x, g_y, order, cofactor, oid, source);
246 m_registered_curves.push_back(d);
252 std::vector<std::shared_ptr<EC_Group_Data>> m_registered_curves;
256EC_Group_Data_Map& EC_Group::ec_group_data()
263 static Allocator_Initializer g_init_allocator;
264 static EC_Group_Data_Map g_ec_data;
271 return ec_group_data().clear();
275std::shared_ptr<EC_Group_Data>
276EC_Group::load_EC_group_info(
const char* p_str,
281 const char* order_str,
287 const BigInt g_x(g_x_str);
288 const BigInt g_y(g_y_str);
289 const BigInt order(order_str);
296std::shared_ptr<EC_Group_Data> EC_Group::BER_decode_EC_group(
const uint8_t bits[],
size_t len,
299 BER_Decoder ber(bits, len);
300 BER_Object obj = ber.get_next_object();
304 throw Decoding_Error(
"Cannot handle ImplicitCA ECC parameters");
309 BER_Decoder(bits, len).decode(dom_par_oid);
310 return ec_group_data().lookup(dom_par_oid);
314 BigInt p, a, b, order, cofactor;
315 std::vector<uint8_t> base_pt;
316 std::vector<uint8_t> seed;
318 BER_Decoder(bits, len)
320 .decode_and_check<
size_t>(1,
"Unknown ECC param version code")
322 .decode_and_check(OID(
"1.2.840.10045.1.1"),
323 "Only prime ECC fields supported")
327 .decode_octet_string_bigint(a)
328 .decode_octet_string_bigint(b)
338 throw Decoding_Error(
"Invalid ECC p parameter");
340 if(a.is_negative() || a >= p)
341 throw Decoding_Error(
"Invalid ECC a parameter");
344 throw Decoding_Error(
"Invalid ECC b parameter");
347 throw Decoding_Error(
"Invalid ECC order parameter");
349 if(cofactor <= 0 || cofactor >= 16)
350 throw Decoding_Error(
"Invalid ECC cofactor parameter");
352 std::pair<BigInt, BigInt> base_xy =
Botan::OS2ECP(base_pt.data(), base_pt.size(), p, a, b);
354 return ec_group_data().lookup_or_create(p, a, b, base_xy.first, base_xy.second,
355 order, cofactor, OID(),
source);
359 throw Decoding_Error(
"Unexpected tag while decoding ECC domain params");
374 this->m_data = ec_group_data().lookup(domain_oid);
388 m_data = ec_group_data().lookup(oid);
394 if(m_data ==
nullptr)
396 if(str.size() > 30 && str.substr(0, 29) ==
"-----BEGIN EC PARAMETERS-----")
404 if(m_data ==
nullptr)
412 return EC_Group(ber.data(), ber.size());
438 m_data = ec_group_data().lookup_or_create(p, a, b, base_x, base_y, order, cofactor, oid,
447const EC_Group_Data& EC_Group::data()
const
449 if(m_data ==
nullptr)
456 return data().curve();
461 return data().a_is_minus_3();
466 return data().a_is_zero();
471 return data().p_bits();
476 return data().p_bytes();
481 return data().order_bits();
486 return data().order_bytes();
506 return data().base_point();
511 return data().order();
526 return data().cofactor();
531 return data().mod_order(k);
536 return data().square_mod_order(x);
541 return data().multiply_mod_order(x, y);
546 return data().multiply_mod_order(x, y, z);
551 return data().inverse_mod_order(x);
561 return data().source();
581 return PointGFp(data().curve(), x, y);
592 std::vector<BigInt>& ws)
const
594 return data().blinded_base_point_multiply(k, rng, ws);
599 std::vector<BigInt>& ws)
const
601 const PointGFp pt = data().blinded_base_point_multiply(k, rng, ws);
616 std::vector<BigInt>& ws)
const
630 std::vector<uint8_t> output;
636 const size_t ecpVers1 = 1;
637 const OID curve_type(
"1.2.840.10045.1.1");
663 throw Encoding_Error(
"Cannot encode EC_Group as OID because OID not set");
687 if(m_data == other.m_data)
729 if(is_builtin && !strong)
738 if(p <= 3 || order <= 0)
745 const size_t test_prob = 128;
746 const bool is_randomly_generated = is_builtin;
749 if(!
is_prime(p, rng, test_prob, is_randomly_generated))
755 if(!
is_prime(order, rng, test_prob, is_randomly_generated))
767 if(discriminant == 0)
788 if(!(base_point * order).is_zero())
#define BOTAN_STATE_CHECK(expr)
static BigInt random_integer(RandomNumberGenerator &rng, const BigInt &min, const BigInt &max)
static secure_vector< uint8_t > encode_1363(const BigInt &n, size_t bytes)
DER_Encoder & start_cons(ASN1_Tag type_tag, ASN1_Tag class_tag=UNIVERSAL)
DER_Encoder & encode_null()
DER_Encoder & encode(bool b)
PointGFp OS2ECP(const uint8_t bits[], size_t len) const
bool a_is_minus_3() const
BigInt blinded_base_point_multiply_x(const BigInt &k, RandomNumberGenerator &rng, std::vector< BigInt > &ws) const
const BigInt & get_b() const
const BigInt & get_a() const
const BigInt & get_g_y() const
PointGFp blinded_base_point_multiply(const BigInt &k, RandomNumberGenerator &rng, std::vector< BigInt > &ws) const
const BigInt & get_cofactor() const
BigInt mod_order(const BigInt &x) const
bool operator==(const EC_Group &other) const
BigInt multiply_mod_order(const BigInt &x, const BigInt &y) const
EC_Group_Source source() const
PointGFp point_multiply(const BigInt &x, const PointGFp &pt, const BigInt &y) const
static std::string PEM_for_named_group(const std::string &name)
const BigInt & get_p() const
static EC_Group EC_Group_from_PEM(const std::string &pem)
bool verify_group(RandomNumberGenerator &rng, bool strong=false) const
PointGFp point(const BigInt &x, const BigInt &y) const
size_t point_size(PointGFp::Compression_Type format) const
const BigInt & get_order() const
size_t get_p_bits() const
bool verify_public_element(const PointGFp &y) const
static std::shared_ptr< EC_Group_Data > EC_group_info(const OID &oid)
std::string PEM_encode() const
const BigInt & get_g_x() const
const OID & get_curve_oid() const
BigInt square_mod_order(const BigInt &x) const
const PointGFp & get_base_point() const
static size_t clear_registered_curve_data()
std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const
BigInt inverse_mod_order(const BigInt &x) const
PointGFp zero_point() const
const CurveGFp & get_curve() const
size_t get_p_bytes() const
PointGFp blinded_var_point_multiply(const PointGFp &point, const BigInt &k, RandomNumberGenerator &rng, std::vector< BigInt > &ws) const
BigInt random_scalar(RandomNumberGenerator &rng) const
size_t get_order_bits() const
size_t get_order_bytes() const
BigInt cube(const BigInt &x) const
BigInt square(const BigInt &x) const
BigInt multiply(const BigInt &x, const BigInt &y) const
BigInt reduce(const BigInt &x) const
static OID from_string(const std::string &str)
std::string to_string() const
PointGFp multi_exp(const BigInt &k1, const BigInt &k2) const
PointGFp mul(const BigInt &k, RandomNumberGenerator &rng, const BigInt &group_order, std::vector< BigInt > &ws) const
bool on_the_curve() const
BigInt get_affine_x() const
int(* final)(unsigned char *, CTX *)
std::string lookup(const OID &oid)
std::string encode(const uint8_t der[], size_t length, const std::string &label, size_t width)
secure_vector< uint8_t > decode_check_label(DataSource &source, const std::string &label_want)
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
PointGFp OS2ECP(const uint8_t data[], size_t data_len, const CurveGFp &curve)
bool is_prime(const BigInt &n, RandomNumberGenerator &rng, size_t prob, bool is_random)
bool is_bailie_psw_probable_prime(const BigInt &n, const Modular_Reducer &mod_n)
@ EC_DOMPAR_ENC_IMPLICITCA
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
std::vector< T, secure_allocator< T > > secure_vector