Go to the documentation of this file.
2 * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
3 *
4 * Squid software is distributed under GPLv2+ license and includes
5 * contributions from numerous individuals and organizations.
6 * Please see the COPYING and CONTRIBUTORS files for details.
7 */
9/* DEBUG: section 33 Client-side Routines */
14#include "base/JobWait.h"
15#include "base/Lock.h"
16#include "client_side.h"
17#include "comm/forward.h"
18#include "http/forward.h"
20namespace Ftp
23typedef enum {
39// TODO: This should become a part of MasterXaction when we start sending
40// master transactions to the clients/ code.
58class Server: public ConnStateData
63 explicit Server(const MasterXaction::Pointer &xact);
64 ~Server() override;
66 /* AsyncJob API */
67 void callException(const std::exception &e) override;
78 // This is a pointer in hope to minimize future changes when MasterState
79 // becomes a part of MasterXaction. Guaranteed not to be nil.
83 friend void StartListening();
85 // errors detected before it is possible to create an HTTP request wrapper
86 enum class EarlyErrorKind {
87 HugeRequest,
88 MissingLogin,
89 MissingUsername,
90 MissingHost,
91 UnsupportedCommand,
92 InvalidUri,
93 MalformedCommand
94 };
96 /* ConnStateData API */
97 Http::Stream *parseOneRequest() override;
98 void processParsedRequest(Http::StreamPointer &context) override;
100 void clientPinnedConnectionClosed(const CommCloseCbParams &io) override;
101 void handleReply(HttpReply *header, StoreIOBuffer receivedData) override;
102 int pipelinePrefetchMax() const override;
103 bool writeControlMsgAndCall(HttpReply *rep, AsyncCall::Pointer &call) override;
104 time_t idleTimeout() const override;
106 /* BodyPipe API */
110 /* AsyncJob API */
111 void start() override;
113 /* Comm callbacks */
114 static void AcceptCtrlConnection(const CommAcceptCbParams &params);
115 void acceptDataConnection(const CommAcceptCbParams &params);
116 void readUploadData(const CommIoCbParams &io);
117 void wroteEarlyReply(const CommIoCbParams &io);
118 void wroteReply(const CommIoCbParams &io);
119 void wroteReplyData(const CommIoCbParams &io);
120 void connectedForData(const CommConnectCbParams &params);
122 unsigned int listenForDataConnection();
123 bool createDataConnection(Ip::Address cltAddr);
124 void closeDataConnection();
128 void userDataCompletionCheckpoint(int finalStatusCode);
134 void calcUri(const SBuf *file);
135 void changeState(const Ftp::ServerState newState, const char *reason);
136 Http::Stream *handleUserRequest(const SBuf &cmd, SBuf &params);
137 bool checkDataConnPost() const;
139 void maybeReadUploadData();
141 void setReply(const int code, const char *msg);
142 void writeCustomReply(const int code, const char *msg, const HttpReply *reply = nullptr);
143 void writeEarlyReply(const int code, const char *msg);
144 void writeErrorReply(const HttpReply *reply, const int status);
145 void writeForwardedForeign(const HttpReply *reply);
146 void writeForwardedReply(const HttpReply *reply);
148 void writeReply(MemBuf &mb);
152 void setDataCommand();
153 bool checkDataConnPre();
156 typedef bool (Ftp::Server::*RequestHandler)(String &cmd, String &params);
157 bool handleFeatRequest(String &cmd, String &params);
158 bool handlePasvRequest(String &cmd, String &params);
159 bool handlePortRequest(String &cmd, String &params);
160 bool handleDataRequest(String &cmd, String &params);
161 bool handleUploadRequest(String &cmd, String &params);
162 bool handleEprtRequest(String &cmd, String &params);
163 bool handleEpsvRequest(String &cmd, String &params);
164 bool handleCwdRequest(String &cmd, String &params);
165 bool handlePassRequest(String &cmd, String &params);
166 bool handleCdupRequest(String &cmd, String &params);
169 typedef void (Ftp::Server::*ReplyHandler)(const HttpReply *reply, StoreIOBuffer data);
170 void handleFeatReply(const HttpReply *header, StoreIOBuffer receivedData);
171 void handlePasvReply(const HttpReply *header, StoreIOBuffer receivedData);
172 void handlePortReply(const HttpReply *header, StoreIOBuffer receivedData);
173 void handleErrorReply(const HttpReply *header, StoreIOBuffer receivedData);
174 void handleDataReply(const HttpReply *header, StoreIOBuffer receivedData);
175 void handleUploadReply(const HttpReply *header, StoreIOBuffer receivedData);
176 void handleEprtReply(const HttpReply *header, StoreIOBuffer receivedData);
177 void handleEpsvReply(const HttpReply *header, StoreIOBuffer receivedData);
180 void doProcessRequest();
181 void shovelUploadData();
182 void resetLogin(const char *reason);
210} // namespace Ftp
#define RefCountable
The locking interface for use on Reference-Counted classes.
Definition: Lock.h:66
int conn
the current server connection FD
Definition: Transport.cc:26
virtual const char * status() const
internal cleanup; do not call directly
Definition: AsyncJob.cc:182
Transaction information shared among our FTP client and server jobs.
Definition: FtpServer.h:43
int userDataDone
Squid will send or has sent this final status code to the FTP client.
Definition: FtpServer.h:54
SBuf workingDir
estimated current working directory for URI formation
Definition: FtpServer.h:50
ServerState serverState
what our FTP server is doing
Definition: FtpServer.h:51
Ip::Address clientDataAddr
address of our FTP client data connection
Definition: FtpServer.h:49
bool clientReadGreeting
Definition: FtpServer.h:52
RefCount< MasterState > Pointer
Definition: FtpServer.h:45
Manages a control connection from an FTP client.
Definition: FtpServer.h:59
void writeCustomReply(const int code, const char *msg, const HttpReply *reply=nullptr)
Definition: FtpServer.cc:507
void handleDataReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:943
bool gotEpsvAll
restrict data conn setup commands to just EPSV
Definition: FtpServer.h:186
void calcUri(const SBuf *file)
computes uri member from host and, if tracked, working dir with file name
Definition: FtpServer.cc:345
AsyncCall::Pointer reader
set when we are reading FTP data
Definition: FtpServer.h:199
bool handlePasvRequest(String &cmd, String &params)
Definition: FtpServer.cc:1413
bool handleDataRequest(String &cmd, String &params)
Definition: FtpServer.cc:1520
bool originDataDownloadAbortedOnError
whether the origin data transfer aborted
Definition: FtpServer.h:204
void setDataCommand()
Definition: FtpServer.cc:1644
bool handleUploadRequest(String &cmd, String &params)
Definition: FtpServer.cc:1534
void writeForwardedReply(const HttpReply *reply)
Definition: FtpServer.cc:1036
void userDataCompletionCheckpoint(int finalStatusCode)
Definition: FtpServer.cc:1809
void connectedForData(const CommConnectCbParams &params)
Done establishing a data connection to the user.
Definition: FtpServer.cc:1703
bool handleCdupRequest(String &cmd, String &params)
Definition: FtpServer.cc:1635
void writeForwardedForeign(const HttpReply *reply)
Definition: FtpServer.cc:1143
static void AcceptCtrlConnection(const CommAcceptCbParams &params)
accept a new FTP control connection and hand it to a dedicated Server
Definition: FtpServer.cc:242
void maybeReadUploadData()
schedules another data connection read if needed
Definition: FtpServer.cc:109
void handleEprtReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:1059
void changeState(const Ftp::ServerState newState, const char *reason)
Definition: FtpServer.cc:529
void wroteReply(const CommIoCbParams &io)
Definition: FtpServer.cc:1256
void handlePasvReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:881
Http::Stream * earlyError(const EarlyErrorKind eek)
creates a context filled with an error message for a given early error
Definition: FtpServer.cc:570
void callException(const std::exception &e) override
called when the job throws during an async call
Definition: FtpServer.cc:1750
void completeDataDownload()
Definition: FtpServer.cc:1834
void handleFeatReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:812
bool handlePortRequest(String &cmd, String &params)
Definition: FtpServer.cc:1491
size_t uploadAvailSize
number of yet unused uploadBuf bytes
Definition: FtpServer.h:191
void acceptDataConnection(const CommAcceptCbParams &params)
Definition: FtpServer.cc:401
bool handleFeatRequest(String &cmd, String &params)
Definition: FtpServer.cc:1406
void writeErrorReply(const HttpReply *reply, const int status)
writes FTP error response with given status and reply-derived error details
Definition: FtpServer.cc:1095
void startWaitingForOrigin()
Definition: FtpServer.cc:1761
friend void StartListening()
accept connections on all configured ftp_ports
SBuf host
intended dest. of a transparently intercepted FTP conn
Definition: FtpServer.h:185
bool checkDataConnPre()
Definition: FtpServer.cc:1661
void writeReply(MemBuf &mb)
Definition: FtpServer.cc:495
void resetLogin(const char *reason)
clear client and server login-related state after the old login is gone
Definition: FtpServer.cc:336
void processParsedRequest(Http::StreamPointer &context) override
start processing a freshly parsed request
Definition: FtpServer.cc:156
void noteBodyConsumerAborted(BodyPipe::Pointer ptr) override
Definition: FtpServer.cc:231
void wroteReplyData(const CommIoCbParams &io)
called when we are done writing a chunk of the response data
Definition: FtpServer.cc:986
JobWait< Comm::ConnOpener > dataConnWait
Definition: FtpServer.h:197
time_t idleTimeout() const override
timeout to use when waiting for the next request
Definition: FtpServer.cc:86
void clientPinnedConnectionClosed(const CommCloseCbParams &io) override
Our close handler called by Comm when the pinned connection is closed.
Definition: FtpServer.cc:316
Server(const MasterXaction::Pointer &xact)
Definition: FtpServer.cc:53
bool writeControlMsgAndCall(HttpReply *rep, AsyncCall::Pointer &call) override
handle a control message received by context from a peer and call back
Definition: FtpServer.cc:1152
AsyncCall::Pointer listener
set when we are passively listening
Definition: FtpServer.h:193
void(Ftp::Server::* ReplyHandler)(const HttpReply *reply, StoreIOBuffer data)
a method handling an FTP response; selected by handleReply()
Definition: FtpServer.h:169
void start() override
called by AsyncStart; do not call directly
Definition: FtpServer.cc:92
void handlePortReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:921
void handleErrorReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:934
void notePeerConnection(Comm::ConnectionPointer conn) override
called just before a FwdState-dispatched job starts using connection
Definition: FtpServer.cc:302
Http::Stream * parseOneRequest() override
Definition: FtpServer.cc:640
char uploadBuf[CLIENT_REQ_BUF_SZ]
data connection input buffer
Definition: FtpServer.h:190
void handleReply(HttpReply *header, StoreIOBuffer receivedData) override
Definition: FtpServer.cc:778
bool createDataConnection(Ip::Address cltAddr)
[Re]initializes dataConn for active data transfers. Does not connect.
Definition: FtpServer.cc:1432
bool handleEpsvRequest(String &cmd, String &params)
Definition: FtpServer.cc:1596
void setReply(const int code, const char *msg)
Definition: FtpServer.cc:1729
bool(Ftp::Server::* RequestHandler)(String &cmd, String &params)
a method handling an FTP command; selected by handleRequest()
Definition: FtpServer.h:156
void replyDataWritingCheckpoint()
ClientStream checks after (actual or skipped) reply data writing.
Definition: FtpServer.cc:1004
bool handlePassRequest(String &cmd, String &params)
Definition: FtpServer.cc:1628
void handleEpsvReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:1072
void wroteEarlyReply(const CommIoCbParams &io)
Definition: FtpServer.cc:1234
Http::Stream * handleUserRequest(const SBuf &cmd, SBuf &params)
Definition: FtpServer.cc:1358
SBuf uri
a URI reconstructed from various FTP message details
Definition: FtpServer.h:184
void handleUploadReply(const HttpReply *header, StoreIOBuffer receivedData)
Definition: FtpServer.cc:1029
AsyncCall::Pointer onDataAcceptCall
who to call upon data conn acceptance
Definition: FtpServer.h:187
bool handleRequest(HttpRequest *)
Definition: FtpServer.cc:1299
void noteMoreBodySpaceAvailable(BodyPipe::Pointer) override
Definition: FtpServer.cc:222
HttpReply::Pointer delayedReply
a response which writing was postponed until stopWaitingForOrigin()
Definition: FtpServer.h:207
void stopWaitingForOrigin(int status)
Definition: FtpServer.cc:1771
void shovelUploadData()
shovel upload data from the internal buffer to the body pipe if possible
Definition: FtpServer.cc:202
unsigned int listenForDataConnection()
Definition: FtpServer.cc:370
void writeForwardedReplyAndCall(const HttpReply *reply, AsyncCall::Pointer &call)
Definition: FtpServer.cc:1161
int pipelinePrefetchMax() const override
returning N allows a pipeline of 1+N requests (see pipeline_prefetch)
Definition: FtpServer.cc:80
bool checkDataConnPost() const
Check that client data connection is ready for immediate I/O.
Definition: FtpServer.cc:1692
void doProcessRequest()
react to the freshly parsed request
Definition: FtpServer.cc:128
Comm::ConnectionPointer dataListenConn
data connection listening socket
Definition: FtpServer.h:188
void readUploadData(const CommIoCbParams &io)
imports more upload data from the data connection
Definition: FtpServer.cc:168
Comm::ConnectionPointer dataConn
data connection
Definition: FtpServer.h:189
bool handleCwdRequest(String &cmd, String &params)
Definition: FtpServer.cc:1621
bool handleEprtRequest(String &cmd, String &params)
Definition: FtpServer.cc:1567
void writeEarlyReply(const int code, const char *msg)
Definition: FtpServer.cc:476
MasterState::Pointer master
info shared among our FTP client and server jobs
Definition: FtpServer.h:80
bool waitingForOrigin
whether we wait for the origin data transfer to end
Definition: FtpServer.h:202
~Server() override
Definition: FtpServer.cc:74
void closeDataConnection()
Definition: FtpServer.cc:445
Definition: MemBuf.h:24
Definition: SBuf.h:94
Definition: defines.h:88
Definition: forward.h:24
Definition: FtpServer.h:23
@ fssError
Definition: FtpServer.h:36
@ fssHandlePort
Definition: FtpServer.h:28
@ fssHandleCdup
Definition: FtpServer.h:35
@ fssHandleFeat
Definition: FtpServer.h:26
@ fssHandlePasv
Definition: FtpServer.h:27
@ fssConnected
Definition: FtpServer.h:25
@ fssHandleEprt
Definition: FtpServer.h:31
@ fssHandleCwd
Definition: FtpServer.h:33
@ fssHandlePass
Definition: FtpServer.h:34
@ fssHandleUploadRequest
Definition: FtpServer.h:30
@ fssBegin
Definition: FtpServer.h:24
@ fssHandleEpsv
Definition: FtpServer.h:32
@ fssHandleDataRequest
Definition: FtpServer.h:29
int code
Definition: smb-errors.c:145






Web Site Translations