src/clients/FtpGateway.cc

   1 /*
   2  * Copyright (C) 1996-2016 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 09    File Transfer Protocol (FTP) */
  10
  11 #include "squid.h"
  12 #include "acl/FilledChecklist.h"
  13 #include "clients/forward.h"
  14 #include "clients/FtpClient.h"
  15 #include "comm.h"
  16 #include "comm/ConnOpener.h"
  17 #include "comm/Read.h"
  18 #include "comm/TcpAcceptor.h"
  19 #include "CommCalls.h"
  20 #include "compat/strtoll.h"
  21 #include "errorpage.h"
  22 #include "fd.h"
  23 #include "fde.h"
  24 #include "FwdState.h"
  25 #include "html_quote.h"
  26 #include "HttpHdrContRange.h"
  27 #include "HttpHeader.h"
  28 #include "HttpHeaderRange.h"
  29 #include "HttpReply.h"
  30 #include "HttpRequest.h"
  31 #include "ip/tools.h"
  32 #include "MemBuf.h"
  33 #include "mime.h"
  34 #include "rfc1738.h"
  35 #include "SquidConfig.h"
  36 #include "SquidString.h"
  37 #include "SquidTime.h"
  38 #include "StatCounters.h"
  39 #include "Store.h"
  40 #include "tools.h"
  41 #include "URL.h"
  42 #include "util.h"
  43 #include "wordlist.h"
  44
  45 #if USE_DELAY_POOLS
  46 #include "DelayPools.h"
  47 #include "MemObject.h"
  48 #endif
  49
  50 #include <cerrno>
  51
  52 namespace Ftp
  53 {
  54
  55 struct GatewayFlags {
  56
  57     /* passive mode */
  58     bool pasv_supported;  ///< PASV command is allowed
  59     bool epsv_all_sent;   ///< EPSV ALL has been used. Must abort on failures.
  60     bool pasv_only;
  61     bool pasv_failed;  // was FwdState::flags.ftp_pasv_failed
  62
  63     /* authentication */
  64     bool authenticated;         ///< authentication success
  65     bool tried_auth_anonymous;  ///< auth has tried to use anonymous credentials already.
  66     bool tried_auth_nopass;     ///< auth tried username with no password already.
  67
  68     /* other */
  69     bool isdir;
  70     bool skip_whitespace;
  71     bool rest_supported;
  72     bool http_header_sent;
  73     bool tried_nlst;
  74     bool need_base_href;
  75     bool dir_slash;
  76     bool root_dir;
  77     bool no_dotdot;
  78     bool binary;
  79     bool try_slash_hack;
  80     bool put;
  81     bool put_mkdir;
  82     bool listformat_unknown;
  83     bool listing;
  84     bool completed_forwarding;
  85 };
  86
  87 class Gateway;
  88 typedef void (StateMethod)(Ftp::Gateway *);
  89
  90 /// FTP Gateway: An FTP client that takes an HTTP request with an ftp:// URI,
  91 /// converts it into one or more FTP commands, and then
  92 /// converts one or more FTP responses into the final HTTP response.
  93 class Gateway : public Ftp::Client
  94 {
  95     CBDATA_CLASS(Gateway);
  96
  97 public:
  98     Gateway(FwdState *);
  99     virtual ~Gateway();
 100     char user[MAX_URL];
 101     char password[MAX_URL];
 102     int password_url;
 103     char *reply_hdr;
 104     int reply_hdr_state;
 105     String clean_url;
 106     String title_url;
 107     String base_href;
 108     int conn_att;
 109     int login_att;
 110     time_t mdtm;
 111     int64_t theSize;
 112     wordlist *pathcomps;
 113     char *filepath;
 114     char *dirpath;
 115     int64_t restart_offset;
 116     char *proxy_host;
 117     size_t list_width;
 118     String cwd_message;
 119     char *old_filepath;
 120     char typecode;
 121     MemBuf listing;     ///< FTP directory listing in HTML format.
 122
 123     GatewayFlags flags;
 124
 125 public:
 126     // these should all be private
 127     virtual void start();
 128     virtual Http::StatusCode failedHttpStatus(err_type &error);
 129     int restartable();
 130     void appendSuccessHeader();
 131     void hackShortcut(StateMethod *nextState);
 132     void unhack();
 133     void readStor();
 134     void parseListing();
 135     MemBuf *htmlifyListEntry(const char *line);
 136     void completedListing(void);
 137
 138     /// create a data channel acceptor and start listening.
 139     void listenForDataChannel(const Comm::ConnectionPointer &conn);
 140
 141     int checkAuth(const HttpHeader * req_hdr);
 142     void checkUrlpath();
 143     void buildTitleUrl();
 144     void writeReplyBody(const char *, size_t len);
 145     void printfReplyBody(const char *fmt, ...);
 146     virtual void completeForwarding();
 147     void processHeadResponse();
 148     void processReplyBody();
 149     void setCurrentOffset(int64_t offset) { currentOffset = offset; }
 150     int64_t getCurrentOffset() const { return currentOffset; }
 151
 152     virtual void dataChannelConnected(const CommConnectCbParams &io);
 153     static PF ftpDataWrite;
 154     virtual void timeout(const CommTimeoutCbParams &io);
 155     void ftpAcceptDataConnection(const CommAcceptCbParams &io);
 156
 157     static HttpReply *ftpAuthRequired(HttpRequest * request, const char *realm);
 158     const char *ftpRealm(void);
 159     void loginFailed(void);
 160
 161     virtual void haveParsedReplyHeaders();
 162
 163     virtual bool haveControlChannel(const char *caller_name) const;
 164
 165 protected:
 166     virtual void handleControlReply();
 167     virtual void dataClosed(const CommCloseCbParams &io);
 168
 169 private:
 170     virtual bool mayReadVirginReplyBody() const;
 171     // BodyConsumer for HTTP: consume request body.
 172     virtual void handleRequestBodyProducerAborted();
 173
 174     void loginParser(const SBuf &login, bool escaped);
 175 };
 176
 177 } // namespace Ftp
 178
 179 typedef Ftp::StateMethod FTPSM; // to avoid lots of non-changes
 180
 181 CBDATA_NAMESPACED_CLASS_INIT(Ftp, Gateway);
 182
 183 typedef struct {
 184     char type;
 185     int64_t size;
 186     char *date;
 187     char *name;
 188     char *showname;
 189     char *link;
 190 } ftpListParts;
 191
 192 #define CTRL_BUFLEN 1024
 193 static char cbuf[CTRL_BUFLEN];
 194
 195 /*
 196  * State machine functions
 197  * send == state transition
 198  * read == wait for response, and select next state transition
 199  * other == Transition logic
 200  */
 201 static FTPSM ftpReadWelcome;
 202 static FTPSM ftpSendUser;
 203 static FTPSM ftpReadUser;
 204 static FTPSM ftpSendPass;
 205 static FTPSM ftpReadPass;
 206 static FTPSM ftpSendType;
 207 static FTPSM ftpReadType;
 208 static FTPSM ftpSendMdtm;
 209 static FTPSM ftpReadMdtm;
 210 static FTPSM ftpSendSize;
 211 static FTPSM ftpReadSize;
 212 static FTPSM ftpSendEPRT;
 213 static FTPSM ftpReadEPRT;
 214 static FTPSM ftpSendPORT;
 215 static FTPSM ftpReadPORT;
 216 static FTPSM ftpSendPassive;
 217 static FTPSM ftpReadEPSV;
 218 static FTPSM ftpReadPasv;
 219 static FTPSM ftpTraverseDirectory;
 220 static FTPSM ftpListDir;
 221 static FTPSM ftpGetFile;
 222 static FTPSM ftpSendCwd;
 223 static FTPSM ftpReadCwd;
 224 static FTPSM ftpRestOrList;
 225 static FTPSM ftpSendList;
 226 static FTPSM ftpSendNlst;
 227 static FTPSM ftpReadList;
 228 static FTPSM ftpSendRest;
 229 static FTPSM ftpReadRest;
 230 static FTPSM ftpSendRetr;
 231 static FTPSM ftpReadRetr;
 232 static FTPSM ftpReadTransferDone;
 233 static FTPSM ftpSendStor;
 234 static FTPSM ftpReadStor;
 235 static FTPSM ftpWriteTransferDone;
 236 static FTPSM ftpSendReply;
 237 static FTPSM ftpSendMkdir;
 238 static FTPSM ftpReadMkdir;
 239 static FTPSM ftpFail;
 240 static FTPSM ftpSendQuit;
 241 static FTPSM ftpReadQuit;
 242
 243 /************************************************
 244 ** Debugs Levels used here                     **
 245 *************************************************
 246 0   CRITICAL Events
 247 1   IMPORTANT Events
 248     Protocol and Transmission failures.
 249 2   FTP Protocol Chatter
 250 3   Logic Flows
 251 4   Data Parsing Flows
 252 5   Data Dumps
 253 7   ??
 254 ************************************************/
 255
 256 /************************************************
 257 ** State Machine Description (excluding hacks) **
 258 *************************************************
 259 From            To
 260 ---------------------------------------
 261 Welcome         User
 262 User            Pass
 263 Pass            Type
 264 Type            TraverseDirectory / GetFile
 265 TraverseDirectory   Cwd / GetFile / ListDir
 266 Cwd         TraverseDirectory / Mkdir
 267 GetFile         Mdtm
 268 Mdtm            Size
 269 Size            Epsv
 270 ListDir         Epsv
 271 Epsv            FileOrList
 272 FileOrList      Rest / Retr / Nlst / List / Mkdir (PUT /xxx;type=d)
 273 Rest            Retr
 274 Retr / Nlst / List  DataRead* (on datachannel)
 275 DataRead*       ReadTransferDone
 276 ReadTransferDone    DataTransferDone
 277 Stor            DataWrite* (on datachannel)
 278 DataWrite*      RequestPutBody** (from client)
 279 RequestPutBody**    DataWrite* / WriteTransferDone
 280 WriteTransferDone   DataTransferDone
 281 DataTransferDone    Quit
 282 Quit            -
 283 ************************************************/
 284
 285 FTPSM *FTP_SM_FUNCS[] = {
 286     ftpReadWelcome,     /* BEGIN */
 287     ftpReadUser,        /* SENT_USER */
 288     ftpReadPass,        /* SENT_PASS */
 289     ftpReadType,        /* SENT_TYPE */
 290     ftpReadMdtm,        /* SENT_MDTM */
 291     ftpReadSize,        /* SENT_SIZE */
 292     ftpReadEPRT,        /* SENT_EPRT */
 293     ftpReadPORT,        /* SENT_PORT */
 294     ftpReadEPSV,        /* SENT_EPSV_ALL */
 295     ftpReadEPSV,        /* SENT_EPSV_1 */
 296     ftpReadEPSV,        /* SENT_EPSV_2 */
 297     ftpReadPasv,        /* SENT_PASV */
 298     ftpReadCwd,     /* SENT_CWD */
 299     ftpReadList,        /* SENT_LIST */
 300     ftpReadList,        /* SENT_NLST */
 301     ftpReadRest,        /* SENT_REST */
 302     ftpReadRetr,        /* SENT_RETR */
 303     ftpReadStor,        /* SENT_STOR */
 304     ftpReadQuit,        /* SENT_QUIT */
 305     ftpReadTransferDone,    /* READING_DATA (RETR,LIST,NLST) */
 306     ftpWriteTransferDone,   /* WRITING_DATA (STOR) */
 307     ftpReadMkdir,       /* SENT_MKDIR */
 308     NULL,           /* SENT_FEAT */
 309     NULL,           /* SENT_PWD */
 310     NULL,           /* SENT_CDUP*/
 311     NULL,           /* SENT_DATA_REQUEST */
 312     NULL            /* SENT_COMMAND */
 313 };
 314
 315 /// handler called by Comm when FTP data channel is closed unexpectedly
 316 void
 317 Ftp::Gateway::dataClosed(const CommCloseCbParams &io)
 318 {
 319     Ftp::Client::dataClosed(io);
 320     failed(ERR_FTP_FAILURE, 0);
 321     /* failed closes ctrl.conn and frees ftpState */
 322
 323     /* NP: failure recovery may be possible when its only a data.conn failure.
 324      *     if the ctrl.conn is still fine, we can send ABOR down it and retry.
 325      *     Just need to watch out for wider Squid states like shutting down or reconfigure.
 326      */
 327 }
 328
 329 Ftp::Gateway::Gateway(FwdState *fwdState):
 330     AsyncJob("FtpStateData"),
 331     Ftp::Client(fwdState),
 332     password_url(0),
 333     reply_hdr(NULL),
 334     reply_hdr_state(0),
 335     conn_att(0),
 336     login_att(0),
 337     mdtm(-1),
 338     theSize(-1),
 339     pathcomps(NULL),
 340     filepath(NULL),
 341     dirpath(NULL),
 342     restart_offset(0),
 343     proxy_host(NULL),
 344     list_width(0),
 345     old_filepath(NULL),
 346     typecode('\0')
 347 {
 348     debugs(9, 3, entry->url());
 349
 350     *user = 0;
 351     *password = 0;
 352     memset(&flags, 0, sizeof(flags));
 353
 354     if (Config.Ftp.passive && !flags.pasv_failed)
 355         flags.pasv_supported = 1;
 356
 357     flags.rest_supported = 1;
 358
 359     if (request->method == Http::METHOD_PUT)
 360         flags.put = 1;
 361
 362     initReadBuf();
 363 }
 364
 365 Ftp::Gateway::~Gateway()
 366 {
 367     debugs(9, 3, entry->url());
 368
 369     if (Comm::IsConnOpen(ctrl.conn)) {
 370         debugs(9, DBG_IMPORTANT, "Internal bug: FTP Gateway left open " <<
 371                "control channel " << ctrl.conn);
 372     }
 373
 374     if (reply_hdr) {
 375         memFree(reply_hdr, MEM_8K_BUF);
 376         reply_hdr = NULL;
 377     }
 378
 379     if (pathcomps)
 380         wordlistDestroy(&pathcomps);
 381
 382     cwd_message.clean();
 383     xfree(old_filepath);
 384     title_url.clean();
 385     base_href.clean();
 386     xfree(filepath);
 387     xfree(dirpath);
 388 }
 389
 390 /**
 391  * Parse a possible login username:password pair.
 392  * Produces filled member variables user, password, password_url if anything found.
 393  *
 394  * \param login    a decoded Basic authentication credential token or URI user-info token
 395  * \param escaped  whether to URL-decode the token after extracting user and password
 396  */
 397 void
 398 Ftp::Gateway::loginParser(const SBuf &login, bool escaped)
 399 {
 400     debugs(9, 4, "login=" << login << ", escaped=" << escaped);
 401     debugs(9, 9, "IN : login=" << login << ", escaped=" << escaped << ", user=" << user << ", password=" << password);
 402
 403     if (login.isEmpty())
 404         return;
 405
 406     const SBuf::size_type colonPos = login.find(':');
 407
 408     /* If there was a username part with at least one character use it.
 409      * Ignore 0-length username portion, retain what we have already.
 410      */
 411     if (colonPos == SBuf::npos || colonPos > 0) {
 412         const SBuf userName = login.substr(0, colonPos);
 413         SBuf::size_type upto = userName.copy(user, sizeof(user)-1);
 414         user[upto]='\0';
 415         debugs(9, 9, "found user=" << userName << ' ' <<
 416                (upto != userName.length() ? ", truncated-to=" : ", length=") << upto <<
 417                ", escaped=" << escaped);
 418         if (escaped)
 419             rfc1738_unescape(user);
 420         debugs(9, 9, "found user=" << user << " (" << strlen(user) << ") unescaped.");
 421     }
 422
 423     /* If there was a password part.
 424      * For 0-length password clobber what we have already, this means explicitly none
 425      */
 426     if (colonPos != SBuf::npos) {
 427         const SBuf pass = login.substr(colonPos+1, SBuf::npos);
 428         SBuf::size_type upto = pass.copy(password, sizeof(password)-1);
 429         password[upto]='\0';
 430         debugs(9, 9, "found password=" << pass << " " <<
 431                (upto != pass.length() ? ", truncated-to=" : ", length=") << upto <<
 432                ", escaped=" << escaped);
 433         if (escaped) {
 434             rfc1738_unescape(password);
 435             password_url = 1;
 436         }
 437         debugs(9, 9, "found password=" << password << " (" << strlen(password) << ") unescaped.");
 438     }
 439
 440     debugs(9, 9, "OUT: login=" << login << ", escaped=" << escaped << ", user=" << user << ", password=" << password);
 441 }
 442
 443 void
 444 Ftp::Gateway::listenForDataChannel(const Comm::ConnectionPointer &conn)
 445 {
 446     assert(!Comm::IsConnOpen(data.conn));
 447
 448     typedef CommCbMemFunT<Gateway, CommAcceptCbParams> AcceptDialer;
 449     typedef AsyncCallT<AcceptDialer> AcceptCall;
 450     RefCount<AcceptCall> call = static_cast<AcceptCall*>(JobCallback(11, 5, AcceptDialer, this, Ftp::Gateway::ftpAcceptDataConnection));
 451     Subscription::Pointer sub = new CallSubscription<AcceptCall>(call);
 452     const char *note = entry->url();
 453
 454     /* open the conn if its not already open */
 455     if (!Comm::IsConnOpen(conn)) {
 456         conn->fd = comm_open_listener(SOCK_STREAM, IPPROTO_TCP, conn->local, conn->flags, note);
 457         if (!Comm::IsConnOpen(conn)) {
 458             debugs(5, DBG_CRITICAL, HERE << "comm_open_listener failed:" << conn->local << " error: " << errno);
 459             return;
 460         }
 461         debugs(9, 3, HERE << "Unconnected data socket created on " << conn);
 462     }
 463
 464     conn->tos = ctrl.conn->tos;
 465     conn->nfmark = ctrl.conn->nfmark;
 466
 467     assert(Comm::IsConnOpen(conn));
 468     AsyncJob::Start(new Comm::TcpAcceptor(conn, note, sub));
 469
 470     // Ensure we have a copy of the FD opened for listening and a close handler on it.
 471     data.opened(conn, dataCloser());
 472     switchTimeoutToDataChannel();
 473 }
 474
 475 void
 476 Ftp::Gateway::timeout(const CommTimeoutCbParams &io)
 477 {
 478     if (SENT_PASV == state) {
 479         /* stupid ftp.netscape.com, of FTP server behind stupid firewall rules */
 480         flags.pasv_supported = false;
 481         debugs(9, DBG_IMPORTANT, "FTP Gateway timeout in SENT_PASV state");
 482
 483         // cancel the data connection setup.
 484         if (data.opener != NULL) {
 485             data.opener->cancel("timeout");
 486             data.opener = NULL;
 487         }
 488         data.close();
 489     }
 490
 491     Ftp::Client::timeout(io);
 492 }
 493
 494 static const char *Month[] = {
 495     "Jan", "Feb", "Mar", "Apr", "May", "Jun",
 496     "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
 497 };
 498
 499 static int
 500 is_month(const char *buf)
 501 {
 502     int i;
 503
 504     for (i = 0; i < 12; ++i)
 505         if (!strcasecmp(buf, Month[i]))
 506             return 1;
 507
 508     return 0;
 509 }
 510
 511 static void
 512 ftpListPartsFree(ftpListParts ** parts)
 513 {
 514     safe_free((*parts)->date);
 515     safe_free((*parts)->name);
 516     safe_free((*parts)->showname);
 517     safe_free((*parts)->link);
 518     safe_free(*parts);
 519 }
 520
 521 #define MAX_TOKENS 64
 522
 523 static ftpListParts *
 524 ftpListParseParts(const char *buf, struct Ftp::GatewayFlags flags)
 525 {
 526     ftpListParts *p = NULL;
 527     char *t = NULL;
 528     const char *ct = NULL;
 529     char *tokens[MAX_TOKENS];
 530     int i;
 531     int n_tokens;
 532     static char tbuf[128];
 533     char *xbuf = NULL;
 534     static int scan_ftp_initialized = 0;
 535     static regex_t scan_ftp_integer;
 536     static regex_t scan_ftp_time;
 537     static regex_t scan_ftp_dostime;
 538     static regex_t scan_ftp_dosdate;
 539
 540     if (!scan_ftp_initialized) {
 541         scan_ftp_initialized = 1;
 542         regcomp(&scan_ftp_integer, "^[0123456789]+$", REG_EXTENDED | REG_NOSUB);
 543         regcomp(&scan_ftp_time, "^[0123456789:]+$", REG_EXTENDED | REG_NOSUB);
 544         regcomp(&scan_ftp_dosdate, "^[0123456789]+-[0123456789]+-[0123456789]+$", REG_EXTENDED | REG_NOSUB);
 545         regcomp(&scan_ftp_dostime, "^[0123456789]+:[0123456789]+[AP]M$", REG_EXTENDED | REG_NOSUB | REG_ICASE);
 546     }
 547
 548     if (buf == NULL)
 549         return NULL;
 550
 551     if (*buf == '\0')
 552         return NULL;
 553
 554     p = (ftpListParts *)xcalloc(1, sizeof(ftpListParts));
 555
 556     n_tokens = 0;
 557
 558     memset(tokens, 0, sizeof(tokens));
 559
 560     xbuf = xstrdup(buf);
 561
 562     if (flags.tried_nlst) {
 563         /* Machine readable format, one name per line */
 564         p->name = xbuf;
 565         p->type = '\0';
 566         return p;
 567     }
 568
 569     for (t = strtok(xbuf, w_space); t && n_tokens < MAX_TOKENS; t = strtok(NULL, w_space)) {
 570         tokens[n_tokens] = xstrdup(t);
 571         ++n_tokens;
 572     }
 573
 574     xfree(xbuf);
 575
 576     /* locate the Month field */
 577     for (i = 3; i < n_tokens - 2; ++i) {
 578         char *size = tokens[i - 1];
 579         char *month = tokens[i];
 580         char *day = tokens[i + 1];
 581         char *year = tokens[i + 2];
 582
 583         if (!is_month(month))
 584             continue;
 585
 586         if (regexec(&scan_ftp_integer, size, 0, NULL, 0) != 0)
 587             continue;
 588
 589         if (regexec(&scan_ftp_integer, day, 0, NULL, 0) != 0)
 590             continue;
 591
 592         if (regexec(&scan_ftp_time, year, 0, NULL, 0) != 0) /* Yr | hh:mm */
 593             continue;
 594
 595         snprintf(tbuf, 128, "%s %2s %5s",
 596                  month, day, year);
 597
 598         if (!strstr(buf, tbuf))
 599             snprintf(tbuf, 128, "%s %2s %-5s",
 600                      month, day, year);
 601
 602         char const *copyFrom = NULL;
 603
 604         if ((copyFrom = strstr(buf, tbuf))) {
 605             p->type = *tokens[0];
 606             p->size = strtoll(size, NULL, 10);
 607             p->date = xstrdup(tbuf);
 608
 609             if (flags.skip_whitespace) {
 610                 copyFrom += strlen(tbuf);
 611
 612                 while (strchr(w_space, *copyFrom))
 613                     ++copyFrom;
 614             } else {
 615                 /* XXX assumes a single space between date and filename
 616                  * suggested by:  Nathan.Bailey@cc.monash.edu.au and
 617                  * Mike Battersby <mike@starbug.bofh.asn.au> */
 618                 copyFrom += strlen(tbuf) + 1;
 619             }
 620
 621             p->name = xstrdup(copyFrom);
 622
 623             if (p->type == 'l' && (t = strstr(p->name, " -> "))) {
 624                 *t = '\0';
 625                 p->link = xstrdup(t + 4);
 626             }
 627
 628             goto found;
 629         }
 630
 631         break;
 632     }
 633
 634     /* try it as a DOS listing, 04-05-70 09:33PM ... */
 635     if (n_tokens > 3 &&
 636             regexec(&scan_ftp_dosdate, tokens[0], 0, NULL, 0) == 0 &&
 637             regexec(&scan_ftp_dostime, tokens[1], 0, NULL, 0) == 0) {
 638         if (!strcasecmp(tokens[2], "<dir>")) {
 639             p->type = 'd';
 640         } else {
 641             p->type = '-';
 642             p->size = strtoll(tokens[2], NULL, 10);
 643         }
 644
 645         snprintf(tbuf, 128, "%s %s", tokens[0], tokens[1]);
 646         p->date = xstrdup(tbuf);
 647
 648         if (p->type == 'd') {
 649             /* Directory.. name begins with first printable after <dir> */
 650             ct = strstr(buf, tokens[2]);
 651             ct += strlen(tokens[2]);
 652
 653             while (xisspace(*ct))
 654                 ++ct;
 655
 656             if (!*ct)
 657                 ct = NULL;
 658         } else {
 659             /* A file. Name begins after size, with a space in between */
 660             snprintf(tbuf, 128, " %s %s", tokens[2], tokens[3]);
 661             ct = strstr(buf, tbuf);
 662
 663             if (ct) {
 664                 ct += strlen(tokens[2]) + 2;
 665             }
 666         }
 667
 668         p->name = xstrdup(ct ? ct : tokens[3]);
 669         goto found;
 670     }
 671
 672     /* Try EPLF format; carson@lehman.com */
 673     if (buf[0] == '+') {
 674         ct = buf + 1;
 675         p->type = 0;
 676
 677         while (ct && *ct) {
 678             time_t tm;
 679             int l = strcspn(ct, ",");
 680             char *tmp;
 681
 682             if (l < 1)
 683                 goto blank;
 684
 685             switch (*ct) {
 686
 687             case '\t':
 688                 p->name = xstrndup(ct + 1, l + 1);
 689                 break;
 690
 691             case 's':
 692                 p->size = atoi(ct + 1);
 693                 break;
 694
 695             case 'm':
 696                 tm = (time_t) strtol(ct + 1, &tmp, 0);
 697
 698                 if (tmp != ct + 1)
 699                     break;  /* not a valid integer */
 700
 701                 p->date = xstrdup(ctime(&tm));
 702
 703                 *(strstr(p->date, "\n")) = '\0';
 704
 705                 break;
 706
 707             case '/':
 708                 p->type = 'd';
 709
 710                 break;
 711
 712             case 'r':
 713                 p->type = '-';
 714
 715                 break;
 716
 717             case 'i':
 718                 break;
 719
 720             default:
 721                 break;
 722             }
 723
 724 blank:
 725             ct = strstr(ct, ",");
 726
 727             if (ct) {
 728                 ++ct;
 729             }
 730         }
 731
 732         if (p->type == 0) {
 733             p->type = '-';
 734         }
 735
 736         if (p->name)
 737             goto found;
 738         else
 739             safe_free(p->date);
 740     }
 741
 742 found:
 743
 744     for (i = 0; i < n_tokens; ++i)
 745         xfree(tokens[i]);
 746
 747     if (!p->name)
 748         ftpListPartsFree(&p);   /* cleanup */
 749
 750     return p;
 751 }
 752
 753 MemBuf *
 754 Ftp::Gateway::htmlifyListEntry(const char *line)
 755 {
 756     char icon[2048];
 757     char href[2048 + 40];
 758     char text[ 2048];
 759     char size[ 2048];
 760     char chdir[ 2048 + 40];
 761     char view[ 2048 + 40];
 762     char download[ 2048 + 40];
 763     char link[ 2048 + 40];
 764     MemBuf *html;
 765     char prefix[2048];
 766     ftpListParts *parts;
 767     *icon = *href = *text = *size = *chdir = *view = *download = *link = '\0';
 768
 769     debugs(9, 7, HERE << " line ={" << line << "}");
 770
 771     if (strlen(line) > 1024) {
 772         html = new MemBuf();
 773         html->init();
 774         html->appendf("<tr><td colspan=\"5\">%s</td></tr>\n", line);
 775         return html;
 776     }
 777
 778     if (flags.dir_slash && dirpath && typecode != 'D')
 779         snprintf(prefix, 2048, "%s/", rfc1738_escape_part(dirpath));
 780     else
 781         prefix[0] = '\0';
 782
 783     if ((parts = ftpListParseParts(line, flags)) == NULL) {
 784         const char *p;
 785
 786         html = new MemBuf();
 787         html->init();
 788         html->appendf("<tr class=\"entry\"><td colspan=\"5\">%s</td></tr>\n", line);
 789
 790         for (p = line; *p && xisspace(*p); ++p);
 791         if (*p && !xisspace(*p))
 792             flags.listformat_unknown = 1;
 793
 794         return html;
 795     }
 796
 797     if (!strcmp(parts->name, ".") || !strcmp(parts->name, "..")) {
 798         ftpListPartsFree(&parts);
 799         return NULL;
 800     }
 801
 802     parts->size += 1023;
 803     parts->size >>= 10;
 804     parts->showname = xstrdup(parts->name);
 805
 806     /* {icon} {text} . . . {date}{size}{chdir}{view}{download}{link}\n  */
 807     xstrncpy(href, rfc1738_escape_part(parts->name), 2048);
 808
 809     xstrncpy(text, parts->showname, 2048);
 810
 811     switch (parts->type) {
 812
 813     case 'd':
 814         snprintf(icon, 2048, "<img border=\"0\" src=\"%s\" alt=\"%-6s\">",
 815                  mimeGetIconURL("internal-dir"),
 816                  "[DIR]");
 817         strcat(href, "/");  /* margin is allocated above */
 818         break;
 819
 820     case 'l':
 821         snprintf(icon, 2048, "<img border=\"0\" src=\"%s\" alt=\"%-6s\">",
 822                  mimeGetIconURL("internal-link"),
 823                  "[LINK]");
 824         /* sometimes there is an 'l' flag, but no "->" link */
 825
 826         if (parts->link) {
 827             char *link2 = xstrdup(html_quote(rfc1738_escape(parts->link)));
 828             snprintf(link, 2048, " -&gt; <a href=\"%s%s\">%s</a>",
 829                      *link2 != '/' ? prefix : "", link2,
 830                      html_quote(parts->link));
 831             safe_free(link2);
 832         }
 833
 834         break;
 835
 836     case '\0':
 837         snprintf(icon, 2048, "<img border=\"0\" src=\"%s\" alt=\"%-6s\">",
 838                  mimeGetIconURL(parts->name),
 839                  "[UNKNOWN]");
 840         snprintf(chdir, 2048, "<a href=\"%s/;type=d\"><img border=\"0\" src=\"%s\" "
 841                  "alt=\"[DIR]\"></a>",
 842                  rfc1738_escape_part(parts->name),
 843                  mimeGetIconURL("internal-dir"));
 844         break;
 845
 846     case '-':
 847
 848     default:
 849         snprintf(icon, 2048, "<img border=\"0\" src=\"%s\" alt=\"%-6s\">",
 850                  mimeGetIconURL(parts->name),
 851                  "[FILE]");
 852         snprintf(size, 2048, " %6" PRId64 "k", parts->size);
 853         break;
 854     }
 855
 856     if (parts->type != 'd') {
 857         if (mimeGetViewOption(parts->name)) {
 858             snprintf(view, 2048, "<a href=\"%s%s;type=a\"><img border=\"0\" src=\"%s\" "
 859                      "alt=\"[VIEW]\"></a>",
 860                      prefix, href, mimeGetIconURL("internal-view"));
 861         }
 862
 863         if (mimeGetDownloadOption(parts->name)) {
 864             snprintf(download, 2048, "<a href=\"%s%s;type=i\"><img border=\"0\" src=\"%s\" "
 865                      "alt=\"[DOWNLOAD]\"></a>",
 866                      prefix, href, mimeGetIconURL("internal-download"));
 867         }
 868     }
 869
 870     /* construct the table row from parts. */
 871     html = new MemBuf();
 872     html->init();
 873     html->appendf("<tr class=\"entry\">"
 874                   "<td class=\"icon\"><a href=\"%s%s\">%s</a></td>"
 875                   "<td class=\"filename\"><a href=\"%s%s\">%s</a></td>"
 876                   "<td class=\"date\">%s</td>"
 877                   "<td class=\"size\">%s</td>"
 878                   "<td class=\"actions\">%s%s%s%s</td>"
 879                   "</tr>\n",
 880                   prefix, href, icon,
 881                   prefix, href, html_quote(text),
 882                   parts->date,
 883                   size,
 884                   chdir, view, download, link);
 885
 886     ftpListPartsFree(&parts);
 887     return html;
 888 }
 889
 890 void
 891 Ftp::Gateway::parseListing()
 892 {
 893     char *buf = data.readBuf->content();
 894     char *sbuf;         /* NULL-terminated copy of termedBuf */
 895     char *end;
 896     char *line;
 897     char *s;
 898     MemBuf *t;
 899     size_t linelen;
 900     size_t usable;
 901     size_t len = data.readBuf->contentSize();
 902
 903     if (!len) {
 904         debugs(9, 3, HERE << "no content to parse for " << entry->url()  );
 905         return;
 906     }
 907
 908     /*
 909      * We need a NULL-terminated buffer for scanning, ick
 910      */
 911     sbuf = (char *)xmalloc(len + 1);
 912     xstrncpy(sbuf, buf, len + 1);
 913     end = sbuf + len - 1;
 914
 915     while (*end != '\r' && *end != '\n' && end > sbuf)
 916         --end;
 917
 918     usable = end - sbuf;
 919
 920     debugs(9, 3, HERE << "usable = " << usable << " of " << len << " bytes.");
 921
 922     if (usable == 0) {
 923         if (buf[0] == '\0' && len == 1) {
 924             debugs(9, 3, HERE << "NIL ends data from " << entry->url() << " transfer problem?");
 925             data.readBuf->consume(len);
 926         } else {
 927             debugs(9, 3, HERE << "didn't find end for " << entry->url());
 928             debugs(9, 3, HERE << "buffer remains (" << len << " bytes) '" << rfc1738_do_escape(buf,0) << "'");
 929         }
 930         xfree(sbuf);
 931         return;
 932     }
 933
 934     debugs(9, 3, HERE << (unsigned long int)len << " bytes to play with");
 935
 936     line = (char *)memAllocate(MEM_4K_BUF);
 937     ++end;
 938     s = sbuf;
 939     s += strspn(s, crlf);
 940
 941     for (; s < end; s += strcspn(s, crlf), s += strspn(s, crlf)) {
 942         debugs(9, 7, HERE << "s = {" << s << "}");
 943         linelen = strcspn(s, crlf) + 1;
 944
 945         if (linelen < 2)
 946             break;
 947
 948         if (linelen > 4096)
 949             linelen = 4096;
 950
 951         xstrncpy(line, s, linelen);
 952
 953         debugs(9, 7, HERE << "{" << line << "}");
 954
 955         if (!strncmp(line, "total", 5))
 956             continue;
 957
 958         t = htmlifyListEntry(line);
 959
 960         if ( t != NULL) {
 961             debugs(9, 7, HERE << "listing append: t = {" << t->contentSize() << ", '" << t->content() << "'}");
 962             listing.append(t->content(), t->contentSize());
 963             delete t;
 964         }
 965     }
 966
 967     debugs(9, 7, HERE << "Done.");
 968     data.readBuf->consume(usable);
 969     memFree(line, MEM_4K_BUF);
 970     xfree(sbuf);
 971 }
 972
 973 void
 974 Ftp::Gateway::processReplyBody()
 975 {
 976     debugs(9, 3, status());
 977
 978     if (request->method == Http::METHOD_HEAD && (flags.isdir || theSize != -1)) {
 979         serverComplete();
 980         return;
 981     }
 982
 983     /* Directory listings are special. They write ther own headers via the error objects */
 984     if (!flags.http_header_sent && data.readBuf->contentSize() >= 0 && !flags.isdir)
 985         appendSuccessHeader();
 986
 987     if (EBIT_TEST(entry->flags, ENTRY_ABORTED)) {
 988         /*
 989          * probably was aborted because content length exceeds one
 990          * of the maximum size limits.
 991          */
 992         abortTransaction("entry aborted after calling appendSuccessHeader()");
 993         return;
 994     }
 995
 996 #if USE_ADAPTATION
 997
 998     if (adaptationAccessCheckPending) {
 999         debugs(9, 3, "returning from Ftp::Gateway::processReplyBody due to adaptationAccessCheckPending");
1000         return;
1001     }
1002
1003 #endif
1004
1005     if (flags.isdir) {
1006         if (!flags.listing) {
1007             flags.listing = 1;
1008             listing.reset();
1009         }
1010         parseListing();
1011         maybeReadVirginBody();
1012         return;
1013     } else if (const int csize = data.readBuf->contentSize()) {
1014         writeReplyBody(data.readBuf->content(), csize);
1015         debugs(9, 5, HERE << "consuming " << csize << " bytes of readBuf");
1016         data.readBuf->consume(csize);
1017     }
1018
1019     entry->flush();
1020
1021     maybeReadVirginBody();
1022 }
1023
1024 /**
1025  * Locates the FTP user:password login.
1026  *
1027  * Highest to lowest priority:
1028  *  - Checks URL (ftp://user:pass@domain)
1029  *  - Authorization: Basic header
1030  *  - squid.conf anonymous-FTP settings (default: anonymous:Squid@).
1031  *
1032  * Special Case: A username-only may be provided in the URL and password in the HTTP headers.
1033  *
1034  * TODO: we might be able to do something about locating username from other sources:
1035  *       ie, external ACL user=* tag or ident lookup
1036  *
1037  \retval 1  if we have everything needed to complete this request.
1038  \retval 0  if something is missing.
1039  */
1040 int
1041 Ftp::Gateway::checkAuth(const HttpHeader * req_hdr)
1042 {
1043     /* default username */
1044     xstrncpy(user, "anonymous", MAX_URL);
1045
1046 #if HAVE_AUTH_MODULE_BASIC
1047     /* Check HTTP Authorization: headers (better than defaults, but less than URL) */
1048     const SBuf auth(req_hdr->getAuth(Http::HdrType::AUTHORIZATION, "Basic"));
1049     if (!auth.isEmpty()) {
1050         flags.authenticated = 1;
1051         loginParser(auth, false);
1052     }
1053     /* we fail with authorization-required error later IFF the FTP server requests it */
1054 #endif
1055
1056     /* Test URL login syntax. Overrides any headers received. */
1057     loginParser(request->url.userInfo(), true);
1058
1059     /* name is missing. thats fatal. */
1060     if (!user[0])
1061         fatal("FTP login parsing destroyed username info");
1062
1063     /* name + password == success */
1064     if (password[0])
1065         return 1;
1066
1067     /* Setup default FTP password settings */
1068     /* this has to be done last so that we can have a no-password case above. */
1069     if (!password[0]) {
1070         if (strcmp(user, "anonymous") == 0 && !flags.tried_auth_anonymous) {
1071             xstrncpy(password, Config.Ftp.anon_user, MAX_URL);
1072             flags.tried_auth_anonymous=1;
1073             return 1;
1074         } else if (!flags.tried_auth_nopass) {
1075             xstrncpy(password, null_string, MAX_URL);
1076             flags.tried_auth_nopass=1;
1077             return 1;
1078         }
1079     }
1080
1081     return 0;           /* different username */
1082 }
1083
1084 void
1085 Ftp::Gateway::checkUrlpath()
1086 {
1087     static SBuf str_type_eq("type=");
1088     auto t = request->url.path().rfind(';');
1089
1090     if (t != SBuf::npos) {
1091         auto filenameEnd = t-1;
1092         if (request->url.path().substr(++t).cmp(str_type_eq, str_type_eq.length()) == 0) {
1093             t += str_type_eq.length();
1094             typecode = (char)xtoupper(request->url.path()[t]);
1095             request->url.path(request->url.path().substr(0,filenameEnd));
1096         }
1097     }
1098
1099     int l = request->url.path().length();
1100     /* check for null path */
1101
1102     if (!l) {
1103         flags.isdir = 1;
1104         flags.root_dir = 1;
1105         flags.need_base_href = 1;   /* Work around broken browsers */
1106     } else if (!request->url.path().cmp("/%2f/")) {
1107         /* UNIX root directory */
1108         flags.isdir = 1;
1109         flags.root_dir = 1;
1110     } else if ((l >= 1) && (request->url.path()[l-1] == '/')) {
1111         /* Directory URL, ending in / */
1112         flags.isdir = 1;
1113
1114         if (l == 1)
1115             flags.root_dir = 1;
1116     } else {
1117         flags.dir_slash = 1;
1118     }
1119 }
1120
1121 void
1122 Ftp::Gateway::buildTitleUrl()
1123 {
1124     title_url = "ftp://";
1125
1126     if (strcmp(user, "anonymous")) {
1127         title_url.append(user);
1128         title_url.append("@");
1129     }
1130
1131     SBuf authority = request->url.authority(request->url.getScheme() != AnyP::PROTO_FTP);
1132
1133     title_url.append(authority.rawContent(), authority.length());
1134     title_url.append(request->url.path().rawContent(), request->url.path().length());
1135
1136     base_href = "ftp://";
1137
1138     if (strcmp(user, "anonymous") != 0) {
1139         base_href.append(rfc1738_escape_part(user));
1140
1141         if (password_url) {
1142             base_href.append(":");
1143             base_href.append(rfc1738_escape_part(password));
1144         }
1145
1146         base_href.append("@");
1147     }
1148
1149     base_href.append(authority.rawContent(), authority.length());
1150     base_href.append(request->url.path().rawContent(), request->url.path().length());
1151     base_href.append("/");
1152 }
1153
1154 void
1155 Ftp::Gateway::start()
1156 {
1157     if (!checkAuth(&request->header)) {
1158         /* create appropriate reply */
1159         HttpReply *reply = ftpAuthRequired(request, ftpRealm());
1160         entry->replaceHttpReply(reply);
1161         serverComplete();
1162         return;
1163     }
1164
1165     checkUrlpath();
1166     buildTitleUrl();
1167     debugs(9, 5, "FD " << ctrl.conn->fd << " : host=" << request->url.host() <<
1168            ", path=" << request->url.path() << ", user=" << user << ", passwd=" << password);
1169     state = BEGIN;
1170     Ftp::Client::start();
1171 }
1172
1173 /* ====================================================================== */
1174
1175 void
1176 Ftp::Gateway::handleControlReply()
1177 {
1178     Ftp::Client::handleControlReply();
1179     if (ctrl.message == NULL)
1180         return; // didn't get complete reply yet
1181
1182     /* Copy the message except for the last line to cwd_message to be
1183      * printed in error messages.
1184      */
1185     for (wordlist *w = ctrl.message; w && w->next; w = w->next) {
1186         cwd_message.append('\n');
1187         cwd_message.append(w->key);
1188     }
1189
1190     FTP_SM_FUNCS[state] (this);
1191 }
1192
1193 /* ====================================================================== */
1194
1195 static void
1196 ftpReadWelcome(Ftp::Gateway * ftpState)
1197 {
1198     int code = ftpState->ctrl.replycode;
1199     debugs(9, 3, HERE);
1200
1201     if (ftpState->flags.pasv_only)
1202         ++ ftpState->login_att;
1203
1204     if (code == 220) {
1205         if (ftpState->ctrl.message) {
1206             if (strstr(ftpState->ctrl.message->key, "NetWare"))
1207                 ftpState->flags.skip_whitespace = 1;
1208         }
1209
1210         ftpSendUser(ftpState);
1211     } else if (code == 120) {
1212         if (NULL != ftpState->ctrl.message)
1213             debugs(9, DBG_IMPORTANT, "FTP server is busy: " << ftpState->ctrl.message->key);
1214
1215         return;
1216     } else {
1217         ftpFail(ftpState);
1218     }
1219 }
1220
1221 /**
1222  * Translate FTP login failure into HTTP error
1223  * this is an attmpt to get the 407 message to show up outside Squid.
1224  * its NOT a general failure. But a correct FTP response type.
1225  */
1226 void
1227 Ftp::Gateway::loginFailed()
1228 {
1229     ErrorState *err = NULL;
1230
1231     if ((state == SENT_USER || state == SENT_PASS) && ctrl.replycode >= 400) {
1232         if (ctrl.replycode == 421 || ctrl.replycode == 426) {
1233             // 421/426 - Service Overload - retry permitted.
1234             err = new ErrorState(ERR_FTP_UNAVAILABLE, Http::scServiceUnavailable, fwd->request);
1235         } else if (ctrl.replycode >= 430 && ctrl.replycode <= 439) {
1236             // 43x - Invalid or Credential Error - retry challenge required.
1237             err = new ErrorState(ERR_FTP_FORBIDDEN, Http::scUnauthorized, fwd->request);
1238         } else if (ctrl.replycode >= 530 && ctrl.replycode <= 539) {
1239             // 53x - Credentials Missing - retry challenge required
1240             if (password_url) // but they were in the URI! major fail.
1241                 err = new ErrorState(ERR_FTP_FORBIDDEN, Http::scForbidden, fwd->request);
1242             else
1243                 err = new ErrorState(ERR_FTP_FORBIDDEN, Http::scUnauthorized, fwd->request);
1244         }
1245     }
1246
1247     if (!err) {
1248         ftpFail(this);
1249         return;
1250     }
1251
1252     failed(ERR_NONE, ctrl.replycode, err);
1253     // any other problems are general falures.
1254
1255     HttpReply *newrep = err->BuildHttpReply();
1256     delete err;
1257
1258 #if HAVE_AUTH_MODULE_BASIC
1259     /* add Authenticate header */
1260     newrep->header.putAuth("Basic", ftpRealm());
1261 #endif
1262
1263     // add it to the store entry for response....
1264     entry->replaceHttpReply(newrep);
1265     serverComplete();
1266 }
1267
1268 const char *
1269 Ftp::Gateway::ftpRealm()
1270 {
1271     static char realm[8192];
1272
1273     /* This request is not fully authenticated */
1274     if (!request) {
1275         snprintf(realm, 8192, "FTP %s unknown", user);
1276     } else if (request->url.port() == 21) {
1277         snprintf(realm, 8192, "FTP %s %s", user, request->url.host());
1278     } else {
1279         snprintf(realm, 8192, "FTP %s %s port %d", user, request->url.host(), request->url.port());
1280     }
1281     return realm;
1282 }
1283
1284 static void
1285 ftpSendUser(Ftp::Gateway * ftpState)
1286 {
1287     /* check the server control channel is still available */
1288     if (!ftpState || !ftpState->haveControlChannel("ftpSendUser"))
1289         return;
1290
1291     if (ftpState->proxy_host != NULL)
1292         snprintf(cbuf, CTRL_BUFLEN, "USER %s@%s\r\n", ftpState->user, ftpState->request->url.host());
1293     else
1294         snprintf(cbuf, CTRL_BUFLEN, "USER %s\r\n", ftpState->user);
1295
1296     ftpState->writeCommand(cbuf);
1297
1298     ftpState->state = Ftp::Client::SENT_USER;
1299 }
1300
1301 static void
1302 ftpReadUser(Ftp::Gateway * ftpState)
1303 {
1304     int code = ftpState->ctrl.replycode;
1305     debugs(9, 3, HERE);
1306
1307     if (code == 230) {
1308         ftpReadPass(ftpState);
1309     } else if (code == 331) {
1310         ftpSendPass(ftpState);
1311     } else {
1312         ftpState->loginFailed();
1313     }
1314 }
1315
1316 static void
1317 ftpSendPass(Ftp::Gateway * ftpState)
1318 {
1319     /* check the server control channel is still available */
1320     if (!ftpState || !ftpState->haveControlChannel("ftpSendPass"))
1321         return;
1322
1323     snprintf(cbuf, CTRL_BUFLEN, "PASS %s\r\n", ftpState->password);
1324     ftpState->writeCommand(cbuf);
1325     ftpState->state = Ftp::Client::SENT_PASS;
1326 }
1327
1328 static void
1329 ftpReadPass(Ftp::Gateway * ftpState)
1330 {
1331     int code = ftpState->ctrl.replycode;
1332     debugs(9, 3, HERE << "code=" << code);
1333
1334     if (code == 230) {
1335         ftpSendType(ftpState);
1336     } else {
1337         ftpState->loginFailed();
1338     }
1339 }
1340
1341 static void
1342 ftpSendType(Ftp::Gateway * ftpState)
1343 {
1344     /* check the server control channel is still available */
1345     if (!ftpState || !ftpState->haveControlChannel("ftpSendType"))
1346         return;
1347
1348     /*
1349      * Ref section 3.2.2 of RFC 1738
1350      */
1351     char mode = ftpState->typecode;
1352
1353     switch (mode) {
1354
1355     case 'D':
1356         mode = 'A';
1357         break;
1358
1359     case 'A':
1360
1361     case 'I':
1362         break;
1363
1364     default:
1365
1366         if (ftpState->flags.isdir) {
1367             mode = 'A';
1368         } else {
1369             auto t = ftpState->request->url.path().rfind('/');
1370             // XXX: performance regression, c_str() may reallocate
1371             SBuf filename = ftpState->request->url.path().substr(t != SBuf::npos ? t + 1 : 0);
1372             mode = mimeGetTransferMode(filename.c_str());
1373         }
1374
1375         break;
1376     }
1377
1378     if (mode == 'I')
1379         ftpState->flags.binary = 1;
1380     else
1381         ftpState->flags.binary = 0;
1382
1383     snprintf(cbuf, CTRL_BUFLEN, "TYPE %c\r\n", mode);
1384
1385     ftpState->writeCommand(cbuf);
1386
1387     ftpState->state = Ftp::Client::SENT_TYPE;
1388 }
1389
1390 static void
1391 ftpReadType(Ftp::Gateway * ftpState)
1392 {
1393     int code = ftpState->ctrl.replycode;
1394     char *path;
1395     char *d, *p;
1396     debugs(9, 3, HERE << "code=" << code);
1397
1398     if (code == 200) {
1399         p = path = SBufToCstring(ftpState->request->url.path());
1400
1401         if (*p == '/')
1402             ++p;
1403
1404         while (*p) {
1405             d = p;
1406             p += strcspn(p, "/");
1407
1408             if (*p) {
1409                 *p = '\0';
1410                 ++p;
1411             }
1412
1413             rfc1738_unescape(d);
1414
1415             if (*d)
1416                 wordlistAdd(&ftpState->pathcomps, d);
1417         }
1418
1419         xfree(path);
1420
1421         if (ftpState->pathcomps)
1422             ftpTraverseDirectory(ftpState);
1423         else
1424             ftpListDir(ftpState);
1425     } else {
1426         ftpFail(ftpState);
1427     }
1428 }
1429
1430 static void
1431 ftpTraverseDirectory(Ftp::Gateway * ftpState)
1432 {
1433     debugs(9, 4, HERE << (ftpState->filepath ? ftpState->filepath : "<NULL>"));
1434
1435     safe_free(ftpState->dirpath);
1436     ftpState->dirpath = ftpState->filepath;
1437     ftpState->filepath = NULL;
1438
1439     /* Done? */
1440
1441     if (ftpState->pathcomps == NULL) {
1442         debugs(9, 3, HERE << "the final component was a directory");
1443         ftpListDir(ftpState);
1444         return;
1445     }
1446
1447     /* Go to next path component */
1448     ftpState->filepath = wordlistChopHead(& ftpState->pathcomps);
1449
1450     /* Check if we are to CWD or RETR */
1451     if (ftpState->pathcomps != NULL || ftpState->flags.isdir) {
1452         ftpSendCwd(ftpState);
1453     } else {
1454         debugs(9, 3, HERE << "final component is probably a file");
1455         ftpGetFile(ftpState);
1456         return;
1457     }
1458 }
1459
1460 static void
1461 ftpSendCwd(Ftp::Gateway * ftpState)
1462 {
1463     char *path = NULL;
1464
1465     /* check the server control channel is still available */
1466     if (!ftpState || !ftpState->haveControlChannel("ftpSendCwd"))
1467         return;
1468
1469     debugs(9, 3, HERE);
1470
1471     path = ftpState->filepath;
1472
1473     if (!strcmp(path, "..") || !strcmp(path, "/")) {
1474         ftpState->flags.no_dotdot = 1;
1475     } else {
1476         ftpState->flags.no_dotdot = 0;
1477     }
1478
1479     snprintf(cbuf, CTRL_BUFLEN, "CWD %s\r\n", path);
1480
1481     ftpState->writeCommand(cbuf);
1482
1483     ftpState->state = Ftp::Client::SENT_CWD;
1484 }
1485
1486 static void
1487 ftpReadCwd(Ftp::Gateway * ftpState)
1488 {
1489     int code = ftpState->ctrl.replycode;
1490     debugs(9, 3, HERE);
1491
1492     if (code >= 200 && code < 300) {
1493         /* CWD OK */
1494         ftpState->unhack();
1495
1496         /* Reset cwd_message to only include the last message */
1497         ftpState->cwd_message.reset("");
1498         for (wordlist *w = ftpState->ctrl.message; w; w = w->next) {
1499             ftpState->cwd_message.append(' ');
1500             ftpState->cwd_message.append(w->key);
1501         }
1502         ftpState->ctrl.message = NULL;
1503
1504         /* Continue to traverse the path */
1505         ftpTraverseDirectory(ftpState);
1506     } else {
1507         /* CWD FAILED */
1508
1509         if (!ftpState->flags.put)
1510             ftpFail(ftpState);
1511         else
1512             ftpSendMkdir(ftpState);
1513     }
1514 }
1515
1516 static void
1517 ftpSendMkdir(Ftp::Gateway * ftpState)
1518 {
1519     char *path = NULL;
1520
1521     /* check the server control channel is still available */
1522     if (!ftpState || !ftpState->haveControlChannel("ftpSendMkdir"))
1523         return;
1524
1525     path = ftpState->filepath;
1526     debugs(9, 3, HERE << "with path=" << path);
1527     snprintf(cbuf, CTRL_BUFLEN, "MKD %s\r\n", path);
1528     ftpState->writeCommand(cbuf);
1529     ftpState->state = Ftp::Client::SENT_MKDIR;
1530 }
1531
1532 static void
1533 ftpReadMkdir(Ftp::Gateway * ftpState)
1534 {
1535     char *path = ftpState->filepath;
1536     int code = ftpState->ctrl.replycode;
1537
1538     debugs(9, 3, HERE << "path " << path << ", code " << code);
1539
1540     if (code == 257) {      /* success */
1541         ftpSendCwd(ftpState);
1542     } else if (code == 550) {   /* dir exists */
1543
1544         if (ftpState->flags.put_mkdir) {
1545             ftpState->flags.put_mkdir = 1;
1546             ftpSendCwd(ftpState);
1547         } else
1548             ftpSendReply(ftpState);
1549     } else
1550         ftpSendReply(ftpState);
1551 }
1552
1553 static void
1554 ftpGetFile(Ftp::Gateway * ftpState)
1555 {
1556     assert(*ftpState->filepath != '\0');
1557     ftpState->flags.isdir = 0;
1558     ftpSendMdtm(ftpState);
1559 }
1560
1561 static void
1562 ftpListDir(Ftp::Gateway * ftpState)
1563 {
1564     if (ftpState->flags.dir_slash) {
1565         debugs(9, 3, HERE << "Directory path did not end in /");
1566         ftpState->title_url.append("/");
1567         ftpState->flags.isdir = 1;
1568     }
1569
1570     ftpSendPassive(ftpState);
1571 }
1572
1573 static void
1574 ftpSendMdtm(Ftp::Gateway * ftpState)
1575 {
1576     /* check the server control channel is still available */
1577     if (!ftpState || !ftpState->haveControlChannel("ftpSendMdtm"))
1578         return;
1579
1580     assert(*ftpState->filepath != '\0');
1581     snprintf(cbuf, CTRL_BUFLEN, "MDTM %s\r\n", ftpState->filepath);
1582     ftpState->writeCommand(cbuf);
1583     ftpState->state = Ftp::Client::SENT_MDTM;
1584 }
1585
1586 static void
1587 ftpReadMdtm(Ftp::Gateway * ftpState)
1588 {
1589     int code = ftpState->ctrl.replycode;
1590     debugs(9, 3, HERE);
1591
1592     if (code == 213) {
1593         ftpState->mdtm = parse_iso3307_time(ftpState->ctrl.last_reply);
1594         ftpState->unhack();
1595     } else if (code < 0) {
1596         ftpFail(ftpState);
1597         return;
1598     }
1599
1600     ftpSendSize(ftpState);
1601 }
1602
1603 static void
1604 ftpSendSize(Ftp::Gateway * ftpState)
1605 {
1606     /* check the server control channel is still available */
1607     if (!ftpState || !ftpState->haveControlChannel("ftpSendSize"))
1608         return;
1609
1610     /* Only send SIZE for binary transfers. The returned size
1611      * is useless on ASCII transfers */
1612
1613     if (ftpState->flags.binary) {
1614         assert(ftpState->filepath != NULL);
1615         assert(*ftpState->filepath != '\0');
1616         snprintf(cbuf, CTRL_BUFLEN, "SIZE %s\r\n", ftpState->filepath);
1617         ftpState->writeCommand(cbuf);
1618         ftpState->state = Ftp::Client::SENT_SIZE;
1619     } else
1620         /* Skip to next state no non-binary transfers */
1621         ftpSendPassive(ftpState);
1622 }
1623
1624 static void
1625 ftpReadSize(Ftp::Gateway * ftpState)
1626 {
1627     int code = ftpState->ctrl.replycode;
1628     debugs(9, 3, HERE);
1629
1630     if (code == 213) {
1631         ftpState->unhack();
1632         ftpState->theSize = strtoll(ftpState->ctrl.last_reply, NULL, 10);
1633
1634         if (ftpState->theSize == 0) {
1635             debugs(9, 2, "SIZE reported " <<
1636                    ftpState->ctrl.last_reply << " on " <<
1637                    ftpState->title_url);
1638             ftpState->theSize = -1;
1639         }
1640     } else if (code < 0) {
1641         ftpFail(ftpState);
1642         return;
1643     }
1644
1645     ftpSendPassive(ftpState);
1646 }
1647
1648 static void
1649 ftpReadEPSV(Ftp::Gateway* ftpState)
1650 {
1651     Ip::Address srvAddr; // unused
1652     if (ftpState->handleEpsvReply(srvAddr)) {
1653         if (ftpState->ctrl.message == NULL)
1654             return; // didn't get complete reply yet
1655
1656         ftpState->connectDataChannel();
1657     }
1658 }
1659
1660 /** Send Passive connection request.
1661  * Default method is to use modern EPSV request.
1662  * The failover mechanism should check for previous state and re-call with alternates on failure.
1663  */
1664 static void
1665 ftpSendPassive(Ftp::Gateway * ftpState)
1666 {
1667     /** Checks the server control channel is still available before running. */
1668     if (!ftpState || !ftpState->haveControlChannel("ftpSendPassive"))
1669         return;
1670
1671     debugs(9, 3, HERE);
1672
1673     /** \par
1674       * Checks for 'HEAD' method request and passes off for special handling by Ftp::Gateway::processHeadResponse(). */
1675     if (ftpState->request->method == Http::METHOD_HEAD && (ftpState->flags.isdir || ftpState->theSize != -1)) {
1676         ftpState->processHeadResponse(); // may call serverComplete
1677         return;
1678     }
1679
1680     if (ftpState->sendPassive()) {
1681         // SENT_EPSV_ALL blocks other non-EPSV connections being attempted
1682         if (ftpState->state == Ftp::Client::SENT_EPSV_ALL)
1683             ftpState->flags.epsv_all_sent = true;
1684     }
1685 }
1686
1687 void
1688 Ftp::Gateway::processHeadResponse()
1689 {
1690     debugs(9, 5, HERE << "handling HEAD response");
1691     ftpSendQuit(this);
1692     appendSuccessHeader();
1693
1694     /*
1695      * On rare occasions I'm seeing the entry get aborted after
1696      * readControlReply() and before here, probably when
1697      * trying to write to the client.
1698      */
1699     if (EBIT_TEST(entry->flags, ENTRY_ABORTED)) {
1700         abortTransaction("entry aborted while processing HEAD");
1701         return;
1702     }
1703
1704 #if USE_ADAPTATION
1705     if (adaptationAccessCheckPending) {
1706         debugs(9,3, HERE << "returning due to adaptationAccessCheckPending");
1707         return;
1708     }
1709 #endif
1710
1711     // processReplyBody calls serverComplete() since there is no body
1712     processReplyBody();
1713 }
1714
1715 static void
1716 ftpReadPasv(Ftp::Gateway * ftpState)
1717 {
1718     Ip::Address srvAddr; // unused
1719     if (ftpState->handlePasvReply(srvAddr))
1720         ftpState->connectDataChannel();
1721     else {
1722         ftpSendEPRT(ftpState);
1723         return;
1724     }
1725 }
1726
1727 void
1728 Ftp::Gateway::dataChannelConnected(const CommConnectCbParams &io)
1729 {
1730     debugs(9, 3, HERE);
1731     data.opener = NULL;
1732
1733     if (io.flag != Comm::OK) {
1734         debugs(9, 2, HERE << "Failed to connect. Retrying via another method.");
1735
1736         // ABORT on timeouts. server may be waiting on a broken TCP link.
1737         if (io.xerrno == Comm::TIMEOUT)
1738             writeCommand("ABOR");
1739
1740         // try another connection attempt with some other method
1741         ftpSendPassive(this);
1742         return;
1743     }
1744
1745     data.opened(io.conn, dataCloser());
1746     ftpRestOrList(this);
1747 }
1748
1749 static void
1750 ftpOpenListenSocket(Ftp::Gateway * ftpState, int fallback)
1751 {
1752     /// Close old data channels, if any. We may open a new one below.
1753     if (ftpState->data.conn != NULL) {
1754         if ((ftpState->data.conn->flags & COMM_REUSEADDR))
1755             // NP: in fact it points to the control channel. just clear it.
1756             ftpState->data.clear();
1757         else
1758             ftpState->data.close();
1759     }
1760     safe_free(ftpState->data.host);
1761
1762     /*
1763      * Set up a listen socket on the same local address as the
1764      * control connection.
1765      */
1766     Comm::ConnectionPointer temp = new Comm::Connection;
1767     temp->local = ftpState->ctrl.conn->local;
1768
1769     /*
1770      * REUSEADDR is needed in fallback mode, since the same port is
1771      * used for both control and data.
1772      */
1773     if (fallback) {
1774         int on = 1;
1775         errno = 0;
1776         if (setsockopt(ftpState->ctrl.conn->fd, SOL_SOCKET, SO_REUSEADDR,
1777                        (char *) &on, sizeof(on)) == -1) {
1778             // SO_REUSEADDR is only an optimization, no need to be verbose about error
1779             debugs(9, 4, "setsockopt failed: " << xstrerror());
1780         }
1781         ftpState->ctrl.conn->flags |= COMM_REUSEADDR;
1782         temp->flags |= COMM_REUSEADDR;
1783     } else {
1784         /* if not running in fallback mode a new port needs to be retrieved */
1785         temp->local.port(0);
1786     }
1787
1788     ftpState->listenForDataChannel(temp);
1789 }
1790
1791 static void
1792 ftpSendPORT(Ftp::Gateway * ftpState)
1793 {
1794     /* check the server control channel is still available */
1795     if (!ftpState || !ftpState->haveControlChannel("ftpSendPort"))
1796         return;
1797
1798     if (Config.Ftp.epsv_all && ftpState->flags.epsv_all_sent) {
1799         debugs(9, DBG_IMPORTANT, "FTP does not allow PORT method after 'EPSV ALL' has been sent.");
1800         return;
1801     }
1802
1803     debugs(9, 3, HERE);
1804     ftpState->flags.pasv_supported = 0;
1805     ftpOpenListenSocket(ftpState, 0);
1806
1807     if (!Comm::IsConnOpen(ftpState->data.listenConn)) {
1808         if ( ftpState->data.listenConn != NULL && !ftpState->data.listenConn->local.isIPv4() ) {
1809             /* non-IPv4 CANNOT send PORT command.                       */
1810             /* we got here by attempting and failing an EPRT            */
1811             /* using the same reply code should simulate a PORT failure */
1812             ftpReadPORT(ftpState);
1813             return;
1814         }
1815
1816         /* XXX Need to set error message */
1817         ftpFail(ftpState);
1818         return;
1819     }
1820
1821     // pull out the internal IP address bytes to send in PORT command...
1822     // source them from the listen_conn->local
1823
1824     struct addrinfo *AI = NULL;
1825     ftpState->data.listenConn->local.getAddrInfo(AI, AF_INET);
1826     unsigned char *addrptr = (unsigned char *) &((struct sockaddr_in*)AI->ai_addr)->sin_addr;
1827     unsigned char *portptr = (unsigned char *) &((struct sockaddr_in*)AI->ai_addr)->sin_port;
1828     snprintf(cbuf, CTRL_BUFLEN, "PORT %d,%d,%d,%d,%d,%d\r\n",
1829              addrptr[0], addrptr[1], addrptr[2], addrptr[3],
1830              portptr[0], portptr[1]);
1831     ftpState->writeCommand(cbuf);
1832     ftpState->state = Ftp::Client::SENT_PORT;
1833
1834     Ip::Address::FreeAddr(AI);
1835 }
1836
1837 static void
1838 ftpReadPORT(Ftp::Gateway * ftpState)
1839 {
1840     int code = ftpState->ctrl.replycode;
1841     debugs(9, 3, HERE);
1842
1843     if (code != 200) {
1844         /* Fall back on using the same port as the control connection */
1845         debugs(9, 3, "PORT not supported by remote end");
1846         ftpOpenListenSocket(ftpState, 1);
1847     }
1848
1849     ftpRestOrList(ftpState);
1850 }
1851
1852 static void
1853 ftpSendEPRT(Ftp::Gateway * ftpState)
1854 {
1855     if (Config.Ftp.epsv_all && ftpState->flags.epsv_all_sent) {
1856         debugs(9, DBG_IMPORTANT, "FTP does not allow EPRT method after 'EPSV ALL' has been sent.");
1857         return;
1858     }
1859
1860     if (!Config.Ftp.eprt) {
1861         /* Disabled. Switch immediately to attempting old PORT command. */
1862         debugs(9, 3, "EPRT disabled by local administrator");
1863         ftpSendPORT(ftpState);
1864         return;
1865     }
1866
1867     debugs(9, 3, HERE);
1868     ftpState->flags.pasv_supported = 0;
1869
1870     ftpOpenListenSocket(ftpState, 0);
1871     debugs(9, 3, "Listening for FTP data connection with FD " << ftpState->data.conn);
1872     if (!Comm::IsConnOpen(ftpState->data.conn)) {
1873         /* XXX Need to set error message */
1874         ftpFail(ftpState);
1875         return;
1876     }
1877
1878     char buf[MAX_IPSTRLEN];
1879
1880     /* RFC 2428 defines EPRT as IPv6 equivalent to IPv4 PORT command. */
1881     /* Which can be used by EITHER protocol. */
1882     snprintf(cbuf, CTRL_BUFLEN, "EPRT |%d|%s|%d|\r\n",
1883              ( ftpState->data.listenConn->local.isIPv6() ? 2 : 1 ),
1884              ftpState->data.listenConn->local.toStr(buf,MAX_IPSTRLEN),
1885              ftpState->data.listenConn->local.port() );
1886
1887     ftpState->writeCommand(cbuf);
1888     ftpState->state = Ftp::Client::SENT_EPRT;
1889 }
1890
1891 static void
1892 ftpReadEPRT(Ftp::Gateway * ftpState)
1893 {
1894     int code = ftpState->ctrl.replycode;
1895     debugs(9, 3, HERE);
1896
1897     if (code != 200) {
1898         /* Failover to attempting old PORT command. */
1899         debugs(9, 3, "EPRT not supported by remote end");
1900         ftpSendPORT(ftpState);
1901         return;
1902     }
1903
1904     ftpRestOrList(ftpState);
1905 }
1906
1907 /** "read" handler to accept FTP data connections.
1908  *
1909  \param io    comm accept(2) callback parameters
1910  */
1911 void
1912 Ftp::Gateway::ftpAcceptDataConnection(const CommAcceptCbParams &io)
1913 {
1914     debugs(9, 3, HERE);
1915
1916     if (EBIT_TEST(entry->flags, ENTRY_ABORTED)) {
1917         abortTransaction("entry aborted when accepting data conn");
1918         data.listenConn->close();
1919         data.listenConn = NULL;
1920         return;
1921     }
1922
1923     if (io.flag != Comm::OK) {
1924         data.listenConn->close();
1925         data.listenConn = NULL;
1926         debugs(9, DBG_IMPORTANT, "FTP AcceptDataConnection: " << io.conn << ": " << xstrerr(io.xerrno));
1927         /** \todo Need to send error message on control channel*/
1928         ftpFail(this);
1929         return;
1930     }
1931
1932     /* data listening conn is no longer even open. abort. */
1933     if (!Comm::IsConnOpen(data.listenConn)) {
1934         data.listenConn = NULL; // ensure that it's cleared and not just closed.
1935         return;
1936     }
1937
1938     /* data listening conn is no longer even open. abort. */
1939     if (!Comm::IsConnOpen(data.conn)) {
1940         data.clear(); // ensure that it's cleared and not just closed.
1941         return;
1942     }
1943
1944     /** \par
1945      * When squid.conf ftp_sanitycheck is enabled, check the new connection is actually being
1946      * made by the remote client which is connected to the FTP control socket.
1947      * Or the one which we were told to listen for by control channel messages (may differ under NAT).
1948      * This prevents third-party hacks, but also third-party load balancing handshakes.
1949      */
1950     if (Config.Ftp.sanitycheck) {
1951         // accept if either our data or ctrl connection is talking to this remote peer.
1952         if (data.conn->remote != io.conn->remote && ctrl.conn->remote != io.conn->remote) {
1953             debugs(9, DBG_IMPORTANT,
1954                    "FTP data connection from unexpected server (" <<
1955                    io.conn->remote << "), expecting " <<
1956                    data.conn->remote << " or " << ctrl.conn->remote);
1957
1958             /* close the bad sources connection down ASAP. */
1959             io.conn->close();
1960
1961             /* drop the bad connection (io) by ignoring the attempt. */
1962             return;
1963         }
1964     }
1965
1966     /** On Comm::OK start using the accepted data socket and discard the temporary listen socket. */
1967     data.close();
1968     data.opened(io.conn, dataCloser());
1969     data.addr(io.conn->remote);
1970
1971     debugs(9, 3, HERE << "Connected data socket on " <<
1972            io.conn << ". FD table says: " <<
1973            "ctrl-peer= " << fd_table[ctrl.conn->fd].ipaddr << ", " <<
1974            "data-peer= " << fd_table[data.conn->fd].ipaddr);
1975
1976     assert(haveControlChannel("ftpAcceptDataConnection"));
1977     assert(ctrl.message == NULL);
1978
1979     // Ctrl channel operations will determine what happens to this data connection
1980 }
1981
1982 static void
1983 ftpRestOrList(Ftp::Gateway * ftpState)
1984 {
1985     debugs(9, 3, HERE);
1986
1987     if (ftpState->typecode == 'D') {
1988         ftpState->flags.isdir = 1;
1989
1990         if (ftpState->flags.put) {
1991             ftpSendMkdir(ftpState); /* PUT name;type=d */
1992         } else {
1993             ftpSendNlst(ftpState);  /* GET name;type=d  sec 3.2.2 of RFC 1738 */
1994         }
1995     } else if (ftpState->flags.put) {
1996         ftpSendStor(ftpState);
1997     } else if (ftpState->flags.isdir)
1998         ftpSendList(ftpState);
1999     else if (ftpState->restartable())
2000         ftpSendRest(ftpState);
2001     else
2002         ftpSendRetr(ftpState);
2003 }
2004
2005 static void
2006 ftpSendStor(Ftp::Gateway * ftpState)
2007 {
2008     /* check the server control channel is still available */
2009     if (!ftpState || !ftpState->haveControlChannel("ftpSendStor"))
2010         return;
2011
2012     debugs(9, 3, HERE);
2013
2014     if (ftpState->filepath != NULL) {
2015         /* Plain file upload */
2016         snprintf(cbuf, CTRL_BUFLEN, "STOR %s\r\n", ftpState->filepath);
2017         ftpState->writeCommand(cbuf);
2018         ftpState->state = Ftp::Client::SENT_STOR;
2019     } else if (ftpState->request->header.getInt64(Http::HdrType::CONTENT_LENGTH) > 0) {
2020         /* File upload without a filename. use STOU to generate one */
2021         snprintf(cbuf, CTRL_BUFLEN, "STOU\r\n");
2022         ftpState->writeCommand(cbuf);
2023         ftpState->state = Ftp::Client::SENT_STOR;
2024     } else {
2025         /* No file to transfer. Only create directories if needed */
2026         ftpSendReply(ftpState);
2027     }
2028 }
2029
2030 /// \deprecated use ftpState->readStor() instead.
2031 static void
2032 ftpReadStor(Ftp::Gateway * ftpState)
2033 {
2034     ftpState->readStor();
2035 }
2036
2037 void Ftp::Gateway::readStor()
2038 {
2039     int code = ctrl.replycode;
2040     debugs(9, 3, HERE);
2041
2042     if (code == 125 || (code == 150 && Comm::IsConnOpen(data.conn))) {
2043         if (!originalRequest()->body_pipe) {
2044             debugs(9, 3, "zero-size STOR?");
2045             state = WRITING_DATA; // make ftpWriteTransferDone() responsible
2046             dataComplete(); // XXX: keep in sync with doneSendingRequestBody()
2047             return;
2048         }
2049
2050         if (!startRequestBodyFlow()) { // register to receive body data
2051             ftpFail(this);
2052             return;
2053         }
2054
2055         /* When client status is 125, or 150 and the data connection is open, Begin data transfer. */
2056         debugs(9, 3, HERE << "starting data transfer");
2057         switchTimeoutToDataChannel();
2058         sendMoreRequestBody();
2059         fwd->dontRetry(true); // dont permit re-trying if the body was sent.
2060         state = WRITING_DATA;
2061         debugs(9, 3, HERE << "writing data channel");
2062     } else if (code == 150) {
2063         /* When client code is 150 with no data channel, Accept data channel. */
2064         debugs(9, 3, "ftpReadStor: accepting data channel");
2065         listenForDataChannel(data.conn);
2066     } else {
2067         debugs(9, DBG_IMPORTANT, HERE << "Unexpected reply code "<< std::setfill('0') << std::setw(3) << code);
2068         ftpFail(this);
2069     }
2070 }
2071
2072 static void
2073 ftpSendRest(Ftp::Gateway * ftpState)
2074 {
2075     /* check the server control channel is still available */
2076     if (!ftpState || !ftpState->haveControlChannel("ftpSendRest"))
2077         return;
2078
2079     debugs(9, 3, HERE);
2080
2081     snprintf(cbuf, CTRL_BUFLEN, "REST %" PRId64 "\r\n", ftpState->restart_offset);
2082     ftpState->writeCommand(cbuf);
2083     ftpState->state = Ftp::Client::SENT_REST;
2084 }
2085
2086 int
2087 Ftp::Gateway::restartable()
2088 {
2089     if (restart_offset > 0)
2090         return 1;
2091
2092     if (!request->range)
2093         return 0;
2094
2095     if (!flags.binary)
2096         return 0;
2097
2098     if (theSize <= 0)
2099         return 0;
2100
2101     int64_t desired_offset = request->range->lowestOffset(theSize);
2102
2103     if (desired_offset <= 0)
2104         return 0;
2105
2106     if (desired_offset >= theSize)
2107         return 0;
2108
2109     restart_offset = desired_offset;
2110     return 1;
2111 }
2112
2113 static void
2114 ftpReadRest(Ftp::Gateway * ftpState)
2115 {
2116     int code = ftpState->ctrl.replycode;
2117     debugs(9, 3, HERE);
2118     assert(ftpState->restart_offset > 0);
2119
2120     if (code == 350) {
2121         ftpState->setCurrentOffset(ftpState->restart_offset);
2122         ftpSendRetr(ftpState);
2123     } else if (code > 0) {
2124         debugs(9, 3, HERE << "REST not supported");
2125         ftpState->flags.rest_supported = 0;
2126         ftpSendRetr(ftpState);
2127     } else {
2128         ftpFail(ftpState);
2129     }
2130 }
2131
2132 static void
2133 ftpSendList(Ftp::Gateway * ftpState)
2134 {
2135     /* check the server control channel is still available */
2136     if (!ftpState || !ftpState->haveControlChannel("ftpSendList"))
2137         return;
2138
2139     debugs(9, 3, HERE);
2140
2141     if (ftpState->filepath) {
2142         snprintf(cbuf, CTRL_BUFLEN, "LIST %s\r\n", ftpState->filepath);
2143     } else {
2144         snprintf(cbuf, CTRL_BUFLEN, "LIST\r\n");
2145     }
2146
2147     ftpState->writeCommand(cbuf);
2148     ftpState->state = Ftp::Client::SENT_LIST;
2149 }
2150
2151 static void
2152 ftpSendNlst(Ftp::Gateway * ftpState)
2153 {
2154     /* check the server control channel is still available */
2155     if (!ftpState || !ftpState->haveControlChannel("ftpSendNlst"))
2156         return;
2157
2158     debugs(9, 3, HERE);
2159
2160     ftpState->flags.tried_nlst = 1;
2161
2162     if (ftpState->filepath) {
2163         snprintf(cbuf, CTRL_BUFLEN, "NLST %s\r\n", ftpState->filepath);
2164     } else {
2165         snprintf(cbuf, CTRL_BUFLEN, "NLST\r\n");
2166     }
2167
2168     ftpState->writeCommand(cbuf);
2169     ftpState->state = Ftp::Client::SENT_NLST;
2170 }
2171
2172 static void
2173 ftpReadList(Ftp::Gateway * ftpState)
2174 {
2175     int code = ftpState->ctrl.replycode;
2176     debugs(9, 3, HERE);
2177
2178     if (code == 125 || (code == 150 && Comm::IsConnOpen(ftpState->data.conn))) {
2179         /* Begin data transfer */
2180         debugs(9, 3, HERE << "begin data transfer from " << ftpState->data.conn->remote << " (" << ftpState->data.conn->local << ")");
2181         ftpState->switchTimeoutToDataChannel();
2182         ftpState->maybeReadVirginBody();
2183         ftpState->state = Ftp::Client::READING_DATA;
2184         return;
2185     } else if (code == 150) {
2186         /* Accept data channel */
2187         debugs(9, 3, HERE << "accept data channel from " << ftpState->data.conn->remote << " (" << ftpState->data.conn->local << ")");
2188         ftpState->listenForDataChannel(ftpState->data.conn);
2189         return;
2190     } else if (!ftpState->flags.tried_nlst && code > 300) {
2191         ftpSendNlst(ftpState);
2192     } else {
2193         ftpFail(ftpState);
2194         return;
2195     }
2196 }
2197
2198 static void
2199 ftpSendRetr(Ftp::Gateway * ftpState)
2200 {
2201     /* check the server control channel is still available */
2202     if (!ftpState || !ftpState->haveControlChannel("ftpSendRetr"))
2203         return;
2204
2205     debugs(9, 3, HERE);
2206
2207     assert(ftpState->filepath != NULL);
2208     snprintf(cbuf, CTRL_BUFLEN, "RETR %s\r\n", ftpState->filepath);
2209     ftpState->writeCommand(cbuf);
2210     ftpState->state = Ftp::Client::SENT_RETR;
2211 }
2212
2213 static void
2214 ftpReadRetr(Ftp::Gateway * ftpState)
2215 {
2216     int code = ftpState->ctrl.replycode;
2217     debugs(9, 3, HERE);
2218
2219     if (code == 125 || (code == 150 && Comm::IsConnOpen(ftpState->data.conn))) {
2220         /* Begin data transfer */
2221         debugs(9, 3, HERE << "begin data transfer from " << ftpState->data.conn->remote << " (" << ftpState->data.conn->local << ")");
2222         ftpState->switchTimeoutToDataChannel();
2223         ftpState->maybeReadVirginBody();
2224         ftpState->state = Ftp::Client::READING_DATA;
2225     } else if (code == 150) {
2226         /* Accept data channel */
2227         ftpState->listenForDataChannel(ftpState->data.conn);
2228     } else if (code >= 300) {
2229         if (!ftpState->flags.try_slash_hack) {
2230             /* Try this as a directory missing trailing slash... */
2231             ftpState->hackShortcut(ftpSendCwd);
2232         } else {
2233             ftpFail(ftpState);
2234         }
2235     } else {
2236         ftpFail(ftpState);
2237     }
2238 }
2239
2240 /**
2241  * Generate the HTTP headers and template fluff around an FTP
2242  * directory listing display.
2243  */
2244 void
2245 Ftp::Gateway::completedListing()
2246 {
2247     assert(entry);
2248     entry->lock("Ftp::Gateway");
2249     ErrorState ferr(ERR_DIR_LISTING, Http::scOkay, request);
2250     ferr.ftp.listing = &listing;
2251     ferr.ftp.cwd_msg = xstrdup(cwd_message.size()? cwd_message.termedBuf() : "");
2252     ferr.ftp.server_msg = ctrl.message;
2253     ctrl.message = NULL;
2254     entry->replaceHttpReply( ferr.BuildHttpReply() );
2255     EBIT_CLR(entry->flags, ENTRY_FWD_HDR_WAIT);
2256     entry->flush();
2257     entry->unlock("Ftp::Gateway");
2258 }
2259
2260 static void
2261 ftpReadTransferDone(Ftp::Gateway * ftpState)
2262 {
2263     int code = ftpState->ctrl.replycode;
2264     debugs(9, 3, HERE);
2265
2266     if (code == 226 || code == 250) {
2267         /* Connection closed; retrieval done. */
2268         if (ftpState->flags.listing) {
2269             ftpState->completedListing();
2270             /* QUIT operation handles sending the reply to client */
2271         }
2272         ftpSendQuit(ftpState);
2273     } else {            /* != 226 */
2274         debugs(9, DBG_IMPORTANT, HERE << "Got code " << code << " after reading data");
2275         ftpState->failed(ERR_FTP_FAILURE, 0);
2276         /* failed closes ctrl.conn and frees ftpState */
2277         return;
2278     }
2279 }
2280
2281 // premature end of the request body
2282 void
2283 Ftp::Gateway::handleRequestBodyProducerAborted()
2284 {
2285     Client::handleRequestBodyProducerAborted();
2286     debugs(9, 3, HERE << "ftpState=" << this);
2287     failed(ERR_READ_ERROR, 0);
2288 }
2289
2290 static void
2291 ftpWriteTransferDone(Ftp::Gateway * ftpState)
2292 {
2293     int code = ftpState->ctrl.replycode;
2294     debugs(9, 3, HERE);
2295
2296     if (!(code == 226 || code == 250)) {
2297         debugs(9, DBG_IMPORTANT, HERE << "Got code " << code << " after sending data");
2298         ftpState->failed(ERR_FTP_PUT_ERROR, 0);
2299         return;
2300     }
2301
2302     ftpState->entry->timestampsSet();   /* XXX Is this needed? */
2303     ftpSendReply(ftpState);
2304 }
2305
2306 static void
2307 ftpSendQuit(Ftp::Gateway * ftpState)
2308 {
2309     /* check the server control channel is still available */
2310     if (!ftpState || !ftpState->haveControlChannel("ftpSendQuit"))
2311         return;
2312
2313     snprintf(cbuf, CTRL_BUFLEN, "QUIT\r\n");
2314     ftpState->writeCommand(cbuf);
2315     ftpState->state = Ftp::Client::SENT_QUIT;
2316 }
2317
2318 /** Completes a client FTP operation with success or other page
2319  *  generated and stored in the entry field by the code issuing QUIT.
2320  */
2321 static void
2322 ftpReadQuit(Ftp::Gateway * ftpState)
2323 {
2324     ftpState->serverComplete();
2325 }
2326
2327 static void
2328 ftpTrySlashHack(Ftp::Gateway * ftpState)
2329 {
2330     char *path;
2331     ftpState->flags.try_slash_hack = 1;
2332     /* Free old paths */
2333
2334     debugs(9, 3, HERE);
2335
2336     if (ftpState->pathcomps)
2337         wordlistDestroy(&ftpState->pathcomps);
2338
2339     safe_free(ftpState->filepath);
2340
2341     /* Build the new path (urlpath begins with /) */
2342     path = SBufToCstring(ftpState->request->url.path());
2343
2344     rfc1738_unescape(path);
2345
2346     ftpState->filepath = path;
2347
2348     /* And off we go */
2349     ftpGetFile(ftpState);
2350 }
2351
2352 /**
2353  * Forget hack status. Next error is shown to the user
2354  */
2355 void
2356 Ftp::Gateway::unhack()
2357 {
2358     debugs(9, 3, HERE);
2359
2360     if (old_request != NULL) {
2361         safe_free(old_request);
2362         safe_free(old_reply);
2363     }
2364 }
2365
2366 void
2367 Ftp::Gateway::hackShortcut(FTPSM * nextState)
2368 {
2369     /* Clear some unwanted state */
2370     setCurrentOffset(0);
2371     restart_offset = 0;
2372     /* Save old error message & some state info */
2373
2374     debugs(9, 3, HERE);
2375
2376     if (old_request == NULL) {
2377         old_request = ctrl.last_command;
2378         ctrl.last_command = NULL;
2379         old_reply = ctrl.last_reply;
2380         ctrl.last_reply = NULL;
2381
2382         if (pathcomps == NULL && filepath != NULL)
2383             old_filepath = xstrdup(filepath);
2384     }
2385
2386     /* Jump to the "hack" state */
2387     nextState(this);
2388 }
2389
2390 static void
2391 ftpFail(Ftp::Gateway *ftpState)
2392 {
2393     const bool slashHack = ftpState->request->url.path().caseCmp("/%2f", 4)==0;
2394     int code = ftpState->ctrl.replycode;
2395     err_type error_code = ERR_NONE;
2396
2397     debugs(9, 6, "state " << ftpState->state <<
2398            " reply code " << code << "flags(" <<
2399            (ftpState->flags.isdir?"IS_DIR,":"") <<
2400            (ftpState->flags.try_slash_hack?"TRY_SLASH_HACK":"") << "), " <<
2401            "mdtm=" << ftpState->mdtm << ", size=" << ftpState->theSize <<
2402            "slashhack=" << (slashHack? "T":"F"));
2403
2404     /* Try the / hack to support "Netscape" FTP URL's for retreiving files */
2405     if (!ftpState->flags.isdir &&   /* Not a directory */
2406             !ftpState->flags.try_slash_hack && !slashHack && /* Not doing slash hack */
2407             ftpState->mdtm <= 0 && ftpState->theSize < 0) { /* Not known as a file */
2408
2409         switch (ftpState->state) {
2410
2411         case Ftp::Client::SENT_CWD:
2412
2413         case Ftp::Client::SENT_RETR:
2414             /* Try the / hack */
2415             ftpState->hackShortcut(ftpTrySlashHack);
2416             return;
2417
2418         default:
2419             break;
2420         }
2421     }
2422
2423     Http::StatusCode sc = ftpState->failedHttpStatus(error_code);
2424     ErrorState *ftperr = new ErrorState(error_code, sc, ftpState->fwd->request);
2425     ftpState->failed(error_code, code, ftperr);
2426     ftperr->detailError(code);
2427     HttpReply *newrep = ftperr->BuildHttpReply();
2428     delete ftperr;
2429
2430     ftpState->entry->replaceHttpReply(newrep);
2431     ftpSendQuit(ftpState);
2432 }
2433
2434 Http::StatusCode
2435 Ftp::Gateway::failedHttpStatus(err_type &error)
2436 {
2437     if (error == ERR_NONE) {
2438         switch (state) {
2439
2440         case SENT_USER:
2441
2442         case SENT_PASS:
2443
2444             if (ctrl.replycode > 500) {
2445                 error = ERR_FTP_FORBIDDEN;
2446                 return password_url ? Http::scForbidden : Http::scUnauthorized;
2447             } else if (ctrl.replycode == 421) {
2448                 error = ERR_FTP_UNAVAILABLE;
2449                 return Http::scServiceUnavailable;
2450             }
2451             break;
2452
2453         case SENT_CWD:
2454
2455         case SENT_RETR:
2456             if (ctrl.replycode == 550) {
2457                 error = ERR_FTP_NOT_FOUND;
2458                 return Http::scNotFound;
2459             }
2460             break;
2461
2462         default:
2463             break;
2464         }
2465     }
2466     return Ftp::Client::failedHttpStatus(error);
2467 }
2468
2469 static void
2470 ftpSendReply(Ftp::Gateway * ftpState)
2471 {
2472     int code = ftpState->ctrl.replycode;
2473     Http::StatusCode http_code;
2474     err_type err_code = ERR_NONE;
2475
2476     debugs(9, 3, HERE << ftpState->entry->url() << ", code " << code);
2477
2478     if (cbdataReferenceValid(ftpState))
2479         debugs(9, 5, HERE << "ftpState (" << ftpState << ") is valid!");
2480
2481     if (code == 226 || code == 250) {
2482         err_code = (ftpState->mdtm > 0) ? ERR_FTP_PUT_MODIFIED : ERR_FTP_PUT_CREATED;
2483         http_code = (ftpState->mdtm > 0) ? Http::scAccepted : Http::scCreated;
2484     } else if (code == 227) {
2485         err_code = ERR_FTP_PUT_CREATED;
2486         http_code = Http::scCreated;
2487     } else {
2488         err_code = ERR_FTP_PUT_ERROR;
2489         http_code = Http::scInternalServerError;
2490     }
2491
2492     ErrorState err(err_code, http_code, ftpState->request);
2493
2494     if (ftpState->old_request)
2495         err.ftp.request = xstrdup(ftpState->old_request);
2496     else
2497         err.ftp.request = xstrdup(ftpState->ctrl.last_command);
2498
2499     if (ftpState->old_reply)
2500         err.ftp.reply = xstrdup(ftpState->old_reply);
2501     else if (ftpState->ctrl.last_reply)
2502         err.ftp.reply = xstrdup(ftpState->ctrl.last_reply);
2503     else
2504         err.ftp.reply = xstrdup("");
2505
2506     // TODO: interpret as FTP-specific error code
2507     err.detailError(code);
2508
2509     ftpState->entry->replaceHttpReply( err.BuildHttpReply() );
2510
2511     ftpSendQuit(ftpState);
2512 }
2513
2514 void
2515 Ftp::Gateway::appendSuccessHeader()
2516 {
2517     debugs(9, 3, HERE);
2518
2519     if (flags.http_header_sent)
2520         return;
2521
2522     HttpReply *reply = new HttpReply;
2523
2524     flags.http_header_sent = 1;
2525
2526     assert(entry->isEmpty());
2527
2528     EBIT_CLR(entry->flags, ENTRY_FWD_HDR_WAIT);
2529
2530     entry->buffer();    /* released when done processing current data payload */
2531
2532     SBuf urlPath = request->url.path();
2533     auto t = urlPath.rfind('/');
2534     SBuf filename = urlPath.substr(t != SBuf::npos ? t : 0);
2535
2536     const char *mime_type = NULL;
2537     const char *mime_enc = NULL;
2538
2539     if (flags.isdir) {
2540         mime_type = "text/html";
2541     } else {
2542         switch (typecode) {
2543
2544         case 'I':
2545             mime_type = "application/octet-stream";
2546             // XXX: performance regression, c_str() may reallocate
2547             mime_enc = mimeGetContentEncoding(filename.c_str());
2548             break;
2549
2550         case 'A':
2551             mime_type = "text/plain";
2552             break;
2553
2554         default:
2555             // XXX: performance regression, c_str() may reallocate
2556             mime_type = mimeGetContentType(filename.c_str());
2557             mime_enc = mimeGetContentEncoding(filename.c_str());
2558             break;
2559         }
2560     }
2561
2562     /* set standard stuff */
2563
2564     if (0 == getCurrentOffset()) {
2565         /* Full reply */
2566         reply->setHeaders(Http::scOkay, "Gatewaying", mime_type, theSize, mdtm, -2);
2567     } else if (theSize < getCurrentOffset()) {
2568         /*
2569          * DPW 2007-05-04
2570          * offset should not be larger than theSize.  We should
2571          * not be seeing this condition any more because we'll only
2572          * send REST if we know the theSize and if it is less than theSize.
2573          */
2574         debugs(0,DBG_CRITICAL,HERE << "Whoops! " <<
2575                " current offset=" << getCurrentOffset() <<
2576                ", but theSize=" << theSize <<
2577                ".  assuming full content response");
2578         reply->setHeaders(Http::scOkay, "Gatewaying", mime_type, theSize, mdtm, -2);
2579     } else {
2580         /* Partial reply */
2581         HttpHdrRangeSpec range_spec;
2582         range_spec.offset = getCurrentOffset();
2583         range_spec.length = theSize - getCurrentOffset();
2584         reply->setHeaders(Http::scPartialContent, "Gatewaying", mime_type, theSize - getCurrentOffset(), mdtm, -2);
2585         httpHeaderAddContRange(&reply->header, range_spec, theSize);
2586     }
2587
2588     /* additional info */
2589     if (mime_enc)
2590         reply->header.putStr(Http::HdrType::CONTENT_ENCODING, mime_enc);
2591
2592     reply->sources |= HttpMsg::srcFtp;
2593     setVirginReply(reply);
2594     adaptOrFinalizeReply();
2595 }
2596
2597 void
2598 Ftp::Gateway::haveParsedReplyHeaders()
2599 {
2600     Client::haveParsedReplyHeaders();
2601
2602     StoreEntry *e = entry;
2603
2604     e->timestampsSet();
2605
2606     if (flags.authenticated) {
2607         /*
2608          * Authenticated requests can't be cached.
2609          */
2610         e->release();
2611     } else if (!EBIT_TEST(e->flags, RELEASE_REQUEST) && !getCurrentOffset()) {
2612         e->setPublicKey();
2613     } else {
2614         e->release();
2615     }
2616 }
2617
2618 HttpReply *
2619 Ftp::Gateway::ftpAuthRequired(HttpRequest * request, const char *realm)
2620 {
2621     ErrorState err(ERR_CACHE_ACCESS_DENIED, Http::scUnauthorized, request);
2622     HttpReply *newrep = err.BuildHttpReply();
2623 #if HAVE_AUTH_MODULE_BASIC
2624     /* add Authenticate header */
2625     newrep->header.putAuth("Basic", realm);
2626 #endif
2627     return newrep;
2628 }
2629
2630 const SBuf &
2631 Ftp::UrlWith2f(HttpRequest * request)
2632 {
2633     SBuf newbuf("%2f");
2634
2635     if (request->url.getScheme() != AnyP::PROTO_FTP) {
2636         static const SBuf nil;
2637         return nil;
2638     }
2639
2640     if (request->url.path()[0] == '/') {
2641         newbuf.append(request->url.path());
2642         request->url.path(newbuf);
2643     } else if (!request->url.path().startsWith(newbuf)) {
2644         newbuf.append(request->url.path().substr(1));
2645         request->url.path(newbuf);
2646     }
2647
2648     return request->effectiveRequestUri();
2649 }
2650
2651 void
2652 Ftp::Gateway::printfReplyBody(const char *fmt, ...)
2653 {
2654     va_list args;
2655     va_start (args, fmt);
2656     static char buf[4096];
2657     buf[0] = '\0';
2658     vsnprintf(buf, 4096, fmt, args);
2659     writeReplyBody(buf, strlen(buf));
2660     va_end(args);
2661 }
2662
2663 /**
2664  * Call this when there is data from the origin server
2665  * which should be sent to either StoreEntry, or to ICAP...
2666  */
2667 void
2668 Ftp::Gateway::writeReplyBody(const char *dataToWrite, size_t dataLength)
2669 {
2670     debugs(9, 5, HERE << "writing " << dataLength << " bytes to the reply");
2671     addVirginReplyBody(dataToWrite, dataLength);
2672 }
2673
2674 /**
2675  * A hack to ensure we do not double-complete on the forward entry.
2676  *
2677  \todo Ftp::Gateway logic should probably be rewritten to avoid
2678  *  double-completion or FwdState should be rewritten to allow it.
2679  */
2680 void
2681 Ftp::Gateway::completeForwarding()
2682 {
2683     if (fwd == NULL || flags.completed_forwarding) {
2684         debugs(9, 3, HERE << "completeForwarding avoids " <<
2685                "double-complete on FD " << ctrl.conn->fd << ", Data FD " << data.conn->fd <<
2686                ", this " << this << ", fwd " << fwd);
2687         return;
2688     }
2689
2690     flags.completed_forwarding = true;
2691     Client::completeForwarding();
2692 }
2693
2694 /**
2695  * Have we lost the FTP server control channel?
2696  *
2697  \retval true   The server control channel is available.
2698  \retval false  The server control channel is not available.
2699  */
2700 bool
2701 Ftp::Gateway::haveControlChannel(const char *caller_name) const
2702 {
2703     if (doneWithServer())
2704         return false;
2705
2706     /* doneWithServer() only checks BOTH channels are closed. */
2707     if (!Comm::IsConnOpen(ctrl.conn)) {
2708         debugs(9, DBG_IMPORTANT, "WARNING! FTP Server Control channel is closed, but Data channel still active.");
2709         debugs(9, 2, caller_name << ": attempted on a closed FTP channel.");
2710         return false;
2711     }
2712
2713     return true;
2714 }
2715
2716 bool
2717 Ftp::Gateway::mayReadVirginReplyBody() const
2718 {
2719     // TODO: Can we do what Ftp::Relay::mayReadVirginReplyBody() does instead?
2720     return !doneWithServer();
2721 }
2722
2723 AsyncJob::Pointer
2724 Ftp::StartGateway(FwdState *const fwdState)
2725 {
2726     return AsyncJob::Start(new Ftp::Gateway(fwdState));
2727 }
2728