Ark Server API (ASE) - Wiki
Loading...
Searching...
No Matches
Poco::Net::InvalidCertificateHandler Class Referenceabstract

#include <InvalidCertificateHandler.h>

+ Inheritance diagram for Poco::Net::InvalidCertificateHandler:

Public Member Functions

 InvalidCertificateHandler (bool handleErrorsOnServerSide)
 
virtual ~InvalidCertificateHandler ()
 
virtual void onInvalidCertificate (const void *pSender, VerificationErrorArgs &errorCert)=0
 Destroys the InvalidCertificateHandler.
 

Protected Attributes

bool _handleErrorsOnServerSide
 

Detailed Description

A InvalidCertificateHandler is invoked whenever an error occurs verifying the certificate. It allows the user to inspect and accept/reject the certificate. One can install one's own InvalidCertificateHandler by implementing this interface. Note that in the implementation file of the subclass the following code must be present (assuming you use the namespace My_API and the name of your handler class is MyGuiHandler):

#include "Poco/Net/CertificateHandlerFactory.h" ... POCO_REGISTER_CHFACTORY(My_API, MyGuiHandler)

One can either set the handler directly in the startup code of the main method of ones application by calling

SSLManager::instance().initialize(mypassphraseHandler, myguiHandler, mySSLContext)

or in case one uses Poco::Util::Application one can rely on an XML configuration and put the following entry under the path openSSL.invalidCertificateHandler:

<invalidCertificateHandler> <name>MyGuiHandler<name> <options> [...] // Put optional config params for the handler here </options> </invalidCertificateHandler>

Note that the name of the InvalidCertificateHandler must be same as the one provided to the POCO_REGISTER_CHFACTORY macro.

Definition at line 31 of file InvalidCertificateHandler.h.

Constructor & Destructor Documentation

◆ InvalidCertificateHandler()

Poco::Net::InvalidCertificateHandler::InvalidCertificateHandler ( bool handleErrorsOnServerSide)

◆ ~InvalidCertificateHandler()

virtual Poco::Net::InvalidCertificateHandler::~InvalidCertificateHandler ( )
virtual

Creates the InvalidCertificateHandler.

Set handleErrorsOnServerSide to true if the certificate handler is used on the server side. Automatically registers at one of the SSLManager::VerificationError events.

Member Function Documentation

◆ onInvalidCertificate()

virtual void Poco::Net::InvalidCertificateHandler::onInvalidCertificate ( const void * pSender,
VerificationErrorArgs & errorCert )
pure virtual

Member Data Documentation

◆ _handleErrorsOnServerSide

bool Poco::Net::InvalidCertificateHandler::_handleErrorsOnServerSide
protected

Receives the questionable certificate in parameter errorCert. If one wants to accept the certificate, call errorCert.setIgnoreError(true).

Definition at line 73 of file InvalidCertificateHandler.h.


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