13591785182

Committed 28 Feb 2025 10:58AM UTC coverage: 91.694% (-0.004%) from 91.698%

Build # 13591785182

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #4724 from randombit/jack/dh-cleanups

Cleanups and deprecations for key agreement

Run Details

95851 of 104534 relevant lines covered (91.69%)

11322820.13 hits per line

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

95.77

/src/lib/pubkey/dh/dh.cpp

/*
* Diffie-Hellman
* (C) 1999-2007,2016,2019,2023 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include <botan/dh.h>

#include <botan/internal/blinding.h>
#include <botan/internal/dl_scheme.h>
#include <botan/internal/pk_ops_impl.h>

namespace Botan {

DH_PublicKey::DH_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_42);
}

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

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

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

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

const DL_Group& DH_PublicKey::group() const {
   return m_public_key->group();
}

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

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

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

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

std::unique_ptr<Private_Key> DH_PublicKey::generate_another(RandomNumberGenerator& rng) const {
   return std::make_unique<DH_PrivateKey>(rng, group());
}

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

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

DH_PrivateKey::DH_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_42);
   m_public_key = m_private_key->public_key();
}

std::unique_ptr<Public_Key> DH_PrivateKey::public_key() const {
   return std::unique_ptr<DH_PublicKey>(new DH_PublicKey(m_public_key));
}

std::vector<uint8_t> DH_PrivateKey::public_value() const {
   return raw_public_key_bits();
}

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

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

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

namespace {

/**
* DH operation
*/
class DH_KA_Operation final : public PK_Ops::Key_Agreement_with_KDF {
   public:
      DH_KA_Operation(const std::shared_ptr<const DL_PrivateKey>& key,
                      std::string_view kdf,
                      RandomNumberGenerator& rng) :
            PK_Ops::Key_Agreement_with_KDF(kdf),
            m_key(key),
            m_key_bits(m_key->private_key().bits()),
            m_blinder(
               m_key->group()._reducer_mod_p(),
               rng,
               [](const BigInt& k) { return k; },
               [this](const BigInt& k) { return powermod_x_p(group().inverse_mod_p(k)); }) {}

      size_t agreed_value_size() const override { return group().p_bytes(); }

      secure_vector<uint8_t> raw_agree(const uint8_t w[], size_t w_len) override;

   private:
      const DL_Group& group() const { return m_key->group(); }

      BigInt powermod_x_p(const BigInt& v) const { return group().power_b_p(v, m_key->private_key(), m_key_bits); }

      std::shared_ptr<const DL_PrivateKey> m_key;
      const size_t m_key_bits;
      Blinder m_blinder;
};

secure_vector<uint8_t> DH_KA_Operation::raw_agree(const uint8_t w[], size_t w_len) {
   BigInt v = BigInt::from_bytes(std::span{w, w_len});

   if(v <= 1 || v >= group().get_p()) {
      throw Invalid_Argument("DH agreement - invalid key provided");
   }

   v = m_blinder.blind(v);
   v = powermod_x_p(v);
   v = m_blinder.unblind(v);

   return v.serialize<secure_vector<uint8_t>>(group().p_bytes());
}

}  // namespace

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

}  // namespace Botan

1	/*
2	* Diffie-Hellman
3	* (C) 1999-2007,2016,2019,2023 Jack Lloyd
4	*
5	* Botan is released under the Simplified BSD License (see license.txt)
6	*/
7
8	#include <botan/dh.h>
9
10	#include <botan/internal/blinding.h>
11	#include <botan/internal/dl_scheme.h>
12	#include <botan/internal/pk_ops_impl.h>
13
14	namespace Botan {
15
16	DH_PublicKey::DH_PublicKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) {	8✔
17	m_public_key = std::make_shared<DL_PublicKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_42);	8✔
18	}	8✔
19
20	DH_PublicKey::DH_PublicKey(const DL_Group& group, const BigInt& y) {	61✔
21	m_public_key = std::make_shared<DL_PublicKey>(group, y);	61✔
22	}	61✔
23
24	size_t DH_PublicKey::estimated_strength() const {	15✔
25	return m_public_key->estimated_strength();	15✔
26	}
27
28	size_t DH_PublicKey::key_length() const {	22✔
29	return m_public_key->p_bits();	22✔
30	}
31
32	const BigInt& DH_PublicKey::get_int_field(std::string_view field) const {	6✔
33	return m_public_key->get_int_field(algo_name(), field);	6✔
34	}
35
36	const DL_Group& DH_PublicKey::group() const {	33✔
37	return m_public_key->group();	33✔
38	}
39
40	AlgorithmIdentifier DH_PublicKey::algorithm_identifier() const {	45✔
41	return AlgorithmIdentifier(object_identifier(), m_public_key->group().DER_encode(DL_Group_Format::ANSI_X9_42));	90✔
42	}
43
44	std::vector<uint8_t> DH_PublicKey::raw_public_key_bits() const {	352✔
45	return m_public_key->public_key_as_bytes();	352✔
46	}
47
48	std::vector<uint8_t> DH_PublicKey::public_key_bits() const {	7✔
49	return m_public_key->DER_encode();	7✔
50	}
51
52	bool DH_PublicKey::check_key(RandomNumberGenerator& rng, bool strong) const {	11✔
53	return m_public_key->check_key(rng, strong);	11✔
54	}
55
56	std::unique_ptr<Private_Key> DH_PublicKey::generate_another(RandomNumberGenerator& rng) const {	5✔
57	return std::make_unique<DH_PrivateKey>(rng, group());	10✔
58	}
59
60	DH_PrivateKey::DH_PrivateKey(RandomNumberGenerator& rng, const DL_Group& group) {	38✔
61	m_private_key = std::make_shared<DL_PrivateKey>(group, rng);	38✔
62	m_public_key = m_private_key->public_key();	38✔
63	}	38✔
64
65	DH_PrivateKey::DH_PrivateKey(const DL_Group& group, const BigInt& x) {	187✔
66	m_private_key = std::make_shared<DL_PrivateKey>(group, x);	187✔
67	m_public_key = m_private_key->public_key();	187✔
68	}	187✔
69
70	DH_PrivateKey::DH_PrivateKey(const AlgorithmIdentifier& alg_id, std::span<const uint8_t> key_bits) {	46✔
71	m_private_key = std::make_shared<DL_PrivateKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_42);	46✔
72	m_public_key = m_private_key->public_key();	33✔
73	}	46✔
74
75	std::unique_ptr<Public_Key> DH_PrivateKey::public_key() const {	17✔
76	return std::unique_ptr<DH_PublicKey>(new DH_PublicKey(m_public_key));	17✔
77	}
78
79	std::vector<uint8_t> DH_PrivateKey::public_value() const {	273✔
80	return raw_public_key_bits();	273✔
81	}
82
83	secure_vector<uint8_t> DH_PrivateKey::private_key_bits() const {	42✔
84	return m_private_key->DER_encode();	42✔
85	}
86
87	secure_vector<uint8_t> DH_PrivateKey::raw_private_key_bits() const {	×
88	return m_private_key->raw_private_key_bits();	×
89	}
90
91	const BigInt& DH_PrivateKey::get_int_field(std::string_view field) const {	13✔
92	return m_private_key->get_int_field(algo_name(), field);	13✔
93	}
94
95	namespace {
96
97	/**
98	* DH operation
99	*/
100	class DH_KA_Operation final : public PK_Ops::Key_Agreement_with_KDF {	×
101	public:
102	DH_KA_Operation(const std::shared_ptr<const DL_PrivateKey>& key,	228✔
103	std::string_view kdf,
104	RandomNumberGenerator& rng) :	228✔
105	PK_Ops::Key_Agreement_with_KDF(kdf),
106	m_key(key),	456✔
107	m_key_bits(m_key->private_key().bits()),	228✔
108	m_blinder(	456✔
109	m_key->group()._reducer_mod_p(),	228✔
110	rng,
111	[](const BigInt& k) { return k; },	228✔
112	[this](const BigInt& k) { return powermod_x_p(group().inverse_mod_p(k)); }) {}	912✔
113
114	size_t agreed_value_size() const override { return group().p_bytes(); }	134✔
115
116	secure_vector<uint8_t> raw_agree(const uint8_t w[], size_t w_len) override;
117
118	private:
119	const DL_Group& group() const { return m_key->group(); }	2,040✔
120
121	BigInt powermod_x_p(const BigInt& v) const { return group().power_b_p(v, m_key->private_key(), m_key_bits); }	228✔
122
123	std::shared_ptr<const DL_PrivateKey> m_key;
124	const size_t m_key_bits;
125	Blinder m_blinder;
126	};
127
128	secure_vector<uint8_t> DH_KA_Operation::raw_agree(const uint8_t w[], size_t w_len) {	1,746✔
129	BigInt v = BigInt::from_bytes(std::span{w, w_len});	1,746✔
130
131	if(v <= 1 \|\| v >= group().get_p()) {	1,746✔
132	throw Invalid_Argument("DH agreement - invalid key provided");	2✔
133	}
134
135	v = m_blinder.blind(v);	1,744✔
136	v = powermod_x_p(v);	1,744✔
137	v = m_blinder.unblind(v);	1,744✔
138
139	return v.serialize<secure_vector<uint8_t>>(group().p_bytes());	3,488✔
140	}	1,746✔
141
142	} // namespace
143
144	std::unique_ptr<PK_Ops::Key_Agreement> DH_PrivateKey::create_key_agreement_op(RandomNumberGenerator& rng,	348✔
145	std::string_view params,
146	std::string_view provider) const {
147	if(provider == "base" \|\| provider.empty()) {	388✔
148	return std::make_unique<DH_KA_Operation>(this->m_private_key, params, rng);	228✔
149	}
150	throw Provider_Not_Found(algo_name(), provider);	240✔
151	}
152
153	} // namespace Botan

randombit / botan / 13591785182

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