FtpServer.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2019 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  */
8 
9 /* DEBUG: section 33 Client-side Routines */
10 
11 #ifndef SQUID_SERVERS_FTP_SERVER_H
12 #define SQUID_SERVERS_FTP_SERVER_H
13 
14 #include "base/Lock.h"
15 #include "client_side.h"
16 
17 namespace Ftp
18 {
19 
20 typedef enum {
34 } ServerState;
35 
36 // TODO: This should become a part of MasterXaction when we start sending
37 // master transactions to the clients/ code.
40 {
41 public:
43 
45 
48  ServerState serverState;
50  int userDataDone;
52 };
53 
55 class Server: public ConnStateData
56 {
58 
59 public:
60  explicit Server(const MasterXaction::Pointer &xact);
61  virtual ~Server() override;
62 
63  /* AsyncJob API */
64  virtual void callException(const std::exception &e) override;
65 
68  void startWaitingForOrigin();
69 
73  void stopWaitingForOrigin(int status);
74 
75  // This is a pointer in hope to minimize future changes when MasterState
76  // becomes a part of MasterXaction. Guaranteed not to be nil.
78 
79 protected:
80  friend void StartListening();
81 
82  // errors detected before it is possible to create an HTTP request wrapper
83  enum class EarlyErrorKind {
84  HugeRequest,
85  MissingLogin,
86  MissingUsername,
87  MissingHost,
88  UnsupportedCommand,
89  InvalidUri,
90  MalformedCommand
91  };
92 
93  /* ConnStateData API */
94  virtual Http::Stream *parseOneRequest() override;
95  virtual void processParsedRequest(Http::StreamPointer &context) override;
96  virtual void notePeerConnection(Comm::ConnectionPointer conn) override;
97  virtual void clientPinnedConnectionClosed(const CommCloseCbParams &io) override;
98  virtual void handleReply(HttpReply *header, StoreIOBuffer receivedData) override;
99  virtual int pipelinePrefetchMax() const override;
100  virtual bool writeControlMsgAndCall(HttpReply *rep, AsyncCall::Pointer &call) override;
101  virtual time_t idleTimeout() const override;
102 
103  /* BodyPipe API */
104  virtual void noteMoreBodySpaceAvailable(BodyPipe::Pointer) override;
105  virtual void noteBodyConsumerAborted(BodyPipe::Pointer ptr) override;
106 
107  /* AsyncJob API */
108  virtual void start() override;
109 
110  /* Comm callbacks */
111  static void AcceptCtrlConnection(const CommAcceptCbParams &params);
112  void acceptDataConnection(const CommAcceptCbParams &params);
113  void readUploadData(const CommIoCbParams &io);
114  void wroteEarlyReply(const CommIoCbParams &io);
115  void wroteReply(const CommIoCbParams &io);
116  void wroteReplyData(const CommIoCbParams &io);
117  void connectedForData(const CommConnectCbParams &params);
118 
119  unsigned int listenForDataConnection();
120  bool createDataConnection(Ip::Address cltAddr);
121  void closeDataConnection();
122 
125  void userDataCompletionCheckpoint(int finalStatusCode);
126 
129  void completeDataDownload();
130 
131  void calcUri(const SBuf *file);
132  void changeState(const Ftp::ServerState newState, const char *reason);
133  Http::Stream *handleUserRequest(const SBuf &cmd, SBuf &params);
134  bool checkDataConnPost() const;
135  void replyDataWritingCheckpoint();
136  void maybeReadUploadData();
137 
138  void setReply(const int code, const char *msg);
139  void writeCustomReply(const int code, const char *msg, const HttpReply *reply = NULL);
140  void writeEarlyReply(const int code, const char *msg);
141  void writeErrorReply(const HttpReply *reply, const int status);
142  void writeForwardedForeign(const HttpReply *reply);
143  void writeForwardedReply(const HttpReply *reply);
144  void writeForwardedReplyAndCall(const HttpReply *reply, AsyncCall::Pointer &call);
145  void writeReply(MemBuf &mb);
146 
147  Http::Stream *earlyError(const EarlyErrorKind eek);
148  bool handleRequest(HttpRequest *);
149  void setDataCommand();
150  bool checkDataConnPre();
151 
153  typedef bool (Ftp::Server::*RequestHandler)(String &cmd, String &params);
154  bool handleFeatRequest(String &cmd, String &params);
155  bool handlePasvRequest(String &cmd, String &params);
156  bool handlePortRequest(String &cmd, String &params);
157  bool handleDataRequest(String &cmd, String &params);
158  bool handleUploadRequest(String &cmd, String &params);
159  bool handleEprtRequest(String &cmd, String &params);
160  bool handleEpsvRequest(String &cmd, String &params);
161  bool handleCwdRequest(String &cmd, String &params);
162  bool handlePassRequest(String &cmd, String &params);
163  bool handleCdupRequest(String &cmd, String &params);
164 
166  typedef void (Ftp::Server::*ReplyHandler)(const HttpReply *reply, StoreIOBuffer data);
167  void handleFeatReply(const HttpReply *header, StoreIOBuffer receivedData);
168  void handlePasvReply(const HttpReply *header, StoreIOBuffer receivedData);
169  void handlePortReply(const HttpReply *header, StoreIOBuffer receivedData);
170  void handleErrorReply(const HttpReply *header, StoreIOBuffer receivedData);
171  void handleDataReply(const HttpReply *header, StoreIOBuffer receivedData);
172  void handleUploadReply(const HttpReply *header, StoreIOBuffer receivedData);
173  void handleEprtReply(const HttpReply *header, StoreIOBuffer receivedData);
174  void handleEpsvReply(const HttpReply *header, StoreIOBuffer receivedData);
175 
176 private:
177  void doProcessRequest();
178  void shovelUploadData();
179  void resetLogin(const char *reason);
180 
183  bool gotEpsvAll;
187  char uploadBuf[CLIENT_REQ_BUF_SZ];
189 
193 
198 
201 };
202 
203 } // namespace Ftp
204 
205 #endif /* SQUID_SERVERS_FTP_SERVER_H */
206 
ServerState
Definition: FtpServer.h:20
Comm::ConnectionPointer dataConn
data connection
Definition: FtpServer.h:186
Definition: SBuf.h:86
Transaction information shared among our FTP client and server jobs.
Definition: FtpServer.h:39
SBuf workingDir
estimated current working directory for URI formation
Definition: FtpServer.h:47
int conn
the current server connection FD
Definition: Transport.cc:26
size_t uploadAvailSize
number of yet unused uploadBuf bytes
Definition: FtpServer.h:188
bool clientReadGreeting
Definition: FtpServer.h:49
bool waitingForOrigin
whether we wait for the origin data transfer to end
Definition: FtpServer.h:195
HttpReply::Pointer delayedReply
a response which writing was postponed until stopWaitingForOrigin()
Definition: FtpServer.h:200
AsyncCall::Pointer listener
set when we are passively listening
Definition: FtpServer.h:190
Manages a control connection from an FTP client.
Definition: FtpServer.h:55
void const char HLPCB void * data
Definition: stub_helper.cc:16
AsyncCall::Pointer reader
set when we are reading FTP data
Definition: FtpServer.h:192
Comm::ConnectionPointer dataListenConn
data connection listening socket
Definition: FtpServer.h:185
SBuf uri
a URI reconstructed from various FTP message details
Definition: FtpServer.h:181
MasterState::Pointer master
info shared among our FTP client and server jobs
Definition: FtpServer.h:77
SBuf host
intended dest. of a transparently intercepted FTP conn
Definition: FtpServer.h:182
unsigned char code
Definition: html_quote.c:20
void StartListening()
accept connections on all configured ftp_ports
Definition: FtpServer.cc:266
bool gotEpsvAll
restrict data conn setup commands to just EPSV
Definition: FtpServer.h:183
bool originDataDownloadAbortedOnError
whether the origin data transfer aborted
Definition: FtpServer.h:197
AsyncCall::Pointer connector
set when we are actively connecting
Definition: FtpServer.h:191
AsyncCall::Pointer onDataAcceptCall
who to call upon data conn acceptance
Definition: FtpServer.h:184
Ip::Address clientDataAddr
address of our FTP client data connection
Definition: FtpServer.h:46
Definition: MemBuf.h:23
Definition: forward.h:27
#define CBDATA_CHILD(type)
Definition: cbdata.h:307
RefCount< MasterState > Pointer
Definition: FtpServer.h:42
ServerState serverState
what our FTP server is doing
Definition: FtpServer.h:48
#define NULL
Definition: types.h:166
int userDataDone
Squid will send or has sent this final status code to the FTP client.
Definition: FtpServer.h:51
#define false
Definition: GnuRegex.c:233
#define CLIENT_REQ_BUF_SZ
Definition: defines.h:130

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors