/* 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. */ #if defined(PROJECT_ENABLE_LIBSODIUM) && defined(PROJECT_ENABLE_BOOST) #include "utils/encrypting_reader.hpp" #include "utils/base64.hpp" #include "utils/collection.hpp" #include "utils/common.hpp" #include "utils/config.hpp" #include "utils/encryption.hpp" #include "utils/error.hpp" #include "utils/file.hpp" #include "utils/unix.hpp" #include "utils/windows.hpp" #if !defined(CURL_READFUNC_ABORT) #define CURL_READFUNC_ABORT (-1) #endif // !defined(CURL_READFUNC_ABORT) namespace repertory::utils::encryption { class encrypting_streambuf final : public encrypting_reader::streambuf { public: encrypting_streambuf(const encrypting_streambuf &) = default; encrypting_streambuf(encrypting_streambuf &&) = delete; auto operator=(const encrypting_streambuf &) -> encrypting_streambuf & = delete; auto operator=(encrypting_streambuf &&) -> encrypting_streambuf & = delete; explicit encrypting_streambuf(const encrypting_reader &reader) : reader_(reader) { setg(reinterpret_cast(0), reinterpret_cast(0), reinterpret_cast(reader_.get_total_size())); } ~encrypting_streambuf() override = default; private: encrypting_reader reader_; protected: auto seekoff(off_type off, std::ios_base::seekdir dir, std::ios_base::openmode which = std::ios_base::out | std::ios_base::in) -> pos_type override { REPERTORY_USES_FUNCTION_NAME(); if ((which & std::ios_base::in) != std::ios_base::in) { throw utils::error::create_exception(function_name, { "output is not supported", }); } const auto set_position = [this](char *next) -> pos_type { if ((next <= egptr()) && (next >= eback())) { setg(eback(), next, reinterpret_cast(reader_.get_total_size())); return static_cast( reinterpret_cast(gptr())); } return {traits_type::eof()}; }; switch (dir) { case std::ios_base::beg: return set_position(eback() + off); case std::ios_base::cur: return set_position(gptr() + off); case std::ios_base::end: return set_position(egptr() + off); } return encrypting_reader::streambuf::seekoff(off, dir, which); } auto seekpos(pos_type pos, std::ios_base::openmode which = std::ios_base::out | std::ios_base::in) -> pos_type override { return seekoff(pos, std::ios_base::beg, which); } auto uflow() -> int_type override { auto ret = underflow(); if (ret == traits_type::eof()) { return ret; } gbump(1); return ret; } auto underflow() -> int_type override { if (gptr() == egptr()) { return traits_type::eof(); } reader_.set_read_position(reinterpret_cast(gptr())); char c{}; auto res = encrypting_reader::reader_function(&c, 1U, 1U, &reader_); if (res != 1) { return traits_type::eof(); } return c; } auto xsgetn(char *ptr, std::streamsize count) -> std::streamsize override { if (gptr() == egptr()) { return traits_type::eof(); } reader_.set_read_position(reinterpret_cast(gptr())); auto res = encrypting_reader::reader_function( ptr, 1U, static_cast(count), &reader_); if ((res == reader_.get_error_return()) || (reader_.get_stop_requested() && (res == static_cast(CURL_READFUNC_ABORT)))) { return traits_type::eof(); } setg(eback(), gptr() + res, reinterpret_cast(reader_.get_total_size())); return static_cast(res); } }; class encrypting_reader_iostream final : public encrypting_reader::iostream { public: encrypting_reader_iostream(const encrypting_reader_iostream &) = delete; encrypting_reader_iostream(encrypting_reader_iostream &&) = delete; auto operator=(const encrypting_reader_iostream &) -> encrypting_reader_iostream & = delete; auto operator=(encrypting_reader_iostream &&) -> encrypting_reader_iostream & = delete; explicit encrypting_reader_iostream( std::unique_ptr buffer) : encrypting_reader::iostream(buffer.get()), buffer_(std::move(buffer)) {} ~encrypting_reader_iostream() override = default; private: std::unique_ptr buffer_; }; const std::size_t encrypting_reader::header_size_ = ([]() { return crypto_aead_xchacha20poly1305_IETF_NPUBBYTES + crypto_aead_xchacha20poly1305_IETF_ABYTES; })(); const std::size_t encrypting_reader::data_chunk_size_ = (8UL * 1024UL * 1024UL); const std::size_t encrypting_reader::encrypted_chunk_size_ = data_chunk_size_ + header_size_; encrypting_reader::encrypting_reader( std::string_view file_name, std::string_view source_path, stop_type_callback stop_requested_cb, std::string_view token, std::optional relative_parent_path, std::size_t error_return) : keys_(utils::encryption::generate_key(token), utils::encryption::generate_key(token)), stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)) { common_initialize(true); create_encrypted_paths(file_name, relative_parent_path); } encrypting_reader::encrypting_reader(stop_type_callback stop_requested_cb, std::string_view encrypted_file_path, std::string_view source_path, std::string_view token, std::size_t error_return) : keys_(utils::encryption::generate_key(token), utils::encryption::generate_key(token)), stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)), encrypted_file_name_( utils::path::strip_to_file_name(std::string{encrypted_file_path})), encrypted_file_path_(encrypted_file_path) { common_initialize(true); } encrypting_reader::encrypting_reader( stop_type_callback stop_requested_cb, std::string_view encrypted_file_path, std::string_view source_path, std::string_view token, std::vector< std::array> iv_list, std::size_t error_return) : keys_(utils::encryption::generate_key(token), utils::encryption::generate_key(token)), stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)), encrypted_file_name_( utils::path::strip_to_file_name(std::string{encrypted_file_path})), encrypted_file_path_(encrypted_file_path), iv_list_(std::move(iv_list)) { common_initialize(false); } encrypting_reader::encrypting_reader( std::string_view file_name, std::string_view source_path, stop_type_callback stop_requested_cb, std::string_view token, kdf_config cfg, std::optional relative_parent_path, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)) { common_initialize_kdf_keys(token, cfg); common_initialize(true); create_encrypted_paths(file_name, relative_parent_path); } encrypting_reader::encrypting_reader(stop_type_callback stop_requested_cb, std::string_view encrypted_file_path, std::string_view source_path, std::string_view token, kdf_config cfg, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)), encrypted_file_name_( utils::path::strip_to_file_name(std::string{encrypted_file_path})), encrypted_file_path_(encrypted_file_path) { common_initialize_kdf_keys(token, cfg); common_initialize(true); } encrypting_reader::encrypting_reader( stop_type_callback stop_requested_cb, std::string_view encrypted_file_path, std::string_view source_path, std::string_view token, kdf_config cfg, std::vector< std::array> iv_list, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)), encrypted_file_name_( utils::path::strip_to_file_name(std::string{encrypted_file_path})), encrypted_file_path_(encrypted_file_path), iv_list_(std::move(iv_list)) { common_initialize_kdf_keys(token, cfg); common_initialize(false); } encrypting_reader::encrypting_reader( std::string_view file_name, std::string_view source_path, stop_type_callback stop_requested_cb, const utils::hash::hash_256_t &master_key, const kdf_config &cfg, std::optional relative_parent_path, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)) { common_initialize_kdf_data(cfg, master_key); auto [path_key, path_cfg] = cfg.create_subkey( kdf_context::path, utils::generate_secure_random(), master_key); keys_.second = std::move(path_key); kdf_headers_->second = path_cfg.to_header(); common_initialize(true); create_encrypted_paths(file_name, relative_parent_path); } encrypting_reader::encrypting_reader( std::string_view file_name, std::string_view source_path, stop_type_callback stop_requested_cb, const utils::hash::hash_256_t &master_key, const std::pair &configs, std::optional relative_parent_path, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)) { keys_ = { configs.first.recreate_subkey(utils::encryption::kdf_context::data, master_key), configs.second.recreate_subkey(utils::encryption::kdf_context::path, master_key), }; kdf_headers_ = { configs.first.to_header(), configs.second.to_header(), }; common_initialize(true); create_encrypted_paths(file_name, relative_parent_path); } encrypting_reader::encrypting_reader(stop_type_callback stop_requested_cb, std::string_view encrypted_file_path, std::string_view source_path, const utils::hash::hash_256_t &master_key, const kdf_config &cfg, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)), encrypted_file_name_( utils::path::strip_to_file_name(std::string{encrypted_file_path})), encrypted_file_path_(encrypted_file_path) { common_initialize_kdf_data(cfg, master_key); common_initialize_kdf_path(master_key); common_initialize(true); } encrypting_reader::encrypting_reader( stop_type_callback stop_requested_cb, std::string_view encrypted_file_path, std::string_view source_path, const utils::hash::hash_256_t &master_key, const kdf_config &cfg, std::vector< std::array> iv_list, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)), encrypted_file_name_( utils::path::strip_to_file_name(std::string{encrypted_file_path})), encrypted_file_path_(encrypted_file_path), iv_list_(std::move(iv_list)) { common_initialize_kdf_data(cfg, master_key); common_initialize_kdf_path(master_key); common_initialize(false); } encrypting_reader::encrypting_reader( stop_type_callback stop_requested_cb, std::string_view encrypted_file_path, std::string_view source_path, const utils::hash::hash_256_t &master_key, const std::pair &configs, std::vector< std::array> iv_list, std::size_t error_return) : stop_requested_cb_(std::move(stop_requested_cb)), error_return_(error_return), source_file_(utils::file::file::open_or_create_file(source_path, true)), encrypted_file_name_( utils::path::strip_to_file_name(std::string{encrypted_file_path})), encrypted_file_path_(encrypted_file_path), iv_list_(std::move(iv_list)) { keys_.first = configs.first.recreate_subkey( utils::encryption::kdf_context::data, master_key); keys_.second = configs.second.recreate_subkey( utils::encryption::kdf_context::path, master_key); kdf_headers_ = { configs.first.to_header(), configs.second.to_header(), }; common_initialize(false); } encrypting_reader::encrypting_reader(const encrypting_reader &reader) : keys_(reader.keys_), stop_requested_cb_(reader.stop_requested_cb_), error_return_(reader.error_return_), source_file_( utils::file::file::open_file(reader.source_file_->get_path(), true)), encrypted_file_name_(reader.encrypted_file_name_), encrypted_file_path_(reader.encrypted_file_path_), iv_list_(reader.iv_list_), chunk_buffers_(reader.chunk_buffers_), kdf_headers_(reader.kdf_headers_), last_data_chunk_(reader.last_data_chunk_), last_data_chunk_size_(reader.last_data_chunk_size_), read_offset_(reader.read_offset_), total_size_(reader.total_size_) { REPERTORY_USES_FUNCTION_NAME(); if (not *source_file_) { throw utils::error::create_exception( function_name, { "file open failed", std::to_string(utils::get_last_error_code()), source_file_->get_path(), }); } } auto encrypting_reader::calculate_decrypted_size(std::uint64_t total_size, bool uses_kdf) -> std::uint64_t { if (uses_kdf) { total_size -= kdf_config::size(); } return total_size - (utils::divide_with_ceiling( total_size, static_cast( get_encrypted_chunk_size())) * encryption_header_size); } auto encrypting_reader::calculate_encrypted_size(std::string_view source_path, bool uses_kdf) -> std::uint64_t { REPERTORY_USES_FUNCTION_NAME(); auto opt_size = utils::file::file{source_path}.size(); if (not opt_size.has_value()) { throw utils::error::create_exception( function_name, { "get file size failed", std::to_string(utils::get_last_error_code()), source_path, }); } return calculate_encrypted_size(opt_size.value(), uses_kdf); } auto encrypting_reader::calculate_encrypted_size(std::uint64_t size, bool uses_kdf) -> std::uint64_t { auto total_chunks = utils::divide_with_ceiling( size, static_cast(data_chunk_size_)); return size + (total_chunks * encryption_header_size) + (uses_kdf ? kdf_config::size() : 0U); } void encrypting_reader::common_initialize(bool procces_iv_list) { REPERTORY_USES_FUNCTION_NAME(); if (not *source_file_) { throw utils::error::create_exception(function_name, { "file open failed", source_file_->get_path(), }); } auto opt_size = source_file_->size(); if (not opt_size.has_value()) { throw utils::error::create_exception(function_name, { "failed to get file size", source_file_->get_path(), }); } auto file_size = opt_size.value(); auto total_chunks = utils::divide_with_ceiling( file_size, static_cast(data_chunk_size_)); total_size_ = file_size + (total_chunks * encryption_header_size) + (kdf_headers_.has_value() ? kdf_headers_->first.size() : 0U); last_data_chunk_ = total_chunks - 1U; last_data_chunk_size_ = (file_size <= data_chunk_size_) ? file_size : (file_size % data_chunk_size_) == 0U ? data_chunk_size_ : file_size % data_chunk_size_; if (not procces_iv_list) { return; } iv_list_.resize(total_chunks); for (auto &data : iv_list_) { randombytes_buf(data.data(), data.size()); } } void encrypting_reader::common_initialize_kdf_data( const kdf_config &cfg, const utils::hash::hash_256_t &master_key) { auto [data_key, data_cfg] = cfg.create_subkey( kdf_context::data, utils::generate_secure_random(), master_key); keys_.first = std::move(data_key); kdf_headers_ = {data_cfg.to_header(), {}}; } void encrypting_reader::common_initialize_kdf_keys(std::string_view token, kdf_config &cfg) { auto key = utils::encryption::generate_key(token, cfg); keys_ = {key, key}; kdf_headers_ = {cfg.to_header(), cfg.to_header()}; } void encrypting_reader::common_initialize_kdf_path( const utils::hash::hash_256_t &master_key) { REPERTORY_USES_FUNCTION_NAME(); auto buffer = macaron::Base64::Decode(encrypted_file_path_); kdf_config path_cfg; if (not kdf_config::from_header(buffer, path_cfg)) { throw utils::error::create_exception( function_name, {"failed to create path kdf config from header"}); } utils::hash::hash_256_t path_key; std::tie(path_key, std::ignore) = path_cfg.create_subkey(kdf_context::path, path_cfg.unique_id, master_key); kdf_headers_->second = path_cfg.to_header(); } void encrypting_reader::create_encrypted_paths( std::string_view file_name, std::optional relative_parent_path) { data_buffer result; utils::encryption::encrypt_data( keys_.second, reinterpret_cast(file_name.data()), file_name.size(), result); if (kdf_headers_.has_value()) { result.insert(result.begin(), kdf_headers_->second.begin(), kdf_headers_->second.end()); } encrypted_file_name_ = kdf_headers_.has_value() ? macaron::Base64::EncodeUrlSafe(result.data(), result.size()) : utils::collection::to_hex_string(result); if (not relative_parent_path.has_value()) { return; } for (const auto &part : utils::string::split(relative_parent_path.value(), utils::path::directory_seperator, false)) { utils::encryption::encrypt_data( keys_.second, reinterpret_cast(part.c_str()), strnlen(part.c_str(), part.size()), result); if (kdf_headers_.has_value()) { result.insert(result.begin(), kdf_headers_->second.begin(), kdf_headers_->second.end()); } encrypted_file_path_ += '/' + (kdf_headers_.has_value() ? macaron::Base64::EncodeUrlSafe(result.data(), result.size()) : utils::collection::to_hex_string(result)); } encrypted_file_path_ += '/' + encrypted_file_name_; } auto encrypting_reader::create_iostream() const -> std::shared_ptr { return std::make_shared( std::make_unique(*this)); } auto encrypting_reader::get_kdf_config_for_data() const -> std::optional { REPERTORY_USES_FUNCTION_NAME(); if (not kdf_headers_.has_value()) { return std::nullopt; } kdf_config cfg; if (not kdf_config::from_header(kdf_headers_->first, cfg)) { throw utils::error::create_exception(function_name, { "invalid kdf header", }); } return cfg; } auto encrypting_reader::get_kdf_config_for_path() const -> std::optional { REPERTORY_USES_FUNCTION_NAME(); if (not kdf_headers_.has_value()) { return std::nullopt; } kdf_config cfg; if (not kdf_config::from_header(kdf_headers_->second, cfg)) { throw utils::error::create_exception(function_name, { "invalid kdf header", }); } return cfg; } auto encrypting_reader::reader_function(char *buffer, size_t size, size_t nitems) -> size_t { REPERTORY_USES_FUNCTION_NAME(); auto read_size = static_cast(size) * static_cast(nitems); if (read_size == 0U) { return 0U; } std::span dest(buffer, read_size); auto read_offset{read_offset_}; std::size_t total_read{}; auto total_size{total_size_}; if (kdf_headers_.has_value()) { auto &hdr = kdf_headers_->first; total_size -= hdr.size(); if (read_offset < hdr.size()) { auto to_read{ utils::calculate_read_size(hdr.size(), read_size, read_offset), }; read_offset_ += to_read; std::memcpy(&dest[total_read], &hdr.at(read_offset), to_read); if (read_size - to_read == 0) { return to_read; } read_offset = 0U; read_size -= to_read; total_read += to_read; } else { read_offset -= hdr.size(); } } auto chunk = static_cast(read_offset / encrypted_chunk_size_); auto chunk_offset = static_cast(read_offset % encrypted_chunk_size_); auto remain = utils::calculate_read_size(total_size, read_size, read_offset); auto ret{false}; if (read_offset < total_size) { try { ret = true; while (not get_stop_requested() && ret && (remain != 0U)) { if (not chunk_buffers_.contains(chunk)) { auto &chunk_buffer = chunk_buffers_[chunk]; data_buffer file_data(chunk == last_data_chunk_ ? last_data_chunk_size_ : data_chunk_size_); chunk_buffer.resize(file_data.size() + encryption_header_size); std::size_t bytes_read{}; ret = source_file_->read( file_data, static_cast(chunk) * static_cast(data_chunk_size_), &bytes_read); if (ret) { utils::encryption::encrypt_data(iv_list_.at(chunk), keys_.first, file_data, chunk_buffer); } } else if (chunk != 0U) { chunk_buffers_.erase(chunk - 1U); } auto &chunk_buffer = chunk_buffers_[chunk]; auto to_read = std::min(chunk_buffer.size() - chunk_offset, remain); std::memcpy(&dest[total_read], &chunk_buffer[chunk_offset], to_read); total_read += to_read; remain -= to_read; chunk_offset = 0U; ++chunk; read_offset_ += to_read; } } catch (const std::exception &e) { utils::error::handle_exception(function_name, e); ret = false; } catch (...) { utils::error::handle_exception(function_name); ret = false; } } return get_stop_requested() ? static_cast(CURL_READFUNC_ABORT) : ret ? total_read : error_return_; } } // namespace repertory::utils::encryption #endif // defined(PROJECT_ENABLE_LIBSODIUM) && defined(PROJECT_ENABLE_BOOST)