A simple PeerConnector for Secure ICAP services. No SslBump capabilities. More...

Inheritance diagram for Ssl::IcapPeerConnector:
Collaboration diagram for Ssl::IcapPeerConnector:

Public Types

typedef CbcPointer< PeerConnectorPointer
 

Public Member Functions

 IcapPeerConnector (Adaptation::Icap::ServiceRep::Pointer &service, const Comm::ConnectionPointer &aServerConn, AsyncCall::Pointer &aCallback, AccessLogEntry::Pointer const &alp, const time_t timeout=0)
 
virtual bool initialize (Security::SessionPointer &)
 
virtual void noteNegotiationDone (ErrorState *error)
 
virtual Security::ContextPointer getTlsContext ()
 
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
 
void callStart (AsyncCall &call)
 
virtual void callEnd ()
 called right after the called job method More...
 
virtual void callException (const std::exception &e)
 called when the job throws during an async call More...
 
virtual void * toCbdata ()=0
 

Static Public Member Functions

static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...
 

Public Attributes

bool noteFwdPconnUse
 hack: whether the connection requires fwdPconnPool->noteUses() More...
 

Protected Member Functions

virtual void start ()
 Preps connection and SSL state. Calls negotiate(). More...
 
virtual bool doneAll () const
 whether positive goal has been reached More...
 
virtual void swanSong ()
 
virtual const char * status () const
 internal cleanup; do not call directly More...
 
void commTimeoutHandler (const CommTimeoutCbParams &)
 The connection read timeout callback handler. More...
 
void commCloseHandler (const CommCloseCbParams &params)
 The comm_close callback handler. More...
 
void negotiate ()
 
bool sslFinalized ()
 
void handleNegotiateError (const int result)
 
void noteWantRead ()
 
bool checkForMissingCertificates ()
 
void startCertDownloading (SBuf &url)
 Start downloading procedure for the given URL. More...
 
void certDownloadingDone (SBuf &object, int status)
 Called by Downloader after a certificate object downloaded. More...
 
virtual void noteWantWrite ()
 
virtual void noteNegotiationError (const int result, const int ssl_error, const int ssl_lib_error)
 
const Comm::ConnectionPointerserverConnection () const
 mimics FwdState to minimize changes to FwdState::initiate/negotiateSsl More...
 
void bail (ErrorState *error)
 sends the given error to the initiator More...
 
void sendSuccess ()
 sends the encrypted connection to the initiator More...
 
void callBack ()
 a bail(), sendSuccess() helper: sends results to the initiator More...
 
void disconnect ()
 a bail(), sendSuccess() helper: stops monitoring the connection More...
 
void bypassCertValidator ()
 If called the certificates validator will not used. More...
 
void recordNegotiationDetails ()
 
void deleteThis (const char *aReason)
 
void mustStop (const char *aReason)
 
bool done () const
 the job is destroyed in callEnd() when done() More...
 

Protected Attributes

HttpRequestPointer request
 peer connection trigger or cause More...
 
Comm::ConnectionPointer serverConn
 TCP connection to the peer. More...
 
AccessLogEntryPointer al
 info for the future access.log entry More...
 
AsyncCall::Pointer callback
 we call this with the results More...
 
const char * stopReason
 reason for forcing done() to be true More...
 
const char * typeName
 kid (leaf) class name, for debugging More...
 
AsyncCall::Pointer inCall
 the asynchronous call being handled, if any More...
 
const InstanceId< AsyncJobid
 job identifier More...
 

Private Member Functions

 CBDATA_CLASS (IcapPeerConnector)
 
void sslCrtvdHandleReply (Ssl::CertValidationResponsePointer)
 Process response from cert validator helper. More...
 
Security::CertErrorssslCrtvdCheckForErrors (Ssl::CertValidationResponse const &, Ssl::ErrorDetail *&)
 Check SSL errors returned from cert validator against sslproxy_cert_error access list. More...
 
void negotiateSsl ()
 Comm::SetSelect() callback. Direct calls tickle/resume negotiations. More...
 

Static Private Member Functions

static void NegotiateSsl (int fd, void *data)
 A wrapper for Comm::SetSelect() notifications. More...
 

Private Attributes

Adaptation::Icap::ServiceRep::Pointer icapService
 
AsyncCall::Pointer closeHandler
 we call this when the connection closed More...
 
time_t negotiationTimeout
 the SSL connection timeout to use More...
 
time_t startTime
 when the peer connector negotiation started More...
 
bool useCertValidator_
 
std::queue< SBufurlsOfMissingCerts
 The list of URLs where missing certificates should be downloaded. More...
 
unsigned int certsDownloads
 the number of downloaded missing certificates More...
 

Static Private Attributes

static const unsigned int MaxCertsDownloads = 10
 The maximum allowed missing certificates downloads. More...
 
static const unsigned int MaxNestedDownloads = 3
 The maximum allowed nested certificates downloads. More...
 

Detailed Description

Definition at line 50 of file Xaction.cc.

Member Typedef Documentation

◆ Pointer

Definition at line 46 of file PeerConnector.h.

Constructor & Destructor Documentation

◆ IcapPeerConnector()

Ssl::IcapPeerConnector::IcapPeerConnector ( Adaptation::Icap::ServiceRep::Pointer service,
const Comm::ConnectionPointer aServerConn,
AsyncCall::Pointer aCallback,
AccessLogEntry::Pointer const &  alp,
const time_t  timeout = 0 
)
inline

Definition at line 53 of file Xaction.cc.

Member Function Documentation

◆ bail()

void Security::PeerConnector::bail ( ErrorState error)
protectedinherited

◆ bypassCertValidator()

void Security::PeerConnector::bypassCertValidator ( )
inlineprotectedinherited

Definition at line 152 of file PeerConnector.h.

References Security::PeerConnector::useCertValidator_.

◆ callBack()

void Security::PeerConnector::callBack ( )
protectedinherited

◆ callEnd()

void AsyncJob::callEnd ( )
virtualinherited

◆ callException()

◆ callStart()

void AsyncJob::callStart ( AsyncCall call)
inherited

◆ canBeCalled()

bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

References AsyncCall::cancel(), debugs, HERE(), AsyncJob::inCall, and NULL.

◆ CBDATA_CLASS()

Ssl::IcapPeerConnector::CBDATA_CLASS ( IcapPeerConnector  )
private

◆ certDownloadingDone()

void Security::PeerConnector::certDownloadingDone ( SBuf object,
int  status 
)
protectedinherited

◆ checkForMissingCertificates()

bool Security::PeerConnector::checkForMissingCertificates ( )
protectedinherited

Run the certificates list sent by the SSL server and check if there are missing certificates. Adds to the urlOfMissingCerts list the URLS of missing certificates if this information provided by the issued certificates with Authority Info Access extension.

Definition at line 702 of file PeerConnector.cc.

References BIO_get_data(), debugs, fd_table, Ssl::missingChainCertificatesUrls(), Downloader::nestedLevel(), request(), and Ssl::ServerBio::serverCertificatesIfAny().

◆ commCloseHandler()

void Security::PeerConnector::commCloseHandler ( const CommCloseCbParams params)
protectedinherited

◆ commTimeoutHandler()

void Security::PeerConnector::commTimeoutHandler ( const CommTimeoutCbParams )
protectedinherited

◆ deleteThis()

void AsyncJob::deleteThis ( const char *  aReason)
protectedinherited

◆ disconnect()

void Security::PeerConnector::disconnect ( )
protectedinherited

Definition at line 568 of file PeerConnector.cc.

References comm_remove_close_handler(), and commUnsetConnTimeout().

◆ done()

bool AsyncJob::done ( ) const
protectedinherited

◆ doneAll()

bool Security::PeerConnector::doneAll ( ) const
protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 59 of file PeerConnector.cc.

References callback, and AsyncJob::doneAll().

◆ getTlsContext()

virtual Security::ContextPointer Ssl::IcapPeerConnector::getTlsContext ( )
inlinevirtual

Must implemented by the kid classes to return the TLS context object to use for building the encryption context objects.

Implements Security::PeerConnector.

Definition at line 65 of file Xaction.cc.

References icapService.

◆ handleNegotiateError()

void Security::PeerConnector::handleNegotiateError ( const int  result)
protectedinherited

Called when the negotiation step aborted because data needs to be transferred to/from server or on error. In the first case setups the appropriate Comm::SetSelect handler. In second case fill an error and report to the PeerConnector caller.

Definition at line 382 of file PeerConnector.cc.

References DBG_IMPORTANT, debugs, fd_table, and Must.

◆ initialize()

bool Ssl::IcapPeerConnector::initialize ( Security::SessionPointer serverSession)
virtual

◆ mustStop()

◆ negotiate()

void Security::PeerConnector::negotiate ( )
protectedinherited

Performs a single secure connection negotiation step. It is called multiple times until the negotiation finishes or aborts.

Definition at line 170 of file PeerConnector.cc.

References debugs, and fd_table.

◆ negotiateSsl()

void Security::PeerConnector::negotiateSsl ( )
privateinherited

Definition at line 375 of file PeerConnector.cc.

References CallJobHere.

◆ NegotiateSsl()

void Security::PeerConnector::NegotiateSsl ( int  fd,
void *  data 
)
staticprivateinherited

Definition at line 365 of file PeerConnector.cc.

References data.

◆ noteNegotiationDone()

void Ssl::IcapPeerConnector::noteNegotiationDone ( ErrorState error)
virtual

Called when the SSL negotiation to the server completed and the certificates validated using the cert validator.

Parameters
errorif not NULL the SSL negotiation was aborted with an error

Reimplemented from Security::PeerConnector.

Definition at line 728 of file Xaction.cc.

References error(), fd_table, and Security::MaybeGetSessionResumeData().

◆ noteNegotiationError()

void Security::PeerConnector::noteNegotiationError ( const int  result,
const int  ssl_error,
const int  ssl_lib_error 
)
protectedvirtualinherited

Called when the SSL_connect function aborts with an SSL negotiation error

Parameters
resultthe SSL_connect return code
ssl_errorthe error code returned from the SSL_get_error function
ssl_lib_errorthe error returned from the ERR_Get_Error function

Reimplemented in Ssl::PeekingPeerConnector.

Definition at line 493 of file PeerConnector.cc.

References DBG_IMPORTANT, debugs, ERR_SECURE_CONNECT_FAIL, Security::ErrorString(), fd_table, ErrorState::NewForwarding(), NULL, request(), SQUID_ERR_SSL_HANDSHAKE, and ssl_ex_index_ssl_error_detail.

Referenced by Ssl::PeekingPeerConnector::noteNegotiationError().

◆ noteWantRead()

void Security::PeerConnector::noteWantRead ( )
protectedinherited

Called when the openSSL SSL_connect fnction request more data from the remote SSL server. Sets the read timeout and sets the Squid COMM_SELECT_READ handler.

Definition at line 446 of file PeerConnector.cc.

References BIO_get_data(), COMM_SELECT_READ, commSetConnTimeout(), Security::PeerConnector::commTimeoutHandler(), DBG_IMPORTANT, debugs, fd_table, Ssl::ServerBio::gotHello(), Ssl::ServerBio::gotHelloFailed(), Ssl::ServerBio::holdRead(), JobCallback, Comm::MortalReadTimeout(), and Comm::SetSelect().

◆ noteWantWrite()

void Security::PeerConnector::noteWantWrite ( )
protectedvirtualinherited

Called when the openSSL SSL_connect function needs to write data to the remote SSL server. Sets the Squid COMM_SELECT_WRITE handler.

Reimplemented in Ssl::PeekingPeerConnector.

Definition at line 484 of file PeerConnector.cc.

References COMM_SELECT_WRITE, debugs, and Comm::SetSelect().

Referenced by Ssl::PeekingPeerConnector::checkForPeekAndSpliceMatched(), and Ssl::PeekingPeerConnector::noteWantWrite().

◆ recordNegotiationDetails()

void Security::PeerConnector::recordNegotiationDetails ( )
protectedinherited

Called after negotiation finishes to record connection details for logging

Definition at line 152 of file PeerConnector.cc.

References BIO_get_data(), fd_table, and Ssl::ServerBio::receivedHelloDetails().

◆ sendSuccess()

void Security::PeerConnector::sendSuccess ( )
protectedinherited

Definition at line 561 of file PeerConnector.cc.

◆ serverConnection()

const Comm::ConnectionPointer& Security::PeerConnector::serverConnection ( ) const
inlineprotectedinherited

◆ sslCrtvdCheckForErrors()

Security::CertErrors * Security::PeerConnector::sslCrtvdCheckForErrors ( Ssl::CertValidationResponse const &  resp,
Ssl::ErrorDetail *&  errDetails 
)
privateinherited

◆ sslCrtvdHandleReply()

◆ sslFinalized()

bool Security::PeerConnector::sslFinalized ( )
protectedinherited

Called after negotiation has finished. Cleans up TLS/SSL state. Returns false if we are now waiting for the certs validation job. Otherwise, returns true, regardless of negotiation success/failure.

Definition at line 214 of file PeerConnector.cc.

References asyncCall(), DBG_IMPORTANT, debugs, Ssl::CertValidationRequest::domainName, ERR_GATEWAY_FAILURE, Ssl::CertValidationRequest::errors, fd_table, NULL, request(), Http::scInternalServerError, Ssl::CertValidationRequest::ssl, ssl_ex_index_server, ssl_ex_index_ssl_errors, Security::PeerConnector::sslCrtvdHandleReply(), Ssl::CertValidationHelper::Submit(), and Ssl::TheConfig.

◆ start()

void Security::PeerConnector::start ( )
protectedvirtualinherited

Reimplemented from AsyncJob.

Definition at line 66 of file PeerConnector.cc.

References assert, debugs, ERR_CONNECT_FAIL, fd_table, Comm::IsConnOpen(), request(), Http::scBadGateway, and AsyncJob::start().

◆ Start()

◆ startCertDownloading()

void Security::PeerConnector::startCertDownloading ( SBuf url)
protectedinherited

◆ status()

const char * Security::PeerConnector::status ( ) const
protectedvirtualinherited

for debugging, starts with space

Reimplemented from AsyncJob.

Definition at line 608 of file PeerConnector.cc.

References buf, and NULL.

◆ swanSong()

void Security::PeerConnector::swanSong ( )
protectedvirtualinherited

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

◆ al

AccessLogEntryPointer Security::PeerConnector::al
protectedinherited

Definition at line 160 of file PeerConnector.h.

◆ callback

AsyncCall::Pointer Security::PeerConnector::callback
protectedinherited

Definition at line 161 of file PeerConnector.h.

Referenced by Security::PeerConnector::PeerConnector().

◆ certsDownloads

unsigned int Security::PeerConnector::certsDownloads
privateinherited

Definition at line 188 of file PeerConnector.h.

◆ closeHandler

AsyncCall::Pointer Security::PeerConnector::closeHandler
privateinherited

Definition at line 182 of file PeerConnector.h.

Referenced by Security::PeerConnector::PeerConnector().

◆ icapService

Adaptation::Icap::ServiceRep::Pointer Ssl::IcapPeerConnector::icapService
private

Definition at line 70 of file Xaction.cc.

Referenced by getTlsContext().

◆ id

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ inCall

AsyncCall::Pointer AsyncJob::inCall
protectedinherited

◆ MaxCertsDownloads

const unsigned int Security::PeerConnector::MaxCertsDownloads = 10
staticprivateinherited

Definition at line 178 of file PeerConnector.h.

◆ MaxNestedDownloads

const unsigned int Security::PeerConnector::MaxNestedDownloads = 3
staticprivateinherited

Definition at line 180 of file PeerConnector.h.

◆ negotiationTimeout

time_t Security::PeerConnector::negotiationTimeout
privateinherited

Definition at line 183 of file PeerConnector.h.

◆ noteFwdPconnUse

bool Security::PeerConnector::noteFwdPconnUse
inherited

Definition at line 65 of file PeerConnector.h.

◆ request

HttpRequestPointer Security::PeerConnector::request
protectedinherited

◆ serverConn

Comm::ConnectionPointer Security::PeerConnector::serverConn
protectedinherited

◆ startTime

time_t Security::PeerConnector::startTime
privateinherited

Definition at line 184 of file PeerConnector.h.

◆ stopReason

const char* AsyncJob::stopReason
protectedinherited

◆ typeName

◆ urlsOfMissingCerts

std::queue<SBuf> Security::PeerConnector::urlsOfMissingCerts
privateinherited

Definition at line 187 of file PeerConnector.h.

◆ useCertValidator_

bool Security::PeerConnector::useCertValidator_
privateinherited

whether the certificate validator should bypassed

Definition at line 185 of file PeerConnector.h.

Referenced by Security::PeerConnector::bypassCertValidator().


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors