2 * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
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.
9 /* DEBUG: section 33 Transfer protocol servers */
12 #include "acl/FilledChecklist.h"
13 #include "base/CharacterSet.h"
14 #include "base/RefCount.h"
15 #include "base/Subscription.h"
16 #include "client_side_reply.h"
17 #include "client_side_request.h"
18 #include "clientStream.h"
19 #include "comm/ConnOpener.h"
20 #include "comm/Read.h"
21 #include "comm/TcpAcceptor.h"
22 #include "comm/Write.h"
23 #include "errorpage.h"
25 #include "ftp/Elements.h"
26 #include "ftp/Parsing.h"
28 #include "http/one/RequestParser.h"
29 #include "HttpHdrCc.h"
31 #include "ipc/FdNotes.h"
32 #include "parser/Tokenizer.h"
33 #include "servers/forward.h"
34 #include "servers/FtpServer.h"
35 #include "SquidConfig.h"
36 #include "StatCounters.h"
42 CBDATA_NAMESPACED_CLASS_INIT(Ftp
, Server
);
46 static void PrintReply(MemBuf
&mb
, const HttpReply
*reply
, const char *const prefix
= "");
47 static bool SupportedCommand(const SBuf
&name
);
48 static bool CommandHasPathParameter(const SBuf
&cmd
);
51 Ftp::Server::Server(const MasterXaction::Pointer
&xact
):
52 AsyncJob("Ftp::Server"),
54 master(new MasterState
),
66 flags
.readMore
= false; // we need to announce ourselves first
70 Ftp::Server::~Server()
72 closeDataConnection();
76 Ftp::Server::pipelinePrefetchMax() const
78 return 0; // no support for concurrent FTP requests
82 Ftp::Server::idleTimeout() const
84 return Config
.Timeout
.ftpClientIdle
;
90 ConnStateData::start();
93 char buf
[MAX_IPSTRLEN
];
94 clientConnection
->local
.toUrl(buf
, MAX_IPSTRLEN
);
97 debugs(33, 5, "FTP transparent URL: " << uri
);
100 writeEarlyReply(220, "Service ready");
103 /// schedules another data connection read if needed
105 Ftp::Server::maybeReadUploadData()
110 const size_t availSpace
= sizeof(uploadBuf
) - uploadAvailSize
;
114 debugs(33, 4, dataConn
<< ": reading FTP data...");
116 typedef CommCbMemFunT
<Server
, CommIoCbParams
> Dialer
;
117 reader
= JobCallback(33, 5, Dialer
, this, Ftp::Server::readUploadData
);
118 comm_read(dataConn
, uploadBuf
+ uploadAvailSize
, availSpace
,
122 /// react to the freshly parsed request
124 Ftp::Server::doProcessRequest()
126 // zero pipelinePrefetchMax() ensures that there is only parsed request
127 Must(pipeline
.count() == 1);
128 ClientSocketContext::Pointer context
= pipeline
.front();
129 Must(context
!= nullptr);
131 ClientHttpRequest
*const http
= context
->http
;
132 assert(http
!= NULL
);
134 HttpRequest
*const request
= http
->request
;
135 Must(http
->storeEntry() || request
);
136 const bool mayForward
= !http
->storeEntry() && handleRequest(request
);
138 if (http
->storeEntry() != NULL
) {
139 debugs(33, 4, "got an immediate response");
140 clientSetKeepaliveFlag(http
);
142 } else if (mayForward
) {
143 debugs(33, 4, "forwarding request to server side");
144 assert(http
->storeEntry() == NULL
);
145 clientProcessRequest(this, Http1::RequestParserPointer(), context
.getRaw());
147 debugs(33, 4, "will resume processing later");
152 Ftp::Server::processParsedRequest(ClientSocketContext
*)
154 Must(pipeline
.count() == 1);
156 // Process FTP request asynchronously to make sure FTP
157 // data connection accept callback is fired first.
158 CallJobHere(33, 4, CbcPointer
<Server
>(this),
159 Ftp::Server
, doProcessRequest
);
162 /// imports more upload data from the data connection
164 Ftp::Server::readUploadData(const CommIoCbParams
&io
)
166 debugs(33, 5, io
.conn
<< " size " << io
.size
);
167 Must(reader
!= NULL
);
170 assert(Comm::IsConnOpen(dataConn
));
171 assert(io
.conn
->fd
== dataConn
->fd
);
173 if (io
.flag
== Comm::OK
&& bodyPipe
!= NULL
) {
175 statCounter
.client_http
.kbytes_in
+= io
.size
;
177 char *const current_buf
= uploadBuf
+ uploadAvailSize
;
178 if (io
.buf
!= current_buf
)
179 memmove(current_buf
, io
.buf
, io
.size
);
180 uploadAvailSize
+= io
.size
;
182 } else if (io
.size
== 0) {
183 debugs(33, 5, io
.conn
<< " closed");
184 closeDataConnection();
185 if (uploadAvailSize
<= 0)
186 finishDechunkingRequest(true);
188 } else { // not Comm::Flags::OK or unexpected read
189 debugs(33, 5, io
.conn
<< " closed");
190 closeDataConnection();
191 finishDechunkingRequest(false);
196 /// shovel upload data from the internal buffer to the body pipe if possible
198 Ftp::Server::shovelUploadData()
200 assert(bodyPipe
!= NULL
);
202 debugs(33, 5, "handling FTP request data for " << clientConnection
);
203 const size_t putSize
= bodyPipe
->putMoreData(uploadBuf
,
206 uploadAvailSize
-= putSize
;
207 if (uploadAvailSize
> 0)
208 memmove(uploadBuf
, uploadBuf
+ putSize
, uploadAvailSize
);
211 if (Comm::IsConnOpen(dataConn
))
212 maybeReadUploadData();
213 else if (uploadAvailSize
<= 0)
214 finishDechunkingRequest(true);
218 Ftp::Server::noteMoreBodySpaceAvailable(BodyPipe::Pointer
)
224 Ftp::Server::noteBodyConsumerAborted(BodyPipe::Pointer ptr
)
226 ConnStateData::noteBodyConsumerAborted(ptr
);
227 closeDataConnection();
230 /// accept a new FTP control connection and hand it to a dedicated Server
232 Ftp::Server::AcceptCtrlConnection(const CommAcceptCbParams
¶ms
)
234 MasterXaction::Pointer xact
= params
.xaction
;
235 AnyP::PortCfgPointer s
= xact
->squidPort
;
237 // NP: it is possible the port was reconfigured when the call or accept() was queued.
239 if (params
.flag
!= Comm::OK
) {
240 // Its possible the call was still queued when the client disconnected
241 debugs(33, 2, s
->listenConn
<< ": FTP accept failure: " << xstrerr(params
.xerrno
));
245 debugs(33, 4, params
.conn
<< ": accepted");
246 fd_note(params
.conn
->fd
, "client ftp connect");
248 if (s
->tcp_keepalive
.enabled
)
249 commSetTcpKeepalive(params
.conn
->fd
, s
->tcp_keepalive
.idle
, s
->tcp_keepalive
.interval
, s
->tcp_keepalive
.timeout
);
251 ++incoming_sockets_accepted
;
253 AsyncJob::Start(new Server(xact
));
257 Ftp::StartListening()
259 for (AnyP::PortCfgPointer s
= FtpPortList
; s
!= NULL
; s
= s
->next
) {
260 if (MAXTCPLISTENPORTS
== NHttpSockets
) {
261 debugs(1, DBG_IMPORTANT
, "Ignoring ftp_port lines exceeding the" <<
262 " limit of " << MAXTCPLISTENPORTS
<< " ports.");
266 // direct new connections accepted by listenConn to Accept()
267 typedef CommCbFunPtrCallT
<CommAcceptCbPtrFun
> AcceptCall
;
268 RefCount
<AcceptCall
> subCall
= commCbCall(5, 5, "Ftp::Server::AcceptCtrlConnection",
269 CommAcceptCbPtrFun(Ftp::Server::AcceptCtrlConnection
,
270 CommAcceptCbParams(NULL
)));
271 clientStartListeningOn(s
, subCall
, Ipc::fdnFtpSocket
);
278 for (AnyP::PortCfgPointer s
= FtpPortList
; s
!= NULL
; s
= s
->next
) {
279 if (s
->listenConn
!= NULL
) {
280 debugs(1, DBG_IMPORTANT
, "Closing FTP port " << s
->listenConn
->local
);
281 s
->listenConn
->close();
282 s
->listenConn
= NULL
;
288 Ftp::Server::notePeerConnection(Comm::ConnectionPointer conn
)
291 ClientSocketContext::Pointer context
= pipeline
.front();
292 Must(context
!= nullptr);
293 ClientHttpRequest
*const http
= context
->http
;
295 HttpRequest
*const request
= http
->request
;
296 Must(request
!= NULL
);
298 // this is not an idle connection, so we do not want I/O monitoring
299 const bool monitor
= false;
301 // make FTP peer connection exclusive to our request
302 pinConnection(conn
, request
, conn
->getPeer(), false, monitor
);
306 Ftp::Server::clientPinnedConnectionClosed(const CommCloseCbParams
&io
)
308 ConnStateData::clientPinnedConnectionClosed(io
);
310 // if the server control connection is gone, reset state to login again
311 resetLogin("control connection closure");
313 // XXX: Reseting is not enough. FtpRelay::sendCommand() will not re-login
314 // because FtpRelay::serverState() is not going to be fssConnected.
317 /// clear client and server login-related state after the old login is gone
319 Ftp::Server::resetLogin(const char *reason
)
321 debugs(33, 5, "will need to re-login due to " << reason
);
322 master
->clientReadGreeting
= false;
323 changeState(fssBegin
, reason
);
326 /// computes uri member from host and, if tracked, working dir with file name
328 Ftp::Server::calcUri(const SBuf
*file
)
332 if (port
->ftp_track_dirs
&& master
->workingDir
.length()) {
333 if (master
->workingDir
[0] != '/')
335 uri
.append(master
->workingDir
);
338 if (uri
[uri
.length() - 1] != '/')
341 if (port
->ftp_track_dirs
&& file
) {
342 static const CharacterSet
Slash("/", "/");
343 Parser::Tokenizer
tok(*file
);
345 uri
.append(tok
.remaining());
349 /// Starts waiting for a data connection. Returns listening port.
350 /// On errors, responds with an error and returns zero.
352 Ftp::Server::listenForDataConnection()
354 closeDataConnection();
356 Comm::ConnectionPointer conn
= new Comm::Connection
;
357 conn
->flags
= COMM_NONBLOCKING
;
358 conn
->local
= transparent() ? port
->s
: clientConnection
->local
;
360 const char *const note
= uri
.c_str();
361 comm_open_listener(SOCK_STREAM
, IPPROTO_TCP
, conn
, note
);
362 if (!Comm::IsConnOpen(conn
)) {
363 debugs(5, DBG_CRITICAL
, "comm_open_listener failed for FTP data: " <<
364 conn
->local
<< " error: " << errno
);
365 writeCustomReply(451, "Internal error");
369 typedef CommCbMemFunT
<Server
, CommAcceptCbParams
> AcceptDialer
;
370 typedef AsyncCallT
<AcceptDialer
> AcceptCall
;
371 RefCount
<AcceptCall
> call
= static_cast<AcceptCall
*>(JobCallback(5, 5, AcceptDialer
, this, Ftp::Server::acceptDataConnection
));
372 Subscription::Pointer sub
= new CallSubscription
<AcceptCall
>(call
);
373 listener
= call
.getRaw();
374 dataListenConn
= conn
;
375 AsyncJob::Start(new Comm::TcpAcceptor(conn
, note
, sub
));
377 const unsigned int listeningPort
= comm_local_port(conn
->fd
);
378 conn
->local
.port(listeningPort
);
379 return listeningPort
;
383 Ftp::Server::acceptDataConnection(const CommAcceptCbParams
¶ms
)
385 if (params
.flag
!= Comm::OK
) {
386 // Its possible the call was still queued when the client disconnected
387 debugs(33, 2, dataListenConn
<< ": accept "
388 "failure: " << xstrerr(params
.xerrno
));
392 debugs(33, 4, "accepted " << params
.conn
);
393 fd_note(params
.conn
->fd
, "passive client ftp data");
394 ++incoming_sockets_accepted
;
396 if (!clientConnection
) {
397 debugs(33, 5, "late data connection?");
398 closeDataConnection(); // in case we are still listening
399 params
.conn
->close();
400 } else if (params
.conn
->remote
!= clientConnection
->remote
) {
401 debugs(33, 2, "rogue data conn? ctrl: " << clientConnection
->remote
);
402 params
.conn
->close();
403 // Some FTP servers close control connection here, but it may make
404 // things worse from DoS p.o.v. and no better from data stealing p.o.v.
406 closeDataConnection();
407 dataConn
= params
.conn
;
409 debugs(33, 7, "ready for data");
410 if (onDataAcceptCall
!= NULL
) {
411 AsyncCall::Pointer call
= onDataAcceptCall
;
412 onDataAcceptCall
= NULL
;
413 // If we got an upload request, start reading data from the client.
414 if (master
->serverState
== fssHandleUploadRequest
)
415 maybeReadUploadData();
417 Must(master
->serverState
== fssHandleDataRequest
);
420 mb
.appendf("150 Data connection opened.\r\n");
421 Comm::Write(clientConnection
, &mb
, call
);
427 Ftp::Server::closeDataConnection()
429 if (listener
!= NULL
) {
430 listener
->cancel("no longer needed");
434 if (Comm::IsConnOpen(dataListenConn
)) {
435 debugs(33, 5, "FTP closing client data listen socket: " <<
437 dataListenConn
->close();
439 dataListenConn
= NULL
;
441 if (reader
!= NULL
) {
442 // Comm::ReadCancel can deal with negative FDs
443 Comm::ReadCancel(dataConn
->fd
, reader
);
447 if (Comm::IsConnOpen(dataConn
)) {
448 debugs(33, 5, "FTP closing client data connection: " <<
455 /// Writes FTP [error] response before we fully parsed the FTP request and
456 /// created the corresponding HTTP request wrapper for that FTP request.
458 Ftp::Server::writeEarlyReply(const int code
, const char *msg
)
460 debugs(33, 7, code
<< ' ' << msg
);
461 assert(99 < code
&& code
< 1000);
465 mb
.appendf("%i %s\r\n", code
, msg
);
467 typedef CommCbMemFunT
<Server
, CommIoCbParams
> Dialer
;
468 AsyncCall::Pointer call
= JobCallback(33, 5, Dialer
, this, Ftp::Server::wroteEarlyReply
);
469 Comm::Write(clientConnection
, &mb
, call
);
471 flags
.readMore
= false;
473 // TODO: Create master transaction. Log it in wroteEarlyReply().
477 Ftp::Server::writeReply(MemBuf
&mb
)
479 debugs(9, 2, "FTP Client " << clientConnection
);
480 debugs(9, 2, "FTP Client REPLY:\n---------\n" << mb
.buf
<<
483 typedef CommCbMemFunT
<Server
, CommIoCbParams
> Dialer
;
484 AsyncCall::Pointer call
= JobCallback(33, 5, Dialer
, this, Ftp::Server::wroteReply
);
485 Comm::Write(clientConnection
, &mb
, call
);
489 Ftp::Server::writeCustomReply(const int code
, const char *msg
, const HttpReply
*reply
)
491 debugs(33, 7, code
<< ' ' << msg
);
492 assert(99 < code
&& code
< 1000);
494 const bool sendDetails
= reply
!= NULL
&&
495 reply
->header
.has(Http::HdrType::FTP_STATUS
) && reply
->header
.has(Http::HdrType::FTP_REASON
);
500 mb
.appendf("%i-%s\r\n", code
, msg
);
501 mb
.appendf(" Server reply:\r\n");
502 Ftp::PrintReply(mb
, reply
, " ");
503 mb
.appendf("%i \r\n", code
);
505 mb
.appendf("%i %s\r\n", code
, msg
);
511 Ftp::Server::changeState(const ServerState newState
, const char *reason
)
513 if (master
->serverState
== newState
) {
514 debugs(33, 3, "client state unchanged at " << master
->serverState
<<
515 " because " << reason
);
516 master
->serverState
= newState
;
518 debugs(33, 3, "client state was " << master
->serverState
<<
519 ", now " << newState
<< " because " << reason
);
520 master
->serverState
= newState
;
524 /// whether the given FTP command has a pathname parameter
526 Ftp::CommandHasPathParameter(const SBuf
&cmd
)
528 static std::set
<SBuf
> PathedCommands
;
529 if (!PathedCommands
.size()) {
530 PathedCommands
.insert(cmdMlst());
531 PathedCommands
.insert(cmdMlsd());
532 PathedCommands
.insert(cmdStat());
533 PathedCommands
.insert(cmdNlst());
534 PathedCommands
.insert(cmdList());
535 PathedCommands
.insert(cmdMkd());
536 PathedCommands
.insert(cmdRmd());
537 PathedCommands
.insert(cmdDele());
538 PathedCommands
.insert(cmdRnto());
539 PathedCommands
.insert(cmdRnfr());
540 PathedCommands
.insert(cmdAppe());
541 PathedCommands
.insert(cmdStor());
542 PathedCommands
.insert(cmdRetr());
543 PathedCommands
.insert(cmdSmnt());
544 PathedCommands
.insert(cmdCwd());
547 return PathedCommands
.find(cmd
) != PathedCommands
.end();
550 /// creates a context filled with an error message for a given early error
551 ClientSocketContext
*
552 Ftp::Server::earlyError(const EarlyErrorKind eek
)
554 /* Default values, to be updated by the switch statement below */
556 const char *reason
= "Internal error";
557 const char *errUri
= "error:ftp-internal-early-error";
560 case EarlyErrorKind::HugeRequest
:
562 reason
= "Huge request";
563 errUri
= "error:ftp-huge-request";
566 case EarlyErrorKind::MissingLogin
:
568 reason
= "Must login first";
569 errUri
= "error:ftp-must-login-first";
572 case EarlyErrorKind::MissingUsername
:
574 reason
= "Missing username";
575 errUri
= "error:ftp-missing-username";
578 case EarlyErrorKind::MissingHost
:
580 reason
= "Missing host";
581 errUri
= "error:ftp-missing-host";
584 case EarlyErrorKind::UnsupportedCommand
:
586 reason
= "Unknown or unsupported command";
587 errUri
= "error:ftp-unsupported-command";
590 case EarlyErrorKind::InvalidUri
:
592 reason
= "Invalid URI";
593 errUri
= "error:ftp-invalid-uri";
596 case EarlyErrorKind::MalformedCommand
:
598 reason
= "Malformed command";
599 errUri
= "error:ftp-malformed-command";
602 // no default so that a compiler can check that we have covered all cases
605 ClientSocketContext
*context
= abortRequestParsing(errUri
);
606 clientStreamNode
*node
= context
->getClientReplyContext();
608 clientReplyContext
*repContext
= dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
611 // We cannot relay FTP scode/reason via HTTP-specific ErrorState.
612 // TODO: When/if ErrorState can handle native FTP errors, use it instead.
613 HttpReply
*reply
= Ftp::HttpReplyWrapper(scode
, reason
, Http::scBadRequest
, -1);
614 repContext
->setReplyToReply(reply
);
618 /// Parses a single FTP request on the control connection.
619 /// Returns a new ClientSocketContext on valid requests and all errors.
620 /// Returns NULL on incomplete requests that may still succeed given more data.
621 ClientSocketContext
*
622 Ftp::Server::parseOneRequest()
624 flags
.readMore
= false; // common for all but one case below
626 // OWS <command> [ RWS <parameter> ] OWS LF
628 // InlineSpaceChars are isspace(3) or RFC 959 Section 3.1.1.5.2, except
629 // for the LF character that we must exclude here (but see FullWhiteSpace).
630 static const char * const InlineSpaceChars
= " \f\r\t\v";
631 static const CharacterSet InlineSpace
= CharacterSet("Ftp::Inline", InlineSpaceChars
);
632 static const CharacterSet FullWhiteSpace
= (InlineSpace
+ CharacterSet::LF
).rename("Ftp::FWS");
633 static const CharacterSet CommandChars
= FullWhiteSpace
.complement("Ftp::Command");
634 static const CharacterSet TailChars
= CharacterSet::LF
.complement("Ftp::Tail");
636 // This set is used to ignore empty commands without allowing an attacker
637 // to keep us endlessly busy by feeding us whitespace or empty commands.
638 static const CharacterSet
&LeadingSpace
= FullWhiteSpace
;
643 Parser::Tokenizer
tok(inBuf
);
645 (void)tok
.skipAll(LeadingSpace
); // leading OWS and empty commands
646 const bool parsed
= tok
.prefix(cmd
, CommandChars
); // required command
648 // note that the condition below will eat either RWS or trailing OWS
649 if (parsed
&& tok
.skipAll(InlineSpace
) && tok
.prefix(params
, TailChars
)) {
650 // now params may include trailing OWS
651 // TODO: Support right-trimming using CharacterSet in Tokenizer instead
652 static const SBuf
bufWhiteSpace(InlineSpaceChars
);
653 params
.trim(bufWhiteSpace
, false, true);
656 // Why limit command line and parameters size? Did not we just parse them?
657 // XXX: Our good old String cannot handle very long strings.
658 const SBuf::size_type tokenMax
= min(
659 static_cast<SBuf::size_type
>(32*1024), // conservative
660 static_cast<SBuf::size_type
>(Config
.maxRequestHeaderSize
));
661 if (cmd
.length() > tokenMax
|| params
.length() > tokenMax
) {
662 changeState(fssError
, "huge req token");
663 quitAfterError(NULL
);
664 return earlyError(EarlyErrorKind::HugeRequest
);
667 // technically, we may skip multiple NLs below, but that is OK
668 if (!parsed
|| !tok
.skipAll(CharacterSet::LF
)) { // did not find terminating LF yet
669 // we need more data, but can we buffer more?
670 if (inBuf
.length() >= Config
.maxRequestHeaderSize
) {
671 changeState(fssError
, "huge req");
672 quitAfterError(NULL
);
673 return earlyError(EarlyErrorKind::HugeRequest
);
675 flags
.readMore
= true;
676 debugs(33, 5, "Waiting for more, up to " <<
677 (Config
.maxRequestHeaderSize
- inBuf
.length()));
682 Must(parsed
&& cmd
.length());
683 consumeInput(tok
.parsedSize()); // TODO: Would delaying optimize copying?
685 debugs(33, 2, ">>ftp " << cmd
<< (params
.isEmpty() ? "" : " ") << params
);
687 cmd
.toUpper(); // this should speed up and simplify future comparisons
689 // interception cases do not need USER to calculate the uri
690 if (!transparent()) {
691 if (!master
->clientReadGreeting
) {
692 // the first command must be USER
693 if (!pinning
.pinned
&& cmd
!= cmdUser())
694 return earlyError(EarlyErrorKind::MissingLogin
);
697 // process USER request now because it sets FTP peer host name
698 if (cmd
== cmdUser()) {
699 if (ClientSocketContext
*errCtx
= handleUserRequest(cmd
, params
))
704 if (!Ftp::SupportedCommand(cmd
))
705 return earlyError(EarlyErrorKind::UnsupportedCommand
);
707 const HttpRequestMethod method
=
708 cmd
== cmdAppe() || cmd
== cmdStor() || cmd
== cmdStou() ?
709 Http::METHOD_PUT
: Http::METHOD_GET
;
711 const SBuf
*path
= (params
.length() && CommandHasPathParameter(cmd
)) ?
714 char *newUri
= xstrdup(uri
.c_str());
715 HttpRequest
*const request
= HttpRequest::CreateFromUrlAndMethod(newUri
, method
);
717 debugs(33, 5, "Invalid FTP URL: " << uri
);
720 return earlyError(EarlyErrorKind::InvalidUri
);
723 request
->flags
.ftpNative
= true;
724 request
->http_ver
= Http::ProtocolVersion(Ftp::ProtocolVersion().major
, Ftp::ProtocolVersion().minor
);
726 // Our fake Request-URIs are not distinctive enough for caching to work
727 request
->flags
.cachable
= false; // XXX: reset later by maybeCacheable()
728 request
->flags
.noCache
= true;
730 request
->header
.putStr(Http::HdrType::FTP_COMMAND
, cmd
.c_str());
731 request
->header
.putStr(Http::HdrType::FTP_ARGUMENTS
, params
.c_str()); // may be ""
732 if (method
== Http::METHOD_PUT
) {
733 request
->header
.putStr(Http::HdrType::EXPECT
, "100-continue");
734 request
->header
.putStr(Http::HdrType::TRANSFER_ENCODING
, "chunked");
737 ClientHttpRequest
*const http
= new ClientHttpRequest(this);
738 http
->request
= request
;
739 HTTPMSGLOCK(http
->request
);
740 http
->req_sz
= tok
.parsedSize();
743 ClientSocketContext
*const result
=
744 new ClientSocketContext(clientConnection
, http
);
746 StoreIOBuffer tempBuffer
;
747 tempBuffer
.data
= result
->reqbuf
;
748 tempBuffer
.length
= HTTP_REQBUF_SZ
;
750 ClientStreamData newServer
= new clientReplyContext(http
);
751 ClientStreamData newClient
= result
;
752 clientStreamInit(&http
->client_stream
, clientGetMoreData
, clientReplyDetach
,
753 clientReplyStatus
, newServer
, clientSocketRecipient
,
754 clientSocketDetach
, newClient
, tempBuffer
);
756 result
->flags
.parsed_ok
= 1;
761 Ftp::Server::handleReply(HttpReply
*reply
, StoreIOBuffer data
)
763 // the caller guarantees that we are dealing with the current context only
764 ClientSocketContext::Pointer context
= pipeline
.front();
765 assert(context
!= nullptr);
767 if (context
->http
&& context
->http
->al
!= NULL
&&
768 !context
->http
->al
->reply
&& reply
) {
769 context
->http
->al
->reply
= reply
;
770 HTTPMSGLOCK(context
->http
->al
->reply
);
773 static ReplyHandler handlers
[] = {
775 NULL
, // fssConnected
776 &Ftp::Server::handleFeatReply
, // fssHandleFeat
777 &Ftp::Server::handlePasvReply
, // fssHandlePasv
778 &Ftp::Server::handlePortReply
, // fssHandlePort
779 &Ftp::Server::handleDataReply
, // fssHandleDataRequest
780 &Ftp::Server::handleUploadReply
, // fssHandleUploadRequest
781 &Ftp::Server::handleEprtReply
,// fssHandleEprt
782 &Ftp::Server::handleEpsvReply
,// fssHandleEpsv
783 NULL
, // fssHandleCwd
784 NULL
, // fssHandlePass
785 NULL
, // fssHandleCdup
786 &Ftp::Server::handleErrorReply
// fssError
789 const Server
&server
= dynamic_cast<const Ftp::Server
&>(*context
->getConn());
790 if (const ReplyHandler handler
= handlers
[server
.master
->serverState
])
791 (this->*handler
)(reply
, data
);
793 writeForwardedReply(reply
);
794 } catch (const std::exception
&e
) {
796 throw TexcHere(e
.what());
801 Ftp::Server::handleFeatReply(const HttpReply
*reply
, StoreIOBuffer
)
803 if (pipeline
.front()->http
->request
->errType
!= ERR_NONE
) {
804 writeCustomReply(502, "Server does not support FEAT", reply
);
809 HttpReply::Pointer featReply
= Ftp::HttpReplyWrapper(211, "End", Http::scNoContent
, 0);
810 HttpHeader
const &serverReplyHeader
= reply
->header
;
812 HttpHeaderPos pos
= HttpHeaderInitPos
;
813 bool hasEPRT
= false;
814 bool hasEPSV
= false;
815 int prependSpaces
= 1;
817 featReply
->header
.putStr(Http::HdrType::FTP_PRE
, "\"211-Features:\"");
818 const int scode
= serverReplyHeader
.getInt(Http::HdrType::FTP_STATUS
);
820 while (const HttpHeaderEntry
*e
= serverReplyHeader
.getEntry(&pos
)) {
821 if (e
->id
== Http::HdrType::FTP_PRE
) {
822 // assume RFC 2389 FEAT response format, quoted by Squid:
823 // <"> SP NAME [SP PARAMS] <">
824 // but accommodate MS servers sending four SPs before NAME
826 // command name ends with (SP parameter) or quote
827 static const CharacterSet
AfterFeatNameChars("AfterFeatName", " \"");
828 static const CharacterSet FeatNameChars
= AfterFeatNameChars
.complement("FeatName");
830 Parser::Tokenizer
tok(SBuf(e
->value
.termedBuf()));
831 if (!tok
.skip('"') || !tok
.skip(' '))
834 // optional spaces; remember their number to accomodate MS servers
835 prependSpaces
= 1 + tok
.skipAll(CharacterSet::SP
);
838 if (!tok
.prefix(cmd
, FeatNameChars
))
842 if (Ftp::SupportedCommand(cmd
)) {
843 featReply
->header
.addEntry(e
->clone());
846 if (cmd
== cmdEprt())
848 else if (cmd
== cmdEpsv())
852 } // else we got a FEAT error and will only report Squid-supported features
856 snprintf(buf
, sizeof(buf
), "\"%*s\"", prependSpaces
+ 4, "EPRT");
857 featReply
->header
.putStr(Http::HdrType::FTP_PRE
, buf
);
860 snprintf(buf
, sizeof(buf
), "\"%*s\"", prependSpaces
+ 4, "EPSV");
861 featReply
->header
.putStr(Http::HdrType::FTP_PRE
, buf
);
864 featReply
->header
.refreshMask();
866 writeForwardedReply(featReply
.getRaw());
870 Ftp::Server::handlePasvReply(const HttpReply
*reply
, StoreIOBuffer
)
872 const ClientSocketContext::Pointer
context(pipeline
.front());
873 assert(context
!= nullptr);
875 if (context
->http
->request
->errType
!= ERR_NONE
) {
876 writeCustomReply(502, "Server does not support PASV", reply
);
880 const unsigned short localPort
= listenForDataConnection();
884 char addr
[MAX_IPSTRLEN
];
885 // remote server in interception setups and local address otherwise
886 const Ip::Address
&server
= transparent() ?
887 clientConnection
->local
: dataListenConn
->local
;
888 server
.toStr(addr
, MAX_IPSTRLEN
, AF_INET
);
889 addr
[MAX_IPSTRLEN
- 1] = '\0';
890 for (char *c
= addr
; *c
!= '\0'; ++c
) {
895 // In interception setups, we combine remote server address with a
896 // local port number and hope that traffic will be redirected to us.
897 // Do not use "227 =a,b,c,d,p1,p2" format or omit parens: some nf_ct_ftp
898 // versions block responses that use those alternative syntax rules!
901 mb
.appendf("227 Entering Passive Mode (%s,%i,%i).\r\n",
903 static_cast<int>(localPort
/ 256),
904 static_cast<int>(localPort
% 256));
905 debugs(9, 3, Raw("writing", mb
.buf
, mb
.size
));
910 Ftp::Server::handlePortReply(const HttpReply
*reply
, StoreIOBuffer
)
912 if (pipeline
.front()->http
->request
->errType
!= ERR_NONE
) {
913 writeCustomReply(502, "Server does not support PASV (converted from PORT)", reply
);
917 writeCustomReply(200, "PORT successfully converted to PASV.");
923 Ftp::Server::handleErrorReply(const HttpReply
*reply
, StoreIOBuffer
)
925 if (!pinning
.pinned
) // we failed to connect to server
927 // 421: we will close due to fssError
928 writeErrorReply(reply
, 421);
932 Ftp::Server::handleDataReply(const HttpReply
*reply
, StoreIOBuffer data
)
934 if (reply
!= NULL
&& reply
->sline
.status() != Http::scOkay
) {
935 writeForwardedReply(reply
);
936 if (Comm::IsConnOpen(dataConn
)) {
937 debugs(33, 3, "closing " << dataConn
<< " on KO reply");
938 closeDataConnection();
944 // We got STREAM_COMPLETE (or error) and closed the client data conn.
945 debugs(33, 3, "ignoring FTP srv data response after clt data closure");
949 if (!checkDataConnPost()) {
950 writeCustomReply(425, "Data connection is not established.");
951 closeDataConnection();
955 debugs(33, 7, data
.length
);
957 if (data
.length
<= 0) {
958 replyDataWritingCheckpoint(); // skip the actual write call
963 mb
.init(data
.length
+ 1, data
.length
+ 1);
964 mb
.append(data
.data
, data
.length
);
966 typedef CommCbMemFunT
<Server
, CommIoCbParams
> Dialer
;
967 AsyncCall::Pointer call
= JobCallback(33, 5, Dialer
, this, Ftp::Server::wroteReplyData
);
968 Comm::Write(dataConn
, &mb
, call
);
970 pipeline
.front()->noteSentBodyBytes(data
.length
);
973 /// called when we are done writing a chunk of the response data
975 Ftp::Server::wroteReplyData(const CommIoCbParams
&io
)
977 if (io
.flag
== Comm::ERR_CLOSING
)
980 if (io
.flag
!= Comm::OK
) {
981 debugs(33, 3, "FTP reply data writing failed: " << xstrerr(io
.xerrno
));
982 closeDataConnection();
983 writeCustomReply(426, "Data connection error; transfer aborted");
987 assert(pipeline
.front()->http
);
988 pipeline
.front()->http
->out
.size
+= io
.size
;
989 replyDataWritingCheckpoint();
992 /// ClientStream checks after (actual or skipped) reply data writing
994 Ftp::Server::replyDataWritingCheckpoint()
996 switch (pipeline
.front()->socketState()) {
998 debugs(33, 3, "Keep going");
999 pipeline
.front()->pullData();
1001 case STREAM_COMPLETE
:
1002 debugs(33, 3, "FTP reply data transfer successfully complete");
1003 writeCustomReply(226, "Transfer complete");
1005 case STREAM_UNPLANNED_COMPLETE
:
1006 debugs(33, 3, "FTP reply data transfer failed: STREAM_UNPLANNED_COMPLETE");
1007 writeCustomReply(451, "Server error; transfer aborted");
1010 debugs(33, 3, "FTP reply data transfer failed: STREAM_FAILED");
1011 writeCustomReply(451, "Server error; transfer aborted");
1014 fatal("unreachable code");
1017 closeDataConnection();
1021 Ftp::Server::handleUploadReply(const HttpReply
*reply
, StoreIOBuffer
)
1023 writeForwardedReply(reply
);
1024 // note that the client data connection may already be closed by now
1028 Ftp::Server::writeForwardedReply(const HttpReply
*reply
)
1032 const HttpHeader
&header
= reply
->header
;
1033 // adaptation and forwarding errors lack Http::HdrType::FTP_STATUS
1034 if (!header
.has(Http::HdrType::FTP_STATUS
)) {
1035 writeForwardedForeign(reply
); // will get to Ftp::Server::wroteReply
1039 typedef CommCbMemFunT
<Server
, CommIoCbParams
> Dialer
;
1040 AsyncCall::Pointer call
= JobCallback(33, 5, Dialer
, this, Ftp::Server::wroteReply
);
1041 writeForwardedReplyAndCall(reply
, call
);
1045 Ftp::Server::handleEprtReply(const HttpReply
*reply
, StoreIOBuffer
)
1047 if (pipeline
.front()->http
->request
->errType
!= ERR_NONE
) {
1048 writeCustomReply(502, "Server does not support PASV (converted from EPRT)", reply
);
1052 writeCustomReply(200, "EPRT successfully converted to PASV.");
1054 // and wait for RETR
1058 Ftp::Server::handleEpsvReply(const HttpReply
*reply
, StoreIOBuffer
)
1060 if (pipeline
.front()->http
->request
->errType
!= ERR_NONE
) {
1061 writeCustomReply(502, "Cannot connect to server", reply
);
1065 const unsigned short localPort
= listenForDataConnection();
1069 // In interception setups, we use a local port number and hope that data
1070 // traffic will be redirected to us.
1073 mb
.appendf("229 Entering Extended Passive Mode (|||%u|)\r\n", localPort
);
1075 debugs(9, 3, Raw("writing", mb
.buf
, mb
.size
));
1079 /// writes FTP error response with given status and reply-derived error details
1081 Ftp::Server::writeErrorReply(const HttpReply
*reply
, const int scode
)
1083 const HttpRequest
*request
= pipeline
.front()->http
->request
;
1089 if (request
->errType
!= ERR_NONE
)
1090 mb
.appendf("%i-%s\r\n", scode
, errorPageName(request
->errType
));
1092 if (request
->errDetail
> 0) {
1093 // XXX: > 0 may not always mean that this is an errno
1094 mb
.appendf("%i-Error: (%d) %s\r\n", scode
,
1096 strerror(request
->errDetail
));
1100 // XXX: Remove hard coded names. Use an error page template instead.
1101 const Adaptation::History::Pointer ah
= request
->adaptHistory();
1102 if (ah
!= NULL
) { // XXX: add adapt::<all_h but use lastMeta here
1103 const String info
= ah
->allMeta
.getByName("X-Response-Info");
1104 const String desc
= ah
->allMeta
.getByName("X-Response-Desc");
1106 mb
.appendf("%i-Information: %s\r\n", scode
, info
.termedBuf());
1108 mb
.appendf("%i-Description: %s\r\n", scode
, desc
.termedBuf());
1113 const char *reason
= reply
->header
.has(Http::HdrType::FTP_REASON
) ?
1114 reply
->header
.getStr(Http::HdrType::FTP_REASON
):
1115 reply
->sline
.reason();
1117 mb
.appendf("%i %s\r\n", scode
, reason
); // error terminating line
1119 // TODO: errorpage.cc should detect FTP client and use
1120 // configurable FTP-friendly error templates which we should
1121 // write to the client "as is" instead of hiding most of the info
1126 /// writes FTP response based on HTTP reply that is not an FTP-response wrapper
1127 /// for example, internally-generated Squid "errorpages" end up here (for now)
1129 Ftp::Server::writeForwardedForeign(const HttpReply
*reply
)
1131 changeState(fssConnected
, "foreign reply");
1132 closeDataConnection();
1133 // 451: We intend to keep the control connection open.
1134 writeErrorReply(reply
, 451);
1138 Ftp::Server::writeControlMsgAndCall(ClientSocketContext
*, HttpReply
*reply
, AsyncCall::Pointer
&call
)
1140 // the caller guarantees that we are dealing with the current context only
1141 // the caller should also make sure reply->header.has(Http::HdrType::FTP_STATUS)
1142 writeForwardedReplyAndCall(reply
, call
);
1146 Ftp::Server::writeForwardedReplyAndCall(const HttpReply
*reply
, AsyncCall::Pointer
&call
)
1148 assert(reply
!= NULL
);
1149 const HttpHeader
&header
= reply
->header
;
1151 // without status, the caller must use the writeForwardedForeign() path
1152 Must(header
.has(Http::HdrType::FTP_STATUS
));
1153 Must(header
.has(Http::HdrType::FTP_REASON
));
1154 const int scode
= header
.getInt(Http::HdrType::FTP_STATUS
);
1155 debugs(33, 7, "scode: " << scode
);
1157 // Status 125 or 150 implies upload or data request, but we still check
1158 // the state in case the server is buggy.
1159 if ((scode
== 125 || scode
== 150) &&
1160 (master
->serverState
== fssHandleUploadRequest
||
1161 master
->serverState
== fssHandleDataRequest
)) {
1162 if (checkDataConnPost()) {
1163 // If the data connection is ready, start reading data (here)
1164 // and forward the response to client (further below).
1165 debugs(33, 7, "data connection established, start data transfer");
1166 if (master
->serverState
== fssHandleUploadRequest
)
1167 maybeReadUploadData();
1169 // If we are waiting to accept the data connection, keep waiting.
1170 if (Comm::IsConnOpen(dataListenConn
)) {
1171 debugs(33, 7, "wait for the client to establish a data connection");
1172 onDataAcceptCall
= call
;
1173 // TODO: Add connect timeout for passive connections listener?
1174 // TODO: Remember server response so that we can forward it?
1176 // Either the connection was establised and closed after the
1177 // data was transferred OR we failed to establish an active
1178 // data connection and already sent the error to the client.
1179 // In either case, there is nothing more to do.
1180 debugs(33, 7, "done with data OR active connection failed");
1188 Ftp::PrintReply(mb
, reply
);
1190 debugs(9, 2, "FTP Client " << clientConnection
);
1191 debugs(9, 2, "FTP Client REPLY:\n---------\n" << mb
.buf
<<
1194 Comm::Write(clientConnection
, &mb
, call
);
1198 Ftp::PrintReply(MemBuf
&mb
, const HttpReply
*reply
, const char *const)
1200 const HttpHeader
&header
= reply
->header
;
1202 HttpHeaderPos pos
= HttpHeaderInitPos
;
1203 while (const HttpHeaderEntry
*e
= header
.getEntry(&pos
)) {
1204 if (e
->id
== Http::HdrType::FTP_PRE
) {
1206 if (httpHeaderParseQuotedString(e
->value
.rawBuf(), e
->value
.size(), &raw
))
1207 mb
.appendf("%s\r\n", raw
.termedBuf());
1211 if (header
.has(Http::HdrType::FTP_STATUS
)) {
1212 const char *reason
= header
.getStr(Http::HdrType::FTP_REASON
);
1213 mb
.appendf("%i %s\r\n", header
.getInt(Http::HdrType::FTP_STATUS
),
1214 (reason
? reason
: 0));
1219 Ftp::Server::wroteEarlyReply(const CommIoCbParams
&io
)
1221 if (io
.flag
== Comm::ERR_CLOSING
)
1224 if (io
.flag
!= Comm::OK
) {
1225 debugs(33, 3, "FTP reply writing failed: " << xstrerr(io
.xerrno
));
1230 ClientSocketContext::Pointer context
= pipeline
.front();
1231 if (context
!= nullptr && context
->http
) {
1232 context
->http
->out
.size
+= io
.size
;
1233 context
->http
->out
.headers_sz
+= io
.size
;
1236 flags
.readMore
= true;
1241 Ftp::Server::wroteReply(const CommIoCbParams
&io
)
1243 if (io
.flag
== Comm::ERR_CLOSING
)
1246 if (io
.flag
!= Comm::OK
) {
1247 debugs(33, 3, "FTP reply writing failed: " << xstrerr(io
.xerrno
));
1252 ClientSocketContext::Pointer context
= pipeline
.front();
1253 assert(context
->http
);
1254 context
->http
->out
.size
+= io
.size
;
1255 context
->http
->out
.headers_sz
+= io
.size
;
1257 if (master
->serverState
== fssError
) {
1258 debugs(33, 5, "closing on FTP server error");
1263 const clientStream_status_t socketState
= context
->socketState();
1264 debugs(33, 5, "FTP client stream state " << socketState
);
1265 switch (socketState
) {
1266 case STREAM_UNPLANNED_COMPLETE
:
1272 case STREAM_COMPLETE
:
1273 flags
.readMore
= true;
1274 changeState(fssConnected
, "Ftp::Server::wroteReply");
1276 finishDechunkingRequest(false);
1277 context
->finished();
1284 Ftp::Server::handleRequest(HttpRequest
*request
)
1286 debugs(33, 9, request
);
1289 HttpHeader
&header
= request
->header
;
1290 Must(header
.has(Http::HdrType::FTP_COMMAND
));
1291 String
&cmd
= header
.findEntry(Http::HdrType::FTP_COMMAND
)->value
;
1292 Must(header
.has(Http::HdrType::FTP_ARGUMENTS
));
1293 String
¶ms
= header
.findEntry(Http::HdrType::FTP_ARGUMENTS
)->value
;
1295 if (do_debug(9, 2)) {
1300 debugs(9, 2, "FTP Client " << clientConnection
);
1301 debugs(9, 2, "FTP Client REQUEST:\n---------\n" << mb
.buf
<<
1305 // TODO: When HttpHeader uses SBuf, change keys to SBuf
1306 typedef std::map
<const std::string
, RequestHandler
> RequestHandlers
;
1307 static RequestHandlers handlers
;
1308 if (!handlers
.size()) {
1309 handlers
["LIST"] = &Ftp::Server::handleDataRequest
;
1310 handlers
["NLST"] = &Ftp::Server::handleDataRequest
;
1311 handlers
["MLSD"] = &Ftp::Server::handleDataRequest
;
1312 handlers
["FEAT"] = &Ftp::Server::handleFeatRequest
;
1313 handlers
["PASV"] = &Ftp::Server::handlePasvRequest
;
1314 handlers
["PORT"] = &Ftp::Server::handlePortRequest
;
1315 handlers
["RETR"] = &Ftp::Server::handleDataRequest
;
1316 handlers
["EPRT"] = &Ftp::Server::handleEprtRequest
;
1317 handlers
["EPSV"] = &Ftp::Server::handleEpsvRequest
;
1318 handlers
["CWD"] = &Ftp::Server::handleCwdRequest
;
1319 handlers
["PASS"] = &Ftp::Server::handlePassRequest
;
1320 handlers
["CDUP"] = &Ftp::Server::handleCdupRequest
;
1323 RequestHandler handler
= NULL
;
1324 if (request
->method
== Http::METHOD_PUT
)
1325 handler
= &Ftp::Server::handleUploadRequest
;
1327 const RequestHandlers::const_iterator hi
= handlers
.find(cmd
.termedBuf());
1328 if (hi
!= handlers
.end())
1329 handler
= hi
->second
;
1333 debugs(9, 7, "forwarding " << cmd
<< " as is, no post-processing");
1337 return (this->*handler
)(cmd
, params
);
1340 /// Called to parse USER command, which is required to create an HTTP request
1341 /// wrapper. W/o request, the errors are handled by returning earlyError().
1342 ClientSocketContext
*
1343 Ftp::Server::handleUserRequest(const SBuf
&, SBuf
¶ms
)
1345 if (params
.isEmpty())
1346 return earlyError(EarlyErrorKind::MissingUsername
);
1348 // find the [end of] user name
1349 const SBuf::size_type eou
= params
.rfind('@');
1350 if (eou
== SBuf::npos
|| eou
+ 1 >= params
.length())
1351 return earlyError(EarlyErrorKind::MissingHost
);
1353 // Determine the intended destination.
1354 host
= params
.substr(eou
+ 1, params
.length());
1355 // If we can parse it as raw IPv6 address, then surround with "[]".
1356 // Otherwise (domain, IPv4, [bracketed] IPv6, garbage, etc), use as is.
1357 if (host
.find(':') != SBuf::npos
) {
1358 const Ip::Address
ipa(host
.c_str());
1359 if (!ipa
.isAnyAddr()) {
1360 char ipBuf
[MAX_IPSTRLEN
];
1361 ipa
.toHostStr(ipBuf
, MAX_IPSTRLEN
);
1366 // const SBuf login = params.substr(0, eou);
1367 params
.chop(0, eou
); // leave just the login part for the peer
1370 if (master
->clientReadGreeting
)
1373 master
->workingDir
.clear();
1376 if (!master
->clientReadGreeting
) {
1377 debugs(9, 3, "set URI to " << uri
);
1378 } else if (oldUri
.caseCmp(uri
) == 0) {
1379 debugs(9, 5, "kept URI as " << oldUri
);
1381 debugs(9, 3, "reset URI from " << oldUri
<< " to " << uri
);
1382 closeDataConnection();
1383 unpinConnection(true); // close control connection to peer
1384 resetLogin("URI reset");
1387 return NULL
; // no early errors
1391 Ftp::Server::handleFeatRequest(String
&, String
&)
1393 changeState(fssHandleFeat
, "handleFeatRequest");
1398 Ftp::Server::handlePasvRequest(String
&, String
¶ms
)
1401 setReply(500, "Bad PASV command");
1405 if (params
.size() > 0) {
1406 setReply(501, "Unexpected parameter");
1410 changeState(fssHandlePasv
, "handlePasvRequest");
1411 // no need to fake PASV request via setDataCommand() in true PASV case
1415 /// [Re]initializes dataConn for active data transfers. Does not connect.
1417 Ftp::Server::createDataConnection(Ip::Address cltAddr
)
1419 assert(clientConnection
!= NULL
);
1420 assert(!clientConnection
->remote
.isAnyAddr());
1422 if (cltAddr
!= clientConnection
->remote
) {
1423 debugs(33, 2, "rogue PORT " << cltAddr
<< " request? ctrl: " << clientConnection
->remote
);
1424 // Closing the control connection would not help with attacks because
1425 // the client is evidently able to connect to us. Besides, closing
1426 // makes retrials easier for the client and more damaging to us.
1427 setReply(501, "Prohibited parameter value");
1431 closeDataConnection();
1433 Comm::ConnectionPointer conn
= new Comm::Connection();
1434 conn
->flags
|= COMM_DOBIND
;
1436 // Use local IP address of the control connection as the source address
1437 // of the active data connection, or some clients will refuse to accept.
1438 conn
->setAddrs(clientConnection
->local
, cltAddr
);
1439 // RFC 959 requires active FTP connections to originate from port 20
1440 // but that would preclude us from supporting concurrent transfers! (XXX?)
1441 conn
->local
.port(0);
1443 debugs(9, 3, "will actively connect from " << conn
->local
<< " to " <<
1447 uploadAvailSize
= 0;
1452 Ftp::Server::handlePortRequest(String
&, String
¶ms
)
1454 // TODO: Should PORT errors trigger closeDataConnection() cleanup?
1457 setReply(500, "Rejecting PORT after EPSV ALL");
1461 if (!params
.size()) {
1462 setReply(501, "Missing parameter");
1466 Ip::Address cltAddr
;
1467 if (!Ftp::ParseIpPort(params
.termedBuf(), NULL
, cltAddr
)) {
1468 setReply(501, "Invalid parameter");
1472 if (!createDataConnection(cltAddr
))
1475 changeState(fssHandlePort
, "handlePortRequest");
1477 return true; // forward our fake PASV request
1481 Ftp::Server::handleDataRequest(String
&, String
&)
1483 if (!checkDataConnPre())
1486 changeState(fssHandleDataRequest
, "handleDataRequest");
1492 Ftp::Server::handleUploadRequest(String
&, String
&)
1494 if (!checkDataConnPre())
1497 if (Config
.accessList
.forceRequestBodyContinuation
) {
1498 ClientHttpRequest
*http
= pipeline
.front()->http
;
1499 HttpRequest
*request
= http
->request
;
1500 ACLFilledChecklist
bodyContinuationCheck(Config
.accessList
.forceRequestBodyContinuation
, request
, NULL
);
1501 if (bodyContinuationCheck
.fastCheck() == ACCESS_ALLOWED
) {
1502 request
->forcedBodyContinuation
= true;
1503 if (checkDataConnPost()) {
1504 // Write control Msg
1505 writeEarlyReply(150, "Data connection opened");
1506 maybeReadUploadData();
1508 // wait for acceptDataConnection but tell it to call wroteEarlyReply
1509 // after writing "150 Data connection opened"
1510 typedef CommCbMemFunT
<Server
, CommIoCbParams
> Dialer
;
1511 AsyncCall::Pointer call
= JobCallback(33, 5, Dialer
, this, Ftp::Server::wroteEarlyReply
);
1512 onDataAcceptCall
= call
;
1517 changeState(fssHandleUploadRequest
, "handleDataRequest");
1523 Ftp::Server::handleEprtRequest(String
&, String
¶ms
)
1525 debugs(9, 3, "Process an EPRT " << params
);
1528 setReply(500, "Rejecting EPRT after EPSV ALL");
1532 if (!params
.size()) {
1533 setReply(501, "Missing parameter");
1537 Ip::Address cltAddr
;
1538 if (!Ftp::ParseProtoIpPort(params
.termedBuf(), cltAddr
)) {
1539 setReply(501, "Invalid parameter");
1543 if (!createDataConnection(cltAddr
))
1546 changeState(fssHandleEprt
, "handleEprtRequest");
1548 return true; // forward our fake PASV request
1552 Ftp::Server::handleEpsvRequest(String
&, String
¶ms
)
1554 debugs(9, 3, "Process an EPSV command with params: " << params
);
1555 if (params
.size() <= 0) {
1556 // treat parameterless EPSV as "use the protocol of the ctrl conn"
1557 } else if (params
.caseCmp("ALL") == 0) {
1558 setReply(200, "EPSV ALL ok");
1561 } else if (params
.cmp("2") == 0) {
1562 if (!Ip::EnableIpv6
) {
1563 setReply(522, "Network protocol not supported, use (1)");
1566 } else if (params
.cmp("1") != 0) {
1567 setReply(501, "Unsupported EPSV parameter");
1571 changeState(fssHandleEpsv
, "handleEpsvRequest");
1573 return true; // forward our fake PASV request
1577 Ftp::Server::handleCwdRequest(String
&, String
&)
1579 changeState(fssHandleCwd
, "handleCwdRequest");
1584 Ftp::Server::handlePassRequest(String
&, String
&)
1586 changeState(fssHandlePass
, "handlePassRequest");
1591 Ftp::Server::handleCdupRequest(String
&, String
&)
1593 changeState(fssHandleCdup
, "handleCdupRequest");
1597 // Convert user PORT, EPRT, PASV, or EPSV data command to Squid PASV command.
1598 // Squid FTP client decides what data command to use with peers.
1600 Ftp::Server::setDataCommand()
1602 ClientHttpRequest
*const http
= pipeline
.front()->http
;
1603 assert(http
!= NULL
);
1604 HttpRequest
*const request
= http
->request
;
1605 assert(request
!= NULL
);
1606 HttpHeader
&header
= request
->header
;
1607 header
.delById(Http::HdrType::FTP_COMMAND
);
1608 header
.putStr(Http::HdrType::FTP_COMMAND
, "PASV");
1609 header
.delById(Http::HdrType::FTP_ARGUMENTS
);
1610 header
.putStr(Http::HdrType::FTP_ARGUMENTS
, "");
1611 debugs(9, 5, "client data command converted to fake PASV");
1614 /// check that client data connection is ready for future I/O or at least
1615 /// has a chance of becoming ready soon.
1617 Ftp::Server::checkDataConnPre()
1619 if (Comm::IsConnOpen(dataConn
))
1622 if (Comm::IsConnOpen(dataListenConn
)) {
1623 // We are still waiting for a client to connect to us after PASV.
1624 // Perhaps client's data conn handshake has not reached us yet.
1625 // After we talk to the server, checkDataConnPost() will recheck.
1626 debugs(33, 3, "expecting clt data conn " << dataListenConn
);
1630 if (!dataConn
|| dataConn
->remote
.isAnyAddr()) {
1631 debugs(33, 5, "missing " << dataConn
);
1632 // TODO: use client address and default port instead.
1633 setReply(425, "Use PORT or PASV first");
1637 // active transfer: open a data connection from Squid to client
1638 typedef CommCbMemFunT
<Server
, CommConnectCbParams
> Dialer
;
1639 connector
= JobCallback(17, 3, Dialer
, this, Ftp::Server::connectedForData
);
1640 Comm::ConnOpener
*cs
= new Comm::ConnOpener(dataConn
, connector
,
1641 Config
.Timeout
.connect
);
1642 AsyncJob::Start(cs
);
1643 return false; // ConnStateData::processFtpRequest waits handleConnectDone
1646 /// Check that client data connection is ready for immediate I/O.
1648 Ftp::Server::checkDataConnPost() const
1650 if (!Comm::IsConnOpen(dataConn
)) {
1651 debugs(33, 3, "missing client data conn: " << dataConn
);
1657 /// Done establishing a data connection to the user.
1659 Ftp::Server::connectedForData(const CommConnectCbParams
¶ms
)
1663 if (params
.flag
!= Comm::OK
) {
1664 /* it might have been a timeout with a partially open link */
1665 if (params
.conn
!= NULL
)
1666 params
.conn
->close();
1667 setReply(425, "Cannot open data connection.");
1668 ClientSocketContext::Pointer context
= pipeline
.front();
1669 Must(context
->http
);
1670 Must(context
->http
->storeEntry() != NULL
);
1672 Must(dataConn
== params
.conn
);
1673 Must(Comm::IsConnOpen(params
.conn
));
1674 fd_note(params
.conn
->fd
, "active client ftp data");
1681 Ftp::Server::setReply(const int code
, const char *msg
)
1683 ClientSocketContext::Pointer context
= pipeline
.front();
1684 ClientHttpRequest
*const http
= context
->http
;
1685 assert(http
!= NULL
);
1686 assert(http
->storeEntry() == NULL
);
1688 HttpReply
*const reply
= Ftp::HttpReplyWrapper(code
, msg
, Http::scNoContent
, 0);
1690 setLogUri(http
, urlCanonicalClean(http
->request
));
1692 clientStreamNode
*const node
= context
->getClientReplyContext();
1693 clientReplyContext
*const repContext
=
1694 dynamic_cast<clientReplyContext
*>(node
->data
.getRaw());
1695 assert(repContext
!= NULL
);
1697 RequestFlags reqFlags
;
1698 reqFlags
.cachable
= false; // force releaseRequest() in storeCreateEntry()
1699 reqFlags
.noCache
= true;
1700 repContext
->createStoreEntry(http
->request
->method
, reqFlags
);
1701 http
->storeEntry()->replaceHttpReply(reply
);
1705 Ftp::Server::callException(const std::exception
&e
)
1707 debugs(33, 2, "FTP::Server job caught: " << e
.what());
1708 closeDataConnection();
1709 unpinConnection(true);
1710 if (Comm::IsConnOpen(clientConnection
))
1711 clientConnection
->close();
1712 AsyncJob::callException(e
);
1715 /// Whether Squid FTP Relay supports a named feature (e.g., a command).
1717 Ftp::SupportedCommand(const SBuf
&name
)
1719 static std::set
<SBuf
> BlackList
;
1720 if (BlackList
.empty()) {
1721 /* Add FTP commands that Squid cannot relay correctly. */
1723 // We probably do not support AUTH TLS.* and AUTH SSL,
1724 // but let's disclaim all AUTH support to KISS, for now.
1725 BlackList
.insert(cmdAuth());
1728 // we claim support for all commands that we do not know about
1729 return BlackList
.find(name
) == BlackList
.end();