8#include <botan/dl_group.h>
10#include <botan/ber_dec.h>
11#include <botan/der_enc.h>
12#include <botan/numthry.h>
14#include <botan/internal/barrett.h>
15#include <botan/internal/divide.h>
16#include <botan/internal/fmt.h>
17#include <botan/internal/mod_inv.h>
18#include <botan/internal/monty.h>
19#include <botan/internal/monty_exp.h>
20#include <botan/internal/primality.h>
21#include <botan/internal/workfactor.h>
26class DL_Group_Data final {
28 DL_Group_Data(
const BigInt& p,
const BigInt& q,
const BigInt& g,
DL_Group_Source source) :
32 m_mod_p(Barrett_Reduction::for_public_modulus(p)),
33 m_mod_q(Barrett_Reduction::for_public_modulus(q)),
34 m_monty_params(m_p, m_mod_p),
42 DL_Group_Data(
const BigInt& p,
const BigInt& g,
DL_Group_Source source) :
45 m_mod_p(Barrett_Reduction::for_public_modulus(p)),
46 m_monty_params(m_p, m_mod_p),
54 ~DL_Group_Data() =
default;
56 DL_Group_Data(
const DL_Group_Data& other) =
delete;
57 DL_Group_Data(DL_Group_Data&& other) =
delete;
58 DL_Group_Data& operator=(
const DL_Group_Data& other) =
delete;
59 DL_Group_Data& operator=(DL_Group_Data&& other) =
delete;
61 const BigInt& p()
const {
return m_p; }
63 const BigInt& q()
const {
return m_q; }
65 const BigInt& g()
const {
return m_g; }
67 const Barrett_Reduction& reducer_mod_p()
const {
return m_mod_p; }
69 const Barrett_Reduction& reducer_mod_q()
const {
74 const Montgomery_Params& monty_params_p()
const {
return m_monty_params; }
76 size_t p_bits()
const {
return m_p_bits; }
78 size_t q_bits()
const {
return m_q_bits; }
80 size_t p_bytes()
const {
return (m_p_bits + 7) / 8; }
82 size_t q_bytes()
const {
return (m_q_bits + 7) / 8; }
84 size_t estimated_strength()
const {
return m_estimated_strength; }
86 size_t exponent_bits()
const {
return m_exponent_bits; }
88 BigInt power_g_p(
const BigInt& k,
size_t max_k_bits)
const {
94 BigInt power_b_p(
const BigInt& b,
const BigInt& k,
size_t max_k_bits)
const {
98 BigInt power_b_p_vartime(
const BigInt& b,
const BigInt& k)
const {
102 bool q_is_set()
const {
return m_q_bits > 0; }
104 void assert_q_is_set(std::string_view function)
const {
106 throw Invalid_State(
fmt(
"DL_Group::{}: q is not set for this group", function));
116 Barrett_Reduction m_mod_p;
117 std::optional<Barrett_Reduction> m_mod_q;
118 Montgomery_Params m_monty_params;
119 std::shared_ptr<const Montgomery_Exponentation_State> m_monty;
122 size_t m_estimated_strength;
123 size_t m_exponent_bits;
128std::shared_ptr<DL_Group_Data> DL_Group::BER_decode_DL_group(
const uint8_t data[],
132 BER_Decoder decoder(data, data_len);
133 BER_Decoder ber = decoder.start_sequence();
139 ber.decode(p).decode(q).decode(g).verify_end();
140 return std::make_shared<DL_Group_Data>(p, q, g,
source);
145 ber.decode(p).decode(g).decode(q).discard_remaining();
146 return std::make_shared<DL_Group_Data>(p, q, g,
source);
150 ber.decode(p).decode(g).discard_remaining();
151 return std::make_shared<DL_Group_Data>(p, g,
source);
153 throw Invalid_Argument(
"Unknown DL_Group encoding");
158std::shared_ptr<DL_Group_Data> DL_Group::load_DL_group_info(
const char* p_str,
const char* q_str,
const char* g_str) {
159 const BigInt p(p_str);
160 const BigInt q(q_str);
161 const BigInt g(g_str);
171std::shared_ptr<DL_Group_Data> DL_Group::load_DL_group_info(
const char* p_str,
const char* g_str) {
172 const BigInt p(p_str);
173 const BigInt q = (p - 1) / 2;
174 const BigInt g(g_str);
182 if(label ==
"DH PARAMETERS") {
184 }
else if(label ==
"DSA PARAMETERS") {
186 }
else if(label ==
"X942 DH PARAMETERS" || label ==
"X9.42 DH PARAMETERS") {
202 if(m_data ==
nullptr) {
212 if(m_data ==
nullptr) {
245 if(e == 0 || r > 0) {
251 Montgomery_Params params(p, mod_p);
260 throw Internal_Error(
"DL_Group: Couldn't create a suitable generator");
274 throw Invalid_Argument(
fmt(
"DL_Group: requested q size {} is too big for p {}", qbits, pbits));
278 if(qbits != 0 && qbits != pbits - 1) {
279 throw Invalid_Argument(
"Cannot create strong-prime DL_Group with specified q bits");
283 const BigInt q = (p - 1) / 2;
307 while(p.
bits() != pbits || !
is_prime(p, rng, 128,
true)) {
310 p = X - (X % q2) + 1;
313 const BigInt g = make_dsa_generator(p, q);
317 qbits = ((pbits <= 1024) ? 160 : 256);
323 const BigInt g = make_dsa_generator(p, q);
338 throw Invalid_Argument(
"DL_Group: The seed given does not generate a DSA group");
341 BigInt g = make_dsa_generator(p, q);
364const DL_Group_Data& DL_Group::data()
const {
369 throw Invalid_State(
"DL_Group uninitialized");
376 if(y <= 1 || y >= p) {
381 if(data().power_b_p_vartime(y, q) != 1) {
393 if(x <= 1 || x >= p) {
407 if(y <= 1 || y >= p || x <= 1 || x >= p) {
424 if(!strong && from_builtin) {
432 if(g < 2 || p < 3 || q < 0) {
436 const size_t test_prob = 128;
439 if(!
is_prime(p, rng, test_prob, is_randomly_generated)) {
444 if((p - 1) % q != 0) {
447 if(data().power_g_p_vartime(q) != 1) {
450 if(!
is_prime(q, rng, test_prob, is_randomly_generated)) {
454 if(!from_builtin && !is_randomly_generated) {
458 const size_t upper_bound = strong ? 1000 : 100;
460 for(
size_t i = 2; i != upper_bound; ++i) {
493 return data().monty_params_p();
497 return data().q_is_set();
501 return data().p_bits();
505 return data().p_bytes();
509 data().assert_q_is_set(
"q_bits");
510 return data().q_bits();
514 data().assert_q_is_set(
"q_bytes");
515 return data().q_bytes();
519 return data().estimated_strength();
523 return data().exponent_bits();
532 return data().reducer_mod_p().reduce(x);
536 return data().reducer_mod_p().multiply(x, y);
540 return data().reducer_mod_p();
544 data().assert_q_is_set(
"inverse_mod_q");
550 data().assert_q_is_set(
"mod_q");
551 return data().reducer_mod_q().reduce(x);
555 data().assert_q_is_set(
"multiply_mod_q");
556 return data().reducer_mod_q().multiply(x, y);
560 data().assert_q_is_set(
"multiply_mod_q");
565 data().assert_q_is_set(
"square_mod_q");
566 return data().reducer_mod_q().
square(x);
574 return data().power_g_p(x, max_x_bits);
582 return data().power_b_p(b, x, max_x_bits);
586 return data().source();
594 throw Encoding_Error(
"Cannot encode DL_Group in ANSI formats when q param is missing");
597 std::vector<uint8_t> output;
617 const std::vector<uint8_t> encoding =
DER_encode(format);
#define BOTAN_STATE_CHECK(expr)
static Barrett_Reduction for_public_modulus(const BigInt &m)
void randomize(RandomNumberGenerator &rng, size_t bitsize, bool set_high_bit=true)
static BigInt from_word(word n)
BigInt & square(secure_vector< word > &ws)
DER_Encoder & start_sequence()
DER_Encoder & encode(bool b)
const Barrett_Reduction & _reducer_mod_p() const
bool verify_private_element(const BigInt &x) const
std::vector< uint8_t > DER_encode(DL_Group_Format format) const
BigInt power_g_p(const BigInt &x) const
static DL_Group from_PEM(std::string_view pem)
BigInt mod_p(const BigInt &x) const
BigInt multiply_mod_p(const BigInt &x, const BigInt &y) const
std::string PEM_encode(DL_Group_Format format) const
const BigInt & get_p() const
static DL_Group from_name(std::string_view name)
BigInt multi_exponentiate(const BigInt &x, const BigInt &y, const BigInt &z) const
bool verify_public_element(const BigInt &y) const
BigInt square_mod_q(const BigInt &x) const
BigInt inverse_mod_q(const BigInt &x) const
bool verify_element_pair(const BigInt &y, const BigInt &x) const
size_t estimated_strength() const
DL_Group_Source source() const
BigInt multiply_mod_q(const BigInt &x, const BigInt &y) const
BigInt inverse_mod_p(const BigInt &x) const
const Montgomery_Params & _monty_params_p() const
BigInt power_b_p(const BigInt &b, const BigInt &x, size_t max_x_bits) const
size_t exponent_bits() const
BigInt mod_q(const BigInt &x) const
bool verify_group(RandomNumberGenerator &rng, bool strong=true) const
const BigInt & get_g() const
static std::shared_ptr< DL_Group_Data > DL_group_info(std::string_view name)
const BigInt & get_q() const
std::string encode(const uint8_t der[], size_t length, std::string_view label, size_t width)
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
void vartime_divide(const BigInt &x, const BigInt &y_arg, BigInt &q_out, BigInt &r_out)
BigInt random_prime(RandomNumberGenerator &rng, size_t bits, const BigInt &coprime, size_t equiv, size_t modulo, size_t prob)
std::string fmt(std::string_view format, const T &... args)
Montgomery_Int monty_exp_vartime(const Montgomery_Params ¶ms_p, const BigInt &g, const BigInt &k)
const size_t PRIME_TABLE_SIZE
Montgomery_Int monty_execute_vartime(const Montgomery_Exponentation_State &precomputed_state, const BigInt &k)
size_t dl_work_factor(size_t bits)
bool is_prime(const BigInt &n, RandomNumberGenerator &rng, size_t prob, bool is_random)
BigInt inverse_mod_public_prime(const BigInt &x, const BigInt &p)
Montgomery_Int monty_multi_exp(const Montgomery_Params ¶ms_p, const BigInt &x_bn, const BigInt &z1, const BigInt &y_bn, const BigInt &z2)
std::vector< T > unlock(const secure_vector< T > &in)
bool generate_dsa_primes(RandomNumberGenerator &rng, BigInt &p, BigInt &q, size_t pbits, size_t qbits, const std::vector< uint8_t > &seed_c, size_t offset)
Montgomery_Int monty_execute(const Montgomery_Exponentation_State &precomputed_state, const BigInt &k, size_t max_k_bits)
size_t dl_exponent_size(size_t bits)
std::shared_ptr< const Montgomery_Exponentation_State > monty_precompute(const Montgomery_Int &g, size_t window_bits, bool const_time)
int32_t jacobi(const BigInt &a, const BigInt &n)
BigInt random_safe_prime(RandomNumberGenerator &rng, size_t bits)
Montgomery_Int monty_exp(const Montgomery_Params ¶ms_p, const BigInt &g, const BigInt &k, size_t max_k_bits)