Skip to content

Add consteval testing of DRBGs and change default parameters for consteval spans #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mborland merged 6 commits into from
Feb 6, 2025
Merged

Add consteval testing of DRBGs and change default parameters for consteval spans #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3fbceba
Default template parameters
mborland Feb 6, 2025
97f1740
Add hmac drbg consteval test
mborland Feb 6, 2025
1bc5ba7
Add hash_drbg immediate_test
mborland Feb 6, 2025
545f3f1
Change default parameters
mborland Feb 6, 2025
7dbd5cb
Remove defaulted parameters
mborland Feb 6, 2025
4d3e055
Remove HMAC default parameters
mborland Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 31 additions & 31 deletions include/boost/crypt2/drbg/detail/hash_drbg.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,29 +68,29 @@ class hash_drbg
compat::uint64_t reseed_counter_ {};
bool initialized_ {};

template <compat::size_t ExtentReturn = compat::dynamic_extent,
compat::size_t Extent1 = compat::dynamic_extent,
compat::size_t Extent2 = compat::dynamic_extent,
compat::size_t Extent3 = compat::dynamic_extent,
compat::size_t Extent4 = compat::dynamic_extent>
template <compat::size_t ExtentReturn,
compat::size_t Extent1,
compat::size_t Extent2 = 0U,
compat::size_t Extent3 = 0U,
compat::size_t Extent4 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto hash_df(compat::uint32_t no_of_bits_to_return,
compat::span<compat::byte, ExtentReturn> return_container,
compat::span<const compat::byte, Extent1> provided_data_1,
compat::span<const compat::byte, Extent2> provided_data_2 = compat::span<const compat::byte, 0U> {},
compat::span<const compat::byte, Extent3> provided_data_3 = compat::span<const compat::byte, 0U> {},
compat::span<const compat::byte, Extent4> provided_data_4 = compat::span<const compat::byte, 0U> {}) noexcept -> state;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto hashgen(compat::span<compat::byte, Extent> returned_bits, compat::size_t requested_number_of_bytes) noexcept -> state;

template <compat::size_t Extent1 = compat::dynamic_extent,
compat::size_t Extent2 = compat::dynamic_extent>
template <compat::size_t Extent1,
compat::size_t Extent2 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto no_pr_generate_impl(compat::span<compat::byte, Extent1> return_data, compat::size_t requested_bits,
compat::span<const compat::byte, Extent2> additional_data = compat::span<const compat::byte, 0U> {}) noexcept -> state;

template <compat::size_t Extent1 = compat::dynamic_extent,
compat::size_t Extent2 = compat::dynamic_extent,
compat::size_t Extent3 = compat::dynamic_extent>
template <compat::size_t Extent1,
compat::size_t Extent2,
compat::size_t Extent3 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto pr_generate_impl(compat::span<compat::byte, Extent1> return_data, compat::size_t requested_bits,
compat::span<const compat::byte, Extent2> entropy,
compat::span<const compat::byte, Extent3> additional_data = compat::span<const compat::byte, 0U> {}) noexcept -> state;
Expand All @@ -100,43 +100,43 @@ class hash_drbg

BOOST_CRYPT_GPU_ENABLED_CONSTEXPR ~hash_drbg() noexcept;

template <compat::size_t Extent1 = compat::dynamic_extent,
compat::size_t Extent2 = compat::dynamic_extent,
compat::size_t Extent3 = compat::dynamic_extent>
template <compat::size_t Extent1,
compat::size_t Extent2 = 0U,
compat::size_t Extent3 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto init(compat::span<const compat::byte, Extent1> entropy,
compat::span<const compat::byte, Extent2> nonce = compat::span<compat::byte, 0>{},
compat::span<const compat::byte, Extent3> personalization = compat::span<compat::byte, 0>{}) noexcept -> state;
compat::span<const compat::byte, Extent2> nonce = compat::span<const compat::byte, 0>{},
compat::span<const compat::byte, Extent3> personalization = compat::span<const compat::byte, 0>{}) noexcept -> state;

template <concepts::sized_range SizedRange1,
concepts::sized_range SizedRange2,
concepts::sized_range SizedRange3 = compat::array<compat::byte, 0U>>
concepts::sized_range SizedRange3 = compat::span<const compat::byte, 0U>>
BOOST_CRYPT_GPU_ENABLED auto init(SizedRange1&& entropy,
SizedRange2&& nonce = compat::array<compat::byte, 0U> {},
SizedRange3&& personalization = compat::array<compat::byte, 0U> {}) noexcept -> state;
SizedRange2&& nonce = compat::span<const compat::byte, 0U> {},
SizedRange3&& personalization = compat::span<const compat::byte, 0U> {}) noexcept -> state;

template <compat::size_t Extent1 = compat::dynamic_extent,
compat::size_t Extent2 = compat::dynamic_extent>
template <compat::size_t Extent1,
compat::size_t Extent2 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto reseed(compat::span<const compat::byte, Extent1> entropy,
compat::span<const compat::byte, Extent2> additional_input = compat::span<compat::byte, 0>{}) noexcept -> state;
compat::span<const compat::byte, Extent2> additional_input = compat::span<const compat::byte, 0>{}) noexcept -> state;

template <concepts::sized_range SizedRange1,
concepts::sized_range SizedRange2 = compat::array<compat::byte, 0U>>
concepts::sized_range SizedRange2 = compat::span<const compat::byte, 0U>>
BOOST_CRYPT_GPU_ENABLED auto reseed(SizedRange1&& entropy,
SizedRange2&& additional_input = compat::array<compat::byte, 0U> {}) noexcept -> state;
SizedRange2&& additional_input = compat::span<const compat::byte, 0U> {}) noexcept -> state;

template <compat::size_t Extent1,
compat::size_t Extent2 = compat::dynamic_extent,
compat::size_t Extent3 = compat::dynamic_extent>
compat::size_t Extent2 = 0U,
compat::size_t Extent3 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto generate(compat::span<compat::byte, Extent1> return_data, compat::size_t requested_bits,
compat::span<const compat::byte, Extent2> additional_data1 = compat::span<const compat::byte, 0U> {},
[[maybe_unused]] compat::span<const compat::byte, Extent3> additional_data2 = compat::span<const compat::byte, 0U> {}) noexcept -> state;

template <concepts::sized_range SizedRange1,
concepts::sized_range SizedRange2 = compat::array<compat::byte, 0U>,
concepts::sized_range SizedRange3 = compat::array<compat::byte, 0U>>
concepts::sized_range SizedRange2 = compat::span<const compat::byte, 0U>,
concepts::sized_range SizedRange3 = compat::span<const compat::byte, 0U>>
BOOST_CRYPT_GPU_ENABLED auto generate(SizedRange1&& return_data, compat::size_t requested_bits,
SizedRange2&& additional_data1 = compat::array<compat::byte, 0U>{},
[[maybe_unused]] SizedRange3&& additional_data2 = compat::array<compat::byte, 0U>{}) noexcept -> state;
SizedRange2&& additional_data1 = compat::span<const compat::byte, 0U>{},
[[maybe_unused]] SizedRange3&& additional_data2 = compat::span<const compat::byte, 0U>{}) noexcept -> state;
};

template <typename HasherType, compat::size_t max_hasher_security, compat::size_t outlen, bool prediction_resistance>
Expand Down Expand Up @@ -241,7 +241,7 @@ hash_drbg<HasherType, max_hasher_security, outlen, prediction_resistance>::hashg
}

auto data {value_};
const auto data_span {compat::span<compat::byte, seedlen_bytes>(data)};
const auto data_span {compat::span<const compat::byte, seedlen_bytes>(data)};
compat::size_t offset {};
HasherType hasher;
while (offset < requested_number_of_bytes)
Expand Down
4 changes: 2 additions & 2 deletions include/boost/crypt2/drbg/detail/hmac_drbg.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ class hmac_drbg
SizedRange2&& nonce = compat::span<const compat::byte, 0U>{},
SizedRange3&& personalization = compat::span<const compat::byte, 0U>{}) noexcept -> state;

template <compat::size_t Extent1, compat::size_t Extent2>
template <compat::size_t Extent1, compat::size_t Extent2 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto reseed(compat::span<const compat::byte, Extent1> entropy,
compat::span<const compat::byte, Extent2> additional_input = compat::span<const compat::byte, 0>{}) noexcept -> state;

Expand All @@ -103,7 +103,7 @@ class hmac_drbg
BOOST_CRYPT_GPU_ENABLED auto reseed(SizedRange1&& entropy,
SizedRange2&& additional_data = compat::span<const compat::byte, 0U>{}) noexcept -> state;

template <compat::size_t Extent1, compat::size_t Extent2, compat::size_t Extent3>
template <compat::size_t Extent1, compat::size_t Extent2 = 0U, compat::size_t Extent3 = 0U>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto generate(compat::span<compat::byte, Extent1> return_data, compat::size_t requested_bits,
compat::span<const compat::byte, Extent2> additional_data_1 = compat::span<const compat::byte, 0U>{},
compat::span<const compat::byte, Extent3> additional_data_2 = compat::span<const compat::byte, 0U>{}) noexcept -> state;
Expand Down
12 changes: 6 additions & 6 deletions include/boost/crypt2/hash/detail/sha3_base.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ class sha3_base final {

BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto process_message_block() noexcept -> void;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
auto update(compat::span<const compat::byte, Extent> data) noexcept -> state;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
auto xof_digest_impl(compat::span<compat::byte, Extent> data, compat::size_t amount) noexcept -> void;

Expand All @@ -59,7 +59,7 @@ class sha3_base final {

BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto init() noexcept -> void;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto process_bytes(compat::span<const compat::byte, Extent> data) noexcept -> state;

template <concepts::sized_range SizedRange>
Expand All @@ -74,7 +74,7 @@ class sha3_base final {
[[nodiscard("Digest is the function return value")]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
compat::enable_if_t<Const, compat::expected<return_type, state>> get_digest() const noexcept;

template <bool Const = !is_xof, compat::size_t Extent = compat::dynamic_extent>
template <bool Const = !is_xof, compat::size_t Extent>
[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
compat::enable_if_t<Const, state> get_digest(compat::span<compat::byte, Extent> data) const noexcept;

Expand All @@ -87,15 +87,15 @@ class sha3_base final {
[[nodiscard("Digest is the function return value")]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
compat::enable_if_t<Const, compat::expected<return_type, state>> get_digest() noexcept;

template <bool Const = is_xof, compat::size_t Extent = compat::dynamic_extent>
template <bool Const = is_xof, compat::size_t Extent>
[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
compat::enable_if_t<Const, state> get_digest(compat::span<compat::byte, Extent> data) noexcept;

template <bool Const = is_xof, concepts::writable_output_range Range>
[[nodiscard]] BOOST_CRYPT_GPU_ENABLED
compat::enable_if_t<Const, state> get_digest(Range&& data) noexcept;

template <bool Const = is_xof, compat::size_t Extent = compat::dynamic_extent>
template <bool Const = is_xof, compat::size_t Extent>
[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
compat::enable_if_t<Const, state> get_digest(compat::span<compat::byte, Extent> data, std::size_t amount) noexcept;

Expand Down
10 changes: 5 additions & 5 deletions include/boost/crypt2/mac/hmac.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,28 @@ class hmac
bool computed_ {false};
bool corrupted_ {false};

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto init_impl(compat::span<const compat::byte, Extent> data) noexcept -> state;

public:

BOOST_CRYPT_GPU_ENABLED_CONSTEXPR hmac() noexcept = default;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
explicit BOOST_CRYPT_GPU_ENABLED_CONSTEXPR hmac(const compat::span<const compat::byte, Extent> key) noexcept { init(key); }

BOOST_CRYPT_GPU_ENABLED_CONSTEXPR ~hmac() noexcept;

BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto init_from_keys(const key_type& inner_key,
const key_type& outer_key) noexcept -> state;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto init(compat::span<const compat::byte, Extent> data) noexcept -> state;

template <concepts::sized_range SizedRange>
BOOST_CRYPT_GPU_ENABLED auto init(SizedRange&& data) noexcept -> state;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto process_bytes(compat::span<const compat::byte, Extent> data) noexcept -> state;

template <concepts::sized_range SizedRange>
Expand All @@ -67,7 +67,7 @@ class hmac

[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto get_digest() const noexcept -> compat::expected<return_type, state>;

template <compat::size_t Extent = compat::dynamic_extent>
template <compat::size_t Extent>
[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
auto get_digest(compat::span<compat::byte, Extent> data) const noexcept -> state;

Expand Down
95 changes: 95 additions & 0 deletions test/test_hash_drbg.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,99 @@ void sha1_error_cases()
BOOST_TEST(pr_rng.generate(bad_return_container, 1, entropy, nonce) == boost::crypt::state::uninitialized);
}

consteval bool immediate_test()
{
boost::crypt::sha1_hash_drbg rng;

constexpr std::array<std::byte, 16> entropy = {
std::byte{0xc3}, std::byte{0xef}, std::byte{0x82}, std::byte{0xce},
std::byte{0x24}, std::byte{0x1f}, std::byte{0x02}, std::byte{0xe4},
std::byte{0x29}, std::byte{0x8b}, std::byte{0x11}, std::byte{0x8c},
std::byte{0xa4}, std::byte{0xf1}, std::byte{0x62}, std::byte{0x25}
};

constexpr std::array<std::byte, 8> nonce = {
std::byte{0x15}, std::byte{0xe3}, std::byte{0x2a}, std::byte{0xbb},
std::byte{0xae}, std::byte{0x6b}, std::byte{0x74}, std::byte{0x33}
};

constexpr std::array<std::byte, 16> additional_input_1 = {
std::byte{0x2b}, std::byte{0x79}, std::byte{0x00}, std::byte{0x52},
std::byte{0xf0}, std::byte{0x9b}, std::byte{0x36}, std::byte{0x4d},
std::byte{0x4a}, std::byte{0x82}, std::byte{0x67}, std::byte{0xa0},
std::byte{0xa7}, std::byte{0xde}, std::byte{0x63}, std::byte{0xb8}
};

constexpr std::array<std::byte, 16> additional_input_2 = {
std::byte{0x2e}, std::byte{0xe0}, std::byte{0x81}, std::byte{0x9a},
std::byte{0x67}, std::byte{0x1d}, std::byte{0x07}, std::byte{0xb5},
std::byte{0x08}, std::byte{0x5c}, std::byte{0xc4}, std::byte{0x6a},
std::byte{0xa0}, std::byte{0xe6}, std::byte{0x1b}, std::byte{0x56}
};

std::span<const std::byte, 16> entropy_span {entropy};
std::span<const std::byte, 8> nonce_span {nonce};
std::span<const std::byte, 16> additional_input_1_span {additional_input_1};
std::span<const std::byte, 16> additional_input_2_span {additional_input_2};

std::array<std::byte, 80> return_bits {};
std::span<std::byte, 80> return_bit_span {return_bits};

// Test process is:
// 1) Instantiate drbg
// 2) Generate bits, do not compare
// 3) Generate bits, compare
// 4) Destroy drbg
rng.init(entropy_span, nonce_span);
// ** INSTANTIATE:
// V = 062e928dbf6ef8f7b57467a2a956f4754b094b5f5a9515fe0059a35d449b74485eac06f0671eaa6ec313fc52da015f69b18cc670d9e89a
// C = 0fb2fcface8fe5876199565b26d3db365037da40291d67915426959d90c8beba18e3dd1961b48a1ac62b0150cdefa5dc077daf27b4cf3e

rng.generate(return_bit_span, 640U, additional_input_1_span);
// ** GENERATE (FIRST CALL):
// V = 15e18f888dfede7f170dbdfdd02acfab9b41259f83b27d8f548038fad5643302778fe466a1b0a63b22b39b4c59a4b7f151bec718d08a16
// C = 0fb2fcface8fe5876199565b26d3db365037da40291d67915426959d90c8beba18e3dd1961b48a1ac62b0150cdefa5dc077daf27b4cf3e

rng.generate(return_bit_span, 640U, additional_input_2_span);
// ** GENERATE (SECOND CALL):
// V = 25948c835c8ec40678a71458f6feaae1eb78ffdfaccfe520a8a6ce98662cf1bc9073c28d8664f953ae0352e0b5a7ecc5577d08a0babfc3
// C = 0fb2fcface8fe5876199565b26d3db365037da40291d67915426959d90c8beba18e3dd1961b48a1ac62b0150cdefa5dc077daf27b4cf3e


constexpr std::array<std::byte, 80> nist_return = {
std::byte{0x58}, std::byte{0x25}, std::byte{0xfa}, std::byte{0x1d},
std::byte{0x1d}, std::byte{0xc3}, std::byte{0x3c}, std::byte{0x64},
std::byte{0xcd}, std::byte{0xc8}, std::byte{0x69}, std::byte{0x06},
std::byte{0x82}, std::byte{0xef}, std::byte{0xf0}, std::byte{0x60},
std::byte{0x39}, std::byte{0xe7}, std::byte{0x95}, std::byte{0x08},
std::byte{0xc3}, std::byte{0xaf}, std::byte{0x48}, std::byte{0xe8},
std::byte{0x80}, std::byte{0xf8}, std::byte{0x22}, std::byte{0x7d},
std::byte{0x5f}, std::byte{0x9a}, std::byte{0xaa}, std::byte{0x14},
std::byte{0xb3}, std::byte{0xbc}, std::byte{0x76}, std::byte{0xba},
std::byte{0xee}, std::byte{0x47}, std::byte{0x7e}, std::byte{0xbb},
std::byte{0xb5}, std::byte{0xc4}, std::byte{0x55}, std::byte{0x47},
std::byte{0x13}, std::byte{0x41}, std::byte{0x79}, std::byte{0x22},
std::byte{0x32}, std::byte{0x57}, std::byte{0x52}, std::byte{0x5e},
std::byte{0x8f}, std::byte{0x3a}, std::byte{0xfe}, std::byte{0xfb},
std::byte{0x78}, std::byte{0xb5}, std::byte{0x9d}, std::byte{0xa0},
std::byte{0x32}, std::byte{0xf1}, std::byte{0x00}, std::byte{0x6d},
std::byte{0x74}, std::byte{0xc9}, std::byte{0x83}, std::byte{0x13},
std::byte{0x75}, std::byte{0xa6}, std::byte{0x77}, std::byte{0xea},
std::byte{0xb3}, std::byte{0x23}, std::byte{0x9c}, std::byte{0x94},
std::byte{0xeb}, std::byte{0xe3}, std::byte{0xf7}, std::byte{0xfa}
};

for (std::size_t i {}; i < return_bits.size(); ++i)
{
if (!(return_bits[i] == static_cast<std::byte>(nist_return[i])))
{
return false;
}
}

return true;
}

int main()
{
sha_1_basic_correctness();
Expand All @@ -465,5 +558,7 @@ int main()
sha1_no_reseed_additional_input();
sha1_error_cases();

static_assert(immediate_test());

return boost::report_errors();
}
Loading