pion-net  4.0.9
Public Member Functions | Protected Member Functions | Static Protected Member Functions
pion::net::HTTPBasicAuth Class Reference

#include <HTTPBasicAuth.hpp>

Inherits pion::net::HTTPAuth.

List of all members.

Public Member Functions

 HTTPBasicAuth (PionUserManagerPtr userManager, const std::string &realm="PION:NET")
 default constructor
virtual ~HTTPBasicAuth ()
 virtual destructor
virtual bool handleRequest (HTTPRequestPtr &request, TCPConnectionPtr &tcp_conn)
virtual void setOption (const std::string &name, const std::string &value)

Protected Member Functions

void handleUnauthorized (HTTPRequestPtr &http_request, TCPConnectionPtr &tcp_conn)

Static Protected Member Functions

static bool parseAuthorization (std::string const &authorization, std::string &credentials)
static bool parseCredentials (std::string const &credentials, std::string &username, std::string &password)

Detailed Description

HTTPBasicAuth: a base class for handling HTTP Authentication and session management in accordance with RFC 2617 http://tools.ietf.org/html/rfc2617

Definition at line 27 of file HTTPBasicAuth.hpp.


Member Function Documentation

bool pion::net::HTTPBasicAuth::handleRequest ( HTTPRequestPtr &  request,
TCPConnectionPtr &  tcp_conn 
) [virtual]

attempts to validate authentication of a new HTTP request. If request valid, pointer to user identity object (if any) will be preserved in the request and return "true". If request not authenticated, appropriate response is sent over tcp_conn and return "false";

Parameters:
requestthe new HTTP request to handle
tcp_connthe TCP connection that has the new request
Returns:
true if request valid and user identity inserted into request

Implements pion::net::HTTPAuth.

Definition at line 35 of file HTTPBasicAuth.cpp.

References handleUnauthorized(), pion::net::HTTPAuth::m_user_manager, pion::net::HTTPAuth::needAuthentication(), parseAuthorization(), and parseCredentials().

void pion::net::HTTPBasicAuth::handleUnauthorized ( HTTPRequestPtr &  http_request,
TCPConnectionPtr &  tcp_conn 
) [protected]

used to send responses when access to resource is not authorized

Parameters:
http_requestthe new HTTP request to handle
tcp_connthe TCP connection that has the new request

Definition at line 133 of file HTTPBasicAuth.cpp.

References pion::net::HTTPResponseWriter::create(), and pion::net::TCPConnection::finish().

Referenced by handleRequest().

bool pion::net::HTTPBasicAuth::parseAuthorization ( std::string const &  authorization,
std::string &  credentials 
) [static, protected]

extracts base64 user credentials from authorization string

Parameters:
authorizationvalue of the HEADER_AUTHORIZATION

Definition at line 104 of file HTTPBasicAuth.cpp.

Referenced by handleRequest().

bool pion::net::HTTPBasicAuth::parseCredentials ( std::string const &  credentials,
std::string &  username,
std::string &  password 
) [static, protected]

parse base64 credentials and extract username/password

Definition at line 114 of file HTTPBasicAuth.cpp.

References pion::algo::base64_decode().

Referenced by handleRequest().

void pion::net::HTTPBasicAuth::setOption ( const std::string &  name,
const std::string &  value 
) [virtual]

sets a configuration option Valid options:

  • "domain" - name of authentication domain
Parameters:
namethe name of the option to change
valuethe value of the option

Reimplemented from pion::net::HTTPAuth.

Definition at line 96 of file HTTPBasicAuth.cpp.


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