randombit / botan / 21768358452

coverage: 90.064% (-0.003%) from 90.067%
21768358452

Pull #5289

github

web-flow 
Merge f589db195 into 8ea0ca252
Pull Request #5289: Further misc header reductions, forward declarations, etc

102238 of 113517 relevant lines covered (90.06%)

11357432.36 hits per line

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

99.89
/src/tests/test_utils_bitvector.cpp
1 
/*
2 
 * (C) 2023-2024 Jack Lloyd
3 
 * (C) 2023-2024 René Meusel, Rohde & Schwarz Cybersecurity
4 
 *
5 
 * Botan is released under the Simplified BSD License (see license.txt)
6 
 */
7 









8



#include "tests.h"










9












10



#if defined(BOTAN_HAS_BITVECTOR)










11



   #include <botan/hex.h>










12



   #include <botan/rng.h>










13



   #include <botan/internal/bitvector.h>










14



   #include <botan/internal/fmt.h>










15



   #include <algorithm>










16



   #include <numeric>










17



   #include <set>










18



#endif










19












20



namespace Botan_Tests {










21












22



#if defined(BOTAN_HAS_BITVECTOR)










23












24



namespace {










25












26



/// Returns a random number in the range [min, max)










27



size_t rand_in_range(Botan::RandomNumberGenerator& rng, size_t min, size_t max) {




135✔





28



   if(min == max) {




135✔





29



      return min;










30



   }










31












32



   const size_t val = Botan::load_le<size_t>(rng.random_array<sizeof(size_t)>());




135✔





33



   return min + (val % (max - min));




135✔





34



}










35












36



/// Returns @p n integers smaller than @p upper_bound in random order










37



std::vector<size_t> rand_indices(Botan::RandomNumberGenerator& rng, size_t n, size_t upper_bound) {




3✔





38



   auto shuffle = [&](std::vector<size_t>& v) {




6✔





39



      // Fisher-Yates shuffle










40



      if(v.size() < 2) {




3✔





41



         return;










42



      }










43



      for(size_t i = 0; i < v.size() - 1; ++i) {




132✔





44



         auto j = rand_in_range(rng, i, v.size());




129✔





45



         std::swap(v[i], v[j]);




129✔





46



      }










47



   };




3✔





48












49



   std::vector<size_t> indices(upper_bound);




3✔





50



   std::iota(indices.begin(), indices.end(), 0);




3✔





51



   shuffle(indices);




3✔





52



   indices.resize(n);




3✔





53



   return indices;




3✔





54



}




×







55












56



/// Create an empty bitvector of random size and chose a random number of points of interests










57



std::pair<Botan::bitvector, std::set<size_t>> rnd_bitvector_with_rnd_pois(Botan::RandomNumberGenerator& rng) {




3✔





58



   const Botan::bitvector bv(rand_in_range(rng, 0, 65));




3✔





59



   const size_t no_poi = rand_in_range(rng, 0, bv.size());




3✔





60



   auto points_of_interest = rand_indices(rng, no_poi, bv.size());




3✔





61












62



   return {bv, {points_of_interest.begin(), points_of_interest.end()}};




6✔





63



}




6✔





64












65



template <size_t mod>










66



auto pattern_generator(size_t offset = 0) {




79✔





67



   return [i = offset]() mutable -> bool {




5,209✔





68



      const bool result = (i % mod) != 0;




5,209✔





69



      ++i;




5,209✔





70



      return result;










71



   };










72



}










73












74



std::vector<Test::Result> test_bitvector_bitwise_accessors(Botan::RandomNumberGenerator& rng) {




1✔





75



   return {




1✔





76



      CHECK("default constructed bitvector",










77



            [](auto& result) {




1✔





78



               const Botan::bitvector bv;




1✔





79



               result.confirm("default constructed bitvector is empty", bv.empty());




2✔





80



               result.test_eq("default constructed bitvector has zero size", bv.size(), size_t(0));




2✔





81



            }),




1✔





82












83



      CHECK("preallocated construction of bitvector",










84



            [](auto& result) {




1✔





85



               Botan::bitvector bv(10);




1✔





86



               result.confirm("allocated bitvector is not empty", !bv.empty());




2✔





87



               result.test_eq("allocated bitvector has allocated size", bv.size(), size_t(10));




1✔





88



               for(size_t i = 0; i < 10; ++i) {




11✔





89



                  result.confirm("bit not set yet", !bv.at(i));




20✔





90



               }










91



            }),




1✔





92












93



      CHECK("setting bits",










94



            [&](auto& result) {




1✔





95



               auto [bv, ones] = rnd_bitvector_with_rnd_pois(rng);




1✔





96












97



               for(const size_t i : ones) {




7✔





98



                  if(rng.next_byte() % 2 == 0) {




6✔





99



                     bv.set(i);




4✔





100



                  } else {










101



                     bv.at(i) = true;




2✔





102



                  }










103



               }










104



               for(size_t i = 0; i < bv.size(); ++i) {




48✔





105



                  result.confirm(Botan::fmt("bit {} in expected state", i), bv.at(i) == ones.contains(i));




141✔





106



               }










107



            }),




1✔





108












109



      CHECK("unsetting bits",










110



            [&](auto& result) {




1✔





111



               auto [bv, zeros] = rnd_bitvector_with_rnd_pois(rng);




1✔





112



               for(auto b : bv) {




47✔





113



                  b.set();




45✔





114



               }










115












116



               for(const size_t i : zeros) {




30✔





117



                  if(rng.next_byte() % 2 == 0) {




29✔





118



                     bv.unset(i);




17✔





119



                  } else {










120



                     bv.at(i) = false;




12✔





121



                  }










122



               }










123



               for(size_t i = 0; i < bv.size(); ++i) {




46✔





124



                  result.confirm(Botan::fmt("bit {} in expected state", i), bv.at(i) == !zeros.contains(i));




135✔





125



               }










126



            }),




1✔





127












128



      CHECK("flipping bits",










129



            [&](auto& result) {




1✔





130



               auto [bv, ones] = rnd_bitvector_with_rnd_pois(rng);




1✔





131












132



               for(size_t i = 0; i < bv.size(); ++i) {




41✔





133



                  if(std::find(ones.begin(), ones.end(), i) == ones.end()) {




80✔





134



                     bv.set(i);




9✔





135



                  }










136



                  bv.flip(i);




40✔





137



               }










138



               for(size_t i = 0; i < bv.size(); ++i) {




41✔





139



                  result.confirm(Botan::fmt("bit {} in expected state", i), bv.at(i) == ones.contains(i));




120✔





140



               }










141



            }),




1✔





142












143



      CHECK("accessors validate offsets",










144



            [](auto& result) {




1✔





145



               Botan::bitvector bv(10);




1✔





146



               result.template test_throws<Botan::Invalid_Argument>(




2✔





147



                  ".at() const out of range", [&] { const_cast<const decltype(bv)&>(bv).at(10); });




2✔





148



               result.template test_throws<Botan::Invalid_Argument>(".at() out of range", [&] { bv.at(10); });




3✔





149



               result.template test_throws<Botan::Invalid_Argument>(".set() out of range", [&] { bv.set(10); });




3✔





150



               result.template test_throws<Botan::Invalid_Argument>(".unset() out of range", [&] { bv.unset(10); });




3✔





151



               result.template test_throws<Botan::Invalid_Argument>(".flip() out of range", [&] { bv.flip(10); });




4✔





152



            }),




1✔





153












154



      CHECK("multiblock handling",










155



            [](auto& result) {




1✔





156



               Botan::bitvector bv(128);




1✔





157



               result.test_eq("has more than 64 bits", bv.size(), 128);




2✔





158



               bv.set(1).set(63).set(64).set(127);




1✔





159



               for(size_t i = 0; i < bv.size(); ++i) {




129✔





160



                  const bool expected = (i == 1 || i == 63 || i == 64 || i == 127);




128✔





161



                  result.test_eq(Botan::fmt("bit {} in expected state", i), bv.at(i), expected);




256✔





162



               }










163



            }),




1✔





164












165



      CHECK("subscript operator",










166



            [](auto& result) {




1✔





167



               Botan::bitvector bv(128);




1✔





168



               bv[0].set();




1✔





169



               bv[1] = true;




1✔





170



               bv[2].flip();




1✔





171



               bv[64] = true;




1✔





172



               bv[80] = true;




1✔





173



               result.confirm("bit 0", bv[0]);




2✔





174



               result.confirm("bit 1", bv[1]);




2✔





175



               result.confirm("bit 2", bv[2]);




2✔





176



               result.confirm("bit 3", !bv[3]);




2✔





177



               result.confirm("bit 64", bv[64]);




2✔





178



               result.confirm("bit 80", bv[80]);




2✔





179



            }),




1✔





180












181



      CHECK("subscript operator does not validate offsets",










182



            [](auto& result) {




1✔





183



               Botan::bitvector bv(10);




1✔





184



               result.template test_throws<Botan::Invalid_Argument>(".at() out of range", [&] { bv.at(10); });




2✔





185



               // Technically the next line is undefined behaviour.










186



               // Though, the current implementation detail won't










187



               // cause issues, which might change!










188



               result.test_no_throw("subscript out of range", [&] { bv[10]; });




3✔





189



            }),




1✔





190












191



      CHECK("bitwise assignment modifiers",










192



            [](auto& result) {




1✔





193



               Botan::bitvector bv(4);




1✔





194












195



               result.require("precondition", !bv[0] && !bv[1]);




2✔





196



               bv[0] &= 1;  // NOLINT(*-use-bool-literals)




1✔





197



               result.confirm("bv[0] still 0", !bv[0]);




2✔





198



               bv[0].set();




1✔





199



               bv[0] &= 1;  // NOLINT(*-use-bool-literals)




1✔





200



               result.confirm("bv[0] still 1", bv[0]);




2✔





201



               bv[0] &= false;




1✔





202



               result.confirm("bv[0] now 0 again", !bv[0]);




2✔





203



               bv[0] &= !bv[1];




1✔





204



               result.confirm("bv[0] still 0 once more", !bv[0]);




2✔





205












206



               result.require("precondition 2", !bv[1] && !bv[2]);




2✔





207



               bv[1] |= 1;  // NOLINT(modernize-use-bool-literals)




1✔





208



               result.confirm("bv[1] is now 1", bv[1]);




2✔





209



               bv[1] |= 0;  // NOLINT(modernize-use-bool-literals)




1✔





210



               result.confirm("bv[1] is still 1", bv[1]);




2✔





211



               bv[1].unset();




1✔





212



               bv[1] |= false;




1✔





213



               result.confirm("bv[1] is 0", !bv[1]);




2✔





214



               bv[1] |= !bv[2];




1✔





215



               result.confirm("bv[1] is 1 again", bv[1]);




2✔





216












217



               result.require("precondition 3", !bv[2] && !bv[3]);




2✔





218



               bv[2] ^= 0;  // NOLINT(modernize-use-bool-literals)




1✔





219



               result.confirm("bv[2] is still 0", !bv[2]);




2✔





220



               bv[2] ^= true;




1✔





221



               result.confirm("bv[2] is now 1", bv[2]);




2✔





222



               bv[2] ^= !bv[3];




1✔





223



               result.confirm("bv[2] is 0 again", !bv[2]);




2✔





224



            }),




1✔





225



   };




11✔





226



}




1✔





227












228



std::vector<Test::Result> test_bitvector_capacity(Botan::RandomNumberGenerator& /*rng*/) {




1✔





229



   return {




1✔





230



      CHECK("default constructed bitvector",










231



            [](auto& result) {




1✔





232



               const Botan::bitvector bv;




1✔





233



               result.confirm("empty", bv.empty());




2✔





234



               result.test_eq("no size", bv.size(), size_t(0));




2✔





235



               result.test_eq("no capacity", bv.capacity(), size_t(0));




2✔





236



            }),




1✔





237












238



      CHECK("allocated bitvector has capacity",










239



            [](auto& result) {




1✔





240



               const Botan::bitvector bv(1);




1✔





241



               result.confirm("empty", !bv.empty());




2✔





242



               result.test_eq("small size", bv.size(), size_t(1));




2✔





243



               result.test_gte("a little capacity", bv.capacity(), size_t(8));




2✔





244



            }),




1✔





245












246



      CHECK("reserved bitvector has capacity",










247



            [](auto& result) {




1✔





248



               Botan::bitvector bv;




1✔





249



               result.test_eq("no size", bv.size(), size_t(0));




2✔





250



               result.test_eq("no capacity", bv.capacity(), size_t(0));




2✔





251












252



               bv.reserve(64);




1✔





253



               result.test_eq("no size", bv.size(), size_t(0));




2✔





254



               result.test_gte("no capacity", bv.capacity(), size_t(64));




2✔





255












256



               bv.reserve(128);




1✔





257



               result.test_eq("no size", bv.size(), size_t(0));




2✔





258



               result.test_gte("no capacity", bv.capacity(), size_t(128));




2✔





259



            }),




1✔





260












261



      CHECK("push_back() extends bitvector",










262



            [](Test::Result& result) {




1✔





263



               Botan::bitvector bv;




1✔





264



               result.confirm("empty", bv.empty());




2✔





265



               result.test_eq("no size", bv.size(), size_t(0));




1✔





266












267



               bv.push_back(true);




1✔





268



               bv.push_back(false);




1✔





269



               bv.push_back(true);




1✔





270



               bv.push_back(false);




1✔





271












272



               result.confirm("not empty", !bv.empty());




2✔





273



               result.test_eq("some size", bv.size(), size_t(4));




1✔





274



               result.test_gte("capacity is typically bigger than size", bv.capacity(), size_t(8));




1✔





275












276



               result.confirm("bit 0", bv.at(0));




2✔





277



               result.confirm("bit 1", !bv.at(1));




2✔





278



               result.confirm("bit 2", bv.at(2));




2✔





279



               result.confirm("bit 3", !bv.at(3));




2✔





280












281



               result.test_throws("bit 4 is not yet allocated", [&] { bv.at(4); });




4✔





282



            }),




1✔





283












284



      CHECK("pop_back() shortens bitvector",










285



            [](Test::Result& result) {




1✔





286



               Botan::bitvector bv;




1✔





287



               bv.push_back(true);




1✔





288



               bv.push_back(false);




1✔





289



               bv.push_back(true);




1✔





290



               bv.push_back(false);




1✔





291



               result.confirm("last is false", !bv.back());




2✔





292












293



               bv.pop_back();




1✔





294



               result.test_eq("size() == 3", bv.size(), 3);




1✔





295



               result.confirm("last is true", bv.back());




2✔





296












297



               bv.pop_back();




1✔





298



               result.test_eq("size() == 2", bv.size(), 2);




1✔





299



               result.confirm("last is false", !bv.back());




2✔





300












301



               bv.pop_back();




1✔





302



               result.test_eq("size() == 1", bv.size(), 1);




1✔





303



               result.confirm("last is true", bv.back());




2✔





304



               result.confirm("first is true", bv.front());




2✔





305












306



               bv.pop_back();




1✔





307



               result.confirm("empty", bv.empty());




2✔





308












309



               result.test_throws("bit 4 is not yet allocated", [&] { bv.at(4); });




4✔





310



            }),




1✔





311












312



      CHECK("resize()",










313



            [](auto& result) {




1✔





314



               Botan::bitvector bv(10);




1✔





315



               bv[0] = true;




1✔





316



               bv[5] = true;




1✔





317



               bv[9] = true;




1✔





318












319



               bv.resize(8);




1✔





320



               result.test_eq("size is reduced", bv.size(), size_t(8));




1✔





321












322



               for(size_t i = 0; i < bv.size(); ++i) {




9✔





323



                  const bool expected = (i == 0 || i == 5);




8✔





324



                  result.test_eq(Botan::fmt("{} is as expected", i), bv[i], expected);




16✔





325



               }










326












327



               bv.resize(0);




1✔





328



               result.confirm("resize(0) empties buffer", bv.empty());




2✔





329












330



               bv.resize(8);




1✔





331



               result.confirm("0 is false", !bv[0]);




2✔





332



               result.confirm("5 is false", !bv[5]);




2✔





333



            }),




1✔





334



   };




7✔





335



}




1✔





336












337



std::vector<Test::Result> test_bitvector_subvector(Botan::RandomNumberGenerator& /*rng*/) {




1✔





338



   auto make_bitpattern = [&]<typename T>(T& bitvector, size_t pattern_offset = 0) {




21✔





339



      auto next = pattern_generator<3>(pattern_offset);




20✔





340












341



      if constexpr(std::unsigned_integral<T>) {










342



         for(size_t i = 0; i < sizeof(T) * 8; ++i) {




316✔





343



            bitvector |= static_cast<T>(next()) << i;




304✔





344



         }










345



      } else {










346



         for(auto& i : bitvector) {




1,616✔





347



            i = next();




800✔





348



         }










349



      }










350



   };




8✔





351












352



   auto bitpattern_at = [&]<std::unsigned_integral T>(T /* ignored */, size_t pattern_offset) -> T {




13✔





353



      T bitvector = 0;




12✔





354



      make_bitpattern(bitvector, pattern_offset);




24✔





355



      return bitvector;










356



   };




1✔





357












358



   auto check_bitpattern = [&](auto& result, auto& bitvector, size_t offset = 0) {




44✔





359



      using bv_t = std::remove_cvref_t<decltype(bitvector)>;










360



      auto next = pattern_generator<3>(offset);




43✔





361












362



      if constexpr(std::unsigned_integral<bv_t>) {










363



         for(size_t i = 0; i < sizeof(bv_t) * 8; ++i) {




496✔





364



            result.confirm(Botan::fmt("{} is as expected", i), (bitvector & (bv_t(1) << i)) != 0, next());




960✔





365



         }










366



      } else {










367



         for(size_t i = 0; i < bitvector.size(); ++i) {




2,056✔





368



            result.confirm(Botan::fmt("{} is as expected", i), bitvector[i], next());




4,058✔





369



         }










370



      }










371



   };




43✔





372












373



   auto check_bitpattern_with_zero_region = [&](auto& result, auto& bitvector, std::pair<size_t, size_t> zero_region) {




13✔





374



      auto next = pattern_generator<3>();




12✔





375



      for(size_t i = 0; i < bitvector.size(); ++i) {




1,212✔





376



         const bool i_in_range = (zero_region.first <= i && i < zero_region.second);




1,200✔





377



         const bool expected = next();




1,200✔





378



         result.confirm(Botan::fmt("{} is as expected", i), bitvector[i], !i_in_range && expected);




2,400✔





379



      }










380



   };




12✔





381












382



   return {




1✔





383



      CHECK("range errors are caught",










384



            [&](auto& result) {




1✔





385



               const Botan::bitvector bv(100);




1✔





386



               result.template test_throws<Botan::Invalid_Argument>("out of range", [&] { bv.subvector(0, 101); });




3✔





387



               result.template test_throws<Botan::Invalid_Argument>("out of range", [&] { bv.subvector(90, 11); });




3✔





388



               result.template test_throws<Botan::Invalid_Argument>("out of range", [&] { bv.subvector(100, 1); });




3✔





389



               result.template test_throws<Botan::Invalid_Argument>("out of range", [&] { bv.subvector(101, 0); });




4✔





390



            }),




1✔





391












392



      CHECK("empty copy is allowed",










393



            [&](auto& result) {




1✔





394



               const Botan::bitvector bv1(100);




1✔





395



               auto bv2 = bv1.subvector(0, 0);




1✔





396



               result.test_eq("empty at 0", bv2.size(), size_t(0));




1✔





397



               auto bv3 = bv1.subvector(10, 0);




1✔





398



               result.test_eq("empty at 10", bv3.size(), size_t(0));




1✔





399



               auto bv4 = bv1.subvector(100, 0);




1✔





400



               result.test_eq("empty at 100", bv3.size(), size_t(0));




2✔





401



            }),




2✔





402












403



      CHECK("byte-aligned copy",










404



            [&](auto& result) {




1✔





405



               Botan::bitvector bv1(100);




1✔





406



               make_bitpattern(bv1);




1✔





407












408



               auto bv2 = bv1.subvector(16, 58);




1✔





409



               result.test_eq("size is as requested", bv2.size(), size_t(58));




1✔





410



               check_bitpattern(result, bv2, 16);




1✔





411












412



               auto bv3 = bv1.subvector(32);  // copy until the end




1✔





413



               result.test_eq("size is as expected", bv3.size(), size_t(68));




1✔





414



               check_bitpattern(result, bv3, 32);




1✔





415



            }),




3✔





416












417



      CHECK("byte-aligned 2",










418



            [&](auto& result) {




1✔





419



               Botan::bitvector bv1(100);




1✔





420



               make_bitpattern(bv1);




1✔





421












422



               auto bv2 = bv1.subvector(8, 91);




1✔





423



               result.test_eq("size is as expected", bv2.size(), size_t(91));




1✔





424



               check_bitpattern(result, bv2, 8);




1✔





425












426



               auto bv3 = bv1.subvector(16, 58);




1✔





427



               result.test_eq("size is as requested", bv3.size(), size_t(58));




1✔





428



               check_bitpattern(result, bv3, 16);




1✔





429












430



               auto bv4 = bv1.subvector(24);  // copy until the end




1✔





431



               result.test_eq("size is as expected", bv4.size(), size_t(100 - 24));




1✔





432



               check_bitpattern(result, bv4, 24);




1✔





433












434



               auto bv5 = bv1.subvector(32);  // copy until the end




1✔





435



               result.test_eq("size is as expected", bv5.size(), size_t(100 - 32));




1✔





436



               check_bitpattern(result, bv5, 32);




1✔





437












438



               auto bv6 = bv1.subvector(48, 51);  // copy until the end




1✔





439



               result.test_eq("size is as expected", bv6.size(), size_t(51));




1✔





440



               check_bitpattern(result, bv6, 48);




1✔





441



            }),




6✔





442












443



      CHECK("byte-aligned copy must zero-out unused bits",










444



            [&](auto& result) {




1✔





445



               Botan::bitvector bv1(100);




1✔





446



               make_bitpattern(bv1);




1✔





447












448



               auto bv2 = bv1.subvector(16, 17);




1✔





449



               result.test_eq("size is as requested", bv2.size(), size_t(17));




1✔





450



               check_bitpattern(result, bv2, 16);




1✔





451












452



               bv2.resize(32);




1✔





453



               for(size_t i = 17; i < bv2.size(); ++i) {




16✔





454



                  result.confirm("tail is zero", !bv2[i]);




30✔





455



               }










456



            }),




2✔





457












458



      CHECK("unaligned copy",










459



            [&](auto& result) {




1✔





460



               Botan::bitvector bv1(100);




1✔





461



               make_bitpattern(bv1);




1✔





462












463



               auto bv2 = bv1.subvector(19, 69);




1✔





464



               result.test_eq("size is as requested", bv2.size(), size_t(69));




1✔





465



               check_bitpattern(result, bv2, 19);




1✔





466












467



               auto bv3 = bv1.subvector(21);  // copy until the end




1✔





468



               result.test_eq("size is as expected", bv3.size(), size_t(79));




1✔





469



               check_bitpattern(result, bv3, 21);




1✔





470












471



               auto bv4 = bv1.subvector(1, 16);




1✔





472



               result.test_eq("size is as expected", bv4.size(), size_t(16));




1✔





473



               check_bitpattern(result, bv4, 1);




1✔





474












475



               auto bv5 = bv1.subvector(1, 32);




1✔





476



               result.test_eq("size is as expected", bv5.size(), size_t(32));




1✔





477



               check_bitpattern(result, bv5, 1);




1✔





478












479



               auto bv6 = bv5.subvector(1, 12);




1✔





480



               result.test_eq("size is as expected", bv6.size(), size_t(12));




1✔





481



               check_bitpattern(result, bv6, 1 + 1);




1✔





482












483



               auto bv7 = bv1.subvector(17, 67);




1✔





484



               result.test_eq("size is as expected", bv7.size(), size_t(67));




1✔





485



               check_bitpattern(result, bv7, 17);




1✔





486












487



               auto bv8 = bv1.subvector(33);  // copy until the end




1✔





488



               result.test_eq("size is as expected", bv8.size(), size_t(67));




1✔





489



               check_bitpattern(result, bv8, 33);




1✔





490



            }),




8✔





491












492



      CHECK("byte-aligned unsigned integer subvector",










493



            [&](auto& result) {




1✔





494



               Botan::bitvector bv1(100);




1✔





495



               make_bitpattern(bv1);




1✔





496












497



               const auto u8_0 = bv1.subvector<uint8_t>(0);




1✔





498



               const auto u8_32 = bv1.subvector<uint8_t>(32);




1✔





499



               check_bitpattern(result, u8_0, 0);




1✔





500



               check_bitpattern(result, u8_32, 32);




1✔





501












502



               const auto u16_0 = bv1.subvector<uint16_t>(0);




1✔





503



               const auto u16_56 = bv1.subvector<uint16_t>(56);




1✔





504



               check_bitpattern(result, u16_0, 0);




1✔





505



               check_bitpattern(result, u16_56, 56);




1✔





506












507



               const auto u32_0 = bv1.subvector<uint32_t>(0);




1✔





508



               const auto u32_48 = bv1.subvector<uint32_t>(48);




1✔





509



               check_bitpattern(result, u32_0, 0);




1✔





510



               check_bitpattern(result, u32_48, 48);




1✔





511












512



               const auto u64_0 = bv1.subvector<uint64_t>(0);




1✔





513



               const auto u64_32 = bv1.subvector<uint64_t>(32);




1✔





514



               check_bitpattern(result, u64_0, 0);




1✔





515



               check_bitpattern(result, u64_32, 32);




1✔





516












517



               result.test_throws("out of range (uint8_t)", [&] { bv1.subvector<uint8_t>(93); });




3✔





518



               result.test_throws("out of range (uint16_t)", [&] { bv1.subvector<uint16_t>(85); });




3✔





519



               result.test_throws("out of range (uint32_t)", [&] { bv1.subvector<uint32_t>(69); });




3✔





520



               result.test_throws("out of range (uint64_t)", [&] { bv1.subvector<uint64_t>(37); });




4✔





521



            }),




1✔





522












523



      CHECK("unaligned unsigned integer subvector",










524



            [&](Test::Result& result) {




1✔





525



               Botan::bitvector bv1(100);




1✔





526



               make_bitpattern(bv1);




1✔





527












528



               const auto u8_3 = bv1.subvector<uint8_t>(3);




1✔





529



               const auto u8_92 = bv1.subvector<uint8_t>(92);




1✔





530



               check_bitpattern(result, u8_3, 3);




1✔





531



               check_bitpattern(result, u8_92, 92);




1✔





532












533



               const auto u16_7 = bv1.subvector<uint16_t>(7);




1✔





534



               const auto u16_84 = bv1.subvector<uint16_t>(84);




1✔





535



               check_bitpattern(result, u16_7, 7);




1✔





536



               check_bitpattern(result, u16_84, 84);




1✔





537












538



               const auto u32_11 = bv1.subvector<uint32_t>(11);




1✔





539



               const auto u32_68 = bv1.subvector<uint32_t>(68);




1✔





540



               check_bitpattern(result, u32_11, 11);




1✔





541



               check_bitpattern(result, u32_68, 68);




1✔





542












543



               const auto u64_21 = bv1.subvector<uint64_t>(21);




1✔





544



               const auto u64_36 = bv1.subvector<uint64_t>(36);




1✔





545



               check_bitpattern(result, u64_21, 21);




1✔





546



               check_bitpattern(result, u64_36, 36);




1✔





547



            }),




1✔





548












549



      CHECK("byte-aligned unsigned integer subvector replacement",










550



            [&](auto& result) {




1✔





551



               Botan::bitvector bv1(100);




1✔





552



               make_bitpattern(bv1);




1✔





553












554



               bv1.subvector_replace(0, uint8_t(0));




1✔





555



               check_bitpattern_with_zero_region(result, bv1, {0, 8});




1✔





556



               bv1.subvector_replace(0, bitpattern_at(uint8_t(0), 0));




2✔





557



               check_bitpattern(result, bv1);




1✔





558












559



               bv1.subvector_replace(32, uint8_t(0));




1✔





560



               check_bitpattern_with_zero_region(result, bv1, {32, 32 + 8});




1✔





561



               bv1.subvector_replace(32, bitpattern_at(uint8_t(0), 32));




2✔





562



               check_bitpattern(result, bv1);




1✔





563












564



               bv1.subvector_replace(56, uint16_t(0));




1✔





565



               check_bitpattern_with_zero_region(result, bv1, {56, 56 + 16});




1✔





566



               bv1.subvector_replace(56, bitpattern_at(uint16_t(0), 56));




2✔





567



               check_bitpattern(result, bv1);




1✔





568












569



               bv1.subvector_replace(48, uint32_t(0));




1✔





570



               check_bitpattern_with_zero_region(result, bv1, {48, 48 + 32});




1✔





571



               bv1.subvector_replace(48, bitpattern_at(uint32_t(0), 48));




2✔





572



               check_bitpattern(result, bv1);




1✔





573












574



               bv1.subvector_replace(16, uint64_t(0));




1✔





575



               check_bitpattern_with_zero_region(result, bv1, {16, 16 + 64});




1✔





576



               bv1.subvector_replace(16, bitpattern_at(uint64_t(0), 16));




2✔





577



               check_bitpattern(result, bv1);




1✔





578












579



               result.test_throws("out of range (uint8_t)", [&] { bv1.subvector_replace<uint8_t>(93, 42); });




3✔





580



               result.test_throws("out of range (uint16_t)", [&] { bv1.subvector_replace<uint16_t>(85, 42); });




3✔





581



               result.test_throws("out of range (uint32_t)", [&] { bv1.subvector_replace<uint32_t>(69, 42); });




3✔





582



               result.test_throws("out of range (uint64_t)", [&] { bv1.subvector_replace<uint64_t>(37, 42); });




4✔





583



            }),




1✔





584












585



      CHECK("unaligned unsigned integer subvector replacement",










586



            [&](auto& result) {




1✔





587



               Botan::bitvector bv1(100);




1✔





588



               make_bitpattern(bv1);




1✔





589












590



               bv1.subvector_replace(3, uint8_t(0));




1✔





591



               check_bitpattern_with_zero_region(result, bv1, {3, 3 + 8});




1✔





592



               bv1.subvector_replace(3, bitpattern_at(uint8_t(0), 3));




2✔





593



               check_bitpattern(result, bv1);




1✔





594












595



               bv1.subvector_replace(92, uint8_t(0));




1✔





596



               check_bitpattern_with_zero_region(result, bv1, {92, 92 + 8});




1✔





597



               bv1.subvector_replace(92, bitpattern_at(uint8_t(0), 92));




2✔





598



               check_bitpattern(result, bv1);




1✔





599












600



               bv1.subvector_replace(7, uint16_t(0));




1✔





601



               check_bitpattern_with_zero_region(result, bv1, {7, 7 + 16});




1✔





602



               bv1.subvector_replace(7, bitpattern_at(uint16_t(0), 7));




2✔





603



               check_bitpattern(result, bv1);




1✔





604












605



               bv1.subvector_replace(84, uint16_t(0));




1✔





606



               check_bitpattern_with_zero_region(result, bv1, {84, 84 + 16});




1✔





607



               bv1.subvector_replace(84, bitpattern_at(uint16_t(0), 84));




2✔





608



               check_bitpattern(result, bv1);




1✔





609












610



               bv1.subvector_replace(11, uint32_t(0));




1✔





611



               check_bitpattern_with_zero_region(result, bv1, {11, 11 + 32});




1✔





612



               bv1.subvector_replace(11, bitpattern_at(uint32_t(0), 11));




2✔





613



               check_bitpattern(result, bv1);




1✔





614












615



               bv1.subvector_replace(68, uint32_t(0));




1✔





616



               check_bitpattern_with_zero_region(result, bv1, {68, 68 + 32});




1✔





617



               bv1.subvector_replace(68, bitpattern_at(uint32_t(0), 68));




2✔





618



               check_bitpattern(result, bv1);




1✔





619












620



               bv1.subvector_replace(21, uint64_t(0));




1✔





621



               check_bitpattern_with_zero_region(result, bv1, {21, 21 + 64});




1✔





622



               bv1.subvector_replace(21, bitpattern_at(uint64_t(0), 21));




2✔





623



               check_bitpattern(result, bv1);




1✔





624



            }),




1✔





625



   };




11✔





626



}




1✔





627












628



std::vector<Test::Result> test_bitvector_global_modifiers_and_predicates(Botan::RandomNumberGenerator& /*rng*/) {




1✔





629



   auto make_bitpattern = [](auto& bitvector) {




3✔





630



      auto next = pattern_generator<5>();




2✔





631



      for(auto& i : bitvector) {




400✔





632



         i = next();




198✔





633



      }










634



   };




2✔





635












636



   auto check_bitpattern = [](auto& result, auto& bitvector) {




2✔





637



      auto next = pattern_generator<5>();




1✔





638



      for(size_t i = 0; i < bitvector.size(); ++i) {




100✔





639



         result.confirm(Botan::fmt("{} is as expected", i), bitvector[i], next());




198✔





640



      }










641



   };




1✔





642












643



   auto check_flipped_bitpattern = [](auto& result, auto& bitvector) {




2✔





644



      auto next = pattern_generator<5>();




1✔





645



      for(size_t i = 0; i < bitvector.size(); ++i) {




100✔





646



         result.confirm(Botan::fmt("{} is as expected", i), bitvector[i], !next());




198✔





647



      }










648



   };




1✔





649












650



   return {




1✔





651



      CHECK("one bit",










652



            [](auto& result) {




1✔





653



               Botan::bitvector bv;




1✔





654



               bv.push_back(true);




1✔





655












656



               bv.flip();




1✔





657



               result.confirm("bit is flipped", !bv[0]);




2✔





658












659



               // check that unused bits aren't flipped










660



               bv.resize(8);




1✔





661



               for(auto&& b : bv) {




9✔





662



                  result.confirm("all bits are false", !b);




16✔





663



               }










664



               bv.resize(1);




1✔





665












666



               bv.flip();




1✔





667



               result.confirm("bit is flipped again", bv[0]);




2✔





668



            }),




1✔





669












670



      CHECK("bits in many blocks",










671



            [&](auto& result) {




1✔





672



               Botan::bitvector bv(99);




1✔





673












674



               make_bitpattern(bv);




1✔





675



               bv.flip();




1✔





676



               check_flipped_bitpattern(result, bv);




1✔





677












678



               bv = ~bv;




2✔





679



               check_bitpattern(result, bv);




1✔





680












681



               bv.resize(112);




1✔





682



               for(size_t i = 99; i < bv.size(); ++i) {




14✔





683



                  result.confirm("just-allocated bit is not set", !bv[i]);




26✔





684



               }










685



            }),




1✔





686












687



      CHECK("set and unset",










688



            [&](auto& result) {




1✔





689



               Botan::bitvector bv(99);




1✔





690












691



               make_bitpattern(bv);




1✔





692



               bv.set();




1✔





693



               bv.resize(128);




1✔





694



               for(size_t i = 0; i < bv.size(); ++i) {




129✔





695



                  const bool expected = (i < 99);




128✔





696



                  result.test_eq("only set bits are set", bv[i], expected);




256✔





697



               }










698












699



               bv.unset();




1✔





700



               for(auto&& b : bv) {




130✔





701



                  result.confirm("bit is not set", !b);




256✔





702



               }










703



            }),




1✔





704












705



      CHECK("any, none and all",










706



            [&](auto& result) {




1✔





707



               Botan::bitvector bv(99);




1✔





708












709



               result.confirm("default construction yields all-zero", bv.none_vartime());




2✔





710



               result.confirm("default construction yields all-zero 2", !bv.any_vartime());




2✔





711



               result.confirm("default construction yields all-zero 3", !bv.all_vartime());




2✔





712



               result.confirm("default construction yields all-zero 4", bv.none());




2✔





713



               result.confirm("default construction yields all-zero 5", !bv.any());




2✔





714



               result.confirm("default construction yields all-zero 6", !bv.all());




2✔





715












716



               bv.set(42);




1✔





717



               result.confirm("setting a bit means there's a bit set", !bv.none_vartime());




2✔





718



               result.confirm("setting a bit means there's a bit set 2", bv.any_vartime());




2✔





719



               result.confirm("setting a bit means there's not all bits set", !bv.all_vartime());




2✔





720



               result.confirm("setting a bit means there's a bit set 3", !bv.none());




2✔





721



               result.confirm("setting a bit means there's a bit set 4", bv.any());




2✔





722



               result.confirm("setting a bit means there's not all bits set 2", !bv.all());




2✔





723












724



               bv.set();




1✔





725



               result.confirm("setting all bits means there's a bit set", !bv.none_vartime());




2✔





726



               result.confirm("setting all bits means there's a bit set 2", bv.any_vartime());




2✔





727



               result.confirm("setting all bits means all bits are set", bv.all_vartime());




2✔





728



               result.confirm("setting all bits means there's a bit set 3", !bv.none());




2✔





729



               result.confirm("setting all bits means there's a bit set 4", bv.any());




2✔





730



               result.confirm("setting all bits means all bits are set 2", bv.all());




2✔





731












732



               bv.unset(97);




1✔





733



               result.confirm("a single 0 at the end means that there's a bit set", !bv.none_vartime());




2✔





734



               result.confirm("a single 0 at the end means that there are bits set", bv.any_vartime());




2✔





735



               result.confirm("a single 0 at the end means that there are not all bits set", !bv.all_vartime());




2✔





736



               result.confirm("a single 0 at the end means that there's a bit set 2", !bv.none());




2✔





737



               result.confirm("a single 0 at the end means that there are bits set 2", bv.any());




2✔





738



               result.confirm("a single 0 at the end means that there are not all bits set 2", !bv.all());




2✔





739












740



               bv.unset();




1✔





741



               result.confirm("unsetting all bits means there's no bit set", bv.none_vartime());




2✔





742



               result.confirm("unsetting all bits means there's no bit set 2", !bv.any_vartime());




2✔





743



               result.confirm("unsetting all bits means there's not all bits set", !bv.all_vartime());




2✔





744



               result.confirm("unsetting all bits means there's no bit set 3", bv.none());




2✔





745



               result.confirm("unsetting all bits means there's no bit set 4", !bv.any());




2✔





746



               result.confirm("unsetting all bits means there's not all bits set 2", !bv.all());




2✔





747



            }),




1✔





748












749



      CHECK("hamming weight oddness",










750



            [](auto& result) {




1✔





751



               const auto even = Botan::hex_decode("FE3410CB0278E4D26602");




1✔





752



               const auto odd = Botan::hex_decode("BB2418C2B4F288921203");




1✔





753












754



               result.confirm("odd hamming", Botan::bitvector(odd).has_odd_hamming_weight().as_bool());




3✔





755



               result.confirm("even hamming", !Botan::bitvector(even).has_odd_hamming_weight().as_bool());




3✔





756



            }),




2✔





757












758



      CHECK("hamming weight",










759



            [](auto& result) {




1✔





760



               auto naive_count = [](const auto& v) {




5✔





761



                  size_t weight = 0;




5✔





762



                  for(const auto& bit : v) {




440✔





763



                     weight += bit.template as<size_t>();




430✔





764



                  }










765



                  return weight;




5✔





766



               };










767












768



               // the last three bits of this bitvector are set, then there's a gap










769



               auto bv = Botan::bitvector(Botan::hex_decode("FE3410CB0278E4D26602E0"));




2✔





770



               result.test_eq("hamming weight", bv.hamming_weight(), size_t(37));




1✔





771



               result.test_eq("hamming weight", bv.hamming_weight(), naive_count(bv));




2✔





772












773



               bv.pop_back();




1✔





774



               result.test_eq("hamming weight", bv.hamming_weight(), size_t(36));




1✔





775



               result.test_eq("hamming weight", bv.hamming_weight(), naive_count(bv));




2✔





776












777



               bv.pop_back();




1✔





778



               result.test_eq("hamming weight", bv.hamming_weight(), size_t(35));




1✔





779



               result.test_eq("hamming weight", bv.hamming_weight(), naive_count(bv));




2✔





780












781



               bv.pop_back();




1✔





782



               result.test_eq("hamming weight", bv.hamming_weight(), size_t(34));




1✔





783



               result.test_eq("hamming weight", bv.hamming_weight(), naive_count(bv));




2✔





784












785



               bv.pop_back();




1✔





786



               result.test_eq("hamming weight", bv.hamming_weight(), size_t(34));




1✔





787



               result.test_eq("hamming weight", bv.hamming_weight(), naive_count(bv));




2✔





788



            }),




1✔





789



   };




7✔





790



}




1✔





791












792



std::vector<Test::Result> test_bitvector_binary_operators(Botan::RandomNumberGenerator& /*rng*/) {




1✔





793



   auto check_set = [](auto& result, auto bits, std::vector<size_t> set_bits) {




13✔





794



      for(size_t i = 0; i < bits.size(); ++i) {




252✔





795



         const auto should_be_set = std::find(set_bits.begin(), set_bits.end(), i) != set_bits.end();




240✔





796



         result.test_eq(Botan::fmt("{} should {}be set", i, (!should_be_set ? "not " : "")), bits[i], should_be_set);




661✔





797



      }










798



   };




12✔





799












800



   auto is_secure_allocator = []<template <typename> typename AllocatorT>(auto& result,




7✔





801



                                                                          const Botan::bitvector_base<AllocatorT>&) {










802



      result.confirm("allocator is Botan::secure_allocator<>",




12✔





803



                     std::same_as<Botan::secure_allocator<uint8_t>, AllocatorT<uint8_t>>);










804



   };




6✔





805












806



   auto is_standard_allocator = []<template <typename> typename AllocatorT>(auto& result,




4✔





807



                                                                            const Botan::bitvector_base<AllocatorT>&) {










808



      result.confirm("allocator is std::allocator<>", std::same_as<std::allocator<uint8_t>, AllocatorT<uint8_t>>);




6✔





809



   };




3✔





810












811



   return {




1✔





812



      CHECK("bitwise_equals",










813



            [&](auto& result) {




1✔





814



               Botan::bitvector lhs(20);




1✔





815



               lhs.set(0).set(4).set(15).set(16).set(19);




1✔





816



               Botan::bitvector rhs(20);




1✔





817



               rhs.set(1).set(4).set(16).set(17).set(18);




1✔





818












819



               result.test_eq("Not equal bitvectors", lhs.equals_vartime(rhs), false);




1✔





820



               result.test_eq("Not equal bitvectors 2", lhs.equals(rhs), false);




2✔





821












822



               lhs.unset().set(13);




1✔





823



               rhs.unset().set(13);




1✔





824












825



               result.test_eq("equal bitvectors", lhs.equals_vartime(rhs), true);




1✔





826



               result.test_eq("equal bitvectors 2", lhs.equals(rhs), true);




2✔





827



            }),




2✔





828












829



      CHECK("bitwise OR",










830



            [&](auto& result) {




1✔





831



               Botan::bitvector lhs(20);




1✔





832



               lhs.set(0).set(4).set(15).set(16).set(19);




1✔





833



               Botan::bitvector rhs(20);




1✔





834



               rhs.set(1).set(4).set(16).set(17).set(18);




1✔





835



               Botan::bitvector unary(20);




1✔





836



               unary.set(8);




1✔





837












838



               Botan::bitvector res = lhs | rhs;




1✔





839



               check_set(result, res, {0, 1, 4, 15, 16, 17, 18, 19});




4✔





840












841



               res |= unary;




1✔





842



               check_set(result, res, {0, 1, 4, 8, 15, 16, 17, 18, 19});




3✔





843












844



               is_standard_allocator(result, res);




1✔





845



            }),




4✔





846












847



      CHECK("bitwise AND",










848



            [&](auto& result) {




1✔





849



               Botan::bitvector lhs(20);




1✔





850



               lhs.set(0).set(4).set(15).set(16).set(18);




1✔





851



               Botan::bitvector rhs(20);




1✔





852



               rhs.set(1).set(4).set(16).set(17).set(18);




1✔





853



               Botan::bitvector unary(20);




1✔





854



               unary.set(8).set(16);




1✔





855












856



               Botan::bitvector res = lhs & rhs;




1✔





857



               check_set(result, res, {4, 16, 18});




4✔





858












859



               res &= unary;




1✔





860



               check_set(result, res, {16});




3✔





861












862



               is_standard_allocator(result, res);




1✔





863



            }),




4✔





864












865



      CHECK("bitwise XOR",










866



            [&](auto& result) {




1✔





867



               Botan::bitvector lhs(20);




1✔





868



               lhs.set(0).set(4).set(15).set(16).set(18);




1✔





869



               Botan::bitvector rhs(20);




1✔





870



               rhs.set(1).set(4).set(16).set(17).set(18);




1✔





871



               Botan::bitvector unary(20);




1✔





872



               unary.set(8).set(16);




1✔





873












874



               Botan::bitvector res = lhs ^ rhs;




1✔





875



               check_set(result, res, {0, 1, 15, 17});




4✔





876












877



               res ^= unary;




1✔





878



               check_set(result, res, {0, 1, 8, 15, 16, 17});




3✔





879












880



               is_standard_allocator(result, res);




1✔





881



            }),




4✔





882












883



      CHECK("bitwise operators with heterogeneous allocators",










884



            [&](auto& result) {




1✔





885



               Botan::bitvector lhs(20);




1✔





886



               lhs.set(0).set(4).set(15).set(16).set(18);




1✔





887



               Botan::secure_bitvector rhs(20);




1✔





888



               rhs.set(1).set(4).set(16).set(17).set(18);




1✔





889



               Botan::bitvector unary(20);




1✔





890



               unary.set(8).set(16);




1✔





891












892



               auto res1 = lhs | rhs;




1✔





893



               is_secure_allocator(result, res1);




1✔





894



               check_set(result, res1, {0, 1, 4, 15, 16, 17, 18, 20});




3✔





895












896



               auto res2 = rhs | lhs;




1✔





897



               is_secure_allocator(result, res2);




1✔





898



               check_set(result, res2, {0, 1, 4, 15, 16, 17, 18, 20});




3✔





899












900



               auto res3 = lhs & rhs;




1✔





901



               is_secure_allocator(result, res3);




1✔





902



               check_set(result, res3, {4, 16, 18});




3✔





903












904



               auto res4 = rhs & lhs;




1✔





905



               is_secure_allocator(result, res4);




1✔





906



               check_set(result, res4, {4, 16, 18});




3✔





907












908



               auto res5 = lhs ^ rhs;




1✔





909



               is_secure_allocator(result, res5);




1✔





910



               check_set(result, res5, {0, 1, 15, 17});




3✔





911












912



               auto res6 = rhs ^ lhs;




1✔





913



               is_secure_allocator(result, res6);




1✔





914



               check_set(result, res6, {0, 1, 15, 17});




4✔





915



            }),




8✔





916



   };




6✔





917



}




1✔





918












919



std::vector<Test::Result> test_bitvector_serialization(Botan::RandomNumberGenerator& /*rng*/) {




1✔





920



   constexpr uint8_t outlen = 64;




1✔





921



   const auto bytearray = [] {




1✔





922



      std::array<uint8_t, outlen> out{};










923



      for(uint8_t i = 0; i < outlen; ++i) {










924



         out[i] = i;










925



      }










926



      return out;










927



   }();










928












929



   auto validate_bytewise = [](auto& result, const auto& bv, std::span<const uint8_t> bytes) {




3✔





930



      for(size_t i = 0; i < bytes.size(); ++i) {




129✔





931



         const uint8_t b = (static_cast<uint8_t>(bv[0 + i * 8]) << 0) | (static_cast<uint8_t>(bv[1 + i * 8]) << 1) |




127✔





932



                           (static_cast<uint8_t>(bv[2 + i * 8]) << 2) | (static_cast<uint8_t>(bv[3 + i * 8]) << 3) |




127✔





933



                           (static_cast<uint8_t>(bv[4 + i * 8]) << 4) | (static_cast<uint8_t>(bv[5 + i * 8]) << 5) |




127✔





934



                           (static_cast<uint8_t>(bv[6 + i * 8]) << 6) | (static_cast<uint8_t>(bv[7 + i * 8]) << 7);




127✔





935












936



         result.test_eq(Botan::fmt("byte {} is as expected", i), static_cast<size_t>(b), static_cast<size_t>(bytes[i]));




254✔





937



      }










938



   };




2✔





939












940



   return {




1✔





941



      CHECK("empty byte-array",










942



            [](auto& result) {




1✔





943



               std::vector<uint8_t> bytes;




1✔





944



               result.require("empty buffer", bytes.empty());




2✔





945












946



               const Botan::bitvector bv(bytes);




1✔





947



               result.confirm("empty bit vector", bv.empty());




2✔





948












949



               auto rendered = bv.to_bytes();




1✔





950



               result.confirm("empty bit vector renders an empty buffer", rendered.empty());




2✔





951



            }),




1✔





952












953



      CHECK("to_bytes() uses secure_allocator if necessary",










954



            [](auto& result) {




1✔





955



               const Botan::bitvector bv;




1✔





956



               const Botan::secure_bitvector sbv;




1✔





957












958



               auto rbv = bv.to_bytes();




1✔





959



               auto rsbv = sbv.to_bytes();




1✔





960












961



               result.confirm("ordinary bitvector uses ordinary std::vector",




2✔





962



                              std::is_same_v<std::vector<uint8_t>, decltype(rbv)>);










963



               result.confirm("secure bitvector uses secure_vector",




2✔





964



                              std::is_same_v<Botan::secure_vector<uint8_t>, decltype(rsbv)>);










965



            }),




1✔





966












967



      CHECK("load all bits from byte-array (aligned data)",










968



            [&](auto& result) {




1✔





969



               const Botan::bitvector bv(bytearray);




1✔





970



               validate_bytewise(result, bv, bytearray);




1✔





971












972



               const auto rbv = bv.to_bytes();




1✔





973



               result.confirm("uint8_t rendered correctly", std::ranges::equal(bytearray, rbv));




3✔





974



            }),




2✔





975












976



      CHECK("load all bits from byte-array (unaligned blocks)",










977



            [&](auto& result) {




1✔





978



               std::array<uint8_t, 63> unaligned_bytearray{};




1✔





979



               Botan::copy_mem(unaligned_bytearray, std::span{bytearray}.first<unaligned_bytearray.size()>());




1✔





980












981



               const Botan::bitvector bv(unaligned_bytearray);




1✔





982



               validate_bytewise(result, bv, unaligned_bytearray);




1✔





983












984



               const auto rbv = bv.to_bytes();




1✔





985



               result.confirm("uint8_t rendered correctly", std::ranges::equal(unaligned_bytearray, rbv));




2✔





986



            }),




3✔





987












988



      CHECK("load bits from byte-array (unaligned data)",










989



            [&](auto& result) {




1✔





990



               constexpr size_t bits_to_load = 31;




1✔





991



               constexpr size_t bytes_to_load = Botan::ceil_tobytes(bits_to_load);




1✔





992












993



               Botan::bitvector bv(bytearray, bits_to_load);




1✔





994












995



               for(size_t i = 0; i < bits_to_load; ++i) {




32✔





996



                  const bool expected = (i == 8) || (i == 17) || (i == 24) || (i == 25);




31✔





997



                  result.test_eq(Botan::fmt("bit {} is correct", i), bv.at(i), expected);




62✔





998



               }










999












1000



               const auto rbv = bv.to_bytes();




1✔





1001



               std::array<uint8_t, bytes_to_load> expected_bytes{};




1✔





1002



               Botan::copy_mem(expected_bytes, std::span{bytearray}.first<bytes_to_load>());




1✔





1003



               expected_bytes.back() &= (uint8_t(1) << (bits_to_load % 8)) - 1;




1✔





1004



               result.confirm("uint8_t rendered correctly", std::ranges::equal(expected_bytes, rbv));




2✔





1005



            }),




2✔





1006












1007



      CHECK("to_bytes(std::span) can handle non-zero out-memory",










1008



            [&](auto& result) {




1✔





1009



               constexpr size_t bits_to_load = 33;




1✔





1010



               constexpr size_t bytes_to_load = Botan::ceil_tobytes(bits_to_load);




1✔





1011












1012



               Botan::bitvector bv(bytearray, bits_to_load);




1✔





1013



               bv.set(32);




1✔





1014












1015



               std::array<uint8_t, bytes_to_load> out = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF};




1✔





1016



               bv.to_bytes(out);




1✔





1017












1018



               result.test_eq_sz("uint8_t rendered correctly", out[4], 0x01);




2✔





1019



            }),




1✔





1020



   };




7✔





1021



}




1✔





1022












1023



std::vector<Test::Result> test_bitvector_constant_time_operations(Botan::RandomNumberGenerator& /*rng*/) {




1✔





1024



   constexpr Botan::CT::Choice yes = Botan::CT::Choice::yes();




1✔





1025



   constexpr Botan::CT::Choice no = Botan::CT::Choice::no();




1✔





1026












1027



   return {




1✔





1028



      CHECK("conditional XOR, block aligned",










1029



            [&](auto& result) {




1✔





1030



               Botan::bitvector bv1(Botan::hex_decode("BAADF00DCAFEBEEF"));




2✔





1031



               const Botan::secure_bitvector bv2(Botan::hex_decode("CAFEBEEFC001B33F"));




2✔





1032



               const auto initial_bv1 = bv1;




1✔





1033



               const auto xor_result = bv1 ^ bv2;




1✔





1034












1035



               bv1.ct_conditional_xor(no, bv2);




1✔





1036



               result.confirm("no change after false condition", bv1 == initial_bv1);




2✔





1037












1038



               bv1.ct_conditional_xor(yes, bv2);




1✔





1039



               result.confirm("XORed if condition was true", bv1 == xor_result);




2✔





1040



            }),




4✔





1041












1042



      CHECK("conditional XOR, byte aligned",










1043



            [&](auto& result) {




1✔





1044



               Botan::bitvector bv1(Botan::hex_decode("BAADF00DCAFEBEEF42"));




2✔





1045



               const Botan::secure_bitvector bv2(Botan::hex_decode("CAFEBEEFC001B33F13"));




2✔





1046



               const auto initial_bv1 = bv1;




1✔





1047



               const auto xor_result = bv1 ^ bv2;




1✔





1048












1049



               bv1.ct_conditional_xor(no, bv2);




1✔





1050



               result.confirm("no change after false condition", bv1 == initial_bv1);




2✔





1051












1052



               bv1.ct_conditional_xor(yes, bv2);




1✔





1053



               result.confirm("XORed if condition was true", bv1 == xor_result);




2✔





1054



            }),




4✔





1055












1056



      CHECK("conditional XOR, no alignment",










1057



            [&](auto& result) {




1✔





1058



               Botan::bitvector bv1(Botan::hex_decode("BAADF00DCAFEBEEF42"));




1✔





1059



               bv1.push_back(true);




1✔





1060



               bv1.push_back(false);




1✔





1061



               Botan::secure_bitvector bv2(Botan::hex_decode("CAFEBEEFC001B33F13"));




1✔





1062



               bv2.push_back(false);




1✔





1063



               bv2.push_back(false);




1✔





1064












1065



               const auto initial_bv1 = bv1;




1✔





1066



               const auto xor_result = bv1 ^ bv2;




1✔





1067












1068



               bv1.ct_conditional_xor(no, bv2);




1✔





1069



               result.confirm("no change after false condition", bv1 == initial_bv1);




2✔





1070












1071



               bv1.ct_conditional_xor(yes, bv2);




1✔





1072



               result.confirm("XORed if condition was true", bv1 == xor_result);




2✔





1073



            }),




4✔





1074



   };




4✔





1075



}




1✔





1076












1077



std::vector<Test::Result> test_bitvector_conditional_xor_workload(Botan::RandomNumberGenerator& /*rng*/) {




1✔





1078



   Test::Result res("Conditional XOR, Gauss Workload");




1✔





1079












1080



   auto rng = Test::new_rng("Conditional XOR, Gauss Workload");




1✔





1081












1082



   const size_t matrix_rows = 1664;




1✔





1083



   const size_t matrix_columns = 8192;




1✔





1084












1085



   std::vector<Botan::bitvector> bitvec_vec;




1✔





1086



   bitvec_vec.reserve(matrix_rows);




1✔





1087



   for(size_t i = 0; i < matrix_rows; ++i) {




1,665✔





1088



      bitvec_vec.push_back(Botan::bitvector(rng->random_vec(matrix_columns / 8)));




4,992✔





1089



   }










1090












1091



   // Simulate #ops of Gaussian Elimination










1092



   const size_t total_iter = matrix_rows * (3 * matrix_rows - 1) / 2;




1✔





1093



   const auto start = Test::timestamp();




1✔





1094



   for(size_t i = 0; i < total_iter; ++i) {




4,152,513✔





1095



      const auto choice = Botan::CT::Choice::from_int(static_cast<uint8_t>(rng->next_byte() % 2));




4,152,512✔





1096



      bitvec_vec.at(i % matrix_rows).ct_conditional_xor(choice, bitvec_vec.at(rng->next_byte() % matrix_rows));




4,152,512✔





1097



   }










1098



   res.set_ns_consumed(Test::timestamp() - start);




1✔





1099












1100



   res.confirm("Prevent compiler from optimizing away",




3✔





1101



               bitvec_vec.at(0).any_vartime() || bitvec_vec.at(0).none_vartime());




1✔





1102



   return {res};




3✔





1103



}




3✔





1104












1105



std::vector<Test::Result> test_bitvector_iterators(Botan::RandomNumberGenerator& /*rng*/) {




1✔





1106



   return {




1✔





1107



      CHECK("Iterators: range-based for loop",










1108



            [](auto& result) {




1✔





1109



               Botan::bitvector bv(6);




1✔





1110



               bv.set(0).set(3).set(4);




1✔





1111












1112



               for(size_t i = 0; auto& ref : bv) {




8✔





1113



                  const bool expected = i == 0 || i == 3 || i == 4;




6✔





1114



                  result.test_eq(Botan::fmt("bit {} is as expected", i), ref, expected);




6✔





1115



                  ++i;




6✔





1116



               }










1117












1118



               for(size_t i = 0; const auto& ref : bv) {




8✔





1119



                  const bool expected = i == 0 || i == 3 || i == 4;




6✔





1120



                  result.test_eq(Botan::fmt("const bit {} is as expected", i), ref, expected);




6✔





1121



                  ++i;




6✔





1122



               }










1123












1124



               for(auto ref : bv) {




14✔





1125



                  ref = true;




6✔





1126



               }










1127












1128



               result.confirm("all bits are set", bv.all_vartime());




2✔





1129



            }),




1✔





1130












1131



      CHECK("Iterators: bare usage",










1132



            [](auto& result) {




1✔





1133



               Botan::bitvector bv(6);




1✔





1134



               bv.set(0).set(3).set(4);




1✔





1135












1136



               size_t i = 0;




1✔





1137



               for(auto itr = bv.begin(); itr != bv.end(); ++itr, ++i) {




7✔





1138



                  const bool expected = i == 0 || i == 3 || i == 4;




6✔





1139



                  result.test_eq(Botan::fmt("bit {} is as expected", i), *itr, expected);




12✔





1140



               }










1141












1142



               i = 0;




1✔





1143



               for(auto itr = bv.cbegin(); itr != bv.cend(); itr++, ++i) {




7✔





1144



                  const bool expected = i == 0 || i == 3 || i == 4;




6✔





1145



                  result.test_eq(Botan::fmt("const bit {} is as expected", i), itr->is_set(), expected);




12✔





1146



               }










1147












1148



               i = 6;




1✔





1149



               auto ritr = bv.end();




1✔





1150



               // NOLINTNEXTLINE(*-avoid-do-while)










1151



               do {










1152



                  --ritr;




6✔





1153



                  --i;




6✔





1154



                  const bool expected = i == 0 || i == 3 || i == 4;




6✔





1155



                  result.test_eq(Botan::fmt("reverse bit {} is as expected", i), *ritr, expected);




6✔





1156



               } while(ritr != bv.begin());




11✔





1157












1158



               for(auto& itr : bv) {




8✔





1159



                  itr.flip();




6✔





1160



               }










1161












1162



               i = 0;




1✔





1163



               for(auto itr = bv.begin(); itr != bv.end(); ++itr, ++i) {




7✔





1164



                  const bool expected = i == 1 || i == 2 || i == 5;




6✔





1165



                  result.test_eq(Botan::fmt("flipped bit {} is as expected", i), *itr, expected);




12✔





1166



               }










1167



            }),




1✔





1168












1169



      CHECK("Iterators: std::distance and std::advance",










1170



            [](auto& result) {




1✔





1171



               Botan::bitvector bv(6);




1✔





1172



               using signed_size_t = std::make_signed_t<size_t>;










1173












1174



               result.test_is_eq("distance", std::distance(bv.begin(), bv.end()), signed_size_t(6));




2✔





1175



               result.test_is_eq("const distance", std::distance(bv.cbegin(), bv.cend()), signed_size_t(6));




3✔





1176












1177



               auto b = bv.begin();




1✔





1178



               std::advance(b, 3);




1✔





1179



               result.test_is_eq("half distance", std::distance(bv.begin(), b), signed_size_t(3));




3✔





1180



            }),




1✔





1181












1182



      CHECK("Iterators: large bitvector",










1183



            [](auto& result) {




1✔





1184



               Botan::bitvector bv(500);




1✔





1185












1186



               for(auto itr = bv.begin(); itr != bv.end(); ++itr) {




1,001✔





1187



                  if(std::distance(bv.begin(), itr) % 2 == 0) {




1,000✔





1188



                     itr->set();




250✔





1189



                  }










1190



                  if(std::distance(bv.begin(), itr) % 3 == 0) {




1,000✔





1191



                     *itr = true;




167✔





1192



                  }










1193



               }










1194












1195



               for(size_t i = 0; const auto& bit : bv) {




502✔





1196



                  const bool expected = (i % 2 == 0) || (i % 3 == 0);




500✔





1197



                  result.test_eq(Botan::fmt("bit {} is as expected", i), bit, expected);




500✔





1198



                  ++i;




500✔





1199



               }










1200



            }),




1✔





1201












1202



      CHECK("Iterators: satiesfies C++20 concepts",










1203



            [](auto& result) {




1✔





1204



               Botan::secure_bitvector bv(42);




1✔





1205



               auto ro_itr = bv.cbegin();




1✔





1206



               auto rw_itr = bv.begin();




1✔





1207












1208



               using ro = decltype(ro_itr);










1209



               using rw = decltype(rw_itr);










1210












1211



               result.confirm("ro input iterator", std::input_iterator<ro>);




2✔





1212



               result.confirm("rw input iterator", std::input_iterator<rw>);




2✔





1213



               result.confirm("ro is not an output iterator", !std::output_iterator<ro, bool>);




2✔





1214



               result.confirm("rw output iterator", std::output_iterator<rw, bool>);




2✔





1215



               result.confirm("ro bidirectional iterator", std::bidirectional_iterator<ro>);




2✔





1216



               result.confirm("rw bidirectional iterator", std::bidirectional_iterator<rw>);




2✔





1217



               result.confirm("ro not a contiguous iterator", !std::contiguous_iterator<ro>);




2✔





1218



               result.confirm("rw not a contiguous iterator", !std::contiguous_iterator<rw>);




2✔





1219



            }),




1✔





1220



   };




6✔





1221



}




1✔





1222












1223



using TestBitvector = Botan::Strong<Botan::bitvector, struct TestBitvector_>;










1224



using TestSecureBitvector = Botan::Strong<Botan::secure_bitvector, struct TestBitvector_>;










1225



using TestUInt32 = Botan::Strong<uint32_t, struct TestUInt32_>;










1226












1227



std::vector<Test::Result> test_bitvector_strongtype_adapter(Botan::RandomNumberGenerator& /*rng*/) {




1✔





1228



   Test::Result result("Bitvector in strong type");




1✔





1229












1230



   TestBitvector bv1(33);




1✔





1231












1232



   result.confirm("bv1 is not empty", !bv1.empty());




2✔





1233



   result.test_eq("bv1 has size 33", bv1.size(), size_t(33));




1✔





1234












1235



   bv1[0] = true;




1✔





1236



   bv1.at(1) = true;




1✔





1237



   bv1.set(2);




2✔





1238



   bv1.unset(3);




2✔





1239



   bv1.flip(4);




2✔





1240



   bv1.push_back(true);




1✔





1241



   bv1.push_back(false);




1✔





1242



   bv1.pop_back();




1✔





1243












1244



   result.confirm("bv1 front is set", bv1.front());




2✔





1245



   result.confirm("bv1 back is set", bv1.back());




2✔





1246



   result.confirm("bv1 has some one bits", bv1.any_vartime());




2✔





1247



   result.confirm("bv1 is not all zero", !bv1.none_vartime());




2✔





1248



   result.confirm("bv1 is not all one", !bv1.all_vartime());




2✔





1249












1250



   result.confirm("hamming weight of bv1", bv1.has_odd_hamming_weight().as_bool());




2✔





1251












1252



   for(size_t i = 0; auto bit : bv1) {




36✔





1253



      const bool expected = (i == 0 || i == 1 || i == 2 || i == 4 || i == 33);




34✔





1254



      result.confirm(Botan::fmt("bv1 bit {} is set", i), bit == expected);




68✔





1255



      ++i;




34✔





1256



   }










1257












1258



   bv1.flip();




2✔





1259












1260



   for(size_t i = 0; auto bit : bv1) {




36✔





1261



      const bool expected = (i == 0 || i == 1 || i == 2 || i == 4 || i == 33);




34✔





1262



      result.confirm(Botan::fmt("bv1 bit {} is set", i), bit != expected);




68✔





1263



      ++i;




34✔





1264



   }










1265












1266



   auto bv2 = bv1.as<TestSecureBitvector>();




1✔





1267












1268



   auto bv3 = bv1 | bv2;




1✔





1269



   result.confirm("bv3 is a secure_bitvector", std::same_as<Botan::secure_bitvector, decltype(bv3)>);




2✔





1270












1271



   auto bv4 = bv2.subvector<TestSecureBitvector>(0, 5);




1✔





1272



   result.confirm("bv4 is a TestSecureBitvector", std::same_as<TestSecureBitvector, decltype(bv4)>);




2✔





1273












1274



   auto bv5 = bv2.subvector<TestUInt32>(1);




1✔





1275



   result.confirm("bv5 is a TestUInt32", std::same_as<TestUInt32, decltype(bv5)>);




2✔





1276



   result.test_is_eq<TestUInt32::wrapped_type>("bv5 has expected value", bv5.get(), 0xFFFFFFF4);




1✔





1277












1278



   const auto str = bv4.to_string();




1✔





1279



   result.test_eq("bv4 to_string", str, "00010");




2✔





1280












1281



   return {result};




3✔





1282



}




6✔





1283












1284



}  // namespace










1285












1286



class BitVector_Tests final : public Test {




1✔





1287



   public:










1288



      std::vector<Test::Result> run() override {




1✔





1289



         std::vector<Test::Result> results;




1✔





1290



         auto& rng = Test::rng();




1✔





1291












1292



         const std::vector<std::function<std::vector<Test::Result>(Botan::RandomNumberGenerator&)>> funcs{




1✔





1293



            test_bitvector_bitwise_accessors,










1294



            test_bitvector_capacity,










1295



            test_bitvector_subvector,










1296



            test_bitvector_global_modifiers_and_predicates,










1297



            test_bitvector_binary_operators,










1298



            test_bitvector_serialization,










1299



            test_bitvector_constant_time_operations,










1300



            test_bitvector_conditional_xor_workload,










1301



            test_bitvector_iterators,










1302



            test_bitvector_strongtype_adapter,










1303



         };




11✔





1304












1305



         for(const auto& test_func : funcs) {




11✔





1306



            auto fn_results = test_func(rng);




10✔





1307



            results.insert(results.end(), fn_results.begin(), fn_results.end());




10✔





1308



         }




10✔





1309












1310



         return results;




1✔





1311



      }




2✔





1312



};










1313












1314



BOTAN_REGISTER_TEST("utils", "bitvector", BitVector_Tests);










1315












1316



#endif










1317












1318



}  // namespace Botan_Tests
























    

  • 

    •