12873787387

Committed 20 Jan 2025 06:20PM UTC coverage: 91.212% (+0.003%) from 91.209%

Build # 12873787387

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #4575 from randombit/jack/cleanup-up-includes

Clean up includes

Run Details

93551 of 102564 relevant lines covered (91.21%)

11622221.86 hits per line

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

95.0

/src/lib/pubkey/dsa/dsa.cpp

/*
* DSA
* (C) 1999-2010,2014,2016,2023 Jack Lloyd
* (C) 2016 René Korthaus
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include <botan/dsa.h>

#include <botan/internal/divide.h>
#include <botan/internal/dl_scheme.h>
#include <botan/internal/keypair.h>
#include <botan/internal/pk_ops_impl.h>

#if defined(BOTAN_HAS_RFC6979_GENERATOR)
   #include <botan/internal/rfc6979.h>
#endif

namespace Botan {

size_t DSA_PublicKey::message_part_size() const {
   return m_public_key->group().q_bytes();
}

size_t DSA_PublicKey::estimated_strength() const {
   return m_public_key->estimated_strength();
}

size_t DSA_PublicKey::key_length() const {
   return m_public_key->p_bits();
}

const BigInt& DSA_PublicKey::get_int_field(std::string_view field) const {
   return m_public_key->get_int_field(algo_name(), field);
}

AlgorithmIdentifier DSA_PublicKey::algorithm_identifier() const {
   return AlgorithmIdentifier(object_identifier(), m_public_key->group().DER_encode(DL_Group_Format::ANSI_X9_57));
}

std::vector<uint8_t> DSA_PublicKey::raw_public_key_bits() const {
   return m_public_key->public_key_as_bytes();
}

std::vector<uint8_t> DSA_PublicKey::public_key_bits() const {
   return m_public_key->DER_encode();
}

bool DSA_PublicKey::check_key(RandomNumberGenerator& rng, bool strong) const {
   return m_public_key->check_key(rng, strong);
}

std::unique_ptr<Private_Key> DSA_PublicKey::generate_another(RandomNumberGenerator& rng) const {
   return std::make_unique<DSA_PrivateKey>(rng, m_public_key->group());
}

DSA_PublicKey::DSA_PublicKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) {
   m_public_key = std::make_shared<DL_PublicKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_57);

   BOTAN_ARG_CHECK(m_public_key->group().has_q(), "Q parameter must be set for DSA");
}

DSA_PublicKey::DSA_PublicKey(const DL_Group& group, const BigInt& y) {
   m_public_key = std::make_shared<DL_PublicKey>(group, y);

   BOTAN_ARG_CHECK(m_public_key->group().has_q(), "Q parameter must be set for DSA");
}

DSA_PrivateKey::DSA_PrivateKey(RandomNumberGenerator& rng, const DL_Group& group) {
   BOTAN_ARG_CHECK(group.has_q(), "Q parameter must be set for DSA");

   m_private_key = std::make_shared<DL_PrivateKey>(group, rng);
   m_public_key = m_private_key->public_key();
}

DSA_PrivateKey::DSA_PrivateKey(const DL_Group& group, const BigInt& x) {
   BOTAN_ARG_CHECK(group.has_q(), "Q parameter must be set for DSA");

   m_private_key = std::make_shared<DL_PrivateKey>(group, x);
   m_public_key = m_private_key->public_key();
}

DSA_PrivateKey::DSA_PrivateKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) {
   m_private_key = std::make_shared<DL_PrivateKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_57);
   m_public_key = m_private_key->public_key();

   BOTAN_ARG_CHECK(m_private_key->group().has_q(), "Q parameter must be set for DSA");
}

bool DSA_PrivateKey::check_key(RandomNumberGenerator& rng, bool strong) const {
   if(!m_private_key->check_key(rng, strong)) {
      return false;
   }

   if(m_private_key->private_key() >= m_private_key->group().get_q()) {
      return false;
   }

   return KeyPair::signature_consistency_check(rng, *this, "SHA-256");
}

secure_vector<uint8_t> DSA_PrivateKey::private_key_bits() const {
   return m_private_key->DER_encode();
}

secure_vector<uint8_t> DSA_PrivateKey::raw_private_key_bits() const {
   return m_private_key->raw_private_key_bits();
}

const BigInt& DSA_PrivateKey::get_int_field(std::string_view field) const {
   return m_private_key->get_int_field(algo_name(), field);
}

std::unique_ptr<Public_Key> DSA_PrivateKey::public_key() const {
   // can't use make_unique here due to private constructor
   return std::unique_ptr<DSA_PublicKey>(new DSA_PublicKey(m_public_key));
}

namespace {

/**
* Object that can create a DSA signature
*/
class DSA_Signature_Operation final : public PK_Ops::Signature_with_Hash {
   public:
      DSA_Signature_Operation(const std::shared_ptr<const DL_PrivateKey>& key,
                              std::string_view emsa,
                              RandomNumberGenerator& rng) :
            PK_Ops::Signature_with_Hash(emsa), m_key(key) {
         m_b = BigInt::random_integer(rng, 2, m_key->group().get_q());
         m_b_inv = m_key->group().inverse_mod_q(m_b);
      }

      size_t signature_length() const override { return 2 * m_key->group().q_bytes(); }

      std::vector<uint8_t> raw_sign(std::span<const uint8_t> msg, RandomNumberGenerator& rng) override;

      AlgorithmIdentifier algorithm_identifier() const override;

   private:
      std::shared_ptr<const DL_PrivateKey> m_key;
      BigInt m_b, m_b_inv;
};

AlgorithmIdentifier DSA_Signature_Operation::algorithm_identifier() const {
   const std::string full_name = "DSA/" + hash_function();
   const OID oid = OID::from_string(full_name);
   return AlgorithmIdentifier(oid, AlgorithmIdentifier::USE_EMPTY_PARAM);
}

std::vector<uint8_t> DSA_Signature_Operation::raw_sign(std::span<const uint8_t> msg, RandomNumberGenerator& rng) {
   const DL_Group& group = m_key->group();
   const BigInt& q = group.get_q();

   BigInt m = BigInt::from_bytes_with_max_bits(msg.data(), msg.size(), group.q_bits());

   if(m >= q) {
      m -= q;
   }

#if defined(BOTAN_HAS_RFC6979_GENERATOR)
   BOTAN_UNUSED(rng);
   const BigInt k = generate_rfc6979_nonce(m_key->private_key(), q, m, this->rfc6979_hash_function());
#else
   const BigInt k = BigInt::random_integer(rng, 1, q);
#endif

   const BigInt k_inv = group.inverse_mod_q(group.mod_q(m_b * k)) * m_b;

   /*
   * It may not be strictly necessary for the reduction (g^k mod p) mod q to be
   * const time, since r is published as part of the signature, and deriving
   * anything useful about k from g^k mod p would seem to require computing a
   * discrete logarithm.
   *
   * However it only increases the cost of signatures by about 7-10%, and DSA is
   * only for legacy use anyway so we don't care about the performance so much.
   */
   const BigInt r = ct_modulo(group.power_g_p(k, group.q_bits()), group.get_q());

   /*
   * Blind the input message and compute x*r+m as (x*r*b + m*b)/b
   */
   m_b = group.square_mod_q(m_b);
   m_b_inv = group.square_mod_q(m_b_inv);

   m = group.multiply_mod_q(m_b, m);
   const BigInt xr = group.multiply_mod_q(m_b, m_key->private_key(), r);

   const BigInt s = group.multiply_mod_q(m_b_inv, k_inv, group.mod_q(xr + m));

   // With overwhelming probability, a bug rather than actual zero r/s
   if(r.is_zero() || s.is_zero()) {
      throw Internal_Error("Computed zero r/s during DSA signature");
   }

   return unlock(BigInt::encode_fixed_length_int_pair(r, s, q.bytes()));
}

/**
* Object that can verify a DSA signature
*/
class DSA_Verification_Operation final : public PK_Ops::Verification_with_Hash {
   public:
      DSA_Verification_Operation(const std::shared_ptr<const DL_PublicKey>& key, std::string_view emsa) :
            PK_Ops::Verification_with_Hash(emsa), m_key(key) {}

      DSA_Verification_Operation(const std::shared_ptr<const DL_PublicKey>& key, const AlgorithmIdentifier& alg_id) :
            PK_Ops::Verification_with_Hash(alg_id, "DSA"), m_key(key) {}

      bool verify(std::span<const uint8_t> input, std::span<const uint8_t> sig) override;

   private:
      std::shared_ptr<const DL_PublicKey> m_key;
};

bool DSA_Verification_Operation::verify(std::span<const uint8_t> input, std::span<const uint8_t> sig) {
   const auto group = m_key->group();

   const BigInt& q = group.get_q();
   const size_t q_bytes = q.bytes();

   if(sig.size() != 2 * q_bytes) {
      return false;
   }

   BigInt r(sig.first(q_bytes));
   BigInt s(sig.last(q_bytes));

   if(r == 0 || r >= q || s == 0 || s >= q) {
      return false;
   }

   BigInt i = BigInt::from_bytes_with_max_bits(input.data(), input.size(), group.q_bits());
   if(i >= q) {
      i -= q;
   }

   s = group.inverse_mod_q(s);

   const BigInt sr = group.multiply_mod_q(s, r);
   const BigInt si = group.multiply_mod_q(s, i);

   s = group.multi_exponentiate(si, m_key->public_key(), sr);

   // s is too big for Barrett, and verification doesn't need to be const-time
   return (s % group.get_q() == r);
}

}  // namespace

std::unique_ptr<PK_Ops::Verification> DSA_PublicKey::create_verification_op(std::string_view params,
                                                                            std::string_view provider) const {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<DSA_Verification_Operation>(this->m_public_key, params);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

std::unique_ptr<PK_Ops::Verification> DSA_PublicKey::create_x509_verification_op(
   const AlgorithmIdentifier& signature_algorithm, std::string_view provider) const {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<DSA_Verification_Operation>(this->m_public_key, signature_algorithm);
   }

   throw Provider_Not_Found(algo_name(), provider);
}

std::unique_ptr<PK_Ops::Signature> DSA_PrivateKey::create_signature_op(RandomNumberGenerator& rng,
                                                                       std::string_view params,
                                                                       std::string_view provider) const {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<DSA_Signature_Operation>(this->m_private_key, params, rng);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

}  // namespace Botan

1	/*
2	* DSA
3	* (C) 1999-2010,2014,2016,2023 Jack Lloyd
4	* (C) 2016 René Korthaus
5	*
6	* Botan is released under the Simplified BSD License (see license.txt)
7	*/
8
9	#include <botan/dsa.h>
10
11	#include <botan/internal/divide.h>
12	#include <botan/internal/dl_scheme.h>
13	#include <botan/internal/keypair.h>
14	#include <botan/internal/pk_ops_impl.h>
15
16	#if defined(BOTAN_HAS_RFC6979_GENERATOR)
17	#include <botan/internal/rfc6979.h>
18	#endif
19
20	namespace Botan {
21
22	size_t DSA_PublicKey::message_part_size() const {	444✔
23	return m_public_key->group().q_bytes();	444✔
24	}
25
26	size_t DSA_PublicKey::estimated_strength() const {	28✔
27	return m_public_key->estimated_strength();	28✔
28	}
29
30	size_t DSA_PublicKey::key_length() const {	1✔
31	return m_public_key->p_bits();	1✔
32	}
33
34	const BigInt& DSA_PublicKey::get_int_field(std::string_view field) const {	8✔
35	return m_public_key->get_int_field(algo_name(), field);	8✔
36	}
37
38	AlgorithmIdentifier DSA_PublicKey::algorithm_identifier() const {	93✔
39	return AlgorithmIdentifier(object_identifier(), m_public_key->group().DER_encode(DL_Group_Format::ANSI_X9_57));	186✔
40	}
41
42	std::vector<uint8_t> DSA_PublicKey::raw_public_key_bits() const {	1✔
43	return m_public_key->public_key_as_bytes();	1✔
44	}
45
46	std::vector<uint8_t> DSA_PublicKey::public_key_bits() const {	68✔
47	return m_public_key->DER_encode();	68✔
48	}
49
50	bool DSA_PublicKey::check_key(RandomNumberGenerator& rng, bool strong) const {	7✔
51	return m_public_key->check_key(rng, strong);	7✔
52	}
53
54	std::unique_ptr<Private_Key> DSA_PublicKey::generate_another(RandomNumberGenerator& rng) const {	1✔
55	return std::make_unique<DSA_PrivateKey>(rng, m_public_key->group());	2✔
56	}
57
58	DSA_PublicKey::DSA_PublicKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) {	234✔
59	m_public_key = std::make_shared<DL_PublicKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_57);	234✔
60
61	BOTAN_ARG_CHECK(m_public_key->group().has_q(), "Q parameter must be set for DSA");	122✔
62	}	234✔
63
64	DSA_PublicKey::DSA_PublicKey(const DL_Group& group, const BigInt& y) {	5✔
65	m_public_key = std::make_shared<DL_PublicKey>(group, y);	5✔
66
67	BOTAN_ARG_CHECK(m_public_key->group().has_q(), "Q parameter must be set for DSA");	5✔
68	}	5✔
69
70	DSA_PrivateKey::DSA_PrivateKey(RandomNumberGenerator& rng, const DL_Group& group) {	17✔
71	BOTAN_ARG_CHECK(group.has_q(), "Q parameter must be set for DSA");	17✔
72
73	m_private_key = std::make_shared<DL_PrivateKey>(group, rng);	17✔
74	m_public_key = m_private_key->public_key();	17✔
75	}	17✔
76
77	DSA_PrivateKey::DSA_PrivateKey(const DL_Group& group, const BigInt& x) {	325✔
78	BOTAN_ARG_CHECK(group.has_q(), "Q parameter must be set for DSA");	325✔
79
80	m_private_key = std::make_shared<DL_PrivateKey>(group, x);	325✔
81	m_public_key = m_private_key->public_key();	325✔
82	}	325✔
83
84	DSA_PrivateKey::DSA_PrivateKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) {	316✔
85	m_private_key = std::make_shared<DL_PrivateKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_57);	316✔
86	m_public_key = m_private_key->public_key();	67✔
87
88	BOTAN_ARG_CHECK(m_private_key->group().has_q(), "Q parameter must be set for DSA");	67✔
89	}	326✔
90
91	bool DSA_PrivateKey::check_key(RandomNumberGenerator& rng, bool strong) const {	5✔
92	if(!m_private_key->check_key(rng, strong)) {	5✔
93	return false;
94	}
95
96	if(m_private_key->private_key() >= m_private_key->group().get_q()) {	5✔
97	return false;
98	}
99
100	return KeyPair::signature_consistency_check(rng, *this, "SHA-256");	5✔
101	}
102
103	secure_vector<uint8_t> DSA_PrivateKey::private_key_bits() const {	33✔
104	return m_private_key->DER_encode();	33✔
105	}
106
107	secure_vector<uint8_t> DSA_PrivateKey::raw_private_key_bits() const {	×
108	return m_private_key->raw_private_key_bits();	×
109	}
110
111	const BigInt& DSA_PrivateKey::get_int_field(std::string_view field) const {	10✔
112	return m_private_key->get_int_field(algo_name(), field);	10✔
113	}
114
115	std::unique_ptr<Public_Key> DSA_PrivateKey::public_key() const {	306✔
116	// can't use make_unique here due to private constructor
117	return std::unique_ptr<DSA_PublicKey>(new DSA_PublicKey(m_public_key));	306✔
118	}
119
120	namespace {
121
122	/**
123	* Object that can create a DSA signature
124	*/
125	class DSA_Signature_Operation final : public PK_Ops::Signature_with_Hash {	×
126	public:
127	DSA_Signature_Operation(const std::shared_ptr<const DL_PrivateKey>& key,	69✔
128	std::string_view emsa,
129	RandomNumberGenerator& rng) :	69✔
130	PK_Ops::Signature_with_Hash(emsa), m_key(key) {	69✔
131	m_b = BigInt::random_integer(rng, 2, m_key->group().get_q());	138✔
132	m_b_inv = m_key->group().inverse_mod_q(m_b);	138✔
133	}	69✔
134
135	size_t signature_length() const override { return 2 * m_key->group().q_bytes(); }	23✔
136
137	std::vector<uint8_t> raw_sign(std::span<const uint8_t> msg, RandomNumberGenerator& rng) override;
138
139	AlgorithmIdentifier algorithm_identifier() const override;
140
141	private:
142	std::shared_ptr<const DL_PrivateKey> m_key;
143	BigInt m_b, m_b_inv;
144	};
145
146	AlgorithmIdentifier DSA_Signature_Operation::algorithm_identifier() const {	37✔
147	const std::string full_name = "DSA/" + hash_function();	74✔
148	const OID oid = OID::from_string(full_name);	37✔
149	return AlgorithmIdentifier(oid, AlgorithmIdentifier::USE_EMPTY_PARAM);	37✔
150	}	37✔
151
152	std::vector<uint8_t> DSA_Signature_Operation::raw_sign(std::span<const uint8_t> msg, RandomNumberGenerator& rng) {	79✔
153	const DL_Group& group = m_key->group();	79✔
154	const BigInt& q = group.get_q();	79✔
155
156	BigInt m = BigInt::from_bytes_with_max_bits(msg.data(), msg.size(), group.q_bits());	79✔
157
158	if(m >= q) {	79✔
159	m -= q;	28✔
160	}
161
162	#if defined(BOTAN_HAS_RFC6979_GENERATOR)
163	BOTAN_UNUSED(rng);	79✔
164	const BigInt k = generate_rfc6979_nonce(m_key->private_key(), q, m, this->rfc6979_hash_function());	79✔
165	#else
166	const BigInt k = BigInt::random_integer(rng, 1, q);
167	#endif
168
169	const BigInt k_inv = group.inverse_mod_q(group.mod_q(m_b * k)) * m_b;	237✔
170
171	/*
172	* It may not be strictly necessary for the reduction (g^k mod p) mod q to be
173	* const time, since r is published as part of the signature, and deriving
174	* anything useful about k from g^k mod p would seem to require computing a
175	* discrete logarithm.
176	*
177	* However it only increases the cost of signatures by about 7-10%, and DSA is
178	* only for legacy use anyway so we don't care about the performance so much.
179	*/
180	const BigInt r = ct_modulo(group.power_g_p(k, group.q_bits()), group.get_q());	79✔
181
182	/*
183	* Blind the input message and compute xr+m as (xrb + mb)/b
184	*/
185	m_b = group.square_mod_q(m_b);	79✔
186	m_b_inv = group.square_mod_q(m_b_inv);	79✔
187
188	m = group.multiply_mod_q(m_b, m);	79✔
189	const BigInt xr = group.multiply_mod_q(m_b, m_key->private_key(), r);	79✔
190
191	const BigInt s = group.multiply_mod_q(m_b_inv, k_inv, group.mod_q(xr + m));	158✔
192
193	// With overwhelming probability, a bug rather than actual zero r/s
194	if(r.is_zero() \|\| s.is_zero()) {	158✔
195	throw Internal_Error("Computed zero r/s during DSA signature");	×
196	}
197
198	return unlock(BigInt::encode_fixed_length_int_pair(r, s, q.bytes()));	237✔
199	}	474✔
200
201	/**
202	* Object that can verify a DSA signature
203	*/
204	class DSA_Verification_Operation final : public PK_Ops::Verification_with_Hash {	×
205	public:
206	DSA_Verification_Operation(const std::shared_ptr<const DL_PublicKey>& key, std::string_view emsa) :	336✔
207	PK_Ops::Verification_with_Hash(emsa), m_key(key) {}	336✔
208
209	DSA_Verification_Operation(const std::shared_ptr<const DL_PublicKey>& key, const AlgorithmIdentifier& alg_id) :	80✔
210	PK_Ops::Verification_with_Hash(alg_id, "DSA"), m_key(key) {}	80✔
211
212	bool verify(std::span<const uint8_t> input, std::span<const uint8_t> sig) override;
213
214	private:
215	std::shared_ptr<const DL_PublicKey> m_key;
216	};
217
218	bool DSA_Verification_Operation::verify(std::span<const uint8_t> input, std::span<const uint8_t> sig) {	7,239✔
219	const auto group = m_key->group();	7,239✔
220
221	const BigInt& q = group.get_q();	7,239✔
222	const size_t q_bytes = q.bytes();	7,239✔
223
224	if(sig.size() != 2 * q_bytes) {	7,239✔
225	return false;
226	}
227
228	BigInt r(sig.first(q_bytes));	7,239✔
229	BigInt s(sig.last(q_bytes));	7,239✔
230
231	if(r == 0 \|\| r >= q \|\| s == 0 \|\| s >= q) {	27,893✔
232	return false;	404✔
233	}
234
235	BigInt i = BigInt::from_bytes_with_max_bits(input.data(), input.size(), group.q_bits());	6,835✔
236	if(i >= q) {	6,835✔
237	i -= q;	1,298✔
238	}
239
240	s = group.inverse_mod_q(s);	6,835✔
241
242	const BigInt sr = group.multiply_mod_q(s, r);	6,835✔
243	const BigInt si = group.multiply_mod_q(s, i);	6,835✔
244
245	s = group.multi_exponentiate(si, m_key->public_key(), sr);	6,835✔
246
247	// s is too big for Barrett, and verification doesn't need to be const-time
248	return (s % group.get_q() == r);	20,505✔
249	}	42,222✔
250
251	} // namespace
252
253	std::unique_ptr<PK_Ops::Verification> DSA_PublicKey::create_verification_op(std::string_view params,	1,311✔
254	std::string_view provider) const {
255	if(provider == "base" \|\| provider.empty()) {	1,637✔
256	return std::make_unique<DSA_Verification_Operation>(this->m_public_key, params);	336✔
257	}
258	throw Provider_Not_Found(algo_name(), provider);	1,950✔
259	}
260
261	std::unique_ptr<PK_Ops::Verification> DSA_PublicKey::create_x509_verification_op(	80✔
262	const AlgorithmIdentifier& signature_algorithm, std::string_view provider) const {
263	if(provider == "base" \|\| provider.empty()) {	80✔
264	return std::make_unique<DSA_Verification_Operation>(this->m_public_key, signature_algorithm);	80✔
265	}
266
267	throw Provider_Not_Found(algo_name(), provider);	×
268	}
269
270	std::unique_ptr<PK_Ops::Signature> DSA_PrivateKey::create_signature_op(RandomNumberGenerator& rng,	132✔
271	std::string_view params,
272	std::string_view provider) const {
273	if(provider == "base" \|\| provider.empty()) {	154✔
274	return std::make_unique<DSA_Signature_Operation>(this->m_private_key, params, rng);	69✔
275	}
276	throw Provider_Not_Found(algo_name(), provider);	126✔
277	}
278
279	} // namespace Botan

randombit / botan / 12873787387

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

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