2 * Copyright (c) 1998 Dag-Erling Coïdan Smørgrav
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * Portions of this code were taken from or based on ftpio.c:
34 * ----------------------------------------------------------------------------
35 * "THE BEER-WARE LICENSE" (Revision 42):
36 * <phk@login.dknet.dk> wrote this file. As long as you retain this notice you
37 * can do whatever you want with this stuff. If we meet some day, and you think
38 * this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp
39 * ----------------------------------------------------------------------------
43 * Dag-Erling Coïdan Smørgrav
46 * Incorporated into libfetch
51 * Turned inside out. Now returns xfers as new file ids, not as a special
54 * $ftpioId: ftpio.c,v 1.30 1998/04/11 07:28:53 phk Exp $
58 #include <sys/param.h>
59 #include <sys/socket.h>
60 #include <netinet/in.h>
78 #define FTP_ANONYMOUS_USER "anonymous"
80 #define FTP_CONNECTION_ALREADY_OPEN 125
81 #define FTP_OPEN_DATA_CONNECTION 150
83 #define FTP_FILE_STATUS 213
84 #define FTP_SERVICE_READY 220
85 #define FTP_TRANSFER_COMPLETE 226
86 #define FTP_PASSIVE_MODE 227
87 #define FTP_LPASSIVE_MODE 228
88 #define FTP_EPASSIVE_MODE 229
89 #define FTP_LOGGED_IN 230
90 #define FTP_FILE_ACTION_OK 250
91 #define FTP_NEED_PASSWORD 331
92 #define FTP_NEED_ACCOUNT 332
93 #define FTP_FILE_OK 350
94 #define FTP_SYNTAX_ERROR 500
95 #define FTP_PROTOCOL_ERROR 999
97 static struct url cached_host;
98 static int cached_socket;
100 static char *last_reply;
101 static size_t lr_size, lr_length;
102 static int last_code;
104 #define isftpreply(foo) (isdigit(foo[0]) && isdigit(foo[1]) \
106 && (foo[3] == ' ' || foo[3] == '\0'))
107 #define isftpinfo(foo) (isdigit(foo[0]) && isdigit(foo[1]) \
108 && isdigit(foo[2]) && foo[3] == '-')
110 /* translate IPv4 mapped IPv6 address to IPv4 address */
112 unmappedaddr(struct sockaddr_in6 *sin6)
114 struct sockaddr_in *sin4;
118 if (sin6->sin6_family != AF_INET6 ||
119 !IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr))
121 sin4 = (struct sockaddr_in *)sin6;
122 addr = *(u_int32_t *)&sin6->sin6_addr.s6_addr[12];
123 port = sin6->sin6_port;
124 memset(sin4, 0, sizeof(struct sockaddr_in));
125 sin4->sin_addr.s_addr = addr;
126 sin4->sin_port = port;
127 sin4->sin_family = AF_INET;
128 sin4->sin_len = sizeof(struct sockaddr_in);
132 * Get server response
137 if (_fetch_getln(cd, &last_reply, &lr_size, &lr_length) == -1) {
141 if (isftpinfo(last_reply)) {
142 while (lr_length && !isftpreply(last_reply)) {
143 if (_fetch_getln(cd, &last_reply, &lr_size, &lr_length) == -1) {
150 while (lr_length && isspace(last_reply[lr_length-1]))
152 last_reply[lr_length] = 0;
154 if (!isftpreply(last_reply)) {
155 _ftp_seterr(FTP_PROTOCOL_ERROR);
159 last_code = (last_reply[0] - '0') * 100
160 + (last_reply[1] - '0') * 10
161 + (last_reply[2] - '0');
167 * Send a command and check reply
170 _ftp_cmd(int cd, const char *fmt, ...)
178 len = vasprintf(&msg, fmt, ap);
187 r = _fetch_putln(cd, msg, len);
195 return _ftp_chkerr(cd);
199 * Return a pointer to the filename part of a path
202 _ftp_filename(const char *file)
206 if ((s = strrchr(file, '/')) == NULL)
213 * Change working directory to the directory that contains the
217 _ftp_cwd(int cd, const char *file)
222 if ((s = strrchr(file, '/')) == NULL || s == file) {
223 e = _ftp_cmd(cd, "CWD /");
225 e = _ftp_cmd(cd, "CWD %.*s", s - file, file);
227 if (e != FTP_FILE_ACTION_OK) {
235 * Request and parse file stats
238 _ftp_stat(int cd, const char *file, struct url_stat *us)
247 us->atime = us->mtime = 0;
249 if ((s = strrchr(file, '/')) == NULL)
254 if ((e = _ftp_cmd(cd, "SIZE %s", s)) != FTP_FILE_STATUS) {
258 for (ln = last_reply + 4; *ln && isspace(*ln); ln++)
260 for (us->size = 0; *ln && isdigit(*ln); ln++)
261 us->size = us->size * 10 + *ln - '0';
262 if (*ln && !isspace(*ln)) {
263 _ftp_seterr(FTP_PROTOCOL_ERROR);
269 DEBUG(fprintf(stderr, "size: [\033[1m%lld\033[m]\n", us->size));
271 if ((e = _ftp_cmd(cd, "MDTM %s", s)) != FTP_FILE_STATUS) {
275 for (ln = last_reply + 4; *ln && isspace(*ln); ln++)
277 switch (strspn(ln, "0123456789")) {
286 _ftp_seterr(FTP_PROTOCOL_ERROR);
289 if (sscanf(ln, "%04d%02d%02d%02d%02d%02d",
290 &tm.tm_year, &tm.tm_mon, &tm.tm_mday,
291 &tm.tm_hour, &tm.tm_min, &tm.tm_sec) != 6) {
292 _ftp_seterr(FTP_PROTOCOL_ERROR);
303 DEBUG(fprintf(stderr, "last modified: [\033[1m%04d-%02d-%02d "
304 "%02d:%02d:%02d\033[m]\n",
305 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday,
306 tm.tm_hour, tm.tm_min, tm.tm_sec));
311 * I/O functions for FTP
314 int csd; /* Control socket descriptor */
315 int dsd; /* Data socket descriptor */
316 int dir; /* Direction */
317 int eof; /* EOF reached */
318 int err; /* Error code */
321 static int _ftp_readfn(void *, char *, int);
322 static int _ftp_writefn(void *, const char *, int);
323 static fpos_t _ftp_seekfn(void *, fpos_t, int);
324 static int _ftp_closefn(void *);
327 _ftp_readfn(void *v, char *buf, int len)
332 io = (struct ftpio *)v;
337 if (io->csd == -1 || io->dsd == -1 || io->dir == O_WRONLY) {
347 r = read(io->dsd, buf, len);
360 _ftp_writefn(void *v, const char *buf, int len)
365 io = (struct ftpio *)v;
370 if (io->csd == -1 || io->dsd == -1 || io->dir == O_RDONLY) {
378 w = write(io->dsd, buf, len);
387 _ftp_seekfn(void *v, fpos_t pos, int whence)
391 io = (struct ftpio *)v;
401 _ftp_closefn(void *v)
406 io = (struct ftpio *)v;
413 if (io->csd == -1 || io->dsd == -1) {
420 DEBUG(fprintf(stderr, "Waiting for final status\n"));
421 r = _ftp_chkerr(io->csd);
424 return (r == FTP_TRANSFER_COMPLETE) ? 0 : -1;
428 _ftp_setup(int csd, int dsd, int mode)
433 if ((io = malloc(sizeof *io)) == NULL)
438 io->eof = io->err = 0;
439 f = funopen(io, _ftp_readfn, _ftp_writefn, _ftp_seekfn, _ftp_closefn);
449 _ftp_transfer(int cd, const char *oper, const char *file,
450 int mode, off_t offset, const char *flags)
452 struct sockaddr_storage sin;
453 struct sockaddr_in6 *sin6;
454 struct sockaddr_in *sin4;
455 int low, pasv, verbose;
462 low = CHECK_FLAG('l');
463 pasv = CHECK_FLAG('p');
464 verbose = CHECK_FLAG('v');
468 pasv = ((s = getenv("FTP_PASSIVE_MODE")) != NULL &&
469 strncasecmp(s, "no", 2) != 0);
471 /* find our own address, bind, and listen */
473 if (getsockname(cd, (struct sockaddr *)&sin, &l) == -1)
475 if (sin.ss_family == AF_INET6)
476 unmappedaddr((struct sockaddr_in6 *)&sin);
478 /* open data socket */
479 if ((sd = socket(sin.ss_family, SOCK_STREAM, IPPROTO_TCP)) == -1) {
490 /* send PASV command */
492 _fetch_info("setting passive mode");
493 switch (sin.ss_family) {
495 if ((e = _ftp_cmd(cd, "PASV")) != FTP_PASSIVE_MODE)
499 if ((e = _ftp_cmd(cd, "EPSV")) != FTP_EPASSIVE_MODE) {
502 if ((e = _ftp_cmd(cd, "LPSV")) != FTP_LPASSIVE_MODE)
507 e = FTP_PROTOCOL_ERROR; /* XXX: error code should be prepared */
512 * Find address and port number. The reply to the PASV command
513 * is IMHO the one and only weak point in the FTP protocol.
517 case FTP_PASSIVE_MODE:
518 case FTP_LPASSIVE_MODE:
519 for (p = ln + 3; *p && !isdigit(*p); p++)
522 e = FTP_PROTOCOL_ERROR;
525 l = (e == FTP_PASSIVE_MODE ? 6 : 21);
526 for (i = 0; *p && i < l; i++, p++)
527 addr[i] = strtol(p, &p, 10);
529 e = FTP_PROTOCOL_ERROR;
533 case FTP_EPASSIVE_MODE:
534 for (p = ln + 3; *p && *p != '('; p++)
537 e = FTP_PROTOCOL_ERROR;
541 if (sscanf(p, "%c%c%c%d%c", &addr[0], &addr[1], &addr[2],
542 &port, &addr[3]) != 5 ||
543 addr[0] != addr[1] ||
544 addr[0] != addr[2] || addr[0] != addr[3]) {
545 e = FTP_PROTOCOL_ERROR;
551 /* seek to required offset */
553 if (_ftp_cmd(cd, "REST %lu", (u_long)offset) != FTP_FILE_OK)
556 /* construct sockaddr for data socket */
558 if (getpeername(cd, (struct sockaddr *)&sin, &l) == -1)
560 if (sin.ss_family == AF_INET6)
561 unmappedaddr((struct sockaddr_in6 *)&sin);
562 switch (sin.ss_family) {
564 sin6 = (struct sockaddr_in6 *)&sin;
565 if (e == FTP_EPASSIVE_MODE)
566 sin6->sin6_port = htons(port);
568 bcopy(addr + 2, (char *)&sin6->sin6_addr, 16);
569 bcopy(addr + 19, (char *)&sin6->sin6_port, 2);
573 sin4 = (struct sockaddr_in *)&sin;
574 if (e == FTP_EPASSIVE_MODE)
575 sin4->sin_port = htons(port);
577 bcopy(addr, (char *)&sin4->sin_addr, 4);
578 bcopy(addr + 4, (char *)&sin4->sin_port, 2);
582 e = FTP_PROTOCOL_ERROR; /* XXX: error code should be prepared */
586 /* connect to data port */
588 _fetch_info("opening data connection");
589 if (connect(sd, (struct sockaddr *)&sin, sin.ss_len) == -1)
592 /* make the server initiate the transfer */
594 _fetch_info("initiating transfer");
595 e = _ftp_cmd(cd, "%s %s", oper, _ftp_filename(file));
596 if (e != FTP_CONNECTION_ALREADY_OPEN && e != FTP_OPEN_DATA_CONNECTION)
604 char hname[INET6_ADDRSTRLEN];
606 switch (sin.ss_family) {
608 ((struct sockaddr_in6 *)&sin)->sin6_port = 0;
609 #ifdef IPV6_PORTRANGE
610 arg = low ? IPV6_PORTRANGE_DEFAULT : IPV6_PORTRANGE_HIGH;
611 if (setsockopt(sd, IPPROTO_IPV6, IPV6_PORTRANGE,
612 (char *)&arg, sizeof(arg)) == -1)
617 ((struct sockaddr_in *)&sin)->sin_port = 0;
618 arg = low ? IP_PORTRANGE_DEFAULT : IP_PORTRANGE_HIGH;
619 if (setsockopt(sd, IPPROTO_IP, IP_PORTRANGE,
620 (char *)&arg, sizeof arg) == -1)
625 _fetch_info("binding data socket");
626 if (bind(sd, (struct sockaddr *)&sin, sin.ss_len) == -1)
628 if (listen(sd, 1) == -1)
631 /* find what port we're on and tell the server */
632 if (getsockname(sd, (struct sockaddr *)&sin, &l) == -1)
634 switch (sin.ss_family) {
636 sin4 = (struct sockaddr_in *)&sin;
637 a = ntohl(sin4->sin_addr.s_addr);
638 p = ntohs(sin4->sin_port);
639 e = _ftp_cmd(cd, "PORT %d,%d,%d,%d,%d,%d",
640 (a >> 24) & 0xff, (a >> 16) & 0xff,
641 (a >> 8) & 0xff, a & 0xff,
642 (p >> 8) & 0xff, p & 0xff);
645 #define UC(b) (((int)b)&0xff)
647 sin6 = (struct sockaddr_in6 *)&sin;
648 if (getnameinfo((struct sockaddr *)&sin, sin.ss_len,
649 hname, sizeof(hname),
650 NULL, 0, NI_NUMERICHOST) == 0) {
651 e = _ftp_cmd(cd, "EPRT |%d|%s|%d|", 2, hname,
652 htons(sin6->sin6_port));
657 ap = (char *)&sin6->sin6_addr;
659 "LPRT %d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d,%d",
661 UC(ap[0]), UC(ap[1]), UC(ap[2]), UC(ap[3]),
662 UC(ap[4]), UC(ap[5]), UC(ap[6]), UC(ap[7]),
663 UC(ap[8]), UC(ap[9]), UC(ap[10]), UC(ap[11]),
664 UC(ap[12]), UC(ap[13]), UC(ap[14]), UC(ap[15]),
666 (ntohs(sin6->sin6_port) >> 8) & 0xff,
667 ntohs(sin6->sin6_port) & 0xff);
671 e = FTP_PROTOCOL_ERROR; /* XXX: error code should be prepared */
677 /* seek to required offset */
679 if (_ftp_cmd(cd, "REST %lu", (u_long)offset) != FTP_FILE_OK)
682 /* make the server initiate the transfer */
684 _fetch_info("initiating transfer");
685 e = _ftp_cmd(cd, "%s %s", oper, _ftp_filename(file));
686 if (e != FTP_OPEN_DATA_CONNECTION)
689 /* accept the incoming connection and go to town */
690 if ((d = accept(sd, NULL, NULL)) == -1)
696 if ((df = _ftp_setup(cd, sd, mode)) == NULL)
718 _ftp_authenticate(int cd, struct url *url, struct url *purl)
720 char *user, *pwd, *logname;
721 char pbuf[MAXHOSTNAMELEN + MAXLOGNAME + 1];
724 /* XXX FTP_AUTH, and maybe .netrc */
726 /* send user name and password */
729 user = getenv("FTP_LOGIN");
731 user = FTP_ANONYMOUS_USER;
732 if (purl && url->port == _fetch_default_port(url->scheme))
733 e = _ftp_cmd(cd, "USER %s@%s", user, url->host);
735 e = _ftp_cmd(cd, "USER %s@%s@%d", user, url->host, url->port);
737 e = _ftp_cmd(cd, "USER %s", user);
739 /* did the server request a password? */
740 if (e == FTP_NEED_PASSWORD) {
743 pwd = getenv("FTP_PASSWORD");
745 if ((logname = getlogin()) == 0)
746 logname = FTP_ANONYMOUS_USER;
747 len = snprintf(pbuf, MAXLOGNAME + 1, "%s@", logname);
748 gethostname(pbuf + len, sizeof pbuf - len);
751 e = _ftp_cmd(cd, "PASS %s", pwd);
758 * Log on to FTP server
761 _ftp_connect(struct url *url, struct url *purl, const char *flags)
763 int cd, e, direct, verbose;
770 direct = CHECK_FLAG('d');
771 verbose = CHECK_FLAG('v');
774 else if (CHECK_FLAG('6'))
780 /* check for proxy */
782 /* XXX proxy authentication! */
783 cd = _fetch_connect(purl->host, purl->port, af, verbose);
785 /* no proxy, go straight to target */
786 cd = _fetch_connect(url->host, url->port, af, verbose);
790 /* check connection */
796 /* expect welcome message */
797 if ((e = _ftp_chkerr(cd)) != FTP_SERVICE_READY)
801 if ((e = _ftp_authenticate(cd, url, purl)) != FTP_LOGGED_IN)
804 /* might as well select mode and type at once */
805 #ifdef FTP_FORCE_STREAM_MODE
806 if ((e = _ftp_cmd(cd, "MODE S")) != FTP_OK) /* default is S */
809 if ((e = _ftp_cmd(cd, "TYPE I")) != FTP_OK) /* default is A */
823 * Disconnect from server
826 _ftp_disconnect(int cd)
828 (void)_ftp_cmd(cd, "QUIT");
833 * Check if we're already connected
836 _ftp_isconnected(struct url *url)
838 return (cached_socket
839 && (strcmp(url->host, cached_host.host) == 0)
840 && (strcmp(url->user, cached_host.user) == 0)
841 && (strcmp(url->pwd, cached_host.pwd) == 0)
842 && (url->port == cached_host.port));
846 * Check the cache, reconnect if no luck
849 _ftp_cached_connect(struct url *url, struct url *purl, const char *flags)
855 /* set default port */
857 url->port = _fetch_default_port(url->scheme);
859 /* try to use previously cached connection */
860 if (_ftp_isconnected(url)) {
861 e = _ftp_cmd(cached_socket, "NOOP");
862 if (e == FTP_OK || e == FTP_SYNTAX_ERROR)
863 return cached_socket;
866 /* connect to server */
867 if ((cd = _ftp_connect(url, purl, flags)) == -1)
870 _ftp_disconnect(cached_socket);
872 memcpy(&cached_host, url, sizeof *url);
877 * Check the proxy settings
885 if (((p = getenv("FTP_PROXY")) || (p = getenv("ftp_proxy")) ||
886 (p = getenv("HTTP_PROXY")) || (p = getenv("http_proxy"))) &&
887 *p && (purl = fetchParseURL(p)) != NULL) {
888 if (!*purl->scheme) {
889 if (getenv("FTP_PROXY") || getenv("ftp_proxy"))
890 strcpy(purl->scheme, SCHEME_FTP);
892 strcpy(purl->scheme, SCHEME_HTTP);
895 purl->port = _fetch_default_proxy_port(purl->scheme);
896 if (strcasecmp(purl->scheme, SCHEME_FTP) == 0 ||
897 strcasecmp(purl->scheme, SCHEME_HTTP) == 0)
908 fetchXGetFTP(struct url *url, struct url_stat *us, const char *flags)
913 /* get the proxy URL, and check if we should use HTTP instead */
914 if (!CHECK_FLAG('d') && (purl = _ftp_get_proxy()) != NULL) {
915 if (strcasecmp(purl->scheme, SCHEME_HTTP) == 0)
916 return _http_request(url, "GET", us, purl, flags);
921 /* connect to server */
922 cd = _ftp_cached_connect(url, purl, flags);
928 /* change directory */
929 if (_ftp_cwd(cd, url->doc) == -1)
933 if (us && _ftp_stat(cd, url->doc, us) == -1
934 && fetchLastErrCode != FETCH_PROTO
935 && fetchLastErrCode != FETCH_UNAVAIL)
938 /* initiate the transfer */
939 return _ftp_transfer(cd, "RETR", url->doc, O_RDONLY, url->offset, flags);
946 fetchGetFTP(struct url *url, const char *flags)
948 return fetchXGetFTP(url, NULL, flags);
955 fetchPutFTP(struct url *url, const char *flags)
960 /* get the proxy URL, and check if we should use HTTP instead */
961 if (!CHECK_FLAG('d') && (purl = _ftp_get_proxy()) != NULL) {
962 if (strcasecmp(purl->scheme, SCHEME_HTTP) == 0)
963 /* XXX HTTP PUT is not implemented, so try without the proxy */
969 /* connect to server */
970 cd = _ftp_cached_connect(url, purl, flags);
976 /* change directory */
977 if (_ftp_cwd(cd, url->doc) == -1)
980 /* initiate the transfer */
981 return _ftp_transfer(cd, CHECK_FLAG('a') ? "APPE" : "STOR",
982 url->doc, O_WRONLY, url->offset, flags);
989 fetchStatFTP(struct url *url, struct url_stat *us, const char *flags)
994 /* get the proxy URL, and check if we should use HTTP instead */
995 if (!CHECK_FLAG('d') && (purl = _ftp_get_proxy()) != NULL) {
996 if (strcasecmp(purl->scheme, SCHEME_HTTP) == 0) {
999 if ((f = _http_request(url, "HEAD", us, purl, flags)) == NULL)
1008 /* connect to server */
1009 cd = _ftp_cached_connect(url, purl, flags);
1015 /* change directory */
1016 if (_ftp_cwd(cd, url->doc) == -1)
1020 return _ftp_stat(cd, url->doc, us);
1027 fetchListFTP(struct url *url, const char *flags)
1029 warnx("fetchListFTP(): not implemented");