Manages a connection from an HTTP/1 or HTTP/0.9 client. More...

#include <Http1Server.h>

Inheritance diagram for Http::One::Server:

[legend]

Collaboration diagram for Http::One::Server:

[legend]

Public Types
typedef CbcPointer< AsyncJob >	Pointer

typedef CbcPointer< BodyProducer >	Pointer

Public Member Functions
	Server (const MasterXaction::Pointer &xact, const bool beHttpsServer)

virtual	~Server ()

void	readSomeHttpData ()

bool	reading () const
	whether Comm::Read() is scheduled More...

virtual void	receivedFirstByte ()
	Update flags and timeout after the first byte received. More...

virtual bool	handleReadData ()

virtual void	afterClientRead ()
	processing to be done after a Comm::Read() More...

virtual void	afterClientWrite (size_t)
	processing to sync state after a Comm::Write() More...

virtual void	sendControlMsg (HttpControlMsg)
	called to send the 1xx message and notify the Source More...

virtual void	doneWithControlMsg ()

bool	clientParseRequests ()
	Traffic parsing. More...

void	readNextRequest ()

void	kick ()
	try to make progress on a transaction or read more I/O More...

bool	isOpen () const

int64_t	mayNeedToReadMoreBody () const

const Auth::UserRequest::Pointer &	getAuth () const

void	setAuth (const Auth::UserRequest::Pointer &aur, const char *cause)

bool	transparent () const

const char *	stoppedReceiving () const
	true if we stopped receiving the request More...

const char *	stoppedSending () const
	true if we stopped sending the response More...

void	stopReceiving (const char *error)
	note request receiving error and close as soon as we write the response More...

void	stopSending (const char *error)
	note response sending error and close as soon as we read the request More...

void	expectNoForwarding ()
	cleans up virgin request [body] forwarding state More...

BodyPipe::Pointer	expectRequestBody (int64_t size)

bool	handleRequestBodyData ()

void	notePinnedConnectionBecameIdle (PinnedIdleContext pic)
	Called when a pinned connection becomes available for forwarding the next request. More...

void	pinBusyConnection (const Comm::ConnectionPointer &pinServerConn, const HttpRequest::Pointer &request)

void	unpinConnection (const bool andClose)
	Undo pinConnection() and, optionally, close the pinned connection. More...

CachePeer *	pinnedPeer () const

bool	pinnedAuth () const

virtual void	notePeerConnection (Comm::ConnectionPointer)
	called just before a FwdState-dispatched job starts using connection More...

virtual void	clientPinnedConnectionClosed (const CommCloseCbParams &io)
	Our close handler called by Comm when the pinned connection is closed. More...

void	clientReadFtpData (const CommIoCbParams &io)

void	connStateClosed (const CommCloseCbParams &io)

void	requestTimeout (const CommTimeoutCbParams &params)

virtual bool	doneAll () const
	whether positive goal has been reached More...

virtual void	swanSong ()

void	quitAfterError (HttpRequest *request)

void	stopPinnedConnectionMonitoring ()
	The caller assumes responsibility for connection closure detection. More...

void	postHttpsAccept ()
	the second part of old httpsAccept, waiting for future HttpsServer home More...

void	startPeekAndSplice ()
	Initializes and starts a peek-and-splice negotiation with the SSL client. More...

void	doPeekAndSpliceStep ()

void	httpsPeeked (PinnedIdleContext pic)
	called by FwdState when it is done bumping the server More...

bool	splice ()
	Splice a bumped client connection on peek-and-splice mode. More...

void	getSslContextStart ()
	Start to create dynamic Security::ContextPointer for host or uses static port SSL context. More...

void	getSslContextDone (Security::ContextPointer &)
	finish configuring the newly created SSL context" More...

void	sslCrtdHandleReply (const Helper::Reply &reply)
	Process response from ssl_crtd. More...

void	switchToHttps (ClientHttpRequest *, Ssl::BumpMode bumpServerMode)

void	parseTlsHandshake ()

bool	switchedToHttps () const

Ssl::ServerBump *	serverBump ()

void	setServerBump (Ssl::ServerBump *srvBump)

const SBuf &	sslCommonName () const

void	resetSslCommonName (const char *name)

const SBuf &	tlsClientSni () const

void	buildSslCertGenerationParams (Ssl::CertificateProperties &certProperties)

bool	serveDelayedError (Http::Stream *)

char *	prepareTlsSwitchingURL (const Http1::RequestParserPointer &hp)

void	consumeInput (const size_t byteCount)
	remove no longer needed leading bytes from the input buffer More...

Http::Stream *	abortRequestParsing (const char *const errUri)
	stop parsing the request and create context for relaying error info More...

bool	fakeAConnectRequest (const char *reason, const SBuf &payload)

bool	initiateTunneledRequest (HttpRequest::Pointer const &cause, Http::MethodType const method, const char *reason, const SBuf &payload)
	generates and sends to tunnel.cc a fake request with a given payload More...

bool	shouldPreserveClientData () const

bool	tunnelOnError (const HttpRequestMethod &, const err_type)
	initiate tunneling if possible or return false otherwise More...

ClientHttpRequest *	buildFakeRequest (Http::MethodType const method, SBuf &useHost, unsigned short usePort, const SBuf &payload)
	build a fake http request More...

virtual void	startShutdown ()

virtual void	endingShutdown ()

NotePairs::Pointer	notes ()

bool	hasNotes () const

const ProxyProtocol::HeaderPointer &	proxyProtocolHeader () const

void	readSomeData ()
	maybe grow the inBuf and schedule Comm::Read() More...

void	stopReading ()
	cancels Comm::Read() if it is scheduled More...

virtual void	writeSomeData ()
	maybe find some data to send and schedule a Comm::Write() More...

void	write (MemBuf *mb)
	schedule some data for a Comm::Write() More...

void	write (char *buf, int len)
	schedule some data for a Comm::Write() More...

bool	writing () const
	whether Comm::Write() is scheduled More...

void	maybeMakeSpaceAvailable ()
	grows the available read buffer space (if possible) More...

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

void	wroteControlMsg (const CommIoCbParams &)
	callback to handle Comm::Write completion More...

Static Public Member Functions
static Comm::ConnectionPointer	BorrowPinnedConnection (HttpRequest *, const AccessLogEntryPointer &)

static void	sslCrtdHandleReplyWrapper (void *data, const Helper::Reply &reply)
	Callback function. It is called when squid receive message from ssl_crtd. More...

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

Public Attributes
Http1::TeChunkedParser *	bodyParser
	parses HTTP/1.1 chunked request body More...

Ip::Address	log_addr

struct {
bool readMore
	needs comm_read (for this request or new requests) More...

bool swanSang

}	flags

struct {
Comm::ConnectionPointer serverConnection

char * host

int port

bool pinned

bool auth

bool reading
	we are monitoring for peer connection closure More...

bool zeroReply
	server closed w/o response (ERR_ZERO_SIZE_OBJECT) More...

bool peerAccessDenied
	cache_peer_access denied pinned connection reuse More...

CachePeer * peer

AsyncCall::Pointer readHandler
	detects serverConnection closure More...

AsyncCall::Pointer closeHandler

}	pinning

Ssl::BumpMode	sslBumpMode
	ssl_bump decision (Ssl::bumpEnd if n/a). More...

Security::HandshakeParser	tlsParser

SBuf	preservedClientData

Comm::ConnectionPointer	clientConnection

AnyP::ProtocolVersion	transferProtocol

SBuf	inBuf
	read I/O buffer for the client connection More...

bool	receivedFirstByte_
	true if at least one byte received on this connection More...

Pipeline	pipeline
	set of requests waiting to be serviced More...

AsyncCall::Pointer	cbControlMsgSent
	Call to schedule when the control msg has been sent. More...

Protected Member Functions
virtual Http::Stream *	parseOneRequest ()

virtual void	processParsedRequest (Http::StreamPointer &context)
	start processing a freshly parsed request More...

virtual void	handleReply (HttpReply *rep, StoreIOBuffer receivedData)

virtual bool	writeControlMsgAndCall (HttpReply *rep, AsyncCall::Pointer &call)
	handle a control message received by context from a peer and call back More...

virtual time_t	idleTimeout () const
	timeout to use when waiting for the next request More...

virtual void	noteMoreBodySpaceAvailable (BodyPipe::Pointer)

virtual void	noteBodyConsumerAborted (BodyPipe::Pointer)

virtual void	start ()
	called by AsyncStart; do not call directly More...

void	proceedAfterBodyContinuation (Http::StreamPointer context)

void	startDechunkingRequest ()
	initialize dechunking state More...

void	finishDechunkingRequest (bool withSuccess)
	put parsed content into input buffer and clean up More...

void	abortChunkedRequestBody (const err_type error)
	quit on errors related to chunked request body handling More...

err_type	handleChunkedRequestBody ()
	parses available chunked encoded body bytes, checks size, returns errors More...

Comm::ConnectionPointer	borrowPinnedConnection (HttpRequest *, const AccessLogEntryPointer &)
	ConnStateData-specific part of BorrowPinnedConnection() More...

void	startPinnedConnectionMonitoring ()

void	clientPinnedConnectionRead (const CommIoCbParams &io)

bool	handleIdleClientPinnedTlsRead ()

Http::Stream *	parseHttpRequest (const Http1::RequestParserPointer &)

virtual int	pipelinePrefetchMax () const
	returning N allows a pipeline of 1+N requests (see pipeline_prefetch) More...

void	whenClientIpKnown ()

void	doClientRead (const CommIoCbParams &io)

void	clientWriteDone (const CommIoCbParams &io)

void	deleteThis (const char *aReason)

void	mustStop (const char *aReason)

bool	done () const
	the job is destroyed in callEnd() when done() More...

virtual const char *	status () const
	internal cleanup; do not call directly More...

void	stopProducingFor (RefCount< BodyPipe > &, bool atEof)

Protected Attributes
BodyPipe::Pointer	bodyPipe
	set when we are reading request body More...

bool	preservingClientData_
	whether preservedClientData is valid and should be kept up to date More...

AsyncCall::Pointer	reader
	set when we are reading More...

AsyncCall::Pointer	writer
	set when we are writing 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< AsyncJob >	id
	job identifier More...

Private Types
typedef void(RegisteredRunner::*	Method) ()
	a pointer to one of the above notification methods More...

Private Member Functions
	CBDATA_CLASS (Server)

void	processHttpRequest (Http::Stream *const context)

void	handleHttpRequestData ()

bool	buildHttpRequest (Http::StreamPointer &context)

void	setReplyError (Http::StreamPointer &context, HttpRequest::Pointer &request, const HttpRequestMethod &method, err_type requestError, Http::StatusCode errStatusCode, const char *requestErrorBytes)

virtual bool	connFinishedWithConn (int size)
	?? More...

virtual void	checkLogging ()
	Log the current [attempt at] transaction if nobody else will. More...

void	clientAfterReadingRequests ()

bool	concurrentRequestQueueFilled () const

void	pinConnection (const Comm::ConnectionPointer &pinServerConn, const HttpRequest &request)
	Forward future client requests using the given server connection. More...

bool	proxyProtocolValidateClient ()

bool	parseProxyProtocolHeader ()

bool	proxyProtocolError (const char *reason)

Security::ContextPointer	getTlsContextFromCache (const SBuf &cacheKey, const Ssl::CertificateProperties &certProperties)

void	storeTlsContextToCache (const SBuf &cacheKey, Security::ContextPointer &ctx)

void	registerRunner ()

void	unregisterRunner ()
	unregisters self; safe to call multiple times More...

virtual void	finalizeConfig ()

virtual void	claimMemoryNeeds ()

virtual void	useConfig ()

virtual void	startReconfigure ()

virtual void	syncConfig ()

virtual void	finishShutdown ()
	Meant for cleanup of services needed by the already destroyed objects. More...

Private Attributes
Http1::RequestParserPointer	parser_

HttpRequestMethod	method_
	parsed HTTP method More...

const bool	isHttpsServer
	temporary hack to avoid creating a true HttpsServer class More...

bool	needProxyProtocolHeader_
	whether PROXY protocol header is still expected More...

ProxyProtocol::HeaderPointer	proxyProtocolHeader_
	the parsed PROXY protocol header More...

Auth::UserRequest::Pointer	auth_
	some user details that can be used to perform authentication on this connection More...

bool	switchedToHttps_

bool	parsingTlsHandshake

uint64_t	parsedBumpedRequestCount
	The number of parsed HTTP requests headers on a bumped client connection. More...

SBuf	tlsConnectHostOrIp
	The TLS server host name appears in CONNECT request or the server ip address for the intercepted requests. More...

unsigned short	tlsConnectPort
	The TLS server port number as passed in the CONNECT request. More...

SBuf	sslCommonName_
	CN name for SSL certificate generation. More...

SBuf	tlsClientSni_
	TLS client delivered SNI value. Empty string if none has been received. More...

SBuf	sslBumpCertKey
	Key to use to store/retrieve generated certificate. More...

Ssl::ServerBump *	sslServerBump
	HTTPS server cert. fetching state for bump-ssl-server-first. More...

Ssl::CertSignAlgorithm	signAlgorithm
	The signing algorithm to use. More...

const char *	stoppedSending_
	the reason why we no longer write the response or nil More...

const char *	stoppedReceiving_
	the reason why we no longer read the request or nil More...

NotePairs::Pointer	theNotes

Detailed Description

Definition at line 20 of file Http1Server.h.

Member Typedef Documentation

◆ Method

typedef void(RegisteredRunner::* RegisteredRunner::Method) ()

inherited

Definition at line 90 of file RunnersRegistry.h.

◆ Pointer [1/2]

typedef CbcPointer<BodyProducer> BodyProducer::Pointer

inherited

Definition at line 25 of file BodyPipe.h.

◆ Pointer [2/2]

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

Constructor & Destructor Documentation

◆ Server()

Server::Server	(	const MasterXaction::Pointer &	xact,
		const bool	beHttpsServer
	)

Definition at line 27 of file Http1Server.cc.

◆ ~Server()

virtual Http::One::Server::~Server ( )

inlinevirtual

Reimplemented from Server.

Definition at line 26 of file Http1Server.h.

Member Function Documentation

◆ abortChunkedRequestBody()

void ConnStateData::abortChunkedRequestBody ( const err_type error )

protectedinherited

Definition at line 2107 of file client_side.cc.

References assert, Server::clientConnection, comm_reset_close(), debugs, ERR_TOO_BIG, error(), ConnStateData::finishDechunkingRequest(), ConnStateData::flags, Pipeline::front(), HERE(), clientReplyContext::http, Server::inBuf, HttpRequest::method, NULL, Server::pipeline, ClientHttpRequest::request, Http::scPayloadTooLarge, clientReplyContext::setReplyToError(), and ClientHttpRequest::uri.

Referenced by ConnStateData::handleRequestBodyData().

◆ abortRequestParsing()

Http::Stream * ConnStateData::abortRequestParsing ( const char *const errUri )

inherited

Definition at line 1019 of file client_side.cc.

References ClientHttpRequest::client_stream, Server::clientConnection, clientGetMoreData, clientReplyDetach, clientReplyStatus, clientSocketDetach(), clientSocketRecipient(), clientStreamInit(), StoreIOBuffer::data, HTTP_REQBUF_SZ, Server::inBuf, StoreIOBuffer::length, SBuf::length(), ClientHttpRequest::req_sz, and ClientHttpRequest::setErrorUri().

Referenced by ConnStateData::parseHttpRequest().

◆ afterClientRead()

void ConnStateData::afterClientRead ( )

virtualinherited

Implements Server.

Definition at line 1967 of file client_side.cc.

References ConnStateData::clientAfterReadingRequests(), Server::clientConnection, ConnStateData::clientParseRequests(), Comm::Connection::close(), commIsHalfClosed(), debugs, Pipeline::empty(), Comm::Connection::fd, fd_note(), ConnStateData::isOpen(), ConnStateData::parseTlsHandshake(), ConnStateData::parsingTlsHandshake, and Server::pipeline.

◆ afterClientWrite()

void ConnStateData::afterClientWrite ( size_t )

virtualinherited

Reimplemented from Server.

Definition at line 1004 of file client_side.cc.

References StatCounters::client_http, Pipeline::empty(), Pipeline::front(), StatCounters::hit_kbytes_out, StatCounters::kbytes_out, Server::pipeline, size, and statCounter.

◆ BorrowPinnedConnection()

Comm::ConnectionPointer ConnStateData::BorrowPinnedConnection	(	HttpRequest *	request,
		const AccessLogEntryPointer &	ale
	)

staticinherited

Returns: validated pinned to-server connection, stopping its monitoring

Exceptions

a	newly allocated ErrorState if validation fails

Definition at line 3974 of file client_side.cc.

References ERR_CANNOT_FORWARD, ErrorState::NewForwarding(), and request().

Referenced by FwdState::usePinned(), and TunnelStateData::usePinned().

◆ borrowPinnedConnection()

Comm::ConnectionPointer ConnStateData::borrowPinnedConnection	(	HttpRequest *	request,
		const AccessLogEntryPointer &	ale
	)

protectedinherited

Definition at line 3943 of file client_side.cc.

References cbdataReferenceValid(), debugs, ERR_CANNOT_FORWARD, ERR_ZERO_SIZE_OBJECT, Comm::IsConnOpen(), Must, ErrorState::NewForwarding(), ConnStateData::pinning, request(), ConnStateData::stopPinnedConnectionMonitoring(), type, ConnStateData::unpinConnection(), and _request::url.

◆ buildFakeRequest()

ClientHttpRequest * ConnStateData::buildFakeRequest	(	Http::MethodType const	method,
		SBuf &	useHost,
		unsigned short	usePort,
		const SBuf &	payload
	)

inherited

Definition at line 3283 of file client_side.cc.

References ClientHttpRequest::al, SBuf::c_str(), ClientHttpRequest::client_stream, Server::clientConnection, clientGetMoreData, clientLifetimeTimeout, clientReplyDetach, clientReplyStatus, clientSocketDetach(), clientSocketRecipient(), clientStreamInit(), commCbCall(), commSetConnTimeout(), Config, StoreIOBuffer::data, ConnStateData::flags, Http::Stream::flags, ConnStateData::getAuth(), Http::HOST, Http::Stream::http, HTTP_REQBUF_SZ, Server::inBuf, XactionInitiator::initClient, ClientHttpRequest::initRequest(), StoreIOBuffer::length, SquidConfig::lifetime, Http::Stream::mayUseConnection(), method, _request::method, Http::METHOD_NONE, Http::Stream::parsed_ok, ConnStateData::port, AnyP::PROTO_AUTHORITY_FORM, AnyP::PROTO_HTTP, AnyP::PROTO_HTTPS, Http::Stream::registerWithConn(), Http::Stream::reqbuf, request(), SBufToCstring(), Http::Message::srcHttp, Http::Message::srcHttps, ConnStateData::switchedToHttps(), MasterXaction::tcpClient, SquidConfig::Timeout, ClientHttpRequest::uri, and _request::url.

Referenced by ConnStateData::fakeAConnectRequest(), and ConnStateData::initiateTunneledRequest().

◆ buildHttpRequest()

bool Server::buildHttpRequest ( Http::StreamPointer & context )

private

Handles parsing results. May generate and deliver an error reply to the client if parsing is failed, or parses the url and build the HttpRequest object using parsing results. Return false if parsing is failed, true otherwise.

Definition at line 98 of file Http1Server.cc.

References assert, clientProcessRequestFinished(), clientTunnelOnError(), debugs, ERR_INVALID_REQ, ERR_INVALID_URL, ERR_PROTOCOL_UNKNOWN, ERR_TOO_BIG, ERR_UNSUP_HTTPVERSION, ERR_UNSUP_REQ, HttpRequest::FromUrlXXX(), Http::HOST, XactionInitiator::initClient, ClientHttpRequest::initRequest(), ClientHttpRequest::log_uri, _request::method, Http::METHOD_NONE, NULL, request(), Http::scBadRequest, Http::scHttpVersionNotSupported, Http::scMethodNotAllowed, Http::scRequestHeaderFieldsTooLarge, Http::scUriTooLong, ClientHttpRequest::setLogUriToRawUri(), MasterXaction::tcpClient, ClientHttpRequest::uri, and _request::url.

◆ buildSslCertGenerationParams()

void ConnStateData::buildSslCertGenerationParams ( Ssl::CertificateProperties & certProperties )

inherited

Fill the certAdaptParams with the required data for certificate adaptation and create the key for storing/retrieve the certificate to/from the cache

Definition at line 2723 of file client_side.cc.

Referenced by ConnStateData::getSslContextStart().

◆ callEnd()

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 136 of file AsyncJob.cc.

References AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), HERE(), AsyncJob::inCall, NULL, AsyncJob::status(), AsyncJob::swanSong(), and AsyncJob::typeName.

Referenced by Adaptation::Icap::Xaction::callEnd(), and AsyncJob::deleteThis().

◆ callException()

void AsyncJob::callException ( const std::exception & e )

virtualinherited

Reimplemented in ClientHttpRequest, Ftp::Server, Adaptation::Icap::ModXact, Adaptation::Icap::Xaction, Adaptation::Icap::ServiceRep, Ipc::Forwarder, and Ipc::Inquirer.

Definition at line 127 of file AsyncJob.cc.

References cbdataReferenceValid(), debugs, Must, AsyncJob::mustStop(), and CbdataParent::toCbdata().

Referenced by Ipc::Inquirer::callException(), Ipc::Forwarder::callException(), Ftp::Server::callException(), and Adaptation::Icap::Xaction::callException().

◆ callStart()

void AsyncJob::callStart ( AsyncCall & call )

inherited

called just before the called method

Definition at line 114 of file AsyncJob.cc.

References cbdataReferenceValid(), AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::inCall, Must, AsyncJob::status(), CbdataParent::toCbdata(), and AsyncJob::typeName.

◆ 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()

Http::One::Server::CBDATA_CLASS ( Server )

private

◆ checkLogging()

void ConnStateData::checkLogging ( )

privatevirtualinherited

Implements Server.

Definition at line 4017 of file client_side.cc.

References Pipeline::back(), ConnStateData::bodyPipe, Pipeline::empty(), Server::inBuf, SBuf::isEmpty(), SBuf::length(), Pipeline::nrequests, Server::pipeline, ClientHttpRequest::req_sz, and ClientHttpRequest::setErrorUri().

Referenced by ConnStateData::swanSong().

◆ claimMemoryNeeds()

virtual void RegisteredRunner::claimMemoryNeeds ( )

inlinevirtualinherited

Called after finalizeConfig(). Meant for announcing memory reservations before memory is allocated.

Reimplemented in MemStoreRr, and IpcIoRr.

Definition at line 51 of file RunnersRegistry.h.

Referenced by RunConfigUsers().

◆ clientAfterReadingRequests()

void ConnStateData::clientAfterReadingRequests ( )

privateinherited

Definition at line 1443 of file client_side.cc.

References Server::clientConnection, Comm::Connection::close(), commIsHalfClosed(), debugs, Comm::Connection::fd, ConnStateData::flags, HERE(), ConnStateData::mayNeedToReadMoreBody(), and Server::readSomeData().

Referenced by ConnStateData::afterClientRead().

◆ clientParseRequests()

bool ConnStateData::clientParseRequests ( )

inherited

Attempt to parse one or more requests from the input buffer. Returns true after completing parsing of at least one request [header]. That includes cases where parsing ended with an error (e.g., a huge request).

Definition at line 1896 of file client_side.cc.

References assert, ConnStateData::bodyPipe, Server::clientConnection, clientLifetimeTimeout, commCbCall(), commSetConnTimeout(), ConnStateData::concurrentRequestQueueFilled(), Config, debugs, ConnStateData::flags, HERE(), Server::inBuf, SBuf::isEmpty(), SBuf::length(), SquidConfig::lifetime, SquidConfig::maxRequestHeaderSize, Must, ConnStateData::needProxyProtocolHeader_, ConnStateData::parsedBumpedRequestCount, ConnStateData::parseOneRequest(), ConnStateData::parseProxyProtocolHeader(), ConnStateData::pinning, ConnStateData::preservingClientData_, ConnStateData::processParsedRequest(), ConnStateData::switchedToHttps(), SquidConfig::Timeout, and ConnStateData::whenClientIpKnown().

Referenced by ConnStateData::afterClientRead(), and ConnStateData::kick().

◆ clientPinnedConnectionClosed()

void ConnStateData::clientPinnedConnectionClosed ( const CommCloseCbParams & io )

virtualinherited

Reimplemented in Ftp::Server.

Definition at line 3767 of file client_side.cc.

References assert, Server::clientConnection, Comm::Connection::close(), CommCommonCbParams::conn, debugs, NULL, ConnStateData::pinning, and ConnStateData::unpinConnection().

Referenced by Ftp::Server::clientPinnedConnectionClosed(), and ConnStateData::pinConnection().

◆ clientPinnedConnectionRead()

void ConnStateData::clientPinnedConnectionRead ( const CommIoCbParams & io )

protectedinherited

Our read handler called by Comm when the server either closes an idle pinned connection or perhaps unexpectedly sends something on that idle (from Squid p.o.v.) connection.

Definition at line 3914 of file client_side.cc.

References Server::clientConnection, Comm::Connection::close(), CommCommonCbParams::conn, debugs, Pipeline::empty(), Comm::ERR_CLOSING, CommCommonCbParams::flag, ConnStateData::handleIdleClientPinnedTlsRead(), Must, NULL, ConnStateData::pinning, Server::pipeline, and CommIoCbParams::size.

Referenced by ConnStateData::startPinnedConnectionMonitoring().

◆ clientReadFtpData()

void ConnStateData::clientReadFtpData ( const CommIoCbParams & io )

inherited

◆ clientWriteDone()

void Server::clientWriteDone ( const CommIoCbParams & io )

protectedinherited

callback handling the Comm::Write completion

Will call afterClientWrite(size_t) to sync the I/O state. Then writeSomeData() to initiate any followup writes that could be immediately done.

Definition at line 186 of file Server.cc.

References Server::afterClientWrite(), Server::clientConnection, CommCommonCbParams::conn, debugs, Comm::ERR_CLOSING, Comm::Connection::fd, CommCommonCbParams::flag, Pipeline::front(), Comm::IsConnOpen(), Must, Server::pipeline, CommIoCbParams::size, Server::writer, and Server::writeSomeData().

Referenced by Server::write().

◆ concurrentRequestQueueFilled()

bool ConnStateData::concurrentRequestQueueFilled ( ) const

privateinherited

Limit the number of concurrent requests.

Returns: true when there are available position(s) in the pipeline queue for another request.; false when the pipeline queue is full or disabled.

Definition at line 1780 of file client_side.cc.

References Ssl::bumpSplice, Server::clientConnection, Pipeline::count(), debugs, Server::pipeline, ConnStateData::pipelinePrefetchMax(), ConnStateData::sslBumpMode, and ConnStateData::transparent().

Referenced by ConnStateData::clientParseRequests().

◆ connFinishedWithConn()

bool ConnStateData::connFinishedWithConn ( int size )

privatevirtualinherited

Implements Server.

Definition at line 1416 of file client_side.cc.

References Server::clientConnection, Config, debugs, Pipeline::empty(), SquidConfig::half_closed_clients, HERE(), Server::inBuf, SBuf::isEmpty(), SquidConfig::onoff, Server::pipeline, size, and Pipeline::terminateAll().

◆ connStateClosed()

void ConnStateData::connStateClosed ( const CommCloseCbParams & io )

inherited

Definition at line 503 of file client_side.cc.

References AsyncJob::deleteThis().

Referenced by ConnStateData::start().

◆ consumeInput()

void ConnStateData::consumeInput ( const size_t byteCount )

inherited

Definition at line 1435 of file client_side.cc.

References assert, SBuf::consume(), debugs, Server::inBuf, and SBuf::length().

Referenced by ConnStateData::handleRequestBodyData(), and ConnStateData::parseHttpRequest().

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protectedinherited

Definition at line 49 of file AsyncJob.cc.

References asyncCall(), AsyncJob::callEnd(), debugs, AsyncJob::inCall, JobMemFun(), Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by ConnStateData::connStateClosed().

◆ doClientRead()

void Server::doClientRead ( const CommIoCbParams & io )

protectedinherited

Definition at line 102 of file Server.cc.

References Server::afterClientRead(), assert, Server::checkLogging(), StatCounters::client_http, Server::clientConnection, Comm::Connection::close(), commMarkHalfClosed(), CommCommonCbParams::conn, Server::connFinishedWithConn(), debugs, Comm::ENDFILE, Comm::ERR_CLOSING, Comm::Connection::fd, fd_note(), fd_table, CommCommonCbParams::flag, Server::handleReadData(), Server::inBuf, Comm::INPROGRESS, Comm::IsConnOpen(), SBuf::isEmpty(), StatCounters::kbytes_in, Server::maybeMakeSpaceAvailable(), Must, NULL, Comm::OK, Server::pipeline, Server::reader, Server::reading(), Comm::ReadNow(), Server::readSomeData(), Server::receivedFirstByte(), Server::receivedFirstByte_, CommIoCbParams::size, statCounter, Pipeline::terminateAll(), CommCommonCbParams::xerrno, and xstrerr().

Referenced by Server::readSomeData().

◆ done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 90 of file AsyncJob.cc.

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

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

◆ doneAll()

virtual bool ConnStateData::doneAll ( ) const

inlinevirtualinherited

Reimplemented from Server.

Definition at line 209 of file client_side.h.

References AsyncJob::doneAll().

◆ doneWithControlMsg()

void ConnStateData::doneWithControlMsg ( )

virtualinherited

Reimplemented from HttpControlMsgSink.

Definition at line 3755 of file client_side.cc.

References Server::clientConnection, ClientSocketContextPushDeferredIfNeeded(), debugs, HttpControlMsgSink::doneWithControlMsg(), Pipeline::front(), and Server::pipeline.

Referenced by ConnStateData::sendControlMsg().

◆ doPeekAndSpliceStep()

void ConnStateData::doPeekAndSpliceStep ( )

inherited

Called when a peek-and-splice step finished. For example after server SSL certificates received and fake server SSL certificates generated

Definition at line 3183 of file client_side.cc.

References assert, BIO_get_data(), Server::clientConnection, clientNegotiateSSL(), COMM_SELECT_WRITE, debugs, Comm::Connection::fd, fd_table, Ssl::ClientBio::hold(), Comm::SetSelect(), and ConnStateData::switchedToHttps_.

Referenced by ConnStateData::getSslContextStart(), and ConnStateData::sslCrtdHandleReply().

◆ endingShutdown()

void ConnStateData::endingShutdown ( )

virtualinherited

Called after shutdown_lifetime grace period ends and before stopping the main loop. At least one main loop iteration is guaranteed after this call. Meant for cleanup and state saving that may require other modules.

Reimplemented from RegisteredRunner.

Definition at line 1046 of file client_side.cc.

References Server::clientConnection, Comm::Connection::close(), and Comm::IsConnOpen().

Referenced by ConnStateData::startShutdown().

◆ expectNoForwarding()

void ConnStateData::expectNoForwarding ( )

inherited

Definition at line 3678 of file client_side.cc.

References ConnStateData::bodyPipe, debugs, BodyPipe::expectNoConsumption(), HERE(), NULL, and BodyPipe::status().

Referenced by ClientHttpRequest::calloutsError().

◆ expectRequestBody()

BodyPipe::Pointer ConnStateData::expectRequestBody ( int64_t size )

inherited

Definition at line 3629 of file client_side.cc.

References ConnStateData::bodyPipe, BodyPipe::setBodySize(), size, and ConnStateData::startDechunkingRequest().

◆ fakeAConnectRequest()

bool ConnStateData::fakeAConnectRequest	(	const char *	reason,
		const SBuf &	payload
	)

inherited

generate a fake CONNECT request with the given payload at the beginning of the client I/O buffer

Definition at line 3254 of file client_side.cc.

References assert, SBuf::assign(), ConnStateData::buildFakeRequest(), ClientHttpRequest::calloutContext, Server::clientConnection, clientProcessRequestFinished(), debugs, ClientHttpRequest::doCallouts(), SBuf::isEmpty(), Comm::Connection::local, MAX_IPSTRLEN, Http::METHOD_CONNECT, Ip::Address::port(), ClientHttpRequest::request, request(), ConnStateData::tlsClientSni_, Ip::Address::toHostStr(), and ConnStateData::transparent().

Referenced by httpsSslBumpAccessCheckDone(), and ConnStateData::splice().

◆ finalizeConfig()

virtual void RegisteredRunner::finalizeConfig ( )

inlinevirtualinherited

Called after parsing squid.conf. Meant for setting configuration options that depend on other configuration options and were not explicitly configured.

Reimplemented in sslBumpCfgRr, and MemStoreRr.

Definition at line 47 of file RunnersRegistry.h.

Referenced by SquidMain().

◆ finishDechunkingRequest()

void ConnStateData::finishDechunkingRequest ( bool withSuccess )

protectedinherited

Definition at line 3698 of file client_side.cc.

References ConnStateData::bodyParser, ConnStateData::bodyPipe, debugs, Pipeline::front(), HERE(), Must, NULL, Server::pipeline, BodyPipe::status(), and BodyProducer::stopProducingFor().

Referenced by ConnStateData::abortChunkedRequestBody(), and ConnStateData::handleChunkedRequestBody().

◆ finishShutdown()

virtual void RegisteredRunner::finishShutdown ( )

inlinevirtualinherited

Definition at line 87 of file RunnersRegistry.h.

Referenced by RunRegistered(), SquidShutdown(), testRock::tearDown(), and watch_child().

◆ getAuth()

const Auth::UserRequest::Pointer& ConnStateData::getAuth ( ) const

inlineinherited

Fetch the user details for connection based authentication NOTE: this is ONLY connection based because NTLM and Negotiate is against HTTP spec.

Definition at line 116 of file client_side.h.

References ConnStateData::auth_.

Referenced by AuthenticateAcl(), ConnStateData::buildFakeRequest(), ClientHttpRequest::calloutsError(), ClientRequestContext::clientAccessCheckDone(), constructHelperQuery(), and ClientRequestContext::hostHeaderVerifyFailed().

◆ getSslContextDone()

void ConnStateData::getSslContextDone ( Security::ContextPointer & ctx )

inherited

◆ getSslContextStart()

void ConnStateData::getSslContextStart ( )

inherited

Definition at line 2828 of file client_side.cc.

References Ssl::ServerBump::act, Ssl::algSignTrusted, assert, ConnStateData::buildSslCertGenerationParams(), Ssl::bumpPeek, Ssl::bumpStare, SBuf::clear(), Server::clientConnection, Ssl::CrtdMessage::code_new_certificate, Ssl::CertificateProperties::commonName, Ssl::CrtdMessage::compose(), Ssl::CrtdMessage::composeRequest(), Ssl::configureSSL(), Ssl::configureUnconfiguredSslContext(), DBG_IMPORTANT, debugs, ConnStateData::doPeekAndSpliceStep(), Pipeline::empty(), Comm::Connection::fd, fd_table, Pipeline::front(), Ssl::GenerateSslContext(), Security::GetFrom(), ConnStateData::getSslContextDone(), ConnStateData::getTlsContextFromCache(), HERE(), Ssl::InRamCertificateDbKey(), SBuf::isEmpty(), Http::METHOD_CONNECT, Must, Store::nil, Server::pipeline, ConnStateData::port, Ssl::CrtdMessage::REQUEST, Ssl::CrtdMessage::setCode(), Ssl::CertificateProperties::signAlgorithm, ConnStateData::signAlgorithm, ConnStateData::sslBumpCertKey, ConnStateData::sslCrtdHandleReplyWrapper(), ConnStateData::sslServerBump, Ssl::ServerBump::step1, ConnStateData::storeTlsContextToCache(), and Ssl::Helper::Submit().

Referenced by ConnStateData::httpsPeeked(), and ConnStateData::parseTlsHandshake().

◆ getTlsContextFromCache()

Security::ContextPointer ConnStateData::getTlsContextFromCache	(	const SBuf &	cacheKey,
		const Ssl::CertificateProperties &	certProperties
	)

privateinherited

Returns: a pointer to the matching cached TLS context or nil

Definition at line 2800 of file client_side.cc.

References Ssl::CertificateProperties::commonName, debugs, LruMap< Key, EntryValue, EntryCost >::del(), LruMap< Key, EntryValue, EntryCost >::get(), Ssl::GlobalContextStorage::getLocalStorage(), ConnStateData::port, Ssl::TheGlobalContextStorage, and Ssl::verifySslCertificate().

Referenced by ConnStateData::getSslContextStart().

◆ handleChunkedRequestBody()

err_type ConnStateData::handleChunkedRequestBody ( )

protectedinherited

◆ handleHttpRequestData()

void Http::One::Server::handleHttpRequestData ( )

private

◆ handleIdleClientPinnedTlsRead()

bool ConnStateData::handleIdleClientPinnedTlsRead ( )

protectedinherited

Handles a ready-for-reading TLS squid-to-server connection that we thought was idle.

Returns: false if and only if the connection should be closed.

Definition at line 3873 of file client_side.cc.

References buf, DBG_IMPORTANT, debugs, error(), fd_table, Must, ConnStateData::pinning, and ConnStateData::startPinnedConnectionMonitoring().

Referenced by ConnStateData::clientPinnedConnectionRead().

◆ handleReadData()

bool ConnStateData::handleReadData ( )

virtualinherited

called when new request data has been read from the socket

Return values

false	called comm_close or setReplyToError (the caller should bail)
true	we did not call comm_close or setReplyToError

Implements Server.

Definition at line 2011 of file client_side.cc.

References ConnStateData::bodyPipe, ConnStateData::handleRequestBodyData(), and NULL.

◆ handleReply()

void Server::handleReply	(	HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protectedvirtual

ClientStream calls this to supply response header (once) and data for the current Http::Stream.

Implements ConnStateData.

Definition at line 292 of file Http1Server.cc.

References assert, RequestFlags::chunkedReply, StoreIOBuffer::data, EBIT_TEST, ENTRY_BAD_LENGTH, HttpRequest::flags, StoreEntry::flags, StoreIOBuffer::length, Must, NULL, ClientHttpRequest::request, ClientHttpRequest::storeEntry(), and RequestFlags::streamError.

◆ handleRequestBodyData()

bool ConnStateData::handleRequestBodyData ( )

inherited

called when new request body data has been buffered in inBuf may close the connection if we were closing and piped everything out

Return values

false	called comm_close or setReplyToError (the caller should bail)
true	we did not call comm_close or setReplyToError

Definition at line 2027 of file client_side.cc.

References ConnStateData::abortChunkedRequestBody(), assert, ConnStateData::bodyParser, ConnStateData::bodyPipe, SBuf::c_str(), Server::clientConnection, Comm::Connection::close(), ConnStateData::consumeInput(), debugs, error(), ConnStateData::handleChunkedRequestBody(), HERE(), Server::inBuf, SBuf::length(), BodyPipe::mayNeedMoreData(), NULL, BodyPipe::putMoreData(), and ConnStateData::stoppedSending().

Referenced by ConnStateData::handleReadData().

◆ hasNotes()

bool ConnStateData::hasNotes ( ) const

inlineinherited

Definition at line 323 of file client_side.h.

References NotePairs::empty(), and ConnStateData::theNotes.

◆ httpsPeeked()

void ConnStateData::httpsPeeked ( PinnedIdleContext pic )

inherited

Definition at line 3198 of file client_side.cc.

References ConnStateData::PinnedIdleContext::connection, debugs, Pipeline::empty(), Pipeline::front(), RefCount< C >::getRaw(), ConnStateData::getSslContextStart(), Comm::IsConnOpen(), Must, ConnStateData::notePinnedConnectionBecameIdle(), NULL, Server::pipeline, Ssl::ServerBump::request, ConnStateData::PinnedIdleContext::request, ConnStateData::sslServerBump, and ConnStateData::tlsConnectHostOrIp.

Referenced by FwdState::completed(), and FwdState::dispatch().

◆ idleTimeout()

time_t Server::idleTimeout ( ) const

protectedvirtual

Implements ConnStateData.

Definition at line 35 of file Http1Server.cc.

References SquidConfig::clientIdlePconn, Config, and SquidConfig::Timeout.

◆ initiateTunneledRequest()

bool ConnStateData::initiateTunneledRequest	(	HttpRequest::Pointer const &	cause,
		Http::MethodType const	method,
		const char *	reason,
		const SBuf &	payload
	)

inherited

◆ isOpen()

bool ConnStateData::isOpen ( ) const

inherited

Definition at line 614 of file client_side.cc.

References cbdataReferenceValid(), Server::clientConnection, Comm::Connection::fd, fd_table, and Comm::IsConnOpen().

Referenced by ConnStateData::afterClientRead(), httpsSslBumpAccessCheckDone(), httpsSslBumpStep2AccessCheckDone(), ConnStateData::sendControlMsg(), ConnStateData::sslCrtdHandleReply(), and ConnStateData::~ConnStateData().

◆ kick()

void ConnStateData::kick ( )

inherited

: We are done with the response, and we are either still receiving request body (early response!) or have already stopped receiving anything.

If we are still receiving, then clientParseRequest() below will fail. (XXX: but then we will call readNextRequest() which may succeed and execute a smuggled request as we are not done with the current request).

If we stopped because we got everything, then try the next request.

If we stopped receiving because of an error, then close now to avoid getting stuck and to prevent accidental request smuggling.

: Attempt to parse a request from the request buffer. If we've been fed a pipelined request it may already be in our read buffer.

: This needs to fall through - if we're unlucky and parse the last request from our read buffer we may never re-register for another client read.

: Either we need to kick-start another read or, if we have a half-closed connection, kill it after the last request. This saves waiting for half-closed connections to finished being half-closed AND then, sometimes, spending "Timeout" time in the keepalive "Waiting for next request" state.

: At this point we either have a parsed request (which we've kicked off the processing for) or not. If we have a deferred request (parsed but deferred for pipeling processing reasons) then look at processing it. If not, simply kickstart another read.

Definition at line 899 of file client_side.cc.

References Server::clientConnection, ConnStateData::clientParseRequests(), ClientSocketContextPushDeferredIfNeeded(), Comm::Connection::close(), commIsHalfClosed(), DBG_IMPORTANT, debugs, Pipeline::empty(), Comm::Connection::fd, ConnStateData::flags, Pipeline::front(), Comm::IsConnOpen(), MYNAME, ConnStateData::pinning, Server::pipeline, ConnStateData::readNextRequest(), and ConnStateData::stoppedReceiving().

Referenced by ConnStateData::notePinnedConnectionBecameIdle(), and Http::Stream::writeComplete().

◆ maybeMakeSpaceAvailable()

void Server::maybeMakeSpaceAvailable ( )

inherited

Prepare inBuf for I/O. This method balances several conflicting desires:

Do not read too few bytes at a time.
Do not waste too much buffer space.
Do not [re]allocate or memmove the buffer too much.
Obey Config.maxRequestBufferSize limit.

Definition at line 70 of file Server.cc.

References SBufReservationRequirements::allowShared, CLIENT_REQ_BUF_SZ, Config, debugs, SBufReservationRequirements::idealSpace, Server::inBuf, SBufReservationRequirements::maxCapacity, SquidConfig::maxRequestBufferSize, SBufReservationRequirements::minSpace, SBuf::reserve(), and SBuf::spaceSize().

Referenced by Server::doClientRead().

◆ mayNeedToReadMoreBody()

int64_t ConnStateData::mayNeedToReadMoreBody ( ) const

inherited

number of body bytes we need to comm_read for the "current" request

Return values

0	We do not need to read any [more] body bytes
negative	May need more but do not know how many; could be zero!
positive	Need to read exactly that many more body bytes

Definition at line 3640 of file client_side.cc.

References ConnStateData::bodyPipe, BodyPipe::bodySizeKnown(), Server::inBuf, SBuf::length(), and BodyPipe::unproducedSize().

Referenced by ConnStateData::clientAfterReadingRequests(), and ConnStateData::stopSending().

◆ mustStop()

void AsyncJob::mustStop ( const char * aReason )

protectedinherited

Definition at line 69 of file AsyncJob.cc.

References debugs, AsyncJob::inCall, Must, NULL, AsyncJob::stopReason, and AsyncJob::typeName.

Referenced by HttpStateData::abortAll(), AsyncJob::callException(), HttpStateData::continueAfterParsingHeader(), HttpStateData::handleMoreRequestBodyAvailable(), HttpStateData::httpStateConnClosed(), HttpStateData::httpTimeout(), Comm::ConnOpener::noteAbort(), ConnStateData::proxyProtocolError(), HttpStateData::readReply(), HttpStateData::start(), and HttpStateData::wroteLast().

◆ noteBodyConsumerAborted()

void Server::noteBodyConsumerAborted ( BodyPipe::Pointer ptr )

protectedvirtual

Implements ConnStateData.

Definition at line 285 of file Http1Server.cc.

References ConnStateData::noteBodyConsumerAborted().

◆ noteMoreBodySpaceAvailable()

void Server::noteMoreBodySpaceAvailable ( BodyPipe::Pointer )

protectedvirtual

Implements ConnStateData.

Definition at line 60 of file Http1Server.cc.

References isOpen().

◆ notePeerConnection()

virtual void ConnStateData::notePeerConnection ( Comm::ConnectionPointer )

inlinevirtualinherited

Reimplemented in Ftp::Server.

Definition at line 197 of file client_side.h.

Referenced by FwdState::successfullyConnectedToPeer().

◆ notePinnedConnectionBecameIdle()

void ConnStateData::notePinnedConnectionBecameIdle ( PinnedIdleContext pic )

inherited

Definition at line 3791 of file client_side.cc.

References ConnStateData::PinnedIdleContext::connection, Pipeline::empty(), ConnStateData::kick(), Must, ConnStateData::pinConnection(), Server::pipeline, ConnStateData::PinnedIdleContext::request, and ConnStateData::startPinnedConnectionMonitoring().

Referenced by ConnStateData::httpsPeeked().

◆ notes()

NotePairs::Pointer ConnStateData::notes ( )

inherited

Returns: existing non-empty connection annotations, creates and returns empty annotations otherwise

Definition at line 4078 of file client_side.cc.

References ConnStateData::theNotes.

Referenced by UpdateRequestNotes().

◆ parseHttpRequest()

Http::Stream * ConnStateData::parseHttpRequest ( const Http1::RequestParserPointer & hp )

protectedinherited

Parse an HTTP request

Note: Sets result->flags.parsed_ok to 0 if failed to parse the request, to 1 if the request was correctly parsed

Parameters

[in] hp an Http1::RequestParser

Returns: NULL on incomplete requests, a Http::Stream on success or failure. TODO: Move to HttpServer. Warning: Move requires large code nonchanges!

Definition at line 1280 of file client_side.cc.

References ConnStateData::abortRequestParsing(), SquidConfig::appendDomainLen, Server::clientConnection, clientGetMoreData, clientReplyDetach, clientReplyStatus, clientSocketDetach(), clientSocketRecipient(), clientStreamInit(), Config, ConnStateData::consumeInput(), StoreIOBuffer::data, DBG_IMPORTANT, debugs, Http::Stream::flags, HTTP_REQBUF_SZ, Server::inBuf, internalCheck(), internalLocalUri(), SBuf::isEmpty(), StoreIOBuffer::length, SBuf::length(), Http::METHOD_CONNECT, Http::METHOD_NONE, Http::METHOD_PRI, Must, NULL, Http::Stream::parsed_ok, ConnStateData::port, prepareAcceleratedURL(), ConnStateData::prepareTlsSwitchingURL(), prepareTransparentURL(), ConnStateData::preservedClientData, ConnStateData::preservingClientData_, Http::ProtocolVersion(), Http::Stream::reqbuf, SBufToCstring(), Http::scMethodNotAllowed, Http::scRequestHeaderFieldsTooLarge, Http::scUriTooLong, ConnStateData::switchedToHttps(), Server::transferProtocol, ConnStateData::transparent(), xcalloc, and xstrdup.

◆ parseOneRequest()

Http::Stream * Server::parseOneRequest ( )

protectedvirtual

parse input buffer prefix into a single transfer protocol request return NULL to request more header bytes (after checking any limits) use abortRequestParsing() to handle parsing errors w/o creating request

Implements ConnStateData.

Definition at line 73 of file Http1Server.cc.

References PROF_start, and PROF_stop.

◆ parseProxyProtocolHeader()

bool ConnStateData::parseProxyProtocolHeader ( )

privateinherited

Attempts to extract a PROXY protocol header from the input buffer and, upon success, stores the parsed header in proxyProtocolHeader_.

Returns: true if the header was successfully parsed; false if more data is needed to parse the header or on error

Definition at line 1852 of file client_side.cc.

References assert, Server::clientConnection, COMM_TRANSPARENT, SBuf::consume(), debugs, Comm::Connection::flags, Server::inBuf, SBuf::length(), Comm::Connection::local, ConnStateData::needProxyProtocolHeader_, ProxyProtocol::Parse(), ConnStateData::proxyProtocolError(), ConnStateData::proxyProtocolHeader_, and Comm::Connection::remote.

Referenced by ConnStateData::clientParseRequests().

◆ parseTlsHandshake()

void ConnStateData::parseTlsHandshake ( )

inherited

Definition at line 2993 of file client_side.cc.

References Ssl::ServerBump::act, ClientHttpRequest::al, assert, Ssl::bumpClientFirst, Ssl::bumpPeek, Ssl::bumpServerFirst, Ssl::bumpSplice, Ssl::bumpStare, Server::clientConnection, clientTunnelOnError(), Comm::Connection::close(), debugs, Security::HandshakeParser::details, Ssl::ServerBump::entry, ERR_PROTOCOL_UNKNOWN, Comm::Connection::fd, fd_note(), Pipeline::front(), RefCount< C >::getRaw(), ConnStateData::getSslContextStart(), Server::inBuf, SBuf::isEmpty(), Must, Security::HandshakeParser::parseHello(), ConnStateData::parsingTlsHandshake, Server::pipeline, ConnStateData::preservedClientData, Server::readSomeData(), ConnStateData::receivedFirstByte(), Ssl::ServerBump::request, request(), Comm::ResetSelect(), ConnStateData::resetSslCommonName(), Security::NegotiationHistory::retrieveParsedInfo(), ConnStateData::sslBumpMode, ConnStateData::sslServerBump, FwdState::Start(), ConnStateData::startPeekAndSplice(), Ssl::ServerBump::step1, ConnStateData::tlsClientSni_, Comm::Connection::tlsNegotiations(), and ConnStateData::tlsParser.

Referenced by ConnStateData::afterClientRead().

◆ pinBusyConnection()

void ConnStateData::pinBusyConnection	(	const Comm::ConnectionPointer &	pinServerConn,
		const HttpRequest::Pointer &	request
	)

inherited

Forward future client requests using the given to-server connection. The connection is still being used by the current client request.

Definition at line 3785 of file client_side.cc.

References ConnStateData::pinConnection(), and request().

◆ pinConnection()

void ConnStateData::pinConnection	(	const Comm::ConnectionPointer &	pinServerConn,
		const HttpRequest &	request
	)

privateinherited

◆ pinnedAuth()

bool ConnStateData::pinnedAuth ( ) const

inlineinherited

Definition at line 194 of file client_side.h.

References ConnStateData::pinning.

◆ pinnedPeer()

CachePeer* ConnStateData::pinnedPeer ( ) const

inlineinherited

returts the pinned CachePeer if exists, NULL otherwise

Definition at line 193 of file client_side.h.

References ConnStateData::pinning.

Referenced by PeerSelector::selectPinned().

◆ pipelinePrefetchMax()

int ConnStateData::pipelinePrefetchMax ( ) const

protectedvirtualinherited

Reimplemented in Ftp::Server.

Definition at line 1766 of file client_side.cc.

References Config, ConnStateData::pinning, and SquidConfig::pipeline_max_prefetch.

Referenced by ConnStateData::concurrentRequestQueueFilled().

◆ postHttpsAccept()

void ConnStateData::postHttpsAccept ( )

inherited

Definition at line 2617 of file client_side.cc.

References ACCESS_DENIED, SquidConfig::accessList, ACLFilledChecklist::al, assert, AccessLogEntry::cache, AccessLogEntry::CacheDetails::caddr, Server::clientConnection, COMM_INTERCEPTION, COMM_TRANSPARENT, Config, current_time, debugs, fatal(), Comm::Connection::flags, Pipeline::front(), HTTPMSGLOCK(), HTTPMSGUNLOCK(), httpsEstablish(), httpsSslBumpAccessCheckDone(), XactionInitiator::initClient, Comm::Connection::local, ConnStateData::log_addr, ClientHttpRequest::log_uri, MAX_IPSTRLEN, ACLFilledChecklist::my_addr, ACLChecklist::nonBlockingCheck(), NULL, Server::pipeline, ConnStateData::port, Ip::Address::port(), AccessLogEntry::CacheDetails::port, AccessLogEntry::proxyProtocolHeader, ConnStateData::proxyProtocolHeader_, Comm::Connection::remote, AccessLogEntry::request, request(), CodeContext::Reset(), ACLFilledChecklist::src_addr, SquidConfig::ssl_bump, AccessLogEntry::CacheDetails::start_time, ACLFilledChecklist::syncAle(), MasterXaction::tcpClient, AccessLogEntry::tcpClient, Ip::Address::toStr(), and _request::url.

◆ prepareTlsSwitchingURL()

char * ConnStateData::prepareTlsSwitchingURL ( const Http1::RequestParserPointer & hp )

inherited

Definition at line 1221 of file client_side.cc.

References buildUrlFromHost(), debugs, AnyP::UriScheme::image(), SBuf::isEmpty(), SBuf::length(), Must, AnyP::ProtocolVersion::protocol, SQUIDSBUFPH, SQUIDSBUFPRINT, ConnStateData::switchedToHttps(), ConnStateData::tlsClientSni(), ConnStateData::tlsConnectHostOrIp, ConnStateData::tlsConnectPort, Server::transferProtocol, and xcalloc.

Referenced by ConnStateData::parseHttpRequest().

◆ proceedAfterBodyContinuation()

void Server::proceedAfterBodyContinuation ( Http::StreamPointer context )

protected

Definition at line 230 of file Http1Server.cc.

References clientProcessRequest(), debugs, and RefCount< C >::getRaw().

Referenced by processParsedRequest().

◆ processHttpRequest()

void Http::One::Server::processHttpRequest ( Http::Stream *const context )

private

◆ processParsedRequest()

void Server::processParsedRequest ( Http::StreamPointer & )

protectedvirtual

◆ proxyProtocolError()

bool ConnStateData::proxyProtocolError ( const char * msg )

privateinherited

Perform cleanup on PROXY protocol errors. If header parsing hits a fatal error terminate the connection, otherwise wait for more data.

Definition at line 1831 of file client_side.cc.

References Server::clientConnection, DBG_IMPORTANT, debugs, and AsyncJob::mustStop().

Referenced by ConnStateData::parseProxyProtocolHeader(), and ConnStateData::proxyProtocolValidateClient().

◆ proxyProtocolHeader()

const ProxyProtocol::HeaderPointer& ConnStateData::proxyProtocolHeader ( ) const

inlineinherited

Definition at line 325 of file client_side.h.

References ConnStateData::proxyProtocolHeader_.

Referenced by ClientHttpRequest::ClientHttpRequest().

◆ proxyProtocolValidateClient()

bool ConnStateData::proxyProtocolValidateClient ( )

privateinherited

Perform proxy_protocol_access ACL tests on the client which connected to PROXY protocol port to see if we trust the sender enough to accept their PROXY header claim.

Definition at line 1809 of file client_side.cc.

References SquidConfig::accessList, Acl::Answer::allowed(), Server::clientConnection, Config, ACLFilledChecklist::conn(), ACLChecklist::fastCheck(), Comm::Connection::local, ACLFilledChecklist::my_addr, NULL, SquidConfig::proxyProtocol, ConnStateData::proxyProtocolError(), Comm::Connection::remote, Comm::Connection::rfc931, and ACLFilledChecklist::src_addr.

Referenced by ConnStateData::start().

◆ quitAfterError()

void ConnStateData::quitAfterError ( HttpRequest * request )

inherited

Changes state so that we close the connection and quit after serving the client-side-detected error response instead of getting stuck.

Definition at line 1457 of file client_side.cc.

References Server::clientConnection, debugs, ConnStateData::flags, HERE(), and request().

Referenced by ConnStateData::serveDelayedError().

◆ reading()

bool Server::reading ( ) const

inlineinherited

Definition at line 57 of file Server.h.

References NULL, and Server::reader.

Referenced by Server::doClientRead(), Server::readSomeData(), and Server::stopReading().

◆ readNextRequest()

void ConnStateData::readNextRequest ( )

inherited

Set the timeout BEFORE calling readSomeData().

Please don't do anything with the FD past here!

Definition at line 859 of file client_side.cc.

References Server::clientConnection, commSetConnTimeout(), debugs, Comm::Connection::fd, fd_note(), HERE(), ConnStateData::idleTimeout(), JobCallback, Server::readSomeData(), ConnStateData::requestTimeout(), and Comm::Connection::timeLeft().

Referenced by ConnStateData::kick().

◆ readSomeData()

void Server::readSomeData ( )

inherited

Definition at line 85 of file Server.cc.

References Server::clientConnection, Config, debugs, Server::doClientRead(), Server::inBuf, JobCallback, SBuf::length(), SquidConfig::maxRequestBufferSize, Comm::Read(), Server::reader, and Server::reading().

Referenced by ConnStateData::clientAfterReadingRequests(), Server::doClientRead(), ConnStateData::parseTlsHandshake(), ConnStateData::readNextRequest(), and ConnStateData::switchToHttps().

◆ readSomeHttpData()

void Http::One::Server::readSomeHttpData ( )

◆ receivedFirstByte()

void ConnStateData::receivedFirstByte ( )

virtualinherited

Implements Server.

Definition at line 1877 of file client_side.cc.

References Server::clientConnection, commSetConnTimeout(), Config, JobCallback, Server::receivedFirstByte_, SquidConfig::request, ConnStateData::requestTimeout(), and SquidConfig::Timeout.

Referenced by ConnStateData::parseTlsHandshake().

◆ registerRunner()

void IndependentRunner::registerRunner ( )

protectedinherited

Definition at line 104 of file RunnersRegistry.cc.

References FindRunners(), and RegisterRunner_().

Referenced by ConnStateData::ConnStateData(), and IdleConnList::IdleConnList().

◆ requestTimeout()

void ConnStateData::requestTimeout ( const CommTimeoutCbParams & io )

inherited

general lifetime handler for HTTP requests

Definition at line 2152 of file client_side.cc.

References Comm::Connection::close(), CommCommonCbParams::conn, debugs, ERR_REQUEST_PARSE_TIMEOUT, ERR_REQUEST_START_TIMEOUT, error(), CommCommonCbParams::fd, Comm::IsConnOpen(), Server::receivedFirstByte_, and ConnStateData::tunnelOnError().

Referenced by ConnStateData::getSslContextDone(), httpsEstablish(), ConnStateData::readNextRequest(), ConnStateData::receivedFirstByte(), start(), and ConnStateData::switchToHttps().

◆ resetSslCommonName()

void ConnStateData::resetSslCommonName ( const char * name )

inlineinherited

Definition at line 258 of file client_side.h.

References ConnStateData::sslCommonName_.

Referenced by ConnStateData::parseTlsHandshake(), and ConnStateData::switchToHttps().

◆ sendControlMsg()

void ConnStateData::sendControlMsg ( HttpControlMsg msg )

virtualinherited

Implements HttpControlMsgSink.

Definition at line 3721 of file client_side.cc.

References HttpControlMsgSink::cbControlMsgSent, HttpControlMsg::cbSuccess, Server::clientConnection, Comm::Connection::close(), debugs, ConnStateData::doneWithControlMsg(), Pipeline::empty(), Pipeline::front(), RefCount< C >::getRaw(), HERE(), ConnStateData::isOpen(), JobCallback, Must, Server::pipeline, HttpControlMsg::reply, ConnStateData::writeControlMsgAndCall(), and HttpControlMsgSink::wroteControlMsg().

Referenced by Ftp::Relay::forwardPreliminaryReply(), and HttpStateData::handle1xx().

◆ serveDelayedError()

bool ConnStateData::serveDelayedError ( Http::Stream * context )

inherited

Called when the client sends the first request on a bumped connection. Returns false if no [delayed] error should be written to the client. Otherwise, writes the error to the client and returns true. Also checks for SQUID_X509_V_ERR_DOMAIN_MISMATCH on bumped requests.

Definition at line 1469 of file client_side.cc.

References ACLFilledChecklist::al, ClientHttpRequest::al, Acl::Answer::allowed(), assert, SquidConfig::cert_error, Ssl::checkX509ServerValidity(), Server::clientConnection, Config, dash_str, debugs, HttpRequest::detailError(), Ssl::ServerBump::entry, ERR_SECURE_CONNECT_FAIL, HttpRequest::errDetail, HttpRequest::errType, ACLChecklist::fastCheck(), Http::Stream::getClientReplyContext(), HttpRequest::hier, Http::Stream::http, StoreEntry::isEmpty(), ClientHttpRequest::log_uri, _request::method, NULL, ClientHttpRequest::Out::offset, ClientHttpRequest::out, Http::Stream::pullData(), ConnStateData::quitAfterError(), Comm::Connection::remote, Ssl::ServerBump::request, ClientHttpRequest::request, request(), Http::scServiceUnavailable, Ssl::ServerBump::serverCert, clientReplyContext::setReplyToError(), clientReplyContext::setReplyToStoreEntry(), SQUID_X509_V_ERR_DOMAIN_MISMATCH, SquidConfig::ssl_client, ACLFilledChecklist::sslErrors, ConnStateData::sslServerBump, ACLFilledChecklist::syncAle(), ClientHttpRequest::uri, and _request::url.

◆ serverBump()

Ssl::ServerBump* ConnStateData::serverBump ( )

inlineinherited

Definition at line 250 of file client_side.h.

References ConnStateData::sslServerBump.

Referenced by Format::Format::assemble(), TunnelStateData::clientExpectsConnectResponse(), httpsSslBumpStep2AccessCheckDone(), ACLServerCertificateStrategy::match(), and ClientRequestContext::sslBumpAccessCheck().

◆ setAuth()

void ConnStateData::setAuth	(	const Auth::UserRequest::Pointer &	aur,
		const char *	cause
	)

inherited

Set the user details for connection-based authentication to use from now until connection closure.

Any change to existing credentials shows that something invalid has happened. Such as:

NTLM/Negotiate auth was violated by the per-request headers missing a revalidation token
NTLM/Negotiate auth was violated by the per-request headers being for another user
SSL-Bump CONNECT tunnel with persistent credentials has ended

Definition at line 510 of file client_side.cc.

References ConnStateData::auth_, Server::clientConnection, comm_reset_close(), debugs, NULL, Auth::UserRequest::releaseAuthServer(), and ConnStateData::stopReceiving().

Referenced by ProxyAuthLookup::LookupDone(), ClientHttpRequest::sslBumpEstablish(), and ConnStateData::swanSong().

◆ setReplyError()

void Server::setReplyError	(	Http::StreamPointer &	context,
		HttpRequest::Pointer &	request,
		const HttpRequestMethod &	method,
		err_type	requestError,
		Http::StatusCode	errStatusCode,
		const char *	requestErrorBytes
	)

private

Definition at line 211 of file Http1Server.cc.

References assert, debugs, method, request(), and clientReplyContext::setReplyToError().

◆ setServerBump()

void ConnStateData::setServerBump ( Ssl::ServerBump * srvBump )

inlineinherited

Definition at line 251 of file client_side.h.

References assert, and ConnStateData::sslServerBump.

Referenced by ClientHttpRequest::doCallouts().

◆ shouldPreserveClientData()

bool ConnStateData::shouldPreserveClientData ( ) const

inherited

whether we should start saving inBuf client bytes in anticipation of tunneling them to the server later (on_unsupported_protocol)

Definition at line 4046 of file client_side.cc.

References SquidConfig::accessList, Config, ConnStateData::needProxyProtocolHeader_, Pipeline::nrequests, SquidConfig::on_unsupported_protocol, ConnStateData::parsedBumpedRequestCount, ConnStateData::parsingTlsHandshake, Server::pipeline, ConnStateData::port, AnyP::PROTO_FTP, ConnStateData::switchedToHttps(), and ConnStateData::transparent().

Referenced by ConnStateData::start(), and ConnStateData::switchToHttps().

◆ splice()

bool ConnStateData::splice ( )

inherited

◆ sslCommonName()

const SBuf& ConnStateData::sslCommonName ( ) const

inlineinherited

Definition at line 257 of file client_side.h.

References ConnStateData::sslCommonName_.

◆ sslCrtdHandleReply()

void ConnStateData::sslCrtdHandleReply ( const Helper::Reply & reply )

inherited

Definition at line 2680 of file client_side.cc.

References Ssl::ServerBump::act, Ssl::algSignTrusted, Helper::BrokenHelper, Ssl::bumpPeek, Ssl::bumpStare, Server::clientConnection, Ssl::configureSSLUsingPkeyAndCertFromMemory(), Ssl::configureUnconfiguredSslContext(), MemBuf::content(), MemBuf::contentSize(), DBG_IMPORTANT, debugs, ConnStateData::doPeekAndSpliceStep(), Comm::Connection::fd, fd_table, Ssl::GenerateSslContextUsingPkeyAndCertFromMemory(), Ssl::CrtdMessage::getBody(), Security::GetFrom(), ConnStateData::getSslContextDone(), MemBuf::hasContent(), HERE(), SBuf::isEmpty(), ConnStateData::isOpen(), Store::nil, Ssl::CrtdMessage::OK, Helper::Okay, Helper::Reply::other(), Ssl::CrtdMessage::parse(), ConnStateData::port, Ssl::CrtdMessage::REPLY, Helper::Reply::result, ConnStateData::signAlgorithm, ConnStateData::sslBumpCertKey, ConnStateData::sslServerBump, Ssl::ServerBump::step1, ConnStateData::storeTlsContextToCache(), and ConnStateData::tlsConnectHostOrIp.

Referenced by ConnStateData::sslCrtdHandleReplyWrapper().

◆ sslCrtdHandleReplyWrapper()

void ConnStateData::sslCrtdHandleReplyWrapper	(	void *	data,
		const Helper::Reply &	reply
	)

staticinherited

Definition at line 2673 of file client_side.cc.

References data, and ConnStateData::sslCrtdHandleReply().

Referenced by ConnStateData::getSslContextStart().

◆ start()

void Server::start ( )

protectedvirtual

Reimplemented from ConnStateData.

Definition at line 41 of file Http1Server.cc.

References commSetConnTimeout(), Config, JobCallback, SquidConfig::request_start_timeout, ConnStateData::requestTimeout(), ConnStateData::start(), and SquidConfig::Timeout.

◆ Start()

AsyncJob::Pointer AsyncJob::Start ( AsyncJob * job )

staticinherited

Definition at line 23 of file AsyncJob.cc.

References CallJobHere, and AsyncJob::start().

Referenced by Ftp::Server::AcceptCtrlConnection(), Ftp::Server::checkDataConnPre(), clientListenerConnectionOpened(), Ftp::Client::connectDataChannel(), TunnelStateData::connectedToPeer(), FwdState::connectStart(), TunnelStateData::connectToPeer(), Adaptation::Icap::Xaction::dnsLookupDone(), Log::TcpLogger::doConnect(), FwdState::establishTunnelThruProxy(), Ipc::Coordinator::handleCacheMgrRequest(), PeerPoolMgr::handleOpenedConnection(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), Ftp::Server::listenForDataConnection(), Adaptation::Icap::Xaction::noteCommConnected(), Log::TcpLogger::Open(), HappyConnOpener::openFreshConnection(), PeerPoolMgr::openNewConnection(), peerProbeConnect(), Rock::SwapDir::rebuild(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), FwdState::secureConnectionToPeerIfNeeded(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), Ident::Start(), Adaptation::AccessCheck::Start(), CacheManager::start(), Security::PeerConnector::startCertDownloading(), TunnelStateData::startConnecting(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

◆ startDechunkingRequest()

void ConnStateData::startDechunkingRequest ( )

protectedinherited

Definition at line 3688 of file client_side.cc.

References assert, ConnStateData::bodyParser, ConnStateData::bodyPipe, debugs, HERE(), Must, NULL, and BodyPipe::status().

Referenced by ConnStateData::expectRequestBody().

◆ startPeekAndSplice()

void ConnStateData::startPeekAndSplice ( )

inherited

Definition at line 3123 of file client_side.cc.

References ACCESS_ALLOWED, SquidConfig::accessList, ACLFilledChecklist::al, ClientHttpRequest::al, assert, Ssl::ServerBump::at(), ACLChecklist::banAction(), BIO_get_data(), Ssl::bumpClientFirst, Ssl::bumpNone, Ssl::bumpServerFirst, SBuf::clear(), Server::clientConnection, clientTunnelOnError(), Comm::Connection::close(), Config, Ssl::createSSLContext(), debugs, Ssl::ServerBump::entry, ERR_SECURE_ACCEPT_FAIL, Comm::Connection::fd, fd_table, Pipeline::front(), RefCount< C >::getRaw(), Ssl::ClientBio::hold(), httpsCreate(), httpsSslBumpStep2AccessCheckDone(), Server::inBuf, ClientHttpRequest::log_uri, ACLChecklist::nonBlockingCheck(), NULL, Server::pipeline, ConnStateData::port, Ssl::ServerBump::request, ClientHttpRequest::request, request(), Ssl::ClientBio::setReadBufData(), SquidConfig::ssl_bump, ConnStateData::sslServerBump, FwdState::Start(), Ssl::ServerBump::step, ConnStateData::switchedToHttps_, ACLFilledChecklist::syncAle(), tlsAttemptHandshake(), tlsBump1, and tlsBump2.

Referenced by httpsSslBumpStep2AccessCheckDone(), and ConnStateData::parseTlsHandshake().

◆ startPinnedConnectionMonitoring()

void ConnStateData::startPinnedConnectionMonitoring ( )

protectedinherited

[re]start monitoring pinned connection for peer closures so that we can propagate them to an idle client pinned to that peer

Definition at line 3851 of file client_side.cc.

References ConnStateData::clientPinnedConnectionRead(), JobCallback, NULL, ConnStateData::pinning, and Comm::Read().

Referenced by ConnStateData::handleIdleClientPinnedTlsRead(), and ConnStateData::notePinnedConnectionBecameIdle().

◆ startReconfigure()

virtual void RegisteredRunner::startReconfigure ( )

inlinevirtualinherited

Called after receiving a reconfigure request and before parsing squid.conf. Meant for modules that need to prepare for their configuration being changed [outside their control]. The changes end with the syncConfig() event.

Reimplemented in Dns::ConfigRr.

Definition at line 63 of file RunnersRegistry.h.

Referenced by mainReconfigureStart().

◆ startShutdown()

void ConnStateData::startShutdown ( )

virtualinherited

Called after receiving a shutdown request and before stopping the main loop. At least one main loop iteration is guaranteed after this call. Meant for cleanup and state saving that may require other modules.

Reimplemented from RegisteredRunner.

Definition at line 1035 of file client_side.cc.

References Pipeline::empty(), ConnStateData::endingShutdown(), and Server::pipeline.

◆ status()

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

Reimplemented in HappyConnOpener, Adaptation::Icap::ServiceRep, Adaptation::Icap::Xaction, Security::PeerConnector, Adaptation::Ecap::XactionRep, Http::Tunneler, Adaptation::Initiate, Comm::TcpAcceptor, and Ipc::Inquirer.

Definition at line 159 of file AsyncJob.cc.

References buf, NULL, and AsyncJob::stopReason.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), Comm::TcpAcceptor::status(), and Adaptation::Initiate::status().

◆ stoppedReceiving()

const char* ConnStateData::stoppedReceiving ( ) const

inlineinherited

Definition at line 152 of file client_side.h.

References ConnStateData::stoppedReceiving_.

Referenced by ConnStateData::kick(), ConnStateData::stopReceiving(), and ConnStateData::stopSending().

◆ stoppedSending()

const char* ConnStateData::stoppedSending ( ) const

inlineinherited

Definition at line 154 of file client_side.h.

References ConnStateData::stoppedSending_.

Referenced by ConnStateData::handleRequestBodyData(), ConnStateData::stopReceiving(), and ConnStateData::stopSending().

◆ stopPinnedConnectionMonitoring()

void ConnStateData::stopPinnedConnectionMonitoring ( )

inherited

Definition at line 3863 of file client_side.cc.

References NULL, ConnStateData::pinning, and Comm::ReadCancel().

Referenced by ConnStateData::borrowPinnedConnection(), and ConnStateData::unpinConnection().

◆ stopProducingFor()

void BodyProducer::stopProducingFor	(	RefCount< BodyPipe > &	p,
		bool	atEof
	)

protectedinherited

Definition at line 107 of file BodyPipe.cc.

References assert, debugs, NULL, and p.

Referenced by Client::cleanAdaptation(), ConnStateData::finishDechunkingRequest(), Client::noteBodyConsumerAborted(), Client::serverComplete2(), and ConnStateData::~ConnStateData().

◆ stopReading()

void Server::stopReading ( )

inherited

Definition at line 56 of file Server.cc.

References Server::clientConnection, Comm::Connection::fd, NULL, Comm::ReadCancel(), Server::reader, and Server::reading().

Referenced by ClientHttpRequest::processRequest().

◆ stopReceiving()

void ConnStateData::stopReceiving ( const char * error )

inherited

Definition at line 3658 of file client_side.cc.

References Server::clientConnection, Comm::Connection::close(), debugs, error(), HERE(), ConnStateData::stoppedReceiving(), ConnStateData::stoppedReceiving_, ConnStateData::stoppedSending(), and ConnStateData::stoppedSending_.

Referenced by ConnStateData::setAuth().

◆ stopSending()

void ConnStateData::stopSending ( const char * error )

inherited

Definition at line 980 of file client_side.cc.

References Server::clientConnection, Comm::Connection::close(), debugs, error(), HERE(), Server::inBuf, SBuf::length(), ConnStateData::mayNeedToReadMoreBody(), ConnStateData::stoppedReceiving(), ConnStateData::stoppedReceiving_, ConnStateData::stoppedSending(), and ConnStateData::stoppedSending_.

◆ storeTlsContextToCache()

void ConnStateData::storeTlsContextToCache	(	const SBuf &	cacheKey,
		Security::ContextPointer &	ctx
	)

privateinherited

Attempts to add a given TLS context to the cache, replacing the old same-key context, if any

Definition at line 2818 of file client_side.cc.

References LruMap< Key, EntryValue, EntryCost >::add(), Server::clientConnection, Comm::Connection::fd, fd_table, Ssl::GlobalContextStorage::getLocalStorage(), ConnStateData::port, and Ssl::TheGlobalContextStorage.

Referenced by ConnStateData::getSslContextStart(), and ConnStateData::sslCrtdHandleReply().

◆ swanSong()

void ConnStateData::swanSong ( )

virtualinherited

Reimplemented from Server.

Definition at line 591 of file client_side.cc.

References ConnStateData::checkLogging(), Server::clientConnection, clientdbEstablished(), debugs, ConnStateData::flags, HERE(), NULL, Server::pipeline, Comm::Connection::remote, ConnStateData::setAuth(), Server::swanSong(), Pipeline::terminateAll(), and ConnStateData::unpinConnection().

◆ switchedToHttps()

bool ConnStateData::switchedToHttps ( ) const

inlineinherited

Definition at line 249 of file client_side.h.

References ConnStateData::switchedToHttps_.

Referenced by ConnStateData::buildFakeRequest(), ConnStateData::clientParseRequests(), ConnStateData::parseHttpRequest(), ConnStateData::prepareTlsSwitchingURL(), ConnStateData::shouldPreserveClientData(), and ClientRequestContext::sslBumpAccessCheck().

◆ switchToHttps()

void ConnStateData::switchToHttps	(	ClientHttpRequest *	http,
		Ssl::BumpMode	bumpServerMode
	)

inherited

Definition at line 2937 of file client_side.cc.

References assert, Ssl::bumpPeek, Ssl::bumpServerFirst, Ssl::bumpStare, Server::clientConnection, commSetConnTimeout(), Config, debugs, ConnStateData::flags, JobCallback, Must, ConnStateData::parsingTlsHandshake, ConnStateData::preservingClientData_, AnyP::PROTO_HTTPS, AnyP::ProtocolVersion::protocol, Server::readSomeData(), Server::receivedFirstByte_, ClientHttpRequest::request, request(), SquidConfig::request_start_timeout, ConnStateData::requestTimeout(), ConnStateData::resetSslCommonName(), ConnStateData::shouldPreserveClientData(), ConnStateData::sslServerBump, ConnStateData::switchedToHttps_, SquidConfig::Timeout, ConnStateData::tlsConnectHostOrIp, ConnStateData::tlsConnectPort, Server::transferProtocol, and _request::url.

Referenced by ClientHttpRequest::sslBumpEstablish().

◆ syncConfig()

virtual void RegisteredRunner::syncConfig ( )

inlinevirtualinherited

Called after parsing squid.conf during reconfiguration. Meant for adjusting the module state based on configuration changes.

Reimplemented in Auth::CredentialCacheRr, and PeerPoolMgrsRr.

Definition at line 67 of file RunnersRegistry.h.

Referenced by mainReconfigureFinish().

◆ tlsClientSni()

const SBuf& ConnStateData::tlsClientSni ( ) const

inlineinherited

Definition at line 259 of file client_side.h.

References ConnStateData::tlsClientSni_.

Referenced by ConnStateData::prepareTlsSwitchingURL().

◆ toCbdata()

virtual void* CbdataParent::toCbdata ( )

pure virtualinherited

Implemented in ClientHttpRequest, HttpStateData, and BodySink.

Referenced by AsyncJob::callException(), and AsyncJob::callStart().

◆ transparent()

bool ConnStateData::transparent ( ) const

inherited

Definition at line 3623 of file client_side.cc.

References Server::clientConnection, COMM_INTERCEPTION, COMM_TRANSPARENT, Comm::Connection::flags, and NULL.

Referenced by ConnStateData::concurrentRequestQueueFilled(), ConnStateData::fakeAConnectRequest(), ConnStateData::initiateTunneledRequest(), ConnStateData::parseHttpRequest(), ConnStateData::shouldPreserveClientData(), ConnStateData::splice(), and ConnStateData::start().

◆ tunnelOnError()

bool ConnStateData::tunnelOnError	(	const HttpRequestMethod &	method,
		const err_type	requestError
	)

inherited

◆ unpinConnection()

void ConnStateData::unpinConnection ( const bool andClose )

inherited

Definition at line 3986 of file client_side.cc.

References cbdataReferenceDone, comm_remove_close_handler(), debugs, HERE(), Comm::IsConnOpen(), NULL, ConnStateData::pinning, safe_free, and ConnStateData::stopPinnedConnectionMonitoring().

Referenced by ConnStateData::borrowPinnedConnection(), ConnStateData::clientPinnedConnectionClosed(), ConnStateData::pinConnection(), Ftp::Relay::serverComplete(), and ConnStateData::swanSong().

◆ unregisterRunner()

void IndependentRunner::unregisterRunner ( )

protectedinherited

Definition at line 96 of file RunnersRegistry.cc.

References FindRunners().

Referenced by IndependentRunner::~IndependentRunner().

◆ useConfig()

virtual void RegisteredRunner::useConfig ( )

inlinevirtualinherited

Called after claimMemoryNeeds(). Meant for activating modules and features using a finalized configuration with known memory requirements.

Reimplemented in MemStoreRr, SharedSessionCacheRr, TransientsRr, PeerPoolMgrsRr, ClientDbRr, SharedMemPagesRr, and Ipc::Mem::RegisteredRunner.

Definition at line 56 of file RunnersRegistry.h.

Referenced by RunConfigUsers().

◆ whenClientIpKnown()

void ConnStateData::whenClientIpKnown ( )

protectedinherited

Perform client data lookups that depend on client src-IP. The PROXY protocol may require some data input first.

Definition at line 2263 of file client_side.cc.

References Acl::Answer::allowed(), assert, ACLChecklist::changeAcl(), SquidConfig::client_db, Server::clientConnection, clientdbEstablished(), clientdbGetInfo(), SquidConfig::ClientDelay, clientIdentDone, Config, debugs, ACLChecklist::fastCheck(), Comm::Connection::fd, fd_table, FQDN_LOOKUP_IF_MISS, fqdncache_gethostbyaddr(), HERE(), ClientDelayConfig::initial, ClientDelayPools::Instance(), Comm::Connection::local, SquidConfig::log_fqdn, ACLFilledChecklist::my_addr, NULL, SquidConfig::onoff, ClientDelayPools::pools, Comm::Connection::remote, ClientInfo::setWriteLimiter(), ACLFilledChecklist::src_addr, Ident::Start(), and Ident::TheConfig.

Referenced by ConnStateData::clientParseRequests(), and ConnStateData::start().

◆ write() [1/2]

void Server::write	(	char *	buf,
		int	len
	)

inlineinherited

Definition at line 76 of file Server.h.

References buf, Server::clientConnection, Server::clientWriteDone(), JobCallback, len, Comm::Write(), and Server::writer.

◆ write() [2/2]

void Server::write ( MemBuf * mb )

inlineinherited

Definition at line 69 of file Server.h.

References Server::clientConnection, Server::clientWriteDone(), JobCallback, Comm::Write(), and Server::writer.

◆ writeControlMsgAndCall()

bool Server::writeControlMsgAndCall	(	HttpReply *	rep,
		AsyncCall::Pointer &	call
	)

protectedvirtual

Implements ConnStateData.

Definition at line 324 of file Http1Server.cc.

References ClientHttpRequest::al, MemBuf::buf, Http::CONNECTION, debugs, Http::Message::header, httpHdrMangleList(), Must, HttpReply::pack(), HttpHeader::putStr(), HttpHeader::removeHopByHopEntries(), HttpReply::removeIrrelevantContentLength(), ClientHttpRequest::request, ROR_REPLY, and Comm::Write().

◆ writeSomeData()

virtual void Server::writeSomeData ( )

inlinevirtualinherited

Definition at line 66 of file Server.h.

Referenced by Server::clientWriteDone().

◆ writing()

bool Server::writing ( ) const

inlineinherited

Definition at line 86 of file Server.h.

References NULL, and Server::writer.

◆ wroteControlMsg()

void HttpControlMsgSink::wroteControlMsg ( const CommIoCbParams & params )

inherited

called when we wrote the 1xx response

Comm::ConnectionPointer Server::clientConnection

inherited

Definition at line 97 of file Server.h.

Referenced by ConnStateData::abortChunkedRequestBody(), ConnStateData::abortRequestParsing(), ConnStateData::afterClientRead(), Format::Format::assemble(), ConnStateData::buildFakeRequest(), ConnStateData::buildSslCertGenerationParams(), ClientHttpRequest::calloutsError(), IdentLookup::checkForAsync(), ClientRequestContext::clientAccessCheckDone(), ConnStateData::clientAfterReadingRequests(), ClientHttpRequest::ClientHttpRequest(), ConnStateData::clientParseRequests(), ConnStateData::clientPinnedConnectionClosed(), ConnStateData::clientPinnedConnectionRead(), ClientRequestContext::clientRedirectDone(), clientSocketRecipient(), Server::clientWriteDone(), ConnStateData::concurrentRequestQueueFilled(), ConnStateData::connFinishedWithConn(), constructHelperQuery(), ClientHttpRequest::doCallouts(), Server::doClientRead(), Server::doneAll(), ConnStateData::doneWithControlMsg(), ConnStateData::doPeekAndSpliceStep(), ConnStateData::endingShutdown(), ESIContext::fail(), ConnStateData::fakeAConnectRequest(), ConnStateData::getSslContextDone(), ConnStateData::getSslContextStart(), ConnStateData::handleChunkedRequestBody(), ConnStateData::handleRequestBodyData(), ClientRequestContext::hostHeaderIpVerify(), ClientRequestContext::hostHeaderVerify(), ClientRequestContext::hostHeaderVerifyFailed(), httpsCreate(), httpsEstablish(), httpsSslBumpAccessCheckDone(), httpsSslBumpStep2AccessCheckDone(), ConnStateData::initiateTunneledRequest(), ConnStateData::isOpen(), ConnStateData::kick(), IdentLookup::LookupDone(), HttpRequest::manager(), ACLIdent::match(), ClientHttpRequest::noteAdaptationAclCheckDone(), ClientHttpRequest::noteBodyProducerAborted(), ConnStateData::parseHttpRequest(), ConnStateData::parseProxyProtocolHeader(), ConnStateData::parseTlsHandshake(), ConnStateData::pinConnection(), ConnStateData::postHttpsAccept(), clientReplyContext::processExpired(), clientReplyContext::processMiss(), clientReplyContext::processOnlyIfCachedMiss(), clientReplyContext::processReplyAccessResult(), ConnStateData::proxyProtocolError(), ConnStateData::proxyProtocolValidateClient(), clientReplyContext::purgeFoundObject(), clientReplyContext::purgeRequest(), ConnStateData::quitAfterError(), ConnStateData::readNextRequest(), Server::readSomeData(), ConnStateData::receivedFirstByte(), PeerSelector::resolveSelected(), clientReplyContext::sendBodyTooLargeError(), ConnStateData::sendControlMsg(), clientReplyContext::sendPreconditionFailedError(), ConnStateData::serveDelayedError(), ConnStateData::setAuth(), ConnStateData::splice(), ClientRequestContext::sslBumpAccessCheckDone(), ClientHttpRequest::sslBumpEstablish(), ClientHttpRequest::sslBumpStart(), ConnStateData::sslCrtdHandleReply(), ConnStateData::start(), ConnStateData::startPeekAndSplice(), Server::stopReading(), ConnStateData::stopReceiving(), ConnStateData::stopSending(), ConnStateData::storeTlsContextToCache(), Server::swanSong(), ConnStateData::swanSong(), ConnStateData::switchToHttps(), ConnStateData::transparent(), ConnStateData::tunnelOnError(), tunnelStart(), TunnelStateData::TunnelStateData(), ConnStateData::whenClientIpKnown(), Server::write(), and ConnStateData::~ConnStateData().

◆ closeHandler

AsyncCall::Pointer ConnStateData::closeHandler

inherited

Definition at line 146 of file client_side.h.

◆ flags

struct { ... } ConnStateData::flags

Referenced by ConnStateData::abortChunkedRequestBody(), ConnStateData::buildFakeRequest(), ConnStateData::clientAfterReadingRequests(), ConnStateData::clientParseRequests(), ConnStateData::ConnStateData(), ClientHttpRequest::doCallouts(), ConnStateData::kick(), ConnStateData::quitAfterError(), Ftp::Server::Server(), ConnStateData::swanSong(), ConnStateData::switchToHttps(), and ConnStateData::~ConnStateData().

◆ host

char* ConnStateData::host

inherited

Definition at line 137 of file client_side.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id

protectedinherited

Definition at line 72 of file AsyncJob.h.

◆ inBuf

SBuf Server::inBuf

inherited

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 71 of file AsyncJob.h.

Referenced by AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::canBeCalled(), AsyncJob::deleteThis(), and AsyncJob::mustStop().

◆ isHttpsServer

const bool Http::One::Server::isHttpsServer

private

Definition at line 63 of file Http1Server.h.

◆ log_addr

Ip::Address ConnStateData::log_addr

inherited

Definition at line 129 of file client_side.h.

Referenced by ClientHttpRequest::ClientHttpRequest(), ConnStateData::ConnStateData(), and ConnStateData::postHttpsAccept().

◆ method_

HttpRequestMethod Http::One::Server::method_

private

Definition at line 60 of file Http1Server.h.

◆ needProxyProtocolHeader_

bool ConnStateData::needProxyProtocolHeader_

privateinherited

Definition at line 402 of file client_side.h.

Referenced by ConnStateData::clientParseRequests(), ConnStateData::parseProxyProtocolHeader(), ConnStateData::shouldPreserveClientData(), and ConnStateData::start().

◆ parsedBumpedRequestCount

uint64_t ConnStateData::parsedBumpedRequestCount

privateinherited

Definition at line 416 of file client_side.h.

Referenced by ConnStateData::clientParseRequests(), and ConnStateData::shouldPreserveClientData().

◆ parser_

Http1::RequestParserPointer Http::One::Server::parser_

private

Definition at line 59 of file Http1Server.h.

◆ parsingTlsHandshake

bool ConnStateData::parsingTlsHandshake

privateinherited

whether we are getting/parsing TLS Hello bytes

Definition at line 414 of file client_side.h.

Referenced by ConnStateData::afterClientRead(), ConnStateData::parseTlsHandshake(), ConnStateData::shouldPreserveClientData(), and ConnStateData::switchToHttps().

◆ peer

CachePeer* ConnStateData::peer

inherited

Definition at line 144 of file client_side.h.

Referenced by clientHttpRequestStatus().

◆ peerAccessDenied

bool ConnStateData::peerAccessDenied

inherited

◆ preservingClientData_

bool ConnStateData::preservingClientData_

protectedinherited

Definition at line 375 of file client_side.h.

Referenced by ConnStateData::clientParseRequests(), ConnStateData::parseHttpRequest(), ConnStateData::start(), ConnStateData::switchToHttps(), and ConnStateData::tunnelOnError().

◆ proxyProtocolHeader_

ProxyProtocol::HeaderPointer ConnStateData::proxyProtocolHeader_

privateinherited

Definition at line 405 of file client_side.h.

Referenced by ConnStateData::parseProxyProtocolHeader(), ConnStateData::postHttpsAccept(), and ConnStateData::proxyProtocolHeader().

◆ reader

AsyncCall::Pointer Server::reader

protectedinherited

Definition at line 124 of file Server.h.

Referenced by Server::doClientRead(), Server::reading(), Server::readSomeData(), and Server::stopReading().

◆ readHandler

AsyncCall::Pointer ConnStateData::readHandler

inherited

Definition at line 145 of file client_side.h.

Tls parser to use for client HELLO messages parsing on bumped connections.

Definition at line 273 of file client_side.h.

Referenced by ConnStateData::parseTlsHandshake().

◆ transferProtocol

AnyP::ProtocolVersion Server::transferProtocol

inherited

The transfer protocol currently being spoken on this connection. HTTP/1.x CONNECT, HTTP/1.1 Upgrade and HTTP/2 SETTINGS offer the ability to change protocols on the fly.

Definition at line 104 of file Server.h.

Referenced by ConnStateData::parseHttpRequest(), ConnStateData::prepareTlsSwitchingURL(), ConnStateData::splice(), and ConnStateData::switchToHttps().

◆ typeName

const char* AsyncJob::typeName

protectedinherited

Definition at line 70 of file AsyncJob.h.

Referenced by AsyncJob::AsyncJob(), AsyncJob::callEnd(), AsyncJob::callStart(), AsyncJob::deleteThis(), AsyncJob::mustStop(), Adaptation::Icap::Xaction::Xaction(), and AsyncJob::~AsyncJob().

◆ writer

AsyncCall::Pointer Server::writer

protectedinherited

Definition at line 125 of file Server.h.

Referenced by Server::clientWriteDone(), Server::write(), and Server::writing().

◆ zeroReply

bool ConnStateData::zeroReply

inherited

Definition at line 142 of file client_side.h.

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

src/servers/Http1Server.h
src/servers/Http1Server.cc

squid-cache.org

Optimising Web Delivery

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Method

◆ Pointer [1/2]

◆ Pointer [2/2]

Constructor & Destructor Documentation

◆ Server()

◆ ~Server()

Member Function Documentation

◆ abortChunkedRequestBody()

◆ abortRequestParsing()

◆ afterClientRead()

◆ afterClientWrite()

◆ BorrowPinnedConnection()

◆ borrowPinnedConnection()

◆ buildFakeRequest()

◆ buildHttpRequest()

◆ buildSslCertGenerationParams()

◆ callEnd()

◆ callException()

◆ callStart()

◆ canBeCalled()

◆ CBDATA_CLASS()

◆ checkLogging()

◆ claimMemoryNeeds()

◆ clientAfterReadingRequests()

◆ clientParseRequests()

◆ clientPinnedConnectionClosed()

◆ clientPinnedConnectionRead()

◆ clientReadFtpData()

◆ clientWriteDone()

◆ concurrentRequestQueueFilled()

◆ connFinishedWithConn()

◆ connStateClosed()

◆ consumeInput()

◆ deleteThis()

◆ doClientRead()

◆ done()

◆ doneAll()

◆ doneWithControlMsg()

◆ doPeekAndSpliceStep()

◆ endingShutdown()

◆ expectNoForwarding()

◆ expectRequestBody()

◆ fakeAConnectRequest()

◆ finalizeConfig()

◆ finishDechunkingRequest()

◆ finishShutdown()

◆ getAuth()

◆ getSslContextDone()

◆ getSslContextStart()

◆ getTlsContextFromCache()

◆ handleChunkedRequestBody()

◆ handleHttpRequestData()

◆ handleIdleClientPinnedTlsRead()

◆ handleReadData()

◆ handleReply()

◆ handleRequestBodyData()

◆ hasNotes()

◆ httpsPeeked()

◆ idleTimeout()

◆ initiateTunneledRequest()

◆ isOpen()

◆ kick()

◆ maybeMakeSpaceAvailable()

◆ mayNeedToReadMoreBody()

◆ mustStop()

◆ noteBodyConsumerAborted()

◆ noteMoreBodySpaceAvailable()