#include <PeerConnector.h>

Inheritance diagram for Security::PeerConnector:
Collaboration diagram for Security::PeerConnector:

Classes

class  CbDialer
 Callback dialer API to allow PeerConnector to set the answer. More...
 

Public Types

typedef CbcPointer< AsyncJobPointer
 

Public Member Functions

 PeerConnector (const Comm::ConnectionPointer &aServerConn, AsyncCall::Pointer &aCallback, const AccessLogEntryPointer &alp, const time_t timeout=0)
 
virtual ~PeerConnector ()
 
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...
 

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 commCloseHandler (const CommCloseCbParams &params)
 The comm_close callback handler. More...
 
void connectionClosed (const char *reason)
 Inform us that the connection is closed. Does the required clean-up. More...
 
bool prepareSocket ()
 
void setReadTimeout ()
 
virtual bool initialize (Security::SessionPointer &)
 
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)
 
virtual void noteNegotiationDone (ErrorState *error)
 
virtual Security::ContextPointer getTlsContext ()=0
 
Comm::ConnectionPointer const & serverConnection () const
 mimics FwdState to minimize changes to FwdState::initiate/negotiateSsl More...
 
void bail (ErrorState *error)
 Return an error to the PeerConnector caller. More...
 
void callBack ()
 
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 (PeerConnector)
 
 PeerConnector (const PeerConnector &)
 
PeerConnectoroperator= (const PeerConnector &)
 
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...
 

Static Private Member Functions

static void NegotiateSsl (int fd, void *data)
 A wrapper function for negotiateSsl for use with Comm::SetSelect. More...
 

Private Attributes

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

Initiates encryption on a connection to peers or servers. Despite its name does not perform any connect(2) operations.

Contains common code and interfaces of various specialized PeerConnector's, including peer certificate validation code.

The caller receives a call back with Security::EncryptorAnswer. If answer.error is not nil, then there was an error and the encryption to the peer or server was not fully established. The error object is suitable for error response generation.
The caller must monitor the connection for closure because this job will not inform the caller about such events.
PeerConnector class currently supports a form of TLS negotiation timeout, which is accounted only when sets the read timeout from encrypted peers/servers. For a complete solution, the caller must monitor the overall connection establishment timeout and close the connection on timeouts. This is probably better than having dedicated (or none at all!) timeouts for peer selection, DNS lookup, TCP handshake, SSL handshake, etc. Some steps may have their own timeout, but not all steps should be forced to have theirs. XXX: tunnel.cc and probably other subsystems do not have an "overall connection establishment" timeout. We need to change their code so that they start monitoring earlier and close on timeouts. This change may need to be discussed on squid-dev.
This job never closes the connection, even on errors. If a 3rd-party closes the connection, this job simply quits without informing the caller.

Definition at line 63 of file PeerConnector.h.

Member Typedef Documentation

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

Security::PeerConnector::PeerConnector ( const Comm::ConnectionPointer aServerConn,
AsyncCall::Pointer aCallback,
const AccessLogEntryPointer alp,
const time_t  timeout = 0 
)

Definition at line 31 of file PeerConnector.cc.

References callback, debugs, AsyncCall::getDialer(), and Must.

Security::PeerConnector::~PeerConnector ( )
virtual

Definition at line 46 of file PeerConnector.cc.

References debugs.

Security::PeerConnector::PeerConnector ( const PeerConnector )
private

Member Function Documentation

void Security::PeerConnector::bail ( ErrorState error)
protected
void Security::PeerConnector::bypassCertValidator ( )
inlineprotected

Definition at line 172 of file PeerConnector.h.

References useCertValidator_.

void Security::PeerConnector::callBack ( )
protected

Callback the caller class, and pass the ready to communicate secure connection or an error if PeerConnector failed.

Definition at line 553 of file PeerConnector.cc.

References Security::PeerConnector::CbDialer::answer(), callback, comm_remove_close_handler(), Security::EncryptorAnswer::conn, debugs, AsyncCall::getDialer(), Must, NULL, and ScheduleCallHere.

void AsyncJob::callEnd ( )
virtualinherited
void AsyncJob::callStart ( AsyncCall call)
inherited
bool AsyncJob::canBeCalled ( AsyncCall call) const
inherited

Definition at line 101 of file AsyncJob.cc.

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

Security::PeerConnector::CBDATA_CLASS ( PeerConnector  )
private
void Security::PeerConnector::certDownloadingDone ( SBuf object,
int  status 
)
protected
bool Security::PeerConnector::checkForMissingCertificates ( )
protected

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 680 of file PeerConnector.cc.

References BIO_get_data(), Security::CertList, debugs, fd_table, Ssl::missingChainCertificatesUrls(), Downloader::nestedLevel(), and request().

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

Definition at line 71 of file PeerConnector.cc.

References CommCommonCbParams::data, debugs, and CommCommonCbParams::fd.

Referenced by prepareSocket().

void Security::PeerConnector::connectionClosed ( const char *  reason)
protected

Definition at line 78 of file PeerConnector.cc.

References callback, debugs, and NULL.

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

Definition at line 90 of file AsyncJob.cc.

References AsyncJob::doneAll(), NULL, and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), and Downloader::downloadFinished().

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

Reimplemented from AsyncJob.

Definition at line 51 of file PeerConnector.cc.

References callback, and AsyncJob::doneAll().

virtual Security::ContextPointer Security::PeerConnector::getTlsContext ( )
protectedpure virtual

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

Implemented in Ssl::IcapPeerConnector, Security::BlindPeerConnector, and Ssl::PeekingPeerConnector.

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

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 384 of file PeerConnector.cc.

References DBG_IMPORTANT, debugs, fd_table, and Must.

void Security::PeerConnector::negotiate ( )
protected

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

Definition at line 176 of file PeerConnector.cc.

References debugs, fd_table, and Comm::IsConnOpen().

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

A wrapper for Comm::SetSelect() notifications.

Definition at line 376 of file PeerConnector.cc.

References CallJobHere, and data.

Referenced by certDownloadingDone(), and noteWantRead().

virtual void Security::PeerConnector::noteNegotiationDone ( ErrorState error)
inlineprotectedvirtual

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 in Ssl::IcapPeerConnector, Security::BlindPeerConnector, and Ssl::PeekingPeerConnector.

Definition at line 156 of file PeerConnector.h.

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

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 488 of file PeerConnector.cc.

References DBG_IMPORTANT, debugs, ErrorState::detail, ERR_SECURE_CONNECT_FAIL, Security::ErrorString(), fd_table, ErrorState::NewForwarding(), NULL, request(), Ssl::ErrorDetail::setLibError(), SQUID_ERR_SSL_HANDSHAKE, ssl_ex_index_ssl_error_detail, and ErrorState::xerrno.

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

void Security::PeerConnector::noteWantRead ( )
protected

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 448 of file PeerConnector.cc.

References BIO_get_data(), COMM_SELECT_READ, DBG_IMPORTANT, debugs, fd_table, Ssl::ServerBio::holdRead(), NegotiateSsl(), and Comm::SetSelect().

void Security::PeerConnector::noteWantWrite ( )
protectedvirtual

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 479 of file PeerConnector.cc.

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

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

PeerConnector& Security::PeerConnector::operator= ( const PeerConnector )
private
bool Security::PeerConnector::prepareSocket ( )
protected

Sets up TCP socket-related notification callbacks if things go wrong. If socket already closed return false, else install the comm_close handler to monitor the socket.

Definition at line 86 of file PeerConnector.cc.

References comm_add_close_handler(), commCloseHandler(), debugs, fd_table, Comm::IsConnOpen(), and JobCallback.

void Security::PeerConnector::recordNegotiationDetails ( )
protected

Called after negotiation finishes to record connection details for logging

Definition at line 158 of file PeerConnector.cc.

References BIO_get_data(), and fd_table.

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

Definition at line 163 of file PeerConnector.h.

References serverConn.

Referenced by Security::BlindPeerConnector::getTlsContext().

void Security::PeerConnector::setReadTimeout ( )
protected

Sets the read timeout to avoid getting stuck while reading from a silent server

Definition at line 144 of file PeerConnector.cc.

References commSetConnTimeout(), Config, max(), min(), SquidConfig::read, squid_curtime, and SquidConfig::Timeout.

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

Checks errors in the cert. validator response against sslproxy_cert_error. The first honored error, if any, is returned via errDetails parameter. The method returns all seen errors except SSL_ERROR_NONE as Security::CertErrors.

Definition at line 321 of file PeerConnector.cc.

References acl_access, ACLFilledChecklist::al, allow_t::allowed(), assert, SquidConfig::cert_error, Config, dash_str, debugs, Ssl::CertValidationResponse::errors, ACLChecklist::fastCheck(), fd_table, i, NULL, CbDataList< C >::push_back_unique(), request(), SquidConfig::ssl_client, and ACLFilledChecklist::sslErrors.

bool Security::PeerConnector::sslFinalized ( )
protected

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 223 of file PeerConnector.cc.

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

void Security::PeerConnector::start ( )
protectedvirtual

Reimplemented from AsyncJob.

Definition at line 58 of file PeerConnector.cc.

References debugs, and AsyncJob::start().

void Security::PeerConnector::startCertDownloading ( SBuf url)
protected
const char * Security::PeerConnector::status ( ) const
protectedvirtual

for debugging, starts with space

Reimplemented from AsyncJob.

Definition at line 586 of file PeerConnector.cc.

References MemBuf::append(), Packable::appendf(), buf, MemBuf::content(), NULL, MemBuf::reset(), and MemBuf::terminate().

void Security::PeerConnector::swanSong ( )
protectedvirtual
virtual void* CbdataParent::toCbdata ( )
pure virtualinherited

Member Data Documentation

AccessLogEntryPointer Security::PeerConnector::al
protected

Definition at line 180 of file PeerConnector.h.

AsyncCall::Pointer Security::PeerConnector::callback
protected

Definition at line 181 of file PeerConnector.h.

Referenced by PeerConnector().

unsigned int Security::PeerConnector::certsDownloads
private

Definition at line 208 of file PeerConnector.h.

AsyncCall::Pointer Security::PeerConnector::closeHandler
private

Definition at line 202 of file PeerConnector.h.

const InstanceId<AsyncJob> AsyncJob::id
protectedinherited

Definition at line 70 of file AsyncJob.h.

AsyncCall::Pointer AsyncJob::inCall
protectedinherited
const unsigned int Security::PeerConnector::MaxCertsDownloads = 10
staticprivate

Definition at line 198 of file PeerConnector.h.

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

Definition at line 200 of file PeerConnector.h.

time_t Security::PeerConnector::negotiationTimeout
private

Definition at line 203 of file PeerConnector.h.

HttpRequestPointer Security::PeerConnector::request
protected
Comm::ConnectionPointer Security::PeerConnector::serverConn
protected

Definition at line 179 of file PeerConnector.h.

Referenced by serverConnection().

time_t Security::PeerConnector::startTime
private

Definition at line 204 of file PeerConnector.h.

const char* AsyncJob::stopReason
protectedinherited
std::queue<SBuf> Security::PeerConnector::urlsOfMissingCerts
private

Definition at line 207 of file PeerConnector.h.

bool Security::PeerConnector::useCertValidator_
private

whether the certificate validator should bypassed

Definition at line 205 of file PeerConnector.h.

Referenced by bypassCertValidator().


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors