/* Copyright <2018-2025> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef REPERTORY_INCLUDE_UTILS_ENCRYPTION_HPP_ #define REPERTORY_INCLUDE_UTILS_ENCRYPTION_HPP_ #if defined(PROJECT_ENABLE_LIBSODIUM) #include "utils/config.hpp" #include "utils/error.hpp" #include "utils/hash.hpp" namespace repertory::utils::encryption { inline constexpr std::uint32_t encryption_header_size{ crypto_aead_xchacha20poly1305_IETF_NPUBBYTES + crypto_aead_xchacha20poly1305_IETF_ABYTES, }; #if defined(PROJECT_ENABLE_BOOST) enum class kdf_version : std::uint8_t { v1 }; enum class kdf_type : std::uint8_t { argon2id }; enum class memlimit_level : std::uint8_t { level1, // 64MiB level2, // 256MiB level3, // 512MiB level4, // 1GiB }; enum class opslimit_level : std::uint8_t { level1, // interactive level2, // moderate level3, // sensitive }; [[nodiscard]] inline auto get_memlimit(memlimit_level memlimit) -> size_t { constexpr const auto mib512{512ULL * 1024ULL * 1024ULL}; switch (memlimit) { case memlimit_level::level1: return crypto_pwhash_MEMLIMIT_INTERACTIVE; case memlimit_level::level2: return crypto_pwhash_MEMLIMIT_MODERATE; case memlimit_level::level3: return mib512; case memlimit_level::level4: return crypto_pwhash_MEMLIMIT_SENSITIVE; } return mib512; } [[nodiscard]] inline auto get_opslimit(opslimit_level opslimit) -> unsigned long long { switch (opslimit) { case opslimit_level::level1: return crypto_pwhash_OPSLIMIT_INTERACTIVE; case opslimit_level::level2: return crypto_pwhash_OPSLIMIT_MODERATE; case opslimit_level::level3: return crypto_pwhash_OPSLIMIT_SENSITIVE; } return crypto_pwhash_OPSLIMIT_MODERATE; } #pragma pack(push, 1) struct kdf_config final { static constexpr std::uint32_t repertory_magic{0x52505432}; using salt_t = std::array; std::uint32_t magic{repertory_magic}; kdf_version version{kdf_version::v1}; kdf_type kdf{kdf_type::argon2id}; memlimit_level memlimit{memlimit_level::level3}; opslimit_level opslimit{opslimit_level::level2}; salt_t salt{}; std::uint64_t checksum{}; [[nodiscard]] static constexpr auto size() -> std::size_t { return sizeof(kdf_config); } [[nodiscard]] auto generate_checksum() const -> std::uint64_t; void generate_salt(); [[nodiscard]] static auto from_header(std::span data, kdf_config &cfg) -> bool; [[nodiscard]] auto to_header() -> auto { kdf_config tmp{*this}; tmp.checksum = boost::endian::native_to_big(tmp.checksum); tmp.magic = boost::endian::native_to_big(tmp.magic); std::array ret{}; std::memcpy(ret.data(), &tmp, size()); return ret; } [[nodiscard]] auto operator==(const kdf_config &) const -> bool = default; [[nodiscard]] auto operator!=(const kdf_config &) const -> bool = default; }; #pragma pack(pop) #endif // defined(PROJECT_ENABLE_BOOST) template [[nodiscard]] inline auto generate_key( std::string_view password, std::function hasher = utils::hash::default_create_hash()) -> hash_t; template [[nodiscard]] inline auto generate_key( std::wstring_view password, std::function hasher = utils::hash::default_create_hash()) -> hash_t; #if defined(PROJECT_ENABLE_BOOST) template [[nodiscard]] inline auto generate_key(std::string_view password, kdf_config &cfg) -> hash_t; template [[nodiscard]] inline auto generate_key(std::wstring_view password, kdf_config &cfg) -> hash_t; template [[nodiscard]] inline auto recreate_key(std::string_view password, const kdf_config &cfg) -> hash_t; template [[nodiscard]] inline auto recreate_key(std::wstring_view password, const kdf_config &cfg) -> hash_t; template [[nodiscard]] auto create_key_argon2id(string_t password, kdf_config &cfg, utils::hash::hash_256_t &key) -> bool; template [[nodiscard]] auto recreate_key_argon2id(string_t password, const kdf_config &cfg, utils::hash::hash_256_t &key) -> bool; template [[nodiscard]] inline bool detect_and_recreate_key(string_t password, std::span header, hash_t &key, std::optional &cfg); template [[nodiscard]] inline bool detect_and_recreate_key(std::string_view password, std::span header, hash_t &key, std::optional &cfg); template [[nodiscard]] inline bool detect_and_recreate_key(std::wstring_view password, std::span header, hash_t &key, std::optional &cfg); [[nodiscard]] auto decrypt_file_name(std::string_view encryption_token, std::string &file_name) -> bool; [[nodiscard]] auto decrypt_file_path(std::string_view encryption_token, std::string &file_path) -> bool; [[nodiscard]] auto decrypt_file_name(std::string_view encryption_token, const kdf_config &cfg, std::string &file_name) -> bool; [[nodiscard]] auto decrypt_file_path(std::string_view encryption_token, const kdf_config &cfg, std::string &file_path) -> bool; template [[nodiscard]] inline auto decrypt_data(const std::array &key, const unsigned char *buffer, std::size_t buffer_size, result_t &res) -> bool { if (buffer_size > encryption_header_size) { std::uint32_t size = boost::endian::native_to_big(static_cast(buffer_size)); res.resize(buffer_size - encryption_header_size); return crypto_aead_xchacha20poly1305_ietf_decrypt_detached( reinterpret_cast(res.data()), nullptr, &buffer[encryption_header_size], res.size(), &buffer[crypto_aead_xchacha20poly1305_IETF_NPUBBYTES], reinterpret_cast(&size), sizeof(size), buffer, key.data()) == 0; } return false; } template [[nodiscard]] inline auto decrypt_data(const std::array &key, const buffer_t &buf, result_t &res) -> bool { return decrypt_data( key, reinterpret_cast(buf.data()), buf.size(), res); } template [[nodiscard]] inline auto decrypt_data( std::string_view password, const buffer_t &buf, result_t &res, std::function hasher = utils::hash::default_create_hash()) -> bool { return decrypt_data(generate_key(password, hasher), buf, res); } template [[nodiscard]] inline auto decrypt_data(std::string_view password, const kdf_config &cfg, const buffer_t &buf, result_t &res) -> bool { return decrypt_data(recreate_key(password, cfg), buf, res); } template [[nodiscard]] inline auto decrypt_data( std::string_view password, const unsigned char *buffer, std::size_t buffer_size, result_t &res, std::function hasher = utils::hash::default_create_hash()) -> bool { return decrypt_data(generate_key(password, hasher), buffer, buffer_size, res); } template [[nodiscard]] inline auto decrypt_data(std::string_view password, const kdf_config &cfg, const unsigned char *buffer, std::size_t buffer_size, result_t &res) -> bool { return decrypt_data(recreate_key(password, cfg), buffer, buffer_size, res); } template inline void encrypt_data(const std::array &iv, const std::array &key, const unsigned char *buffer, std::size_t buffer_size, result_t &res) { REPERTORY_USES_FUNCTION_NAME(); std::array mac{}; const std::uint32_t size = boost::endian::native_to_big( static_cast(buffer_size + encryption_header_size)); res.resize(buffer_size + encryption_header_size); unsigned long long mac_length{}; if (crypto_aead_xchacha20poly1305_ietf_encrypt_detached( reinterpret_cast(&res[encryption_header_size]), mac.data(), &mac_length, buffer, buffer_size, reinterpret_cast(&size), sizeof(size), nullptr, iv.data(), key.data()) != 0) { throw repertory::utils::error::create_exception(function_name, { "encryption failed", }); } std::memcpy(res.data(), iv.data(), iv.size()); std::memcpy(&res[iv.size()], mac.data(), mac.size()); } template inline void encrypt_data(const std::array &key, const unsigned char *buffer, std::size_t buffer_size, result_t &res) { std::array iv{}; randombytes_buf(iv.data(), iv.size()); encrypt_data(iv, key, buffer, buffer_size, res); } template inline void encrypt_data( std::string_view password, const unsigned char *buffer, std::size_t buffer_size, result_t &res, std::function hasher = utils::hash::default_create_hash()) { encrypt_data(generate_key(password, hasher), buffer, buffer_size, res); } template inline void encrypt_data(std::string_view password, kdf_config &cfg, const unsigned char *buffer, std::size_t buffer_size, result_t &res) { encrypt_data(generate_key(password, cfg), buffer, buffer_size, res); } template inline void encrypt_data( std::string_view password, const buffer_t &buf, result_t &res, std::function hasher = utils::hash::default_create_hash()) { encrypt_data(generate_key(password, hasher), reinterpret_cast(buf.data()), buf.size(), res); } template inline void encrypt_data(std::string_view password, kdf_config &cfg, const buffer_t &buf, result_t &res) { encrypt_data(generate_key(password, cfg), reinterpret_cast(buf.data()), buf.size(), res); } template inline void encrypt_data(const std::array &key, const buffer_t &buf, result_t &res) { encrypt_data(key, reinterpret_cast(buf.data()), buf.size(), res); } template inline void encrypt_data(const std::array &iv, const std::array &key, const buffer_t &buf, result_t &res) { encrypt_data(iv, key, reinterpret_cast(buf.data()), buf.size(), res); } using reader_func_t = std::function; [[nodiscard]] auto read_encrypted_range(const http_range &range, const utils::hash::hash_256_t &key, bool uses_kdf, reader_func_t reader_func, std::uint64_t total_size, data_buffer &data) -> bool; [[nodiscard]] auto read_encrypted_range( const http_range &range, const utils::hash::hash_256_t &key, bool uses_kdf, reader_func_t reader_func, std::uint64_t total_size, unsigned char *data, std::size_t size, std::size_t &bytes_read) -> bool; [[nodiscard]] inline auto read_encrypted_range(const http_range &range, const utils::hash::hash_256_t &key, reader_func_t reader_func, std::uint64_t total_size, data_buffer &data) -> bool { return read_encrypted_range(range, key, false, reader_func, total_size, data); } [[nodiscard]] inline auto read_encrypted_range( const http_range &range, const utils::hash::hash_256_t &key, reader_func_t reader_func, std::uint64_t total_size, unsigned char *data, std::size_t size, std::size_t &bytes_read) -> bool { return read_encrypted_range(range, key, false, reader_func, total_size, data, size, bytes_read); } template auto create_key_argon2id(string_t password, kdf_config &cfg, utils::hash::hash_256_t &key) -> bool { cfg.generate_salt(); return recreate_key_argon2id(password, cfg, key); } template auto recreate_key_argon2id(string_t password, const kdf_config &cfg, utils::hash::hash_256_t &key) -> bool { return crypto_pwhash( reinterpret_cast(key.data()), key.size(), reinterpret_cast(password.data()), password.size() * sizeof(typename string_t::value_type), cfg.salt.data(), get_opslimit(cfg.opslimit), get_memlimit(cfg.memlimit), crypto_pwhash_ALG_ARGON2ID13) == 0; } #endif // defined(PROJECT_ENABLE_BOOST) template inline auto generate_key( std::string_view password, std::function hasher) -> hash_t { return hasher(reinterpret_cast(password.data()), password.size()); } template inline auto generate_key( std::wstring_view password, std::function hasher) -> hash_t { return hasher(reinterpret_cast(password.data()), password.size() * sizeof(wchar_t)); } #if defined(PROJECT_ENABLE_BOOST) template inline auto generate_key_impl(string_t password, kdf_config &cfg) -> hash_t { REPERTORY_USES_FUNCTION_NAME(); switch (cfg.version) { case kdf_version::v1: switch (cfg.kdf) { case kdf_type::argon2id: { hash_t key{}; if (not create_key_argon2id(password, cfg, key)) { throw utils::error::create_exception( function_name, { "failed to generate argon2id key", }); } return key; } default: throw utils::error::create_exception( function_name, { "unsupported kdf type", std::to_string(static_cast(cfg.kdf)), }); } default: throw utils::error::create_exception( function_name, { "unsupported kdf version", std::to_string(static_cast(cfg.version)), }); } } template inline auto recreate_key_impl(string_t password, const kdf_config &cfg) -> hash_t { REPERTORY_USES_FUNCTION_NAME(); switch (cfg.version) { case kdf_version::v1: switch (cfg.kdf) { case kdf_type::argon2id: { hash_t key{}; if (not recreate_key_argon2id(password, cfg, key)) { throw utils::error::create_exception( function_name, { "failed to generate argon2id key", }); } return key; } default: throw utils::error::create_exception( function_name, { "unsupported kdf type", std::to_string(static_cast(cfg.kdf)), }); } default: throw utils::error::create_exception( function_name, { "unsupported kdf version", std::to_string(static_cast(cfg.version)), }); } } template inline auto generate_key(std::string_view password, kdf_config &cfg) -> hash_t { return generate_key_impl(password, cfg); } template inline auto generate_key(std::wstring_view password, kdf_config &cfg) -> hash_t { return generate_key_impl(password, cfg); } template inline auto recreate_key(std::string_view password, const kdf_config &cfg) -> hash_t { return recreate_key_impl(password, cfg); } template inline auto recreate_key(std::wstring_view password, const kdf_config &cfg) -> hash_t { return recreate_key_impl(password, cfg); } template inline bool detect_and_recreate_key(string_t password, std::span header, hash_t &key, std::optional &cfg) { if (header.size() >= kdf_config::size()) { kdf_config tmp{}; if (kdf_config::from_header(header.first(kdf_config::size()), tmp)) { cfg = tmp; key = recreate_key(password, *cfg); return true; } } key = generate_key(password); return false; } template inline bool detect_and_recreate_key(std::string_view password, std::span header, hash_t &key, std::optional &cfg) { return detect_and_recreate_key(password, header, key, cfg); } template inline bool detect_and_recreate_key(std::wstring_view password, std::span header, hash_t &key, std::optional &cfg) { return detect_and_recreate_key(password, header, key, cfg); } #endif // defined(PROJECT_ENABLE_BOOST) } // namespace repertory::utils::encryption #endif // defined(PROJECT_ENABLE_LIBSODIUM) #endif // REPERTORY_INCLUDE_UTILS_ENCRYPTION_HPP_