Merge pull request #199 from cppalliance/sha3_384

mborland · web-flow · commit 9c8f6be0d7d4 · 2025-01-14T10:28:08.000-05:00
Update SHA3-384
diff --git a/include/boost/crypt2/hash/detail/sha3_base.hpp b/include/boost/crypt2/hash/detail/sha3_base.hpp
@@ -67,8 +67,9 @@ class sha3_base final {
     [[nodiscard("Digest is the function return value")]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
     auto get_digest() noexcept -> compat::expected<return_type, state>;
 
+    template <compat::size_t Extent>
     [[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
-    auto get_digest(compat::span<compat::byte> data) noexcept -> state;
+    auto get_digest(compat::span<compat::byte, Extent> data) noexcept -> state;
 
     template <concepts::writable_output_range Range>
     [[nodiscard]] BOOST_CRYPT_GPU_ENABLED auto get_digest(Range&& data) noexcept -> state;
@@ -357,8 +358,9 @@ auto sha3_base<digest_size, is_xof>::get_digest() noexcept -> compat::expected<r
 }
 
 template <compat::size_t digest_size, bool is_xof>
+template <compat::size_t Extent>
 [[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto
-sha3_base<digest_size, is_xof>::get_digest(compat::span<compat::byte> data) noexcept -> state
+sha3_base<digest_size, is_xof>::get_digest(compat::span<compat::byte, Extent> data) noexcept -> state
 {
     if (!computed_ || corrupted_)
     {
@@ -398,6 +400,11 @@ template <concepts::writable_output_range Range>
 {
     using value_type = compat::range_value_t<Range>;
 
+    if (!computed_ || corrupted_)
+    {
+        return state::state_error;
+    }
+
     auto data_span {compat::span<value_type>(compat::forward<Range>(data))};
 
     #if defined(__clang__) && __clang_major__ >= 19
@@ -407,7 +414,7 @@ template <concepts::writable_output_range Range>
 
     if constexpr (is_xof)
     {
-        return get_digest(compat::span<compat::byte>(compat::as_writable_bytes(data_span).data()));
+        xof_digest_impl(compat::span<compat::byte>(compat::as_writable_bytes(data_span).data()));
     }
     else
     {
@@ -416,7 +423,7 @@ template <concepts::writable_output_range Range>
             return state::insufficient_output_length;
         }
 
-        return get_digest(
+        sha_digest_impl(
             compat::span<compat::byte, digest_size>(
                 compat::as_writable_bytes(data_span).data(),
                 digest_size
@@ -427,6 +434,8 @@ template <concepts::writable_output_range Range>
     #if defined(__clang__) && __clang_major__ >= 19
     #pragma clang diagnostic pop
     #endif
+
+    return state::success;
 }
 
 } // namespace boost::crypt::hash_detail
diff --git a/include/boost/crypt2/hash/sha3_384.hpp b/include/boost/crypt2/hash/sha3_384.hpp
@@ -0,0 +1,50 @@
+// Copyright 2024 - 2025 Matt Borland
+// Distributed under the Boost Software License, Version 1.0.
+// https://www.boost.org/LICENSE_1_0.txt
+
+#ifndef BOOST_CRYPT2_HASH_SHA3_384_HPP
+#define BOOST_CRYPT2_HASH_SHA3_384_HPP
+
+#include <boost/crypt2/hash/detail/sha3_base.hpp>
+#include <boost/crypt2/hash/detail/hash_file.hpp>
+#include <boost/crypt2/detail/compat.hpp>
+#include <boost/crypt2/detail/concepts.hpp>
+
+namespace boost::crypt {
+
+BOOST_CRYPT_EXPORT using sha3_384_hasher = hash_detail::sha3_base<48U>;
+
+// One shot functions
+[[nodiscard]] BOOST_CRYPT_EXPORT BOOST_CRYPT_GPU_ENABLED_CONSTEXPR
+auto sha3_384(compat::span<const compat::byte> data) noexcept -> compat::expected<sha3_384_hasher::return_type, state>
+{
+    sha3_384_hasher hasher;
+    hasher.process_bytes(data);
+    hasher.finalize();
+    return hasher.get_digest();
+}
+
+template <compat::sized_range SizedRange>
+[[nodiscard]] BOOST_CRYPT_EXPORT BOOST_CRYPT_GPU_ENABLED
+auto sha3_384(SizedRange&& data) noexcept -> compat::expected<sha3_384_hasher::return_type, state>
+{
+    sha3_384_hasher hasher;
+    hasher.process_bytes(data);
+    hasher.finalize();
+    return hasher.get_digest();
+}
+
+#if !BOOST_CRYPT_HAS_CUDA
+
+template <concepts::file_system_path T>
+[[nodiscard]] BOOST_CRYPT_EXPORT
+auto sha3_384_file(const T& filepath) -> compat::expected<sha3_384_hasher::return_type, state>
+{
+    return hash_detail::hash_file_impl<sha3_384_hasher>(filepath);
+}
+
+#endif // BOOST_CRYPT_HAS_CUDA
+
+} // namespace boost::crypt
+
+#endif // BOOST_CRYPT2_HASH_SHA3_384_HPP
diff --git a/include/boost/crypt2/hash/sha3_512.hpp b/include/boost/crypt2/hash/sha3_512.hpp
@@ -2,8 +2,8 @@
 // Distributed under the Boost Software License, Version 1.0.
 // https://www.boost.org/LICENSE_1_0.txt
 
-#ifndef BOOST_CRYPT2_HASH_SHA384_HPP
-#define BOOST_CRYPT2_HASH_SHA384_HPP
+#ifndef BOOST_CRYPT2_HASH_SHA3_512_HPP
+#define BOOST_CRYPT2_HASH_SHA3_512_HPP
 
 #include <boost/crypt2/hash/detail/sha3_base.hpp>
 #include <boost/crypt2/hash/detail/hash_file.hpp>
@@ -47,4 +47,4 @@ auto sha3_512_file(const T& filepath) -> compat::expected<sha3_512_hasher::retur
 
 } // namespace boost::crypt
 
-#endif //BOOST_CRYPT2_HASH_SHA384_HPP
+#endif //BOOST_CRYPT2_HASH_SHA3_512_HPP
diff --git a/test/Jamfile b/test/Jamfile
@@ -67,7 +67,7 @@ run test_sha512.cpp ;
 run test_sha512_224.cpp ;
 run test_sha512_256.cpp ;
 run test_sha3_512.cpp ;
-#run test_sha3_384.cpp ;
+run test_sha3_384.cpp ;
 #run test_sha3_256.cpp ;
 #run test_sha3_224.cpp ;
 #run test_shake128.cpp ;
@@ -128,8 +128,8 @@ run test_nist_cavs_sha3_512_monte.cpp ;
 run test_nist_cavs_sha3_512_short_long.cpp ;
 #run test_nist_cavs_sha3_512_hmac.cpp ;
 
-#run test_nist_cavs_sha3_384_monte.cpp ;
-#run test_nist_cavs_sha3_384_short_long.cpp ;
+run test_nist_cavs_sha3_384_monte.cpp ;
+run test_nist_cavs_sha3_384_short_long.cpp ;
 #run test_nist_cavs_sha3_384_hmac.cpp ;
 
 #run test_nist_cavs_sha3_256_monte.cpp ;
diff --git a/test/nvcc_jamfile b/test/nvcc_jamfile
@@ -17,7 +17,7 @@ run test_sha512_nvcc.cu ;
 run test_sha512_224_nvcc.cu ;
 run test_sha512_256_nvcc.cu ;
 run test_sha3_512_nvcc.cu ;
-#run test_sha3_384_nvcc.cu ;
+run test_sha3_384_nvcc.cu ;
 #run test_sha3_256_nvcc.cu ;
 #run test_sha3_224_nvcc.cu ;
 #run test_shake128_nvcc.cu ;
diff --git a/test/test_nist_cavs_sha3_384_monte.cpp b/test/test_nist_cavs_sha3_384_monte.cpp
@@ -3,13 +3,13 @@
 // Distributed under the Boost Software License, Version 1.0.
 // https://www.boost.org/LICENSE_1_0.txt
 
-#include <boost/crypt/hash/sha3_384.hpp>
+#include <boost/crypt2/hash/sha3_384.hpp>
 
 #include "test_nist_cavs_detail.hpp"
 
 auto main() -> int
 {
-  bool result_is_ok { true };
+    bool result_is_ok { true };
 
     {
         nist::cavs::test_vector_container_type my_test_vectors_monte { };
@@ -27,5 +27,5 @@ auto main() -> int
         BOOST_TEST(result_is_ok);
     }
 
-  return boost::report_errors();
+    return boost::report_errors();
 }
diff --git a/test/test_nist_cavs_sha3_384_short_long.cpp b/test/test_nist_cavs_sha3_384_short_long.cpp
@@ -3,7 +3,7 @@
 // Distributed under the Boost Software License, Version 1.0.
 // https://www.boost.org/LICENSE_1_0.txt
 
-#include <boost/crypt/hash/sha3_384.hpp>
+#include <boost/crypt2/hash/sha3_384.hpp>
 
 #include "test_nist_cavs_detail.hpp"
 
diff --git a/test/test_sha3_384.cpp b/test/test_sha3_384.cpp
diff --git a/test/test_sha3_384_nvcc.cu b/test/test_sha3_384_nvcc.cu

Original file line number	Diff line number	Diff line change
`@@ -67,8 +67,9 @@ class sha3_base final {`
`67`	`67`	`[[nodiscard("Digest is the function return value")]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR`
`68`	`68`	`auto get_digest() noexcept -> compat::expected<return_type, state>;`
`69`	`69`
	`70`	`+ template <compat::size_t Extent>`
`70`	`71`	`[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR`
`71`		`- auto get_digest(compat::span<compat::byte> data) noexcept -> state;`
	`72`	`+ auto get_digest(compat::span<compat::byte, Extent> data) noexcept -> state;`
`72`	`73`
`73`	`74`	`template <concepts::writable_output_range Range>`
`74`	`75`	`[[nodiscard]] BOOST_CRYPT_GPU_ENABLED auto get_digest(Range&& data) noexcept -> state;`
`@@ -357,8 +358,9 @@ auto sha3_base<digest_size, is_xof>::get_digest() noexcept -> compat::expected<r`
`357`	`358`	`}`
`358`	`359`
`359`	`360`	`template <compat::size_t digest_size, bool is_xof>`
	`361`	`+template <compat::size_t Extent>`
`360`	`362`	`[[nodiscard]] BOOST_CRYPT_GPU_ENABLED_CONSTEXPR auto`
`361`		`-sha3_base<digest_size, is_xof>::get_digest(compat::span<compat::byte> data) noexcept -> state`
	`363`	`+sha3_base<digest_size, is_xof>::get_digest(compat::span<compat::byte, Extent> data) noexcept -> state`
`362`	`364`	`{`
`363`	`365`	`if (!computed_ \|\| corrupted_)`
`364`	`366`	`{`
`@@ -398,6 +400,11 @@ template <concepts::writable_output_range Range>`
`398`	`400`	`{`
`399`	`401`	`using value_type = compat::range_value_t<Range>;`
`400`	`402`
	`403`	`+ if (!computed_ \|\| corrupted_)`
	`404`	`+ {`
	`405`	`+ return state::state_error;`
	`406`	`+ }`
	`407`	`+`
`401`	`408`	`auto data_span {compat::span<value_type>(compat::forward<Range>(data))};`
`402`	`409`
`403`	`410`	`#if defined(__clang__) && __clang_major__ >= 19`
`@@ -407,7 +414,7 @@ template <concepts::writable_output_range Range>`
`407`	`414`
`408`	`415`	`if constexpr (is_xof)`
`409`	`416`	`{`
`410`		`- return get_digest(compat::span<compat::byte>(compat::as_writable_bytes(data_span).data()));`
	`417`	`+ xof_digest_impl(compat::span<compat::byte>(compat::as_writable_bytes(data_span).data()));`
`411`	`418`	`}`
`412`	`419`	`else`
`413`	`420`	`{`
`@@ -416,7 +423,7 @@ template <concepts::writable_output_range Range>`
`416`	`423`	`return state::insufficient_output_length;`
`417`	`424`	`}`
`418`	`425`
`419`		`- return get_digest(`
	`426`	`+ sha_digest_impl(`
`420`	`427`	`compat::span<compat::byte, digest_size>(`
`421`	`428`	`compat::as_writable_bytes(data_span).data(),`
`422`	`429`	`digest_size`
`@@ -427,6 +434,8 @@ template <concepts::writable_output_range Range>`
`427`	`434`	`#if defined(__clang__) && __clang_major__ >= 19`
`428`	`435`	`#pragma clang diagnostic pop`
`429`	`436`	`#endif`
	`437`	`+`
	`438`	`+ return state::success;`
`430`	`439`	`}`
`431`	`440`
`432`	`441`	`} // namespace boost::crypt::hash_detail`
Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,13 @@`
`3`	`3`	`// Distributed under the Boost Software License, Version 1.0.`
`4`	`4`	`// https://www.boost.org/LICENSE_1_0.txt`
`5`	`5`
`6`		`-#include <boost/crypt/hash/sha3_384.hpp>`
	`6`	`+#include <boost/crypt2/hash/sha3_384.hpp>`
`7`	`7`
`8`	`8`	`#include "test_nist_cavs_detail.hpp"`
`9`	`9`
`10`	`10`	`auto main() -> int`
`11`	`11`	`{`
`12`		`- bool result_is_ok { true };`
	`12`	`+ bool result_is_ok { true };`
`13`	`13`
`14`	`14`	`{`
`15`	`15`	`nist::cavs::test_vector_container_type my_test_vectors_monte { };`
`@@ -27,5 +27,5 @@ auto main() -> int`
`27`	`27`	`BOOST_TEST(result_is_ok);`
`28`	`28`	`}`
`29`	`29`
`30`		`- return boost::report_errors();`
	`30`	`+ return boost::report_errors();`
`31`	`31`	`}`