Manages a control connection from an FTP client. More...

#include <FtpServer.h>

Inheritance diagram for Ftp::Server:

[legend]

Collaboration diagram for Ftp::Server:

[legend]

Public Types
typedef CbcPointer< AsyncJob >	Pointer

typedef CbcPointer< BodyProducer >	Pointer

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

	~Server () override

void	callException (const std::exception &e) override
	called when the job throws during an async call More...

void	startWaitingForOrigin ()

void	stopWaitingForOrigin (int status)

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

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

bool	handleReadData () override

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

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

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

void	doneWithControlMsg () override

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	resetReadTimeout (time_t timeout)
	(re)sets timeout for receiving more bytes from the client More...

void	extendLifetime ()
	(re)sets client_lifetime timeout 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	noteTakeServerConnectionControl (ServerConnectionContext)

void	clientReadFtpData (const CommIoCbParams &io)

void	connStateClosed (const CommCloseCbParams &io)

void	requestTimeout (const CommTimeoutCbParams &params)

void	lifetimeTimeout (const CommTimeoutCbParams &params)

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

void	swanSong () override

void	quitAfterError (HttpRequest *request)

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

Security::IoResult	acceptTls ()

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	add (const Http::StreamPointer &context)
	registers a newly created stream More...

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, const char *reason, const SBuf &payload)
	generates and sends to tunnel.cc a fake request with a given payload More...

bool	shouldPreserveClientData () const

ClientHttpRequest *	buildFakeRequest (SBuf &useHost, AnyP::KnownPort usePort, const SBuf &payload)
	build a fake http request More...

void	startShutdown () override

void	endingShutdown () override

NotePairs::Pointer	notes ()

bool	hasNotes () const

const ProxyProtocol::HeaderPointer &	proxyProtocolHeader () const

void	updateError (const Error &)
	if necessary, stores new error information (if any) More...

void	updateError (const err_type c, const ErrorDetailPointer &d)
	emplacement/convenience wrapper for updateError(const Error &) More...

void	fillChecklist (ACLFilledChecklist &) const override
	configure the given checklist (to reflect the current transaction state) More...

void	fillConnectionLevelDetails (ACLFilledChecklist &) 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...

void	handleStopRequest ()
	process external request to terminate now (i.e. during this 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 void	Start (const Pointer &job)

Public Attributes
MasterState::Pointer	master
	info shared among our FTP client and server jobs More...

Http1::TeChunkedParser *	bodyParser = nullptr
	parses HTTP/1.1 chunked request body More...

Ip::Address	log_addr

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

bool swanSang = false

}	flags

struct {
Comm::ConnectionPointer serverConnection

char * host = nullptr
	host name of pinned connection More...

AnyP::Port port
	destination port of the request that caused serverConnection More...

bool pinned = false
	this connection was pinned More...

bool auth = false
	pinned for www authentication More...

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

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

bool peerAccessDenied = false
	cache_peer_access denied pinned connection reuse More...

CachePeer * peer = nullptr
	CachePeer the connection goes via. More...

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

AsyncCall::Pointer closeHandler
	The close handler for pinned server side connection. More...

}	pinning

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

Security::HandshakeParser	tlsParser

SBuf	preservedClientData

Error	bareError
	a problem that occurred without a request (e.g., while parsing headers) More...

Security::KeyLogger	keyLogger
	managers logging of the being-accepted TLS connection secrets More...

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...

const InstanceId< AsyncJob >	id
	job identifier More...

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

Protected Types
enum class	EarlyErrorKind { HugeRequest , MissingLogin , MissingUsername , MissingHost , UnsupportedCommand , InvalidUri , MalformedCommand }

typedef bool(Ftp::Server::*	RequestHandler) (String &cmd, String &params)
	a method handling an FTP command; selected by handleRequest() More...

typedef void(Ftp::Server::*	ReplyHandler) (const HttpReply *reply, StoreIOBuffer data)
	a method handling an FTP response; selected by handleReply() More...

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

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

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

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

void	handleReply (HttpReply *header, StoreIOBuffer receivedData) override

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

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

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

void	noteMoreBodySpaceAvailable (BodyPipe::Pointer) override

void	noteBodyConsumerAborted (BodyPipe::Pointer ptr) override

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

void	acceptDataConnection (const CommAcceptCbParams &params)

void	readUploadData (const CommIoCbParams &io)
	imports more upload data from the data connection More...

void	wroteEarlyReply (const CommIoCbParams &io)

void	wroteReply (const CommIoCbParams &io)

void	wroteReplyData (const CommIoCbParams &io)
	called when we are done writing a chunk of the response data More...

void	connectedForData (const CommConnectCbParams &params)
	Done establishing a data connection to the user. More...

unsigned int	listenForDataConnection ()

bool	createDataConnection (Ip::Address cltAddr)
	[Re]initializes dataConn for active data transfers. Does not connect. More...

void	closeDataConnection ()

void	userDataCompletionCheckpoint (int finalStatusCode)

void	completeDataDownload ()

void	calcUri (const SBuf *file)
	computes uri member from host and, if tracked, working dir with file name More...

void	changeState (const Ftp::ServerState newState, const char *reason)

Http::Stream *	handleUserRequest (const SBuf &cmd, SBuf &params)

bool	checkDataConnPost () const
	Check that client data connection is ready for immediate I/O. More...

void	replyDataWritingCheckpoint ()
	ClientStream checks after (actual or skipped) reply data writing. More...

void	maybeReadUploadData ()
	schedules another data connection read if needed More...

void	setReply (const int code, const char *msg)

void	writeCustomReply (const int code, const char msg, const HttpReply reply=nullptr)

void	writeEarlyReply (const int code, const char *msg)

void	writeErrorReply (const HttpReply *reply, const int status)
	writes FTP error response with given status and reply-derived error details More...

void	writeForwardedForeign (const HttpReply *reply)

void	writeForwardedReply (const HttpReply *reply)

void	writeForwardedReplyAndCall (const HttpReply *reply, AsyncCall::Pointer &call)

void	writeReply (MemBuf &mb)

Http::Stream *	earlyError (const EarlyErrorKind eek)
	creates a context filled with an error message for a given early error More...

bool	handleRequest (HttpRequest *)

void	setDataCommand ()

bool	checkDataConnPre ()

bool	handleFeatRequest (String &cmd, String &params)

bool	handlePasvRequest (String &cmd, String &params)

bool	handlePortRequest (String &cmd, String &params)

bool	handleDataRequest (String &cmd, String &params)

bool	handleUploadRequest (String &cmd, String &params)

bool	handleEprtRequest (String &cmd, String &params)

bool	handleEpsvRequest (String &cmd, String &params)

bool	handleCwdRequest (String &cmd, String &params)

bool	handlePassRequest (String &cmd, String &params)

bool	handleCdupRequest (String &cmd, String &params)

void	handleFeatReply (const HttpReply *header, StoreIOBuffer receivedData)

void	handlePasvReply (const HttpReply *header, StoreIOBuffer receivedData)

void	handlePortReply (const HttpReply *header, StoreIOBuffer receivedData)

void	handleErrorReply (const HttpReply *header, StoreIOBuffer receivedData)

void	handleDataReply (const HttpReply *header, StoreIOBuffer receivedData)

void	handleUploadReply (const HttpReply *header, StoreIOBuffer receivedData)

void	handleEprtReply (const HttpReply *header, StoreIOBuffer receivedData)

void	handleEpsvReply (const HttpReply *header, StoreIOBuffer receivedData)

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 &)

void	whenClientIpKnown ()

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

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)

Static Protected Member Functions
static void	AcceptCtrlConnection (const CommAcceptCbParams &params)
	accept a new FTP control connection and hand it to a dedicated Server More...

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

bool	preservingClientData_ = false
	whether preservedClientData is valid and should be kept up to date 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...

bool	started_ = false
	Start() has finished successfully. More...

bool	swanSang_ = false
	swanSong() was called More...

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

Private Member Functions
	CBDATA_CHILD (Server)

void	doProcessRequest ()
	react to the freshly parsed request More...

void	shovelUploadData ()
	shovel upload data from the internal buffer to the body pipe if possible More...

void	resetLogin (const char *reason)
	clear client and server login-related state after the old login is gone More...

void	terminateAll (const Error &, const LogTagsErrors &) override
	abort any pending transactions and prevent new ones (by closing) More...

bool	shouldCloseOnEof () const override
	whether to stop serving our client after reading EOF on its connection More...

void	checkLogging ()
	log the last (attempt at) transaction if nobody else did 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	handleSslBumpHandshakeError (const Security::IoResult &)
	process a problematic Security::Accept() result on the SslBump code path More...

virtual void	finalizedInCbdataChild ()=0
	hack: ensure CBDATA_CHILD() after a toCbdata()-defining CBDATA_INTERMEDIATE() More...

void	registerRunner ()

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

virtual void	bootstrapConfig ()

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
SBuf	uri
	a URI reconstructed from various FTP message details More...

SBuf	host
	intended dest. of a transparently intercepted FTP conn More...

bool	gotEpsvAll
	restrict data conn setup commands to just EPSV More...

AsyncCall::Pointer	onDataAcceptCall
	who to call upon data conn acceptance More...

Comm::ConnectionPointer	dataListenConn
	data connection listening socket More...

Comm::ConnectionPointer	dataConn
	data connection More...

char	uploadBuf [CLIENT_REQ_BUF_SZ]
	data connection input buffer More...

size_t	uploadAvailSize
	number of yet unused uploadBuf bytes More...

AsyncCall::Pointer	listener
	set when we are passively listening More...

JobWait< Comm::ConnOpener >	dataConnWait

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

bool	waitingForOrigin
	whether we wait for the origin data transfer to end More...

bool	originDataDownloadAbortedOnError
	whether the origin data transfer aborted More...

HttpReply::Pointer	delayedReply
	a response which writing was postponed until stopWaitingForOrigin() More...

bool	needProxyProtocolHeader_ = false
	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_ = false

bool	parsingTlsHandshake = false

uint64_t	parsedBumpedRequestCount = 0
	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...

AnyP::Port	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 = nullptr
	HTTPS server cert. fetching state for bump-ssl-server-first. More...

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

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

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

NotePairs::Pointer	theNotes

Friends
void	StartListening ()
	accept connections on all configured ftp_ports More...

Detailed Description

Definition at line 57 of file FtpServer.h.

Member Typedef Documentation

◆ Method

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

inherited

Definition at line 94 of file RunnersRegistry.h.

◆ Pointer [1/2]

typedef CbcPointer<AsyncJob> AsyncJob::Pointer

inherited

Definition at line 34 of file AsyncJob.h.

◆ Pointer [2/2]

typedef CbcPointer<BodyProducer> BodyProducer::Pointer

inherited

Definition at line 25 of file BodyPipe.h.

◆ ReplyHandler

typedef void(Ftp::Server::* Ftp::Server::ReplyHandler) (const HttpReply *reply, StoreIOBuffer data)

protected

Definition at line 168 of file FtpServer.h.

◆ RequestHandler

typedef bool(Ftp::Server::* Ftp::Server::RequestHandler) (String &cmd, String &params)

protected

Definition at line 155 of file FtpServer.h.

Member Enumeration Documentation

◆ EarlyErrorKind

enum class Ftp::Server::EarlyErrorKind

strongprotected

Enumerator
HugeRequest
MissingLogin
MissingUsername
MissingHost
UnsupportedCommand
InvalidUri
MalformedCommand

Definition at line 85 of file FtpServer.h.

Constructor & Destructor Documentation

◆ Server()

Server::Server ( const MasterXaction::Pointer & xact )

explicit

Definition at line 53 of file FtpServer.cc.

References ConnStateData::flags, and uploadBuf.

◆ ~Server()

Server::~Server ( )

override

Definition at line 74 of file FtpServer.cc.

Member Function Documentation

◆ abortChunkedRequestBody()

void ConnStateData::abortChunkedRequestBody ( const err_type error )

protectedinherited

Definition at line 2098 of file client_side.cc.

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

Referenced by ConnStateData::handleRequestBodyData().

◆ abortRequestParsing()

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

inherited

Definition at line 1038 of file client_side.cc.

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

Referenced by ConnStateData::parseHttpRequest().

◆ AcceptCtrlConnection()

void Server::AcceptCtrlConnection ( const CommAcceptCbParams & params )

staticprotected

Definition at line 242 of file FtpServer.cc.

References Assure, CommCommonCbParams::conn, debugs, Comm::Connection::fd, fd_note(), CommCommonCbParams::flag, MasterXaction::MakePortful(), Comm::OK, CommAcceptCbParams::port, AsyncJob::Start(), CommCommonCbParams::xerrno, and xstrerr().

Referenced by Ftp::StartListening().

◆ acceptDataConnection()

void Server::acceptDataConnection ( const CommAcceptCbParams & params )

protected

Definition at line 401 of file FtpServer.cc.

References Packable::appendf(), Comm::Connection::close(), CommCommonCbParams::conn, debugs, Comm::Connection::fd, fd_note(), CommCommonCbParams::flag, Ftp::fssHandleDataRequest, Ftp::fssHandleUploadRequest, MemBuf::init(), Comm::Connection::leaveOrphanage(), Must, Comm::OK, Comm::Connection::remote, Comm::Write(), CommCommonCbParams::xerrno, and xstrerr().

Referenced by listenForDataConnection().

◆ acceptTls()

Security::IoResult ConnStateData::acceptTls ( )

inherited

Starts or resumes accepting a TLS connection. TODO: Make this helper method protected after converting clientNegotiateSSL() into a method.

Definition at line 2293 of file client_side.cc.

References Security::Accept(), assert, Security::KeyLogger::checkpoint(), Server::clientConnection, Comm::Connection::fd, fd_table, and ConnStateData::keyLogger.

Referenced by ConnStateData::startPeekAndSplice().

◆ add()

void ConnStateData::add ( const Http::StreamPointer & context )

inherited

Definition at line 1759 of file client_side.cc.

References Pipeline::add(), assert, ConnStateData::bareError, Error::clear(), Pipeline::count(), debugs, Pipeline::nrequests, and Server::pipeline.

◆ afterClientRead()

void ConnStateData::afterClientRead ( )

overridevirtualinherited

Implements Server.

Definition at line 1963 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 )

overridevirtualinherited

Reimplemented from Server.

Definition at line 1023 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.

◆ bootstrapConfig()

virtual void RegisteredRunner::bootstrapConfig ( )

inlinevirtualinherited

Called right before parsing squid.conf. Meant for initializing/preparing configuration parsing facilities.

Reimplemented in NtlmAuthRr.

Definition at line 46 of file RunnersRegistry.h.

Referenced by SquidMain().

◆ 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 3949 of file client_side.cc.

References ERR_CANNOT_FORWARD, ErrorState::NewForwarding(), and HttpRequest::pinnedConnection().

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

◆ borrowPinnedConnection()

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

protectedinherited

Definition at line 3918 of file client_side.cc.

References cbdataReferenceValid(), debugs, ERR_CANNOT_FORWARD, ERR_ZERO_SIZE_OBJECT, AnyP::Uri::host(), Comm::IsConnOpen(), Must, ErrorState::NewForwarding(), ConnStateData::pinning, AnyP::Uri::port(), ConnStateData::stopPinnedConnectionMonitoring(), ConnStateData::unpinConnection(), and HttpRequest::url.

◆ buildFakeRequest()

ClientHttpRequest * ConnStateData::buildFakeRequest	(	SBuf &	useHost,
		AnyP::KnownPort	usePort,
		const SBuf &	payload
	)

inherited

Definition at line 3238 of file client_side.cc.

References ClientHttpRequest::al, HttpRequest::auth_user_request, SBuf::c_str(), ClientHttpRequest::client_stream, Server::clientConnection, clientGetMoreData, clientReplyDetach, clientReplyStatus, clientSocketDetach(), clientSocketRecipient(), clientStreamInit(), StoreIOBuffer::data, HttpRequest::effectiveRequestUri(), ConnStateData::extendLifetime(), ConnStateData::flags, Http::Stream::flags, ConnStateData::getAuth(), RefCount< C >::getRaw(), Http::Message::header, AnyP::Uri::host(), Http::HOST, HTTP_REQBUF_SZ, Server::inBuf, ClientHttpRequest::initRequest(), StoreIOBuffer::length, MasterXaction::MakePortful(), HttpRequest::manager(), Http::Stream::mayUseConnection(), HttpRequest::method, Http::METHOD_CONNECT, Http::Stream::parsed_ok, AnyP::Uri::port(), ConnStateData::port, AnyP::PROTO_AUTHORITY_FORM, AnyP::PROTO_HTTPS, HttpHeader::putStr(), Http::Stream::registerWithConn(), Http::Stream::reqbuf, SBufToCstring(), AnyP::Uri::setScheme(), Http::Message::sources, Http::Message::srcHttp, Http::Message::srcHttps, ConnStateData::switchedToHttps(), ClientHttpRequest::uri, and HttpRequest::url.

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

◆ 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 2644 of file client_side.cc.

Referenced by ConnStateData::getSslContextStart().

◆ calcUri()

void Server::calcUri ( const SBuf * file )

protected

Definition at line 345 of file FtpServer.cc.

References port.

◆ callEnd()

void AsyncJob::callEnd ( )

virtualinherited

called right after the called job method

Reimplemented in Adaptation::Icap::Xaction.

Definition at line 137 of file AsyncJob.cc.

References assert, AsyncCall::debugLevel, debugs, AsyncCall::debugSection, AsyncJob::done(), AsyncJob::inCall, AsyncJob::started_, AsyncJob::status(), AsyncJob::swanSang_, AsyncJob::swanSong(), and AsyncJob::typeName.

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

◆ callException()

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

overridevirtual

Reimplemented from ConnStateData.

Definition at line 1750 of file FtpServer.cc.

References AsyncJob::callException(), debugs, and Comm::IsConnOpen().

◆ callStart()

void AsyncJob::callStart ( AsyncCall & call )

inherited

called just before the called method

Definition at line 115 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 102 of file AsyncJob.cc.

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

◆ CBDATA_CHILD()

Ftp::Server::CBDATA_CHILD ( Server )

private

◆ changeState()

void Server::changeState	(	const Ftp::ServerState	newState,
		const char *	reason
	)

protected

Definition at line 529 of file FtpServer.cc.

References debugs.

◆ checkDataConnPost()

bool Server::checkDataConnPost ( ) const

protected

Definition at line 1692 of file FtpServer.cc.

References debugs, and Comm::IsConnOpen().

◆ checkDataConnPre()

bool Server::checkDataConnPre ( )

protected

check that client data connection is ready for future I/O or at least has a chance of becoming ready soon.

Definition at line 1661 of file FtpServer.cc.

References Config, SquidConfig::connect, connectedForData(), debugs, Comm::IsConnOpen(), JobCallback, and SquidConfig::Timeout.

◆ checkLogging()

void ConnStateData::checkLogging ( )

privateinherited

Definition at line 4035 of file client_side.cc.

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

Referenced by ConnStateData::swanSong().

◆ claimMemoryNeeds()

virtual void RegisteredRunner::claimMemoryNeeds ( )

inlinevirtualinherited

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

Reimplemented in IpcIoRr, and MemStoreRr.

Definition at line 55 of file RunnersRegistry.h.

Referenced by RunConfigUsers().

◆ clientAfterReadingRequests()

void ConnStateData::clientAfterReadingRequests ( )

privateinherited

Definition at line 1463 of file client_side.cc.

References Server::clientConnection, Comm::Connection::close(), commIsHalfClosed(), debugs, Comm::Connection::fd, ConnStateData::flags, 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, ConnStateData::concurrentRequestQueueFilled(), Config, debugs, ConnStateData::extendLifetime(), ConnStateData::flags, Server::inBuf, SBuf::isEmpty(), SBuf::length(), SquidConfig::maxRequestHeaderSize, Must, ConnStateData::needProxyProtocolHeader_, ConnStateData::parsedBumpedRequestCount, ConnStateData::parseOneRequest(), ConnStateData::parseProxyProtocolHeader(), ConnStateData::pinning, ConnStateData::preservingClientData_, ConnStateData::processParsedRequest(), ConnStateData::switchedToHttps(), and ConnStateData::whenClientIpKnown().

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

◆ clientPinnedConnectionClosed()

void Server::clientPinnedConnectionClosed ( const CommCloseCbParams & io )

overrideprotectedvirtual

Reimplemented from ConnStateData.

Definition at line 316 of file FtpServer.cc.

References ConnStateData::clientPinnedConnectionClosed(), and Comm::IsConnOpen().

◆ 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 3889 of file client_side.cc.

References Server::clientConnection, Comm::Connection::close(), CommCommonCbParams::conn, debugs, Pipeline::empty(), Comm::ERR_CLOSING, CommCommonCbParams::flag, ConnStateData::handleIdleClientPinnedTlsRead(), Must, 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 193 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().

◆ closeDataConnection()

void Server::closeDataConnection ( )

protected

Definition at line 445 of file FtpServer.cc.

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

◆ completeDataDownload()

void Server::completeDataDownload ( )

protected

Writes the data-transfer status reply to the FTP client and closes the data connection.

Definition at line 1834 of file FtpServer.cc.

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

◆ connectedForData()

void Server::connectedForData ( const CommConnectCbParams & params )

protected

Definition at line 1703 of file FtpServer.cc.

References assert, CommCommonCbParams::conn, Comm::Connection::fd, fd_note(), CommCommonCbParams::flag, Comm::IsConnOpen(), Must, and Comm::OK.

Referenced by checkDataConnPre().

◆ connStateClosed()

void ConnStateData::connStateClosed ( const CommCloseCbParams & io )

inherited

Definition at line 507 of file client_side.cc.

References Server::clientConnection, AsyncJob::deleteThis(), and Comm::Connection::noteClosure().

Referenced by ConnStateData::start().

◆ consumeInput()

void ConnStateData::consumeInput ( const size_t byteCount )

inherited

Definition at line 1455 of file client_side.cc.

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

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

◆ createDataConnection()

bool Server::createDataConnection ( Ip::Address cltAddr )

protected

Definition at line 1432 of file FtpServer.cc.

References assert, COMM_DOBIND, COMM_INTERCEPTION, COMM_TRANSPARENT, conn, debugs, and Ip::Address::isIPv4().

◆ deleteThis()

void AsyncJob::deleteThis ( const char * aReason )

protectedinherited

Definition at line 50 of file AsyncJob.cc.

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

Referenced by ConnStateData::connStateClosed(), and AsyncJob::deleteThis().

◆ doClientRead()

void Server::doClientRead ( const CommIoCbParams & io )

protectedinherited

Definition at line 106 of file Server.cc.

References LogTagsErrors::aborted, Server::afterClientRead(), assert, StatCounters::client_http, Server::clientConnection, commMarkHalfClosed(), CommCommonCbParams::conn, debugs, Comm::ENDFILE, ERR_CLIENT_GONE, Comm::ERR_CLOSING, Helper::Error, 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, SysErrorDetail::NewIfAny(), Comm::OK, Server::reader, Server::reading(), Comm::ReadNow(), Server::readSomeData(), Server::receivedFirstByte(), Server::receivedFirstByte_, Server::shouldCloseOnEof(), CommIoCbParams::size, statCounter, Server::terminateAll(), LogTagsErrors::timedout, CommCommonCbParams::xerrno, and xstrerr().

Referenced by Server::readSomeData().

◆ done()

bool AsyncJob::done ( ) const

protectedinherited

Definition at line 91 of file AsyncJob.cc.

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

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

◆ doneAll()

bool ConnStateData::doneAll ( ) const

inlineoverridevirtualinherited

Reimplemented from AsyncJob.

Definition at line 240 of file client_side.h.

References AsyncJob::doneAll().

◆ doneWithControlMsg()

void ConnStateData::doneWithControlMsg ( )

overridevirtualinherited

Reimplemented from HttpControlMsgSink.

Definition at line 3729 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 3129 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().

◆ doProcessRequest()

void Server::doProcessRequest ( )

private

Definition at line 128 of file FtpServer.cc.

References assert, clientProcessRequest(), clientSetKeepaliveFlag(), debugs, RefCount< C >::getRaw(), Must, ClientHttpRequest::request, and ClientHttpRequest::storeEntry().

◆ earlyError()

Http::Stream * Server::earlyError ( const EarlyErrorKind eek )

protected

Definition at line 570 of file FtpServer.cc.

References Http::Stream::getClientReplyContext(), Ftp::HttpReplyWrapper(), Must, Http::scBadRequest, and clientReplyContext::setReplyToReply().

◆ endingShutdown()

void ConnStateData::endingShutdown ( )

overridevirtualinherited

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 1065 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 3652 of file client_side.cc.

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

Referenced by ClientHttpRequest::calloutsError().

◆ expectRequestBody()

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

inherited

Definition at line 3603 of file client_side.cc.

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

◆ extendLifetime()

void ConnStateData::extendLifetime ( )

inherited

Definition at line 606 of file client_side.cc.

References Server::clientConnection, commSetConnTimeout(), Config, JobCallback, SquidConfig::lifetime, ConnStateData::lifetimeTimeout(), and SquidConfig::Timeout.

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

◆ 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 3209 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, Ip::Address::port(), ClientHttpRequest::request, ConnStateData::tlsClientSni_, Ip::Address::toHostStr(), and ConnStateData::transparent().

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

◆ fillChecklist()

void ConnStateData::fillChecklist ( ACLFilledChecklist & ) const

overridevirtualinherited

Implements Acl::ChecklistFiller.

Definition at line 3559 of file client_side.cc.

References clientAclChecklistFill(), Pipeline::front(), Server::pipeline, and ACLFilledChecklist::setConn().

Referenced by ConnStateData::buildSslCertGenerationParams(), ConnStateData::postHttpsAccept(), ConnStateData::proxyProtocolValidateClient(), ConnStateData::startPeekAndSplice(), ConnStateData::tunnelOnError(), and ConnStateData::whenClientIpKnown().

◆ fillConnectionLevelDetails()

void ConnStateData::fillConnectionLevelDetails ( ACLFilledChecklist & checklist ) const

inherited

fillChecklist() obligations not fulfilled by the front request TODO: This is a temporary ACLFilledChecklist::setConn() callback to allow filling checklist using our non-public information sources. It should be removed as unnecessary by making ACLs extract the information they need from the ACLFilledChecklist::conn() without filling/copying.

Definition at line 3576 of file client_side.cc.

References assert, Server::clientConnection, ACLFilledChecklist::conn(), Comm::Connection::local, ACLFilledChecklist::my_addr, Comm::Connection::remote, ACLFilledChecklist::request, ACLFilledChecklist::rfc931, Comm::Connection::rfc931, ACLFilledChecklist::setIdent(), ACLFilledChecklist::src_addr, ACLFilledChecklist::sslErrors, Ssl::ServerBump::sslErrors(), and ConnStateData::sslServerBump.

Referenced by ACLFilledChecklist::setConn().

◆ 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 51 of file RunnersRegistry.h.

Referenced by SquidMain().

◆ finalizedInCbdataChild()

virtual void CbdataParent::finalizedInCbdataChild ( )

privatepure virtualinherited

◆ finishDechunkingRequest()

void ConnStateData::finishDechunkingRequest ( bool withSuccess )

protectedinherited

Definition at line 3672 of file client_side.cc.

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

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

◆ finishShutdown()

virtual void RegisteredRunner::finishShutdown ( )

inlinevirtualinherited

Definition at line 91 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 124 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 2748 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(), Comm::Connection::fd, fd_table, Ssl::GenerateSslContext(), Security::GetFrom(), ConnStateData::getSslContextDone(), ConnStateData::getTlsContextFromCache(), Ssl::InRamCertificateDbKey(), SBuf::isEmpty(), Store::nil, ConnStateData::port, Ssl::CrtdMessage::REQUEST, Ssl::CrtdMessage::setCode(), ConnStateData::signAlgorithm, Ssl::CertificateProperties::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 2720 of file client_side.cc.

References Ssl::CertificateProperties::commonName, debugs, ClpMap< Key, Value, MemoryUsedBy >::del(), ClpMap< Key, Value, MemoryUsedBy >::get(), Ssl::GlobalContextStorage::getLocalStorage(), ConnStateData::port, Ssl::TheGlobalContextStorage, and Ssl::verifySslCertificate().

Referenced by ConnStateData::getSslContextStart().

◆ handleCdupRequest()

bool Server::handleCdupRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1635 of file FtpServer.cc.

References Ftp::fssHandleCdup.

Referenced by handleRequest().

◆ handleChunkedRequestBody()

err_type ConnStateData::handleChunkedRequestBody ( )

protectedinherited

◆ handleCwdRequest()

bool Server::handleCwdRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1621 of file FtpServer.cc.

References Ftp::fssHandleCwd.

Referenced by handleRequest().

◆ handleDataReply()

void Server::handleDataReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 943 of file FtpServer.cc.

References MemBuf::append(), StoreIOBuffer::data, debugs, MemBuf::init(), Comm::IsConnOpen(), JobCallback, StoreIOBuffer::length, Http::scOkay, HttpReply::sline, Http::StatusLine::status(), Comm::Write(), and wroteReplyData().

Referenced by handleReply().

◆ handleDataRequest()

bool Server::handleDataRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1520 of file FtpServer.cc.

References Ftp::fssHandleDataRequest.

Referenced by handleRequest().

◆ handleEprtReply()

void Server::handleEprtReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 1059 of file FtpServer.cc.

Referenced by handleReply().

◆ handleEprtRequest()

bool Server::handleEprtRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1567 of file FtpServer.cc.

References debugs, Ftp::fssHandleEprt, Ftp::ParseProtoIpPort(), String::size(), and String::termedBuf().

Referenced by handleRequest().

◆ handleEpsvReply()

void Server::handleEpsvReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 1072 of file FtpServer.cc.

References Packable::appendf(), MemBuf::buf, debugs, MemBuf::init(), and MemBuf::size.

Referenced by handleReply().

◆ handleEpsvRequest()

bool Server::handleEpsvRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1596 of file FtpServer.cc.

References String::caseCmp(), String::cmp(), debugs, Ip::EnableIpv6, Ftp::fssHandleEpsv, and String::size().

Referenced by handleRequest().

◆ handleErrorReply()

void Server::handleErrorReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 934 of file FtpServer.cc.

Referenced by handleReply().

◆ handleFeatReply()

void Server::handleFeatReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 812 of file FtpServer.cc.

References HttpHeader::addEntry(), Ftp::cmdEprt(), Ftp::cmdEpsv(), CharacterSet::complement(), Http::FTP_PRE, Http::FTP_STATUS, HttpHeader::getEntry(), HttpHeader::getInt(), RefCount< C >::getRaw(), Http::Message::header, HttpHeaderInitPos, Ftp::HttpReplyWrapper(), Must, HttpHeader::putStr(), HttpHeader::refreshMask(), Http::scNoContent, CharacterSet::SP, Ftp::SupportedCommand(), and SBuf::toUpper().

Referenced by handleReply().

◆ handleFeatRequest()

bool Server::handleFeatRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1406 of file FtpServer.cc.

References Ftp::fssHandleFeat.

Referenced by handleRequest().

◆ 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 3847 of file client_side.cc.

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

Referenced by ConnStateData::clientPinnedConnectionRead().

◆ handlePassRequest()

bool Server::handlePassRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1628 of file FtpServer.cc.

References Ftp::fssHandlePass.

Referenced by handleRequest().

◆ handlePasvReply()

void Server::handlePasvReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 881 of file FtpServer.cc.

References Packable::appendf(), assert, MemBuf::buf, debugs, MemBuf::init(), MAX_IPSTRLEN, server, and MemBuf::size.

Referenced by handleReply().

◆ handlePasvRequest()

bool Server::handlePasvRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1413 of file FtpServer.cc.

References Ftp::fssHandlePasv, and String::size().

Referenced by handleRequest().

◆ handlePortReply()

void Server::handlePortReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 921 of file FtpServer.cc.

Referenced by handleReply().

◆ handlePortRequest()

bool Server::handlePortRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1491 of file FtpServer.cc.

References Ftp::fssHandlePort, Ftp::ParseIpPort(), String::size(), and String::termedBuf().

Referenced by handleRequest().

◆ handleReadData()

bool ConnStateData::handleReadData ( )

overridevirtualinherited

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 2002 of file client_side.cc.

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

◆ handleReply()

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

overrideprotectedvirtual

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

Implements ConnStateData.

Definition at line 778 of file FtpServer.cc.

References assert, handleDataReply(), handleEprtReply(), handleEpsvReply(), handleErrorReply(), handleFeatReply(), handlePasvReply(), handlePortReply(), handler(), handleUploadReply(), server, and TexcHere.

◆ handleRequest()

bool Server::handleRequest ( HttpRequest * request )

protected

◆ 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 2018 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(), Server::inBuf, SBuf::length(), BodyPipe::mayNeedMoreData(), BodyPipe::putMoreData(), and ConnStateData::stoppedSending().

Referenced by ConnStateData::handleReadData().

◆ handleSslBumpHandshakeError()

void ConnStateData::handleSslBumpHandshakeError ( const Security::IoResult & handshakeResult )

privateinherited

◆ handleStopRequest()

void AsyncJob::handleStopRequest ( )

inlineinherited

Definition at line 71 of file AsyncJob.h.

References AsyncJob::mustStop().

◆ handleUploadReply()

void Server::handleUploadReply	(	const HttpReply *	header,
		StoreIOBuffer	receivedData
	)

protected

Definition at line 1029 of file FtpServer.cc.

Referenced by handleReply().

◆ handleUploadRequest()

bool Server::handleUploadRequest	(	String &	cmd,
		String &	params
	)

protected

Definition at line 1534 of file FtpServer.cc.

References SquidConfig::accessList, ACLFilledChecklist::al, ClientHttpRequest::al, Acl::Answer::allowed(), Config, ACLChecklist::fastCheck(), HttpRequest::forcedBodyContinuation, SquidConfig::forceRequestBodyContinuation, Ftp::fssHandleUploadRequest, JobCallback, ClientHttpRequest::log_uri, ClientHttpRequest::request, ACLFilledChecklist::syncAle(), and wroteEarlyReply().

Referenced by handleRequest().

◆ handleUserRequest()

Http::Stream * Server::handleUserRequest	(	const SBuf &	cmd,
		SBuf &	params
	)

protected

Called to parse USER command, which is required to create an HTTP request wrapper. W/o request, the errors are handled by returning earlyError().

Definition at line 1358 of file FtpServer.cc.

References SBuf::caseCmp(), SBuf::chop(), SBuf::clear(), debugs, Ip::Address::isAnyAddr(), SBuf::isEmpty(), SBuf::length(), MAX_IPSTRLEN, SBuf::npos, SBuf::rfind(), SBuf::substr(), and Ip::Address::toHostStr().

◆ hasNotes()

bool ConnStateData::hasNotes ( ) const

inlineinherited

Definition at line 359 of file client_side.h.

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

◆ httpsPeeked()

void ConnStateData::httpsPeeked ( PinnedIdleContext pic )

inherited

Definition at line 3144 of file client_side.cc.

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

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

◆ idleTimeout()

time_t Server::idleTimeout ( ) const

overrideprotectedvirtual

Implements ConnStateData.

Definition at line 86 of file FtpServer.cc.

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

◆ initiateTunneledRequest()

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

inherited

◆ isOpen()

bool ConnStateData::isOpen ( ) const

inherited

Definition at line 664 of file client_side.cc.

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

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

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

◆ lifetimeTimeout()

void ConnStateData::lifetimeTimeout ( const CommTimeoutCbParams & params )

inherited

Definition at line 2165 of file client_side.cc.

References CommCommonCbParams::conn, DBG_IMPORTANT, debugs, ERR_LIFETIME_EXP, Debug::Extra(), ConnStateData::terminateAll(), and LogTagsErrors::timedout.

Referenced by ConnStateData::extendLifetime().

◆ listenForDataConnection()

unsigned int Server::listenForDataConnection ( )

protected

Starts waiting for a data connection. Returns listening port. On errors, responds with an error and returns zero.

Definition at line 370 of file FtpServer.cc.

References acceptDataConnection(), comm_local_port(), COMM_NONBLOCKING, comm_open_listener(), conn, DBG_CRITICAL, debugs, Comm::IsConnOpen(), JobCallback, port, and AsyncJob::Start().

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

◆ maybeReadUploadData()

void Server::maybeReadUploadData ( )

protected

Definition at line 109 of file FtpServer.cc.

References comm_read(), debugs, JobCallback, and readUploadData().

◆ 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 3614 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

◆ noteBodyConsumerAborted()

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

overrideprotectedvirtual

Implements ConnStateData.

Definition at line 231 of file FtpServer.cc.

References isOpen(), and ConnStateData::noteBodyConsumerAborted().

◆ noteMoreBodySpaceAvailable()

void Server::noteMoreBodySpaceAvailable ( BodyPipe::Pointer )

overrideprotectedvirtual

Implements ConnStateData.

Definition at line 222 of file FtpServer.cc.

References isOpen().

◆ notePeerConnection()

void Server::notePeerConnection ( Comm::ConnectionPointer )

overrideprotectedvirtual

Reimplemented from ConnStateData.

Definition at line 302 of file FtpServer.cc.

References conn, Must, and ClientHttpRequest::request.

◆ notePinnedConnectionBecameIdle()

void ConnStateData::notePinnedConnectionBecameIdle ( PinnedIdleContext pic )

inherited

Definition at line 3765 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 4086 of file client_side.cc.

References ConnStateData::theNotes.

Referenced by UpdateRequestNotes().

◆ noteTakeServerConnectionControl()

virtual void ConnStateData::noteTakeServerConnectionControl ( ServerConnectionContext )

inlinevirtualinherited

Gives us the control of the Squid-to-server connection. Used, for example, to initiate a TCP tunnel after protocol switching.

Reimplemented in Http::One::Server.

Definition at line 230 of file client_side.h.

Referenced by HttpStateData::proceedAfter1xx().

◆ 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 1299 of file client_side.cc.

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

◆ parseOneRequest()

Http::Stream * Server::parseOneRequest ( )

overrideprotectedvirtual

Parses a single FTP request on the control connection. Returns a new Http::Stream on valid requests and all errors. Returns NULL on incomplete requests that may still succeed given more data.

Implements ConnStateData.

Definition at line 640 of file FtpServer.cc.

References SBuf::c_str(), ClientHttpRequest::client_stream, clientGetMoreData, clientReplyDetach, clientReplyStatus, clientSocketDetach, clientSocketRecipient, clientStreamInit(), Ftp::cmdAppe(), Ftp::cmdStor(), Ftp::cmdStou(), Ftp::cmdUser(), Ftp::CommandHasPathParameter(), CharacterSet::complement(), Config, StoreIOBuffer::data, debugs, Http::EXPECT, Http::Stream::flags, HttpRequest::FromUrl(), Ftp::fssError, Http::FTP_ARGUMENTS, Http::FTP_COMMAND, HTTP_REQBUF_SZ, ClientHttpRequest::initRequest(), SBuf::isEmpty(), SBuf::length(), StoreIOBuffer::length, CharacterSet::LF, MasterXaction::MakePortful(), SquidConfig::maxRequestHeaderSize, Http::METHOD_GET, Http::METHOD_PUT, min(), Must, Http::Stream::parsed_ok, port, Ftp::ProtocolVersion(), Http::ProtocolVersion(), ClientHttpRequest::req_sz, Http::Stream::reqbuf, Ftp::SupportedCommand(), SBuf::toUpper(), Http::TRANSFER_ENCODING, SBuf::trim(), ClientHttpRequest::uri, and xstrdup.

◆ 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 1856 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 2898 of file client_side.cc.

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

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 3759 of file client_side.cc.

References ConnStateData::pinConnection().

◆ pinConnection()

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

privateinherited

◆ pinnedAuth()

bool ConnStateData::pinnedAuth ( ) const

inlineinherited

Definition at line 205 of file client_side.h.

References ConnStateData::pinning.

◆ pinnedPeer()

CachePeer * ConnStateData::pinnedPeer ( ) const

inlineinherited

Returns: the pinned CachePeer if one exists, nil otherwise

Definition at line 204 of file client_side.h.

References ConnStateData::pinning.

Referenced by PeerSelector::selectPinned().

◆ pipelinePrefetchMax()

int Server::pipelinePrefetchMax ( ) const

overrideprotectedvirtual

Reimplemented from ConnStateData.

Definition at line 80 of file FtpServer.cc.

◆ postHttpsAccept()

void ConnStateData::postHttpsAccept ( )

inherited

Definition at line 2538 of file client_side.cc.

References ACCESS_DENIED, SquidConfig::accessList, ACLFilledChecklist::al, assert, ConnStateData::bareError, AccessLogEntry::cache, AccessLogEntry::CacheDetails::caddr, Server::clientConnection, COMM_INTERCEPTION, COMM_TRANSPARENT, Config, current_time, debugs, fatal(), ConnStateData::fillChecklist(), Comm::Connection::flags, Pipeline::front(), AnyP::Uri::host(), HTTPMSGLOCK(), HTTPMSGUNLOCK(), httpsEstablish(), httpsSslBumpAccessCheckDone(), Comm::Connection::local, ConnStateData::log_addr, ClientHttpRequest::log_uri, MasterXaction::MakePortful(), MAX_IPSTRLEN, HttpRequest::myportname, ACLChecklist::nonBlockingCheck(), Server::pipeline, AccessLogEntry::CacheDetails::port, ConnStateData::port, Ip::Address::port(), AnyP::Uri::port(), AccessLogEntry::proxyProtocolHeader, ConnStateData::proxyProtocolHeader_, AccessLogEntry::request, CodeContext::Reset(), SquidConfig::ssl_bump, AccessLogEntry::CacheDetails::start_time, ACLFilledChecklist::syncAle(), AccessLogEntry::tcpClient, Ip::Address::toStr(), AccessLogEntry::updateError(), and HttpRequest::url.

◆ prepareTlsSwitchingURL()

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

inherited

Definition at line 1240 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().

◆ processParsedRequest()

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

overrideprotectedvirtual

Implements ConnStateData.

Definition at line 156 of file FtpServer.cc.

References CallJobHere, and Must.

◆ 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 1835 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 361 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 1816 of file client_side.cc.

References SquidConfig::accessList, Acl::Answer::allowed(), Config, ACLChecklist::fastCheck(), ConnStateData::fillChecklist(), SquidConfig::proxyProtocol, and ConnStateData::proxyProtocolError().

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 1477 of file client_side.cc.

References Server::clientConnection, debugs, ConnStateData::flags, HttpRequest::flags, and RequestFlags::proxyKeepalive.

Referenced by ConnStateData::serveDelayedError().

◆ reading()

bool Server::reading ( ) const

inlineinherited

Definition at line 58 of file Server.h.

References 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 881 of file client_side.cc.

References Server::clientConnection, debugs, Comm::Connection::fd, fd_note(), ConnStateData::idleTimeout(), Server::readSomeData(), ConnStateData::resetReadTimeout(), and Comm::Connection::timeLeft().

Referenced by ConnStateData::kick().

◆ readSomeData()

void Server::readSomeData ( )

inherited

Definition at line 89 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().

◆ readUploadData()

void Server::readUploadData ( const CommIoCbParams & io )

protected

Definition at line 168 of file FtpServer.cc.

References assert, CommIoCbParams::buf, StatCounters::client_http, CommCommonCbParams::conn, debugs, Comm::Connection::fd, CommCommonCbParams::flag, Comm::IsConnOpen(), StatCounters::kbytes_in, Must, Comm::OK, CommIoCbParams::size, and statCounter.

Referenced by maybeReadUploadData().

◆ receivedFirstByte()

void ConnStateData::receivedFirstByte ( )

overridevirtualinherited

Implements Server.

Definition at line 1881 of file client_side.cc.

References Config, Server::receivedFirstByte_, SquidConfig::request, ConnStateData::resetReadTimeout(), 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(), IdleConnList::IdleConnList(), and Rock::Rebuild::Rebuild().

◆ replyDataWritingCheckpoint()

void Server::replyDataWritingCheckpoint ( )

protected

Definition at line 1004 of file FtpServer.cc.

References debugs, fatal(), STREAM_COMPLETE, STREAM_FAILED, STREAM_NONE, and STREAM_UNPLANNED_COMPLETE.

◆ requestTimeout()

void ConnStateData::requestTimeout ( const CommTimeoutCbParams & io )

inherited

general lifetime handler for HTTP requests

Definition at line 2142 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_, ConnStateData::tunnelOnError(), and ConnStateData::updateError().

Referenced by ConnStateData::resetReadTimeout(), and Http::One::Server::start().

◆ resetLogin()

void Server::resetLogin ( const char * reason )

private

Definition at line 336 of file FtpServer.cc.

References debugs, and Ftp::fssBegin.

◆ resetReadTimeout()

void ConnStateData::resetReadTimeout ( time_t timeout )

inherited

Definition at line 598 of file client_side.cc.

References Server::clientConnection, commSetConnTimeout(), JobCallback, and ConnStateData::requestTimeout().

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

◆ resetSslCommonName()

void ConnStateData::resetSslCommonName ( const char * name )

inlineinherited

Definition at line 294 of file client_side.h.

References ConnStateData::sslCommonName_.

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

◆ sendControlMsg()

void ConnStateData::sendControlMsg ( HttpControlMsg msg )

overridevirtualinherited

◆ 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 1489 of file client_side.cc.

References ClientHttpRequest::al, Acl::Answer::allowed(), assert, SquidConfig::cert_error, Ssl::checkX509ServerValidity(), clientAclChecklistFill(), Server::clientConnection, Config, debugs, Ssl::ServerBump::entry, ERR_SECURE_CONNECT_FAIL, HttpRequest::error, ACLChecklist::fastCheck(), Http::Stream::getClientReplyContext(), HttpRequest::hier, AnyP::Uri::host(), Http::Stream::http, StoreEntry::isEmpty(), HttpRequest::method, ClientHttpRequest::Out::offset, ClientHttpRequest::out, Http::Stream::pullData(), ConnStateData::quitAfterError(), Comm::Connection::remote, ClientHttpRequest::request, Ssl::ServerBump::request, Http::scServiceUnavailable, Ssl::ServerBump::serverCert, clientReplyContext::setReplyToError(), clientReplyContext::setReplyToStoreEntry(), SQUID_X509_V_ERR_DOMAIN_MISMATCH, SquidConfig::ssl_client, ACLFilledChecklist::sslErrors, ConnStateData::sslServerBump, Error::update(), ConnStateData::updateError(), ClientHttpRequest::uri, and HttpRequest::url.

◆ serverBump()

Ssl::ServerBump * ConnStateData::serverBump ( )

inlineinherited

Definition at line 286 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 518 of file client_side.cc.

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

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

◆ setDataCommand()

void Server::setDataCommand ( )

protected

Definition at line 1644 of file FtpServer.cc.

References assert, debugs, Http::FTP_ARGUMENTS, Http::FTP_COMMAND, Http::Message::header, ClientHttpRequest::request, and HttpHeader::updateOrAddStr().

◆ setReply()

void Server::setReply	(	const int	code,
		const char *	msg
	)

protected

Definition at line 1729 of file FtpServer.cc.

References assert, code, clientReplyContext::createStoreEntry(), RequestFlags::disableCacheUse(), Ftp::HttpReplyWrapper(), HttpRequest::method, StoreEntry::replaceHttpReply(), ClientHttpRequest::request, Http::scNoContent, and ClientHttpRequest::storeEntry().

◆ setServerBump()

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

inlineinherited

Definition at line 287 of file client_side.h.

References assert, and ConnStateData::sslServerBump.

Referenced by ClientHttpRequest::doCallouts().

◆ shouldCloseOnEof()

bool ConnStateData::shouldCloseOnEof ( ) const

overrideprivatevirtualinherited

Implements Server.

Definition at line 1435 of file client_side.cc.

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

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

◆ shovelUploadData()

void Server::shovelUploadData ( )

private

Definition at line 202 of file FtpServer.cc.

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

◆ splice()

bool ConnStateData::splice ( )

inherited

Definition at line 3003 of file client_side.cc.

References assert, Server::clientConnection, Pipeline::empty(), ConnStateData::fakeAConnectRequest(), Comm::Connection::fd, fd_table, Pipeline::front(), ConnStateData::initiateTunneledRequest(), Must, Server::pipeline, ConnStateData::preservedClientData, Http::ProtocolVersion(), ClientHttpRequest::request, Server::transferProtocol, and ConnStateData::transparent().

Referenced by httpsSslBumpStep2AccessCheckDone().

◆ sslCommonName()

const SBuf & ConnStateData::sslCommonName ( ) const

inlineinherited

Definition at line 293 of file client_side.h.

References ConnStateData::sslCommonName_.

◆ sslCrtdHandleReply()

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

inherited

Definition at line 2601 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(), 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 2594 of file client_side.cc.

References ConnStateData::sslCrtdHandleReply().

Referenced by ConnStateData::getSslContextStart().

◆ start()

void Server::start ( )

overrideprotectedvirtual

Reimplemented from ConnStateData.

Definition at line 92 of file FtpServer.cc.

References debugs, MAX_IPSTRLEN, and ConnStateData::start().

◆ Start()

void AsyncJob::Start ( const Pointer & job )

staticinherited

Promises to start the configured job (eventually). The job is deemed to be running asynchronously beyond this point, so the caller should only access the job object via AsyncCalls rather than directly.

swanSong() is only called for jobs for which this method has returned successfully (i.e. without throwing).

Definition at line 24 of file AsyncJob.cc.

References CallJobHere, AsyncJob::start(), and AsyncJob::started_.

Referenced by AcceptCtrlConnection(), clientListenerConnectionOpened(), Ipc::Coordinator::handleCacheMgrRequest(), Ipc::Coordinator::handleSnmpRequest(), httpAccept(), httpsAccept(), httpStart(), idnsInitVC(), Ftp::Gateway::listenForDataChannel(), listenForDataConnection(), Log::TcpLogger::Open(), peerProbeConnect(), Mgr::FunAction::respond(), Mgr::InfoAction::respond(), Ipc::SendMessage(), Mgr::Inquirer::sendResponse(), snmpConstructReponse(), SquidMain(), CacheManager::start(), Adaptation::AccessCheck::Start(), Rock::Rebuild::Start(), JobWaitBase::start_(), BodyPipe::startAutoConsumptionIfNeeded(), Ftp::StartGateway(), Ftp::StartRelay(), PeerPoolMgrsRr::syncConfig(), and Rock::SwapDir::updateHeaders().

◆ startDechunkingRequest()

void ConnStateData::startDechunkingRequest ( )

protectedinherited

Definition at line 3662 of file client_side.cc.

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

Referenced by ConnStateData::expectRequestBody().

◆ startPeekAndSplice()

void ConnStateData::startPeekAndSplice ( )

inherited

Definition at line 3037 of file client_side.cc.

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

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 3825 of file client_side.cc.

References ConnStateData::clientPinnedConnectionRead(), JobCallback, 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 67 of file RunnersRegistry.h.

Referenced by mainReconfigureStart().

◆ startShutdown()

void ConnStateData::startShutdown ( )

overridevirtualinherited

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 1054 of file client_side.cc.

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

◆ startWaitingForOrigin()

void Server::startWaitingForOrigin ( )

Called by Ftp::Client class when it is start receiving or sending data.

Definition at line 1761 of file FtpServer.cc.

References debugs, and isOpen().

Referenced by Ftp::Relay::sendCommand().

◆ status()

const char * AsyncJob::status ( ) const

protectedvirtualinherited

for debugging, starts with space

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

Definition at line 167 of file AsyncJob.cc.

References MemBuf::append(), Packable::appendf(), MemBuf::content(), MemBuf::reset(), AsyncJob::stopReason, and MemBuf::terminate().

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

◆ stoppedReceiving()

const char * ConnStateData::stoppedReceiving ( ) const

inlineinherited

Definition at line 160 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 162 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 3837 of file client_side.cc.

References 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, BodyPipe::clearProducer(), and debugs.

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

◆ stopReading()

void Server::stopReading ( )

inherited

Definition at line 60 of file Server.cc.

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

Referenced by ClientHttpRequest::processRequest().

◆ stopReceiving()

void ConnStateData::stopReceiving ( const char * error )

inherited

Definition at line 3632 of file client_side.cc.

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

Referenced by ConnStateData::setAuth().

◆ stopSending()

void ConnStateData::stopSending ( const char * error )

inherited

Definition at line 999 of file client_side.cc.

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

◆ stopWaitingForOrigin()

void Server::stopWaitingForOrigin ( int status )

Called by Ftp::Client class when it is done receiving or sending data. Waits for both agents to be done before responding to the FTP client and closing the data connection.

Definition at line 1771 of file FtpServer.cc.

References debugs, Ftp::fssHandleDataRequest, RefCount< C >::getRaw(), isOpen(), and Must.

Referenced by Ftp::Relay::stopOriginWait().

◆ 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 2738 of file client_side.cc.

References ClpMap< Key, Value, MemoryUsedBy >::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 ( )

overridevirtualinherited

Reimplemented from AsyncJob.

Definition at line 615 of file client_side.cc.

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

◆ switchedToHttps()

bool ConnStateData::switchedToHttps ( ) const

inlineinherited

Definition at line 285 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

◆ 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 71 of file RunnersRegistry.h.

Referenced by mainReconfigureFinish().

◆ terminateAll()

void ConnStateData::terminateAll	(	const Error &	,
		const LogTagsErrors &
	)

overrideprivatevirtualinherited

Implements Server.

Definition at line 3992 of file client_side.cc.

References assert, Pipeline::back(), ConnStateData::bareError, ConnStateData::bodyPipe, SBuf::clear(), Server::clientConnection, Comm::Connection::close(), Pipeline::count(), debugs, Pipeline::empty(), error(), Pipeline::front(), Server::inBuf, SBuf::isEmpty(), SBuf::length(), MakeNamedErrorDetail(), Pipeline::nrequests, ConnStateData::parsingTlsHandshake, Server::pipeline, and Error::update().

Referenced by ConnStateData::lifetimeTimeout(), and ConnStateData::swanSong().

◆ tlsClientSni()

const SBuf & ConnStateData::tlsClientSni ( ) const

inlineinherited

Definition at line 295 of file client_side.h.

References ConnStateData::tlsClientSni_.

Referenced by ConnStateData::prepareTlsSwitchingURL().

◆ toCbdata()

virtual void * CbdataParent::toCbdata ( )

pure virtualinherited

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

◆ transparent()

bool ConnStateData::transparent ( ) const

inherited

Definition at line 3597 of file client_side.cc.

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

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

◆ tunnelOnError()

bool ConnStateData::tunnelOnError ( const err_type requestError )

protectedinherited

◆ unpinConnection()

void ConnStateData::unpinConnection ( const bool andClose )

inherited

Definition at line 3961 of file client_side.cc.

References cbdataReferenceDone, comm_remove_close_handler(), debugs, Comm::IsConnOpen(), 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().

◆ updateError() [1/2]

void ConnStateData::updateError	(	const err_type	c,
		const ErrorDetailPointer &	d
	)

inlineinherited

Definition at line 367 of file client_side.h.

References Helper::Error, and ConnStateData::updateError().

Referenced by ConnStateData::updateError().

◆ updateError() [2/2]

void ConnStateData::updateError ( const Error & error )

inherited

Definition at line 652 of file client_side.cc.

References assert, ConnStateData::bareError, error(), Pipeline::front(), Server::pipeline, and Error::update().

Referenced by ConnStateData::callException(), ConnStateData::handleSslBumpHandshakeError(), ConnStateData::initiateTunneledRequest(), ConnStateData::parseTlsHandshake(), ConnStateData::requestTimeout(), and ConnStateData::serveDelayedError().

◆ 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 ClientDbRr, SharedMemPagesRr, Ipc::Mem::RegisteredRunner, MemStoreRr, PeerPoolMgrsRr, SharedSessionCacheRr, and TransientsRr.

Definition at line 60 of file RunnersRegistry.h.

Referenced by RunConfigUsers().

◆ userDataCompletionCheckpoint()

void Server::userDataCompletionCheckpoint ( int finalStatusCode )

protected

Called after data transfer on client-to-squid data connection is finished.

Definition at line 1809 of file FtpServer.cc.

References debugs, and Must.

◆ 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 2231 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, ConnStateData::fillChecklist(), FQDN_LOOKUP_IF_MISS, fqdncache_gethostbyaddr(), ClientDelayConfig::initial, ClientDelayPools::Instance(), SquidConfig::onoff, ClientDelayPools::pools, Comm::Connection::remote, Dns::ResolveClientAddressesAsap, ClientInfo::setWriteLimiter(), 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 77 of file Server.h.

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

◆ write() [2/2]

void Server::write ( MemBuf * mb )

inlineinherited

Definition at line 70 of file Server.h.

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

◆ writeControlMsgAndCall()

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

overrideprotectedvirtual

Implements ConnStateData.

Definition at line 1152 of file FtpServer.cc.

◆ writeCustomReply()

void Server::writeCustomReply	(	const int	code,
		const char *	msg,
		const HttpReply *	reply = `nullptr`
	)

protected

Definition at line 507 of file FtpServer.cc.

References Packable::appendf(), assert, code, debugs, Http::FTP_REASON, Http::FTP_STATUS, HttpHeader::has(), Http::Message::header, MemBuf::init(), and Ftp::PrintReply().

◆ writeEarlyReply()

void Server::writeEarlyReply	(	const int	code,
		const char *	msg
	)

protected

Writes FTP [error] response before we fully parsed the FTP request and created the corresponding HTTP request wrapper for that FTP request.

Definition at line 476 of file FtpServer.cc.

References Packable::appendf(), assert, code, debugs, MemBuf::init(), JobCallback, Comm::Write(), and wroteEarlyReply().

◆ writeErrorReply()

void Server::writeErrorReply	(	const HttpReply *	reply,
		const int	status
	)

protected

◆ writeForwardedForeign()

void Server::writeForwardedForeign ( const HttpReply * reply )

protected

writes FTP response based on HTTP reply that is not an FTP-response wrapper for example, internally-generated Squid "errorpages" end up here (for now)

Definition at line 1143 of file FtpServer.cc.

References Ftp::fssConnected.

◆ writeForwardedReply()

void Server::writeForwardedReply ( const HttpReply * reply )

protected

Definition at line 1036 of file FtpServer.cc.

References Http::FTP_STATUS, HttpHeader::has(), Http::Message::header, JobCallback, Must, and wroteReply().

◆ writeForwardedReplyAndCall()

void Server::writeForwardedReplyAndCall	(	const HttpReply *	reply,
		AsyncCall::Pointer &	call
	)

protected

Definition at line 1161 of file FtpServer.cc.

References assert, MemBuf::buf, debugs, Ftp::fssHandleDataRequest, Ftp::fssHandleUploadRequest, Http::FTP_REASON, Http::FTP_STATUS, HttpHeader::getInt(), HttpHeader::has(), Http::Message::header, MemBuf::init(), Comm::IsConnOpen(), Must, Ftp::PrintReply(), and Comm::Write().

◆ writeReply()

void Server::writeReply ( MemBuf & mb )

protected

Definition at line 495 of file FtpServer.cc.

References MemBuf::buf, debugs, JobCallback, Comm::Write(), and wroteReply().

◆ writeSomeData()

virtual void Server::writeSomeData ( )

inlinevirtualinherited

Definition at line 67 of file Server.h.

Referenced by Server::clientWriteDone().

◆ writing()

bool Server::writing ( ) const

inlineinherited

Definition at line 87 of file Server.h.

References Server::writer.

◆ wroteControlMsg()

void HttpControlMsgSink::wroteControlMsg ( const CommIoCbParams & params )

inherited

called when we wrote the 1xx response

Definition at line 25 of file HttpControlMsg.cc.

References Comm::Connection::close(), CommCommonCbParams::conn, debugs, HttpControlMsgSink::doneWithControlMsg(), Comm::ERR_CLOSING, CommCommonCbParams::flag, Comm::OK, CommCommonCbParams::xerrno, and xstrerr().

Referenced by ConnStateData::sendControlMsg().

◆ wroteEarlyReply()

void Server::wroteEarlyReply ( const CommIoCbParams & io )

protected

Definition at line 1234 of file FtpServer.cc.

References Comm::Connection::close(), CommCommonCbParams::conn, debugs, Comm::ERR_CLOSING, CommCommonCbParams::flag, Comm::OK, CommIoCbParams::size, CommCommonCbParams::xerrno, and xstrerr().

Referenced by handleUploadRequest(), and writeEarlyReply().

◆ wroteReply()

void Server::wroteReply ( const CommIoCbParams & io )

protected

Definition at line 1256 of file FtpServer.cc.

References assert, Comm::Connection::close(), CommCommonCbParams::conn, debugs, Comm::ERR_CLOSING, CommCommonCbParams::flag, Ftp::fssConnected, Ftp::fssError, Comm::OK, CommIoCbParams::size, STREAM_COMPLETE, STREAM_FAILED, STREAM_NONE, STREAM_UNPLANNED_COMPLETE, CommCommonCbParams::xerrno, and xstrerr().

Referenced by writeForwardedReply(), and writeReply().

◆ wroteReplyData()

void Server::wroteReplyData ( const CommIoCbParams & io )

protected

Definition at line 986 of file FtpServer.cc.

References assert, debugs, Comm::ERR_CLOSING, CommCommonCbParams::flag, Comm::OK, CommIoCbParams::size, CommCommonCbParams::xerrno, and xstrerr().

Referenced by handleDataReply().

Friends And Related Function Documentation

◆ StartListening

void StartListening ( )

friend

Member Data Documentation

◆ auth

bool ConnStateData::auth = false

inherited

Definition at line 148 of file client_side.h.

Referenced by clientCheckPinning().

◆ auth_

Auth::UserRequest::Pointer ConnStateData::auth_

privateinherited

Definition at line 474 of file client_side.h.

Referenced by ConnStateData::getAuth(), and ConnStateData::setAuth().

◆ bareError

Error ConnStateData::bareError

inherited

Definition at line 382 of file client_side.h.

Referenced by ClientHttpRequest::ClientHttpRequest(), ConnStateData::add(), ConnStateData::checkLogging(), ConnStateData::postHttpsAccept(), ConnStateData::terminateAll(), and ConnStateData::updateError().

◆ bodyParser

Http1::TeChunkedParser* ConnStateData::bodyParser = nullptr

inherited

Definition at line 109 of file client_side.h.

Referenced by ConnStateData::~ConnStateData(), ConnStateData::finishDechunkingRequest(), ConnStateData::handleChunkedRequestBody(), ConnStateData::handleRequestBodyData(), and ConnStateData::startDechunkingRequest().

◆ bodyPipe

BodyPipe::Pointer ConnStateData::bodyPipe

protectedinherited

Definition at line 432 of file client_side.h.

Referenced by ConnStateData::~ConnStateData(), ConnStateData::clientParseRequests(), ConnStateData::expectNoForwarding(), ConnStateData::expectRequestBody(), ConnStateData::finishDechunkingRequest(), ConnStateData::handleChunkedRequestBody(), ConnStateData::handleReadData(), ConnStateData::handleRequestBodyData(), ConnStateData::mayNeedToReadMoreBody(), ConnStateData::noteBodyConsumerAborted(), ConnStateData::startDechunkingRequest(), and ConnStateData::terminateAll().

◆ cbControlMsgSent

AsyncCall::Pointer HttpControlMsgSink::cbControlMsgSent

inherited

Definition at line 42 of file HttpControlMsg.h.

Referenced by clientSocketRecipient(), HttpControlMsgSink::doneWithControlMsg(), and ConnStateData::sendControlMsg().

◆ clientConnection

Comm::ConnectionPointer Server::clientConnection

inherited

Definition at line 98 of file Server.h.

Referenced by ClientHttpRequest::ClientHttpRequest(), Server::Server(), TunnelStateData::TunnelStateData(), ConnStateData::~ConnStateData(), ConnStateData::abortChunkedRequestBody(), ConnStateData::abortRequestParsing(), ConnStateData::acceptTls(), ConnStateData::afterClientRead(), Format::Format::assemble(), ConnStateData::buildFakeRequest(), IdentLookup::checkForAsync(), ConnStateData::clientAfterReadingRequests(), ConnStateData::clientParseRequests(), ConnStateData::clientPinnedConnectionClosed(), ConnStateData::clientPinnedConnectionRead(), ClientRequestContext::clientRedirectDone(), clientSocketRecipient(), Server::clientWriteDone(), ConnStateData::concurrentRequestQueueFilled(), ConnStateData::connStateClosed(), Server::doClientRead(), Server::doneAll(), ConnStateData::doneWithControlMsg(), ConnStateData::doPeekAndSpliceStep(), ConnStateData::endingShutdown(), ConnStateData::extendLifetime(), ConnStateData::fakeAConnectRequest(), ConnStateData::fillConnectionLevelDetails(), ConnStateData::getSslContextDone(), ConnStateData::getSslContextStart(), ConnStateData::handleChunkedRequestBody(), ConnStateData::handleRequestBodyData(), ConnStateData::handleSslBumpHandshakeError(), 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(), ConnStateData::proxyProtocolError(), ConnStateData::quitAfterError(), ConnStateData::readNextRequest(), Server::readSomeData(), ConnStateData::resetReadTimeout(), PeerSelector::resolveSelected(), ConnStateData::sendControlMsg(), 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(), ConnStateData::swanSong(), Server::swanSong(), ConnStateData::switchToHttps(), ConnStateData::terminateAll(), ConnStateData::transparent(), ConnStateData::tunnelOnError(), tunnelStart(), ConnStateData::whenClientIpKnown(), and Server::write().

◆ closeHandler

AsyncCall::Pointer ConnStateData::closeHandler

inherited

Definition at line 154 of file client_side.h.

◆ dataConn

Comm::ConnectionPointer Ftp::Server::dataConn

private

Definition at line 188 of file FtpServer.h.

◆ dataConnWait

JobWait<Comm::ConnOpener> Ftp::Server::dataConnWait

private

Waits for an FTP data connection to the client to be established/opened. This wait only happens in FTP active mode (via PORT or EPRT).

Definition at line 196 of file FtpServer.h.

◆ dataListenConn

Comm::ConnectionPointer Ftp::Server::dataListenConn

private

Definition at line 187 of file FtpServer.h.

◆ delayedReply

HttpReply::Pointer Ftp::Server::delayedReply

private

Definition at line 206 of file FtpServer.h.

◆

struct { ... } ConnStateData::flags

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

◆ gotEpsvAll

bool Ftp::Server::gotEpsvAll

private

Definition at line 185 of file FtpServer.h.

◆ host

SBuf Ftp::Server::host

private

Definition at line 184 of file FtpServer.h.

◆ id

const InstanceId<AsyncJob> AsyncJob::id

inherited

Definition at line 73 of file AsyncJob.h.

◆ inBuf

SBuf Server::inBuf

inherited

◆ inCall

AsyncCall::Pointer AsyncJob::inCall

protectedinherited

Definition at line 81 of file AsyncJob.h.

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

◆ keyLogger

Security::KeyLogger ConnStateData::keyLogger

inherited

Definition at line 385 of file client_side.h.

Referenced by ConnStateData::acceptTls().

◆ listener

AsyncCall::Pointer Ftp::Server::listener

private

Definition at line 192 of file FtpServer.h.

◆ log_addr

Ip::Address ConnStateData::log_addr

inherited

Definition at line 137 of file client_side.h.

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

◆ master

MasterState::Pointer Ftp::Server::master

Definition at line 79 of file FtpServer.h.

◆ needProxyProtocolHeader_

bool ConnStateData::needProxyProtocolHeader_ = false

privateinherited

Definition at line 467 of file client_side.h.

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

◆ onDataAcceptCall

AsyncCall::Pointer Ftp::Server::onDataAcceptCall

private

Definition at line 186 of file FtpServer.h.

◆ originDataDownloadAbortedOnError

bool Ftp::Server::originDataDownloadAbortedOnError

private

Definition at line 203 of file FtpServer.h.

◆ parsedBumpedRequestCount

uint64_t ConnStateData::parsedBumpedRequestCount = 0

privateinherited

Definition at line 481 of file client_side.h.

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

◆ parsingTlsHandshake

bool ConnStateData::parsingTlsHandshake = false

privateinherited

whether we are getting/parsing TLS Hello bytes

Definition at line 479 of file client_side.h.

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

◆ peer

CachePeer* ConnStateData::peer = nullptr

inherited

Definition at line 152 of file client_side.h.

◆ peerAccessDenied

bool ConnStateData::peerAccessDenied = false

inherited

Definition at line 151 of file client_side.h.

Referenced by PeerSelector::selectPinned().

◆ pinned

bool ConnStateData::pinned = false

inherited

Definition at line 147 of file client_side.h.

Referenced by HttpRequest::pinnedConnection().

◆

struct { ... } ConnStateData::pinning

Referenced by ConnStateData::borrowPinnedConnection(), clientCheckPinning(), ConnStateData::clientParseRequests(), ConnStateData::clientPinnedConnectionClosed(), ConnStateData::clientPinnedConnectionRead(), ConnStateData::handleIdleClientPinnedTlsRead(), ConnStateData::initiateTunneledRequest(), ConnStateData::kick(), ConnStateData::pinConnection(), ConnStateData::pinnedAuth(), HttpRequest::pinnedConnection(), ConnStateData::pinnedPeer(), ConnStateData::pipelinePrefetchMax(), PeerSelector::selectPinned(), ConnStateData::startPinnedConnectionMonitoring(), ConnStateData::stopPinnedConnectionMonitoring(), and ConnStateData::unpinConnection().

◆ pipeline

Pipeline Server::pipeline

inherited

Definition at line 116 of file Server.h.

Referenced by ConnStateData::abortChunkedRequestBody(), ConnStateData::add(), ConnStateData::afterClientRead(), ConnStateData::afterClientWrite(), ConnStateData::checkLogging(), ConnStateData::clientPinnedConnectionRead(), clientSocketRecipient(), Server::clientWriteDone(), ConnStateData::concurrentRequestQueueFilled(), ConnStateData::doneWithControlMsg(), ConnStateData::fillChecklist(), ConnStateData::finishDechunkingRequest(), ConnStateData::httpsPeeked(), httpsSslBumpStep2AccessCheckDone(), ConnStateData::kick(), ConnStateData::notePinnedConnectionBecameIdle(), ConnStateData::parseTlsHandshake(), ConnStateData::postHttpsAccept(), ConnStateData::sendControlMsg(), ConnStateData::shouldCloseOnEof(), ConnStateData::shouldPreserveClientData(), ConnStateData::splice(), ConnStateData::startPeekAndSplice(), ConnStateData::startShutdown(), ConnStateData::terminateAll(), ConnStateData::tunnelOnError(), and ConnStateData::updateError().

◆ port

AnyP::Port ConnStateData::port

inherited

◆ preservedClientData

SBuf ConnStateData::preservedClientData

inherited

From-client handshake bytes (including bytes at the beginning of a CONNECT tunnel) which we may need to forward as-is if their syntax does not match the expected TLS or HTTP protocol (on_unsupported_protocol).

Definition at line 350 of file client_side.h.

Referenced by Format::Format::assemble(), ConnStateData::parseHttpRequest(), ConnStateData::parseTlsHandshake(), ConnStateData::splice(), and ConnStateData::tunnelOnError().

◆ preservingClientData_

bool ConnStateData::preservingClientData_ = false

protectedinherited

Definition at line 435 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 470 of file client_side.h.

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

◆ reader

AsyncCall::Pointer Ftp::Server::reader

private

Definition at line 198 of file FtpServer.h.

◆ readHandler

AsyncCall::Pointer ConnStateData::readHandler

inherited

Definition at line 153 of file client_side.h.

◆ reading

bool ConnStateData::reading = false

inherited

Definition at line 149 of file client_side.h.

◆ readMore

bool ConnStateData::readMore = true

inherited

Definition at line 140 of file client_side.h.

Referenced by ClientHttpRequest::doCallouts().

◆ receivedFirstByte_

bool Server::receivedFirstByte_

inherited

Definition at line 113 of file Server.h.

Referenced by Server::doClientRead(), ConnStateData::receivedFirstByte(), ConnStateData::requestTimeout(), and ConnStateData::switchToHttps().

◆ serverConnection

Comm::ConnectionPointer ConnStateData::serverConnection

inherited

Definition at line 144 of file client_side.h.

Referenced by clientCheckPinning().

◆ signAlgorithm

Ssl::CertSignAlgorithm ConnStateData::signAlgorithm = Ssl::algSignTrusted

privateinherited

Definition at line 495 of file client_side.h.

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

◆ sslBumpCertKey

SBuf ConnStateData::sslBumpCertKey

privateinherited

Definition at line 491 of file client_side.h.

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

◆ sslBumpMode

Ssl::BumpMode ConnStateData::sslBumpMode = Ssl::bumpEnd

inherited

Definition at line 305 of file client_side.h.

Referenced by ConnStateData::concurrentRequestQueueFilled(), httpsSslBumpAccessCheckDone(), httpsSslBumpStep2AccessCheckDone(), ClientRequestContext::sslBumpAccessCheck(), and ClientHttpRequest::sslBumpStart().

◆ sslCommonName_

SBuf ConnStateData::sslCommonName_

privateinherited

Definition at line 487 of file client_side.h.

Referenced by ConnStateData::buildSslCertGenerationParams(), ConnStateData::resetSslCommonName(), and ConnStateData::sslCommonName().

◆ sslServerBump

Ssl::ServerBump* ConnStateData::sslServerBump = nullptr

privateinherited

Definition at line 494 of file client_side.h.

Referenced by ConnStateData::~ConnStateData(), ConnStateData::buildSslCertGenerationParams(), ConnStateData::fillConnectionLevelDetails(), ConnStateData::getSslContextStart(), ConnStateData::httpsPeeked(), ConnStateData::parseTlsHandshake(), ConnStateData::serveDelayedError(), ConnStateData::serverBump(), ConnStateData::setServerBump(), ConnStateData::sslCrtdHandleReply(), ConnStateData::startPeekAndSplice(), and ConnStateData::switchToHttps().

◆ started_

bool AsyncJob::started_ = false

protectedinherited

Definition at line 83 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), AsyncJob::callEnd(), and AsyncJob::Start().

◆ stoppedReceiving_

const char* ConnStateData::stoppedReceiving_ = nullptr

privateinherited

Definition at line 501 of file client_side.h.

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

◆ stoppedSending_

const char* ConnStateData::stoppedSending_ = nullptr

privateinherited

Definition at line 499 of file client_side.h.

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

◆ stopReason

const char* AsyncJob::stopReason

protectedinherited

Definition at line 79 of file AsyncJob.h.

Referenced by AsyncJob::deleteThis(), AsyncJob::done(), AsyncJob::mustStop(), AsyncJob::status(), and HappyConnOpener::status().

◆ swanSang

bool ConnStateData::swanSang = false

inherited

Definition at line 141 of file client_side.h.

◆ swanSang_

bool AsyncJob::swanSang_ = false

protectedinherited

Definition at line 84 of file AsyncJob.h.

Referenced by AsyncJob::~AsyncJob(), and AsyncJob::callEnd().

◆ switchedToHttps_

bool ConnStateData::switchedToHttps_ = false

privateinherited

Definition at line 478 of file client_side.h.

Referenced by ConnStateData::doPeekAndSpliceStep(), ConnStateData::getSslContextDone(), ConnStateData::startPeekAndSplice(), ConnStateData::switchedToHttps(), and ConnStateData::switchToHttps().

◆ theNotes

NotePairs::Pointer ConnStateData::theNotes

privateinherited

Connection annotations, clt_conn_tag and other tags are stored here. If set, are propagated to the current and all future master transactions on the connection.

Definition at line 505 of file client_side.h.

Referenced by ConnStateData::hasNotes(), and ConnStateData::notes().

◆ tlsClientSni_

SBuf ConnStateData::tlsClientSni_

privateinherited

Definition at line 490 of file client_side.h.

Referenced by ConnStateData::fakeAConnectRequest(), ConnStateData::parseTlsHandshake(), and ConnStateData::tlsClientSni().

◆ tlsConnectHostOrIp

SBuf ConnStateData::tlsConnectHostOrIp

privateinherited

The TLS server host name as passed in the CONNECT request

Definition at line 485 of file client_side.h.

Referenced by ConnStateData::buildSslCertGenerationParams(), ConnStateData::getSslContextDone(), ConnStateData::httpsPeeked(), ConnStateData::initiateTunneledRequest(), ConnStateData::prepareTlsSwitchingURL(), ConnStateData::sslCrtdHandleReply(), and ConnStateData::switchToHttps().

◆ tlsConnectPort

AnyP::Port ConnStateData::tlsConnectPort

privateinherited

Definition at line 486 of file client_side.h.

Referenced by ConnStateData::initiateTunneledRequest(), ConnStateData::prepareTlsSwitchingURL(), and ConnStateData::switchToHttps().

◆ tlsParser

Security::HandshakeParser ConnStateData::tlsParser

inherited

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

Definition at line 309 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 105 of file Server.h.

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

◆ typeName

const char* AsyncJob::typeName

protectedinherited

Definition at line 80 of file AsyncJob.h.

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

◆ uploadAvailSize

size_t Ftp::Server::uploadAvailSize

private

Definition at line 190 of file FtpServer.h.

◆ uploadBuf

char Ftp::Server::uploadBuf[CLIENT_REQ_BUF_SZ]

private

Definition at line 189 of file FtpServer.h.

Referenced by Server().

◆ uri

SBuf Ftp::Server::uri

private

Definition at line 183 of file FtpServer.h.

◆ waitingForOrigin

bool Ftp::Server::waitingForOrigin

private

Definition at line 201 of file FtpServer.h.

◆ writer

AsyncCall::Pointer Server::writer

protectedinherited

Definition at line 126 of file Server.h.

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

◆ zeroReply

bool ConnStateData::zeroReply = false

inherited

Definition at line 150 of file client_side.h.

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

src/servers/FtpServer.h
src/servers/FtpServer.cc

squid-cache.org

Optimising Web Delivery

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Method

◆ Pointer [1/2]

◆ Pointer [2/2]

◆ ReplyHandler

◆ RequestHandler

Member Enumeration Documentation

◆ EarlyErrorKind

Constructor & Destructor Documentation

◆ Server()

◆ ~Server()

Member Function Documentation

◆ abortChunkedRequestBody()

◆ abortRequestParsing()

◆ AcceptCtrlConnection()

◆ acceptDataConnection()

◆ acceptTls()

◆ add()

◆ afterClientRead()

◆ afterClientWrite()

◆ bootstrapConfig()

◆ BorrowPinnedConnection()

◆ borrowPinnedConnection()

◆ buildFakeRequest()

◆ buildSslCertGenerationParams()

◆ calcUri()

◆ callEnd()

◆ callException()

◆ callStart()

◆ canBeCalled()

◆ CBDATA_CHILD()

◆ changeState()

◆ checkDataConnPost()

◆ checkDataConnPre()

◆ checkLogging()

◆ claimMemoryNeeds()

◆ clientAfterReadingRequests()

◆ clientParseRequests()

◆ clientPinnedConnectionClosed()

◆ clientPinnedConnectionRead()

◆ clientReadFtpData()

◆ clientWriteDone()

◆ closeDataConnection()

◆ completeDataDownload()

◆ concurrentRequestQueueFilled()

◆ connectedForData()

◆ connStateClosed()

◆ consumeInput()

◆ createDataConnection()

◆ deleteThis()

◆ doClientRead()

◆ done()

◆ doneAll()

◆ doneWithControlMsg()

◆ doPeekAndSpliceStep()

◆ doProcessRequest()

◆ earlyError()

◆ endingShutdown()

◆ expectNoForwarding()

◆ expectRequestBody()

◆ extendLifetime()

◆ fakeAConnectRequest()

◆ fillChecklist()

◆ fillConnectionLevelDetails()

◆ finalizeConfig()