2 * Copyright (c) 1998-2004 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.
28 * $FreeBSD: src/lib/libfetch/common.c,v 1.56 2008/04/15 23:29:51 cperciva Exp $
31 #include <sys/param.h>
32 #include <sys/socket.h>
36 #include <netinet/in.h>
53 /*** Local data **************************************************************/
56 * Error messages for resolver errors
58 static struct fetcherr netdb_errlist[] = {
60 { EAI_NODATA, FETCH_RESOLV, "Host not found" },
62 { EAI_AGAIN, FETCH_TEMP, "Transient resolver failure" },
63 { EAI_FAIL, FETCH_RESOLV, "Non-recoverable resolver failure" },
64 { EAI_NONAME, FETCH_RESOLV, "No address record" },
65 { -1, FETCH_UNKNOWN, "Unknown resolver error" }
69 static const char ENDL[2] = "\r\n";
72 /*** Error-reporting functions ***********************************************/
75 * Map error code to string
77 static struct fetcherr *
78 fetch_finderr(struct fetcherr *p, int e)
80 while (p->num != -1 && p->num != e)
89 fetch_seterr(struct fetcherr *p, int e)
91 p = fetch_finderr(p, e);
92 fetchLastErrCode = p->cat;
93 snprintf(fetchLastErrString, MAXERRSTRING, "%s", p->string);
97 * Set error code according to errno
104 fetchLastErrCode = FETCH_OK;
111 fetchLastErrCode = FETCH_AUTH;
114 case EISDIR: /* XXX */
115 fetchLastErrCode = FETCH_UNAVAIL;
118 fetchLastErrCode = FETCH_MEMORY;
122 fetchLastErrCode = FETCH_TEMP;
125 fetchLastErrCode = FETCH_EXISTS;
128 fetchLastErrCode = FETCH_FULL;
136 fetchLastErrCode = FETCH_NETWORK;
140 fetchLastErrCode = FETCH_ABORT;
143 fetchLastErrCode = FETCH_TIMEOUT;
147 fetchLastErrCode = FETCH_DOWN;
150 fetchLastErrCode = FETCH_UNKNOWN;
152 snprintf(fetchLastErrString, MAXERRSTRING, "%s", strerror(errno));
157 * Emit status message
160 fetch_info(const char *fmt, ...)
165 vfprintf(stderr, fmt, ap);
171 /*** Network-related utility functions ***************************************/
174 * Return the default port for a scheme
177 fetch_default_port(const char *scheme)
181 if ((se = getservbyname(scheme, "tcp")) != NULL)
182 return (ntohs(se->s_port));
183 if (strcasecmp(scheme, SCHEME_FTP) == 0)
184 return (FTP_DEFAULT_PORT);
185 if (strcasecmp(scheme, SCHEME_HTTP) == 0)
186 return (HTTP_DEFAULT_PORT);
191 * Return the default proxy port for a scheme
194 fetch_default_proxy_port(const char *scheme)
196 if (strcasecmp(scheme, SCHEME_FTP) == 0)
197 return (FTP_DEFAULT_PROXY_PORT);
198 if (strcasecmp(scheme, SCHEME_HTTP) == 0)
199 return (HTTP_DEFAULT_PROXY_PORT);
205 * Create a connection for an existing descriptor.
212 /* allocate and fill connection structure */
213 if ((conn = calloc(1, sizeof(*conn))) == NULL)
215 fcntl(sd, F_SETFD, FD_CLOEXEC);
223 * Bump a connection's reference count.
226 fetch_ref(conn_t *conn)
235 * Bind a socket to a specific local address
238 fetch_bind(int sd, int af, const char *addr)
240 struct addrinfo hints, *res, *res0;
243 memset(&hints, 0, sizeof(hints));
244 hints.ai_family = af;
245 hints.ai_socktype = SOCK_STREAM;
246 hints.ai_protocol = 0;
247 if ((err = getaddrinfo(addr, NULL, &hints, &res0)) != 0)
249 for (res = res0; res; res = res->ai_next)
250 if (bind(sd, res->ai_addr, res->ai_addrlen) == 0)
257 * Establish a TCP connection to the specified port on the specified host.
260 fetch_connect(const char *host, int port, int af, int verbose)
264 const char *bindaddr;
265 struct addrinfo hints, *res, *res0;
268 DEBUG(fprintf(stderr, "---> %s:%d\n", host, port));
271 fetch_info("looking up %s", host);
273 /* look up host name and set up socket address structure */
274 snprintf(pbuf, sizeof(pbuf), "%d", port);
275 memset(&hints, 0, sizeof(hints));
276 hints.ai_family = af;
277 hints.ai_socktype = SOCK_STREAM;
278 hints.ai_protocol = 0;
279 if ((err = getaddrinfo(host, pbuf, &hints, &res0)) != 0) {
283 bindaddr = getenv("FETCH_BIND_ADDRESS");
286 fetch_info("connecting to %s:%d", host, port);
289 for (sd = -1, res = res0; res; sd = -1, res = res->ai_next) {
290 if ((sd = socket(res->ai_family, res->ai_socktype,
291 res->ai_protocol)) == -1)
293 if (bindaddr != NULL && *bindaddr != '\0' &&
294 fetch_bind(sd, res->ai_family, bindaddr) != 0) {
295 fetch_info("failed to bind to '%s'", bindaddr);
299 if (connect(sd, res->ai_addr, res->ai_addrlen) == 0 &&
300 fcntl(sd, F_SETFL, O_NONBLOCK) == 0)
310 if ((conn = fetch_reopen(sd)) == NULL) {
319 * Enable SSL on a connection.
322 fetch_ssl(conn_t *conn, int verbose)
327 /* Init the SSL library and context */
328 if (!SSL_library_init()){
329 fprintf(stderr, "SSL library init failed\n");
333 SSL_load_error_strings();
335 conn->ssl_meth = SSLv23_client_method();
336 conn->ssl_ctx = SSL_CTX_new(conn->ssl_meth);
337 SSL_CTX_set_mode(conn->ssl_ctx, SSL_MODE_AUTO_RETRY);
339 conn->ssl = SSL_new(conn->ssl_ctx);
340 if (conn->ssl == NULL){
341 fprintf(stderr, "SSL context creation failed\n");
344 SSL_set_fd(conn->ssl, conn->sd);
345 while ((ret = SSL_connect(conn->ssl)) == -1) {
346 ssl_err = SSL_get_error(conn->ssl, ret);
347 if (ssl_err != SSL_ERROR_WANT_READ &&
348 ssl_err != SSL_ERROR_WANT_WRITE) {
349 ERR_print_errors_fp(stderr);
358 fprintf(stderr, "SSL connection established using %s\n",
359 SSL_get_cipher(conn->ssl));
360 conn->ssl_cert = SSL_get_peer_certificate(conn->ssl);
361 name = X509_get_subject_name(conn->ssl_cert);
362 str = X509_NAME_oneline(name, 0, 0);
363 printf("Certificate subject: %s\n", str);
365 name = X509_get_issuer_name(conn->ssl_cert);
366 str = X509_NAME_oneline(name, 0, 0);
367 printf("Certificate issuer: %s\n", str);
375 fprintf(stderr, "SSL support disabled\n");
380 #define FETCH_READ_WAIT -2
381 #define FETCH_READ_ERROR -1
382 #define FETCH_READ_DONE 0
386 fetch_ssl_read(SSL *ssl, char *buf, size_t len)
391 rlen = SSL_read(ssl, buf, len);
393 ssl_err = SSL_get_error(ssl, rlen);
394 if (ssl_err == SSL_ERROR_WANT_READ ||
395 ssl_err == SSL_ERROR_WANT_WRITE) {
396 return (FETCH_READ_WAIT);
398 ERR_print_errors_fp(stderr);
399 return (FETCH_READ_ERROR);
407 fetch_socket_read(int sd, char *buf, size_t len)
411 rlen = read(sd, buf, len);
413 if (errno == EAGAIN || (errno == EINTR && fetchRestartCalls))
414 return (FETCH_READ_WAIT);
416 return (FETCH_READ_ERROR);
422 * Read a character from a connection w/ timeout
425 fetch_read(conn_t *conn, char *buf, size_t len)
427 struct timeval now, timeout, delta;
434 gettimeofday(&timeout, NULL);
435 timeout.tv_sec += fetchTimeout;
441 * The socket is non-blocking. Instead of the canonical
442 * select() -> read(), we do the following:
444 * 1) call read() or SSL_read().
445 * 2) if an error occurred, return -1.
446 * 3) if we received data but we still expect more,
447 * update our counters and loop.
448 * 4) if read() or SSL_read() signaled EOF, return.
449 * 5) if we did not receive any data but we're not at EOF,
452 * In the SSL case, this is necessary because if we
453 * receive a close notification, we have to call
454 * SSL_read() one additional time after we've read
455 * everything we received.
457 * In the non-SSL case, it may improve performance (very
458 * slightly) when reading small amounts of data.
461 if (conn->ssl != NULL)
462 rlen = fetch_ssl_read(conn->ssl, buf, len);
465 rlen = fetch_socket_read(conn->sd, buf, len);
468 } else if (rlen > 0) {
473 } else if (rlen == FETCH_READ_ERROR) {
476 // assert(rlen == FETCH_READ_WAIT);
477 while (fetchTimeout && !FD_ISSET(conn->sd, &readfds)) {
478 FD_SET(conn->sd, &readfds);
479 gettimeofday(&now, NULL);
480 delta.tv_sec = timeout.tv_sec - now.tv_sec;
481 delta.tv_usec = timeout.tv_usec - now.tv_usec;
482 if (delta.tv_usec < 0) {
483 delta.tv_usec += 1000000;
486 if (delta.tv_sec < 0) {
492 r = select(conn->sd + 1, &readfds, NULL, NULL, &delta);
494 if (errno == EINTR && fetchRestartCalls)
506 * Read a line of text from a connection w/ timeout
508 #define MIN_BUF_SIZE 1024
511 fetch_getln(conn_t *conn)
518 if (conn->buf == NULL) {
519 if ((conn->buf = malloc(MIN_BUF_SIZE)) == NULL) {
523 conn->bufsize = MIN_BUF_SIZE;
530 len = fetch_read(conn, &c, 1);
535 conn->buf[conn->buflen++] = c;
536 if (conn->buflen == conn->bufsize) {
538 tmpsize = conn->bufsize * 2 + 1;
539 if ((tmp = realloc(tmp, tmpsize)) == NULL) {
544 conn->bufsize = tmpsize;
548 conn->buf[conn->buflen] = '\0';
549 DEBUG(fprintf(stderr, "<<< %s", conn->buf));
555 * Write to a connection w/ timeout
558 fetch_write(conn_t *conn, const char *buf, size_t len)
562 iov.iov_base = __DECONST(char *, buf);
564 return fetch_writev(conn, &iov, 1);
568 * Write a vector to a connection w/ timeout
569 * Note: can modify the iovec.
572 fetch_writev(conn_t *conn, struct iovec *iov, int iovcnt)
574 struct timeval now, timeout, delta;
581 gettimeofday(&timeout, NULL);
582 timeout.tv_sec += fetchTimeout;
587 while (fetchTimeout && !FD_ISSET(conn->sd, &writefds)) {
588 FD_SET(conn->sd, &writefds);
589 gettimeofday(&now, NULL);
590 delta.tv_sec = timeout.tv_sec - now.tv_sec;
591 delta.tv_usec = timeout.tv_usec - now.tv_usec;
592 if (delta.tv_usec < 0) {
593 delta.tv_usec += 1000000;
596 if (delta.tv_sec < 0) {
602 r = select(conn->sd + 1, NULL, &writefds, NULL, &delta);
604 if (errno == EINTR && fetchRestartCalls)
611 if (conn->ssl != NULL)
612 wlen = SSL_write(conn->ssl,
613 iov->iov_base, iov->iov_len);
616 wlen = writev(conn->sd, iov, iovcnt);
618 /* we consider a short write a failure */
619 /* XXX perhaps we shouldn't in the SSL case */
625 if (errno == EINTR && fetchRestartCalls)
630 while (iovcnt > 0 && wlen >= (ssize_t)iov->iov_len) {
631 wlen -= iov->iov_len;
636 iov->iov_len -= wlen;
637 iov->iov_base = __DECONST(char *, iov->iov_base) + wlen;
645 * Write a line of text to a connection w/ timeout
648 fetch_putln(conn_t *conn, const char *str, size_t len)
653 DEBUG(fprintf(stderr, ">>> %s\n", str));
654 iov[0].iov_base = __DECONST(char *, str);
655 iov[0].iov_len = len;
656 iov[1].iov_base = __DECONST(char *, ENDL);
657 iov[1].iov_len = sizeof(ENDL);
659 ret = fetch_writev(conn, &iov[1], 1);
661 ret = fetch_writev(conn, iov, 2);
672 fetch_close(conn_t *conn)
678 ret = close(conn->sd);
685 /*** Directory-related utility functions *************************************/
688 fetch_add_entry(struct url_ent **p, int *size, int *len,
689 const char *name, struct url_stat *us)
698 if (*len >= *size - 1) {
699 tmp = realloc(*p, (*size * 2 + 1) * sizeof(**p));
705 *size = (*size * 2 + 1);
710 snprintf(tmp->name, PATH_MAX, "%s", name);
711 memcpy(&tmp->stat, us, sizeof(*us));
714 (++tmp)->name[0] = 0;
720 /*** Authentication-related utility functions ********************************/
723 fetch_read_word(FILE *f)
725 static char word[1024];
727 if (fscanf(f, " %1023s ", word) != 1)
733 * Get authentication data for a URL from .netrc
736 fetch_netrc_auth(struct url *url)
743 if ((p = getenv("NETRC")) != NULL) {
744 if (snprintf(fn, sizeof(fn), "%s", p) >= (int)sizeof(fn)) {
745 fetch_info("$NETRC specifies a file name "
746 "longer than PATH_MAX");
750 if ((p = getenv("HOME")) != NULL) {
753 if ((pwd = getpwuid(getuid())) == NULL ||
754 (p = pwd->pw_dir) == NULL)
757 if (snprintf(fn, sizeof(fn), "%s/.netrc", p) >= (int)sizeof(fn))
761 if ((f = fopen(fn, "r")) == NULL)
763 while ((word = fetch_read_word(f)) != NULL) {
764 if (strcmp(word, "default") == 0) {
765 DEBUG(fetch_info("Using default .netrc settings"));
768 if (strcmp(word, "machine") == 0 &&
769 (word = fetch_read_word(f)) != NULL &&
770 strcasecmp(word, url->host) == 0) {
771 DEBUG(fetch_info("Using .netrc settings for %s", word));
777 while ((word = fetch_read_word(f)) != NULL) {
778 if (strcmp(word, "login") == 0) {
779 if ((word = fetch_read_word(f)) == NULL)
781 if (snprintf(url->user, sizeof(url->user),
782 "%s", word) > (int)sizeof(url->user)) {
783 fetch_info("login name in .netrc is too long");
786 } else if (strcmp(word, "password") == 0) {
787 if ((word = fetch_read_word(f)) == NULL)
789 if (snprintf(url->pwd, sizeof(url->pwd),
790 "%s", word) > (int)sizeof(url->pwd)) {
791 fetch_info("password in .netrc is too long");
794 } else if (strcmp(word, "account") == 0) {
795 if ((word = fetch_read_word(f)) == NULL)
797 /* XXX not supported! */
810 * The no_proxy environment variable specifies a set of domains for
811 * which the proxy should not be consulted; the contents is a comma-,
812 * or space-separated list of domain names. A single asterisk will
813 * override all proxy variables and no transactions will be proxied
814 * (for compatability with lynx and curl, see the discussion at
815 * <http://curl.haxx.se/mail/archive_pre_oct_99/0009.html>).
818 fetch_no_proxy_match(const char *host)
820 const char *no_proxy, *p, *q;
823 if ((no_proxy = getenv("NO_PROXY")) == NULL &&
824 (no_proxy = getenv("no_proxy")) == NULL)
827 /* asterisk matches any hostname */
828 if (strcmp(no_proxy, "*") == 0)
831 h_len = strlen(host);
834 /* position p at the beginning of a domain suffix */
835 while (*p == ',' || isspace((unsigned char)*p))
838 /* position q at the first separator character */
840 if (*q == ',' || isspace((unsigned char)*q))
844 if (d_len > 0 && h_len >= d_len &&
845 strncasecmp(host + h_len - d_len,
847 /* domain name matches */