ARCHIVE/clio
1
0
Fork 0
mirror of https://github.com/XRPLF/clio.git synced 2025-11-04 11:55:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: Create interface for DOSGuard (#1602)

Browse Source 
For #919.
This commit is contained in:
Sergey Kuznetsov
2024-08-13 17:26:47 +01:00
committed by GitHub
parent 49e9d5eda0
commit b7c8ed7e3a
26 changed files with 535 additions and 270 deletions
Download Patch File Download Diff File Expand all files Collapse all files

128
tests/unit/web/dosguard/DOSGuardTests.cpp Normal file
View File

@@ -0,0 +1,128 @@
//------------------------------------------------------------------------------
/*
This file is part of clio: https://github.com/XRPLF/clio
Copyright (c) 2022, 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 "util/LoggerFixtures.hpp"
#include "util/config/Config.hpp"
#include "web/dosguard/DOSGuard.hpp"
#include "web/dosguard/WhitelistHandlerInterface.hpp"
#include <boost/json/parse.hpp>
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <string_view>
using namespace testing;
using namespace util;
using namespace std;
using namespace web::dosguard;
namespace json = boost::json;
struct DOSGuardTest : NoLoggerFixture {
static constexpr auto JSONData = R"JSON(
{
"dos_guard": {
"max_fetches": 100,
"max_connections": 2,
"max_requests": 3,
"whitelist": [
"127.0.0.1"
]
}
}
)JSON";
static constexpr auto IP = "127.0.0.2";
struct MockWhitelistHandler : WhitelistHandlerInterface {
MOCK_METHOD(bool, isWhiteListed, (std::string_view ip), (const));
};
Config cfg{json::parse(JSONData)};
NiceMock<MockWhitelistHandler> whitelistHandler;
DOSGuard guard{cfg, whitelistHandler};
};
TEST_F(DOSGuardTest, Whitelisting)
{
EXPECT_CALL(whitelistHandler, isWhiteListed("127.0.0.1")).Times(1).WillOnce(Return(false));
EXPECT_FALSE(guard.isWhiteListed("127.0.0.1"));
EXPECT_CALL(whitelistHandler, isWhiteListed("127.0.0.1")).Times(1).WillOnce(Return(true));
EXPECT_TRUE(guard.isWhiteListed("127.0.0.1"));
}
TEST_F(DOSGuardTest, ConnectionCount)
{
EXPECT_TRUE(guard.isOk(IP));
guard.increment(IP); // one connection
EXPECT_TRUE(guard.isOk(IP));
guard.increment(IP); // two connections
EXPECT_TRUE(guard.isOk(IP));
guard.increment(IP); // > two connections, can't connect more
EXPECT_FALSE(guard.isOk(IP));
guard.decrement(IP);
EXPECT_TRUE(guard.isOk(IP)); // can connect again
}
TEST_F(DOSGuardTest, FetchCount)
{
EXPECT_TRUE(guard.add(IP, 50)); // half of allowence
EXPECT_TRUE(guard.add(IP, 50)); // now fully charged
EXPECT_FALSE(guard.add(IP, 1)); // can't add even 1 anymore
EXPECT_FALSE(guard.isOk(IP));
guard.clear(); // force clear the above fetch count
EXPECT_TRUE(guard.isOk(IP)); // can fetch again
}
TEST_F(DOSGuardTest, ClearFetchCountOnTimer)
{
EXPECT_TRUE(guard.add(IP, 50)); // half of allowence
EXPECT_TRUE(guard.add(IP, 50)); // now fully charged
EXPECT_FALSE(guard.add(IP, 1)); // can't add even 1 anymore
EXPECT_FALSE(guard.isOk(IP));
guard.clear(); // pretend sweep called from timer
EXPECT_TRUE(guard.isOk(IP)); // can fetch again
}
TEST_F(DOSGuardTest, RequestLimit)
{
EXPECT_TRUE(guard.request(IP));
EXPECT_TRUE(guard.request(IP));
EXPECT_TRUE(guard.request(IP));
EXPECT_TRUE(guard.isOk(IP));
EXPECT_FALSE(guard.request(IP));
EXPECT_FALSE(guard.isOk(IP));
guard.clear();
EXPECT_TRUE(guard.isOk(IP)); // can request again
}
TEST_F(DOSGuardTest, RequestLimitOnTimer)
{
EXPECT_TRUE(guard.request(IP));
EXPECT_TRUE(guard.request(IP));
EXPECT_TRUE(guard.request(IP));
EXPECT_TRUE(guard.isOk(IP));
EXPECT_FALSE(guard.request(IP));
EXPECT_FALSE(guard.isOk(IP));
guard.clear();
EXPECT_TRUE(guard.isOk(IP)); // can request again
}