2 * util/net_help.c - implementation of the network helper code
4 * Copyright (c) 2007, NLnet Labs. All rights reserved.
6 * This software is open source.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
19 * Neither the name of the NLNET LABS nor the names of its contributors may
20 * be used to endorse or promote products derived from this software without
21 * specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * Implementation of net_help.h.
41 #include "util/net_help.h"
43 #include "util/data/dname.h"
44 #include "util/module.h"
45 #include "util/regional.h"
46 #include "util/config_file.h"
47 #include "sldns/parseutil.h"
48 #include "sldns/wire2str.h"
50 #ifdef HAVE_OPENSSL_SSL_H
51 #include <openssl/ssl.h>
52 #include <openssl/evp.h>
53 #include <openssl/rand.h>
55 #ifdef HAVE_OPENSSL_ERR_H
56 #include <openssl/err.h>
62 /** max length of an IP address (the address portion) that we allow */
63 #define MAX_ADDR_STRLEN 128 /* characters */
64 /** default value for EDNS ADVERTISED size */
65 uint16_t EDNS_ADVERTISED_SIZE = 4096;
67 /** minimal responses when positive answer: default is no */
68 int MINIMAL_RESPONSES = 0;
70 /** rrset order roundrobin: default is no */
71 int RRSET_ROUNDROBIN = 0;
73 /** log tag queries with name instead of 'info' for filtering */
74 int LOG_TAG_QUERYREPLY = 0;
76 static struct tls_session_ticket_key {
77 unsigned char *key_name;
78 unsigned char *aes_key;
79 unsigned char *hmac_key;
82 /* returns true is string addr is an ip6 specced address */
84 str_is_ip6(const char* str)
92 fd_set_nonblock(int s)
96 if((flag = fcntl(s, F_GETFL)) == -1) {
97 log_err("can't fcntl F_GETFL: %s", strerror(errno));
101 if(fcntl(s, F_SETFL, flag) == -1) {
102 log_err("can't fcntl F_SETFL: %s", strerror(errno));
105 #elif defined(HAVE_IOCTLSOCKET)
106 unsigned long on = 1;
107 if(ioctlsocket(s, FIONBIO, &on) != 0) {
108 log_err("can't ioctlsocket FIONBIO on: %s",
109 wsa_strerror(WSAGetLastError()));
120 if((flag = fcntl(s, F_GETFL)) == -1) {
121 log_err("cannot fcntl F_GETFL: %s", strerror(errno));
125 if(fcntl(s, F_SETFL, flag) == -1) {
126 log_err("cannot fcntl F_SETFL: %s", strerror(errno));
129 #elif defined(HAVE_IOCTLSOCKET)
130 unsigned long off = 0;
131 if(ioctlsocket(s, FIONBIO, &off) != 0) {
132 if(WSAGetLastError() != WSAEINVAL || verbosity >= 4)
133 log_err("can't ioctlsocket FIONBIO off: %s",
134 wsa_strerror(WSAGetLastError()));
143 if(num == 0) return 1;
144 return (num & (num-1)) == 0;
148 memdup(void* data, size_t len)
151 if(!data) return NULL;
152 if(len == 0) return NULL;
155 memcpy(d, data, len);
160 log_addr(enum verbosity_value v, const char* str,
161 struct sockaddr_storage* addr, socklen_t addrlen)
164 const char* family = "unknown";
166 int af = (int)((struct sockaddr_in*)addr)->sin_family;
167 void* sinaddr = &((struct sockaddr_in*)addr)->sin_addr;
171 case AF_INET: family="ip4"; break;
172 case AF_INET6: family="ip6";
173 sinaddr = &((struct sockaddr_in6*)addr)->sin6_addr;
177 (void)inet_ntop(af, sinaddr, dest,
178 (socklen_t)sizeof(dest));
179 verbose(v, "%s local %s", str, dest);
180 return; /* do not continue and try to get port */
183 if(inet_ntop(af, sinaddr, dest, (socklen_t)sizeof(dest)) == 0) {
184 (void)strlcpy(dest, "(inet_ntop error)", sizeof(dest));
186 dest[sizeof(dest)-1] = 0;
187 port = ntohs(((struct sockaddr_in*)addr)->sin_port);
189 verbose(v, "%s %s %s port %d (len %d)", str, family, dest,
190 (int)port, (int)addrlen);
191 else verbose(v, "%s %s port %d", str, dest, (int)port);
195 extstrtoaddr(const char* str, struct sockaddr_storage* addr,
199 int port = UNBOUND_DNS_PORT;
200 if((s=strchr(str, '@'))) {
201 char buf[MAX_ADDR_STRLEN];
202 if(s-str >= MAX_ADDR_STRLEN) {
205 (void)strlcpy(buf, str, sizeof(buf));
208 if(port == 0 && strcmp(s+1,"0")!=0) {
211 return ipstrtoaddr(buf, port, addr, addrlen);
213 return ipstrtoaddr(str, port, addr, addrlen);
218 ipstrtoaddr(const char* ip, int port, struct sockaddr_storage* addr,
225 char buf[MAX_ADDR_STRLEN];
227 struct sockaddr_in6* sa = (struct sockaddr_in6*)addr;
228 *addrlen = (socklen_t)sizeof(struct sockaddr_in6);
229 memset(sa, 0, *addrlen);
230 sa->sin6_family = AF_INET6;
231 sa->sin6_port = (in_port_t)htons(p);
232 if((s=strchr(ip, '%'))) { /* ip6%interface, rfc 4007 */
233 if(s-ip >= MAX_ADDR_STRLEN)
235 (void)strlcpy(buf, ip, sizeof(buf));
237 sa->sin6_scope_id = (uint32_t)atoi(s+1);
240 if(inet_pton((int)sa->sin6_family, ip, &sa->sin6_addr) <= 0) {
244 struct sockaddr_in* sa = (struct sockaddr_in*)addr;
245 *addrlen = (socklen_t)sizeof(struct sockaddr_in);
246 memset(sa, 0, *addrlen);
247 sa->sin_family = AF_INET;
248 sa->sin_port = (in_port_t)htons(p);
249 if(inet_pton((int)sa->sin_family, ip, &sa->sin_addr) <= 0) {
256 int netblockstrtoaddr(const char* str, int port, struct sockaddr_storage* addr,
257 socklen_t* addrlen, int* net)
261 *net = (str_is_ip6(str)?128:32);
262 if((s=strchr(str, '/'))) {
263 if(atoi(s+1) > *net) {
264 log_err("netblock too large: %s", str);
268 if(*net == 0 && strcmp(s+1, "0") != 0) {
269 log_err("cannot parse netblock: '%s'", str);
272 strlcpy(buf, str, sizeof(buf));
273 s = strchr(buf, '/');
277 if(!ipstrtoaddr(s?s:str, port, addr, addrlen)) {
278 log_err("cannot parse ip address: '%s'", str);
282 addr_mask(addr, *addrlen, *net);
287 /* RPZ format address dname to network byte order address */
288 static int ipdnametoaddr(uint8_t* dname, size_t dnamelen,
289 struct sockaddr_storage* addr, socklen_t* addrlen, int* af)
292 size_t dnamelabs = dname_count_labels(dname);
300 /* need 1 byte for label length */
305 dname_has_label(dname, dnamelen, (uint8_t*)"\002zz")) {
310 i = (*af == AF_INET) ? 3 : 15;
311 if(*af == AF_INET6) {
312 struct sockaddr_in6* sa = (struct sockaddr_in6*)addr;
313 *addrlen = (socklen_t)sizeof(struct sockaddr_in6);
314 memset(sa, 0, *addrlen);
315 sa->sin6_family = AF_INET6;
316 ia = (uint8_t*)&sa->sin6_addr;
318 struct sockaddr_in* sa = (struct sockaddr_in*)addr;
319 *addrlen = (socklen_t)sizeof(struct sockaddr_in);
320 memset(sa, 0, *addrlen);
321 sa->sin_family = AF_INET;
322 ia = (uint8_t*)&sa->sin_addr;
324 while(lablen && i >= 0 && len <= dnamelen) {
325 char buff[LDNS_MAX_LABELLEN+1];
326 uint16_t chunk; /* big enough to not overflow on IPv6 hextet */
327 if((*af == AF_INET && (lablen > 3 || dnamelabs > 6)) ||
328 (*af == AF_INET6 && (lablen > 4 || dnamelabs > 10))) {
331 if(memcmp(dname, "zz", 2) == 0 && *af == AF_INET6) {
332 /* Add one or more 0 labels. Address is initialised at
333 * 0, so just skip the zero part. */
334 int zl = 11 - dnamelabs;
340 memcpy(buff, dname, lablen);
342 chunk = strtol(buff, &e, (*af == AF_INET) ? 10 : 16);
343 if(!e || *e != '\0' || (*af == AF_INET && chunk > 255))
346 log_assert(i < 4 && i >= 0);
347 ia[i] = (uint8_t)chunk;
350 log_assert(i < 16 && i >= 1);
351 /* ia in network byte order */
352 ia[i-1] = (uint8_t)(chunk >> 8);
353 ia[i] = (uint8_t)(chunk & 0x00FF);
362 /* input too short */
367 int netblockdnametoaddr(uint8_t* dname, size_t dnamelen,
368 struct sockaddr_storage* addr, socklen_t* addrlen, int* net, int* af)
370 char buff[3 /* 3 digit netblock */ + 1];
372 if(dnamelen < 1 || *dname > 3)
373 /* netblock invalid */
377 if(dnamelen < 1 + nlablen)
380 memcpy(buff, dname+1, nlablen);
381 buff[nlablen] = '\0';
383 if(*net == 0 && strcmp(buff, "0") != 0)
387 if(!ipdnametoaddr(dname, dnamelen-1-nlablen, addr, addrlen, af))
389 if((*af == AF_INET6 && *net > 128) || (*af == AF_INET && *net > 32))
394 int authextstrtoaddr(char* str, struct sockaddr_storage* addr,
395 socklen_t* addrlen, char** auth_name)
398 int port = UNBOUND_DNS_PORT;
399 if((s=strchr(str, '@'))) {
400 char buf[MAX_ADDR_STRLEN];
401 size_t len = (size_t)(s-str);
402 char* hash = strchr(s+1, '#');
408 if(len >= MAX_ADDR_STRLEN) {
411 (void)strlcpy(buf, str, sizeof(buf));
415 if(!hash && strcmp(s+1,"0")!=0)
417 if(hash && strncmp(s+1,"0#",2)!=0)
420 return ipstrtoaddr(buf, port, addr, addrlen);
422 if((s=strchr(str, '#'))) {
423 char buf[MAX_ADDR_STRLEN];
424 size_t len = (size_t)(s-str);
425 if(len >= MAX_ADDR_STRLEN) {
428 (void)strlcpy(buf, str, sizeof(buf));
430 port = UNBOUND_DNS_OVER_TLS_PORT;
432 return ipstrtoaddr(buf, port, addr, addrlen);
435 return ipstrtoaddr(str, port, addr, addrlen);
438 /** store port number into sockaddr structure */
440 sockaddr_store_port(struct sockaddr_storage* addr, socklen_t addrlen, int port)
442 if(addr_is_ip6(addr, addrlen)) {
443 struct sockaddr_in6* sa = (struct sockaddr_in6*)addr;
444 sa->sin6_port = (in_port_t)htons((uint16_t)port);
446 struct sockaddr_in* sa = (struct sockaddr_in*)addr;
447 sa->sin_port = (in_port_t)htons((uint16_t)port);
452 log_nametypeclass(enum verbosity_value v, const char* str, uint8_t* name,
453 uint16_t type, uint16_t dclass)
455 char buf[LDNS_MAX_DOMAINLEN+1];
460 dname_str(name, buf);
461 if(type == LDNS_RR_TYPE_TSIG) ts = "TSIG";
462 else if(type == LDNS_RR_TYPE_IXFR) ts = "IXFR";
463 else if(type == LDNS_RR_TYPE_AXFR) ts = "AXFR";
464 else if(type == LDNS_RR_TYPE_MAILB) ts = "MAILB";
465 else if(type == LDNS_RR_TYPE_MAILA) ts = "MAILA";
466 else if(type == LDNS_RR_TYPE_ANY) ts = "ANY";
467 else if(sldns_rr_descript(type) && sldns_rr_descript(type)->_name)
468 ts = sldns_rr_descript(type)->_name;
470 snprintf(t, sizeof(t), "TYPE%d", (int)type);
473 if(sldns_lookup_by_id(sldns_rr_classes, (int)dclass) &&
474 sldns_lookup_by_id(sldns_rr_classes, (int)dclass)->name)
475 cs = sldns_lookup_by_id(sldns_rr_classes, (int)dclass)->name;
477 snprintf(c, sizeof(c), "CLASS%d", (int)dclass);
480 log_info("%s %s %s %s", str, buf, ts, cs);
484 log_query_in(const char* str, uint8_t* name, uint16_t type, uint16_t dclass)
486 char buf[LDNS_MAX_DOMAINLEN+1];
489 dname_str(name, buf);
490 if(type == LDNS_RR_TYPE_TSIG) ts = "TSIG";
491 else if(type == LDNS_RR_TYPE_IXFR) ts = "IXFR";
492 else if(type == LDNS_RR_TYPE_AXFR) ts = "AXFR";
493 else if(type == LDNS_RR_TYPE_MAILB) ts = "MAILB";
494 else if(type == LDNS_RR_TYPE_MAILA) ts = "MAILA";
495 else if(type == LDNS_RR_TYPE_ANY) ts = "ANY";
496 else if(sldns_rr_descript(type) && sldns_rr_descript(type)->_name)
497 ts = sldns_rr_descript(type)->_name;
499 snprintf(t, sizeof(t), "TYPE%d", (int)type);
502 if(sldns_lookup_by_id(sldns_rr_classes, (int)dclass) &&
503 sldns_lookup_by_id(sldns_rr_classes, (int)dclass)->name)
504 cs = sldns_lookup_by_id(sldns_rr_classes, (int)dclass)->name;
506 snprintf(c, sizeof(c), "CLASS%d", (int)dclass);
509 if(LOG_TAG_QUERYREPLY)
510 log_query("%s %s %s %s", str, buf, ts, cs);
511 else log_info("%s %s %s %s", str, buf, ts, cs);
514 void log_name_addr(enum verbosity_value v, const char* str, uint8_t* zone,
515 struct sockaddr_storage* addr, socklen_t addrlen)
518 const char* family = "unknown_family ";
519 char namebuf[LDNS_MAX_DOMAINLEN+1];
521 int af = (int)((struct sockaddr_in*)addr)->sin_family;
522 void* sinaddr = &((struct sockaddr_in*)addr)->sin_addr;
526 case AF_INET: family=""; break;
527 case AF_INET6: family="";
528 sinaddr = &((struct sockaddr_in6*)addr)->sin6_addr;
530 case AF_LOCAL: family="local "; break;
533 if(inet_ntop(af, sinaddr, dest, (socklen_t)sizeof(dest)) == 0) {
534 (void)strlcpy(dest, "(inet_ntop error)", sizeof(dest));
536 dest[sizeof(dest)-1] = 0;
537 port = ntohs(((struct sockaddr_in*)addr)->sin_port);
538 dname_str(zone, namebuf);
539 if(af != AF_INET && af != AF_INET6)
540 verbose(v, "%s <%s> %s%s#%d (addrlen %d)",
541 str, namebuf, family, dest, (int)port, (int)addrlen);
542 else verbose(v, "%s <%s> %s%s#%d",
543 str, namebuf, family, dest, (int)port);
546 void log_err_addr(const char* str, const char* err,
547 struct sockaddr_storage* addr, socklen_t addrlen)
551 int af = (int)((struct sockaddr_in*)addr)->sin_family;
552 void* sinaddr = &((struct sockaddr_in*)addr)->sin_addr;
554 sinaddr = &((struct sockaddr_in6*)addr)->sin6_addr;
555 if(inet_ntop(af, sinaddr, dest, (socklen_t)sizeof(dest)) == 0) {
556 (void)strlcpy(dest, "(inet_ntop error)", sizeof(dest));
558 dest[sizeof(dest)-1] = 0;
559 port = ntohs(((struct sockaddr_in*)addr)->sin_port);
561 log_err("%s: %s for %s port %d (len %d)", str, err, dest,
562 (int)port, (int)addrlen);
563 else log_err("%s: %s for %s port %d", str, err, dest, (int)port);
567 sockaddr_cmp(struct sockaddr_storage* addr1, socklen_t len1,
568 struct sockaddr_storage* addr2, socklen_t len2)
570 struct sockaddr_in* p1_in = (struct sockaddr_in*)addr1;
571 struct sockaddr_in* p2_in = (struct sockaddr_in*)addr2;
572 struct sockaddr_in6* p1_in6 = (struct sockaddr_in6*)addr1;
573 struct sockaddr_in6* p2_in6 = (struct sockaddr_in6*)addr2;
578 log_assert(len1 == len2);
579 if( p1_in->sin_family < p2_in->sin_family)
581 if( p1_in->sin_family > p2_in->sin_family)
583 log_assert( p1_in->sin_family == p2_in->sin_family );
585 if( p1_in->sin_family == AF_INET ) {
586 /* just order it, ntohs not required */
587 if(p1_in->sin_port < p2_in->sin_port)
589 if(p1_in->sin_port > p2_in->sin_port)
591 log_assert(p1_in->sin_port == p2_in->sin_port);
592 return memcmp(&p1_in->sin_addr, &p2_in->sin_addr, INET_SIZE);
593 } else if (p1_in6->sin6_family == AF_INET6) {
594 /* just order it, ntohs not required */
595 if(p1_in6->sin6_port < p2_in6->sin6_port)
597 if(p1_in6->sin6_port > p2_in6->sin6_port)
599 log_assert(p1_in6->sin6_port == p2_in6->sin6_port);
600 return memcmp(&p1_in6->sin6_addr, &p2_in6->sin6_addr,
603 /* eek unknown type, perform this comparison for sanity. */
604 return memcmp(addr1, addr2, len1);
609 sockaddr_cmp_addr(struct sockaddr_storage* addr1, socklen_t len1,
610 struct sockaddr_storage* addr2, socklen_t len2)
612 struct sockaddr_in* p1_in = (struct sockaddr_in*)addr1;
613 struct sockaddr_in* p2_in = (struct sockaddr_in*)addr2;
614 struct sockaddr_in6* p1_in6 = (struct sockaddr_in6*)addr1;
615 struct sockaddr_in6* p2_in6 = (struct sockaddr_in6*)addr2;
620 log_assert(len1 == len2);
621 if( p1_in->sin_family < p2_in->sin_family)
623 if( p1_in->sin_family > p2_in->sin_family)
625 log_assert( p1_in->sin_family == p2_in->sin_family );
627 if( p1_in->sin_family == AF_INET ) {
628 return memcmp(&p1_in->sin_addr, &p2_in->sin_addr, INET_SIZE);
629 } else if (p1_in6->sin6_family == AF_INET6) {
630 return memcmp(&p1_in6->sin6_addr, &p2_in6->sin6_addr,
633 /* eek unknown type, perform this comparison for sanity. */
634 return memcmp(addr1, addr2, len1);
639 addr_is_ip6(struct sockaddr_storage* addr, socklen_t len)
641 if(len == (socklen_t)sizeof(struct sockaddr_in6) &&
642 ((struct sockaddr_in6*)addr)->sin6_family == AF_INET6)
648 addr_mask(struct sockaddr_storage* addr, socklen_t len, int net)
650 uint8_t mask[8] = {0x0, 0x80, 0xc0, 0xe0, 0xf0, 0xf8, 0xfc, 0xfe};
653 if(addr_is_ip6(addr, len)) {
654 s = (uint8_t*)&((struct sockaddr_in6*)addr)->sin6_addr;
657 s = (uint8_t*)&((struct sockaddr_in*)addr)->sin_addr;
662 for(i=net/8+1; i<max/8; i++) {
665 s[net/8] &= mask[net&0x7];
669 addr_in_common(struct sockaddr_storage* addr1, int net1,
670 struct sockaddr_storage* addr2, int net2, socklen_t addrlen)
672 int min = (net1<net2)?net1:net2;
676 if(addr_is_ip6(addr1, addrlen)) {
677 s1 = (uint8_t*)&((struct sockaddr_in6*)addr1)->sin6_addr;
678 s2 = (uint8_t*)&((struct sockaddr_in6*)addr2)->sin6_addr;
681 s1 = (uint8_t*)&((struct sockaddr_in*)addr1)->sin_addr;
682 s2 = (uint8_t*)&((struct sockaddr_in*)addr2)->sin_addr;
685 /* match = bits_in_common(s1, s2, to); */
686 for(i=0; i<to; i++) {
690 uint8_t z = s1[i]^s2[i];
699 if(match > min) match = min;
704 addr_to_str(struct sockaddr_storage* addr, socklen_t addrlen,
705 char* buf, size_t len)
707 int af = (int)((struct sockaddr_in*)addr)->sin_family;
708 void* sinaddr = &((struct sockaddr_in*)addr)->sin_addr;
709 if(addr_is_ip6(addr, addrlen))
710 sinaddr = &((struct sockaddr_in6*)addr)->sin6_addr;
711 if(inet_ntop(af, sinaddr, buf, (socklen_t)len) == 0) {
712 snprintf(buf, len, "(inet_ntop_error)");
717 addr_is_ip4mapped(struct sockaddr_storage* addr, socklen_t addrlen)
719 /* prefix for ipv4 into ipv6 mapping is ::ffff:x.x.x.x */
720 const uint8_t map_prefix[16] =
721 {0,0,0,0, 0,0,0,0, 0,0,0xff,0xff, 0,0,0,0};
723 if(!addr_is_ip6(addr, addrlen))
725 /* s is 16 octet ipv6 address string */
726 s = (uint8_t*)&((struct sockaddr_in6*)addr)->sin6_addr;
727 return (memcmp(s, map_prefix, 12) == 0);
730 int addr_is_broadcast(struct sockaddr_storage* addr, socklen_t addrlen)
732 int af = (int)((struct sockaddr_in*)addr)->sin_family;
733 void* sinaddr = &((struct sockaddr_in*)addr)->sin_addr;
734 return af == AF_INET && addrlen>=(socklen_t)sizeof(struct sockaddr_in)
735 && memcmp(sinaddr, "\377\377\377\377", 4) == 0;
738 int addr_is_any(struct sockaddr_storage* addr, socklen_t addrlen)
740 int af = (int)((struct sockaddr_in*)addr)->sin_family;
741 void* sinaddr = &((struct sockaddr_in*)addr)->sin_addr;
742 void* sin6addr = &((struct sockaddr_in6*)addr)->sin6_addr;
743 if(af == AF_INET && addrlen>=(socklen_t)sizeof(struct sockaddr_in)
744 && memcmp(sinaddr, "\000\000\000\000", 4) == 0)
746 else if(af==AF_INET6 && addrlen>=(socklen_t)sizeof(struct sockaddr_in6)
747 && memcmp(sin6addr, "\000\000\000\000\000\000\000\000"
748 "\000\000\000\000\000\000\000\000", 16) == 0)
753 void sock_list_insert(struct sock_list** list, struct sockaddr_storage* addr,
754 socklen_t len, struct regional* region)
756 struct sock_list* add = (struct sock_list*)regional_alloc(region,
757 sizeof(*add) - sizeof(add->addr) + (size_t)len);
759 log_err("out of memory in socketlist insert");
766 if(len) memmove(&add->addr, addr, len);
769 void sock_list_prepend(struct sock_list** list, struct sock_list* add)
771 struct sock_list* last = add;
780 int sock_list_find(struct sock_list* list, struct sockaddr_storage* addr,
784 if(len == list->len) {
785 if(len == 0 || sockaddr_cmp_addr(addr, len,
786 &list->addr, list->len) == 0)
794 void sock_list_merge(struct sock_list** list, struct regional* region,
795 struct sock_list* add)
798 for(p=add; p; p=p->next) {
799 if(!sock_list_find(*list, &p->addr, p->len))
800 sock_list_insert(list, &p->addr, p->len, region);
805 log_crypto_err(const char* str)
808 log_crypto_err_code(str, ERR_get_error());
811 #endif /* HAVE_SSL */
814 void log_crypto_err_code(const char* str, unsigned long err)
817 /* error:[error code]:[library name]:[function name]:[reason string] */
820 ERR_error_string_n(err, buf, sizeof(buf));
821 log_err("%s crypto %s", str, buf);
822 while( (e=ERR_get_error()) ) {
823 ERR_error_string_n(e, buf, sizeof(buf));
824 log_err("and additionally crypto %s", buf);
829 #endif /* HAVE_SSL */
833 listen_sslctx_setup(void* ctxt)
836 SSL_CTX* ctx = (SSL_CTX*)ctxt;
837 /* no SSLv2, SSLv3 because has defects */
838 #if SSL_OP_NO_SSLv2 != 0
839 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2) & SSL_OP_NO_SSLv2)
841 log_crypto_err("could not set SSL_OP_NO_SSLv2");
845 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv3) & SSL_OP_NO_SSLv3)
847 log_crypto_err("could not set SSL_OP_NO_SSLv3");
850 #if defined(SSL_OP_NO_TLSv1) && defined(SSL_OP_NO_TLSv1_1)
851 /* if we have tls 1.1 disable 1.0 */
852 if((SSL_CTX_set_options(ctx, SSL_OP_NO_TLSv1) & SSL_OP_NO_TLSv1)
854 log_crypto_err("could not set SSL_OP_NO_TLSv1");
858 #if defined(SSL_OP_NO_TLSv1_1) && defined(SSL_OP_NO_TLSv1_2)
859 /* if we have tls 1.2 disable 1.1 */
860 if((SSL_CTX_set_options(ctx, SSL_OP_NO_TLSv1_1) & SSL_OP_NO_TLSv1_1)
861 != SSL_OP_NO_TLSv1_1){
862 log_crypto_err("could not set SSL_OP_NO_TLSv1_1");
866 #if defined(SSL_OP_NO_RENEGOTIATION)
867 /* disable client renegotiation */
868 if((SSL_CTX_set_options(ctx, SSL_OP_NO_RENEGOTIATION) &
869 SSL_OP_NO_RENEGOTIATION) != SSL_OP_NO_RENEGOTIATION) {
870 log_crypto_err("could not set SSL_OP_NO_RENEGOTIATION");
874 #if defined(SHA256_DIGEST_LENGTH) && defined(USE_ECDSA)
875 /* if we have sha256, set the cipher list to have no known vulns */
876 if(!SSL_CTX_set_cipher_list(ctx, "TLS13-CHACHA20-POLY1305-SHA256:TLS13-AES-256-GCM-SHA384:TLS13-AES-128-GCM-SHA256:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256"))
877 log_crypto_err("could not set cipher list with SSL_CTX_set_cipher_list");
880 if((SSL_CTX_set_options(ctx, SSL_OP_CIPHER_SERVER_PREFERENCE) &
881 SSL_OP_CIPHER_SERVER_PREFERENCE) !=
882 SSL_OP_CIPHER_SERVER_PREFERENCE) {
883 log_crypto_err("could not set SSL_OP_CIPHER_SERVER_PREFERENCE");
887 #ifdef HAVE_SSL_CTX_SET_SECURITY_LEVEL
888 SSL_CTX_set_security_level(ctx, 0);
892 #endif /* HAVE_SSL */
897 listen_sslctx_setup_2(void* ctxt)
900 SSL_CTX* ctx = (SSL_CTX*)ctxt;
902 #if HAVE_DECL_SSL_CTX_SET_ECDH_AUTO
903 if(!SSL_CTX_set_ecdh_auto(ctx,1)) {
904 log_crypto_err("Error in SSL_CTX_ecdh_auto, not enabling ECDHE");
906 #elif defined(USE_ECDSA)
908 EC_KEY *ecdh = EC_KEY_new_by_curve_name (NID_X9_62_prime256v1);
910 log_crypto_err("could not find p256, not enabling ECDHE");
912 if (1 != SSL_CTX_set_tmp_ecdh (ctx, ecdh)) {
913 log_crypto_err("Error in SSL_CTX_set_tmp_ecdh, not enabling ECDHE");
921 #endif /* HAVE_SSL */
924 void* listen_sslctx_create(char* key, char* pem, char* verifypem)
927 SSL_CTX* ctx = SSL_CTX_new(SSLv23_server_method());
929 log_crypto_err("could not SSL_CTX_new");
932 if(!key || key[0] == 0) {
933 log_err("error: no tls-service-key file specified");
937 if(!pem || pem[0] == 0) {
938 log_err("error: no tls-service-pem file specified");
942 if(!listen_sslctx_setup(ctx)) {
946 if(!SSL_CTX_use_certificate_chain_file(ctx, pem)) {
947 log_err("error for cert file: %s", pem);
948 log_crypto_err("error in SSL_CTX use_certificate_chain_file");
952 if(!SSL_CTX_use_PrivateKey_file(ctx, key, SSL_FILETYPE_PEM)) {
953 log_err("error for private key file: %s", key);
954 log_crypto_err("Error in SSL_CTX use_PrivateKey_file");
958 if(!SSL_CTX_check_private_key(ctx)) {
959 log_err("error for key file: %s", key);
960 log_crypto_err("Error in SSL_CTX check_private_key");
964 listen_sslctx_setup_2(ctx);
965 if(verifypem && verifypem[0]) {
966 if(!SSL_CTX_load_verify_locations(ctx, verifypem, NULL)) {
967 log_crypto_err("Error in SSL_CTX verify locations");
971 SSL_CTX_set_client_CA_list(ctx, SSL_load_client_CA_file(
973 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER, NULL);
977 (void)key; (void)pem; (void)verifypem;
983 /* For windows, the CA trust store is not read by openssl.
984 Add code to open the trust store using wincrypt API and add
985 the root certs into openssl trust store */
987 add_WIN_cacerts_to_openssl_store(SSL_CTX* tls_ctx)
989 HCERTSTORE hSystemStore;
990 PCCERT_CONTEXT pTargetCert = NULL;
993 verbose(VERB_ALGO, "Adding Windows certificates from system root store to CA store");
995 /* load just once per context lifetime for this version
996 TODO: dynamically update CA trust changes as they are available */
1000 /* Call wincrypt's CertOpenStore to open the CA root store. */
1002 if ((hSystemStore = CertOpenStore(
1003 CERT_STORE_PROV_SYSTEM,
1006 /* NOTE: mingw does not have this const: replace with 1 << 16 from code
1007 CERT_SYSTEM_STORE_CURRENT_USER, */
1014 store = SSL_CTX_get_cert_store(tls_ctx);
1018 /* failure if the CA store is empty or the call fails */
1019 if ((pTargetCert = CertEnumCertificatesInStore(
1020 hSystemStore, pTargetCert)) == 0) {
1021 verbose(VERB_ALGO, "CA certificate store for Windows is empty.");
1024 /* iterate over the windows cert store and add to openssl store */
1027 X509 *cert1 = d2i_X509(NULL,
1028 (const unsigned char **)&pTargetCert->pbCertEncoded,
1029 pTargetCert->cbCertEncoded);
1031 /* return error if a cert fails */
1032 verbose(VERB_ALGO, "%s %d:%s",
1033 "Unable to parse certificate in memory",
1034 (int)ERR_get_error(), ERR_error_string(ERR_get_error(), NULL));
1038 /* return error if a cert add to store fails */
1039 if (X509_STORE_add_cert(store, cert1) == 0) {
1040 unsigned long error = ERR_peek_last_error();
1042 /* Ignore error X509_R_CERT_ALREADY_IN_HASH_TABLE which means the
1043 * certificate is already in the store. */
1044 if(ERR_GET_LIB(error) != ERR_LIB_X509 ||
1045 ERR_GET_REASON(error) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
1046 verbose(VERB_ALGO, "%s %d:%s\n",
1047 "Error adding certificate", (int)ERR_get_error(),
1048 ERR_error_string(ERR_get_error(), NULL));
1055 } while ((pTargetCert = CertEnumCertificatesInStore(
1056 hSystemStore, pTargetCert)) != 0);
1058 /* Clean up memory and quit. */
1060 CertFreeCertificateContext(pTargetCert);
1063 if (!CertCloseStore(
1067 verbose(VERB_ALGO, "Completed adding Windows certificates to CA store successfully");
1070 #endif /* USE_WINSOCK */
1072 void* connect_sslctx_create(char* key, char* pem, char* verifypem, int wincert)
1075 SSL_CTX* ctx = SSL_CTX_new(SSLv23_client_method());
1077 log_crypto_err("could not allocate SSL_CTX pointer");
1080 #if SSL_OP_NO_SSLv2 != 0
1081 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2) & SSL_OP_NO_SSLv2)
1082 != SSL_OP_NO_SSLv2) {
1083 log_crypto_err("could not set SSL_OP_NO_SSLv2");
1088 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv3) & SSL_OP_NO_SSLv3)
1089 != SSL_OP_NO_SSLv3) {
1090 log_crypto_err("could not set SSL_OP_NO_SSLv3");
1094 #if defined(SSL_OP_NO_RENEGOTIATION)
1095 /* disable client renegotiation */
1096 if((SSL_CTX_set_options(ctx, SSL_OP_NO_RENEGOTIATION) &
1097 SSL_OP_NO_RENEGOTIATION) != SSL_OP_NO_RENEGOTIATION) {
1098 log_crypto_err("could not set SSL_OP_NO_RENEGOTIATION");
1103 if(!SSL_CTX_use_certificate_chain_file(ctx, pem)) {
1104 log_err("error in client certificate %s", pem);
1105 log_crypto_err("error in certificate file");
1109 if(!SSL_CTX_use_PrivateKey_file(ctx, key, SSL_FILETYPE_PEM)) {
1110 log_err("error in client private key %s", key);
1111 log_crypto_err("error in key file");
1115 if(!SSL_CTX_check_private_key(ctx)) {
1116 log_err("error in client key %s", key);
1117 log_crypto_err("error in SSL_CTX_check_private_key");
1122 if((verifypem && verifypem[0]) || wincert) {
1123 if(verifypem && verifypem[0]) {
1124 if(!SSL_CTX_load_verify_locations(ctx, verifypem, NULL)) {
1125 log_crypto_err("error in SSL_CTX verify");
1132 if(!add_WIN_cacerts_to_openssl_store(ctx)) {
1133 log_crypto_err("error in add_WIN_cacerts_to_openssl_store");
1141 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER, NULL);
1145 (void)key; (void)pem; (void)verifypem; (void)wincert;
1150 void* incoming_ssl_fd(void* sslctx, int fd)
1153 SSL* ssl = SSL_new((SSL_CTX*)sslctx);
1155 log_crypto_err("could not SSL_new");
1158 SSL_set_accept_state(ssl);
1159 (void)SSL_set_mode(ssl, (long)SSL_MODE_AUTO_RETRY);
1160 if(!SSL_set_fd(ssl, fd)) {
1161 log_crypto_err("could not SSL_set_fd");
1167 (void)sslctx; (void)fd;
1172 void* outgoing_ssl_fd(void* sslctx, int fd)
1175 SSL* ssl = SSL_new((SSL_CTX*)sslctx);
1177 log_crypto_err("could not SSL_new");
1180 SSL_set_connect_state(ssl);
1181 (void)SSL_set_mode(ssl, (long)SSL_MODE_AUTO_RETRY);
1182 if(!SSL_set_fd(ssl, fd)) {
1183 log_crypto_err("could not SSL_set_fd");
1189 (void)sslctx; (void)fd;
1194 #if defined(HAVE_SSL) && defined(OPENSSL_THREADS) && !defined(THREADS_DISABLED) && defined(CRYPTO_LOCK) && OPENSSL_VERSION_NUMBER < 0x10100000L
1195 /** global lock list for openssl locks */
1196 static lock_basic_type *ub_openssl_locks = NULL;
1198 /** callback that gets thread id for openssl */
1199 #ifdef HAVE_CRYPTO_THREADID_SET_CALLBACK
1201 ub_crypto_id_cb(CRYPTO_THREADID *id)
1203 CRYPTO_THREADID_set_numeric(id, (unsigned long)log_thread_get());
1206 static unsigned long
1207 ub_crypto_id_cb(void)
1209 return (unsigned long)log_thread_get();
1214 ub_crypto_lock_cb(int mode, int type, const char *ATTR_UNUSED(file),
1215 int ATTR_UNUSED(line))
1217 if((mode&CRYPTO_LOCK)) {
1218 lock_basic_lock(&ub_openssl_locks[type]);
1220 lock_basic_unlock(&ub_openssl_locks[type]);
1223 #endif /* OPENSSL_THREADS */
1225 int ub_openssl_lock_init(void)
1227 #if defined(HAVE_SSL) && defined(OPENSSL_THREADS) && !defined(THREADS_DISABLED) && defined(CRYPTO_LOCK) && OPENSSL_VERSION_NUMBER < 0x10100000L
1229 ub_openssl_locks = (lock_basic_type*)reallocarray(
1230 NULL, (size_t)CRYPTO_num_locks(), sizeof(lock_basic_type));
1231 if(!ub_openssl_locks)
1233 for(i=0; i<CRYPTO_num_locks(); i++) {
1234 lock_basic_init(&ub_openssl_locks[i]);
1236 # ifdef HAVE_CRYPTO_THREADID_SET_CALLBACK
1237 CRYPTO_THREADID_set_callback(&ub_crypto_id_cb);
1239 CRYPTO_set_id_callback(&ub_crypto_id_cb);
1241 CRYPTO_set_locking_callback(&ub_crypto_lock_cb);
1242 #endif /* OPENSSL_THREADS */
1246 void ub_openssl_lock_delete(void)
1248 #if defined(HAVE_SSL) && defined(OPENSSL_THREADS) && !defined(THREADS_DISABLED) && defined(CRYPTO_LOCK) && OPENSSL_VERSION_NUMBER < 0x10100000L
1250 if(!ub_openssl_locks)
1252 # ifdef HAVE_CRYPTO_THREADID_SET_CALLBACK
1253 CRYPTO_THREADID_set_callback(NULL);
1255 CRYPTO_set_id_callback(NULL);
1257 CRYPTO_set_locking_callback(NULL);
1258 for(i=0; i<CRYPTO_num_locks(); i++) {
1259 lock_basic_destroy(&ub_openssl_locks[i]);
1261 free(ub_openssl_locks);
1262 #endif /* OPENSSL_THREADS */
1265 int listen_sslctx_setup_ticket_keys(void* sslctx, struct config_strlist* tls_session_ticket_keys) {
1268 struct config_strlist* p;
1269 struct tls_session_ticket_key *keys;
1270 for(p = tls_session_ticket_keys; p; p = p->next) {
1273 keys = calloc(s, sizeof(struct tls_session_ticket_key));
1276 memset(keys, 0, s*sizeof(*keys));
1279 for(p = tls_session_ticket_keys; p; p = p->next) {
1281 unsigned char *data;
1284 data = (unsigned char *)malloc(80);
1288 f = fopen(p->str, "r");
1290 log_err("could not read tls-session-ticket-key %s: %s", p->str, strerror(errno));
1294 n = fread(data, 1, 80, f);
1298 log_err("tls-session-ticket-key %s is %d bytes, must be 80 bytes", p->str, (int)n);
1302 verbose(VERB_OPS, "read tls-session-ticket-key: %s", p->str);
1304 keys->key_name = data;
1305 keys->aes_key = data + 16;
1306 keys->hmac_key = data + 48;
1309 /* terminate array with NULL key name entry */
1310 keys->key_name = NULL;
1311 if(SSL_CTX_set_tlsext_ticket_key_cb(sslctx, tls_session_ticket_key_cb) == 0) {
1312 log_err("no support for TLS session ticket");
1318 (void)tls_session_ticket_keys;
1324 int tls_session_ticket_key_cb(void *ATTR_UNUSED(sslctx), unsigned char* key_name, unsigned char* iv, void *evp_sctx, void *hmac_ctx, int enc)
1327 const EVP_MD *digest;
1328 const EVP_CIPHER *cipher;
1329 int evp_cipher_length;
1330 digest = EVP_sha256();
1331 cipher = EVP_aes_256_cbc();
1332 evp_cipher_length = EVP_CIPHER_iv_length(cipher);
1335 verbose(VERB_CLIENT, "start session encrypt");
1336 memcpy(key_name, ticket_keys->key_name, 16);
1337 if (RAND_bytes(iv, evp_cipher_length) != 1) {
1338 verbose(VERB_CLIENT, "RAND_bytes failed");
1341 if (EVP_EncryptInit_ex(evp_sctx, cipher, NULL, ticket_keys->aes_key, iv) != 1) {
1342 verbose(VERB_CLIENT, "EVP_EncryptInit_ex failed");
1345 #ifndef HMAC_INIT_EX_RETURNS_VOID
1346 if (HMAC_Init_ex(hmac_ctx, ticket_keys->hmac_key, 32, digest, NULL) != 1) {
1347 verbose(VERB_CLIENT, "HMAC_Init_ex failed");
1351 HMAC_Init_ex(hmac_ctx, ticket_keys->hmac_key, 32, digest, NULL);
1354 } else if (enc == 0) {
1356 struct tls_session_ticket_key *key;
1357 verbose(VERB_CLIENT, "start session decrypt");
1358 for(key = ticket_keys; key->key_name != NULL; key++) {
1359 if (!memcmp(key_name, key->key_name, 16)) {
1360 verbose(VERB_CLIENT, "Found session_key");
1364 if(key->key_name == NULL) {
1365 verbose(VERB_CLIENT, "Not found session_key");
1369 #ifndef HMAC_INIT_EX_RETURNS_VOID
1370 if (HMAC_Init_ex(hmac_ctx, key->hmac_key, 32, digest, NULL) != 1) {
1371 verbose(VERB_CLIENT, "HMAC_Init_ex failed");
1375 HMAC_Init_ex(hmac_ctx, key->hmac_key, 32, digest, NULL);
1377 if (EVP_DecryptInit_ex(evp_sctx, cipher, NULL, key->aes_key, iv) != 1) {
1378 log_err("EVP_DecryptInit_ex failed");
1382 return (key == ticket_keys) ? 1 : 2;
1396 listen_sslctx_delete_ticket_keys(void)
1398 struct tls_session_ticket_key *key;
1399 if(!ticket_keys) return;
1400 for(key = ticket_keys; key->key_name != NULL; key++) {
1401 /* wipe key data from memory*/
1402 #ifdef HAVE_EXPLICIT_BZERO
1403 explicit_bzero(key->key_name, 80);
1405 memset(key->key_name, 0xdd, 80);
1407 free(key->key_name);