5230455705

Committed 10 Jun 2023 02:30PM UTC coverage: 91.715% (-0.03%) from 91.746%

Build # 5230455705

Build Type

push

github

Committed by

randombit

Commit Message

Merge GH #3584 Change clang-format AllowShortFunctionsOnASingleLine config from All to Inline

Run Details

77182 of 84154 relevant lines covered (91.72%)

11975295.43 hits per line

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

92.92

/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/numthry.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::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);
}

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) {
   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) {
   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();
}

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(); }

      secure_vector<uint8_t> raw_sign(const uint8_t msg[], size_t msg_len, 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);
}

secure_vector<uint8_t> DSA_Signature_Operation::raw_sign(const uint8_t msg[],
                                                         size_t msg_len,
                                                         RandomNumberGenerator& rng) {
   const DL_Group& group = m_key->group();
   const BigInt& q = group.get_q();

   BigInt m = BigInt::from_bytes_with_max_bits(msg, msg_len, 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(k);

   /*
   * 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 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(const uint8_t msg[], size_t msg_len, const uint8_t sig[], size_t sig_len) override;

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

bool DSA_Verification_Operation::verify(const uint8_t msg[], size_t msg_len, const uint8_t sig[], size_t sig_len) {
   const auto group = m_key->group();

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

   if(sig_len != 2 * q_bytes) {
      return false;
   }

   BigInt r(sig, q_bytes);
   BigInt s(sig + q_bytes, q_bytes);
   BigInt i = BigInt::from_bytes_with_max_bits(msg, msg_len, group.q_bits());
   if(i >= q) {
      i -= q;
   }

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

   s = inverse_mod(s, q);

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

randombit / botan / 5230455705

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