HttpAuthRealm Class Reference

Authentication Realm. More...

#include <http_auth_realm.h>

Public Member Functions
	HttpAuthRealm (const std::string &name, const std::string &require, const std::string &method, const std::string &backend)
std::string	name () const
	name of the auth realm. More...
std::string	require () const
	require notitation of the realm More...
std::string	method () const
	Authentication Method name. More...
std::string	backend () const
	Authentication Backend name. More...
std::error_code	authenticate (const std::string &username, const std::string &password) const
	authenticate a user in a realm. More...

Private Attributes
std::string	name_
std::string	require_
std::string	method_
std::string	backend_

Detailed Description

Authentication Realm.

multiple areas in the HTTP server may have the same required authentication. They are in the same 'realm'.

A realm has

• a name
• a requirement
• a backend
• a required authentication method

Constructor & Destructor Documentation

HttpAuthRealm()

HttpAuthRealm::HttpAuthRealm ( const std::string &  name, const std::string &  require, const std::string &  method, const std::string &  backend  )

inline

Member Function Documentation

authenticate()

std::error_code HttpAuthRealm::authenticate	(	const std::string &	username,
		const std::string &	password
	)		const

authenticate a user in a realm.

Returns

error-code

Return values

0	authentication without error

backend()

std::string HttpAuthRealm::backend ( ) const

inline

Authentication Backend name.

• file

method()

std::string HttpAuthRealm::method ( ) const

inline

Authentication Method name.

• basic

name()

std::string HttpAuthRealm::name ( ) const

inline

name of the auth realm.

require()

std::string HttpAuthRealm::require ( ) const

inline

require notitation of the realm

Member Data Documentation

backend_

std::string HttpAuthRealm::backend_

private

method_

std::string HttpAuthRealm::method_

private

name_

std::string HttpAuthRealm::name_

private

require_

std::string HttpAuthRealm::require_

private

---

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

• router/src/http/src/http_auth_realm.h
• router/src/http/src/http_auth_realm.cc