5079590438

Committed 25 May 2023 12:28PM UTC coverage: 92.228% (+0.5%) from 91.723%

Build # 5079590438

Build Type

Pull #3502

github

Pull Request Pull Request #3502: Apply clang-format to the codebase

Run Details

75589 of 81959 relevant lines covered (92.23%)

12139530.51 hits per line

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

88.39

/src/cli/zfec.cpp

/*
* (C) 2021 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include "cli.h"

#if defined(BOTAN_HAS_ZFEC) && defined(BOTAN_HAS_SHA2_64)
   #include <botan/hash.h>
   #include <botan/zfec.h>
   #include <botan/internal/loadstor.h>
   #include <fstream>
   #include <sstream>
#endif

namespace Botan_CLI {

#if defined(BOTAN_HAS_ZFEC) && defined(BOTAN_HAS_SHA2_64)

static const uint32_t FEC_MAGIC = 0xFECC0DEC;
const char* const FEC_SHARE_HASH = "SHA-512-256";

class FEC_Share final {
   public:
      FEC_Share() : m_share(0), m_k(0), m_n(0), m_padding(0), m_bits() {}

      FEC_Share(size_t share, size_t k, size_t n, size_t padding, const uint8_t bits[], size_t len) :
            m_share(share), m_k(k), m_n(n), m_padding(padding), m_bits(bits, bits + len) {}

      size_t share_id() const { return m_share; }

      size_t k() const { return m_k; }

      size_t n() const { return m_n; }

      size_t padding() const { return m_padding; }

      size_t share_size() const { return m_bits.size(); }

      const uint8_t* share_data() const { return m_bits.data(); }

      static FEC_Share deserialize(const uint8_t bits[], size_t len, Botan::HashFunction& hash) {
         const size_t hash_len = hash.output_length();

         if(len < FEC_SHARE_HEADER_LEN + hash_len)
            throw CLI_Error("FEC share is too short to be valid");

         if(Botan::load_be<uint32_t>(bits, 0) != FEC_MAGIC)
            throw CLI_Error("FEC share does not have expected magic bytes");

         // verify that reserved bytes are zero
         for(size_t i = 8; i != 12; ++i) {
            if(bits[i] != 0)
               throw CLI_Error("FEC share has reserved header bytes set");
         }

         size_t share_id = bits[4];
         size_t k = bits[5];
         size_t n = bits[6];
         size_t padding = bits[7];

         if(share_id >= n || k >= n || padding >= k)
            throw CLI_Error("FEC share has invalid k/n/padding fields");

         hash.update(bits, len - hash_len);
         auto share_hash = hash.final();

         const bool digest_ok = Botan::same_mem(share_hash.data(), &bits[len - hash_len], hash_len);

         if(!digest_ok)
            throw CLI_Error("FEC share has invalid hash");

         return FEC_Share(
            share_id, k, n, padding, bits + FEC_SHARE_HEADER_LEN, len - (FEC_SHARE_HEADER_LEN + hash_len));
      }

      void serialize_to(Botan::HashFunction& hash, std::ostream& out) const {
         uint8_t header[FEC_SHARE_HEADER_LEN] = {0};

         Botan::store_be(FEC_MAGIC, header);
         header[4] = static_cast<uint8_t>(m_share);
         header[5] = static_cast<uint8_t>(m_k);
         header[6] = static_cast<uint8_t>(m_n);
         header[7] = static_cast<uint8_t>(m_padding);
         // bytes 8..12 left as zero/reserved

         out.write(reinterpret_cast<const char*>(header), sizeof(header));
         out.write(reinterpret_cast<const char*>(m_bits.data()), m_bits.size());

         hash.update(header, sizeof(header));
         hash.update(m_bits);
         auto digest = hash.final();

         out.write(reinterpret_cast<const char*>(digest.data()), digest.size());
      }

   private:
      static const size_t FEC_SHARE_HEADER_LEN = 12;

      size_t m_share;
      size_t m_k;
      size_t m_n;
      size_t m_padding;
      std::vector<uint8_t> m_bits;
};

class FEC_Encode final : public Command {
   public:
      FEC_Encode() : Command("fec_encode --suffix=fec --prefix= --output-dir= k n input") {}

      std::string group() const override { return "fec"; }

      std::string description() const override { return "Forward error encode a file"; }

      void go() override {
         const size_t k = get_arg_sz("k");
         const size_t n = get_arg_sz("n");

         const std::string suffix = get_arg("suffix");
         const std::string prefix = get_arg("prefix");
         const std::string input = get_arg("input");
         const std::string output_dir = get_arg("output-dir");

         Botan::ZFEC fec(k, n);  // checks k/n for validity

         auto hash = Botan::HashFunction::create_or_throw(FEC_SHARE_HASH);

         auto input_data = slurp_file(get_arg("input"));

         // append a hash of the input
         hash->update(input_data);
         const auto hash_of_input = hash->final();
         input_data.insert(input_data.end(), hash_of_input.begin(), hash_of_input.end());

         // add padding 0x00 bytes as needed to round up to k multiple
         size_t padding = 0;
         while(input_data.size() % k != 0) {
            padding += 1;
            input_data.push_back(0x00);
         }

         auto encoder_fn = [&](size_t share, const uint8_t bits[], size_t len) {
            std::ostringstream output_fsname;

            if(!output_dir.empty())
               output_fsname << output_dir << "/";

            if(!prefix.empty())
               output_fsname << prefix;
            else
               output_fsname << input;

            output_fsname << "." << (share + 1) << "_" << n;

            if(!suffix.empty())
               output_fsname << "." << suffix;

            std::ofstream output(output_fsname.str(), std::ios::binary);

            FEC_Share fec_share(share, k, n, padding, bits, len);
            fec_share.serialize_to(*hash, output);
         };

         fec.encode(input_data.data(), input_data.size(), encoder_fn);
      }
};

BOTAN_REGISTER_COMMAND("fec_encode", FEC_Encode);

class FEC_Decode final : public Command {
   public:
      FEC_Decode() : Command("fec_decode *shares") {}

      std::string group() const override { return "fec"; }

      std::string description() const override { return "Recover data from FEC shares"; }

      void go() override {
         auto hash = Botan::HashFunction::create_or_throw(FEC_SHARE_HASH);
         const size_t hash_len = hash->output_length();

         std::vector<FEC_Share> shares;

         for(const auto& share_fsname : get_arg_list("shares")) {
            const auto share_bits = slurp_file(share_fsname);

            try {
               auto share = FEC_Share::deserialize(share_bits.data(), share_bits.size(), *hash);
               shares.push_back(share);
            } catch(std::exception& e) {
               error_output() << "Ignoring invalid share '" << share_fsname << "': " << e.what() << "\n";
            }
         }

         if(shares.empty()) {
            error_output() << "Must provide a list of at least k shares\n";
            this->set_return_code(1);
            return;
         }

         size_t k = 0;
         size_t n = 0;
         size_t padding = 0;
         size_t share_size = 0;

         for(const auto& share : shares) {
            if(k == 0 && n == 0 && padding == 0) {
               k = share.k();
               n = share.n();
               padding = share.padding();
               share_size = share.share_size();
            } else {
               if(share.k() != k || share.n() != n || share.padding() != padding || share.share_size() != share_size) {
                  error_output() << "Shares have mismatched k/n/padding/size values\n";
                  this->set_return_code(2);
                  return;
               }
            }
         }

         if(shares.size() < k) {
            error_output() << "At least " << k << " shares are required for recovery\n";
            this->set_return_code(2);
            return;
         }

         Botan::ZFEC fec(k, n);

         std::vector<uint8_t> decoded(share_size * k);

         auto decoder_fn = [&](size_t share, const uint8_t bits[], size_t len) {
            std::memcpy(&decoded[share * share_size], bits, len);
         };

         std::map<size_t, const uint8_t*> share_ptrs;

         for(auto& share : shares)
            share_ptrs[share.share_id()] = share.share_data();

         fec.decode_shares(share_ptrs, share_size, decoder_fn);

         auto decoded_digest = hash->process(decoded.data(), decoded.size() - (hash_len + padding));

         if(!Botan::same_mem(decoded_digest.data(), &decoded[decoded.size() - (hash_len + padding)], hash_len))
            throw CLI_Error("Recovered data failed digest check");

         for(size_t i = 0; i != padding; ++i)
            if(decoded[decoded.size() - padding + i] != 0)
               throw CLI_Error("Recovered data had non-zero padding bytes");

         output().write(reinterpret_cast<const char*>(decoded.data()), decoded.size() - (hash_len + padding));
      }
};

BOTAN_REGISTER_COMMAND("fec_decode", FEC_Decode);

class FEC_Info final : public Command {
   public:
      FEC_Info() : Command("fec_info share") {}

      std::string group() const override { return "fec"; }

      std::string description() const override { return "Display information about a FEC share"; }

      void go() override {
         auto hash = Botan::HashFunction::create_or_throw(FEC_SHARE_HASH);

         const std::string share_fsname = get_arg("share");
         const auto share_bits = slurp_file(share_fsname);

         try {
            auto share = FEC_Share::deserialize(share_bits.data(), share_bits.size(), *hash);
            output() << "FEC share " << share.share_id() + 1 << "/" << share.n() << " with " << share.k()
                     << " needed for recovery\n";
         } catch(std::exception& e) {
            error_output() << "Invalid share '" << share_fsname << "': " << e.what() << "\n";
         }
      }
};

BOTAN_REGISTER_COMMAND("fec_info", FEC_Info);

#endif

}

1	/*
2	* (C) 2021 Jack Lloyd
3	*
4	* Botan is released under the Simplified BSD License (see license.txt)
5	*/
6
7	#include "cli.h"
8
9	#if defined(BOTAN_HAS_ZFEC) && defined(BOTAN_HAS_SHA2_64)
10	#include <botan/hash.h>
11	#include <botan/zfec.h>
12	#include <botan/internal/loadstor.h>
13	#include <fstream>
14	#include <sstream>
15	#endif
16
17	namespace Botan_CLI {
18
19	#if defined(BOTAN_HAS_ZFEC) && defined(BOTAN_HAS_SHA2_64)
20
21	static const uint32_t FEC_MAGIC = 0xFECC0DEC;
22	const char* const FEC_SHARE_HASH = "SHA-512-256";
23
24	class FEC_Share final {	34✔
25	public:
26	FEC_Share() : m_share(0), m_k(0), m_n(0), m_padding(0), m_bits() {}
27
28	FEC_Share(size_t share, size_t k, size_t n, size_t padding, const uint8_t bits[], size_t len) :	15✔
29	m_share(share), m_k(k), m_n(n), m_padding(padding), m_bits(bits, bits + len) {}	30✔
30
31	size_t share_id() const { return m_share; }	3✔
32
33	size_t k() const { return m_k; }	10✔
34
35	size_t n() const { return m_n; }	10✔
36
37	size_t padding() const { return m_padding; }	5✔
38
39	size_t share_size() const { return m_bits.size(); }	3✔
40
41	const uint8_t* share_data() const { return m_bits.data(); }	3✔
42
43	static FEC_Share deserialize(const uint8_t bits[], size_t len, Botan::HashFunction& hash) {	10✔
44	const size_t hash_len = hash.output_length();	10✔
45
46	if(len < FEC_SHARE_HEADER_LEN + hash_len)	10✔
47	throw CLI_Error("FEC share is too short to be valid");	×
48
49	if(Botan::load_be<uint32_t>(bits, 0) != FEC_MAGIC)	10✔
50	throw CLI_Error("FEC share does not have expected magic bytes");	×
51
52	// verify that reserved bytes are zero
53	for(size_t i = 8; i != 12; ++i) {	50✔
54	if(bits[i] != 0)	40✔
55	throw CLI_Error("FEC share has reserved header bytes set");	×
56	}
57
58	size_t share_id = bits[4];	10✔
59	size_t k = bits[5];	10✔
60	size_t n = bits[6];	10✔
61	size_t padding = bits[7];	10✔
62
63	if(share_id >= n \|\| k >= n \|\| padding >= k)	10✔
64	throw CLI_Error("FEC share has invalid k/n/padding fields");	×
65
66	hash.update(bits, len - hash_len);	10✔
67	auto share_hash = hash.final();	10✔
68
69	const bool digest_ok = Botan::same_mem(share_hash.data(), &bits[len - hash_len], hash_len);	10✔
70
71	if(!digest_ok)	10✔
72	throw CLI_Error("FEC share has invalid hash");	×
73
74	return FEC_Share(	10✔
75	share_id, k, n, padding, bits + FEC_SHARE_HEADER_LEN, len - (FEC_SHARE_HEADER_LEN + hash_len));	10✔
76	}	10✔
77
78	void serialize_to(Botan::HashFunction& hash, std::ostream& out) const {	5✔
79	uint8_t header[FEC_SHARE_HEADER_LEN] = {0};	5✔
80
81	Botan::store_be(FEC_MAGIC, header);	5✔
82	header[4] = static_cast<uint8_t>(m_share);	5✔
83	header[5] = static_cast<uint8_t>(m_k);	5✔
84	header[6] = static_cast<uint8_t>(m_n);	5✔
85	header[7] = static_cast<uint8_t>(m_padding);	5✔
86	// bytes 8..12 left as zero/reserved
87
88	out.write(reinterpret_cast<const char*>(header), sizeof(header));	5✔
89	out.write(reinterpret_cast<const char*>(m_bits.data()), m_bits.size());	5✔
90
91	hash.update(header, sizeof(header));	5✔
92	hash.update(m_bits);	5✔
93	auto digest = hash.final();	5✔
94
95	out.write(reinterpret_cast<const char*>(digest.data()), digest.size());	5✔
96	}	5✔
97
98	private:
99	static const size_t FEC_SHARE_HEADER_LEN = 12;
100
101	size_t m_share;
102	size_t m_k;
103	size_t m_n;
104	size_t m_padding;
105	std::vector<uint8_t> m_bits;
106	};
107
108	class FEC_Encode final : public Command {
109	public:
110	FEC_Encode() : Command("fec_encode --suffix=fec --prefix= --output-dir= k n input") {}	4✔
111
112	std::string group() const override { return "fec"; }	1✔
113
114	std::string description() const override { return "Forward error encode a file"; }	1✔
115
116	void go() override {	1✔
117	const size_t k = get_arg_sz("k");	1✔
118	const size_t n = get_arg_sz("n");	1✔
119
120	const std::string suffix = get_arg("suffix");	1✔
121	const std::string prefix = get_arg("prefix");	1✔
122	const std::string input = get_arg("input");	1✔
123	const std::string output_dir = get_arg("output-dir");	1✔
124
125	Botan::ZFEC fec(k, n); // checks k/n for validity	1✔
126
127	auto hash = Botan::HashFunction::create_or_throw(FEC_SHARE_HASH);	1✔
128
129	auto input_data = slurp_file(get_arg("input"));	2✔
130
131	// append a hash of the input
132	hash->update(input_data);	1✔
133	const auto hash_of_input = hash->final();	1✔
134	input_data.insert(input_data.end(), hash_of_input.begin(), hash_of_input.end());	1✔
135
136	// add padding 0x00 bytes as needed to round up to k multiple
137	size_t padding = 0;	1✔
138	while(input_data.size() % k != 0) {	2✔
139	padding += 1;	1✔
140	input_data.push_back(0x00);	1✔
141	}
142
143	auto encoder_fn = [&](size_t share, const uint8_t bits[], size_t len) {	6✔
144	std::ostringstream output_fsname;	5✔
145
146	if(!output_dir.empty())	5✔
147	output_fsname << output_dir << "/";	5✔
148
149	if(!prefix.empty())	5✔
150	output_fsname << prefix;	5✔
151	else
152	output_fsname << input;	×
153
154	output_fsname << "." << (share + 1) << "_" << n;	5✔
155
156	if(!suffix.empty())	5✔
157	output_fsname << "." << suffix;	5✔
158
159	std::ofstream output(output_fsname.str(), std::ios::binary);	5✔
160
161	FEC_Share fec_share(share, k, n, padding, bits, len);	5✔
162	fec_share.serialize_to(*hash, output);	5✔
163	};	5✔
164
165	fec.encode(input_data.data(), input_data.size(), encoder_fn);	2✔
166	}	6✔
167	};
168
169	BOTAN_REGISTER_COMMAND("fec_encode", FEC_Encode);	2✔
170
171	class FEC_Decode final : public Command {
172	public:
173	FEC_Decode() : Command("fec_decode *shares") {}	6✔
174
175	std::string group() const override { return "fec"; }	1✔
176
177	std::string description() const override { return "Recover data from FEC shares"; }	1✔
178
179	void go() override {	2✔
180	auto hash = Botan::HashFunction::create_or_throw(FEC_SHARE_HASH);	2✔
181	const size_t hash_len = hash->output_length();	2✔
182
183	std::vector<FEC_Share> shares;	2✔
184
185	for(const auto& share_fsname : get_arg_list("shares")) {	7✔
186	const auto share_bits = slurp_file(share_fsname);	5✔
187
188	try {	5✔
189	auto share = FEC_Share::deserialize(share_bits.data(), share_bits.size(), *hash);	5✔
190	shares.push_back(share);	5✔
191	} catch(std::exception& e) {	5✔
192	error_output() << "Ignoring invalid share '" << share_fsname << "': " << e.what() << "\n";	×
193	}	×
194	}	7✔
195
196	if(shares.empty()) {	2✔
197	error_output() << "Must provide a list of at least k shares\n";	×
198	this->set_return_code(1);	×
199	return;	×
200	}
201
202	size_t k = 0;	2✔
203	size_t n = 0;	2✔
204	size_t padding = 0;	2✔
205	size_t share_size = 0;	2✔
206
207	for(const auto& share : shares) {	7✔
208	if(k == 0 && n == 0 && padding == 0) {	5✔
209	k = share.k();	2✔
210	n = share.n();	2✔
211	padding = share.padding();	2✔
212	share_size = share.share_size();	2✔
213	} else {
214	if(share.k() != k \|\| share.n() != n \|\| share.padding() != padding \|\| share.share_size() != share_size) {	3✔
215	error_output() << "Shares have mismatched k/n/padding/size values\n";	×
216	this->set_return_code(2);	×
217	return;	×
218	}
219	}
220	}
221
222	if(shares.size() < k) {	2✔
223	error_output() << "At least " << k << " shares are required for recovery\n";	1✔
224	this->set_return_code(2);	1✔
225	return;	1✔
226	}
227
228	Botan::ZFEC fec(k, n);	1✔
229
230	std::vector<uint8_t> decoded(share_size * k);	1✔
231
232	auto decoder_fn = [&](size_t share, const uint8_t bits[], size_t len) {	4✔
233	std::memcpy(&decoded[share * share_size], bits, len);	3✔
234	};	1✔
235
236	std::map<size_t, const uint8_t*> share_ptrs;	1✔
237
238	for(auto& share : shares)	4✔
239	share_ptrs[share.share_id()] = share.share_data();	3✔
240
241	fec.decode_shares(share_ptrs, share_size, decoder_fn);	1✔
242
243	auto decoded_digest = hash->process(decoded.data(), decoded.size() - (hash_len + padding));	1✔
244
245	if(!Botan::same_mem(decoded_digest.data(), &decoded[decoded.size() - (hash_len + padding)], hash_len))	2✔
246	throw CLI_Error("Recovered data failed digest check");	×
247
248	for(size_t i = 0; i != padding; ++i)	2✔
249	if(decoded[decoded.size() - padding + i] != 0)	1✔
250	throw CLI_Error("Recovered data had non-zero padding bytes");	×
251
252	output().write(reinterpret_cast<const char*>(decoded.data()), decoded.size() - (hash_len + padding));	1✔
253	}	6✔
254	};
255
256	BOTAN_REGISTER_COMMAND("fec_decode", FEC_Decode);	3✔
257
258	class FEC_Info final : public Command {
259	public:
260	FEC_Info() : Command("fec_info share") {}	12✔
261
262	std::string group() const override { return "fec"; }	1✔
263
264	std::string description() const override { return "Display information about a FEC share"; }	1✔
265
266	void go() override {	5✔
267	auto hash = Botan::HashFunction::create_or_throw(FEC_SHARE_HASH);	5✔
268
269	const std::string share_fsname = get_arg("share");	5✔
270	const auto share_bits = slurp_file(share_fsname);	5✔
271
272	try {	5✔
273	auto share = FEC_Share::deserialize(share_bits.data(), share_bits.size(), *hash);	5✔
274	output() << "FEC share " << share.share_id() + 1 << "/" << share.n() << " with " << share.k()	5✔
275	<< " needed for recovery\n";	5✔
276	} catch(std::exception& e) {	5✔
277	error_output() << "Invalid share '" << share_fsname << "': " << e.what() << "\n";	×
278	}	×
279	}	15✔
280	};
281
282	BOTAN_REGISTER_COMMAND("fec_info", FEC_Info);	6✔
283
284	#endif
285
286	}

randombit / botan / 5079590438

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