Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
web::PasswordAdminVerificationStrategy Class Reference

Admin verification strategy that checks the password from the request header. More...

#include <AdminVerificationStrategy.hpp>

Inheritance diagram for web::PasswordAdminVerificationStrategy:
Collaboration diagram for web::PasswordAdminVerificationStrategy:

Public Member Functions

 PasswordAdminVerificationStrategy (std::string const &password)
 Construct a new PasswordAdminVerificationStrategy object.
 
bool isAdmin (RequestHeader const &request, std::string_view) const override
 Checks whether request is from a host that is considered authorized as admin using the password (if any) from the request.
 
- Public Member Functions inherited from web::AdminVerificationStrategy

Static Public Attributes

static constexpr std::string_view kPASSWORD_PREFIX = "Password "
 The prefix for the password in the request header.
 

Additional Inherited Members

- Public Types inherited from web::AdminVerificationStrategy
using RequestHeader = boost::beast::http::request<boost::beast::http::string_body>::header_type
 

Detailed Description

Admin verification strategy that checks the password from the request header.

Constructor & Destructor Documentation

◆ PasswordAdminVerificationStrategy()

web::PasswordAdminVerificationStrategy::PasswordAdminVerificationStrategy ( std::string const & password)

Construct a new PasswordAdminVerificationStrategy object.

Parameters
passwordThe password to check

Member Function Documentation

◆ isAdmin()

bool web::PasswordAdminVerificationStrategy::isAdmin ( RequestHeader const & request,
std::string_view  ) const
overridevirtual

Checks whether request is from a host that is considered authorized as admin using the password (if any) from the request.

Parameters
requestThe request from a host
Returns
true if the password from request matches admin password from config

Implements web::AdminVerificationStrategy.


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