2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1998-2016 Dag-Erling Smørgrav
5 * Copyright (c) 2013 Michael Gmelin <freebsd@grem.de>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer
13 * in this position and unchanged.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/socket.h>
40 #include <netinet/in.h>
56 #include <openssl/x509v3.h>
63 /*** Local data **************************************************************/
66 * Error messages for resolver errors
68 static struct fetcherr netdb_errlist[] = {
70 { EAI_NODATA, FETCH_RESOLV, "Host not found" },
72 { EAI_AGAIN, FETCH_TEMP, "Transient resolver failure" },
73 { EAI_FAIL, FETCH_RESOLV, "Non-recoverable resolver failure" },
74 { EAI_NONAME, FETCH_RESOLV, "No address record" },
75 { -1, FETCH_UNKNOWN, "Unknown resolver error" }
79 * SOCKS5 error enumerations
84 SOCKS5_ERR_READ_METHOD,
87 SOCKS5_ERR_NOTIMPLEMENTED,
88 SOCKS5_ERR_HOSTNAME_SIZE,
91 SOCKS5_ERR_NON_VER5_RESP,
93 SOCKS5_ERR_NOT_ALLOWED,
94 SOCKS5_ERR_NET_UNREACHABLE,
95 SOCKS5_ERR_HOST_UNREACHABLE,
96 SOCKS5_ERR_CONN_REFUSED,
97 SOCKS5_ERR_TTL_EXPIRED,
98 SOCKS5_ERR_COM_UNSUPPORTED,
99 SOCKS5_ERR_ADDR_UNSUPPORTED,
100 SOCKS5_ERR_UNSPECIFIED,
101 /* Configuration errors */
103 SOCKS5_ERR_BAD_PROXY_FORMAT,
108 * Error messages for SOCKS5 errors
110 static struct fetcherr socks5_errlist[] = {
111 /* SOCKS5 protocol errors */
112 { SOCKS5_ERR_SELECTION, FETCH_ABORT, "SOCKS5: Failed to send selection method" },
113 { SOCKS5_ERR_READ_METHOD, FETCH_ABORT, "SOCKS5: Failed to read method" },
114 { SOCKS5_ERR_VER5_ONLY, FETCH_PROTO, "SOCKS5: Only version 5 is implemented" },
115 { SOCKS5_ERR_NOMETHODS, FETCH_PROTO, "SOCKS5: No acceptable methods" },
116 { SOCKS5_ERR_NOTIMPLEMENTED, FETCH_PROTO, "SOCKS5: Method currently not implemented" },
117 { SOCKS5_ERR_HOSTNAME_SIZE, FETCH_PROTO, "SOCKS5: Hostname size is above 256 bytes" },
118 { SOCKS5_ERR_REQUEST, FETCH_PROTO, "SOCKS5: Failed to request" },
119 { SOCKS5_ERR_REPLY, FETCH_PROTO, "SOCKS5: Failed to receive reply" },
120 { SOCKS5_ERR_NON_VER5_RESP, FETCH_PROTO, "SOCKS5: Server responded with a non-version 5 response" },
121 { SOCKS5_ERR_GENERAL, FETCH_ABORT, "SOCKS5: General server failure" },
122 { SOCKS5_ERR_NOT_ALLOWED, FETCH_AUTH, "SOCKS5: Connection not allowed by ruleset" },
123 { SOCKS5_ERR_NET_UNREACHABLE, FETCH_NETWORK, "SOCKS5: Network unreachable" },
124 { SOCKS5_ERR_HOST_UNREACHABLE, FETCH_ABORT, "SOCKS5: Host unreachable" },
125 { SOCKS5_ERR_CONN_REFUSED, FETCH_ABORT, "SOCKS5: Connection refused" },
126 { SOCKS5_ERR_TTL_EXPIRED, FETCH_TIMEOUT, "SOCKS5: TTL expired" },
127 { SOCKS5_ERR_COM_UNSUPPORTED, FETCH_PROTO, "SOCKS5: Command not supported" },
128 { SOCKS5_ERR_ADDR_UNSUPPORTED, FETCH_ABORT, "SOCKS5: Address type not supported" },
129 { SOCKS5_ERR_UNSPECIFIED, FETCH_UNKNOWN, "SOCKS5: Unspecified error" },
130 /* Configuration error */
131 { SOCKS5_ERR_BAD_HOST, FETCH_ABORT, "SOCKS5: Bad proxy host" },
132 { SOCKS5_ERR_BAD_PROXY_FORMAT, FETCH_ABORT, "SOCKS5: Bad proxy format" },
133 { SOCKS5_ERR_BAD_PORT, FETCH_ABORT, "SOCKS5: Bad port" }
137 static const char ENDL[2] = "\r\n";
140 /*** Error-reporting functions ***********************************************/
143 * Map error code to string
145 static struct fetcherr *
146 fetch_finderr(struct fetcherr *p, int e)
148 while (p->num != -1 && p->num != e)
157 fetch_seterr(struct fetcherr *p, int e)
159 p = fetch_finderr(p, e);
160 fetchLastErrCode = p->cat;
161 snprintf(fetchLastErrString, MAXERRSTRING, "%s", p->string);
165 * Set error code according to errno
172 fetchLastErrCode = FETCH_OK;
179 fetchLastErrCode = FETCH_AUTH;
182 case EISDIR: /* XXX */
183 fetchLastErrCode = FETCH_UNAVAIL;
186 fetchLastErrCode = FETCH_MEMORY;
190 fetchLastErrCode = FETCH_TEMP;
193 fetchLastErrCode = FETCH_EXISTS;
196 fetchLastErrCode = FETCH_FULL;
204 fetchLastErrCode = FETCH_NETWORK;
208 fetchLastErrCode = FETCH_ABORT;
211 fetchLastErrCode = FETCH_TIMEOUT;
215 fetchLastErrCode = FETCH_DOWN;
218 fetchLastErrCode = FETCH_UNKNOWN;
220 snprintf(fetchLastErrString, MAXERRSTRING, "%s", strerror(errno));
225 * Emit status message
228 fetch_info(const char *fmt, ...)
233 vfprintf(stderr, fmt, ap);
239 /*** Network-related utility functions ***************************************/
242 * Return the default port for a scheme
245 fetch_default_port(const char *scheme)
249 if ((se = getservbyname(scheme, "tcp")) != NULL)
250 return (ntohs(se->s_port));
251 if (strcmp(scheme, SCHEME_FTP) == 0)
252 return (FTP_DEFAULT_PORT);
253 if (strcmp(scheme, SCHEME_HTTP) == 0)
254 return (HTTP_DEFAULT_PORT);
259 * Return the default proxy port for a scheme
262 fetch_default_proxy_port(const char *scheme)
264 if (strcmp(scheme, SCHEME_FTP) == 0)
265 return (FTP_DEFAULT_PROXY_PORT);
266 if (strcmp(scheme, SCHEME_HTTP) == 0)
267 return (HTTP_DEFAULT_PROXY_PORT);
273 * Create a connection for an existing descriptor.
281 /* allocate and fill connection structure */
282 if ((conn = calloc(1, sizeof(*conn))) == NULL)
284 fcntl(sd, F_SETFD, FD_CLOEXEC);
285 setsockopt(sd, SOL_SOCKET, SO_NOSIGPIPE, &opt, sizeof opt);
293 * Bump a connection's reference count.
296 fetch_ref(conn_t *conn)
308 fetch_resolve(const char *addr, int port, int af)
310 char hbuf[256], sbuf[8];
311 struct addrinfo hints, *res;
312 const char *hb, *he, *sep;
313 const char *host, *service;
316 /* first, check for a bracketed IPv6 address */
319 if ((sep = strchr(hb, ']')) == NULL) {
326 sep = strchrnul(hb, ':');
330 /* see if we need to copy the host name */
332 len = snprintf(hbuf, sizeof(hbuf),
333 "%.*s", (int)(he - hb), hb);
336 if (len >= (int)sizeof(hbuf)) {
337 errno = ENAMETOOLONG;
345 /* was it followed by a service name? */
346 if (*sep == '\0' && port != 0) {
347 if (port < 1 || port > 65535) {
351 if (snprintf(sbuf, sizeof(sbuf), "%d", port) < 0)
354 } else if (*sep != '\0') {
361 memset(&hints, 0, sizeof(hints));
362 hints.ai_family = af;
363 hints.ai_socktype = SOCK_STREAM;
364 hints.ai_flags = AI_ADDRCONFIG;
365 if ((err = getaddrinfo(host, service, &hints, &res)) != 0) {
377 * Bind a socket to a specific local address
380 fetch_bind(int sd, int af, const char *addr)
382 struct addrinfo *cliai, *ai;
385 if ((cliai = fetch_resolve(addr, 0, af)) == NULL)
387 for (ai = cliai; ai != NULL; ai = ai->ai_next)
388 if ((err = bind(sd, ai->ai_addr, ai->ai_addrlen)) == 0)
393 return (err == 0 ? 0 : -1);
398 * SOCKS5 connection initiation, based on RFC 1928
399 * Default DNS resolution over SOCKS5
402 fetch_socks5_init(conn_t *conn, const char *host, int port, int verbose)
405 * Size is based on largest packet prefix (4 bytes) +
406 * Largest FQDN (256) + one byte size (1) +
409 unsigned char buf[BUFF_SIZE];
414 fetch_info("Initializing SOCKS5 connection: %s:%d", host, port);
416 /* Connection initialization */
418 *ptr++ = SOCKS_VERSION_5;
419 *ptr++ = SOCKS_CONNECTION;
422 if (fetch_write(conn, buf, 3) != 3) {
423 ret = SOCKS5_ERR_SELECTION;
427 /* Verify response from SOCKS5 server */
428 if (fetch_read(conn, buf, 2) != 2) {
429 ret = SOCKS5_ERR_READ_METHOD;
434 if (ptr[0] != SOCKS_VERSION_5) {
435 ret = SOCKS5_ERR_VER5_ONLY;
438 if (ptr[1] == SOCKS_NOMETHODS) {
439 ret = SOCKS5_ERR_NOMETHODS;
442 else if (ptr[1] != SOCKS5_NOTIMPLEMENTED) {
443 ret = SOCKS5_ERR_NOTIMPLEMENTED;
448 *ptr++ = SOCKS_VERSION_5;
449 *ptr++ = SOCKS_CONNECTION;
451 /* Encode all targets as a hostname to avoid DNS leaks */
452 *ptr++ = SOCKS_ATYP_DOMAINNAME;
453 if (strlen(host) > FQDN_SIZE) {
454 ret = SOCKS5_ERR_HOSTNAME_SIZE;
457 *ptr++ = strlen(host);
458 strncpy(ptr, host, strlen(host));
459 ptr = ptr + strlen(host);
462 *ptr++ = port & 0x00ff;
463 *ptr++ = (port & 0xff00) >> 8;
465 if (fetch_write(conn, buf, ptr - buf) != ptr - buf) {
466 ret = SOCKS5_ERR_REQUEST;
470 /* BND.ADDR is variable length, read the largest on non-blocking socket */
471 if (!fetch_read(conn, buf, BUFF_SIZE)) {
472 ret = SOCKS5_ERR_REPLY;
477 if (*ptr++ != SOCKS_VERSION_5) {
478 ret = SOCKS5_ERR_NON_VER5_RESP;
485 case SOCKS_GENERAL_FAILURE:
486 ret = SOCKS5_ERR_GENERAL;
488 case SOCKS_CONNECTION_NOT_ALLOWED:
489 ret = SOCKS5_ERR_NOT_ALLOWED;
491 case SOCKS_NETWORK_UNREACHABLE:
492 ret = SOCKS5_ERR_NET_UNREACHABLE;
494 case SOCKS_HOST_UNREACHABLE:
495 ret = SOCKS5_ERR_HOST_UNREACHABLE;
497 case SOCKS_CONNECTION_REFUSED:
498 ret = SOCKS5_ERR_CONN_REFUSED;
500 case SOCKS_TTL_EXPIRED:
501 ret = SOCKS5_ERR_TTL_EXPIRED;
503 case SOCKS_COMMAND_NOT_SUPPORTED:
504 ret = SOCKS5_ERR_COM_UNSUPPORTED;
506 case SOCKS_ADDRESS_NOT_SUPPORTED:
507 ret = SOCKS5_ERR_ADDR_UNSUPPORTED;
510 ret = SOCKS5_ERR_UNSPECIFIED;
522 * Perform SOCKS5 initialization
525 fetch_socks5_getenv(char **host, int *port)
527 char *socks5env, *endptr, *ext;
529 if ((socks5env = getenv("SOCKS5_PROXY")) == NULL || *socks5env == '\0') {
535 /* IPv6 addresses begin and end in brackets */
536 if (socks5env[0] == '[') {
537 if (socks5env[strlen(socks5env) - 1] == ']') {
538 *host = strndup(socks5env, strlen(socks5env));
541 *port = 1080; /* Default port as defined in RFC1928 */
543 ext = strstr(socks5env, "]:");
545 socks5_seterr(SOCKS5_ERR_BAD_PROXY_FORMAT);
549 *host = strndup(socks5env, ext - socks5env);
553 *port = strtoimax(ext + 1, (char **)&endptr, 10);
554 if (*endptr != '\0' || errno != 0 || *port < 0 ||
556 socks5_seterr(SOCKS5_ERR_BAD_PORT);
561 ext = strrchr(socks5env, ':');
563 *host = strdup(socks5env);
566 *host = strndup(socks5env, ext-socks5env);
570 *port = strtoimax(ext + 1, (char **)&endptr, 10);
571 if (*endptr != '\0' || errno != 0 || *port < 0 ||
573 socks5_seterr(SOCKS5_ERR_BAD_PORT);
582 fprintf(stderr, "Failure to allocate memory, exiting.\n");
588 * Establish a TCP connection to the specified port on the specified host.
591 fetch_connect(const char *host, int port, int af, int verbose)
593 struct addrinfo *cais = NULL, *sais = NULL, *cai, *sai;
594 const char *bindaddr;
596 int err = 0, sd = -1;
600 DEBUGF("---> %s:%d\n", host, port);
602 /* Check if SOCKS5_PROXY env variable is set */
603 if (!fetch_socks5_getenv(&sockshost, &socksport))
606 /* Not using SOCKS5 proxy */
607 if (sockshost == NULL) {
608 /* resolve server address */
610 fetch_info("resolving server address: %s:%d", host,
612 if ((sais = fetch_resolve(host, port, af)) == NULL)
615 /* resolve client address */
616 bindaddr = getenv("FETCH_BIND_ADDRESS");
617 if (bindaddr != NULL && *bindaddr != '\0') {
619 fetch_info("resolving client address: %s",
621 if ((cais = fetch_resolve(bindaddr, 0, af)) == NULL)
625 /* resolve socks5 proxy address */
627 fetch_info("resolving SOCKS5 server address: %s:%d",
628 sockshost, socksport);
629 if ((sais = fetch_resolve(sockshost, socksport, af)) == NULL) {
630 socks5_seterr(SOCKS5_ERR_BAD_HOST);
635 /* try each server address in turn */
636 for (err = 0, sai = sais; sai != NULL; sai = sai->ai_next) {
638 if ((sd = socket(sai->ai_family, SOCK_STREAM, 0)) < 0)
640 /* attempt to bind to client address */
641 for (err = 0, cai = cais; cai != NULL; cai = cai->ai_next) {
642 if (cai->ai_family != sai->ai_family)
644 if ((err = bind(sd, cai->ai_addr, cai->ai_addrlen)) == 0)
649 fetch_info("failed to bind to %s", bindaddr);
652 /* attempt to connect to server address */
653 if ((err = connect(sd, sai->ai_addr, sai->ai_addrlen)) == 0)
655 /* clean up before next attempt */
660 if (verbose && sockshost == NULL) {
661 fetch_info("failed to connect to %s:%d", host, port);
663 } else if (sockshost != NULL) {
666 "failed to connect to SOCKS5 server %s:%d",
667 sockshost, socksport);
668 socks5_seterr(SOCKS5_ERR_CONN_REFUSED);
674 if ((conn = fetch_reopen(sd)) == NULL)
678 if (!fetch_socks5_init(conn, host, port, verbose))
701 * Convert characters A-Z to lowercase (intentionally avoid any locale
702 * specific conversions).
705 fetch_ssl_tolower(char in)
707 if (in >= 'A' && in <= 'Z')
714 * isalpha implementation that intentionally avoids any locale specific
718 fetch_ssl_isalpha(char in)
720 return ((in >= 'A' && in <= 'Z') || (in >= 'a' && in <= 'z'));
724 * Check if passed hostnames a and b are equal.
727 fetch_ssl_hname_equal(const char *a, size_t alen, const char *b,
734 for (i = 0; i < alen; ++i) {
735 if (fetch_ssl_tolower(a[i]) != fetch_ssl_tolower(b[i]))
742 * Check if domain label is traditional, meaning that only A-Z, a-z, 0-9
743 * and '-' (hyphen) are allowed. Hyphens have to be surrounded by alpha-
744 * numeric characters. Double hyphens (like they're found in IDN a-labels
745 * 'xn--') are not allowed. Empty labels are invalid.
748 fetch_ssl_is_trad_domain_label(const char *l, size_t len, int wcok)
752 if (!len || l[0] == '-' || l[len-1] == '-')
754 for (i = 0; i < len; ++i) {
755 if (!isdigit(l[i]) &&
756 !fetch_ssl_isalpha(l[i]) &&
757 !(l[i] == '*' && wcok) &&
758 !(l[i] == '-' && l[i - 1] != '-'))
765 * Check if host name consists only of numbers. This might indicate an IP
766 * address, which is not a good idea for CN wildcard comparison.
769 fetch_ssl_hname_is_only_numbers(const char *hostname, size_t len)
773 for (i = 0; i < len; ++i) {
774 if (!((hostname[i] >= '0' && hostname[i] <= '9') ||
782 * Check if the host name h passed matches the pattern passed in m which
783 * is usually part of subjectAltName or CN of a certificate presented to
784 * the client. This includes wildcard matching. The algorithm is based on
785 * RFC6125, sections 6.4.3 and 7.2, which clarifies RFC2818 and RFC3280.
788 fetch_ssl_hname_match(const char *h, size_t hlen, const char *m,
791 int delta, hdotidx, mdot1idx, wcidx;
792 const char *hdot, *mdot1, *mdot2;
793 const char *wc; /* wildcard */
795 if (!(h && *h && m && *m))
797 if ((wc = strnstr(m, "*", mlen)) == NULL)
798 return (fetch_ssl_hname_equal(h, hlen, m, mlen));
800 /* hostname should not be just dots and numbers */
801 if (fetch_ssl_hname_is_only_numbers(h, hlen))
803 /* only one wildcard allowed in pattern */
804 if (strnstr(wc + 1, "*", mlen - wcidx - 1) != NULL)
807 * there must be at least two more domain labels and
808 * wildcard has to be in the leftmost label (RFC6125)
810 mdot1 = strnstr(m, ".", mlen);
811 if (mdot1 == NULL || mdot1 < wc || (mlen - (mdot1 - m)) < 4)
813 mdot1idx = mdot1 - m;
814 mdot2 = strnstr(mdot1 + 1, ".", mlen - mdot1idx - 1);
815 if (mdot2 == NULL || (mlen - (mdot2 - m)) < 2)
817 /* hostname must contain a dot and not be the 1st char */
818 hdot = strnstr(h, ".", hlen);
819 if (hdot == NULL || hdot == h)
823 * host part of hostname must be at least as long as
824 * pattern it's supposed to match
826 if (hdotidx < mdot1idx)
829 * don't allow wildcards in non-traditional domain names
830 * (IDN, A-label, U-label...)
832 if (!fetch_ssl_is_trad_domain_label(h, hdotidx, 0) ||
833 !fetch_ssl_is_trad_domain_label(m, mdot1idx, 1))
835 /* match domain part (part after first dot) */
836 if (!fetch_ssl_hname_equal(hdot, hlen - hdotidx, mdot1,
839 /* match part left of wildcard */
840 if (!fetch_ssl_hname_equal(h, wcidx, m, wcidx))
842 /* match part right of wildcard */
843 delta = mdot1idx - wcidx - 1;
844 if (!fetch_ssl_hname_equal(hdot - delta, delta,
845 mdot1 - delta, delta))
847 /* all tests succeeded, it's a match */
852 * Get numeric host address info - returns NULL if host was not an IP
853 * address. The caller is responsible for deallocation using
856 static struct addrinfo *
857 fetch_ssl_get_numeric_addrinfo(const char *hostname, size_t len)
859 struct addrinfo hints, *res;
862 host = (char *)malloc(len + 1);
863 memcpy(host, hostname, len);
865 memset(&hints, 0, sizeof(hints));
866 hints.ai_family = PF_UNSPEC;
867 hints.ai_socktype = SOCK_STREAM;
868 hints.ai_protocol = 0;
869 hints.ai_flags = AI_NUMERICHOST;
870 /* port is not relevant for this purpose */
871 if (getaddrinfo(host, "443", &hints, &res) != 0)
878 * Compare ip address in addrinfo with address passes.
881 fetch_ssl_ipaddr_match_bin(const struct addrinfo *lhost, const char *rhost,
886 if (lhost->ai_family == AF_INET && rhostlen == 4) {
887 left = (void *)&((struct sockaddr_in*)(void *)
888 lhost->ai_addr)->sin_addr.s_addr;
890 } else if (lhost->ai_family == AF_INET6 && rhostlen == 16) {
891 left = (void *)&((struct sockaddr_in6 *)(void *)
892 lhost->ai_addr)->sin6_addr;
896 return (!memcmp(left, (const void *)rhost, rhostlen) ? 1 : 0);
900 * Compare ip address in addrinfo with host passed. If host is not an IP
901 * address, comparison will fail.
904 fetch_ssl_ipaddr_match(const struct addrinfo *laddr, const char *r,
907 struct addrinfo *raddr;
912 if ((raddr = fetch_ssl_get_numeric_addrinfo(r, rlen)) == NULL)
913 return 0; /* not a numeric host */
915 if (laddr->ai_family == raddr->ai_family) {
916 if (laddr->ai_family == AF_INET) {
917 rip = (char *)&((struct sockaddr_in *)(void *)
918 raddr->ai_addr)->sin_addr.s_addr;
919 ret = fetch_ssl_ipaddr_match_bin(laddr, rip, 4);
921 } else if (laddr->ai_family == AF_INET6) {
922 rip = (char *)&((struct sockaddr_in6 *)(void *)
923 raddr->ai_addr)->sin6_addr;
924 ret = fetch_ssl_ipaddr_match_bin(laddr, rip, 16);
934 * Verify server certificate by subjectAltName.
937 fetch_ssl_verify_altname(STACK_OF(GENERAL_NAME) *altnames,
938 const char *host, struct addrinfo *ip)
940 const GENERAL_NAME *name;
945 for (i = 0; i < sk_GENERAL_NAME_num(altnames); ++i) {
946 #if OPENSSL_VERSION_NUMBER < 0x10000000L
948 * This is a workaround, since the following line causes
949 * alignment issues in clang:
950 * name = sk_GENERAL_NAME_value(altnames, i);
951 * OpenSSL explicitly warns not to use those macros
952 * directly, but there isn't much choice (and there
953 * shouldn't be any ill side effects)
955 name = (GENERAL_NAME *)SKM_sk_value(void, altnames, i);
957 name = sk_GENERAL_NAME_value(altnames, i);
959 #if OPENSSL_VERSION_NUMBER < 0x10100000L
960 ns = (const char *)ASN1_STRING_data(name->d.ia5);
962 ns = (const char *)ASN1_STRING_get0_data(name->d.ia5);
964 nslen = (size_t)ASN1_STRING_length(name->d.ia5);
966 if (name->type == GEN_DNS && ip == NULL &&
967 fetch_ssl_hname_match(host, strlen(host), ns, nslen))
969 else if (name->type == GEN_IPADD && ip != NULL &&
970 fetch_ssl_ipaddr_match_bin(ip, ns, nslen))
977 * Verify server certificate by CN.
980 fetch_ssl_verify_cn(X509_NAME *subject, const char *host,
983 ASN1_STRING *namedata;
984 X509_NAME_ENTRY *nameentry;
985 int cnlen, lastpos, loc, ret;
992 /* get most specific CN (last entry in list) and compare */
993 while ((lastpos = X509_NAME_get_index_by_NID(subject,
994 NID_commonName, lastpos)) != -1)
998 nameentry = X509_NAME_get_entry(subject, loc);
999 namedata = X509_NAME_ENTRY_get_data(nameentry);
1000 cnlen = ASN1_STRING_to_UTF8(&cn, namedata);
1002 fetch_ssl_hname_match(host, strlen(host), cn, cnlen))
1004 else if (ip != NULL && fetch_ssl_ipaddr_match(ip, cn, cnlen))
1012 * Verify that server certificate subjectAltName/CN matches
1013 * hostname. First check, if there are alternative subject names. If yes,
1014 * those have to match. Only if those don't exist it falls back to
1015 * checking the subject's CN.
1018 fetch_ssl_verify_hname(X509 *cert, const char *host)
1020 struct addrinfo *ip;
1021 STACK_OF(GENERAL_NAME) *altnames;
1026 ip = fetch_ssl_get_numeric_addrinfo(host, strlen(host));
1027 altnames = X509_get_ext_d2i(cert, NID_subject_alt_name,
1030 if (altnames != NULL) {
1031 ret = fetch_ssl_verify_altname(altnames, host, ip);
1033 subject = X509_get_subject_name(cert);
1034 if (subject != NULL)
1035 ret = fetch_ssl_verify_cn(subject, host, ip);
1040 if (altnames != NULL)
1041 GENERAL_NAMES_free(altnames);
1046 * Configure transport security layer based on environment.
1049 fetch_ssl_setup_transport_layer(SSL_CTX *ctx, int verbose)
1051 long ssl_ctx_options;
1053 ssl_ctx_options = SSL_OP_ALL | SSL_OP_NO_SSLv2 | SSL_OP_NO_TICKET;
1054 if (getenv("SSL_ALLOW_SSL3") == NULL)
1055 ssl_ctx_options |= SSL_OP_NO_SSLv3;
1056 if (getenv("SSL_NO_TLS1") != NULL)
1057 ssl_ctx_options |= SSL_OP_NO_TLSv1;
1058 if (getenv("SSL_NO_TLS1_1") != NULL)
1059 ssl_ctx_options |= SSL_OP_NO_TLSv1_1;
1060 if (getenv("SSL_NO_TLS1_2") != NULL)
1061 ssl_ctx_options |= SSL_OP_NO_TLSv1_2;
1063 fetch_info("SSL options: %lx", ssl_ctx_options);
1064 SSL_CTX_set_options(ctx, ssl_ctx_options);
1069 * Configure peer verification based on environment.
1071 #define LOCAL_CERT_FILE "/usr/local/etc/ssl/cert.pem"
1072 #define BASE_CERT_FILE "/etc/ssl/cert.pem"
1074 fetch_ssl_setup_peer_verification(SSL_CTX *ctx, int verbose)
1076 X509_LOOKUP *crl_lookup;
1077 X509_STORE *crl_store;
1078 const char *ca_cert_file, *ca_cert_path, *crl_file;
1080 if (getenv("SSL_NO_VERIFY_PEER") == NULL) {
1081 ca_cert_file = getenv("SSL_CA_CERT_FILE");
1082 if (ca_cert_file == NULL &&
1083 access(LOCAL_CERT_FILE, R_OK) == 0)
1084 ca_cert_file = LOCAL_CERT_FILE;
1085 if (ca_cert_file == NULL &&
1086 access(BASE_CERT_FILE, R_OK) == 0)
1087 ca_cert_file = BASE_CERT_FILE;
1088 ca_cert_path = getenv("SSL_CA_CERT_PATH");
1090 fetch_info("Peer verification enabled");
1091 if (ca_cert_file != NULL)
1092 fetch_info("Using CA cert file: %s",
1094 if (ca_cert_path != NULL)
1095 fetch_info("Using CA cert path: %s",
1097 if (ca_cert_file == NULL && ca_cert_path == NULL)
1098 fetch_info("Using OpenSSL default "
1099 "CA cert file and path");
1101 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER,
1102 fetch_ssl_cb_verify_crt);
1103 if (ca_cert_file != NULL || ca_cert_path != NULL)
1104 SSL_CTX_load_verify_locations(ctx, ca_cert_file,
1107 SSL_CTX_set_default_verify_paths(ctx);
1108 if ((crl_file = getenv("SSL_CRL_FILE")) != NULL) {
1110 fetch_info("Using CRL file: %s", crl_file);
1111 crl_store = SSL_CTX_get_cert_store(ctx);
1112 crl_lookup = X509_STORE_add_lookup(crl_store,
1113 X509_LOOKUP_file());
1114 if (crl_lookup == NULL ||
1115 !X509_load_crl_file(crl_lookup, crl_file,
1116 X509_FILETYPE_PEM)) {
1118 "Could not load CRL file %s\n",
1122 X509_STORE_set_flags(crl_store,
1123 X509_V_FLAG_CRL_CHECK |
1124 X509_V_FLAG_CRL_CHECK_ALL);
1131 * Configure client certificate based on environment.
1134 fetch_ssl_setup_client_certificate(SSL_CTX *ctx, int verbose)
1136 const char *client_cert_file, *client_key_file;
1138 if ((client_cert_file = getenv("SSL_CLIENT_CERT_FILE")) != NULL) {
1139 client_key_file = getenv("SSL_CLIENT_KEY_FILE") != NULL ?
1140 getenv("SSL_CLIENT_KEY_FILE") : client_cert_file;
1142 fetch_info("Using client cert file: %s",
1144 fetch_info("Using client key file: %s",
1147 if (SSL_CTX_use_certificate_chain_file(ctx,
1148 client_cert_file) != 1) {
1150 "Could not load client certificate %s\n",
1154 if (SSL_CTX_use_PrivateKey_file(ctx, client_key_file,
1155 SSL_FILETYPE_PEM) != 1) {
1157 "Could not load client key %s\n",
1166 * Callback for SSL certificate verification, this is called on server
1167 * cert verification. It takes no decision, but informs the user in case
1168 * verification failed.
1171 fetch_ssl_cb_verify_crt(int verified, X509_STORE_CTX *ctx)
1179 if ((crt = X509_STORE_CTX_get_current_cert(ctx)) != NULL &&
1180 (name = X509_get_subject_name(crt)) != NULL)
1181 str = X509_NAME_oneline(name, 0, 0);
1182 fprintf(stderr, "Certificate verification failed for %s\n",
1183 str != NULL ? str : "no relevant certificate");
1192 * Enable SSL on a connection.
1195 fetch_ssl(conn_t *conn, const struct url *URL, int verbose)
1202 /* Init the SSL library and context */
1203 if (!SSL_library_init()){
1204 fprintf(stderr, "SSL library init failed\n");
1208 SSL_load_error_strings();
1210 conn->ssl_meth = SSLv23_client_method();
1211 conn->ssl_ctx = SSL_CTX_new(conn->ssl_meth);
1212 SSL_CTX_set_mode(conn->ssl_ctx, SSL_MODE_AUTO_RETRY);
1214 fetch_ssl_setup_transport_layer(conn->ssl_ctx, verbose);
1215 if (!fetch_ssl_setup_peer_verification(conn->ssl_ctx, verbose))
1217 if (!fetch_ssl_setup_client_certificate(conn->ssl_ctx, verbose))
1220 conn->ssl = SSL_new(conn->ssl_ctx);
1221 if (conn->ssl == NULL) {
1222 fprintf(stderr, "SSL context creation failed\n");
1225 SSL_set_fd(conn->ssl, conn->sd);
1227 #if OPENSSL_VERSION_NUMBER >= 0x0090806fL && !defined(OPENSSL_NO_TLSEXT)
1228 if (!SSL_set_tlsext_host_name(conn->ssl,
1229 __DECONST(struct url *, URL)->host)) {
1231 "TLS server name indication extension failed for host %s\n",
1236 while ((ret = SSL_connect(conn->ssl)) == -1) {
1237 ssl_err = SSL_get_error(conn->ssl, ret);
1238 if (ssl_err != SSL_ERROR_WANT_READ &&
1239 ssl_err != SSL_ERROR_WANT_WRITE) {
1240 ERR_print_errors_fp(stderr);
1244 conn->ssl_cert = SSL_get_peer_certificate(conn->ssl);
1246 if (conn->ssl_cert == NULL) {
1247 fprintf(stderr, "No server SSL certificate\n");
1251 if (getenv("SSL_NO_VERIFY_HOSTNAME") == NULL) {
1253 fetch_info("Verify hostname");
1254 if (!fetch_ssl_verify_hname(conn->ssl_cert, URL->host)) {
1256 "SSL certificate subject doesn't match host %s\n",
1263 fetch_info("%s connection established using %s",
1264 SSL_get_version(conn->ssl), SSL_get_cipher(conn->ssl));
1265 name = X509_get_subject_name(conn->ssl_cert);
1266 str = X509_NAME_oneline(name, 0, 0);
1267 fetch_info("Certificate subject: %s", str);
1269 name = X509_get_issuer_name(conn->ssl_cert);
1270 str = X509_NAME_oneline(name, 0, 0);
1271 fetch_info("Certificate issuer: %s", str);
1280 fprintf(stderr, "SSL support disabled\n");
1285 #define FETCH_READ_WAIT -2
1286 #define FETCH_READ_ERROR -1
1287 #define FETCH_READ_DONE 0
1291 fetch_ssl_read(SSL *ssl, char *buf, size_t len)
1296 rlen = SSL_read(ssl, buf, len);
1298 ssl_err = SSL_get_error(ssl, rlen);
1299 if (ssl_err == SSL_ERROR_WANT_READ ||
1300 ssl_err == SSL_ERROR_WANT_WRITE) {
1301 return (FETCH_READ_WAIT);
1303 ERR_print_errors_fp(stderr);
1304 return (FETCH_READ_ERROR);
1312 fetch_socket_read(int sd, char *buf, size_t len)
1316 rlen = read(sd, buf, len);
1318 if (errno == EAGAIN || (errno == EINTR && fetchRestartCalls))
1319 return (FETCH_READ_WAIT);
1321 return (FETCH_READ_ERROR);
1327 * Read a character from a connection w/ timeout
1330 fetch_read(conn_t *conn, char *buf, size_t len)
1332 struct timeval now, timeout, delta;
1337 if (fetchTimeout > 0) {
1338 gettimeofday(&timeout, NULL);
1339 timeout.tv_sec += fetchTimeout;
1343 memset(&pfd, 0, sizeof pfd);
1345 pfd.events = POLLIN | POLLERR;
1349 * The socket is non-blocking. Instead of the canonical
1350 * poll() -> read(), we do the following:
1352 * 1) call read() or SSL_read().
1353 * 2) if we received some data, return it.
1354 * 3) if an error occurred, return -1.
1355 * 4) if read() or SSL_read() signaled EOF, return.
1356 * 5) if we did not receive any data but we're not at EOF,
1359 * In the SSL case, this is necessary because if we
1360 * receive a close notification, we have to call
1361 * SSL_read() one additional time after we've read
1362 * everything we received.
1364 * In the non-SSL case, it may improve performance (very
1365 * slightly) when reading small amounts of data.
1368 if (conn->ssl != NULL)
1369 rlen = fetch_ssl_read(conn->ssl, buf, len);
1372 rlen = fetch_socket_read(conn->sd, buf, len);
1375 } else if (rlen == FETCH_READ_ERROR) {
1379 // assert(rlen == FETCH_READ_WAIT);
1380 if (fetchTimeout > 0) {
1381 gettimeofday(&now, NULL);
1382 if (!timercmp(&timeout, &now, >)) {
1387 timersub(&timeout, &now, &delta);
1388 deltams = delta.tv_sec * 1000 +
1389 delta.tv_usec / 1000;;
1393 if (poll(&pfd, 1, deltams) < 0) {
1394 if (errno == EINTR && fetchRestartCalls)
1405 * Read a line of text from a connection w/ timeout
1407 #define MIN_BUF_SIZE 1024
1410 fetch_getln(conn_t *conn)
1417 if (conn->buf == NULL) {
1418 if ((conn->buf = malloc(MIN_BUF_SIZE)) == NULL) {
1422 conn->bufsize = MIN_BUF_SIZE;
1425 conn->buf[0] = '\0';
1429 len = fetch_read(conn, &c, 1);
1434 conn->buf[conn->buflen++] = c;
1435 if (conn->buflen == conn->bufsize) {
1437 tmpsize = conn->bufsize * 2 + 1;
1438 if ((tmp = realloc(tmp, tmpsize)) == NULL) {
1443 conn->bufsize = tmpsize;
1445 } while (c != '\n');
1447 conn->buf[conn->buflen] = '\0';
1448 DEBUGF("<<< %s", conn->buf);
1454 * Write to a connection w/ timeout
1457 fetch_write(conn_t *conn, const char *buf, size_t len)
1461 iov.iov_base = __DECONST(char *, buf);
1463 return fetch_writev(conn, &iov, 1);
1467 * Write a vector to a connection w/ timeout
1468 * Note: can modify the iovec.
1471 fetch_writev(conn_t *conn, struct iovec *iov, int iovcnt)
1473 struct timeval now, timeout, delta;
1475 ssize_t wlen, total;
1478 memset(&pfd, 0, sizeof pfd);
1481 pfd.events = POLLOUT | POLLERR;
1482 gettimeofday(&timeout, NULL);
1483 timeout.tv_sec += fetchTimeout;
1487 while (iovcnt > 0) {
1488 while (fetchTimeout && pfd.revents == 0) {
1489 gettimeofday(&now, NULL);
1490 if (!timercmp(&timeout, &now, >)) {
1495 timersub(&timeout, &now, &delta);
1496 deltams = delta.tv_sec * 1000 +
1497 delta.tv_usec / 1000;
1500 if (poll(&pfd, 1, deltams) < 0) {
1501 /* POSIX compliance */
1502 if (errno == EAGAIN)
1504 if (errno == EINTR && fetchRestartCalls)
1511 if (conn->ssl != NULL)
1512 wlen = SSL_write(conn->ssl,
1513 iov->iov_base, iov->iov_len);
1516 wlen = writev(conn->sd, iov, iovcnt);
1518 /* we consider a short write a failure */
1519 /* XXX perhaps we shouldn't in the SSL case */
1525 if (errno == EINTR && fetchRestartCalls)
1530 while (iovcnt > 0 && wlen >= (ssize_t)iov->iov_len) {
1531 wlen -= iov->iov_len;
1536 iov->iov_len -= wlen;
1537 iov->iov_base = __DECONST(char *, iov->iov_base) + wlen;
1545 * Write a line of text to a connection w/ timeout
1548 fetch_putln(conn_t *conn, const char *str, size_t len)
1550 struct iovec iov[2];
1553 DEBUGF(">>> %s\n", str);
1554 iov[0].iov_base = __DECONST(char *, str);
1555 iov[0].iov_len = len;
1556 iov[1].iov_base = __DECONST(char *, ENDL);
1557 iov[1].iov_len = sizeof(ENDL);
1559 ret = fetch_writev(conn, &iov[1], 1);
1561 ret = fetch_writev(conn, iov, 2);
1572 fetch_close(conn_t *conn)
1576 if (--conn->ref > 0)
1580 SSL_shutdown(conn->ssl);
1581 SSL_set_connect_state(conn->ssl);
1582 SSL_free(conn->ssl);
1585 if (conn->ssl_ctx) {
1586 SSL_CTX_free(conn->ssl_ctx);
1587 conn->ssl_ctx = NULL;
1589 if (conn->ssl_cert) {
1590 X509_free(conn->ssl_cert);
1591 conn->ssl_cert = NULL;
1594 ret = close(conn->sd);
1601 /*** Directory-related utility functions *************************************/
1604 fetch_add_entry(struct url_ent **p, int *size, int *len,
1605 const char *name, struct url_stat *us)
1607 struct url_ent *tmp;
1614 if (*len >= *size - 1) {
1615 tmp = reallocarray(*p, *size * 2 + 1, sizeof(**p));
1621 *size = (*size * 2 + 1);
1626 snprintf(tmp->name, PATH_MAX, "%s", name);
1627 memcpy(&tmp->stat, us, sizeof(*us));
1630 (++tmp)->name[0] = 0;
1636 /*** Authentication-related utility functions ********************************/
1639 fetch_read_word(FILE *f)
1641 static char word[1024];
1643 if (fscanf(f, " %1023s ", word) != 1)
1649 fetch_netrc_open(void)
1656 if ((p = getenv("NETRC")) != NULL) {
1657 DEBUGF("NETRC=%s\n", p);
1658 if (snprintf(fn, sizeof(fn), "%s", p) >= (int)sizeof(fn)) {
1659 fetch_info("$NETRC specifies a file name "
1660 "longer than PATH_MAX");
1664 if ((p = getenv("HOME")) == NULL) {
1665 if ((pwd = getpwuid(getuid())) == NULL ||
1666 (p = pwd->pw_dir) == NULL)
1669 if (snprintf(fn, sizeof(fn), "%s/.netrc", p) >= (int)sizeof(fn))
1673 if ((fd = open(fn, O_RDONLY)) < 0) {
1675 DEBUGF("%s: %s\n", fn, strerror(serrno));
1682 * Get authentication data for a URL from .netrc
1685 fetch_netrc_auth(struct url *url)
1691 if (url->netrcfd < 0)
1692 url->netrcfd = fetch_netrc_open();
1693 if (url->netrcfd < 0)
1695 if ((f = fdopen(url->netrcfd, "r")) == NULL) {
1697 DEBUGF("fdopen(netrcfd): %s", strerror(errno));
1698 close(url->netrcfd);
1704 DEBUGF("searching netrc for %s\n", url->host);
1705 while ((word = fetch_read_word(f)) != NULL) {
1706 if (strcmp(word, "default") == 0) {
1707 DEBUGF("using default netrc settings\n");
1710 if (strcmp(word, "machine") == 0 &&
1711 (word = fetch_read_word(f)) != NULL &&
1712 strcasecmp(word, url->host) == 0) {
1713 DEBUGF("using netrc settings for %s\n", word);
1719 while ((word = fetch_read_word(f)) != NULL) {
1720 if (strcmp(word, "login") == 0) {
1721 if ((word = fetch_read_word(f)) == NULL)
1723 if (snprintf(url->user, sizeof(url->user),
1724 "%s", word) > (int)sizeof(url->user)) {
1725 fetch_info("login name in .netrc is too long");
1726 url->user[0] = '\0';
1728 } else if (strcmp(word, "password") == 0) {
1729 if ((word = fetch_read_word(f)) == NULL)
1731 if (snprintf(url->pwd, sizeof(url->pwd),
1732 "%s", word) > (int)sizeof(url->pwd)) {
1733 fetch_info("password in .netrc is too long");
1736 } else if (strcmp(word, "account") == 0) {
1737 if ((word = fetch_read_word(f)) == NULL)
1739 /* XXX not supported! */
1756 * The no_proxy environment variable specifies a set of domains for
1757 * which the proxy should not be consulted; the contents is a comma-,
1758 * or space-separated list of domain names. A single asterisk will
1759 * override all proxy variables and no transactions will be proxied
1760 * (for compatibility with lynx and curl, see the discussion at
1761 * <http://curl.haxx.se/mail/archive_pre_oct_99/0009.html>).
1764 fetch_no_proxy_match(const char *host)
1766 const char *no_proxy, *p, *q;
1767 size_t h_len, d_len;
1769 if ((no_proxy = getenv("NO_PROXY")) == NULL &&
1770 (no_proxy = getenv("no_proxy")) == NULL)
1773 /* asterisk matches any hostname */
1774 if (strcmp(no_proxy, "*") == 0)
1777 h_len = strlen(host);
1780 /* position p at the beginning of a domain suffix */
1781 while (*p == ',' || isspace((unsigned char)*p))
1784 /* position q at the first separator character */
1785 for (q = p; *q; ++q)
1786 if (*q == ',' || isspace((unsigned char)*q))
1790 if (d_len > 0 && h_len >= d_len &&
1791 strncasecmp(host + h_len - d_len,
1793 /* domain name matches */