12878091418

Committed 20 Jan 2025 06:20PM UTC coverage: 91.216% (+0.007%) from 91.209%

Build # 12878091418

Build Type

push

github

Committed by

web-flow

Commit Message

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

Clean up includes

Coverage Stats

93555 of 102564 relevant lines covered (91.22%)

11518104.42 hits per line

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

95.35

/src/lib/pubkey/sm2/sm2.cpp

/*
* SM2 Signatures
* (C) 2017,2018 Ribose Inc
* (C) 2018,2024 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include <botan/sm2.h>

#include <botan/hash.h>
#include <botan/internal/keypair.h>
#include <botan/internal/loadstor.h>
#include <botan/internal/parsing.h>
#include <botan/internal/pk_ops_impl.h>

namespace Botan {

std::string SM2_PublicKey::algo_name() const {
   return "SM2";
}

std::unique_ptr<Public_Key> SM2_PrivateKey::public_key() const {
   return std::make_unique<SM2_Signature_PublicKey>(domain(), _public_ec_point());
}

bool SM2_PrivateKey::check_key(RandomNumberGenerator& rng, bool strong) const {
   if(!EC_PrivateKey::check_key(rng, strong)) {
      return false;
   }

   // SM2 has an oddity in private key generation when compared to
   // other EC*DSA style signature algorithms described in ISO14888-3:
   // the private key x MUST be in [0, q-1) instead of [0, q).
   //
   // The lower bound is already checked by the default impl
   if(private_value() >= domain().get_order() - 1) {
      return false;
   }

   if(!strong) {
      return true;
   }

   return KeyPair::signature_consistency_check(rng, *this, "user@example.com,SM3");
}

SM2_PrivateKey::SM2_PrivateKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) :
      EC_PrivateKey(alg_id, key_bits),
      m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
      m_da_inv_legacy(m_da_inv.to_bigint()) {}

SM2_PrivateKey::SM2_PrivateKey(EC_Group group, EC_Scalar x) :
      EC_PrivateKey(std::move(group), std::move(x)),
      m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
      m_da_inv_legacy(m_da_inv.to_bigint()) {}

SM2_PrivateKey::SM2_PrivateKey(RandomNumberGenerator& rng, EC_Group group) :
      EC_PrivateKey(rng, std::move(group)),
      m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
      m_da_inv_legacy(m_da_inv.to_bigint()) {}

SM2_PrivateKey::SM2_PrivateKey(RandomNumberGenerator& rng, EC_Group group, const BigInt& x) :
      EC_PrivateKey(rng, std::move(group), x),
      m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),
      m_da_inv_legacy(m_da_inv.to_bigint()) {}

std::vector<uint8_t> sm2_compute_za(HashFunction& hash,
                                    std::string_view user_id,
                                    const EC_Group& group,
                                    const EC_AffinePoint& pubkey) {
   if(user_id.size() >= 8192) {
      throw Invalid_Argument("SM2 user id too long to represent");
   }

   const uint16_t uid_len = static_cast<uint16_t>(8 * user_id.size());

   hash.update(get_byte<0>(uid_len));
   hash.update(get_byte<1>(uid_len));
   hash.update(user_id);

   const size_t p_bytes = group.get_p_bytes();

   hash.update(group.get_a().serialize(p_bytes));
   hash.update(group.get_b().serialize(p_bytes));
   hash.update(group.get_g_x().serialize(p_bytes));
   hash.update(group.get_g_y().serialize(p_bytes));
   hash.update(pubkey.xy_bytes());

   return hash.final<std::vector<uint8_t>>();
}

namespace {

/**
* SM2 signature operation
*/
class SM2_Signature_Operation final : public PK_Ops::Signature {
   public:
      SM2_Signature_Operation(const SM2_PrivateKey& sm2, std::string_view ident, std::string_view hash) :
            m_group(sm2.domain()), m_x(sm2._private_key()), m_da_inv(sm2._get_da_inv()) {
         if(hash == "Raw") {
            // m_hash is null, m_za is empty
         } else {
            m_hash = HashFunction::create_or_throw(hash);
            // ZA=H256(ENTLA || IDA || a || b || xG || yG || xA || yA)
            m_za = sm2_compute_za(*m_hash, ident, m_group, sm2._public_ec_point());
            m_hash->update(m_za);
         }
      }

      size_t signature_length() const override { return 2 * m_group.get_order_bytes(); }

      void update(std::span<const uint8_t> input) override {
         if(m_hash) {
            m_hash->update(input);
         } else {
            m_digest.insert(m_digest.end(), input.begin(), input.end());
         }
      }

      std::vector<uint8_t> sign(RandomNumberGenerator& rng) override;

      std::string hash_function() const override { return m_hash ? m_hash->name() : "Raw"; }

   private:
      const EC_Group m_group;
      const EC_Scalar m_x;
      const EC_Scalar m_da_inv;

      std::vector<uint8_t> m_za;
      secure_vector<uint8_t> m_digest;
      std::unique_ptr<HashFunction> m_hash;
      std::vector<BigInt> m_ws;
};

std::vector<uint8_t> SM2_Signature_Operation::sign(RandomNumberGenerator& rng) {
   const auto e = [&]() {
      if(m_hash) {
         auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_hash->final());
         // prepend ZA for next signature if any
         m_hash->update(m_za);
         return ie;
      } else {
         auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_digest);
         m_digest.clear();
         return ie;
      }
   }();

   const auto k = EC_Scalar::random(m_group, rng);

   const auto r = EC_Scalar::gk_x_mod_order(k, rng, m_ws) + e;
   const auto s = (k - r * m_x) * m_da_inv;

   return EC_Scalar::serialize_pair(r, s);
}

/**
* SM2 verification operation
*/
class SM2_Verification_Operation final : public PK_Ops::Verification {
   public:
      SM2_Verification_Operation(const SM2_PublicKey& sm2, std::string_view ident, std::string_view hash) :
            m_group(sm2.domain()), m_gy_mul(sm2._public_ec_point()) {
         if(hash == "Raw") {
            // m_hash is null, m_za is empty
         } else {
            m_hash = HashFunction::create_or_throw(hash);
            // ZA=H256(ENTLA || IDA || a || b || xG || yG || xA || yA)
            m_za = sm2_compute_za(*m_hash, ident, m_group, sm2._public_ec_point());
            m_hash->update(m_za);
         }
      }

      void update(std::span<const uint8_t> input) override {
         if(m_hash) {
            m_hash->update(input);
         } else {
            m_digest.insert(m_digest.end(), input.begin(), input.end());
         }
      }

      bool is_valid_signature(std::span<const uint8_t> sig) override;

      std::string hash_function() const override { return m_hash ? m_hash->name() : "Raw"; }

   private:
      const EC_Group m_group;
      const EC_Group::Mul2Table m_gy_mul;
      secure_vector<uint8_t> m_digest;
      std::vector<uint8_t> m_za;
      std::unique_ptr<HashFunction> m_hash;
};

bool SM2_Verification_Operation::is_valid_signature(std::span<const uint8_t> sig) {
   const auto e = [&]() {
      if(m_hash) {
         auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_hash->final());
         // prepend ZA for next signature if any
         m_hash->update(m_za);
         return ie;
      } else {
         auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_digest);
         m_digest.clear();
         return ie;
      }
   }();

   if(auto rs = EC_Scalar::deserialize_pair(m_group, sig)) {
      const auto& [r, s] = rs.value();

      if(r.is_nonzero() && s.is_nonzero()) {
         const auto t = r + s;
         if(t.is_nonzero()) {
            // Check if r - e = x_coord(g*s + y*t) % n
            return m_gy_mul.mul2_vartime_x_mod_order_eq(r - e, s, t);
         }
      }
   }
   return false;
}

void parse_sm2_param_string(std::string_view params, std::string& userid, std::string& hash) {
   // GM/T 0009-2012 specifies this as the default userid
   const std::string default_userid = "1234567812345678";

   // defaults:
   userid = default_userid;
   hash = "SM3";

   /*
   * SM2 parameters have the following possible formats:
   * Ident [since 2.2.0]
   * Ident,Hash [since 2.3.0]
   */

   auto comma = params.find(',');
   if(comma == std::string::npos) {
      userid = params;
   } else {
      userid = params.substr(0, comma);
      hash = params.substr(comma + 1, std::string::npos);
   }
}

}  // namespace

std::unique_ptr<Private_Key> SM2_PublicKey::generate_another(RandomNumberGenerator& rng) const {
   return std::make_unique<SM2_PrivateKey>(rng, domain());
}

std::unique_ptr<PK_Ops::Verification> SM2_PublicKey::create_verification_op(std::string_view params,
                                                                            std::string_view provider) const {
   if(provider == "base" || provider.empty()) {
      std::string userid, hash;
      parse_sm2_param_string(params, userid, hash);
      return std::make_unique<SM2_Verification_Operation>(*this, userid, hash);
   }

   throw Provider_Not_Found(algo_name(), provider);
}

std::unique_ptr<PK_Ops::Signature> SM2_PrivateKey::create_signature_op(RandomNumberGenerator& /*rng*/,
                                                                       std::string_view params,
                                                                       std::string_view provider) const {
   if(provider == "base" || provider.empty()) {
      std::string userid, hash;
      parse_sm2_param_string(params, userid, hash);
      return std::make_unique<SM2_Signature_Operation>(*this, userid, hash);
   }

   throw Provider_Not_Found(algo_name(), provider);
}

}  // namespace Botan

1	/*
2	* SM2 Signatures
3	* (C) 2017,2018 Ribose Inc
4	* (C) 2018,2024 Jack Lloyd
5	*
6	* Botan is released under the Simplified BSD License (see license.txt)
7	*/
8
9	#include <botan/sm2.h>
10
11	#include <botan/hash.h>
12	#include <botan/internal/keypair.h>
13	#include <botan/internal/loadstor.h>
14	#include <botan/internal/parsing.h>
15	#include <botan/internal/pk_ops_impl.h>
16
17	namespace Botan {
18
19	std::string SM2_PublicKey::algo_name() const {	207✔
20	return "SM2";	207✔
21	}
22
23	std::unique_ptr<Public_Key> SM2_PrivateKey::public_key() const {	7✔
24	return std::make_unique<SM2_Signature_PublicKey>(domain(), _public_ec_point());	7✔
25	}
26
27	bool SM2_PrivateKey::check_key(RandomNumberGenerator& rng, bool strong) const {	4✔
28	if(!EC_PrivateKey::check_key(rng, strong)) {	4✔
29	return false;
30	}
31
32	// SM2 has an oddity in private key generation when compared to
33	// other EC*DSA style signature algorithms described in ISO14888-3:
34	// the private key x MUST be in [0, q-1) instead of [0, q).
35	//
36	// The lower bound is already checked by the default impl
37	if(private_value() >= domain().get_order() - 1) {	8✔
38	return false;
39	}
40
41	if(!strong) {	4✔
42	return true;
43	}
44
45	return KeyPair::signature_consistency_check(rng, *this, "user@example.com,SM3");	2✔
46	}
47
48	SM2_PrivateKey::SM2_PrivateKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) :	20✔
49	EC_PrivateKey(alg_id, key_bits),
50	m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),	20✔
51	m_da_inv_legacy(m_da_inv.to_bigint()) {}	40✔
52
53	SM2_PrivateKey::SM2_PrivateKey(EC_Group group, EC_Scalar x) :	×
54	EC_PrivateKey(std::move(group), std::move(x)),
55	m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),	×
56	m_da_inv_legacy(m_da_inv.to_bigint()) {}	×
57
58	SM2_PrivateKey::SM2_PrivateKey(RandomNumberGenerator& rng, EC_Group group) :	10✔
59	EC_PrivateKey(rng, std::move(group)),
60	m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),	10✔
61	m_da_inv_legacy(m_da_inv.to_bigint()) {}	20✔
62
63	SM2_PrivateKey::SM2_PrivateKey(RandomNumberGenerator& rng, EC_Group group, const BigInt& x) :	15✔
64	EC_PrivateKey(rng, std::move(group), x),
65	m_da_inv((this->_private_key() + EC_Scalar::one(domain())).invert()),	15✔
66	m_da_inv_legacy(m_da_inv.to_bigint()) {}	30✔
67
68	std::vector<uint8_t> sm2_compute_za(HashFunction& hash,	28✔
69	std::string_view user_id,
70	const EC_Group& group,
71	const EC_AffinePoint& pubkey) {
72	if(user_id.size() >= 8192) {	28✔
73	throw Invalid_Argument("SM2 user id too long to represent");	×
74	}
75
76	const uint16_t uid_len = static_cast<uint16_t>(8 * user_id.size());	28✔
77
78	hash.update(get_byte<0>(uid_len));	28✔
79	hash.update(get_byte<1>(uid_len));	28✔
80	hash.update(user_id);	28✔
81
82	const size_t p_bytes = group.get_p_bytes();	28✔
83
84	hash.update(group.get_a().serialize(p_bytes));	28✔
85	hash.update(group.get_b().serialize(p_bytes));	28✔
86	hash.update(group.get_g_x().serialize(p_bytes));	28✔
87	hash.update(group.get_g_y().serialize(p_bytes));	28✔
88	hash.update(pubkey.xy_bytes());	28✔
89
90	return hash.final<std::vector<uint8_t>>();	28✔
91	}
92
93	namespace {
94
95	/**
96	* SM2 signature operation
97	*/
98	class SM2_Signature_Operation final : public PK_Ops::Signature {	×
99	public:
100	SM2_Signature_Operation(const SM2_PrivateKey& sm2, std::string_view ident, std::string_view hash) :	15✔
101	m_group(sm2.domain()), m_x(sm2._private_key()), m_da_inv(sm2._get_da_inv()) {	15✔
102	if(hash == "Raw") {	17✔
103	// m_hash is null, m_za is empty
104	} else {
105	m_hash = HashFunction::create_or_throw(hash);	13✔
106	// ZA=H256(ENTLA \|\| IDA \|\| a \|\| b \|\| xG \|\| yG \|\| xA \|\| yA)
107	m_za = sm2_compute_za(*m_hash, ident, m_group, sm2._public_ec_point());	13✔
108	m_hash->update(m_za);	13✔
109	}
110	}	15✔
111
112	size_t signature_length() const override { return 2 * m_group.get_order_bytes(); }	10✔
113
114	void update(std::span<const uint8_t> input) override {	19✔
115	if(m_hash) {	19✔
116	m_hash->update(input);	17✔
117	} else {
118	m_digest.insert(m_digest.end(), input.begin(), input.end());	2✔
119	}
120	}	19✔
121
122	std::vector<uint8_t> sign(RandomNumberGenerator& rng) override;
123
124	std::string hash_function() const override { return m_hash ? m_hash->name() : "Raw"; }	4✔
125
126	private:
127	const EC_Group m_group;
128	const EC_Scalar m_x;
129	const EC_Scalar m_da_inv;
130
131	std::vector<uint8_t> m_za;
132	secure_vector<uint8_t> m_digest;
133	std::unique_ptr<HashFunction> m_hash;
134	std::vector<BigInt> m_ws;
135	};
136
137	std::vector<uint8_t> SM2_Signature_Operation::sign(RandomNumberGenerator& rng) {	20✔
138	const auto e = [&]() {	60✔
139	if(m_hash) {	20✔
140	auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_hash->final());	18✔
141	// prepend ZA for next signature if any
142	m_hash->update(m_za);	18✔
143	return ie;	18✔
144	} else {	18✔
145	auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_digest);	2✔
146	m_digest.clear();	2✔
147	return ie;	2✔
148	}	2✔
149	}();	20✔
150
151	const auto k = EC_Scalar::random(m_group, rng);	20✔
152
153	const auto r = EC_Scalar::gk_x_mod_order(k, rng, m_ws) + e;	40✔
154	const auto s = (k - r * m_x) * m_da_inv;	20✔
155
156	return EC_Scalar::serialize_pair(r, s);	40✔
157	}	20✔
158
159	/**
160	* SM2 verification operation
161	*/
162	class SM2_Verification_Operation final : public PK_Ops::Verification {	×
163	public:
164	SM2_Verification_Operation(const SM2_PublicKey& sm2, std::string_view ident, std::string_view hash) :	15✔
165	m_group(sm2.domain()), m_gy_mul(sm2._public_ec_point()) {	15✔
166	if(hash == "Raw") {	17✔
167	// m_hash is null, m_za is empty
168	} else {
169	m_hash = HashFunction::create_or_throw(hash);	13✔
170	// ZA=H256(ENTLA \|\| IDA \|\| a \|\| b \|\| xG \|\| yG \|\| xA \|\| yA)
171	m_za = sm2_compute_za(*m_hash, ident, m_group, sm2._public_ec_point());	13✔
172	m_hash->update(m_za);	13✔
173	}
174	}	15✔
175
176	void update(std::span<const uint8_t> input) override {	178✔
177	if(m_hash) {	178✔
178	m_hash->update(input);	154✔
179	} else {
180	m_digest.insert(m_digest.end(), input.begin(), input.end());	24✔
181	}
182	}	178✔
183
184	bool is_valid_signature(std::span<const uint8_t> sig) override;
185
186	std::string hash_function() const override { return m_hash ? m_hash->name() : "Raw"; }	4✔
187
188	private:
189	const EC_Group m_group;
190	const EC_Group::Mul2Table m_gy_mul;
191	secure_vector<uint8_t> m_digest;
192	std::vector<uint8_t> m_za;
193	std::unique_ptr<HashFunction> m_hash;
194	};
195
196	bool SM2_Verification_Operation::is_valid_signature(std::span<const uint8_t> sig) {	179✔
197	const auto e = [&]() {	537✔
198	if(m_hash) {	179✔
199	auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_hash->final());	155✔
200	// prepend ZA for next signature if any
201	m_hash->update(m_za);	155✔
202	return ie;	155✔
203	} else {	155✔
204	auto ie = EC_Scalar::from_bytes_mod_order(m_group, m_digest);	24✔
205	m_digest.clear();	24✔
206	return ie;	24✔
207	}	24✔
208	}();	179✔
209
210	if(auto rs = EC_Scalar::deserialize_pair(m_group, sig)) {	179✔
211	const auto& [r, s] = rs.value();	170✔
212
213	if(r.is_nonzero() && s.is_nonzero()) {	340✔
214	const auto t = r + s;	170✔
215	if(t.is_nonzero()) {	170✔
216	// Check if r - e = x_coord(gs + yt) % n
217	return m_gy_mul.mul2_vartime_x_mod_order_eq(r - e, s, t);	170✔
218	}
219	}	170✔
220	}	170✔
221	return false;	9✔
222	}	179✔
223
224	void parse_sm2_param_string(std::string_view params, std::string& userid, std::string& hash) {	30✔
225	// GM/T 0009-2012 specifies this as the default userid
226	const std::string default_userid = "1234567812345678";	30✔
227
228	// defaults:
229	userid = default_userid;	30✔
230	hash = "SM3";	30✔
231
232	/*
233	* SM2 parameters have the following possible formats:
234	* Ident [since 2.2.0]
235	* Ident,Hash [since 2.3.0]
236	*/
237
238	auto comma = params.find(',');	30✔
239	if(comma == std::string::npos) {	30✔
240	userid = params;	38✔
241	} else {
242	userid = params.substr(0, comma);	22✔
243	hash = params.substr(comma + 1, std::string::npos);	44✔
244	}
245	}	30✔
246
247	} // namespace
248
249	std::unique_ptr<Private_Key> SM2_PublicKey::generate_another(RandomNumberGenerator& rng) const {	2✔
250	return std::make_unique<SM2_PrivateKey>(rng, domain());	4✔
251	}
252
253	std::unique_ptr<PK_Ops::Verification> SM2_PublicKey::create_verification_op(std::string_view params,	36✔
254	std::string_view provider) const {
255	if(provider == "base" \|\| provider.empty()) {	45✔
256	std::string userid, hash;	15✔
257	parse_sm2_param_string(params, userid, hash);	15✔
258	return std::make_unique<SM2_Verification_Operation>(*this, userid, hash);	15✔
259	}	15✔
260
261	throw Provider_Not_Found(algo_name(), provider);	42✔
262	}
263
264	std::unique_ptr<PK_Ops::Signature> SM2_PrivateKey::create_signature_op(RandomNumberGenerator& /rng/,	36✔
265	std::string_view params,
266	std::string_view provider) const {
267	if(provider == "base" \|\| provider.empty()) {	45✔
268	std::string userid, hash;	15✔
269	parse_sm2_param_string(params, userid, hash);	15✔
270	return std::make_unique<SM2_Signature_Operation>(*this, userid, hash);	15✔
271	}	15✔
272
273	throw Provider_Not_Found(algo_name(), provider);	42✔
274	}
275
276	} // namespace Botan

randombit / botan / 12878091418

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