5123321399

Committed 30 May 2023 04:06PM UTC coverage: 92.213% (+0.004%) from 92.209%

Build # 5123321399

Build Type

Pull #3558

github

Committed by

web-flow

Commit Message

Merge dd72f7389 into 057bcbc35

Pull Request Pull Request #3558: Add braces around all if/else statements

Run Details

75602 of 81986 relevant lines covered (92.21%)

11859779.3 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

}  // namespace Botan_CLI

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

randombit / botan / 5123321399

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