Botan 3.14.1
Crypto and TLS for C&
ecgdsa.cpp
Go to the documentation of this file.
1/*
2* ECGDSA (BSI-TR-03111, version 2.0)
3* (C) 2016 René Korthaus
4* (C) 2018,2024 Jack Lloyd
5*
6* Botan is released under the Simplified BSD License (see license.txt)
7*/
8
9#include <botan/ecgdsa.h>
10
11#include <botan/assert.h>
12#include <botan/ec_group.h>
13#include <botan/internal/ct_utils.h>
14#include <botan/internal/keypair.h>
15#include <botan/internal/pk_ops_impl.h>
16#include <botan/internal/pk_options_impl.h>
17
18namespace Botan {
19
20std::unique_ptr<Public_Key> ECGDSA_PrivateKey::public_key() const {
21 return std::make_unique<ECGDSA_PublicKey>(domain(), public_ec_point());
22}
23
25 if(!EC_PrivateKey::check_key(rng, strong)) {
26 return false;
27 }
28
29 if(!strong) {
30 return true;
31 }
32
33 return KeyPair::signature_consistency_check(rng, *this, "SHA-256");
34}
35
36namespace {
37
38/**
39* ECGDSA signature operation
40*/
41class ECGDSA_Signature_Operation final : public PK_Ops::Signature_with_Hash {
42 public:
43 ECGDSA_Signature_Operation(const ECGDSA_PrivateKey& ecgdsa, const PK_Signature_Options_Reader& options) :
44 PK_Ops::Signature_with_Hash(options), m_group(ecgdsa.domain()), m_x(ecgdsa._private_key()) {}
45
46 std::vector<uint8_t> raw_sign(std::span<const uint8_t> msg, RandomNumberGenerator& rng) override;
47
48 size_t signature_length() const override { return 2 * m_group.get_order_bytes(); }
49
50 AlgorithmIdentifier algorithm_identifier() const override;
51
52 private:
53 const EC_Group m_group;
54 const EC_Scalar m_x;
55};
56
57AlgorithmIdentifier ECGDSA_Signature_Operation::algorithm_identifier() const {
58 const std::string full_name = "ECGDSA/" + hash_function();
59 const OID oid = OID::from_string(full_name);
60 return AlgorithmIdentifier(oid, AlgorithmIdentifier::USE_EMPTY_PARAM);
61}
62
63std::vector<uint8_t> ECGDSA_Signature_Operation::raw_sign(std::span<const uint8_t> msg, RandomNumberGenerator& rng) {
64 const auto m = EC_Scalar::from_bytes_with_trunc(m_group, msg);
65
66 const auto scope = CT::scoped_poison(m_x);
67
68 const auto k = EC_Scalar::random(m_group, rng);
69 CT::poison(k);
70
71 const auto r = EC_Scalar::gk_x_mod_order(k, rng);
72
73 const auto s = m_x * ((k * r) - m);
74
75 CT::unpoison_all(r, s);
76
77 // With overwhelming probability, a bug rather than actual zero r/s
78 if(r.is_zero() || s.is_zero()) {
79 throw Internal_Error("During ECGDSA signature generated zero r/s");
80 }
81
82 return EC_Scalar::serialize_pair(r, s);
83}
84
85/**
86* ECGDSA verification operation
87*/
88class ECGDSA_Verification_Operation final : public PK_Ops::Verification_with_Hash {
89 public:
90 ECGDSA_Verification_Operation(const ECGDSA_PublicKey& ecgdsa, const PK_Signature_Options_Reader& options) :
91 PK_Ops::Verification_with_Hash(options), m_group(ecgdsa.domain()), m_gy_mul(ecgdsa.public_ec_point()) {}
92
93 ECGDSA_Verification_Operation(const ECGDSA_PublicKey& ecgdsa, const AlgorithmIdentifier& alg_id) :
94 PK_Ops::Verification_with_Hash(alg_id, "ECGDSA"),
95 m_group(ecgdsa.domain()),
96 m_gy_mul(ecgdsa.public_ec_point()) {}
97
98 bool verify(std::span<const uint8_t> msg, std::span<const uint8_t> sig) override;
99
100 private:
101 const EC_Group m_group;
102 const EC_Group::Mul2Table m_gy_mul;
103};
104
105bool ECGDSA_Verification_Operation::verify(std::span<const uint8_t> msg, std::span<const uint8_t> sig) {
106 if(auto rs = EC_Scalar::deserialize_pair(m_group, sig)) {
107 const auto& [r, s] = rs.value();
108
109 if(r.is_nonzero() && s.is_nonzero()) {
110 const auto m = EC_Scalar::from_bytes_with_trunc(m_group, msg);
111
112 const auto w = r.invert_vartime();
113
114 // Check if r == x_coord(g*w*m + y*w*s) % n
115 return m_gy_mul.mul2_vartime_x_mod_order_eq(r, w, m, s);
116 }
117 }
118
119 return false;
120}
121
122} // namespace
123
125 return domain().get_order_bytes();
126}
127
128std::unique_ptr<Private_Key> ECGDSA_PublicKey::generate_another(RandomNumberGenerator& rng) const {
129 return std::make_unique<ECGDSA_PrivateKey>(rng, domain());
130}
131
132std::unique_ptr<PK_Ops::Verification> ECGDSA_PublicKey::_create_verification_op(
133 const PK_Signature_Options_Reader& options) const {
135
136 return std::make_unique<ECGDSA_Verification_Operation>(*this, options);
137}
138
139std::unique_ptr<PK_Ops::Verification> ECGDSA_PublicKey::create_x509_verification_op(
140 const AlgorithmIdentifier& signature_algorithm, std::string_view provider) const {
141 if(provider == "base" || provider.empty()) {
142 return std::make_unique<ECGDSA_Verification_Operation>(*this, signature_algorithm);
143 }
144
145 throw Provider_Not_Found(algo_name(), provider);
146}
147
148std::unique_ptr<PK_Ops::Signature> ECGDSA_PrivateKey::_create_signature_op(
149 RandomNumberGenerator& rng, const PK_Signature_Options_Reader& options) const {
150 BOTAN_UNUSED(rng);
152
153 return std::make_unique<ECGDSA_Signature_Operation>(*this, options);
154}
155
156} // namespace Botan
#define BOTAN_UNUSED
Definition assert.h:151
bool check_key(RandomNumberGenerator &rng, bool strong) const override
Definition ecgdsa.cpp:24
std::unique_ptr< PK_Ops::Signature > _create_signature_op(RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const override
Definition ecgdsa.cpp:148
std::unique_ptr< Public_Key > public_key() const override
Definition ecgdsa.cpp:20
std::string algo_name() const override
Definition ecgdsa.h:48
std::optional< size_t > _signature_element_size_for_DER_encoding() const override
Definition ecgdsa.cpp:124
std::unique_ptr< PK_Ops::Verification > create_x509_verification_op(const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override
Definition ecgdsa.cpp:139
std::unique_ptr< Private_Key > generate_another(RandomNumberGenerator &rng) const final
Definition ecgdsa.cpp:128
std::unique_ptr< PK_Ops::Verification > _create_verification_op(const PK_Signature_Options_Reader &options) const override
Definition ecgdsa.cpp:132
bool mul2_vartime_x_mod_order_eq(const EC_Scalar &v, const EC_Scalar &x, const EC_Scalar &y) const
Definition ec_group.cpp:987
bool check_key(RandomNumberGenerator &rng, bool strong) const override
Definition ecc_key.cpp:237
const EC_Group & domain() const
Definition ecc_key.cpp:76
const EC_AffinePoint & public_ec_point() const
Definition ecc_key.cpp:88
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &private_key, const Public_Key &public_key, std::string_view padding)
Definition keypair.cpp:49
void require_software_provider(const OptionsT &options, std::string_view algo_name)