2 * unbound-anchor.c - update the root anchor if necessary.
4 * Copyright (c) 2010, 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.
39 * This file checks to see that the current 5011 keys work to prime the
40 * current root anchor. If not a certificate is used to update the anchor,
41 * with RFC7958 https xml fetch.
43 * This is a concept solution for distribution of the DNSSEC root
44 * trust anchor. It is a small tool, called "unbound-anchor", that
45 * runs before the main validator starts. I.e. in the init script:
46 * unbound-anchor; unbound. Thus it is meant to run at system boot time.
48 * Management-Abstract:
49 * * first run: fill root.key file with hardcoded DS record.
50 * * mostly: use RFC5011 tracking, quick . DNSKEY UDP query.
51 * * failover: use RFC7958 builtin certificate, do https and update.
52 * Special considerations:
53 * * 30-days RFC5011 timer saves a lot of https traffic.
54 * * DNSKEY probe must be NOERROR, saves a lot of https traffic.
55 * * fail if clock before sign date of the root, if cert expired.
56 * * if the root goes back to unsigned, deals with it.
58 * It has hardcoded the root DS anchors and the ICANN CA root certificate.
59 * It allows with options to override those. It also takes root-hints (it
60 * has to do a DNS resolve), and also has hardcoded defaults for those.
62 * Once it starts, just before the validator starts, it quickly checks if
63 * the root anchor file needs to be updated. First it tries to use
64 * RFC5011-tracking of the root key. If that fails (and for 30-days since
65 * last successful probe), then it attempts to update using the
66 * certificate. So most of the time, the RFC5011 tracking will work fine,
67 * and within a couple milliseconds, the main daemon can start. It will
68 * have only probed the . DNSKEY, not done expensive https transfers on the
69 * root infrastructure.
71 * If there is no root key in the root.key file, it bootstraps the
72 * RFC5011-tracking with its builtin DS anchors; if that fails it
73 * bootstraps the RFC5011-tracking using the certificate. (again to avoid
74 * https, and it is also faster).
76 * It uses the XML file by converting it to DS records and writing that to the
77 * key file. Unbound can detect that the 'special comments' are gone, and
78 * the file contains a list of normal DNSKEY/DS records, and uses that to
79 * bootstrap 5011 (the KSK is made VALID).
81 * The certificate RFC7958 update is done by fetching root-anchors.xml and
82 * root-anchors.p7s via SSL. The HTTPS certificate can be logged but is
83 * not validated (https for channel security; the security comes from the
84 * certificate). The 'data.iana.org' domain name A and AAAA are resolved
85 * without DNSSEC. It tries a random IP until the transfer succeeds. It
86 * then checks the p7s signature.
88 * On any failure, it leaves the root key file untouched. The main
89 * validator has to cope with it, it cannot fix things (So a failure does
90 * not go 'without DNSSEC', no downgrade). If it used its builtin stuff or
91 * did the https, it exits with an exit code, so that this can trigger the
92 * init script to log the event and potentially alert the operator that can
95 * The date is also checked. Before 2010-07-15 is a failure (root not
96 * signed yet; avoids attacks on system clock). The
97 * last-successful-RFC5011-probe (if available) has to be more than 30 days
98 * in the past (otherwise, RFC5011 should have worked). This keeps
99 * unnecessary https traffic down. If the main certificate is expired, it
102 * The dates on the keys in the xml are checked (uses the libexpat xml
103 * parser), only the valid ones are used to re-enstate RFC5011 tracking.
104 * If 0 keys are valid, the zone has gone to insecure (a special marker is
105 * written in the keyfile that tells the main validator daemon the zone is
108 * Only the root ICANN CA is shipped, not the intermediate ones. The
109 * intermediate CAs are included in the p7s file that was downloaded. (the
110 * root cert is valid to 2028 and the intermediate to 2014, today).
112 * Obviously, the tool also has options so the operator can provide a new
113 * keyfile, a new certificate and new URLs, and fresh root hints. By
114 * default it logs nothing on failure and success; it 'just works'.
119 #include "libunbound/unbound.h"
120 #include "sldns/rrdef.h"
121 #include "sldns/parseutil.h"
124 #error "need libexpat to parse root-anchors.xml file."
129 #ifdef HAVE_OPENSSL_SSL_H
130 #include <openssl/ssl.h>
132 #ifdef HAVE_OPENSSL_ERR_H
133 #include <openssl/err.h>
135 #ifdef HAVE_OPENSSL_RAND_H
136 #include <openssl/rand.h>
138 #include <openssl/x509.h>
139 #include <openssl/x509v3.h>
140 #include <openssl/pem.h>
142 /** name of server in URL to fetch HTTPS from */
143 #define URLNAME "data.iana.org"
144 /** path on HTTPS server to xml file */
145 #define XMLNAME "root-anchors/root-anchors.xml"
146 /** path on HTTPS server to p7s file */
147 #define P7SNAME "root-anchors/root-anchors.p7s"
148 /** name of the signer of the certificate */
149 #define P7SIGNER "dnssec@iana.org"
150 /** port number for https access */
151 #define HTTPS_PORT 443
154 /* sneakily reuse the the wsa_strerror function, on windows */
155 char* wsa_strerror(int err);
158 /** verbosity for this application */
161 /** list of IP addresses */
164 struct ip_list* next;
165 /** length of addr */
167 /** address ready to connect to */
168 struct sockaddr_storage addr;
169 /** has the address been used */
173 /** Give unbound-anchor usage, and exit (1). */
177 printf("Usage: local-unbound-anchor [opts]\n");
178 printf(" Setup or update root anchor. "
179 "Most options have defaults.\n");
180 printf(" Run this program before you start the validator.\n");
182 printf(" The anchor and cert have default builtin content\n");
183 printf(" if the file does not exist or is empty.\n");
185 printf("-a file root key file, default %s\n", ROOT_ANCHOR_FILE);
186 printf(" The key is input and output for this tool.\n");
187 printf("-c file cert file, default %s\n", ROOT_CERT_FILE);
188 printf("-l list builtin key and cert on stdout\n");
189 printf("-u name server in https url, default %s\n", URLNAME);
190 printf("-x path pathname to xml in url, default %s\n", XMLNAME);
191 printf("-s path pathname to p7s in url, default %s\n", P7SNAME);
192 printf("-n name signer's subject emailAddress, default %s\n", P7SIGNER);
193 printf("-4 work using IPv4 only\n");
194 printf("-6 work using IPv6 only\n");
195 printf("-f resolv.conf use given resolv.conf\n");
196 printf("-r root.hints use given root.hints\n"
197 " builtin root hints are used by default\n");
198 printf("-R fallback from -f to root query on error\n");
199 printf("-v more verbose\n");
200 printf("-C conf debug, read config\n");
201 printf("-P port use port for https connect, default 443\n");
202 printf("-F debug, force update with cert\n");
203 printf("-h show this usage help\n");
204 printf("Version %s\n", PACKAGE_VERSION);
205 printf("BSD licensed, see LICENSE in source package for details.\n");
206 printf("Report bugs to %s\n", PACKAGE_BUGREPORT);
210 /** return the built in root update certificate */
212 get_builtin_cert(void)
215 /* The ICANN CA fetched at 24 Sep 2010. Valid to 2028 */
216 "-----BEGIN CERTIFICATE-----\n"
217 "MIIDdzCCAl+gAwIBAgIBATANBgkqhkiG9w0BAQsFADBdMQ4wDAYDVQQKEwVJQ0FO\n"
218 "TjEmMCQGA1UECxMdSUNBTk4gQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxFjAUBgNV\n"
219 "BAMTDUlDQU5OIFJvb3QgQ0ExCzAJBgNVBAYTAlVTMB4XDTA5MTIyMzA0MTkxMloX\n"
220 "DTI5MTIxODA0MTkxMlowXTEOMAwGA1UEChMFSUNBTk4xJjAkBgNVBAsTHUlDQU5O\n"
221 "IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRYwFAYDVQQDEw1JQ0FOTiBSb290IENB\n"
222 "MQswCQYDVQQGEwJVUzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKDb\n"
223 "cLhPNNqc1NB+u+oVvOnJESofYS9qub0/PXagmgr37pNublVThIzyLPGCJ8gPms9S\n"
224 "G1TaKNIsMI7d+5IgMy3WyPEOECGIcfqEIktdR1YWfJufXcMReZwU4v/AdKzdOdfg\n"
225 "ONiwc6r70duEr1IiqPbVm5T05l1e6D+HkAvHGnf1LtOPGs4CHQdpIUcy2kauAEy2\n"
226 "paKcOcHASvbTHK7TbbvHGPB+7faAztABLoneErruEcumetcNfPMIjXKdv1V1E3C7\n"
227 "MSJKy+jAqqQJqjZoQGB0necZgUMiUv7JK1IPQRM2CXJllcyJrm9WFxY0c1KjBO29\n"
228 "iIKK69fcglKcBuFShUECAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8B\n"
229 "Af8EBAMCAf4wHQYDVR0OBBYEFLpS6UmDJIZSL8eZzfyNa2kITcBQMA0GCSqGSIb3\n"
230 "DQEBCwUAA4IBAQAP8emCogqHny2UYFqywEuhLys7R9UKmYY4suzGO4nkbgfPFMfH\n"
231 "6M+Zj6owwxlwueZt1j/IaCayoKU3QsrYYoDRolpILh+FPwx7wseUEV8ZKpWsoDoD\n"
232 "2JFbLg2cfB8u/OlE4RYmcxxFSmXBg0yQ8/IoQt/bxOcEEhhiQ168H2yE5rxJMt9h\n"
233 "15nu5JBSewrCkYqYYmaxyOC3WrVGfHZxVI7MpIFcGdvSb2a1uyuua8l0BKgk3ujF\n"
234 "0/wsHNeP22qNyVO+XVBzrM8fk8BSUFuiT/6tZTYXRtEt5aKQZgXbKU5dUF3jT9qg\n"
235 "j/Br5BZw3X/zd325TvnswzMC1+ljLzHnQGGk\n"
236 "-----END CERTIFICATE-----\n"
240 /** return the built in root DS trust anchor */
245 /* The anchors must start on a new line with ". IN DS and end with \n"[;]
246 * because the makedist script greps on the source here */
247 /* anchor 19036 is from 2010 */
248 /* anchor 20326 is from 2017 */
249 ". IN DS 19036 8 2 49AAC11D7B6F6446702E54A1607371607A1A41855200FD2CE1CDDE32F24E8FB5\n"
250 ". IN DS 20326 8 2 E06D44B80B8F1D39A95C0B0D7C65D08458E880409BBC683457104237C7F8EC8D\n";
253 /** print hex data */
255 print_data(const char* msg, const char* data, int len)
259 for(i=0; i<len; i++) {
260 printf(" %2.2x", (unsigned char)data[i]);
265 /** print ub context creation error and exit */
267 ub_ctx_error_exit(struct ub_ctx* ctx, const char* str, const char* str2)
270 if(str && str2 && verb) printf("%s: %s\n", str, str2);
271 if(verb) printf("error: could not create unbound resolver context\n");
276 * Create a new unbound context with the commandline settings applied
278 static struct ub_ctx*
279 create_unbound_context(const char* res_conf, const char* root_hints,
280 const char* debugconf, int ip4only, int ip6only)
283 struct ub_ctx* ctx = ub_ctx_create();
285 if(verb) printf("out of memory\n");
288 /* do not waste time and network traffic to fetch extra nameservers */
289 r = ub_ctx_set_option(ctx, "target-fetch-policy:", "0 0 0 0 0");
290 if(r && verb) printf("ctx targetfetchpolicy: %s\n", ub_strerror(r));
291 /* read config file first, so its settings can be overridden */
293 r = ub_ctx_config(ctx, debugconf);
294 if(r) ub_ctx_error_exit(ctx, debugconf, ub_strerror(r));
297 r = ub_ctx_resolvconf(ctx, res_conf);
298 if(r) ub_ctx_error_exit(ctx, res_conf, ub_strerror(r));
301 r = ub_ctx_set_option(ctx, "root-hints:", root_hints);
302 if(r) ub_ctx_error_exit(ctx, root_hints, ub_strerror(r));
305 r = ub_ctx_set_option(ctx, "do-ip6:", "no");
306 if(r) ub_ctx_error_exit(ctx, "ip4only", ub_strerror(r));
309 r = ub_ctx_set_option(ctx, "do-ip4:", "no");
310 if(r) ub_ctx_error_exit(ctx, "ip6only", ub_strerror(r));
315 /** printout certificate in detail */
317 verb_cert(const char* msg, X509* x)
319 if(verb == 0 || verb == 1) return;
321 if(msg) printf("%s\n", msg);
322 X509_print_ex_fp(stdout, x, 0, (unsigned long)-1
323 ^(X509_FLAG_NO_SUBJECT
324 |X509_FLAG_NO_ISSUER|X509_FLAG_NO_VALIDITY));
327 if(msg) printf("%s\n", msg);
328 X509_print_fp(stdout, x);
331 /** printout certificates in detail */
333 verb_certs(const char* msg, STACK_OF(X509)* sk)
335 int i, num = sk_X509_num(sk);
336 if(verb == 0 || verb == 1) return;
337 for(i=0; i<num; i++) {
338 printf("%s (%d/%d)\n", msg, i, num);
339 verb_cert(NULL, sk_X509_value(sk, i));
343 /** read certificates from a PEM bio */
344 static STACK_OF(X509)*
345 read_cert_bio(BIO* bio)
347 STACK_OF(X509) *sk = sk_X509_new_null();
349 if(verb) printf("out of memory\n");
352 while(!BIO_eof(bio)) {
353 X509* x = PEM_read_bio_X509(bio, NULL, 0, NULL);
356 printf("failed to read X509\n");
357 ERR_print_errors_fp(stdout);
361 if(!sk_X509_push(sk, x)) {
362 if(verb) printf("out of memory\n");
369 /* read the certificate file */
370 static STACK_OF(X509)*
371 read_cert_file(const char* file)
377 if(file == NULL || strcmp(file, "") == 0) {
380 sk = sk_X509_new_null();
382 if(verb) printf("out of memory\n");
385 in = fopen(file, "r");
387 if(verb) printf("%s: %s\n", file, strerror(errno));
389 sk_X509_pop_free(sk, X509_free);
394 X509* x = PEM_read_X509(in, NULL, 0, NULL);
397 printf("failed to read X509 file\n");
398 ERR_print_errors_fp(stdout);
402 if(!sk_X509_push(sk, x)) {
403 if(verb) printf("out of memory\n");
408 /* read away newline after --END CERT-- */
409 if(!fgets(buf, (int)sizeof(buf), in))
414 if(verb) printf("%s is empty\n", file);
416 sk_X509_pop_free(sk, X509_free);
423 /** read certificates from the builtin certificate */
424 static STACK_OF(X509)*
425 read_builtin_cert(void)
427 const char* builtin_cert = get_builtin_cert();
429 BIO *bio = BIO_new_mem_buf(builtin_cert,
430 (int)strlen(builtin_cert));
432 if(verb) printf("out of memory\n");
435 sk = read_cert_bio(bio);
437 if(verb) printf("internal error, out of memory\n");
444 /** read update cert file or use builtin */
445 static STACK_OF(X509)*
446 read_cert_or_builtin(const char* file)
448 STACK_OF(X509) *sk = read_cert_file(file);
450 if(verb) printf("using builtin certificate\n");
451 sk = read_builtin_cert();
453 if(verb) printf("have %d trusted certificates\n", sk_X509_num(sk));
454 verb_certs("trusted certificates", sk);
459 do_list_builtin(void)
461 const char* builtin_cert = get_builtin_cert();
462 const char* builtin_ds = get_builtin_ds();
463 printf("%s\n", builtin_ds);
464 printf("%s\n", builtin_cert);
468 /** printout IP address with message */
470 verb_addr(const char* msg, struct ip_list* ip)
474 void* a = &((struct sockaddr_in*)&ip->addr)->sin_addr;
475 if(ip->len != (socklen_t)sizeof(struct sockaddr_in))
476 a = &((struct sockaddr_in6*)&ip->addr)->sin6_addr;
478 if(inet_ntop((int)((struct sockaddr_in*)&ip->addr)->sin_family,
479 a, out, (socklen_t)sizeof(out))==0)
480 printf("%s (inet_ntop error)\n", msg);
481 else printf("%s %s\n", msg, out);
487 ip_list_free(struct ip_list* p)
497 /** create ip_list entry for a RR record */
498 static struct ip_list*
499 RR_to_ip(int tp, char* data, int len, int port)
501 struct ip_list* ip = (struct ip_list*)calloc(1, sizeof(*ip));
502 uint16_t p = (uint16_t)port;
503 if(tp == LDNS_RR_TYPE_A) {
504 struct sockaddr_in* sa = (struct sockaddr_in*)&ip->addr;
505 ip->len = (socklen_t)sizeof(*sa);
506 sa->sin_family = AF_INET;
507 sa->sin_port = (in_port_t)htons(p);
508 if(len != (int)sizeof(sa->sin_addr)) {
509 if(verb) printf("skipped badly formatted A\n");
513 memmove(&sa->sin_addr, data, sizeof(sa->sin_addr));
515 } else if(tp == LDNS_RR_TYPE_AAAA) {
516 struct sockaddr_in6* sa = (struct sockaddr_in6*)&ip->addr;
517 ip->len = (socklen_t)sizeof(*sa);
518 sa->sin6_family = AF_INET6;
519 sa->sin6_port = (in_port_t)htons(p);
520 if(len != (int)sizeof(sa->sin6_addr)) {
521 if(verb) printf("skipped badly formatted AAAA\n");
525 memmove(&sa->sin6_addr, data, sizeof(sa->sin6_addr));
527 if(verb) printf("internal error: bad type in RRtoip\n");
531 verb_addr("resolved server address", ip);
535 /** Resolve name, type, class and add addresses to iplist */
537 resolve_host_ip(struct ub_ctx* ctx, const char* host, int port, int tp, int cl,
538 struct ip_list** head)
540 struct ub_result* res = NULL;
544 r = ub_resolve(ctx, host, tp, cl, &res);
546 if(verb) printf("error: resolve %s %s: %s\n", host,
547 (tp==LDNS_RR_TYPE_A)?"A":"AAAA", ub_strerror(r));
551 if(verb) printf("out of memory\n");
555 if(!res->havedata || res->rcode || !res->data) {
556 if(verb) printf("resolve %s %s: no result\n", host,
557 (tp==LDNS_RR_TYPE_A)?"A":"AAAA");
560 for(i = 0; res->data[i]; i++) {
561 struct ip_list* ip = RR_to_ip(tp, res->data[i], res->len[i],
567 ub_resolve_free(res);
570 /** parse a text IP address into a sockaddr */
571 static struct ip_list*
572 parse_ip_addr(const char* str, int port)
576 struct sockaddr_in6 a6;
577 struct sockaddr_in a;
580 uint16_t p = (uint16_t)port;
581 memset(&addr, 0, sizeof(addr));
583 if(inet_pton(AF_INET6, str, &addr.a6.sin6_addr) > 0) {
585 addr.a6.sin6_family = AF_INET6;
586 addr.a6.sin6_port = (in_port_t)htons(p);
587 len = (socklen_t)sizeof(addr.a6);
589 if(inet_pton(AF_INET, str, &addr.a.sin_addr) > 0) {
591 addr.a.sin_family = AF_INET;
592 addr.a.sin_port = (in_port_t)htons(p);
593 len = (socklen_t)sizeof(struct sockaddr_in);
595 if(!len) return NULL;
596 ip = (struct ip_list*)calloc(1, sizeof(*ip));
598 if(verb) printf("out of memory\n");
602 memmove(&ip->addr, &addr, len);
603 if(verb) printf("server address is %s\n", str);
608 * Resolve a domain name (even though the resolver is down and there is
609 * no trust anchor). Without DNSSEC validation.
610 * @param host: the name to resolve.
611 * If this name is an IP4 or IP6 address this address is returned.
612 * @param port: the port number used for the returned IP structs.
613 * @param res_conf: resolv.conf (if any).
614 * @param root_hints: root hints (if any).
615 * @param debugconf: unbound.conf for debugging options.
616 * @param ip4only: use only ip4 for resolve and only lookup A
617 * @param ip6only: use only ip6 for resolve and only lookup AAAA
618 * default is to lookup A and AAAA using ip4 and ip6.
619 * @return list of IP addresses.
621 static struct ip_list*
622 resolve_name(const char* host, int port, const char* res_conf,
623 const char* root_hints, const char* debugconf, int ip4only, int ip6only)
626 struct ip_list* list = NULL;
627 /* first see if name is an IP address itself */
628 if( (list=parse_ip_addr(host, port)) ) {
632 /* create resolver context */
633 ctx = create_unbound_context(res_conf, root_hints, debugconf,
636 /* try resolution of A */
638 resolve_host_ip(ctx, host, port, LDNS_RR_TYPE_A,
639 LDNS_RR_CLASS_IN, &list);
642 /* try resolution of AAAA */
644 resolve_host_ip(ctx, host, port, LDNS_RR_TYPE_AAAA,
645 LDNS_RR_CLASS_IN, &list);
650 if(verb) printf("%s has no IP addresses I can use\n", host);
656 /** clear used flags */
658 wipe_ip_usage(struct ip_list* p)
666 /** count unused IPs */
668 count_unused(struct ip_list* p)
678 /** pick random unused element from IP list */
679 static struct ip_list*
680 pick_random_ip(struct ip_list* list)
682 struct ip_list* p = list;
683 int num = count_unused(list);
685 if(num == 0) return NULL;
686 /* not perfect, but random enough */
687 sel = (int)arc4random_uniform((uint32_t)num);
688 /* skip over unused elements that we did not select */
689 while(sel > 0 && p) {
693 /* find the next unused element */
696 if(!p) return NULL; /* robustness */
711 /** printout socket errno */
713 print_sock_err(const char* msg)
716 if(verb) printf("%s: %s\n", msg, strerror(errno));
718 if(verb) printf("%s: %s\n", msg, wsa_strerror(WSAGetLastError()));
722 /** connect to IP address */
724 connect_to_ip(struct ip_list* ip)
727 verb_addr("connect to", ip);
728 fd = socket(ip->len==(socklen_t)sizeof(struct sockaddr_in)?
729 AF_INET:AF_INET6, SOCK_STREAM, 0);
731 print_sock_err("socket");
734 if(connect(fd, (struct sockaddr*)&ip->addr, ip->len) < 0) {
735 print_sock_err("connect");
742 /** create SSL context */
746 SSL_CTX* sslctx = SSL_CTX_new(SSLv23_client_method());
748 if(verb) printf("SSL_CTX_new error\n");
754 /** initiate TLS on a connection */
756 TLS_initiate(SSL_CTX* sslctx, int fd)
760 SSL* ssl = SSL_new(sslctx);
762 if(verb) printf("SSL_new error\n");
765 SSL_set_connect_state(ssl);
766 (void)SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
767 if(!SSL_set_fd(ssl, fd)) {
768 if(verb) printf("SSL_set_fd error\n");
774 if( (r=SSL_do_handshake(ssl)) == 1)
776 r = SSL_get_error(ssl, r);
777 if(r != SSL_ERROR_WANT_READ && r != SSL_ERROR_WANT_WRITE) {
778 if(verb) printf("SSL handshake failed\n");
782 /* wants to be called again */
784 x = SSL_get_peer_certificate(ssl);
786 if(verb) printf("Server presented no peer certificate\n");
790 verb_cert("server SSL certificate", x);
795 /** perform neat TLS shutdown */
797 TLS_shutdown(int fd, SSL* ssl, SSL_CTX* sslctx)
799 /* shutdown the SSL connection nicely */
800 if(SSL_shutdown(ssl) == 0) {
804 SSL_CTX_free(sslctx);
808 /** write a line over SSL */
810 write_ssl_line(SSL* ssl, const char* str, const char* sec)
815 snprintf(buf, sizeof(buf), str, sec);
817 snprintf(buf, sizeof(buf), "%s", str);
820 if(l+2 >= sizeof(buf)) {
821 if(verb) printf("line too long\n");
824 if(verb >= 2) printf("SSL_write: %s\n", buf);
829 if(SSL_write(ssl, buf, (int)strlen(buf)) <= 0) {
830 if(verb) printf("could not SSL_write %s", str);
836 /** process header line, check rcode and keeping track of size */
838 process_one_header(char* buf, size_t* clen, int* chunked)
840 if(verb>=2) printf("header: '%s'\n", buf);
841 if(strncasecmp(buf, "HTTP/1.1 ", 9) == 0) {
842 /* check returncode */
844 if(verb) printf("bad status %s\n", buf+9);
847 } else if(strncasecmp(buf, "Content-Length: ", 16) == 0) {
849 *clen = (size_t)atoi(buf+16);
850 } else if(strncasecmp(buf, "Transfer-Encoding: chunked", 19+7) == 0) {
858 * Read one line from SSL
860 * skips "\r\n" (but not copied to buf).
861 * @param ssl: the SSL connection to read from (blocking).
862 * @param buf: buffer to return line in.
863 * @param len: size of the buffer.
864 * @return 0 on error, 1 on success.
867 read_ssl_line(SSL* ssl, char* buf, size_t len)
874 if(verb) printf("line too long\n");
877 if((r = SSL_read(ssl, buf+n, 1)) <= 0) {
878 if(SSL_get_error(ssl, r) == SSL_ERROR_ZERO_RETURN) {
882 if(verb) printf("could not SSL_read\n");
885 if(endnl && buf[n] == '\n') {
889 if(verb) printf("error: stray linefeeds\n");
891 } else if(buf[n] == '\r') {
892 /* skip \r, and also \n on the wire */
895 } else if(buf[n] == '\n') {
896 /* skip the \n, we are done */
904 /** read http headers and process them */
906 read_http_headers(SSL* ssl, size_t* clen)
911 while(read_ssl_line(ssl, buf, sizeof(buf))) {
914 if(!process_one_header(buf, clen, &chunked))
920 /** read a data chunk */
922 read_data_chunk(SSL* ssl, size_t len)
927 if(len >= 0xfffffff0)
928 return NULL; /* to protect against integer overflow in malloc*/
929 data = malloc(len+1);
931 if(verb) printf("out of memory\n");
935 if((r = SSL_read(ssl, data+got, (int)(len-got))) <= 0) {
936 if(SSL_get_error(ssl, r) == SSL_ERROR_ZERO_RETURN) {
938 if(verb) printf("could not SSL_read: unexpected EOF\n");
942 if(verb) printf("could not SSL_read\n");
946 if(verb >= 2) printf("at %d/%d\n", (int)got, (int)len);
949 if(verb>=2) printf("read %d data\n", (int)len);
954 /** parse chunk header */
956 parse_chunk_header(char* buf, size_t* result)
959 size_t v = (size_t)strtol(buf, &e, 16);
966 /** read chunked data from connection */
968 do_chunked_read(SSL* ssl)
973 BIO* mem = BIO_new(BIO_s_mem());
974 if(verb>=3) printf("do_chunked_read\n");
976 if(verb) printf("out of memory\n");
979 while(read_ssl_line(ssl, buf, sizeof(buf))) {
980 /* read the chunked start line */
981 if(verb>=2) printf("chunk header: %s\n", buf);
982 if(!parse_chunk_header(buf, &len)) {
984 if(verb>=3) printf("could not parse chunk header\n");
987 if(verb>=2) printf("chunk len: %d\n", (int)len);
991 /* skip end-of-chunk-trailer lines,
992 * until the empty line after that */
994 if(!read_ssl_line(ssl, buf, sizeof(buf))) {
998 } while (strlen(buf) > 0);
999 /* end of chunks, zero terminate it */
1000 if(BIO_write(mem, &z, 1) <= 0) {
1001 if(verb) printf("out of memory\n");
1007 /* read the chunked body */
1008 body = read_data_chunk(ssl, len);
1013 if(BIO_write(mem, body, (int)len) <= 0) {
1014 if(verb) printf("out of memory\n");
1020 /* skip empty line after data chunk */
1021 if(!read_ssl_line(ssl, buf, sizeof(buf))) {
1030 /** start HTTP1.1 transaction on SSL */
1032 write_http_get(SSL* ssl, const char* pathname, const char* urlname)
1034 if(write_ssl_line(ssl, "GET /%s HTTP/1.1", pathname) &&
1035 write_ssl_line(ssl, "Host: %s", urlname) &&
1036 write_ssl_line(ssl, "User-Agent: unbound-anchor/%s",
1038 /* We do not really do multiple queries per connection,
1039 * but this header setting is also not needed.
1040 * write_ssl_line(ssl, "Connection: close", NULL) &&*/
1041 write_ssl_line(ssl, "", NULL)) {
1047 /** read chunked data and zero terminate; len is without zero */
1049 read_chunked_zero_terminate(SSL* ssl, size_t* len)
1051 /* do the chunked version */
1052 BIO* tmp = do_chunked_read(ssl);
1053 char* data, *d = NULL;
1056 if(verb) printf("could not read from https\n");
1059 l = (size_t)BIO_get_mem_data(tmp, &d);
1060 if(verb>=2) printf("chunked data is %d\n", (int)l);
1061 if(l == 0 || d == NULL) {
1062 if(verb) printf("out of memory\n");
1066 data = (char*)malloc(l);
1068 if(verb) printf("out of memory\n");
1076 /** read HTTP result from SSL */
1078 read_http_result(SSL* ssl)
1083 if(!read_http_headers(ssl, &len)) {
1087 data = read_chunked_zero_terminate(ssl, &len);
1089 data = read_data_chunk(ssl, len);
1091 if(!data) return NULL;
1092 if(verb >= 4) print_data("read data", data, (int)len);
1093 m = BIO_new(BIO_s_mem());
1095 if(verb) printf("out of memory\n");
1099 BIO_write(m, data, (int)len);
1104 /** https to an IP addr, return BIO with pathname or NULL */
1106 https_to_ip(struct ip_list* ip, const char* pathname, const char* urlname)
1111 SSL_CTX* sslctx = setup_sslctx();
1115 fd = connect_to_ip(ip);
1117 SSL_CTX_free(sslctx);
1120 ssl = TLS_initiate(sslctx, fd);
1122 SSL_CTX_free(sslctx);
1126 if(!write_http_get(ssl, pathname, urlname)) {
1127 if(verb) printf("could not write to server\n");
1129 SSL_CTX_free(sslctx);
1133 bio = read_http_result(ssl);
1134 TLS_shutdown(fd, ssl, sslctx);
1139 * Do a HTTPS, HTTP1.1 over TLS, to fetch a file
1140 * @param ip_list: list of IP addresses to use to fetch from.
1141 * @param pathname: pathname of file on server to GET.
1142 * @param urlname: name to pass as the virtual host for this request.
1143 * @return a memory BIO with the file in it.
1146 https(struct ip_list* ip_list, const char* pathname, const char* urlname)
1150 /* try random address first, and work through the list */
1151 wipe_ip_usage(ip_list);
1152 while( (ip = pick_random_ip(ip_list)) ) {
1154 bio = https_to_ip(ip, pathname, urlname);
1158 if(verb) printf("could not fetch %s\n", pathname);
1161 if(verb) printf("fetched %s (%d bytes)\n",
1162 pathname, (int)BIO_ctrl_pending(bio));
1167 /** XML parse private data during the parse */
1169 /** the parser, reference */
1171 /** the current tag; malloced; or NULL outside of tags */
1173 /** current date to use during the parse */
1175 /** number of keys usefully read in */
1177 /** the compiled anchors as DS records */
1180 /** do we want to use this anchor? */
1182 /** the current anchor: Zone */
1184 /** the current anchor: KeyTag */
1186 /** the current anchor: Algorithm */
1188 /** the current anchor: DigestType */
1190 /** the current anchor: Digest*/
1194 /** The BIO for the tag */
1196 xml_selectbio(struct xml_data* data, const char* tag)
1199 if(strcasecmp(tag, "KeyTag") == 0)
1201 else if(strcasecmp(tag, "Algorithm") == 0)
1203 else if(strcasecmp(tag, "DigestType") == 0)
1205 else if(strcasecmp(tag, "Digest") == 0)
1211 * XML handle character data, the data inside an element.
1212 * @param userData: xml_data structure
1213 * @param s: the character data. May not all be in one callback.
1214 * NOT zero terminated.
1215 * @param len: length of this part of the data.
1218 xml_charhandle(void *userData, const XML_Char *s, int len)
1220 struct xml_data* data = (struct xml_data*)userData;
1222 /* skip characters outside of elements */
1227 printf("%s%s charhandle: '",
1228 data->use_key?"use ":"",
1229 data->tag?data->tag:"none");
1230 for(i=0; i<len; i++)
1234 if(strcasecmp(data->tag, "Zone") == 0) {
1235 if(BIO_write(data->czone, s, len) < 0) {
1236 if(verb) printf("out of memory in BIO_write\n");
1241 /* only store if key is used */
1244 b = xml_selectbio(data, data->tag);
1246 if(BIO_write(b, s, len) < 0) {
1247 if(verb) printf("out of memory in BIO_write\n");
1254 * XML fetch value of particular attribute(by name) or NULL if not present.
1255 * @param atts: attribute array (from xml_startelem).
1256 * @param name: name of attribute to look for.
1257 * @return the value or NULL. (ptr into atts).
1259 static const XML_Char*
1260 find_att(const XML_Char **atts, const XML_Char* name)
1263 for(i=0; atts[i]; i+=2) {
1264 if(strcasecmp(atts[i], name) == 0)
1271 * XML convert DateTime element to time_t.
1272 * [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]
1273 * (with optional .ssssss fractional seconds)
1274 * @param str: the string
1275 * @return a time_t representation or 0 on failure.
1278 xml_convertdate(const char* str)
1283 /* for this application, ignore minus in front;
1284 * only positive dates are expected */
1286 if(s[0] == '-') s++;
1287 memset(&tm, 0, sizeof(tm));
1288 /* parse initial content of the string (lots of whitespace allowed) */
1289 s = strptime(s, "%t%Y%t-%t%m%t-%t%d%tT%t%H%t:%t%M%t:%t%S%t", &tm);
1291 if(verb) printf("xml_convertdate parse failure %s\n", str);
1294 /* parse remainder of date string */
1296 /* optional '.' and fractional seconds */
1297 int frac = 0, n = 0;
1298 if(sscanf(s+1, "%d%n", &frac, &n) < 1) {
1299 if(verb) printf("xml_convertdate f failure %s\n", str);
1302 /* fraction is not used, time_t has second accuracy */
1306 if(*s == 'Z' || *s == 'z') {
1307 /* nothing to do for this */
1309 } else if(*s == '+' || *s == '-') {
1310 /* optional timezone spec: Z or +hh:mm or -hh:mm */
1311 int hr = 0, mn = 0, n = 0;
1312 if(sscanf(s+1, "%d:%d%n", &hr, &mn, &n) < 2) {
1313 if(verb) printf("xml_convertdate tz failure %s\n", str);
1327 /* not ended properly */
1328 /* but ignore, (lenient) */
1331 t = sldns_mktime_from_utc(&tm);
1332 if(t == (time_t)-1) {
1333 if(verb) printf("xml_convertdate mktime failure\n");
1340 * XML handle the KeyDigest start tag, check validity periods.
1343 handle_keydigest(struct xml_data* data, const XML_Char **atts)
1346 if(find_att(atts, "validFrom")) {
1347 time_t from = xml_convertdate(find_att(atts, "validFrom"));
1349 if(verb) printf("error: xml cannot be parsed\n");
1352 if(data->date < from)
1355 if(find_att(atts, "validUntil")) {
1356 time_t until = xml_convertdate(find_att(atts, "validUntil"));
1358 if(verb) printf("error: xml cannot be parsed\n");
1361 if(data->date > until)
1364 /* yes we want to use this key */
1366 (void)BIO_reset(data->ctag);
1367 (void)BIO_reset(data->calgo);
1368 (void)BIO_reset(data->cdigtype);
1369 (void)BIO_reset(data->cdigest);
1372 /** See if XML element equals the zone name */
1374 xml_is_zone_name(BIO* zone, const char* name)
1379 (void)BIO_seek(zone, 0);
1380 zlen = BIO_get_mem_data(zone, &z);
1381 if(!zlen || !z) return 0;
1382 /* zero terminate */
1383 if(zlen >= (long)sizeof(buf)) return 0;
1384 memmove(buf, z, (size_t)zlen);
1387 return (strncasecmp(buf, name, strlen(name)) == 0);
1391 * XML start of element. This callback is called whenever an XML tag starts.
1393 * @param userData: the xml_data structure.
1394 * @param name: the tag that starts.
1395 * @param atts: array of strings, pairs of attr = value, ends with NULL.
1396 * i.e. att[0]="att[1]" att[2]="att[3]" att[4]isNull
1399 xml_startelem(void *userData, const XML_Char *name, const XML_Char **atts)
1401 struct xml_data* data = (struct xml_data*)userData;
1403 if(verb>=4) printf("xml tag start '%s'\n", name);
1405 data->tag = strdup(name);
1407 if(verb) printf("out of memory\n");
1412 for(i=0; atts[i]; i+=2) {
1413 printf(" %s='%s'\n", atts[i], atts[i+1]);
1416 /* handle attributes to particular types */
1417 if(strcasecmp(name, "KeyDigest") == 0) {
1418 handle_keydigest(data, atts);
1420 } else if(strcasecmp(name, "Zone") == 0) {
1421 (void)BIO_reset(data->czone);
1425 /* for other types we prepare to pick up the data */
1428 b = xml_selectbio(data, data->tag);
1435 /** Append str to bio */
1437 xml_append_str(BIO* b, const char* s)
1439 if(BIO_write(b, s, (int)strlen(s)) < 0) {
1440 if(verb) printf("out of memory in BIO_write\n");
1445 /** Append bio to bio */
1447 xml_append_bio(BIO* b, BIO* a)
1451 (void)BIO_seek(a, 0);
1452 len = BIO_get_mem_data(a, &z);
1454 if(verb) printf("out of memory in BIO_write\n");
1457 /* remove newlines in the data here */
1458 for(i=0; i<len; i++) {
1459 if(z[i] == '\r' || z[i] == '\n')
1463 if(BIO_write(b, z, len) < 0) {
1464 if(verb) printf("out of memory in BIO_write\n");
1469 /** write the parsed xml-DS to the DS list */
1471 xml_append_ds(struct xml_data* data)
1473 /* write DS to accumulated DS */
1474 xml_append_str(data->ds, ". IN DS ");
1475 xml_append_bio(data->ds, data->ctag);
1476 xml_append_str(data->ds, " ");
1477 xml_append_bio(data->ds, data->calgo);
1478 xml_append_str(data->ds, " ");
1479 xml_append_bio(data->ds, data->cdigtype);
1480 xml_append_str(data->ds, " ");
1481 xml_append_bio(data->ds, data->cdigest);
1482 xml_append_str(data->ds, "\n");
1487 * XML end of element. This callback is called whenever an XML tag ends.
1489 * @param userData: the xml_data structure
1490 * @param name: the tag that ends.
1493 xml_endelem(void *userData, const XML_Char *name)
1495 struct xml_data* data = (struct xml_data*)userData;
1496 if(verb>=4) printf("xml tag end '%s'\n", name);
1499 if(strcasecmp(name, "KeyDigest") == 0) {
1501 xml_append_ds(data);
1503 } else if(strcasecmp(name, "Zone") == 0) {
1504 if(!xml_is_zone_name(data->czone, ".")) {
1505 if(verb) printf("xml not for the right zone\n");
1511 /* Stop the parser when an entity declaration is encountered. For safety. */
1513 xml_entitydeclhandler(void *userData,
1514 const XML_Char *ATTR_UNUSED(entityName),
1515 int ATTR_UNUSED(is_parameter_entity),
1516 const XML_Char *ATTR_UNUSED(value), int ATTR_UNUSED(value_length),
1517 const XML_Char *ATTR_UNUSED(base),
1518 const XML_Char *ATTR_UNUSED(systemId),
1519 const XML_Char *ATTR_UNUSED(publicId),
1520 const XML_Char *ATTR_UNUSED(notationName))
1522 #if HAVE_DECL_XML_STOPPARSER
1523 (void)XML_StopParser((XML_Parser)userData, XML_FALSE);
1530 * XML parser setup of the callbacks for the tags
1533 xml_parse_setup(XML_Parser parser, struct xml_data* data, time_t now)
1536 memset(data, 0, sizeof(*data));
1537 XML_SetUserData(parser, data);
1538 data->parser = parser;
1540 data->ds = BIO_new(BIO_s_mem());
1541 data->ctag = BIO_new(BIO_s_mem());
1542 data->czone = BIO_new(BIO_s_mem());
1543 data->calgo = BIO_new(BIO_s_mem());
1544 data->cdigtype = BIO_new(BIO_s_mem());
1545 data->cdigest = BIO_new(BIO_s_mem());
1546 if(!data->ds || !data->ctag || !data->calgo || !data->czone ||
1547 !data->cdigtype || !data->cdigest) {
1548 if(verb) printf("out of memory\n");
1551 snprintf(buf, sizeof(buf), "; created by unbound-anchor on %s",
1553 if(BIO_write(data->ds, buf, (int)strlen(buf)) < 0) {
1554 if(verb) printf("out of memory\n");
1557 XML_SetEntityDeclHandler(parser, xml_entitydeclhandler);
1558 XML_SetElementHandler(parser, xml_startelem, xml_endelem);
1559 XML_SetCharacterDataHandler(parser, xml_charhandle);
1563 * Perform XML parsing of the root-anchors file
1564 * Its format description can be read here
1565 * https://data.iana.org/root-anchors/draft-icann-dnssec-trust-anchor.txt
1567 * @param xml: BIO with xml data.
1568 * @param now: the current time for checking DS validity periods.
1569 * @return memoryBIO with the DS data in zone format.
1570 * or NULL if the zone is insecure.
1571 * (It exit()s on error)
1574 xml_parse(BIO* xml, time_t now)
1579 struct xml_data data;
1581 parser = XML_ParserCreate(NULL);
1583 if(verb) printf("could not XML_ParserCreate\n");
1587 /* setup callbacks */
1588 xml_parse_setup(parser, &data, now);
1591 (void)BIO_seek(xml, 0);
1592 len = (int)BIO_get_mem_data(xml, &pp);
1594 if(verb) printf("out of memory\n");
1597 if(!XML_Parse(parser, pp, len, 1 /*isfinal*/ )) {
1598 const char *e = XML_ErrorString(XML_GetErrorCode(parser));
1599 if(verb) printf("XML_Parse failure %s\n", e?e:"");
1604 if(verb) printf("XML was parsed successfully, %d keys\n",
1607 XML_ParserFree(parser);
1610 (void)BIO_seek(data.ds, 0);
1611 len = BIO_get_mem_data(data.ds, &pp);
1612 printf("got DS bio %d: '", len);
1613 if(!fwrite(pp, (size_t)len, 1, stdout))
1614 /* compilers do not allow us to ignore fwrite .. */
1615 fprintf(stderr, "error writing to stdout\n");
1618 BIO_free(data.czone);
1619 BIO_free(data.ctag);
1620 BIO_free(data.calgo);
1621 BIO_free(data.cdigtype);
1622 BIO_free(data.cdigest);
1624 if(data.num_keys == 0) {
1625 /* the root zone seems to have gone insecure */
1633 /* get key usage out of its extension, returns 0 if no key_usage extension */
1634 static unsigned long
1635 get_usage_of_ex(X509* cert)
1637 unsigned long val = 0;
1639 if((s=X509_get_ext_d2i(cert, NID_key_usage, NULL, NULL))) {
1643 val |= s->data[1] << 8;
1645 ASN1_BIT_STRING_free(s);
1650 /** get valid signers from the list of signers in the signature */
1651 static STACK_OF(X509)*
1652 get_valid_signers(PKCS7* p7, const char* p7signer)
1655 STACK_OF(X509)* validsigners = sk_X509_new_null();
1656 STACK_OF(X509)* signers = PKCS7_get0_signers(p7, NULL, 0);
1657 unsigned long usage = 0;
1659 if(verb) printf("out of memory\n");
1660 sk_X509_free(signers);
1664 if(verb) printf("no signers in pkcs7 signature\n");
1665 sk_X509_free(validsigners);
1668 for(i=0; i<sk_X509_num(signers); i++) {
1669 X509_NAME* nm = X509_get_subject_name(
1670 sk_X509_value(signers, i));
1673 if(verb) printf("signer %d: cert has no subject name\n", i);
1677 char* nmline = X509_NAME_oneline(nm, buf,
1679 printf("signer %d: Subject: %s\n", i,
1680 nmline?nmline:"no subject");
1681 if(verb >= 3 && X509_NAME_get_text_by_NID(nm,
1682 NID_commonName, buf, (int)sizeof(buf)))
1683 printf("commonName: %s\n", buf);
1684 if(verb >= 3 && X509_NAME_get_text_by_NID(nm,
1685 NID_pkcs9_emailAddress, buf, (int)sizeof(buf)))
1686 printf("emailAddress: %s\n", buf);
1689 int ku_loc = X509_get_ext_by_NID(
1690 sk_X509_value(signers, i), NID_key_usage, -1);
1691 if(verb >= 3 && ku_loc >= 0) {
1692 X509_EXTENSION *ex = X509_get_ext(
1693 sk_X509_value(signers, i), ku_loc);
1695 printf("keyUsage: ");
1696 X509V3_EXT_print_fp(stdout, ex, 0, 0);
1701 if(!p7signer || strcmp(p7signer, "")==0) {
1702 /* there is no name to check, return all records */
1703 if(verb) printf("did not check commonName of signer\n");
1705 if(!X509_NAME_get_text_by_NID(nm,
1706 NID_pkcs9_emailAddress,
1707 buf, (int)sizeof(buf))) {
1708 if(verb) printf("removed cert with no name\n");
1709 continue; /* no name, no use */
1711 if(strcmp(buf, p7signer) != 0) {
1712 if(verb) printf("removed cert with wrong name\n");
1713 continue; /* wrong name, skip it */
1717 /* check that the key usage allows digital signatures
1719 usage = get_usage_of_ex(sk_X509_value(signers, i));
1720 if(!(usage & KU_DIGITAL_SIGNATURE)) {
1721 if(verb) printf("removed cert with no key usage Digital Signature allowed\n");
1725 /* we like this cert, add it to our list of valid
1726 * signers certificates */
1727 sk_X509_push(validsigners, sk_X509_value(signers, i));
1729 sk_X509_free(signers);
1730 return validsigners;
1733 /** verify a PKCS7 signature, false on failure */
1735 verify_p7sig(BIO* data, BIO* p7s, STACK_OF(X509)* trust, const char* p7signer)
1738 X509_STORE *store = X509_STORE_new();
1739 STACK_OF(X509)* validsigners;
1742 #ifdef X509_V_FLAG_CHECK_SS_SIGNATURE
1743 X509_VERIFY_PARAM* param = X509_VERIFY_PARAM_new();
1745 if(verb) printf("out of memory\n");
1746 X509_STORE_free(store);
1749 /* do the selfcheck on the root certificate; it checks that the
1751 X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CHECK_SS_SIGNATURE);
1752 if(store) X509_STORE_set1_param(store, param);
1755 if(verb) printf("out of memory\n");
1756 #ifdef X509_V_FLAG_CHECK_SS_SIGNATURE
1757 X509_VERIFY_PARAM_free(param);
1761 #ifdef X509_V_FLAG_CHECK_SS_SIGNATURE
1762 X509_VERIFY_PARAM_free(param);
1765 (void)BIO_seek(p7s, 0);
1766 (void)BIO_seek(data, 0);
1768 /* convert p7s to p7 (the signature) */
1769 p7 = d2i_PKCS7_bio(p7s, NULL);
1771 if(verb) printf("could not parse p7s signature file\n");
1772 X509_STORE_free(store);
1775 if(verb >= 2) printf("parsed the PKCS7 signature\n");
1777 /* convert trust to trusted certificate store */
1778 for(i=0; i<sk_X509_num(trust); i++) {
1779 if(!X509_STORE_add_cert(store, sk_X509_value(trust, i))) {
1780 if(verb) printf("failed X509_STORE_add_cert\n");
1781 X509_STORE_free(store);
1786 if(verb >= 2) printf("setup the X509_STORE\n");
1788 /* check what is in the Subject name of the certificates,
1789 * and build a stack that contains only the right certificates */
1790 validsigners = get_valid_signers(p7, p7signer);
1792 X509_STORE_free(store);
1796 if(PKCS7_verify(p7, validsigners, store, data, NULL, PKCS7_NOINTERN) == 1) {
1798 if(verb) printf("the PKCS7 signature verified\n");
1801 ERR_print_errors_fp(stdout);
1805 sk_X509_free(validsigners);
1806 X509_STORE_free(store);
1811 /** write unsigned root anchor file, a 5011 revoked tp */
1813 write_unsigned_root(const char* root_anchor_file)
1816 time_t now = time(NULL);
1817 out = fopen(root_anchor_file, "w");
1819 if(verb) printf("%s: %s\n", root_anchor_file, strerror(errno));
1822 if(fprintf(out, "; autotrust trust anchor file\n"
1825 "; This file was written by unbound-anchor on %s"
1826 "; It indicates that the root does not use DNSSEC\n"
1827 "; to restart DNSSEC overwrite this file with a\n"
1828 "; valid trustanchor or (empty-it and run unbound-anchor)\n"
1829 , ctime(&now)) < 0) {
1830 if(verb) printf("failed to write 'unsigned' to %s\n",
1832 if(verb && errno != 0) printf("%s\n", strerror(errno));
1838 FlushFileBuffers((HANDLE)_get_osfhandle(_fileno(out)));
1843 /** write root anchor file */
1845 write_root_anchor(const char* root_anchor_file, BIO* ds)
1850 (void)BIO_seek(ds, 0);
1851 len = BIO_get_mem_data(ds, &pp);
1853 if(verb) printf("out of memory\n");
1856 out = fopen(root_anchor_file, "w");
1858 if(verb) printf("%s: %s\n", root_anchor_file, strerror(errno));
1861 if(fwrite(pp, (size_t)len, 1, out) != 1) {
1862 if(verb) printf("failed to write all data to %s\n",
1864 if(verb && errno != 0) printf("%s\n", strerror(errno));
1870 FlushFileBuffers((HANDLE)_get_osfhandle(_fileno(out)));
1875 /** Perform the verification and update of the trustanchor file */
1877 verify_and_update_anchor(const char* root_anchor_file, BIO* xml, BIO* p7s,
1878 STACK_OF(X509)* cert, const char* p7signer)
1882 /* verify xml file */
1883 if(!verify_p7sig(xml, p7s, cert, p7signer)) {
1884 printf("the PKCS7 signature failed\n");
1888 /* parse the xml file into DS records */
1889 ds = xml_parse(xml, time(NULL));
1891 /* the root zone is unsigned now */
1892 write_unsigned_root(root_anchor_file);
1894 /* reinstate 5011 tracking */
1895 write_root_anchor(root_anchor_file, ds);
1901 static void do_wsa_cleanup(void) { WSACleanup(); }
1904 /** perform actual certupdate work */
1906 do_certupdate(const char* root_anchor_file, const char* root_cert_file,
1907 const char* urlname, const char* xmlname, const char* p7sname,
1908 const char* p7signer, const char* res_conf, const char* root_hints,
1909 const char* debugconf, int ip4only, int ip6only, int port)
1911 STACK_OF(X509)* cert;
1913 struct ip_list* ip_list = NULL;
1915 /* read pem file or provide builtin */
1916 cert = read_cert_or_builtin(root_cert_file);
1918 /* lookup A, AAAA for the urlname (or parse urlname if IP address) */
1919 ip_list = resolve_name(urlname, port, res_conf, root_hints, debugconf,
1923 if(1) { /* libunbound finished, startup WSA for the https connection */
1926 if((r = WSAStartup(MAKEWORD(2,2), &wsa_data)) != 0) {
1927 if(verb) printf("WSAStartup failed: %s\n",
1931 atexit(&do_wsa_cleanup);
1935 /* fetch the necessary files over HTTPS */
1936 xml = https(ip_list, xmlname, urlname);
1937 p7s = https(ip_list, p7sname, urlname);
1939 /* verify and update the root anchor */
1940 verify_and_update_anchor(root_anchor_file, xml, p7s, cert, p7signer);
1941 if(verb) printf("success: the anchor has been updated "
1942 "using the cert\n");
1947 sk_X509_pop_free(cert, X509_free);
1949 ip_list_free(ip_list);
1954 * Try to read the root RFC5011 autotrust anchor file,
1955 * @param file: filename.
1957 * 0 if does not exist or empty
1958 * 1 if trust-point-revoked-5011
1962 try_read_anchor(const char* file)
1967 FILE* in = fopen(file, "r");
1969 /* only if the file does not exist, can we fix it */
1970 if(errno != ENOENT) {
1971 if(verb) printf("%s: %s\n", file, strerror(errno));
1972 if(verb) printf("error: cannot access the file\n");
1975 if(verb) printf("%s does not exist\n", file);
1978 while(fgets(line, (int)sizeof(line), in)) {
1979 line[sizeof(line)-1] = 0;
1980 if(strncmp(line, ";;REVOKED", 9) == 0) {
1982 if(verb) printf("%s : the trust point is revoked\n"
1983 "and the zone is considered unsigned.\n"
1984 "if you wish to re-enable, delete the file\n",
1989 while(*p == ' ' || *p == '\t')
1991 if(p[0]==0 || p[0]=='\n' || p[0]==';') continue;
1992 /* this line is a line of content */
1997 if(verb) printf("%s is empty\n", file);
2000 if(verb) printf("%s has content\n", file);
2004 /** Write the builtin root anchor to a file */
2006 write_builtin_anchor(const char* file)
2008 const char* builtin_root_anchor = get_builtin_ds();
2009 FILE* out = fopen(file, "w");
2011 if(verb) printf("%s: %s\n", file, strerror(errno));
2012 if(verb) printf(" could not write builtin anchor\n");
2015 if(!fwrite(builtin_root_anchor, strlen(builtin_root_anchor), 1, out)) {
2016 if(verb) printf("%s: %s\n", file, strerror(errno));
2017 if(verb) printf(" could not complete write builtin anchor\n");
2023 * Check the root anchor file.
2024 * If does not exist, provide builtin and write file.
2025 * If empty, provide builtin and write file.
2026 * If trust-point-revoked-5011 file: make the program exit.
2027 * @param root_anchor_file: filename of the root anchor.
2028 * @param used_builtin: set to 1 if the builtin is written.
2029 * @return 0 if trustpoint is insecure, 1 on success. Exit on failure.
2032 provide_builtin(const char* root_anchor_file, int* used_builtin)
2034 /* try to read it */
2035 switch(try_read_anchor(root_anchor_file))
2037 case 0: /* no exist or empty */
2038 write_builtin_anchor(root_anchor_file);
2041 case 1: /* revoked tp */
2043 case 2: /* it is fine */
2051 * add an autotrust anchor for the root to the context
2054 add_5011_probe_root(struct ub_ctx* ctx, const char* root_anchor_file)
2057 r = ub_ctx_set_option(ctx, "auto-trust-anchor-file:", root_anchor_file);
2059 if(verb) printf("add 5011 probe to ctx: %s\n", ub_strerror(r));
2066 * Prime the root key and return the result. Exit on error.
2067 * @param ctx: the unbound context to perform the priming with.
2068 * @return: the result of the prime, on error it exit()s.
2070 static struct ub_result*
2071 prime_root_key(struct ub_ctx* ctx)
2073 struct ub_result* res = NULL;
2075 r = ub_resolve(ctx, ".", LDNS_RR_TYPE_DNSKEY, LDNS_RR_CLASS_IN, &res);
2077 if(verb) printf("resolve DNSKEY: %s\n", ub_strerror(r));
2082 if(verb) printf("out of memory\n");
2089 /** see if ADDPEND keys exist in autotrust file (if possible) */
2091 read_if_pending_keys(const char* file)
2093 FILE* in = fopen(file, "r");
2096 if(verb>=2) printf("%s: %s\n", file, strerror(errno));
2099 while(fgets(line, (int)sizeof(line), in)) {
2100 if(line[0]==';') continue;
2101 if(strstr(line, "[ ADDPEND ]")) {
2103 if(verb) printf("RFC5011-state has ADDPEND keys\n");
2111 /** read last successful probe time from autotrust file (if possible) */
2113 read_last_success_time(const char* file)
2115 FILE* in = fopen(file, "r");
2118 if(verb) printf("%s: %s\n", file, strerror(errno));
2121 while(fgets(line, (int)sizeof(line), in)) {
2122 if(strncmp(line, ";;last_success: ", 16) == 0) {
2124 time_t x = (unsigned int)strtol(line+16, &e, 10);
2127 if(verb) printf("failed to parse "
2128 "last_success probe time\n");
2131 if(verb) printf("last successful probe: %s", ctime(&x));
2136 if(verb) printf("no last_success probe time in anchor file\n");
2141 * Read autotrust 5011 probe file and see if the date
2142 * compared to the current date allows a certupdate.
2143 * If the last successful probe was recent then 5011 cannot be behind,
2144 * and the failure cannot be solved with a certupdate.
2145 * The debugconf is to validation-override the date for testing.
2146 * @param root_anchor_file: filename of root key
2147 * @return true if certupdate is ok.
2150 probe_date_allows_certupdate(const char* root_anchor_file)
2152 int has_pending_keys = read_if_pending_keys(root_anchor_file);
2153 int32_t last_success = read_last_success_time(root_anchor_file);
2154 int32_t now = (int32_t)time(NULL);
2155 int32_t leeway = 30 * 24 * 3600; /* 30 days leeway */
2156 /* if the date is before 2010-07-15:00.00.00 then the root has not
2157 * been signed yet, and thus we refuse to take action. */
2158 if(time(NULL) < xml_convertdate("2010-07-15T00:00:00")) {
2159 if(verb) printf("the date is before the root was first signed,"
2160 " please correct the clock\n");
2163 if(last_success == 0)
2164 return 1; /* no probe time */
2165 if(has_pending_keys)
2166 return 1; /* key in ADDPEND state, a previous probe has
2167 inserted that, and it was present in all recent probes,
2168 but it has not become active. The 30 day timer may not have
2169 expired, but we know(for sure) there is a rollover going on.
2170 If we only managed to pickup the new key on its last day
2171 of announcement (for example) this can happen. */
2172 if(now - last_success < 0) {
2173 if(verb) printf("the last successful probe is in the future,"
2174 " clock was modified\n");
2177 if(now - last_success >= leeway) {
2178 if(verb) printf("the last successful probe was more than 30 "
2182 if(verb) printf("the last successful probe is recent\n");
2186 static struct ub_result *
2187 fetch_root_key(const char* root_anchor_file, const char* res_conf,
2188 const char* root_hints, const char* debugconf,
2189 int ip4only, int ip6only)
2192 struct ub_result* dnskey;
2194 ctx = create_unbound_context(res_conf, root_hints, debugconf,
2196 add_5011_probe_root(ctx, root_anchor_file);
2197 dnskey = prime_root_key(ctx);
2202 /** perform the unbound-anchor work */
2204 do_root_update_work(const char* root_anchor_file, const char* root_cert_file,
2205 const char* urlname, const char* xmlname, const char* p7sname,
2206 const char* p7signer, const char* res_conf, const char* root_hints,
2207 const char* debugconf, int ip4only, int ip6only, int force,
2208 int res_conf_fallback, int port)
2210 struct ub_result* dnskey;
2211 int used_builtin = 0;
2214 /* see if builtin rootanchor needs to be provided, or if
2215 * rootanchor is 'revoked-trust-point' */
2216 if(!provide_builtin(root_anchor_file, &used_builtin))
2219 /* make unbound context with 5011-probe for root anchor,
2220 * and probe . DNSKEY */
2221 dnskey = fetch_root_key(root_anchor_file, res_conf,
2222 root_hints, debugconf, ip4only, ip6only);
2223 rcode = dnskey->rcode;
2225 if (res_conf_fallback && res_conf && !dnskey->secure) {
2226 if (verb) printf("%s failed, retrying direct\n", res_conf);
2227 ub_resolve_free(dnskey);
2228 /* try direct query without res_conf */
2229 dnskey = fetch_root_key(root_anchor_file, NULL,
2230 root_hints, debugconf, ip4only, ip6only);
2231 if (rcode != 0 && dnskey->rcode == 0) {
2237 /* if secure: exit */
2238 if(dnskey->secure && !force) {
2239 if(verb) printf("success: the anchor is ok\n");
2240 ub_resolve_free(dnskey);
2241 return used_builtin;
2243 if(force && verb) printf("debug cert update forced\n");
2244 ub_resolve_free(dnskey);
2246 /* if not (and NOERROR): check date and do certupdate */
2248 probe_date_allows_certupdate(root_anchor_file)) || force) {
2249 if(do_certupdate(root_anchor_file, root_cert_file, urlname,
2250 xmlname, p7sname, p7signer, res_conf, root_hints,
2251 debugconf, ip4only, ip6only, port))
2253 return used_builtin;
2255 if(verb) printf("fail: the anchor is NOT ok and could not be fixed\n");
2256 return used_builtin;
2259 /** getopt global, in case header files fail to declare it. */
2261 /** getopt global, in case header files fail to declare it. */
2262 extern char* optarg;
2264 /** Main routine for unbound-anchor */
2265 int main(int argc, char* argv[])
2268 const char* root_anchor_file = ROOT_ANCHOR_FILE;
2269 const char* root_cert_file = ROOT_CERT_FILE;
2270 const char* urlname = URLNAME;
2271 const char* xmlname = XMLNAME;
2272 const char* p7sname = P7SNAME;
2273 const char* p7signer = P7SIGNER;
2274 const char* res_conf = NULL;
2275 const char* root_hints = NULL;
2276 const char* debugconf = NULL;
2277 int dolist=0, ip4only=0, ip6only=0, force=0, port = HTTPS_PORT;
2278 int res_conf_fallback = 0;
2279 /* parse the options */
2280 while( (c=getopt(argc, argv, "46C:FRP:a:c:f:hln:r:s:u:vx:")) != -1) {
2292 root_anchor_file = optarg;
2295 root_cert_file = optarg;
2313 root_hints = optarg;
2316 res_conf_fallback = 1;
2325 port = atoi(optarg);
2337 /* argv += optind; not using further arguments */
2341 #ifdef HAVE_ERR_LOAD_CRYPTO_STRINGS
2342 ERR_load_crypto_strings();
2344 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_SSL)
2345 ERR_load_SSL_strings();
2347 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_CRYPTO)
2348 OpenSSL_add_all_algorithms();
2350 OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
2351 | OPENSSL_INIT_ADD_ALL_DIGESTS
2352 | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
2354 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_SSL)
2355 (void)SSL_library_init();
2357 (void)OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL);
2360 if(dolist) do_list_builtin();
2362 return do_root_update_work(root_anchor_file, root_cert_file, urlname,
2363 xmlname, p7sname, p7signer, res_conf, root_hints, debugconf,
2364 ip4only, ip6only, force, res_conf_fallback, port);