caffa::rpc::RestAuthenticator Class Reference

#include <cafRestAuthenticator.h>

Public Member Functions
virtual std::string	sslCertificate () const =0
virtual std::string	sslKey () const =0
virtual std::string	sslDhParameters () const =0
virtual bool	authenticate (const std::string &authorisationHeader) const =0

Detailed Description

An abstract autheticator which takes the HTTP authorisation header line and checks if this is acceptable. CAFFA only comes with an completly non-production-ready Demo Authenticator in the Examples section. Application developers have to implement their own (secure) authenticator. If any of the SSL-methods return a blank string, SSL will be disabled.

Member Function Documentation

authenticate()

virtual bool caffa::rpc::RestAuthenticator::authenticate ( const std::string &  authorisationHeader ) const

pure virtual

Perform authentication with the HTTP authorisation header line.

Parameters

authorisationHeader

The authorisation line. Contains both username and password separated by a colon.

sslCertificate()

virtual std::string caffa::rpc::RestAuthenticator::sslCertificate ( ) const

pure virtual

A SSL certificate. If left blank SSL will be disabled.

sslDhParameters()

virtual std::string caffa::rpc::RestAuthenticator::sslDhParameters ( ) const

pure virtual

SSL Diffie-Hellman parameters. If left blank SSL will be disabled.

sslKey()

virtual std::string caffa::rpc::RestAuthenticator::sslKey ( ) const

pure virtual

A SSL private key. If left blank SSL will be disabled.

---

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

• RestInterface/cafRestAuthenticator.h