]>
git.ipfire.org Git - thirdparty/squid.git/blob - src/clients/FtpClient.cc
2 * Copyright (C) 1996-2016 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 09 File Transfer Protocol (FTP) */
12 #include "acl/FilledChecklist.h"
13 #include "client_side.h"
14 #include "clients/FtpClient.h"
15 #include "comm/ConnOpener.h"
16 #include "comm/Read.h"
17 #include "comm/TcpAcceptor.h"
18 #include "comm/Write.h"
19 #include "errorpage.h"
21 #include "ftp/Parsing.h"
22 #include "http/Stream.h"
24 #include "SquidConfig.h"
25 #include "SquidString.h"
26 #include "StatCounters.h"
35 const char *const crlf
= "\r\n";
38 escapeIAC(const char *buf
)
42 unsigned const char *p
;
45 for (p
= (unsigned const char *)buf
, n
= 1; *p
; ++n
, ++p
)
49 ret
= (char *)xmalloc(n
);
51 for (p
= (unsigned const char *)buf
, r
=(unsigned char *)ret
; *p
; ++p
) {
63 assert((r
- (unsigned char *)ret
) == n
);
69 /// configures the channel with a descriptor and registers a close handler
71 Ftp::Channel::opened(const Comm::ConnectionPointer
&newConn
,
72 const AsyncCall::Pointer
&aCloser
)
74 assert(!Comm::IsConnOpen(conn
));
75 assert(closer
== NULL
);
77 assert(Comm::IsConnOpen(newConn
));
78 assert(aCloser
!= NULL
);
82 comm_add_close_handler(conn
->fd
, closer
);
85 /// planned close: removes the close handler and calls comm_close
89 // channels with active listeners will be closed when the listener handler dies.
90 if (Comm::IsConnOpen(conn
)) {
91 comm_remove_close_handler(conn
->fd
, closer
);
92 conn
->close(); // we do not expect to be called back
98 Ftp::Channel::forget()
100 if (Comm::IsConnOpen(conn
)) {
101 commUnsetConnTimeout(conn
);
102 comm_remove_close_handler(conn
->fd
, closer
);
108 Ftp::Channel::clear()
114 /* Ftp::CtrlChannel */
116 Ftp::CtrlChannel::CtrlChannel():
125 buf
= static_cast<char*>(memAllocBuf(4096, &size
));
128 Ftp::CtrlChannel::~CtrlChannel()
130 memFreeBuf(size
, buf
);
132 wordlistDestroy(&message
);
133 safe_free(last_command
);
134 safe_free(last_reply
);
137 /* Ftp::DataChannel */
139 Ftp::DataChannel::DataChannel():
147 Ftp::DataChannel::~DataChannel()
153 Ftp::DataChannel::addr(const Ip::Address
&import
)
155 static char addrBuf
[MAX_IPSTRLEN
];
156 import
.toStr(addrBuf
, sizeof(addrBuf
));
158 host
= xstrdup(addrBuf
);
159 port
= import
.port();
164 Ftp::Client::Client(FwdState
*fwdState
):
165 AsyncJob("Ftp::Client"),
172 shortenReadTimeout(false)
174 ++statCounter
.server
.all
.requests
;
175 ++statCounter
.server
.ftp
.requests
;
177 ctrl
.last_command
= xstrdup("Connect to server");
179 typedef CommCbMemFunT
<Client
, CommCloseCbParams
> Dialer
;
180 const AsyncCall::Pointer closer
= JobCallback(9, 5, Dialer
, this,
181 Ftp::Client::ctrlClosed
);
182 ctrl
.opened(fwdState
->serverConnection(), closer
);
185 Ftp::Client::~Client()
187 if (data
.opener
!= NULL
) {
188 data
.opener
->cancel("Ftp::Client destructed");
193 safe_free(old_request
);
194 safe_free(old_reply
);
195 fwd
= NULL
; // refcounted
201 scheduleReadControlReply(0);
205 Ftp::Client::initReadBuf()
207 if (data
.readBuf
== NULL
) {
208 data
.readBuf
= new MemBuf
;
209 data
.readBuf
->init(4096, SQUID_TCP_SO_RCVBUF
);
214 * Close the FTP server connection(s). Used by serverComplete().
217 Ftp::Client::closeServer()
219 if (Comm::IsConnOpen(ctrl
.conn
)) {
220 debugs(9, 3, "closing FTP server FD " << ctrl
.conn
->fd
<< ", this " << this);
221 fwd
->unregister(ctrl
.conn
);
225 if (Comm::IsConnOpen(data
.conn
)) {
226 debugs(9, 3, "closing FTP data FD " << data
.conn
->fd
<< ", this " << this);
230 debugs(9, 3, "FTP ctrl and data connections closed. this " << this);
234 * Did we close all FTP server connection(s)?
236 \retval true Both server control and data channels are closed. And not waiting for a new data connection to open.
237 \retval false Either control channel or data is still active.
240 Ftp::Client::doneWithServer() const
242 return !Comm::IsConnOpen(ctrl
.conn
) && !Comm::IsConnOpen(data
.conn
);
246 Ftp::Client::failed(err_type error
, int xerrno
, ErrorState
*err
)
248 debugs(9, 3, "entry-null=" << (entry
?entry
->isEmpty():0) << ", entry=" << entry
);
250 const char *command
, *reply
;
254 debugs(9, 6, "error=" << err
->type
<< ", code=" << xerrno
<<
255 ", status=" << err
->httpStatus
);
259 Http::StatusCode httpStatus
= failedHttpStatus(error
);
260 ftperr
= new ErrorState(error
, httpStatus
, fwd
->request
);
263 ftperr
->xerrno
= xerrno
;
265 ftperr
->ftp
.server_msg
= ctrl
.message
;
269 command
= old_request
;
271 command
= ctrl
.last_command
;
273 if (command
&& strncmp(command
, "PASS", 4) == 0)
274 command
= "PASS <yourpassword>";
279 reply
= ctrl
.last_reply
;
282 ftperr
->ftp
.request
= xstrdup(command
);
285 ftperr
->ftp
.reply
= xstrdup(reply
);
288 fwd
->request
->detailError(error
, xerrno
);
290 closeServer(); // we failed, so no serverComplete()
295 Ftp::Client::failedHttpStatus(err_type
&error
)
297 if (error
== ERR_NONE
)
298 error
= ERR_FTP_FAILURE
;
299 return error
== ERR_READ_TIMEOUT
? Http::scGatewayTimeout
:
305 * Looks like there are no longer anymore callers that set
306 * buffered_ok=1. Perhaps it can be removed at some point.
309 Ftp::Client::scheduleReadControlReply(int buffered_ok
)
311 debugs(9, 3, ctrl
.conn
);
313 if (buffered_ok
&& ctrl
.offset
> 0) {
314 /* We've already read some reply data */
315 handleControlReply();
318 if (!Comm::IsConnOpen(ctrl
.conn
)) {
319 debugs(9, 3, "cannot read without ctrl " << ctrl
.conn
);
323 * Cancel the timeout on the Data socket (if any) and
324 * establish one on the control socket.
326 if (Comm::IsConnOpen(data
.conn
)) {
327 commUnsetConnTimeout(data
.conn
);
330 const time_t tout
= shortenReadTimeout
?
331 min(Config
.Timeout
.connect
, Config
.Timeout
.read
):
333 shortenReadTimeout
= false; // we only need to do this once, after PASV
335 typedef CommCbMemFunT
<Client
, CommTimeoutCbParams
> TimeoutDialer
;
336 AsyncCall::Pointer timeoutCall
= JobCallback(9, 5, TimeoutDialer
, this, Ftp::Client::timeout
);
337 commSetConnTimeout(ctrl
.conn
, tout
, timeoutCall
);
339 typedef CommCbMemFunT
<Client
, CommIoCbParams
> Dialer
;
340 AsyncCall::Pointer reader
= JobCallback(9, 5, Dialer
, this, Ftp::Client::readControlReply
);
341 comm_read(ctrl
.conn
, ctrl
.buf
+ ctrl
.offset
, ctrl
.size
- ctrl
.offset
, reader
);
346 Ftp::Client::readControlReply(const CommIoCbParams
&io
)
348 debugs(9, 3, "FD " << io
.fd
<< ", Read " << io
.size
<< " bytes");
351 statCounter
.server
.all
.kbytes_in
+= io
.size
;
352 statCounter
.server
.ftp
.kbytes_in
+= io
.size
;
355 if (io
.flag
== Comm::ERR_CLOSING
)
358 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
359 if (abortOnData("entry aborted during control reply read"))
363 assert(ctrl
.offset
< ctrl
.size
);
365 if (io
.flag
== Comm::OK
&& io
.size
> 0) {
366 fd_bytes(io
.fd
, io
.size
, FD_READ
);
369 if (io
.flag
!= Comm::OK
) {
370 debugs(50, ignoreErrno(io
.xerrno
) ? 3 : DBG_IMPORTANT
,
371 "FTP control reply read error: " << xstrerr(io
.xerrno
));
373 if (ignoreErrno(io
.xerrno
)) {
374 scheduleReadControlReply(0);
376 failed(ERR_READ_ERROR
, io
.xerrno
);
377 /* failed closes ctrl.conn and frees ftpState */
383 if (entry
->store_status
== STORE_PENDING
) {
384 failed(ERR_FTP_FAILURE
, 0);
385 /* failed closes ctrl.conn and frees ftpState */
389 /* XXX this may end up having to be serverComplete() .. */
390 abortAll("zero control reply read");
394 unsigned int len
=io
.size
+ ctrl
.offset
;
396 assert(len
<= ctrl
.size
);
397 if (Comm::IsConnOpen(ctrl
.conn
))
398 commUnsetConnTimeout(ctrl
.conn
); // we are done waiting for ctrl reply
399 handleControlReply();
403 Ftp::Client::handleControlReply()
405 debugs(9, 3, status());
407 size_t bytes_used
= 0;
408 wordlistDestroy(&ctrl
.message
);
410 if (!parseControlReply(bytes_used
)) {
411 /* didn't get complete reply yet */
413 if (ctrl
.offset
== ctrl
.size
) {
414 ctrl
.buf
= static_cast<char*>(memReallocBuf(ctrl
.buf
, ctrl
.size
<< 1, &ctrl
.size
));
417 scheduleReadControlReply(0);
421 assert(ctrl
.message
); // the entire FTP server response, line by line
422 assert(ctrl
.replycode
>= 0); // FTP status code (from the last line)
423 assert(ctrl
.last_reply
); // FTP reason (from the last line)
425 if (ctrl
.offset
== bytes_used
) {
429 /* Got some data past the complete reply */
430 assert(bytes_used
< ctrl
.offset
);
431 ctrl
.offset
-= bytes_used
;
432 memmove(ctrl
.buf
, ctrl
.buf
+ bytes_used
, ctrl
.offset
);
435 debugs(9, 3, "state=" << state
<< ", code=" << ctrl
.replycode
);
439 Ftp::Client::handlePasvReply(Ip::Address
&srvAddr
)
441 int code
= ctrl
.replycode
;
443 debugs(9, 3, status());
446 debugs(9, 2, "PASV not supported by remote end");
450 /* 227 Entering Passive Mode (h1,h2,h3,h4,p1,p2). */
451 /* ANSI sez [^0-9] is undefined, it breaks on Watcom cc */
452 debugs(9, 5, "scanning: " << ctrl
.last_reply
);
454 buf
= ctrl
.last_reply
+ strcspn(ctrl
.last_reply
, "0123456789");
456 const char *forceIp
= Config
.Ftp
.sanitycheck
?
457 fd_table
[ctrl
.conn
->fd
].ipaddr
: NULL
;
458 if (!Ftp::ParseIpPort(buf
, forceIp
, srvAddr
)) {
459 debugs(9, DBG_IMPORTANT
, "Unsafe PASV reply from " <<
460 ctrl
.conn
->remote
<< ": " << ctrl
.last_reply
);
470 Ftp::Client::handleEpsvReply(Ip::Address
&remoteAddr
)
472 int code
= ctrl
.replycode
;
474 debugs(9, 3, status());
476 if (code
!= 229 && code
!= 522) {
478 /* handle broken servers (RFC 2428 says OK code for EPSV MUST be 229 not 200) */
479 /* vsftpd for one send '200 EPSV ALL ok.' without even port info.
480 * Its okay to re-send EPSV 1/2 but nothing else. */
481 debugs(9, DBG_IMPORTANT
, "Broken FTP Server at " << ctrl
.conn
->remote
<< ". Wrong accept code for EPSV");
483 debugs(9, 2, "EPSV not supported by remote end");
485 return sendPassive();
489 /* Peer responded with a list of supported methods:
490 * 522 Network protocol not supported, use (1)
491 * 522 Network protocol not supported, use (1,2)
492 * 522 Network protocol not supported, use (2)
493 * TODO: Handle the (1,2) case which may happen after EPSV ALL. Close
494 * data + control without self-destructing and re-open from scratch.
496 debugs(9, 5, "scanning: " << ctrl
.last_reply
);
497 buf
= ctrl
.last_reply
;
498 while (buf
!= NULL
&& *buf
!= '\0' && *buf
!= '\n' && *buf
!= '(')
500 if (buf
!= NULL
&& *buf
== '\n')
503 if (buf
== NULL
|| *buf
== '\0') {
504 /* handle broken server (RFC 2428 says MUST specify supported protocols in 522) */
505 debugs(9, DBG_IMPORTANT
, "Broken FTP Server at " << ctrl
.conn
->remote
<< ". 522 error missing protocol negotiation hints");
506 return sendPassive();
507 } else if (strcmp(buf
, "(1)") == 0) {
508 state
= SENT_EPSV_2
; /* simulate having sent and failed EPSV 2 */
509 return sendPassive();
510 } else if (strcmp(buf
, "(2)") == 0) {
511 if (Ip::EnableIpv6
) {
512 /* If server only supports EPSV 2 and we have already tried that. Go straight to EPRT */
513 if (state
== SENT_EPSV_2
) {
516 /* or try the next Passive mode down the chain. */
517 return sendPassive();
520 /* Server only accept EPSV in IPv6 traffic. */
521 state
= SENT_EPSV_1
; /* simulate having sent and failed EPSV 1 */
522 return sendPassive();
525 /* handle broken server (RFC 2428 says MUST specify supported protocols in 522) */
526 debugs(9, DBG_IMPORTANT
, "WARNING: Server at " << ctrl
.conn
->remote
<< " sent unknown protocol negotiation hint: " << buf
);
527 return sendPassive();
529 /* coverity[unreachable] */
530 /* safeguard against possible future bugs in above conditions */
531 failed(ERR_FTP_FAILURE
, 0);
535 /* 229 Entering Extended Passive Mode (|||port|) */
536 /* ANSI sez [^0-9] is undefined, it breaks on Watcom cc */
537 debugs(9, 5, "scanning: " << ctrl
.last_reply
);
539 buf
= ctrl
.last_reply
+ strcspn(ctrl
.last_reply
, "(");
543 int n
= sscanf(buf
, "(%c%c%c%hu%c)", &h1
, &h2
, &h3
, &port
, &h4
);
545 if (n
< 4 || h1
!= h2
|| h1
!= h3
|| h1
!= h4
) {
546 debugs(9, DBG_IMPORTANT
, "Invalid EPSV reply from " <<
547 ctrl
.conn
->remote
<< ": " <<
550 return sendPassive();
554 debugs(9, DBG_IMPORTANT
, "Unsafe EPSV reply from " <<
555 ctrl
.conn
->remote
<< ": " <<
558 return sendPassive();
561 if (Config
.Ftp
.sanitycheck
) {
563 debugs(9, DBG_IMPORTANT
, "Unsafe EPSV reply from " <<
564 ctrl
.conn
->remote
<< ": " <<
567 return sendPassive();
571 remoteAddr
= ctrl
.conn
->remote
;
572 remoteAddr
.port(port
);
573 data
.addr(remoteAddr
);
577 // FTP clients do not support EPRT and PORT commands yet.
578 // The Ftp::Client::sendEprt() will fail because of the unimplemented
579 // openListenSocket() or sendPort() methods
581 Ftp::Client::sendEprt()
583 if (!Config
.Ftp
.eprt
) {
584 /* Disabled. Switch immediately to attempting old PORT command. */
585 debugs(9, 3, "EPRT disabled by local administrator");
589 debugs(9, 3, status());
591 if (!openListenSocket()) {
592 failed(ERR_FTP_FAILURE
, 0);
596 debugs(9, 3, "Listening for FTP data connection with FD " << data
.conn
);
597 if (!Comm::IsConnOpen(data
.conn
)) {
598 // TODO: Set error message.
599 failed(ERR_FTP_FAILURE
, 0);
605 char buf
[MAX_IPSTRLEN
];
606 /* RFC 2428 defines EPRT as IPv6 equivalent to IPv4 PORT command. */
607 /* Which can be used by EITHER protocol. */
608 debugs(9, 3, "Listening for FTP data connection on port" << comm_local_port(data
.conn
->fd
) << " or port?" << data
.conn
->local
.port());
609 mb
.appendf("EPRT |%d|%s|%d|%s",
610 ( data
.conn
->local
.isIPv6() ? 2 : 1 ),
611 data
.conn
->local
.toStr(buf
,MAX_IPSTRLEN
),
612 comm_local_port(data
.conn
->fd
), Ftp::crlf
);
615 writeCommand(mb
.content());
620 Ftp::Client::sendPort()
622 failed(ERR_FTP_FAILURE
, 0);
627 Ftp::Client::sendPassive()
629 debugs(9, 3, status());
632 * Checks for EPSV ALL special conditions:
633 * If enabled to be sent, squid MUST NOT request any other connect methods.
634 * If 'ALL' is sent and fails the entire FTP Session fails.
635 * NP: By my reading exact EPSV protocols maybe attempted, but only EPSV method. */
636 if (Config
.Ftp
.epsv_all
&& state
== SENT_EPSV_1
) {
637 // We are here because the last "EPSV 1" failed, but because of epsv_all
638 // no other method allowed.
639 debugs(9, DBG_IMPORTANT
, "FTP does not allow PASV method after 'EPSV ALL' has been sent.");
640 failed(ERR_FTP_FAILURE
, 0);
644 /// Closes any old FTP-Data connection which may exist. */
648 * Checks for previous EPSV/PASV failures on this server/session.
649 * Diverts to EPRT immediately if they are not working. */
650 if (!Config
.Ftp
.passive
|| state
== SENT_PASV
) {
658 * Send EPSV (ALL,2,1) or PASV on the control channel.
660 * - EPSV ALL is used if enabled.
661 * - EPSV 2 is used if ALL is disabled and IPv6 is available and ctrl channel is IPv6.
662 * - EPSV 1 is used if EPSV 2 (IPv6) fails or is not available or ctrl channel is IPv4.
663 * - PASV is used if EPSV 1 fails.
666 case SENT_EPSV_ALL
: /* EPSV ALL resulted in a bad response. Try ther EPSV methods. */
667 if (ctrl
.conn
->local
.isIPv6()) {
668 debugs(9, 5, "FTP Channel is IPv6 (" << ctrl
.conn
->remote
<< ") attempting EPSV 2 after EPSV ALL has failed.");
669 mb
.appendf("EPSV 2%s", Ftp::crlf
);
673 // else fall through to skip EPSV 2
675 case SENT_EPSV_2
: /* EPSV IPv6 failed. Try EPSV IPv4 */
676 if (ctrl
.conn
->local
.isIPv4()) {
677 debugs(9, 5, "FTP Channel is IPv4 (" << ctrl
.conn
->remote
<< ") attempting EPSV 1 after EPSV ALL has failed.");
678 mb
.appendf("EPSV 1%s", Ftp::crlf
);
681 } else if (Config
.Ftp
.epsv_all
) {
682 debugs(9, DBG_IMPORTANT
, "FTP does not allow PASV method after 'EPSV ALL' has been sent.");
683 failed(ERR_FTP_FAILURE
, 0);
686 // else fall through to skip EPSV 1
688 case SENT_EPSV_1
: /* EPSV options exhausted. Try PASV now. */
689 debugs(9, 5, "FTP Channel (" << ctrl
.conn
->remote
<< ") rejects EPSV connection attempts. Trying PASV instead.");
690 mb
.appendf("PASV%s", Ftp::crlf
);
696 if (Config
.accessList
.ftp_epsv
) {
697 ACLFilledChecklist
checklist(Config
.accessList
.ftp_epsv
, fwd
->request
, NULL
);
698 doEpsv
= (checklist
.fastCheck() == ACCESS_ALLOWED
);
701 debugs(9, 5, "EPSV support manually disabled. Sending PASV for FTP Channel (" << ctrl
.conn
->remote
<<")");
702 mb
.appendf("PASV%s", Ftp::crlf
);
704 } else if (Config
.Ftp
.epsv_all
) {
705 debugs(9, 5, "EPSV ALL manually enabled. Attempting with FTP Channel (" << ctrl
.conn
->remote
<<")");
706 mb
.appendf("EPSV ALL%s", Ftp::crlf
);
707 state
= SENT_EPSV_ALL
;
709 if (ctrl
.conn
->local
.isIPv6()) {
710 debugs(9, 5, "FTP Channel (" << ctrl
.conn
->remote
<< "). Sending default EPSV 2");
711 mb
.appendf("EPSV 2%s", Ftp::crlf
);
714 if (ctrl
.conn
->local
.isIPv4()) {
715 debugs(9, 5, "Channel (" << ctrl
.conn
->remote
<<"). Sending default EPSV 1");
716 mb
.appendf("EPSV 1%s", Ftp::crlf
);
725 wordlistDestroy(&ctrl
.message
);
726 ctrl
.message
= NULL
; //No message to return to client.
727 ctrl
.offset
= 0; //reset readed response, to make room read the next response
729 writeCommand(mb
.content());
731 shortenReadTimeout
= true;
736 Ftp::Client::connectDataChannel()
738 safe_free(ctrl
.last_command
);
740 safe_free(ctrl
.last_reply
);
742 ctrl
.last_command
= xstrdup("Connect to server data port");
744 // Generate a new data channel descriptor to be opened.
745 Comm::ConnectionPointer conn
= new Comm::Connection
;
746 conn
->setAddrs(ctrl
.conn
->local
, data
.host
);
748 conn
->remote
.port(data
.port
);
749 conn
->tos
= ctrl
.conn
->tos
;
750 conn
->nfmark
= ctrl
.conn
->nfmark
;
752 debugs(9, 3, "connecting to " << conn
->remote
);
754 typedef CommCbMemFunT
<Client
, CommConnectCbParams
> Dialer
;
755 data
.opener
= JobCallback(9, 3, Dialer
, this, Ftp::Client::dataChannelConnected
);
756 Comm::ConnOpener
*cs
= new Comm::ConnOpener(conn
, data
.opener
, Config
.Timeout
.connect
);
757 cs
->setHost(data
.host
);
762 Ftp::Client::openListenSocket()
767 /// creates a data channel Comm close callback
769 Ftp::Client::dataCloser()
771 typedef CommCbMemFunT
<Client
, CommCloseCbParams
> Dialer
;
772 return JobCallback(9, 5, Dialer
, this, Ftp::Client::dataClosed
);
775 /// handler called by Comm when FTP data channel is closed unexpectedly
777 Ftp::Client::dataClosed(const CommCloseCbParams
&)
779 debugs(9, 4, status());
780 if (data
.listenConn
!= NULL
) {
781 data
.listenConn
->close();
782 data
.listenConn
= NULL
;
783 // NP clear() does the: data.fd = -1;
789 Ftp::Client::writeCommand(const char *buf
)
792 /* trace FTP protocol communications at level 2 */
793 debugs(9, 2, "ftp<< " << buf
);
795 if (Config
.Ftp
.telnet
)
796 ebuf
= escapeIAC(buf
);
800 safe_free(ctrl
.last_command
);
802 safe_free(ctrl
.last_reply
);
804 ctrl
.last_command
= ebuf
;
806 if (!Comm::IsConnOpen(ctrl
.conn
)) {
807 debugs(9, 2, "cannot send to closing ctrl " << ctrl
.conn
);
808 // TODO: assert(ctrl.closer != NULL);
812 typedef CommCbMemFunT
<Client
, CommIoCbParams
> Dialer
;
813 AsyncCall::Pointer call
= JobCallback(9, 5, Dialer
, this,
814 Ftp::Client::writeCommandCallback
);
815 Comm::Write(ctrl
.conn
, ctrl
.last_command
, strlen(ctrl
.last_command
), call
, NULL
);
817 scheduleReadControlReply(0);
821 Ftp::Client::writeCommandCallback(const CommIoCbParams
&io
)
824 debugs(9, 5, "wrote " << io
.size
<< " bytes");
827 fd_bytes(io
.fd
, io
.size
, FD_WRITE
);
828 statCounter
.server
.all
.kbytes_out
+= io
.size
;
829 statCounter
.server
.ftp
.kbytes_out
+= io
.size
;
832 if (io
.flag
== Comm::ERR_CLOSING
)
836 debugs(9, DBG_IMPORTANT
, "FTP command write error: " << io
.conn
<< ": " << xstrerr(io
.xerrno
));
837 failed(ERR_WRITE_ERROR
, io
.xerrno
);
838 /* failed closes ctrl.conn and frees ftpState */
843 /// handler called by Comm when FTP control channel is closed unexpectedly
845 Ftp::Client::ctrlClosed(const CommCloseCbParams
&)
847 debugs(9, 4, status());
849 doneWithFwd
= "ctrlClosed()"; // assume FwdState is monitoring too
850 mustStop("Ftp::Client::ctrlClosed");
854 Ftp::Client::timeout(const CommTimeoutCbParams
&io
)
856 debugs(9, 4, io
.conn
<< ": '" << entry
->url() << "'" );
858 if (abortOnBadEntry("entry went bad while waiting for a timeout"))
861 failed(ERR_READ_TIMEOUT
, 0);
862 /* failed() closes ctrl.conn and frees ftpState */
865 const Comm::ConnectionPointer
&
866 Ftp::Client::dataConnection() const
872 Ftp::Client::maybeReadVirginBody()
875 if (!Comm::IsConnOpen(data
.conn
) || fd_table
[data
.conn
->fd
].closing())
878 if (data
.read_pending
)
883 const int read_sz
= replyBodySpace(*data
.readBuf
, 0);
885 debugs(9, 9, "FTP may read up to " << read_sz
<< " bytes");
887 if (read_sz
< 2) // see http.cc
890 data
.read_pending
= true;
892 typedef CommCbMemFunT
<Client
, CommTimeoutCbParams
> TimeoutDialer
;
893 AsyncCall::Pointer timeoutCall
= JobCallback(9, 5,
894 TimeoutDialer
, this, Ftp::Client::timeout
);
895 commSetConnTimeout(data
.conn
, Config
.Timeout
.read
, timeoutCall
);
897 debugs(9,5,"queueing read on FD " << data
.conn
->fd
);
899 typedef CommCbMemFunT
<Client
, CommIoCbParams
> Dialer
;
900 entry
->delayAwareRead(data
.conn
, data
.readBuf
->space(), read_sz
,
901 JobCallback(9, 5, Dialer
, this, Ftp::Client::dataRead
));
905 Ftp::Client::dataRead(const CommIoCbParams
&io
)
910 data
.read_pending
= false;
912 debugs(9, 3, "FD " << io
.fd
<< " Read " << io
.size
<< " bytes");
915 statCounter
.server
.all
.kbytes_in
+= io
.size
;
916 statCounter
.server
.ftp
.kbytes_in
+= io
.size
;
919 if (io
.flag
== Comm::ERR_CLOSING
)
922 assert(io
.fd
== data
.conn
->fd
);
924 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
)) {
925 abortOnData("entry aborted during dataRead");
929 if (io
.flag
== Comm::OK
&& io
.size
> 0) {
930 debugs(9, 5, "appended " << io
.size
<< " bytes to readBuf");
931 data
.readBuf
->appended(io
.size
);
933 DelayId delayId
= entry
->mem_obj
->mostBytesAllowed();
934 delayId
.bytesIn(io
.size
);
936 ++ IOStats
.Ftp
.reads
;
938 for (j
= io
.size
- 1, bin
= 0; j
; ++bin
)
941 ++ IOStats
.Ftp
.read_hist
[bin
];
944 if (io
.flag
!= Comm::OK
) {
945 debugs(50, ignoreErrno(io
.xerrno
) ? 3 : DBG_IMPORTANT
,
946 "FTP data read error: " << xstrerr(io
.xerrno
));
948 if (ignoreErrno(io
.xerrno
)) {
949 maybeReadVirginBody();
951 failed(ERR_READ_ERROR
, 0);
952 /* failed closes ctrl.conn and frees ftpState */
955 } else if (io
.size
== 0) {
956 debugs(9, 3, "Calling dataComplete() because io.size == 0");
959 * Dangerous curves ahead. This call to dataComplete was
960 * calling scheduleReadControlReply, handleControlReply,
961 * and then ftpReadTransferDone. If ftpReadTransferDone
962 * gets unexpected status code, it closes down the control
963 * socket and our FtpStateData object gets destroyed. As
964 * a workaround we no longer set the 'buffered_ok' flag in
965 * the scheduleReadControlReply call.
974 Ftp::Client::dataComplete()
976 debugs(9, 3,status());
978 /* Connection closed; transfer done. */
980 /// Close data channel, if any, to conserve resources while we wait.
983 /* expect the "transfer complete" message on the control socket */
986 * Previously, this was the only place where we set the
987 * 'buffered_ok' flag when calling scheduleReadControlReply().
988 * It caused some problems if the FTP server returns an unexpected
989 * status code after the data command. FtpStateData was being
990 * deleted in the middle of dataRead().
992 /* AYJ: 2011-01-13: Bug 2581.
993 * 226 status is possibly waiting in the ctrl buffer.
994 * The connection will hang if we DONT send buffered_ok.
995 * This happens on all transfers which can be completly sent by the
996 * server before the 150 started status message is read in by Squid.
997 * ie all transfers of about one packet hang.
999 scheduleReadControlReply(1);
1003 Ftp::Client::abortAll(const char *reason
)
1005 debugs(9, 3, "aborting transaction for " << reason
<<
1006 "; FD " << (ctrl
.conn
!=NULL
?ctrl
.conn
->fd
:-1) << ", Data FD " << (data
.conn
!=NULL
?data
.conn
->fd
:-1) << ", this " << this);
1011 * Cancel the timeout on the Control socket and establish one
1012 * on the data socket
1015 Ftp::Client::switchTimeoutToDataChannel()
1017 commUnsetConnTimeout(ctrl
.conn
);
1019 typedef CommCbMemFunT
<Client
, CommTimeoutCbParams
> TimeoutDialer
;
1020 AsyncCall::Pointer timeoutCall
= JobCallback(9, 5, TimeoutDialer
, this,
1021 Ftp::Client::timeout
);
1022 commSetConnTimeout(data
.conn
, Config
.Timeout
.read
, timeoutCall
);
1026 Ftp::Client::sentRequestBody(const CommIoCbParams
&io
)
1029 statCounter
.server
.ftp
.kbytes_out
+= io
.size
;
1030 ::Client::sentRequestBody(io
);
1034 * called after we wrote the last byte of the request body
1037 Ftp::Client::doneSendingRequestBody()
1039 ::Client::doneSendingRequestBody();
1040 debugs(9, 3, status());
1042 /* NP: RFC 959 3.3. DATA CONNECTION MANAGEMENT
1043 * if transfer type is 'stream' call dataComplete()
1044 * otherwise leave open. (reschedule control channel read?)
1048 /// Parses FTP server control response into ctrl structure fields,
1049 /// setting bytesUsed and returning true on success.
1051 Ftp::Client::parseControlReply(size_t &bytesUsed
)
1058 wordlist
*head
= NULL
;
1060 wordlist
**tail
= &head
;
1062 debugs(9, 3, status());
1064 * We need a NULL-terminated buffer for scanning, ick
1066 const size_t len
= ctrl
.offset
;
1067 sbuf
= (char *)xmalloc(len
+ 1);
1068 xstrncpy(sbuf
, ctrl
.buf
, len
+ 1);
1069 end
= sbuf
+ len
- 1;
1071 while (*end
!= '\r' && *end
!= '\n' && end
> sbuf
)
1074 usable
= end
- sbuf
;
1076 debugs(9, 3, "usable = " << usable
);
1079 debugs(9, 3, "didn't find end of line");
1084 debugs(9, 3, len
<< " bytes to play with");
1087 s
+= strspn(s
, crlf
);
1089 for (; s
< end
; s
+= strcspn(s
, crlf
), s
+= strspn(s
, crlf
)) {
1093 debugs(9, 5, "s = {" << s
<< "}");
1095 linelen
= strcspn(s
, crlf
) + 1;
1101 complete
= (*s
>= '0' && *s
<= '9' && *(s
+ 3) == ' ');
1103 list
= new wordlist();
1105 list
->key
= (char *)xmalloc(linelen
);
1107 xstrncpy(list
->key
, s
, linelen
);
1109 /* trace the FTP communication chat at level 2 */
1110 debugs(9, 2, "ftp>> " << list
->key
);
1113 // use list->key for last_reply because s contains the new line
1114 ctrl
.last_reply
= xstrdup(list
->key
+ 4);
1115 ctrl
.replycode
= atoi(list
->key
);
1123 bytesUsed
= static_cast<size_t>(s
- sbuf
);
1127 wordlistDestroy(&head
);
1131 ctrl
.message
= head
;
1132 assert(ctrl
.replycode
>= 0);
1133 assert(ctrl
.last_reply
);
1134 assert(ctrl
.message
);