-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: Create interface for DOSGuard (#1602)
For #919.
- Loading branch information
Showing
26 changed files
with
535 additions
and
270 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,15 @@ | ||
| add_library(clio_web) | ||
|
|
||
| target_sources( | ||
| clio_web PRIVATE impl/AdminVerificationStrategy.cpp impl/ServerSslContext.cpp IntervalSweepHandler.cpp Resolver.cpp | ||
| Server.cpp | ||
| clio_web | ||
| PRIVATE Resolver.cpp | ||
| Server.cpp | ||
| dosguard/DOSGuard.cpp | ||
| dosguard/IntervalSweepHandler.cpp | ||
| dosguard/WhitelistHandler.cpp | ||
| impl/AdminVerificationStrategy.cpp | ||
| impl/ServerSslContext.cpp | ||
| ng/Server.cpp | ||
| ) | ||
|
|
||
| target_link_libraries(clio_web PUBLIC clio_util) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| //------------------------------------------------------------------------------ | ||
| /* | ||
| This file is part of clio: https://github.com/XRPLF/clio | ||
| Copyright (c) 2024, the clio developers. | ||
| Permission to use, copy, modify, and distribute this software for any | ||
| purpose with or without fee is hereby granted, provided that the above | ||
| copyright notice and this permission notice appear in all copies. | ||
| THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
| WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
| MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
| ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
| ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
| OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
| */ | ||
| //============================================================================== | ||
|
|
||
| #include "web/dosguard/DOSGuard.hpp" | ||
|
|
||
| #include "util/Assert.hpp" | ||
| #include "util/config/Config.hpp" | ||
| #include "util/log/Logger.hpp" | ||
| #include "web/dosguard/WhitelistHandlerInterface.hpp" | ||
|
|
||
| #include <boost/iterator/transform_iterator.hpp> | ||
|
|
||
| #include <cstdint> | ||
| #include <functional> | ||
| #include <mutex> | ||
| #include <string> | ||
| #include <string_view> | ||
| #include <unordered_set> | ||
|
|
||
| namespace web::dosguard { | ||
|
|
||
| DOSGuard::DOSGuard(util::Config const& config, WhitelistHandlerInterface const& whitelistHandler) | ||
| : whitelistHandler_{std::cref(whitelistHandler)} | ||
| , maxFetches_{config.valueOr("dos_guard.max_fetches", DEFAULT_MAX_FETCHES)} | ||
| , maxConnCount_{config.valueOr("dos_guard.max_connections", DEFAULT_MAX_CONNECTIONS)} | ||
| , maxRequestCount_{config.valueOr("dos_guard.max_requests", DEFAULT_MAX_REQUESTS)} | ||
| { | ||
| } | ||
|
|
||
| [[nodiscard]] bool | ||
| DOSGuard::isWhiteListed(std::string_view const ip) const noexcept | ||
| { | ||
| return whitelistHandler_.get().isWhiteListed(ip); | ||
| } | ||
|
|
||
| [[nodiscard]] bool | ||
| DOSGuard::isOk(std::string const& ip) const noexcept | ||
| { | ||
| if (whitelistHandler_.get().isWhiteListed(ip)) | ||
| return true; | ||
|
|
||
| { | ||
| std::scoped_lock const lck(mtx_); | ||
| if (ipState_.find(ip) != ipState_.end()) { | ||
| auto [transferedByte, requests] = ipState_.at(ip); | ||
| if (transferedByte > maxFetches_ || requests > maxRequestCount_) { | ||
| LOG(log_.warn()) << "Dosguard: Client surpassed the rate limit. ip = " << ip | ||
| << " Transfered Byte: " << transferedByte << "; Requests: " << requests; | ||
| return false; | ||
| } | ||
| } | ||
| auto it = ipConnCount_.find(ip); | ||
| if (it != ipConnCount_.end()) { | ||
| if (it->second > maxConnCount_) { | ||
| LOG(log_.warn()) << "Dosguard: Client surpassed the rate limit. ip = " << ip | ||
| << " Concurrent connection: " << it->second; | ||
| return false; | ||
| } | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| void | ||
| DOSGuard::increment(std::string const& ip) noexcept | ||
| { | ||
| if (whitelistHandler_.get().isWhiteListed(ip)) | ||
| return; | ||
| std::scoped_lock const lck{mtx_}; | ||
| ipConnCount_[ip]++; | ||
| } | ||
|
|
||
| void | ||
| DOSGuard::decrement(std::string const& ip) noexcept | ||
| { | ||
| if (whitelistHandler_.get().isWhiteListed(ip)) | ||
| return; | ||
| std::scoped_lock const lck{mtx_}; | ||
| ASSERT(ipConnCount_[ip] > 0, "Connection count for ip {} can't be 0", ip); | ||
| ipConnCount_[ip]--; | ||
| if (ipConnCount_[ip] == 0) | ||
| ipConnCount_.erase(ip); | ||
| } | ||
|
|
||
| [[maybe_unused]] bool | ||
| DOSGuard::add(std::string const& ip, uint32_t numObjects) noexcept | ||
| { | ||
| if (whitelistHandler_.get().isWhiteListed(ip)) | ||
| return true; | ||
|
|
||
| { | ||
| std::scoped_lock const lck(mtx_); | ||
| ipState_[ip].transferedByte += numObjects; | ||
| } | ||
|
|
||
| return isOk(ip); | ||
| } | ||
|
|
||
| [[maybe_unused]] bool | ||
| DOSGuard::request(std::string const& ip) noexcept | ||
| { | ||
| if (whitelistHandler_.get().isWhiteListed(ip)) | ||
| return true; | ||
|
|
||
| { | ||
| std::scoped_lock const lck(mtx_); | ||
| ipState_[ip].requestsCount++; | ||
| } | ||
|
|
||
| return isOk(ip); | ||
| } | ||
|
|
||
| void | ||
| DOSGuard::clear() noexcept | ||
| { | ||
| std::scoped_lock const lck(mtx_); | ||
| ipState_.clear(); | ||
| } | ||
|
|
||
| [[nodiscard]] std::unordered_set<std::string> | ||
| DOSGuard::getWhitelist(util::Config const& config) | ||
| { | ||
| using T = std::unordered_set<std::string> const; | ||
| auto whitelist = config.arrayOr("dos_guard.whitelist", {}); | ||
| auto const transform = [](auto const& elem) { return elem.template value<std::string>(); }; | ||
| return T{ | ||
| boost::transform_iterator(std::begin(whitelist), transform), | ||
| boost::transform_iterator(std::end(whitelist), transform) | ||
| }; | ||
| } | ||
|
|
||
| } // namespace web::dosguard |
Oops, something went wrong.