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

#include <FtpServer.h>

Inheritance diagram for Ftp::Server:
Collaboration diagram for Ftp::Server:

Public Types

typedef CbcPointer< AsyncJobPointer
typedef CbcPointer< BodyProducerPointer

Public Member Functions

 Server (const MasterXaction::Pointer &xact)
virtual ~Server () override
virtual 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...
virtual void receivedFirstByte ()
 Update flags and timeout after the first byte received. More...
virtual bool handleReadData ()
virtual void afterClientRead ()
 processing to be done after a Comm::Read() More...
virtual void afterClientWrite (size_t)
 processing to sync state after a Comm::Write() More...
virtual void sendControlMsg (HttpControlMsg)
 called to send the 1xx message and notify the Source More...
virtual void doneWithControlMsg ()
bool clientParseRequests ()
 Traffic parsing. More...
void readNextRequest ()
void kick ()
 try to make progress on a transaction or read more I/O More...
bool isOpen () const
int64_t mayNeedToReadMoreBody () const
const Auth::UserRequest::PointergetAuth () const
void setAuth (const Auth::UserRequest::Pointer &aur, const char *cause)
bool transparent () const
const char * stoppedReceiving () const
 true if we stopped receiving the request More...
const char * stoppedSending () const
 true if we stopped sending the response More...
void stopReceiving (const char *error)
 note request receiving error and close as soon as we write the response More...
void stopSending (const char *error)
 note response sending error and close as soon as we read the request More...
void expectNoForwarding ()
 cleans up virgin request [body] forwarding state More...
BodyPipe::Pointer expectRequestBody (int64_t size)
bool handleRequestBodyData ()
void notePinnedConnectionBecameIdle (PinnedIdleContext pic)
 Called when a pinned connection becomes available for forwarding the next request. More...
void pinBusyConnection (const Comm::ConnectionPointer &pinServerConn, const HttpRequest::Pointer &request)
void unpinConnection (const bool andClose)
 Undo pinConnection() and, optionally, close the pinned connection. More...
Comm::ConnectionPointer borrowPinnedConnection (HttpRequest *request, const CachePeer *aPeer)
 Returns validated pinnned server connection (and stops its monitoring). More...
const Comm::ConnectionPointer validatePinnedConnection (HttpRequest *request, const CachePeer *peer)
CachePeerpinnedPeer () const
bool pinnedAuth () const
void clientReadFtpData (const CommIoCbParams &io)
void connStateClosed (const CommCloseCbParams &io)
void requestTimeout (const CommTimeoutCbParams &params)
virtual bool doneAll () const
 whether positive goal has been reached More...
virtual void swanSong ()
void quitAfterError (HttpRequest *request)
void stopPinnedConnectionMonitoring ()
 The caller assumes responsibility for connection closure detection. More...
void postHttpsAccept ()
 the second part of old httpsAccept, waiting for future HttpsServer home More...
void startPeekAndSplice ()
 Initializes and starts a peek-and-splice negotiation with the SSL client. More...
void doPeekAndSpliceStep ()
void httpsPeeked (PinnedIdleContext pic)
 called by FwdState when it is done bumping the server More...
bool splice ()
 Splice a bumped client connection on peek-and-splice mode. More...
void getSslContextStart ()
 Start to create dynamic Security::ContextPointer for host or uses static port SSL context. More...
void getSslContextDone (Security::ContextPointer &)
 finish configuring the newly created SSL context" More...
void sslCrtdHandleReply (const Helper::Reply &reply)
 Proccess response from ssl_crtd. More...
void switchToHttps (HttpRequest *request, Ssl::BumpMode bumpServerMode)
void parseTlsHandshake ()
bool switchedToHttps () const
Ssl::ServerBumpserverBump ()
void setServerBump (Ssl::ServerBump *srvBump)
const SBufsslCommonName () const
void resetSslCommonName (const char *name)
const SBuftlsClientSni () const
void buildSslCertGenerationParams (Ssl::CertificateProperties &certProperties)
bool serveDelayedError (Http::Stream *)
void consumeInput (const size_t byteCount)
 remove no longer needed leading bytes from the input buffer More...
Http::StreamabortRequestParsing (const char *const errUri)
 stop parsing the request and create context for relaying error info More...
bool fakeAConnectRequest (const char *reason, const SBuf &payload)
bool initiateTunneledRequest (HttpRequest::Pointer const &cause, Http::MethodType const method, const char *reason, const SBuf &payload)
 generates and sends to a fake request with a given payload More...
bool mayTunnelUnsupportedProto ()
 whether tunneling of unsupported protocol is allowed for this connection More...
ClientHttpRequestbuildFakeRequest (Http::MethodType const method, SBuf &useHost, unsigned short usePort, const SBuf &payload)
 build a fake http request More...
virtual void startShutdown ()
virtual void endingShutdown ()
NotePairs::Pointer notes ()
bool hasNotes () const
void readSomeData ()
 maybe grow the inBuf and schedule Comm::Read() More...
void stopReading ()
 cancels Comm::Read() if it is scheduled More...
virtual void writeSomeData ()
 maybe find some data to send and schedule a Comm::Write() More...
void write (MemBuf *mb)
 schedule some data for a Comm::Write() More...
void write (char *buf, int len)
 schedule some data for a Comm::Write() More...
bool writing () const
 whether Comm::Write() is scheduled More...
void maybeMakeSpaceAvailable ()
 grows the available read buffer space (if possible) More...
bool canBeCalled (AsyncCall &call) const
 whether we can be called More...
void callStart (AsyncCall &call)
virtual void callEnd ()
 called right after the called job method More...
virtual void * toCbdata ()=0
void wroteControlMsg (const CommIoCbParams &)
 callback to handle Comm::Write completion More...

Static Public Member Functions

static void sslCrtdHandleReplyWrapper (void *data, const Helper::Reply &reply)
 Callback function. It is called when squid receive message from ssl_crtd. More...
static Pointer Start (AsyncJob *job)
 starts a freshly created job (i.e., makes the job asynchronous) More...

Public Attributes

MasterState::Pointer master
 info shared among our FTP client and server jobs More...
 parses HTTP/1.1 chunked request body More...
Ip::Address log_addr
struct {
   bool   readMore
 needs comm_read (for this request or new requests) More...
   bool   swanSang
struct {
   Comm::ConnectionPointer   serverConnection
   char *   host
   int   port
   bool   pinned
   bool   auth
   bool   reading
 we are monitoring for peer connection closure More...
   bool   zeroReply
 server closed w/o response (ERR_ZERO_SIZE_OBJECT) More...
   CachePeer *   peer
   AsyncCall::Pointer   readHandler
 detects serverConnection closure More...
   AsyncCall::Pointer   closeHandler
Ssl::BumpMode sslBumpMode
 ssl_bump decision (Ssl::bumpEnd if n/a). More...
Security::HandshakeParser tlsParser
SBuf preservedClientData
Comm::ConnectionPointer clientConnection
AnyP::ProtocolVersion transferProtocol
SBuf inBuf
 read I/O buffer for the client connection More...
bool receivedFirstByte_
 true if at least one byte received on this connection More...
Pipeline pipeline
 set of requests waiting to be serviced More...
AsyncCall::Pointer cbControlMsgSent
 Call to schedule when the control msg has been sent. More...

Protected Types

enum  EarlyErrorKind {
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

virtual Http::StreamparseOneRequest () override
virtual void processParsedRequest (Http::StreamPointer &context) override
 start processing a freshly parsed request More...
virtual void notePeerConnection (Comm::ConnectionPointer conn) override
 called just before a FwdState-dispatched job starts using connection More...
virtual void clientPinnedConnectionClosed (const CommCloseCbParams &io) override
 Our close handler called by Comm when the pinned connection is closed. More...
virtual void handleReply (HttpReply *header, StoreIOBuffer receivedData) override
virtual int pipelinePrefetchMax () const override
 returning N allows a pipeline of 1+N requests (see pipeline_prefetch) More...
virtual bool writeControlMsgAndCall (HttpReply *rep, AsyncCall::Pointer &call) override
 handle a control message received by context from a peer and call back More...
virtual time_t idleTimeout () const override
 timeout to use when waiting for the next request More...
virtual void noteMoreBodySpaceAvailable (BodyPipe::Pointer) override
virtual void noteBodyConsumerAborted (BodyPipe::Pointer ptr) override
virtual 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::StreamhandleUserRequest (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=NULL)
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::StreamearlyError (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...
void startPinnedConnectionMonitoring ()
void clientPinnedConnectionRead (const CommIoCbParams &io)
bool handleIdleClientPinnedTlsRead ()
void whenClientIpKnown ()
void doClientRead (const CommIoCbParams &io)
void clientWriteDone (const CommIoCbParams &io)
void deleteThis (const char *aReason)
void mustStop (const char *aReason)
bool done () const
 the job is destroyed in callEnd() when done() More...
virtual const char * status () const
 internal cleanup; do not call directly More...
void stopProducingFor (RefCount< BodyPipe > &, bool atEof)

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...
AsyncCall::Pointer writer
 set when we are writing More...
const char * stopReason
 reason for forcing done() to be true More...
const char * typeName
 kid (leaf) class name, for debugging More...
AsyncCall::Pointer inCall
 the asynchronous call being handled, if any More...
const InstanceId< AsyncJobid
 job identifier More...

Private Member Functions

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

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...
AsyncCall::Pointer connector
 set when we are actively connecting More...
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...


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

Detailed Description

Definition at line 55 of file FtpServer.h.

Member Typedef Documentation

Definition at line 25 of file BodyPipe.h.

Definition at line 34 of file AsyncJob.h.

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

Definition at line 166 of file FtpServer.h.

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

Definition at line 153 of file FtpServer.h.

Member Enumeration Documentation

enum Ftp::Server::EarlyErrorKind

Definition at line 83 of file FtpServer.h.

Constructor & Destructor Documentation

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

Definition at line 52 of file

References ConnStateData::flags, and uploadBuf.

Server::~Server ( )

Reimplemented from Server.

Definition at line 73 of file

Member Function Documentation

void ConnStateData::afterClientWrite ( size_t  )
Comm::ConnectionPointer ConnStateData::borrowPinnedConnection ( HttpRequest request,
const CachePeer aPeer 
ClientHttpRequest * ConnStateData::buildFakeRequest ( Http::MethodType const  method,
SBuf useHost,
unsigned short  usePort,
const SBuf payload 
void Server::calcUri ( const SBuf file)

Definition at line 340 of file

References port, Parser::Tokenizer::remaining(), and Parser::Tokenizer::skipAll().

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

Reimplemented from AsyncJob.

Definition at line 1752 of file

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

void AsyncJob::callStart ( AsyncCall call)
bool AsyncJob::canBeCalled ( AsyncCall call) const

Definition at line 101 of file

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

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

Definition at line 524 of file

References debugs.

bool Server::checkDataConnPost ( ) const

Definition at line 1695 of file

References debugs, and Comm::IsConnOpen().

bool Server::checkDataConnPre ( )

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

Definition at line 1664 of file

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

void Server::clientPinnedConnectionClosed ( const CommCloseCbParams io)

Reimplemented from ConnStateData.

Definition at line 311 of file

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

void ConnStateData::clientPinnedConnectionRead ( const CommIoCbParams io)

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 3989 of file

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

Referenced by ConnStateData::startPinnedConnectionMonitoring().

void ConnStateData::clientReadFtpData ( const CommIoCbParams io)
void Server::clientWriteDone ( const CommIoCbParams io)

callback handling the Comm::Write completion

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

Definition at line 186 of file

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

void Server::closeDataConnection ( )

Definition at line 440 of file

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

void Server::completeDataDownload ( )

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

Definition at line 1836 of file

void Server::connectedForData ( const CommConnectCbParams params)
void ConnStateData::connStateClosed ( const CommCloseCbParams io)

Definition at line 496 of file

References AsyncJob::deleteThis().

Referenced by ConnStateData::start().

void ConnStateData::consumeInput ( const size_t  byteCount)
void AsyncJob::deleteThis ( const char *  aReason)
bool AsyncJob::done ( ) const

Definition at line 90 of file

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

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

virtual bool ConnStateData::doneAll ( ) const

Reimplemented from Server.

Definition at line 212 of file client_side.h.

References AsyncJob::doneAll().

void ConnStateData::doneWithControlMsg ( )
void ConnStateData::doPeekAndSpliceStep ( )

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

Definition at line 3293 of file

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

void ConnStateData::endingShutdown ( )

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 1040 of file

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

Referenced by ConnStateData::startShutdown().

void ConnStateData::expectNoForwarding ( )
BodyPipe::Pointer ConnStateData::expectRequestBody ( int64_t  size)
void ConnStateData::finishDechunkingRequest ( bool  withSuccess)
const Auth::UserRequest::Pointer& ConnStateData::getAuth ( ) const

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 114 of file client_side.h.

References ConnStateData::auth_.

Referenced by Auth::UserRequest::authenticate(), AuthenticateAcl(), authTryGetUser(), ConnStateData::buildFakeRequest(), ClientHttpRequest::calloutsError(), ClientRequestContext::clientAccessCheckDone(), clientProcessRequest(), constructHelperQuery(), and ClientRequestContext::hostHeaderVerifyFailed().

bool Server::handleCdupRequest ( String cmd,
String params 

Definition at line 1638 of file

References Ftp::fssHandleCdup.

Referenced by handleRequest().

bool Server::handleCwdRequest ( String cmd,
String params 

Definition at line 1624 of file

References Ftp::fssHandleCwd.

Referenced by handleRequest().

void Server::handleDataReply ( const HttpReply header,
StoreIOBuffer  receivedData 
bool Server::handleDataRequest ( String cmd,
String params 

Definition at line 1525 of file

References Ftp::fssHandleDataRequest.

Referenced by handleRequest().

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

Definition at line 1062 of file

References ERR_NONE.

Referenced by handleReply().

bool Server::handleEprtRequest ( String cmd,
String params 
void Server::handleEpsvReply ( const HttpReply header,
StoreIOBuffer  receivedData 

Definition at line 1075 of file

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

Referenced by handleReply().

bool Server::handleEpsvRequest ( String cmd,
String params 
void Server::handleErrorReply ( const HttpReply header,
StoreIOBuffer  receivedData 

Definition at line 937 of file

Referenced by handleReply().

bool Server::handleFeatRequest ( String cmd,
String params 

Definition at line 1411 of file

References Ftp::fssHandleFeat.

Referenced by handleRequest().

bool ConnStateData::handleIdleClientPinnedTlsRead ( )

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

false if and only if the connection should be closed.

Definition at line 3948 of file

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

Referenced by ConnStateData::clientPinnedConnectionRead().

bool Server::handlePassRequest ( String cmd,
String params 

Definition at line 1631 of file

References Ftp::fssHandlePass.

Referenced by handleRequest().

void Server::handlePasvReply ( const HttpReply header,
StoreIOBuffer  receivedData 
bool Server::handlePasvRequest ( String cmd,
String params 

Definition at line 1418 of file

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

Referenced by handleRequest().

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

Definition at line 924 of file

References ERR_NONE.

Referenced by handleReply().

bool Server::handlePortRequest ( String cmd,
String params 

Definition at line 1496 of file

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

Referenced by handleRequest().

bool ConnStateData::handleReadData ( )

called when new request data has been read from the socket

Return values
falsecalled comm_close or setReplyToError (the caller should bail)
truewe did not call comm_close or setReplyToError

Implements Server.

Definition at line 2192 of file

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

void Server::handleReply ( HttpReply header,
StoreIOBuffer  receivedData 

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

Implements ConnStateData.

Definition at line 775 of file

References assert, handleDataReply(), handleEprtReply(), handleEpsvReply(), handleErrorReply(), handleFeatReply(), handlePasvReply(), handlePortReply(), handler(), handleUploadReply(), HTTPMSGLOCK(), master, NULL, server, Ftp::MasterState::serverState, and TexcHere.

bool ConnStateData::handleRequestBodyData ( )

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
falsecalled comm_close or setReplyToError (the caller should bail)
truewe did not call comm_close or setReplyToError

Definition at line 2208 of file

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

Referenced by clientProcessRequest(), and ConnStateData::handleReadData().

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

Definition at line 1032 of file

Referenced by handleReply().

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

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 1363 of file

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

bool ConnStateData::hasNotes ( ) const

Definition at line 320 of file client_side.h.

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

time_t Server::idleTimeout ( ) const

Implements ConnStateData.

Definition at line 85 of file

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

void ConnStateData::kick ( )
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 892 of file

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

unsigned int Server::listenForDataConnection ( )

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

Definition at line 365 of file

References acceptDataConnection(), comm_local_port(), COMM_NONBLOCKING, comm_open_listener(), conn, DBG_CRITICAL, debugs, Comm::Connection::fd, Comm::Connection::flags, RefCount< C >::getRaw(), Comm::IsConnOpen(), JobCallback, Comm::Connection::local, port, Ip::Address::port(), and AsyncJob::Start().

void Server::maybeMakeSpaceAvailable ( )

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

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

Definition at line 70 of file

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

void Server::maybeReadUploadData ( )

Definition at line 108 of file

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

int64_t ConnStateData::mayNeedToReadMoreBody ( ) const

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

Return values
0We do not need to read any [more] body bytes
negativeMay need more but do not know how many; could be zero!
positiveNeed to read exactly that many more body bytes

Definition at line 3720 of file

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

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

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

Implements ConnStateData.

Definition at line 230 of file

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

void Server::noteMoreBodySpaceAvailable ( BodyPipe::Pointer  )

Implements ConnStateData.

Definition at line 221 of file

References isOpen().

void Server::notePeerConnection ( Comm::ConnectionPointer  )

Reimplemented from ConnStateData.

Definition at line 297 of file

References Must, NULL, ClientHttpRequest::request, and request().

NotePairs::Pointer ConnStateData::notes ( )
existing non-empty connection annotations, creates and returns empty annotations otherwise

Definition at line 4126 of file

References ConnStateData::theNotes.

Referenced by UpdateRequestNotes().

Http::Stream * Server::parseOneRequest ( )

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 635 of file

References SBuf::c_str(), RequestFlags::cachable, 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, HttpRequest::flags, Http::Stream::flags, HttpRequest::FromUrl(), Ftp::fssError, Http::FTP_ARGUMENTS, Http::FTP_COMMAND, RequestFlags::ftpNative, Http::Message::header, HTTP_REQBUF_SZ, Http::Message::http_ver, HTTPMSGLOCK(), XactionInitiator::initClient, SBuf::isEmpty(), StoreIOBuffer::length, SBuf::length(), CharacterSet::LF, SquidConfig::maxRequestHeaderSize, method, Http::METHOD_GET, Http::METHOD_PUT, min(), Must, RequestFlags::noCache, NULL, Http::Stream::parsed_ok, Parser::Tokenizer::parsedSize(), Parser::Tokenizer::prefix(), Http::ProtocolVersion(), Ftp::ProtocolVersion(), HttpHeader::putStr(), ClientHttpRequest::req_sz, Http::Stream::reqbuf, ClientHttpRequest::request, request(), Parser::Tokenizer::skipAll(), Ftp::SupportedCommand(), MasterXaction::tcpClient, SBuf::toUpper(), Http::TRANSFER_ENCODING, SBuf::trim(), ClientHttpRequest::uri, and xstrdup.

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

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

Definition at line 3860 of file

References ConnStateData::pinConnection().

bool ConnStateData::pinnedAuth ( ) const

Definition at line 197 of file client_side.h.

References ConnStateData::pinning.

Referenced by FwdState::connectStart().

CachePeer* ConnStateData::pinnedPeer ( ) const

returts the pinned CachePeer if exists, NULL otherwise

Definition at line 196 of file client_side.h.

References ConnStateData::pinning.

Referenced by peerSelectPinned().

int Server::pipelinePrefetchMax ( ) const

Reimplemented from ConnStateData.

Definition at line 79 of file

void Server::processParsedRequest ( Http::StreamPointer )

Implements ConnStateData.

Definition at line 155 of file

References CallJobHere, and Must.

void ConnStateData::quitAfterError ( HttpRequest request)

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 1471 of file

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

Referenced by clientProcessRequest(), and ConnStateData::serveDelayedError().

bool Server::reading ( ) const

Definition at line 57 of file Server.h.

References NULL, and Server::reader.

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

void ConnStateData::readNextRequest ( )
void ConnStateData::receivedFirstByte ( )
void Server::replyDataWritingCheckpoint ( )
void Server::resetLogin ( const char *  reason)

Definition at line 331 of file

References debugs, and Ftp::fssBegin.

void ConnStateData::resetSslCommonName ( const char *  name)
bool ConnStateData::serveDelayedError ( Http::Stream context)
void ConnStateData::setAuth ( const Auth::UserRequest::Pointer aur,
const char *  cause 

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 503 of file

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

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

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

Definition at line 254 of file client_side.h.

References assert, and ConnStateData::sslServerBump.

Referenced by ClientHttpRequest::doCallouts().

void Server::shovelUploadData ( )

Definition at line 201 of file

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

const SBuf& ConnStateData::sslCommonName ( ) const

Definition at line 260 of file client_side.h.

References ConnStateData::sslCommonName_.

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

Definition at line 2799 of file

References ConnStateData::sslCrtdHandleReply().

Referenced by ConnStateData::getSslContextStart().

void Server::start ( )

Reimplemented from ConnStateData.

Definition at line 91 of file

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

void ConnStateData::startDechunkingRequest ( )
void ConnStateData::startPinnedConnectionMonitoring ( )

[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 3926 of file

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

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

void ConnStateData::startShutdown ( )

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 1029 of file

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

void Server::startWaitingForOrigin ( )

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

Definition at line 1763 of file

References debugs, and isOpen().

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

const char* ConnStateData::stoppedReceiving ( ) const
const char* ConnStateData::stoppedSending ( ) const
void ConnStateData::stopPinnedConnectionMonitoring ( )
void BodyProducer::stopProducingFor ( RefCount< BodyPipe > &  p,
bool  atEof 
void Server::stopReading ( )
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 1773 of file

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

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

bool ConnStateData::switchedToHttps ( ) const
const SBuf& ConnStateData::tlsClientSni ( ) const

Definition at line 262 of file client_side.h.

References ConnStateData::tlsClientSni_.

virtual void* CbdataParent::toCbdata ( )
pure virtualinherited
void Server::userDataCompletionCheckpoint ( int  finalStatusCode)

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

Definition at line 1811 of file

References debugs, and Must.

const Comm::ConnectionPointer ConnStateData::validatePinnedConnection ( HttpRequest request,
const CachePeer peer 

Checks if there is pinning info if it is valid. It can close the server side connection if pinned info is not valid.

requestif it is not NULL also checks if the pinning info refers to the request client side HttpRequest
CachePeerif it is not NULL also check if the CachePeer is the pinning CachePeer
The details of the server side connection (may be closed if failures were present).

Definition at line 4018 of file

References cbdataReferenceValid(), debugs, HERE(), URL::host(), Comm::IsConnOpen(), ConnStateData::pinning, URL::port(), ConnStateData::unpinConnection(), and HttpRequest::url.

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

void Server::write ( MemBuf mb)
void Server::write ( char *  buf,
int  len 
bool Server::writeControlMsgAndCall ( HttpReply rep,
AsyncCall::Pointer call 

Implements ConnStateData.

Definition at line 1157 of file

void Server::writeCustomReply ( const int  code,
const char *  msg,
const HttpReply reply = NULL 
void Server::writeEarlyReply ( const int  code,
const char *  msg 

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 471 of file

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

void Server::writeForwardedForeign ( const HttpReply reply)

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 1148 of file

References Ftp::fssConnected.

void Server::writeForwardedReply ( const HttpReply reply)
void Server::writeReply ( MemBuf mb)

Definition at line 490 of file

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

virtual void Server::writeSomeData ( )

Definition at line 66 of file Server.h.

Referenced by Server::clientWriteDone().

bool Server::writing ( ) const

Definition at line 86 of file Server.h.

References NULL, and Server::writer.

void HttpControlMsgSink::wroteControlMsg ( const CommIoCbParams params)
void Server::wroteReplyData ( const CommIoCbParams io)

Friends And Related Function Documentation

void StartListening ( )

Member Data Documentation

bool ConnStateData::auth

Definition at line 138 of file client_side.h.

Referenced by clientCheckPinning().

AsyncCall::Pointer HttpControlMsgSink::cbControlMsgSent
Comm::ConnectionPointer Server::clientConnection

Definition at line 97 of file Server.h.

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

AsyncCall::Pointer ConnStateData::closeHandler

Definition at line 143 of file client_side.h.

AsyncCall::Pointer Ftp::Server::connector

Definition at line 191 of file FtpServer.h.

Comm::ConnectionPointer Ftp::Server::dataConn

Definition at line 186 of file FtpServer.h.

Comm::ConnectionPointer Ftp::Server::dataListenConn

Definition at line 185 of file FtpServer.h.

HttpReply::Pointer Ftp::Server::delayedReply

Definition at line 200 of file FtpServer.h.

bool Ftp::Server::gotEpsvAll

Definition at line 183 of file FtpServer.h.

SBuf Ftp::Server::host

Definition at line 182 of file FtpServer.h.

const InstanceId<AsyncJob> AsyncJob::id

Definition at line 70 of file AsyncJob.h.

AsyncCall::Pointer AsyncJob::inCall
AsyncCall::Pointer Ftp::Server::listener

Definition at line 190 of file FtpServer.h.

MasterState::Pointer Ftp::Server::master

Definition at line 77 of file FtpServer.h.

Referenced by handleReply().

AsyncCall::Pointer Ftp::Server::onDataAcceptCall

Definition at line 184 of file FtpServer.h.

bool Ftp::Server::originDataDownloadAbortedOnError

Definition at line 197 of file FtpServer.h.

CachePeer* ConnStateData::peer

Definition at line 141 of file client_side.h.

Referenced by clientHttpRequestStatus().

bool ConnStateData::pinned

Definition at line 137 of file client_side.h.

Referenced by HttpRequest::pinnedConnection().

SBuf ConnStateData::preservedClientData

client data which may need to forward as-is to server after an on_unsupported_protocol tunnel decision.

Definition at line 311 of file client_side.h.

Referenced by clientTunnelOnError(), parseHttpRequest(), ConnStateData::parseTlsHandshake(), and ConnStateData::splice().

AsyncCall::Pointer Ftp::Server::reader

Definition at line 192 of file FtpServer.h.

AsyncCall::Pointer ConnStateData::readHandler

Definition at line 142 of file client_side.h.

bool ConnStateData::reading

Definition at line 139 of file client_side.h.

bool ConnStateData::readMore
bool Server::receivedFirstByte_
Comm::ConnectionPointer ConnStateData::serverConnection

Definition at line 134 of file client_side.h.

Referenced by clientCheckPinning().

const char* AsyncJob::stopReason
bool ConnStateData::swanSang

Definition at line 131 of file client_side.h.

Security::HandshakeParser ConnStateData::tlsParser

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

Definition at line 276 of file client_side.h.

Referenced by ConnStateData::parseTlsHandshake().

AnyP::ProtocolVersion Server::transferProtocol

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

Definition at line 104 of file Server.h.

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

size_t Ftp::Server::uploadAvailSize

Definition at line 188 of file FtpServer.h.

char Ftp::Server::uploadBuf[CLIENT_REQ_BUF_SZ]

Definition at line 187 of file FtpServer.h.

Referenced by Server().

SBuf Ftp::Server::uri

Definition at line 181 of file FtpServer.h.

bool Ftp::Server::waitingForOrigin

Definition at line 195 of file FtpServer.h.

AsyncCall::Pointer Server::writer

Definition at line 125 of file Server.h.

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

bool ConnStateData::zeroReply

Definition at line 140 of file client_side.h.

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






Web Site Translations