2 * Copyright (C) 2007-2011 Internet Systems Consortium, Inc. ("ISC")
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 * PERFORMANCE OF THIS SOFTWARE.
17 /* $Id: dnssec-keyfromlabel.c,v 1.32.14.2 2011-03-12 04:59:14 tbox Exp $ */
26 #include <isc/buffer.h>
27 #include <isc/commandline.h>
28 #include <isc/entropy.h>
30 #include <isc/region.h>
31 #include <isc/print.h>
32 #include <isc/string.h>
35 #include <dns/dnssec.h>
36 #include <dns/fixedname.h>
37 #include <dns/keyvalues.h>
40 #include <dns/rdataclass.h>
41 #include <dns/result.h>
42 #include <dns/secalg.h>
46 #include "dnssectool.h"
48 #define MAX_RSA 4096 /* should be long enough... */
50 const char *program = "dnssec-keyfromlabel";
53 #define DEFAULT_ALGORITHM "RSASHA1"
54 #define DEFAULT_NSEC3_ALGORITHM "NSEC3RSASHA1"
56 static const char *algs = "RSA | RSAMD5 | DH | DSA | RSASHA1 |"
57 " NSEC3DSA | NSEC3RSASHA1 |"
58 " RSASHA256 | RSASHA512 | ECCGOST";
60 ISC_PLATFORM_NORETURN_PRE static void
61 usage(void) ISC_PLATFORM_NORETURN_POST;
65 fprintf(stderr, "Usage:\n");
66 fprintf(stderr, " %s -l label [options] name\n\n",
68 fprintf(stderr, "Version: %s\n", VERSION);
69 fprintf(stderr, "Required options:\n");
70 fprintf(stderr, " -l label: label of the key pair\n");
71 fprintf(stderr, " name: owner of the key\n");
72 fprintf(stderr, "Other options:\n");
73 fprintf(stderr, " -a algorithm: %s\n", algs);
74 fprintf(stderr, " (default: RSASHA1, or "
75 "NSEC3RSASHA1 if using -3)\n");
76 fprintf(stderr, " -3: use NSEC3-capable algorithm\n");
77 fprintf(stderr, " -c class (default: IN)\n");
79 fprintf(stderr, " -E enginename (default: pkcs11)\n");
81 fprintf(stderr, " -E enginename\n");
83 fprintf(stderr, " -f keyflag: KSK | REVOKE\n");
84 fprintf(stderr, " -K directory: directory in which to place "
86 fprintf(stderr, " -k: generate a TYPE=KEY key\n");
87 fprintf(stderr, " -n nametype: ZONE | HOST | ENTITY | USER | OTHER\n");
88 fprintf(stderr, " (DNSKEY generation defaults to ZONE\n");
89 fprintf(stderr, " -p protocol: default: 3 [dnssec]\n");
90 fprintf(stderr, " -t type: "
91 "AUTHCONF | NOAUTHCONF | NOAUTH | NOCONF "
92 "(default: AUTHCONF)\n");
93 fprintf(stderr, " -y: permit keys that might collide\n");
94 fprintf(stderr, " -v verbose level\n");
95 fprintf(stderr, "Date options:\n");
96 fprintf(stderr, " -P date/[+-]offset: set key publication date\n");
97 fprintf(stderr, " -A date/[+-]offset: set key activation date\n");
98 fprintf(stderr, " -R date/[+-]offset: set key revocation date\n");
99 fprintf(stderr, " -I date/[+-]offset: set key inactivation date\n");
100 fprintf(stderr, " -D date/[+-]offset: set key deletion date\n");
101 fprintf(stderr, " -G: generate key only; do not set -P or -A\n");
102 fprintf(stderr, " -C: generate a backward-compatible key, omitting"
104 fprintf(stderr, "Output:\n");
105 fprintf(stderr, " K<name>+<alg>+<id>.key, "
106 "K<name>+<alg>+<id>.private\n");
112 main(int argc, char **argv) {
113 char *algname = NULL, *nametype = NULL, *type = NULL;
114 const char *directory = NULL;
116 const char *engine = "pkcs11";
118 const char *engine = NULL;
120 char *classname = NULL;
122 dst_key_t *key = NULL;
123 dns_fixedname_t fname;
125 isc_uint16_t flags = 0, kskflag = 0, revflag = 0;
127 isc_boolean_t oldstyle = ISC_FALSE;
128 isc_mem_t *mctx = NULL;
130 int protocol = -1, signatory = 0;
135 isc_log_t *log = NULL;
136 isc_entropy_t *ectx = NULL;
137 dns_rdataclass_t rdclass;
138 int options = DST_TYPE_PRIVATE | DST_TYPE_PUBLIC;
140 isc_stdtime_t publish = 0, activate = 0, revoke = 0;
141 isc_stdtime_t inactive = 0, delete = 0;
143 isc_boolean_t setpub = ISC_FALSE, setact = ISC_FALSE;
144 isc_boolean_t setrev = ISC_FALSE, setinact = ISC_FALSE;
145 isc_boolean_t setdel = ISC_FALSE;
146 isc_boolean_t unsetpub = ISC_FALSE, unsetact = ISC_FALSE;
147 isc_boolean_t unsetrev = ISC_FALSE, unsetinact = ISC_FALSE;
148 isc_boolean_t unsetdel = ISC_FALSE;
149 isc_boolean_t genonly = ISC_FALSE;
150 isc_boolean_t use_nsec3 = ISC_FALSE;
151 isc_boolean_t avoid_collisions = ISC_TRUE;
158 RUNTIME_CHECK(isc_mem_create(0, 0, &mctx) == ISC_R_SUCCESS);
160 dns_result_register();
162 isc_commandline_errprint = ISC_FALSE;
164 isc_stdtime_get(&now);
166 while ((ch = isc_commandline_parse(argc, argv,
167 "3a:Cc:E:f:K:kl:n:p:t:v:yFhGP:A:R:I:D:")) != -1)
171 use_nsec3 = ISC_TRUE;
174 algname = isc_commandline_argument;
180 classname = isc_commandline_argument;
183 engine = isc_commandline_argument;
186 c = (unsigned char)(isc_commandline_argument[0]);
187 if (toupper(c) == 'K')
188 kskflag = DNS_KEYFLAG_KSK;
189 else if (toupper(c) == 'R')
190 revflag = DNS_KEYFLAG_REVOKE;
192 fatal("unknown flag '%s'",
193 isc_commandline_argument);
196 directory = isc_commandline_argument;
197 ret = try_dir(directory);
198 if (ret != ISC_R_SUCCESS)
199 fatal("cannot open directory %s: %s",
200 directory, isc_result_totext(ret));
203 options |= DST_TYPE_KEY;
206 label = isc_mem_strdup(mctx, isc_commandline_argument);
209 nametype = isc_commandline_argument;
212 protocol = strtol(isc_commandline_argument, &endp, 10);
213 if (*endp != '\0' || protocol < 0 || protocol > 255)
214 fatal("-p must be followed by a number "
218 type = isc_commandline_argument;
221 verbose = strtol(isc_commandline_argument, &endp, 0);
223 fatal("-v must be followed by a number");
226 avoid_collisions = ISC_FALSE;
232 if (setpub || unsetpub)
233 fatal("-P specified more than once");
235 if (strcasecmp(isc_commandline_argument, "none")) {
237 publish = strtotime(isc_commandline_argument,
244 if (setact || unsetact)
245 fatal("-A specified more than once");
247 if (strcasecmp(isc_commandline_argument, "none")) {
249 activate = strtotime(isc_commandline_argument,
256 if (setrev || unsetrev)
257 fatal("-R specified more than once");
259 if (strcasecmp(isc_commandline_argument, "none")) {
261 revoke = strtotime(isc_commandline_argument,
268 if (setinact || unsetinact)
269 fatal("-I specified more than once");
271 if (strcasecmp(isc_commandline_argument, "none")) {
273 inactive = strtotime(isc_commandline_argument,
276 unsetinact = ISC_TRUE;
280 if (setdel || unsetdel)
281 fatal("-D specified more than once");
283 if (strcasecmp(isc_commandline_argument, "none")) {
285 delete = strtotime(isc_commandline_argument,
292 /* Reserved for FIPS mode */
295 if (isc_commandline_option != '?')
296 fprintf(stderr, "%s: invalid argument -%c\n",
297 program, isc_commandline_option);
303 fprintf(stderr, "%s: unhandled option -%c\n",
304 program, isc_commandline_option);
310 setup_entropy(mctx, NULL, &ectx);
311 ret = dst_lib_init2(mctx, ectx, engine,
312 ISC_ENTROPY_BLOCKING | ISC_ENTROPY_GOODONLY);
313 if (ret != ISC_R_SUCCESS)
314 fatal("could not initialize dst: %s",
315 isc_result_totext(ret));
317 setup_logging(verbose, mctx, &log);
320 fatal("the key label was not specified");
321 if (argc < isc_commandline_index + 1)
322 fatal("the key name was not specified");
323 if (argc > isc_commandline_index + 1)
324 fatal("extraneous arguments");
326 if (strchr(label, ':') == NULL &&
327 engine != NULL && strlen(engine) != 0U) {
331 len = strlen(label) + strlen(engine) + 2;
332 l = isc_mem_allocate(mctx, len);
334 fatal("cannot allocate memory");
335 snprintf(l, len, "%s:%s", engine, label);
336 isc_mem_free(mctx, label);
340 if (algname == NULL) {
342 algname = strdup(DEFAULT_NSEC3_ALGORITHM);
344 algname = strdup(DEFAULT_ALGORITHM);
346 fprintf(stderr, "no algorithm specified; "
347 "defaulting to %s\n", algname);
350 if (strcasecmp(algname, "RSA") == 0) {
351 fprintf(stderr, "The use of RSA (RSAMD5) is not recommended.\n"
352 "If you still wish to use RSA (RSAMD5) please "
353 "specify \"-a RSAMD5\"\n");
357 r.length = strlen(algname);
358 ret = dns_secalg_fromtext(&alg, &r);
359 if (ret != ISC_R_SUCCESS)
360 fatal("unknown algorithm %s", algname);
361 if (alg == DST_ALG_DH)
362 options |= DST_TYPE_KEY;
366 alg != DST_ALG_NSEC3DSA && alg != DST_ALG_NSEC3RSASHA1 &&
367 alg != DST_ALG_RSASHA256 && alg != DST_ALG_RSASHA512 &&
368 alg != DST_ALG_ECCGOST) {
369 fatal("%s is incompatible with NSEC3; "
370 "do not use the -3 option", algname);
373 if (type != NULL && (options & DST_TYPE_KEY) != 0) {
374 if (strcasecmp(type, "NOAUTH") == 0)
375 flags |= DNS_KEYTYPE_NOAUTH;
376 else if (strcasecmp(type, "NOCONF") == 0)
377 flags |= DNS_KEYTYPE_NOCONF;
378 else if (strcasecmp(type, "NOAUTHCONF") == 0) {
379 flags |= (DNS_KEYTYPE_NOAUTH | DNS_KEYTYPE_NOCONF);
381 else if (strcasecmp(type, "AUTHCONF") == 0)
384 fatal("invalid type %s", type);
387 if (nametype == NULL) {
388 if ((options & DST_TYPE_KEY) != 0) /* KEY */
389 fatal("no nametype specified");
390 flags |= DNS_KEYOWNER_ZONE; /* DNSKEY */
391 } else if (strcasecmp(nametype, "zone") == 0)
392 flags |= DNS_KEYOWNER_ZONE;
393 else if ((options & DST_TYPE_KEY) != 0) { /* KEY */
394 if (strcasecmp(nametype, "host") == 0 ||
395 strcasecmp(nametype, "entity") == 0)
396 flags |= DNS_KEYOWNER_ENTITY;
397 else if (strcasecmp(nametype, "user") == 0)
398 flags |= DNS_KEYOWNER_USER;
400 fatal("invalid KEY nametype %s", nametype);
401 } else if (strcasecmp(nametype, "other") != 0) /* DNSKEY */
402 fatal("invalid DNSKEY nametype %s", nametype);
404 rdclass = strtoclass(classname);
406 if (directory == NULL)
409 if ((options & DST_TYPE_KEY) != 0) /* KEY */
411 else if ((flags & DNS_KEYOWNER_ZONE) != 0) { /* DNSKEY */
417 protocol = DNS_KEYPROTO_DNSSEC;
418 else if ((options & DST_TYPE_KEY) == 0 &&
419 protocol != DNS_KEYPROTO_DNSSEC)
420 fatal("invalid DNSKEY protocol: %d", protocol);
422 if ((flags & DNS_KEYFLAG_TYPEMASK) == DNS_KEYTYPE_NOKEY) {
423 if ((flags & DNS_KEYFLAG_SIGNATORYMASK) != 0)
424 fatal("specified null key with signing authority");
427 if ((flags & DNS_KEYFLAG_OWNERMASK) == DNS_KEYOWNER_ZONE &&
428 alg == DNS_KEYALG_DH)
429 fatal("a key with algorithm '%s' cannot be a zone key",
432 dns_fixedname_init(&fname);
433 name = dns_fixedname_name(&fname);
434 isc_buffer_init(&buf, argv[isc_commandline_index],
435 strlen(argv[isc_commandline_index]));
436 isc_buffer_add(&buf, strlen(argv[isc_commandline_index]));
437 ret = dns_name_fromtext(name, &buf, dns_rootname, 0, NULL);
438 if (ret != ISC_R_SUCCESS)
439 fatal("invalid key name %s: %s", argv[isc_commandline_index],
440 isc_result_totext(ret));
442 isc_buffer_init(&buf, filename, sizeof(filename) - 1);
444 /* associate the key */
445 ret = dst_key_fromlabel(name, alg, flags, protocol,
446 rdclass, engine, label, NULL, mctx, &key);
447 isc_entropy_stopcallbacksources(ectx);
449 if (ret != ISC_R_SUCCESS) {
450 char namestr[DNS_NAME_FORMATSIZE];
451 char algstr[DNS_SECALG_FORMATSIZE];
452 dns_name_format(name, namestr, sizeof(namestr));
453 dns_secalg_format(alg, algstr, sizeof(algstr));
454 fatal("failed to get key %s/%s: %s\n",
455 namestr, algstr, isc_result_totext(ret));
461 * Set key timing metadata (unless using -C)
463 * Publish and activation dates are set to "now" by default, but
464 * can be overridden. Creation date is always set to "now".
467 dst_key_settime(key, DST_TIME_CREATED, now);
469 if (genonly && (setpub || setact))
470 fatal("cannot use -G together with -P or -A options");
473 dst_key_settime(key, DST_TIME_PUBLISH, publish);
475 dst_key_settime(key, DST_TIME_PUBLISH, activate);
476 else if (!genonly && !unsetpub)
477 dst_key_settime(key, DST_TIME_PUBLISH, now);
480 dst_key_settime(key, DST_TIME_ACTIVATE, activate);
481 else if (!genonly && !unsetact)
482 dst_key_settime(key, DST_TIME_ACTIVATE, now);
486 fprintf(stderr, "%s: warning: Key is "
487 "not flagged as a KSK, but -R "
488 "was used. Revoking a ZSK is "
489 "legal, but undefined.\n",
491 dst_key_settime(key, DST_TIME_REVOKE, revoke);
495 dst_key_settime(key, DST_TIME_INACTIVE, inactive);
498 dst_key_settime(key, DST_TIME_DELETE, delete);
500 if (setpub || setact || setrev || setinact ||
501 setdel || unsetpub || unsetact ||
502 unsetrev || unsetinact || unsetdel || genonly)
503 fatal("cannot use -C together with "
504 "-P, -A, -R, -I, -D, or -G options");
506 * Compatibility mode: Private-key-format
507 * should be set to 1.2.
509 dst_key_setprivateformat(key, 1, 2);
513 * Do not overwrite an existing key. Warn LOUDLY if there
514 * is a risk of ID collision due to this key or another key
517 if (key_collision(dst_key_id(key), name, directory, alg, mctx, &exact))
519 isc_buffer_clear(&buf);
520 ret = dst_key_buildfilename(key, 0, directory, &buf);
521 if (ret != ISC_R_SUCCESS)
522 fatal("dst_key_buildfilename returned: %s\n",
523 isc_result_totext(ret));
525 fatal("%s: %s already exists\n", program, filename);
527 if (avoid_collisions)
528 fatal("%s: %s could collide with another key upon "
529 "revokation\n", program, filename);
531 fprintf(stderr, "%s: WARNING: Key %s could collide with "
532 "another key upon revokation. If you plan "
533 "to revoke keys, destroy this key and "
534 "generate a different one.\n",
538 ret = dst_key_tofile(key, options, directory);
539 if (ret != ISC_R_SUCCESS) {
540 char keystr[DST_KEY_FORMATSIZE];
541 dst_key_format(key, keystr, sizeof(keystr));
542 fatal("failed to write key %s: %s\n", keystr,
543 isc_result_totext(ret));
546 isc_buffer_clear(&buf);
547 ret = dst_key_buildfilename(key, 0, NULL, &buf);
548 if (ret != ISC_R_SUCCESS)
549 fatal("dst_key_buildfilename returned: %s\n",
550 isc_result_totext(ret));
551 printf("%s\n", filename);
554 cleanup_logging(&log);
555 cleanup_entropy(&ectx);
559 isc_mem_stats(mctx, stdout);
560 isc_mem_free(mctx, label);
561 isc_mem_destroy(&mctx);