A simple handler to add/check elements in a whitelist. More...

Inheritance diagram for web::dosguard::WhitelistHandler:

Collaboration diagram for web::dosguard::WhitelistHandler:

Public Member Functions
	WhitelistHandler (Whitelist whitelist)
	Constructs a WhitelistHandler from an already-built Whitelist.
bool	isWhiteListed (std::string_view ip) const override
	Checks to see if the given IP is whitelisted.
Public Member Functions inherited from web::dosguard::WhitelistHandlerInterface
virtual	~WhitelistHandlerInterface ()=default
	Virtual destructor.

Static Public Member Functions
template<SomeResolver HostnameResolverType = Resolver>
static std::expected< WhitelistHandler, std::string >	create (util::config::ClioConfigDefinition const &config, HostnameResolverType &&resolver={})
	Creates a WhitelistHandler by loading all whitelisted IPs and masks from config.

Detailed Description

A simple handler to add/check elements in a whitelist.

Constructor & Destructor Documentation

web::dosguard::WhitelistHandler::WhitelistHandler ( Whitelist whitelist )

explicit

Constructs a WhitelistHandler from an already-built Whitelist.

Parameters

whitelist The whitelist to use

template<SomeResolver HostnameResolverType = Resolver>

std::expected< WhitelistHandler, std::string > web::dosguard::WhitelistHandler::create	(	util::config::ClioConfigDefinition const &	config,
		HostnameResolverType &&	resolver = {} )

inlinestatic

Creates a WhitelistHandler by loading all whitelisted IPs and masks from config.

Parameters

config	The Clio config to use
resolver	The resolver to use for hostname resolution

Returns: The WhitelistHandler on success, or an error string if any whitelist entry is invalid

bool web::dosguard::WhitelistHandler::isWhiteListed ( std::string_view ip ) const

inlinenodiscardoverridevirtual

Checks to see if the given IP is whitelisted.

Parameters

ip	The IP to check

The documentation for this class was generated from the following files: