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: 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 to resolve -u name\n");
196 printf("-r root.hints use given root.hints to resolve -u name\n"
197 " builtin root hints are used by default\n");
198 printf("-v more verbose\n");
199 printf("-C conf debug, read config\n");
200 printf("-P port use port for https connect, default 443\n");
201 printf("-F debug, force update with cert\n");
202 printf("-h show this usage help\n");
203 printf("Version %s\n", PACKAGE_VERSION);
204 printf("BSD licensed, see LICENSE in source package for details.\n");
205 printf("Report bugs to %s\n", PACKAGE_BUGREPORT);
209 /** return the built in root update certificate */
211 get_builtin_cert(void)
214 /* The ICANN CA fetched at 24 Sep 2010. Valid to 2028 */
215 "-----BEGIN CERTIFICATE-----\n"
216 "MIIDdzCCAl+gAwIBAgIBATANBgkqhkiG9w0BAQsFADBdMQ4wDAYDVQQKEwVJQ0FO\n"
217 "TjEmMCQGA1UECxMdSUNBTk4gQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxFjAUBgNV\n"
218 "BAMTDUlDQU5OIFJvb3QgQ0ExCzAJBgNVBAYTAlVTMB4XDTA5MTIyMzA0MTkxMloX\n"
219 "DTI5MTIxODA0MTkxMlowXTEOMAwGA1UEChMFSUNBTk4xJjAkBgNVBAsTHUlDQU5O\n"
220 "IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRYwFAYDVQQDEw1JQ0FOTiBSb290IENB\n"
221 "MQswCQYDVQQGEwJVUzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKDb\n"
222 "cLhPNNqc1NB+u+oVvOnJESofYS9qub0/PXagmgr37pNublVThIzyLPGCJ8gPms9S\n"
223 "G1TaKNIsMI7d+5IgMy3WyPEOECGIcfqEIktdR1YWfJufXcMReZwU4v/AdKzdOdfg\n"
224 "ONiwc6r70duEr1IiqPbVm5T05l1e6D+HkAvHGnf1LtOPGs4CHQdpIUcy2kauAEy2\n"
225 "paKcOcHASvbTHK7TbbvHGPB+7faAztABLoneErruEcumetcNfPMIjXKdv1V1E3C7\n"
226 "MSJKy+jAqqQJqjZoQGB0necZgUMiUv7JK1IPQRM2CXJllcyJrm9WFxY0c1KjBO29\n"
227 "iIKK69fcglKcBuFShUECAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8B\n"
228 "Af8EBAMCAf4wHQYDVR0OBBYEFLpS6UmDJIZSL8eZzfyNa2kITcBQMA0GCSqGSIb3\n"
229 "DQEBCwUAA4IBAQAP8emCogqHny2UYFqywEuhLys7R9UKmYY4suzGO4nkbgfPFMfH\n"
230 "6M+Zj6owwxlwueZt1j/IaCayoKU3QsrYYoDRolpILh+FPwx7wseUEV8ZKpWsoDoD\n"
231 "2JFbLg2cfB8u/OlE4RYmcxxFSmXBg0yQ8/IoQt/bxOcEEhhiQ168H2yE5rxJMt9h\n"
232 "15nu5JBSewrCkYqYYmaxyOC3WrVGfHZxVI7MpIFcGdvSb2a1uyuua8l0BKgk3ujF\n"
233 "0/wsHNeP22qNyVO+XVBzrM8fk8BSUFuiT/6tZTYXRtEt5aKQZgXbKU5dUF3jT9qg\n"
234 "j/Br5BZw3X/zd325TvnswzMC1+ljLzHnQGGk\n"
235 "-----END CERTIFICATE-----\n"
239 /** return the built in root DS trust anchor */
244 ". IN DS 19036 8 2 49AAC11D7B6F6446702E54A1607371607A1A41855200FD2CE1CDDE32F24E8FB5\n";
247 /** print hex data */
249 print_data(const char* msg, const char* data, int len)
253 for(i=0; i<len; i++) {
254 printf(" %2.2x", (unsigned char)data[i]);
259 /** print ub context creation error and exit */
261 ub_ctx_error_exit(struct ub_ctx* ctx, const char* str, const char* str2)
264 if(str && str2 && verb) printf("%s: %s\n", str, str2);
265 if(verb) printf("error: could not create unbound resolver context\n");
270 * Create a new unbound context with the commandline settings applied
272 static struct ub_ctx*
273 create_unbound_context(const char* res_conf, const char* root_hints,
274 const char* debugconf, int ip4only, int ip6only)
277 struct ub_ctx* ctx = ub_ctx_create();
279 if(verb) printf("out of memory\n");
282 /* do not waste time and network traffic to fetch extra nameservers */
283 r = ub_ctx_set_option(ctx, "target-fetch-policy:", "0 0 0 0 0");
284 if(r && verb) printf("ctx targetfetchpolicy: %s\n", ub_strerror(r));
285 /* read config file first, so its settings can be overridden */
287 r = ub_ctx_config(ctx, debugconf);
288 if(r) ub_ctx_error_exit(ctx, debugconf, ub_strerror(r));
291 r = ub_ctx_resolvconf(ctx, res_conf);
292 if(r) ub_ctx_error_exit(ctx, res_conf, ub_strerror(r));
295 r = ub_ctx_set_option(ctx, "root-hints:", root_hints);
296 if(r) ub_ctx_error_exit(ctx, root_hints, ub_strerror(r));
299 r = ub_ctx_set_option(ctx, "do-ip6:", "no");
300 if(r) ub_ctx_error_exit(ctx, "ip4only", ub_strerror(r));
303 r = ub_ctx_set_option(ctx, "do-ip4:", "no");
304 if(r) ub_ctx_error_exit(ctx, "ip6only", ub_strerror(r));
309 /** printout certificate in detail */
311 verb_cert(const char* msg, X509* x)
313 if(verb == 0 || verb == 1) return;
315 if(msg) printf("%s\n", msg);
316 X509_print_ex_fp(stdout, x, 0, (unsigned long)-1
317 ^(X509_FLAG_NO_SUBJECT
318 |X509_FLAG_NO_ISSUER|X509_FLAG_NO_VALIDITY));
321 if(msg) printf("%s\n", msg);
322 X509_print_fp(stdout, x);
325 /** printout certificates in detail */
327 verb_certs(const char* msg, STACK_OF(X509)* sk)
329 int i, num = sk_X509_num(sk);
330 if(verb == 0 || verb == 1) return;
331 for(i=0; i<num; i++) {
332 printf("%s (%d/%d)\n", msg, i, num);
333 verb_cert(NULL, sk_X509_value(sk, i));
337 /** read certificates from a PEM bio */
338 static STACK_OF(X509)*
339 read_cert_bio(BIO* bio)
341 STACK_OF(X509) *sk = sk_X509_new_null();
343 if(verb) printf("out of memory\n");
346 while(!BIO_eof(bio)) {
347 X509* x = PEM_read_bio_X509(bio, NULL, 0, NULL);
350 printf("failed to read X509\n");
351 ERR_print_errors_fp(stdout);
355 if(!sk_X509_push(sk, x)) {
356 if(verb) printf("out of memory\n");
363 /* read the certificate file */
364 static STACK_OF(X509)*
365 read_cert_file(const char* file)
371 if(file == NULL || strcmp(file, "") == 0) {
374 sk = sk_X509_new_null();
376 if(verb) printf("out of memory\n");
379 in = fopen(file, "r");
381 if(verb) printf("%s: %s\n", file, strerror(errno));
383 sk_X509_pop_free(sk, X509_free);
388 X509* x = PEM_read_X509(in, NULL, 0, NULL);
391 printf("failed to read X509 file\n");
392 ERR_print_errors_fp(stdout);
396 if(!sk_X509_push(sk, x)) {
397 if(verb) printf("out of memory\n");
402 /* read away newline after --END CERT-- */
403 if(!fgets(buf, (int)sizeof(buf), in))
408 if(verb) printf("%s is empty\n", file);
410 sk_X509_pop_free(sk, X509_free);
417 /** read certificates from the builtin certificate */
418 static STACK_OF(X509)*
419 read_builtin_cert(void)
421 const char* builtin_cert = get_builtin_cert();
424 char* d = strdup(builtin_cert); /* to avoid const warnings in the
425 changed prototype of BIO_new_mem_buf */
427 if(verb) printf("out of memory\n");
430 bio = BIO_new_mem_buf(d, (int)strlen(d));
432 if(verb) printf("out of memory\n");
435 sk = read_cert_bio(bio);
437 if(verb) printf("internal error, out of memory\n");
445 /** read update cert file or use builtin */
446 static STACK_OF(X509)*
447 read_cert_or_builtin(const char* file)
449 STACK_OF(X509) *sk = read_cert_file(file);
451 if(verb) printf("using builtin certificate\n");
452 sk = read_builtin_cert();
454 if(verb) printf("have %d trusted certificates\n", sk_X509_num(sk));
455 verb_certs("trusted certificates", sk);
460 do_list_builtin(void)
462 const char* builtin_cert = get_builtin_cert();
463 const char* builtin_ds = get_builtin_ds();
464 printf("%s\n", builtin_ds);
465 printf("%s\n", builtin_cert);
469 /** printout IP address with message */
471 verb_addr(const char* msg, struct ip_list* ip)
475 void* a = &((struct sockaddr_in*)&ip->addr)->sin_addr;
476 if(ip->len != (socklen_t)sizeof(struct sockaddr_in))
477 a = &((struct sockaddr_in6*)&ip->addr)->sin6_addr;
479 if(inet_ntop((int)((struct sockaddr_in*)&ip->addr)->sin_family,
480 a, out, (socklen_t)sizeof(out))==0)
481 printf("%s (inet_ntop error)\n", msg);
482 else printf("%s %s\n", msg, out);
488 ip_list_free(struct ip_list* p)
498 /** create ip_list entry for a RR record */
499 static struct ip_list*
500 RR_to_ip(int tp, char* data, int len, int port)
502 struct ip_list* ip = (struct ip_list*)calloc(1, sizeof(*ip));
503 uint16_t p = (uint16_t)port;
504 if(tp == LDNS_RR_TYPE_A) {
505 struct sockaddr_in* sa = (struct sockaddr_in*)&ip->addr;
506 ip->len = (socklen_t)sizeof(*sa);
507 sa->sin_family = AF_INET;
508 sa->sin_port = (in_port_t)htons(p);
509 if(len != (int)sizeof(sa->sin_addr)) {
510 if(verb) printf("skipped badly formatted A\n");
514 memmove(&sa->sin_addr, data, sizeof(sa->sin_addr));
516 } else if(tp == LDNS_RR_TYPE_AAAA) {
517 struct sockaddr_in6* sa = (struct sockaddr_in6*)&ip->addr;
518 ip->len = (socklen_t)sizeof(*sa);
519 sa->sin6_family = AF_INET6;
520 sa->sin6_port = (in_port_t)htons(p);
521 if(len != (int)sizeof(sa->sin6_addr)) {
522 if(verb) printf("skipped badly formatted AAAA\n");
526 memmove(&sa->sin6_addr, data, sizeof(sa->sin6_addr));
528 if(verb) printf("internal error: bad type in RRtoip\n");
532 verb_addr("resolved server address", ip);
536 /** Resolve name, type, class and add addresses to iplist */
538 resolve_host_ip(struct ub_ctx* ctx, const char* host, int port, int tp, int cl,
539 struct ip_list** head)
541 struct ub_result* res = NULL;
545 r = ub_resolve(ctx, host, tp, cl, &res);
547 if(verb) printf("error: resolve %s %s: %s\n", host,
548 (tp==LDNS_RR_TYPE_A)?"A":"AAAA", ub_strerror(r));
552 if(verb) printf("out of memory\n");
556 if(!res->havedata || res->rcode || !res->data) {
557 if(verb) printf("resolve %s %s: no result\n", host,
558 (tp==LDNS_RR_TYPE_A)?"A":"AAAA");
561 for(i = 0; res->data[i]; i++) {
562 struct ip_list* ip = RR_to_ip(tp, res->data[i], res->len[i],
568 ub_resolve_free(res);
571 /** parse a text IP address into a sockaddr */
572 static struct ip_list*
573 parse_ip_addr(const char* str, int port)
577 struct sockaddr_in6 a6;
578 struct sockaddr_in a;
581 uint16_t p = (uint16_t)port;
582 memset(&addr, 0, sizeof(addr));
584 if(inet_pton(AF_INET6, str, &addr.a6.sin6_addr) > 0) {
586 addr.a6.sin6_family = AF_INET6;
587 addr.a6.sin6_port = (in_port_t)htons(p);
588 len = (socklen_t)sizeof(addr.a6);
590 if(inet_pton(AF_INET, str, &addr.a.sin_addr) > 0) {
592 addr.a.sin_family = AF_INET;
593 addr.a.sin_port = (in_port_t)htons(p);
594 len = (socklen_t)sizeof(struct sockaddr_in);
596 if(!len) return NULL;
597 ip = (struct ip_list*)calloc(1, sizeof(*ip));
599 if(verb) printf("out of memory\n");
603 memmove(&ip->addr, &addr, len);
604 if(verb) printf("server address is %s\n", str);
609 * Resolve a domain name (even though the resolver is down and there is
610 * no trust anchor). Without DNSSEC validation.
611 * @param host: the name to resolve.
612 * If this name is an IP4 or IP6 address this address is returned.
613 * @param port: the port number used for the returned IP structs.
614 * @param res_conf: resolv.conf (if any).
615 * @param root_hints: root hints (if any).
616 * @param debugconf: unbound.conf for debugging options.
617 * @param ip4only: use only ip4 for resolve and only lookup A
618 * @param ip6only: use only ip6 for resolve and only lookup AAAA
619 * default is to lookup A and AAAA using ip4 and ip6.
620 * @return list of IP addresses.
622 static struct ip_list*
623 resolve_name(const char* host, int port, const char* res_conf,
624 const char* root_hints, const char* debugconf, int ip4only, int ip6only)
627 struct ip_list* list = NULL;
628 /* first see if name is an IP address itself */
629 if( (list=parse_ip_addr(host, port)) ) {
633 /* create resolver context */
634 ctx = create_unbound_context(res_conf, root_hints, debugconf,
637 /* try resolution of A */
639 resolve_host_ip(ctx, host, port, LDNS_RR_TYPE_A,
640 LDNS_RR_CLASS_IN, &list);
643 /* try resolution of AAAA */
645 resolve_host_ip(ctx, host, port, LDNS_RR_TYPE_AAAA,
646 LDNS_RR_CLASS_IN, &list);
651 if(verb) printf("%s has no IP addresses I can use\n", host);
657 /** clear used flags */
659 wipe_ip_usage(struct ip_list* p)
667 /** cound unused IPs */
669 count_unused(struct ip_list* p)
679 /** pick random unused element from IP list */
680 static struct ip_list*
681 pick_random_ip(struct ip_list* list)
683 struct ip_list* p = list;
684 int num = count_unused(list);
686 if(num == 0) return NULL;
687 /* not perfect, but random enough */
688 sel = (int)arc4random_uniform((uint32_t)num);
689 /* skip over unused elements that we did not select */
690 while(sel > 0 && p) {
694 /* find the next unused element */
697 if(!p) return NULL; /* robustness */
712 /** printout socket errno */
714 print_sock_err(const char* msg)
717 if(verb) printf("%s: %s\n", msg, strerror(errno));
719 if(verb) printf("%s: %s\n", msg, wsa_strerror(WSAGetLastError()));
723 /** connect to IP address */
725 connect_to_ip(struct ip_list* ip)
728 verb_addr("connect to", ip);
729 fd = socket(ip->len==(socklen_t)sizeof(struct sockaddr_in)?
730 AF_INET:AF_INET6, SOCK_STREAM, 0);
732 print_sock_err("socket");
735 if(connect(fd, (struct sockaddr*)&ip->addr, ip->len) < 0) {
736 print_sock_err("connect");
743 /** create SSL context */
747 SSL_CTX* sslctx = SSL_CTX_new(SSLv23_client_method());
749 if(verb) printf("SSL_CTX_new error\n");
755 /** initiate TLS on a connection */
757 TLS_initiate(SSL_CTX* sslctx, int fd)
761 SSL* ssl = SSL_new(sslctx);
763 if(verb) printf("SSL_new error\n");
766 SSL_set_connect_state(ssl);
767 (void)SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY);
768 if(!SSL_set_fd(ssl, fd)) {
769 if(verb) printf("SSL_set_fd error\n");
775 if( (r=SSL_do_handshake(ssl)) == 1)
777 r = SSL_get_error(ssl, r);
778 if(r != SSL_ERROR_WANT_READ && r != SSL_ERROR_WANT_WRITE) {
779 if(verb) printf("SSL handshake failed\n");
783 /* wants to be called again */
785 x = SSL_get_peer_certificate(ssl);
787 if(verb) printf("Server presented no peer certificate\n");
791 verb_cert("server SSL certificate", x);
796 /** perform neat TLS shutdown */
798 TLS_shutdown(int fd, SSL* ssl, SSL_CTX* sslctx)
800 /* shutdown the SSL connection nicely */
801 if(SSL_shutdown(ssl) == 0) {
805 SSL_CTX_free(sslctx);
809 /** write a line over SSL */
811 write_ssl_line(SSL* ssl, const char* str, const char* sec)
816 snprintf(buf, sizeof(buf), str, sec);
818 snprintf(buf, sizeof(buf), "%s", str);
821 if(l+2 >= sizeof(buf)) {
822 if(verb) printf("line too long\n");
825 if(verb >= 2) printf("SSL_write: %s\n", buf);
830 if(SSL_write(ssl, buf, (int)strlen(buf)) <= 0) {
831 if(verb) printf("could not SSL_write %s", str);
837 /** process header line, check rcode and keeping track of size */
839 process_one_header(char* buf, size_t* clen, int* chunked)
841 if(verb>=2) printf("header: '%s'\n", buf);
842 if(strncasecmp(buf, "HTTP/1.1 ", 9) == 0) {
843 /* check returncode */
845 if(verb) printf("bad status %s\n", buf+9);
848 } else if(strncasecmp(buf, "Content-Length: ", 16) == 0) {
850 *clen = (size_t)atoi(buf+16);
851 } else if(strncasecmp(buf, "Transfer-Encoding: chunked", 19+7) == 0) {
859 * Read one line from SSL
861 * skips "\r\n" (but not copied to buf).
862 * @param ssl: the SSL connection to read from (blocking).
863 * @param buf: buffer to return line in.
864 * @param len: size of the buffer.
865 * @return 0 on error, 1 on success.
868 read_ssl_line(SSL* ssl, char* buf, size_t len)
875 if(verb) printf("line too long\n");
878 if((r = SSL_read(ssl, buf+n, 1)) <= 0) {
879 if(SSL_get_error(ssl, r) == SSL_ERROR_ZERO_RETURN) {
883 if(verb) printf("could not SSL_read\n");
886 if(endnl && buf[n] == '\n') {
890 if(verb) printf("error: stray linefeeds\n");
892 } else if(buf[n] == '\r') {
893 /* skip \r, and also \n on the wire */
896 } else if(buf[n] == '\n') {
897 /* skip the \n, we are done */
905 /** read http headers and process them */
907 read_http_headers(SSL* ssl, size_t* clen)
912 while(read_ssl_line(ssl, buf, sizeof(buf))) {
915 if(!process_one_header(buf, clen, &chunked))
921 /** read a data chunk */
923 read_data_chunk(SSL* ssl, size_t len)
928 if(len >= 0xfffffff0)
929 return NULL; /* to protect against integer overflow in malloc*/
930 data = malloc(len+1);
932 if(verb) printf("out of memory\n");
936 if((r = SSL_read(ssl, data+got, (int)(len-got))) <= 0) {
937 if(SSL_get_error(ssl, r) == SSL_ERROR_ZERO_RETURN) {
939 if(verb) printf("could not SSL_read: unexpected EOF\n");
943 if(verb) printf("could not SSL_read\n");
947 if(verb >= 2) printf("at %d/%d\n", (int)got, (int)len);
950 if(verb>=2) printf("read %d data\n", (int)len);
955 /** parse chunk header */
957 parse_chunk_header(char* buf, size_t* result)
960 size_t v = (size_t)strtol(buf, &e, 16);
967 /** read chunked data from connection */
969 do_chunked_read(SSL* ssl)
974 BIO* mem = BIO_new(BIO_s_mem());
975 if(verb>=3) printf("do_chunked_read\n");
977 if(verb) printf("out of memory\n");
980 while(read_ssl_line(ssl, buf, sizeof(buf))) {
981 /* read the chunked start line */
982 if(verb>=2) printf("chunk header: %s\n", buf);
983 if(!parse_chunk_header(buf, &len)) {
985 if(verb>=3) printf("could not parse chunk header\n");
988 if(verb>=2) printf("chunk len: %d\n", (int)len);
992 /* skip end-of-chunk-trailer lines,
993 * until the empty line after that */
995 if(!read_ssl_line(ssl, buf, sizeof(buf))) {
999 } while (strlen(buf) > 0);
1000 /* end of chunks, zero terminate it */
1001 if(BIO_write(mem, &z, 1) <= 0) {
1002 if(verb) printf("out of memory\n");
1008 /* read the chunked body */
1009 body = read_data_chunk(ssl, len);
1014 if(BIO_write(mem, body, (int)len) <= 0) {
1015 if(verb) printf("out of memory\n");
1021 /* skip empty line after data chunk */
1022 if(!read_ssl_line(ssl, buf, sizeof(buf))) {
1031 /** start HTTP1.1 transaction on SSL */
1033 write_http_get(SSL* ssl, const char* pathname, const char* urlname)
1035 if(write_ssl_line(ssl, "GET /%s HTTP/1.1", pathname) &&
1036 write_ssl_line(ssl, "Host: %s", urlname) &&
1037 write_ssl_line(ssl, "User-Agent: unbound-anchor/%s",
1039 /* We do not really do multiple queries per connection,
1040 * but this header setting is also not needed.
1041 * write_ssl_line(ssl, "Connection: close", NULL) &&*/
1042 write_ssl_line(ssl, "", NULL)) {
1048 /** read chunked data and zero terminate; len is without zero */
1050 read_chunked_zero_terminate(SSL* ssl, size_t* len)
1052 /* do the chunked version */
1053 BIO* tmp = do_chunked_read(ssl);
1054 char* data, *d = NULL;
1057 if(verb) printf("could not read from https\n");
1060 l = (size_t)BIO_get_mem_data(tmp, &d);
1061 if(verb>=2) printf("chunked data is %d\n", (int)l);
1062 if(l == 0 || d == NULL) {
1063 if(verb) printf("out of memory\n");
1067 data = (char*)malloc(l);
1069 if(verb) printf("out of memory\n");
1077 /** read HTTP result from SSL */
1079 read_http_result(SSL* ssl)
1084 if(!read_http_headers(ssl, &len)) {
1088 data = read_chunked_zero_terminate(ssl, &len);
1090 data = read_data_chunk(ssl, len);
1092 if(!data) return NULL;
1093 if(verb >= 4) print_data("read data", data, (int)len);
1094 m = BIO_new_mem_buf(data, (int)len);
1096 if(verb) printf("out of memory\n");
1102 /** https to an IP addr, return BIO with pathname or NULL */
1104 https_to_ip(struct ip_list* ip, const char* pathname, const char* urlname)
1109 SSL_CTX* sslctx = setup_sslctx();
1113 fd = connect_to_ip(ip);
1115 SSL_CTX_free(sslctx);
1118 ssl = TLS_initiate(sslctx, fd);
1120 SSL_CTX_free(sslctx);
1124 if(!write_http_get(ssl, pathname, urlname)) {
1125 if(verb) printf("could not write to server\n");
1127 SSL_CTX_free(sslctx);
1131 bio = read_http_result(ssl);
1132 TLS_shutdown(fd, ssl, sslctx);
1137 * Do a HTTPS, HTTP1.1 over TLS, to fetch a file
1138 * @param ip_list: list of IP addresses to use to fetch from.
1139 * @param pathname: pathname of file on server to GET.
1140 * @param urlname: name to pass as the virtual host for this request.
1141 * @return a memory BIO with the file in it.
1144 https(struct ip_list* ip_list, const char* pathname, const char* urlname)
1148 /* try random address first, and work through the list */
1149 wipe_ip_usage(ip_list);
1150 while( (ip = pick_random_ip(ip_list)) ) {
1152 bio = https_to_ip(ip, pathname, urlname);
1156 if(verb) printf("could not fetch %s\n", pathname);
1159 if(verb) printf("fetched %s (%d bytes)\n",
1160 pathname, (int)BIO_ctrl_pending(bio));
1165 /** free up a downloaded file BIO */
1167 free_file_bio(BIO* bio)
1170 (void)BIO_reset(bio);
1171 (void)BIO_get_mem_data(bio, &pp);
1176 /** XML parse private data during the parse */
1178 /** the parser, reference */
1180 /** the current tag; malloced; or NULL outside of tags */
1182 /** current date to use during the parse */
1184 /** number of keys usefully read in */
1186 /** the compiled anchors as DS records */
1189 /** do we want to use this anchor? */
1191 /** the current anchor: Zone */
1193 /** the current anchor: KeyTag */
1195 /** the current anchor: Algorithm */
1197 /** the current anchor: DigestType */
1199 /** the current anchor: Digest*/
1203 /** The BIO for the tag */
1205 xml_selectbio(struct xml_data* data, const char* tag)
1208 if(strcasecmp(tag, "KeyTag") == 0)
1210 else if(strcasecmp(tag, "Algorithm") == 0)
1212 else if(strcasecmp(tag, "DigestType") == 0)
1214 else if(strcasecmp(tag, "Digest") == 0)
1220 * XML handle character data, the data inside an element.
1221 * @param userData: xml_data structure
1222 * @param s: the character data. May not all be in one callback.
1223 * NOT zero terminated.
1224 * @param len: length of this part of the data.
1227 xml_charhandle(void *userData, const XML_Char *s, int len)
1229 struct xml_data* data = (struct xml_data*)userData;
1231 /* skip characters outside of elements */
1236 printf("%s%s charhandle: '",
1237 data->use_key?"use ":"",
1238 data->tag?data->tag:"none");
1239 for(i=0; i<len; i++)
1243 if(strcasecmp(data->tag, "Zone") == 0) {
1244 if(BIO_write(data->czone, s, len) < 0) {
1245 if(verb) printf("out of memory in BIO_write\n");
1250 /* only store if key is used */
1253 b = xml_selectbio(data, data->tag);
1255 if(BIO_write(b, s, len) < 0) {
1256 if(verb) printf("out of memory in BIO_write\n");
1263 * XML fetch value of particular attribute(by name) or NULL if not present.
1264 * @param atts: attribute array (from xml_startelem).
1265 * @param name: name of attribute to look for.
1266 * @return the value or NULL. (ptr into atts).
1268 static const XML_Char*
1269 find_att(const XML_Char **atts, const XML_Char* name)
1272 for(i=0; atts[i]; i+=2) {
1273 if(strcasecmp(atts[i], name) == 0)
1280 * XML convert DateTime element to time_t.
1281 * [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]
1282 * (with optional .ssssss fractional seconds)
1283 * @param str: the string
1284 * @return a time_t representation or 0 on failure.
1287 xml_convertdate(const char* str)
1292 /* for this application, ignore minus in front;
1293 * only positive dates are expected */
1295 if(s[0] == '-') s++;
1296 memset(&tm, 0, sizeof(tm));
1297 /* parse initial content of the string (lots of whitespace allowed) */
1298 s = strptime(s, "%t%Y%t-%t%m%t-%t%d%tT%t%H%t:%t%M%t:%t%S%t", &tm);
1300 if(verb) printf("xml_convertdate parse failure %s\n", str);
1303 /* parse remainder of date string */
1305 /* optional '.' and fractional seconds */
1306 int frac = 0, n = 0;
1307 if(sscanf(s+1, "%d%n", &frac, &n) < 1) {
1308 if(verb) printf("xml_convertdate f failure %s\n", str);
1311 /* fraction is not used, time_t has second accuracy */
1315 if(*s == 'Z' || *s == 'z') {
1316 /* nothing to do for this */
1318 } else if(*s == '+' || *s == '-') {
1319 /* optional timezone spec: Z or +hh:mm or -hh:mm */
1320 int hr = 0, mn = 0, n = 0;
1321 if(sscanf(s+1, "%d:%d%n", &hr, &mn, &n) < 2) {
1322 if(verb) printf("xml_convertdate tz failure %s\n", str);
1336 /* not ended properly */
1337 /* but ignore, (lenient) */
1340 t = sldns_mktime_from_utc(&tm);
1341 if(t == (time_t)-1) {
1342 if(verb) printf("xml_convertdate mktime failure\n");
1349 * XML handle the KeyDigest start tag, check validity periods.
1352 handle_keydigest(struct xml_data* data, const XML_Char **atts)
1355 if(find_att(atts, "validFrom")) {
1356 time_t from = xml_convertdate(find_att(atts, "validFrom"));
1358 if(verb) printf("error: xml cannot be parsed\n");
1361 if(data->date < from)
1364 if(find_att(atts, "validUntil")) {
1365 time_t until = xml_convertdate(find_att(atts, "validUntil"));
1367 if(verb) printf("error: xml cannot be parsed\n");
1370 if(data->date > until)
1373 /* yes we want to use this key */
1375 (void)BIO_reset(data->ctag);
1376 (void)BIO_reset(data->calgo);
1377 (void)BIO_reset(data->cdigtype);
1378 (void)BIO_reset(data->cdigest);
1381 /** See if XML element equals the zone name */
1383 xml_is_zone_name(BIO* zone, const char* name)
1388 (void)BIO_seek(zone, 0);
1389 zlen = BIO_get_mem_data(zone, &z);
1390 if(!zlen || !z) return 0;
1391 /* zero terminate */
1392 if(zlen >= (long)sizeof(buf)) return 0;
1393 memmove(buf, z, (size_t)zlen);
1396 return (strncasecmp(buf, name, strlen(name)) == 0);
1400 * XML start of element. This callback is called whenever an XML tag starts.
1402 * @param userData: the xml_data structure.
1403 * @param name: the tag that starts.
1404 * @param atts: array of strings, pairs of attr = value, ends with NULL.
1405 * i.e. att[0]="att[1]" att[2]="att[3]" att[4]isNull
1408 xml_startelem(void *userData, const XML_Char *name, const XML_Char **atts)
1410 struct xml_data* data = (struct xml_data*)userData;
1412 if(verb>=4) printf("xml tag start '%s'\n", name);
1414 data->tag = strdup(name);
1416 if(verb) printf("out of memory\n");
1421 for(i=0; atts[i]; i+=2) {
1422 printf(" %s='%s'\n", atts[i], atts[i+1]);
1425 /* handle attributes to particular types */
1426 if(strcasecmp(name, "KeyDigest") == 0) {
1427 handle_keydigest(data, atts);
1429 } else if(strcasecmp(name, "Zone") == 0) {
1430 (void)BIO_reset(data->czone);
1434 /* for other types we prepare to pick up the data */
1437 b = xml_selectbio(data, data->tag);
1444 /** Append str to bio */
1446 xml_append_str(BIO* b, const char* s)
1448 if(BIO_write(b, s, (int)strlen(s)) < 0) {
1449 if(verb) printf("out of memory in BIO_write\n");
1454 /** Append bio to bio */
1456 xml_append_bio(BIO* b, BIO* a)
1460 (void)BIO_seek(a, 0);
1461 len = BIO_get_mem_data(a, &z);
1463 if(verb) printf("out of memory in BIO_write\n");
1466 /* remove newlines in the data here */
1467 for(i=0; i<len; i++) {
1468 if(z[i] == '\r' || z[i] == '\n')
1472 if(BIO_write(b, z, len) < 0) {
1473 if(verb) printf("out of memory in BIO_write\n");
1478 /** write the parsed xml-DS to the DS list */
1480 xml_append_ds(struct xml_data* data)
1482 /* write DS to accumulated DS */
1483 xml_append_str(data->ds, ". IN DS ");
1484 xml_append_bio(data->ds, data->ctag);
1485 xml_append_str(data->ds, " ");
1486 xml_append_bio(data->ds, data->calgo);
1487 xml_append_str(data->ds, " ");
1488 xml_append_bio(data->ds, data->cdigtype);
1489 xml_append_str(data->ds, " ");
1490 xml_append_bio(data->ds, data->cdigest);
1491 xml_append_str(data->ds, "\n");
1496 * XML end of element. This callback is called whenever an XML tag ends.
1498 * @param userData: the xml_data structure
1499 * @param name: the tag that ends.
1502 xml_endelem(void *userData, const XML_Char *name)
1504 struct xml_data* data = (struct xml_data*)userData;
1505 if(verb>=4) printf("xml tag end '%s'\n", name);
1508 if(strcasecmp(name, "KeyDigest") == 0) {
1510 xml_append_ds(data);
1512 } else if(strcasecmp(name, "Zone") == 0) {
1513 if(!xml_is_zone_name(data->czone, ".")) {
1514 if(verb) printf("xml not for the right zone\n");
1520 /* Stop the parser when an entity declaration is encountered. For safety. */
1522 xml_entitydeclhandler(void *userData,
1523 const XML_Char *ATTR_UNUSED(entityName),
1524 int ATTR_UNUSED(is_parameter_entity),
1525 const XML_Char *ATTR_UNUSED(value), int ATTR_UNUSED(value_length),
1526 const XML_Char *ATTR_UNUSED(base),
1527 const XML_Char *ATTR_UNUSED(systemId),
1528 const XML_Char *ATTR_UNUSED(publicId),
1529 const XML_Char *ATTR_UNUSED(notationName))
1531 #if HAVE_DECL_XML_STOPPARSER
1532 (void)XML_StopParser((XML_Parser)userData, XML_FALSE);
1539 * XML parser setup of the callbacks for the tags
1542 xml_parse_setup(XML_Parser parser, struct xml_data* data, time_t now)
1545 memset(data, 0, sizeof(*data));
1546 XML_SetUserData(parser, data);
1547 data->parser = parser;
1549 data->ds = BIO_new(BIO_s_mem());
1550 data->ctag = BIO_new(BIO_s_mem());
1551 data->czone = BIO_new(BIO_s_mem());
1552 data->calgo = BIO_new(BIO_s_mem());
1553 data->cdigtype = BIO_new(BIO_s_mem());
1554 data->cdigest = BIO_new(BIO_s_mem());
1555 if(!data->ds || !data->ctag || !data->calgo || !data->czone ||
1556 !data->cdigtype || !data->cdigest) {
1557 if(verb) printf("out of memory\n");
1560 snprintf(buf, sizeof(buf), "; created by unbound-anchor on %s",
1562 if(BIO_write(data->ds, buf, (int)strlen(buf)) < 0) {
1563 if(verb) printf("out of memory\n");
1566 XML_SetEntityDeclHandler(parser, xml_entitydeclhandler);
1567 XML_SetElementHandler(parser, xml_startelem, xml_endelem);
1568 XML_SetCharacterDataHandler(parser, xml_charhandle);
1572 * Perform XML parsing of the root-anchors file
1573 * Its format description can be read here
1574 * https://data.iana.org/root-anchors/draft-icann-dnssec-trust-anchor.txt
1576 * @param xml: BIO with xml data.
1577 * @param now: the current time for checking DS validity periods.
1578 * @return memoryBIO with the DS data in zone format.
1579 * or NULL if the zone is insecure.
1580 * (It exit()s on error)
1583 xml_parse(BIO* xml, time_t now)
1588 struct xml_data data;
1590 parser = XML_ParserCreate(NULL);
1592 if(verb) printf("could not XML_ParserCreate\n");
1596 /* setup callbacks */
1597 xml_parse_setup(parser, &data, now);
1600 (void)BIO_reset(xml);
1601 len = (int)BIO_get_mem_data(xml, &pp);
1603 if(verb) printf("out of memory\n");
1606 if(!XML_Parse(parser, pp, len, 1 /*isfinal*/ )) {
1607 const char *e = XML_ErrorString(XML_GetErrorCode(parser));
1608 if(verb) printf("XML_Parse failure %s\n", e?e:"");
1613 if(verb) printf("XML was parsed successfully, %d keys\n",
1616 XML_ParserFree(parser);
1619 (void)BIO_seek(data.ds, 0);
1620 len = BIO_get_mem_data(data.ds, &pp);
1621 printf("got DS bio %d: '", len);
1622 if(!fwrite(pp, (size_t)len, 1, stdout))
1623 /* compilers do not allow us to ignore fwrite .. */
1624 fprintf(stderr, "error writing to stdout\n");
1627 BIO_free(data.czone);
1628 BIO_free(data.ctag);
1629 BIO_free(data.calgo);
1630 BIO_free(data.cdigtype);
1631 BIO_free(data.cdigest);
1633 if(data.num_keys == 0) {
1634 /* the root zone seems to have gone insecure */
1642 /* get key usage out of its extension, returns 0 if no key_usage extension */
1643 static unsigned long
1644 get_usage_of_ex(X509* cert)
1646 unsigned long val = 0;
1648 if((s=X509_get_ext_d2i(cert, NID_key_usage, NULL, NULL))) {
1652 val |= s->data[1] << 8;
1654 ASN1_BIT_STRING_free(s);
1659 /** get valid signers from the list of signers in the signature */
1660 static STACK_OF(X509)*
1661 get_valid_signers(PKCS7* p7, const char* p7signer)
1664 STACK_OF(X509)* validsigners = sk_X509_new_null();
1665 STACK_OF(X509)* signers = PKCS7_get0_signers(p7, NULL, 0);
1666 unsigned long usage = 0;
1668 if(verb) printf("out of memory\n");
1669 sk_X509_free(signers);
1673 if(verb) printf("no signers in pkcs7 signature\n");
1674 sk_X509_free(validsigners);
1677 for(i=0; i<sk_X509_num(signers); i++) {
1678 X509_NAME* nm = X509_get_subject_name(
1679 sk_X509_value(signers, i));
1682 if(verb) printf("signer %d: cert has no subject name\n", i);
1686 char* nmline = X509_NAME_oneline(nm, buf,
1688 printf("signer %d: Subject: %s\n", i,
1689 nmline?nmline:"no subject");
1690 if(verb >= 3 && X509_NAME_get_text_by_NID(nm,
1691 NID_commonName, buf, (int)sizeof(buf)))
1692 printf("commonName: %s\n", buf);
1693 if(verb >= 3 && X509_NAME_get_text_by_NID(nm,
1694 NID_pkcs9_emailAddress, buf, (int)sizeof(buf)))
1695 printf("emailAddress: %s\n", buf);
1698 int ku_loc = X509_get_ext_by_NID(
1699 sk_X509_value(signers, i), NID_key_usage, -1);
1700 if(verb >= 3 && ku_loc >= 0) {
1701 X509_EXTENSION *ex = X509_get_ext(
1702 sk_X509_value(signers, i), ku_loc);
1704 printf("keyUsage: ");
1705 X509V3_EXT_print_fp(stdout, ex, 0, 0);
1710 if(!p7signer || strcmp(p7signer, "")==0) {
1711 /* there is no name to check, return all records */
1712 if(verb) printf("did not check commonName of signer\n");
1714 if(!X509_NAME_get_text_by_NID(nm,
1715 NID_pkcs9_emailAddress,
1716 buf, (int)sizeof(buf))) {
1717 if(verb) printf("removed cert with no name\n");
1718 continue; /* no name, no use */
1720 if(strcmp(buf, p7signer) != 0) {
1721 if(verb) printf("removed cert with wrong name\n");
1722 continue; /* wrong name, skip it */
1726 /* check that the key usage allows digital signatures
1728 usage = get_usage_of_ex(sk_X509_value(signers, i));
1729 if(!(usage & KU_DIGITAL_SIGNATURE)) {
1730 if(verb) printf("removed cert with no key usage Digital Signature allowed\n");
1734 /* we like this cert, add it to our list of valid
1735 * signers certificates */
1736 sk_X509_push(validsigners, sk_X509_value(signers, i));
1738 sk_X509_free(signers);
1739 return validsigners;
1742 /** verify a PKCS7 signature, false on failure */
1744 verify_p7sig(BIO* data, BIO* p7s, STACK_OF(X509)* trust, const char* p7signer)
1747 X509_STORE *store = X509_STORE_new();
1748 STACK_OF(X509)* validsigners;
1751 #ifdef X509_V_FLAG_CHECK_SS_SIGNATURE
1752 X509_VERIFY_PARAM* param = X509_VERIFY_PARAM_new();
1754 if(verb) printf("out of memory\n");
1755 X509_STORE_free(store);
1758 /* do the selfcheck on the root certificate; it checks that the
1760 X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CHECK_SS_SIGNATURE);
1761 if(store) X509_STORE_set1_param(store, param);
1764 if(verb) printf("out of memory\n");
1765 #ifdef X509_V_FLAG_CHECK_SS_SIGNATURE
1766 X509_VERIFY_PARAM_free(param);
1770 #ifdef X509_V_FLAG_CHECK_SS_SIGNATURE
1771 X509_VERIFY_PARAM_free(param);
1774 (void)BIO_reset(p7s);
1775 (void)BIO_reset(data);
1777 /* convert p7s to p7 (the signature) */
1778 p7 = d2i_PKCS7_bio(p7s, NULL);
1780 if(verb) printf("could not parse p7s signature file\n");
1781 X509_STORE_free(store);
1784 if(verb >= 2) printf("parsed the PKCS7 signature\n");
1786 /* convert trust to trusted certificate store */
1787 for(i=0; i<sk_X509_num(trust); i++) {
1788 if(!X509_STORE_add_cert(store, sk_X509_value(trust, i))) {
1789 if(verb) printf("failed X509_STORE_add_cert\n");
1790 X509_STORE_free(store);
1795 if(verb >= 2) printf("setup the X509_STORE\n");
1797 /* check what is in the Subject name of the certificates,
1798 * and build a stack that contains only the right certificates */
1799 validsigners = get_valid_signers(p7, p7signer);
1801 X509_STORE_free(store);
1805 if(PKCS7_verify(p7, validsigners, store, data, NULL, PKCS7_NOINTERN) == 1) {
1807 if(verb) printf("the PKCS7 signature verified\n");
1810 ERR_print_errors_fp(stdout);
1814 sk_X509_free(validsigners);
1815 X509_STORE_free(store);
1820 /** write unsigned root anchor file, a 5011 revoked tp */
1822 write_unsigned_root(const char* root_anchor_file)
1825 time_t now = time(NULL);
1826 out = fopen(root_anchor_file, "w");
1828 if(verb) printf("%s: %s\n", root_anchor_file, strerror(errno));
1831 if(fprintf(out, "; autotrust trust anchor file\n"
1834 "; This file was written by unbound-anchor on %s"
1835 "; It indicates that the root does not use DNSSEC\n"
1836 "; to restart DNSSEC overwrite this file with a\n"
1837 "; valid trustanchor or (empty-it and run unbound-anchor)\n"
1838 , ctime(&now)) < 0) {
1839 if(verb) printf("failed to write 'unsigned' to %s\n",
1841 if(verb && errno != 0) printf("%s\n", strerror(errno));
1847 FlushFileBuffers((HANDLE)_get_osfhandle(_fileno(out)));
1852 /** write root anchor file */
1854 write_root_anchor(const char* root_anchor_file, BIO* ds)
1859 (void)BIO_seek(ds, 0);
1860 len = BIO_get_mem_data(ds, &pp);
1862 if(verb) printf("out of memory\n");
1865 out = fopen(root_anchor_file, "w");
1867 if(verb) printf("%s: %s\n", root_anchor_file, strerror(errno));
1870 if(fwrite(pp, (size_t)len, 1, out) != 1) {
1871 if(verb) printf("failed to write all data to %s\n",
1873 if(verb && errno != 0) printf("%s\n", strerror(errno));
1879 FlushFileBuffers((HANDLE)_get_osfhandle(_fileno(out)));
1884 /** Perform the verification and update of the trustanchor file */
1886 verify_and_update_anchor(const char* root_anchor_file, BIO* xml, BIO* p7s,
1887 STACK_OF(X509)* cert, const char* p7signer)
1891 /* verify xml file */
1892 if(!verify_p7sig(xml, p7s, cert, p7signer)) {
1893 printf("the PKCS7 signature failed\n");
1897 /* parse the xml file into DS records */
1898 ds = xml_parse(xml, time(NULL));
1900 /* the root zone is unsigned now */
1901 write_unsigned_root(root_anchor_file);
1903 /* reinstate 5011 tracking */
1904 write_root_anchor(root_anchor_file, ds);
1910 static void do_wsa_cleanup(void) { WSACleanup(); }
1913 /** perform actual certupdate work */
1915 do_certupdate(const char* root_anchor_file, const char* root_cert_file,
1916 const char* urlname, const char* xmlname, const char* p7sname,
1917 const char* p7signer, const char* res_conf, const char* root_hints,
1918 const char* debugconf, int ip4only, int ip6only, int port,
1919 struct ub_result* dnskey)
1921 STACK_OF(X509)* cert;
1923 struct ip_list* ip_list = NULL;
1925 /* read pem file or provide builtin */
1926 cert = read_cert_or_builtin(root_cert_file);
1928 /* lookup A, AAAA for the urlname (or parse urlname if IP address) */
1929 ip_list = resolve_name(urlname, port, res_conf, root_hints, debugconf,
1933 if(1) { /* libunbound finished, startup WSA for the https connection */
1936 if((r = WSAStartup(MAKEWORD(2,2), &wsa_data)) != 0) {
1937 if(verb) printf("WSAStartup failed: %s\n",
1941 atexit(&do_wsa_cleanup);
1945 /* fetch the necessary files over HTTPS */
1946 xml = https(ip_list, xmlname, urlname);
1947 p7s = https(ip_list, p7sname, urlname);
1949 /* verify and update the root anchor */
1950 verify_and_update_anchor(root_anchor_file, xml, p7s, cert, p7signer);
1951 if(verb) printf("success: the anchor has been updated "
1952 "using the cert\n");
1957 sk_X509_pop_free(cert, X509_free);
1959 ub_resolve_free(dnskey);
1960 ip_list_free(ip_list);
1965 * Try to read the root RFC5011 autotrust anchor file,
1966 * @param file: filename.
1968 * 0 if does not exist or empty
1969 * 1 if trust-point-revoked-5011
1973 try_read_anchor(const char* file)
1978 FILE* in = fopen(file, "r");
1980 /* only if the file does not exist, can we fix it */
1981 if(errno != ENOENT) {
1982 if(verb) printf("%s: %s\n", file, strerror(errno));
1983 if(verb) printf("error: cannot access the file\n");
1986 if(verb) printf("%s does not exist\n", file);
1989 while(fgets(line, (int)sizeof(line), in)) {
1990 line[sizeof(line)-1] = 0;
1991 if(strncmp(line, ";;REVOKED", 9) == 0) {
1993 if(verb) printf("%s : the trust point is revoked\n"
1994 "and the zone is considered unsigned.\n"
1995 "if you wish to re-enable, delete the file\n",
2000 while(*p == ' ' || *p == '\t')
2002 if(p[0]==0 || p[0]=='\n' || p[0]==';') continue;
2003 /* this line is a line of content */
2008 if(verb) printf("%s is empty\n", file);
2011 if(verb) printf("%s has content\n", file);
2015 /** Write the builtin root anchor to a file */
2017 write_builtin_anchor(const char* file)
2019 const char* builtin_root_anchor = get_builtin_ds();
2020 FILE* out = fopen(file, "w");
2022 if(verb) printf("%s: %s\n", file, strerror(errno));
2023 if(verb) printf(" could not write builtin anchor\n");
2026 if(!fwrite(builtin_root_anchor, strlen(builtin_root_anchor), 1, out)) {
2027 if(verb) printf("%s: %s\n", file, strerror(errno));
2028 if(verb) printf(" could not complete write builtin anchor\n");
2034 * Check the root anchor file.
2035 * If does not exist, provide builtin and write file.
2036 * If empty, provide builtin and write file.
2037 * If trust-point-revoked-5011 file: make the program exit.
2038 * @param root_anchor_file: filename of the root anchor.
2039 * @param used_builtin: set to 1 if the builtin is written.
2040 * @return 0 if trustpoint is insecure, 1 on success. Exit on failure.
2043 provide_builtin(const char* root_anchor_file, int* used_builtin)
2045 /* try to read it */
2046 switch(try_read_anchor(root_anchor_file))
2048 case 0: /* no exist or empty */
2049 write_builtin_anchor(root_anchor_file);
2052 case 1: /* revoked tp */
2054 case 2: /* it is fine */
2062 * add an autotrust anchor for the root to the context
2065 add_5011_probe_root(struct ub_ctx* ctx, const char* root_anchor_file)
2068 r = ub_ctx_set_option(ctx, "auto-trust-anchor-file:", root_anchor_file);
2070 if(verb) printf("add 5011 probe to ctx: %s\n", ub_strerror(r));
2077 * Prime the root key and return the result. Exit on error.
2078 * @param ctx: the unbound context to perform the priming with.
2079 * @return: the result of the prime, on error it exit()s.
2081 static struct ub_result*
2082 prime_root_key(struct ub_ctx* ctx)
2084 struct ub_result* res = NULL;
2086 r = ub_resolve(ctx, ".", LDNS_RR_TYPE_DNSKEY, LDNS_RR_CLASS_IN, &res);
2088 if(verb) printf("resolve DNSKEY: %s\n", ub_strerror(r));
2093 if(verb) printf("out of memory\n");
2100 /** see if ADDPEND keys exist in autotrust file (if possible) */
2102 read_if_pending_keys(const char* file)
2104 FILE* in = fopen(file, "r");
2107 if(verb>=2) printf("%s: %s\n", file, strerror(errno));
2110 while(fgets(line, (int)sizeof(line), in)) {
2111 if(line[0]==';') continue;
2112 if(strstr(line, "[ ADDPEND ]")) {
2114 if(verb) printf("RFC5011-state has ADDPEND keys\n");
2122 /** read last successful probe time from autotrust file (if possible) */
2124 read_last_success_time(const char* file)
2126 FILE* in = fopen(file, "r");
2129 if(verb) printf("%s: %s\n", file, strerror(errno));
2132 while(fgets(line, (int)sizeof(line), in)) {
2133 if(strncmp(line, ";;last_success: ", 16) == 0) {
2135 time_t x = (unsigned int)strtol(line+16, &e, 10);
2138 if(verb) printf("failed to parse "
2139 "last_success probe time\n");
2142 if(verb) printf("last successful probe: %s", ctime(&x));
2147 if(verb) printf("no last_success probe time in anchor file\n");
2152 * Read autotrust 5011 probe file and see if the date
2153 * compared to the current date allows a certupdate.
2154 * If the last successful probe was recent then 5011 cannot be behind,
2155 * and the failure cannot be solved with a certupdate.
2156 * The debugconf is to validation-override the date for testing.
2157 * @param root_anchor_file: filename of root key
2158 * @return true if certupdate is ok.
2161 probe_date_allows_certupdate(const char* root_anchor_file)
2163 int has_pending_keys = read_if_pending_keys(root_anchor_file);
2164 int32_t last_success = read_last_success_time(root_anchor_file);
2165 int32_t now = (int32_t)time(NULL);
2166 int32_t leeway = 30 * 24 * 3600; /* 30 days leeway */
2167 /* if the date is before 2010-07-15:00.00.00 then the root has not
2168 * been signed yet, and thus we refuse to take action. */
2169 if(time(NULL) < xml_convertdate("2010-07-15T00:00:00")) {
2170 if(verb) printf("the date is before the root was first signed,"
2171 " please correct the clock\n");
2174 if(last_success == 0)
2175 return 1; /* no probe time */
2176 if(has_pending_keys)
2177 return 1; /* key in ADDPEND state, a previous probe has
2178 inserted that, and it was present in all recent probes,
2179 but it has not become active. The 30 day timer may not have
2180 expired, but we know(for sure) there is a rollover going on.
2181 If we only managed to pickup the new key on its last day
2182 of announcement (for example) this can happen. */
2183 if(now - last_success < 0) {
2184 if(verb) printf("the last successful probe is in the future,"
2185 " clock was modified\n");
2188 if(now - last_success >= leeway) {
2189 if(verb) printf("the last successful probe was more than 30 "
2193 if(verb) printf("the last successful probe is recent\n");
2197 /** perform the unbound-anchor work */
2199 do_root_update_work(const char* root_anchor_file, const char* root_cert_file,
2200 const char* urlname, const char* xmlname, const char* p7sname,
2201 const char* p7signer, const char* res_conf, const char* root_hints,
2202 const char* debugconf, int ip4only, int ip6only, int force, int port)
2205 struct ub_result* dnskey;
2206 int used_builtin = 0;
2208 /* see if builtin rootanchor needs to be provided, or if
2209 * rootanchor is 'revoked-trust-point' */
2210 if(!provide_builtin(root_anchor_file, &used_builtin))
2213 /* make unbound context with 5011-probe for root anchor,
2214 * and probe . DNSKEY */
2215 ctx = create_unbound_context(res_conf, root_hints, debugconf,
2217 add_5011_probe_root(ctx, root_anchor_file);
2218 dnskey = prime_root_key(ctx);
2221 /* if secure: exit */
2222 if(dnskey->secure && !force) {
2223 if(verb) printf("success: the anchor is ok\n");
2224 ub_resolve_free(dnskey);
2225 return used_builtin;
2227 if(force && verb) printf("debug cert update forced\n");
2229 /* if not (and NOERROR): check date and do certupdate */
2230 if((dnskey->rcode == 0 &&
2231 probe_date_allows_certupdate(root_anchor_file)) || force) {
2232 if(do_certupdate(root_anchor_file, root_cert_file, urlname,
2233 xmlname, p7sname, p7signer, res_conf, root_hints,
2234 debugconf, ip4only, ip6only, port, dnskey))
2236 return used_builtin;
2238 if(verb) printf("fail: the anchor is NOT ok and could not be fixed\n");
2239 ub_resolve_free(dnskey);
2240 return used_builtin;
2243 /** getopt global, in case header files fail to declare it. */
2245 /** getopt global, in case header files fail to declare it. */
2246 extern char* optarg;
2248 /** Main routine for unbound-anchor */
2249 int main(int argc, char* argv[])
2252 const char* root_anchor_file = ROOT_ANCHOR_FILE;
2253 const char* root_cert_file = ROOT_CERT_FILE;
2254 const char* urlname = URLNAME;
2255 const char* xmlname = XMLNAME;
2256 const char* p7sname = P7SNAME;
2257 const char* p7signer = P7SIGNER;
2258 const char* res_conf = NULL;
2259 const char* root_hints = NULL;
2260 const char* debugconf = NULL;
2261 int dolist=0, ip4only=0, ip6only=0, force=0, port = HTTPS_PORT;
2262 /* parse the options */
2263 while( (c=getopt(argc, argv, "46C:FP:a:c:f:hln:r:s:u:vx:")) != -1) {
2275 root_anchor_file = optarg;
2278 root_cert_file = optarg;
2296 root_hints = optarg;
2305 port = atoi(optarg);
2321 #ifdef HAVE_ERR_LOAD_CRYPTO_STRINGS
2322 ERR_load_crypto_strings();
2324 ERR_load_SSL_strings();
2325 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_CRYPTO)
2326 OpenSSL_add_all_algorithms();
2328 OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
2329 | OPENSSL_INIT_ADD_ALL_DIGESTS
2330 | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
2332 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_SSL)
2333 (void)SSL_library_init();
2335 (void)OPENSSL_init_ssl(0, NULL);
2338 if(dolist) do_list_builtin();
2340 return do_root_update_work(root_anchor_file, root_cert_file, urlname,
2341 xmlname, p7sname, p7signer, res_conf, root_hints, debugconf,
2342 ip4only, ip6only, force, port);