2 * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2001, 2003 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: rndc-confgen.c,v 1.9.2.7 2004/03/09 06:09:26 marka Exp $ */
25 #include <isc/assertions.h>
26 #include <isc/base64.h>
27 #include <isc/buffer.h>
28 #include <isc/commandline.h>
29 #include <isc/entropy.h>
31 #include <isc/keyboard.h>
34 #include <isc/print.h>
35 #include <isc/result.h>
36 #include <isc/string.h>
40 #include <dns/keyvalues.h>
48 #define DEFAULT_KEYLENGTH 128 /* Bits. */
49 #define DEFAULT_KEYNAME "rndc-key"
50 #define DEFAULT_SERVER "127.0.0.1"
51 #define DEFAULT_PORT 953
53 static char program[256];
56 isc_boolean_t verbose = ISC_FALSE;
58 const char *keyfile, *keydef;
65 %s [-a] [-b bits] [-c keyfile] [-k keyname] [-p port] [-r randomfile] \
66 [-s addr] [-t chrootdir] [-u user]\n\
67 -a: generate just the key clause and write it to keyfile (%s)\n\
68 -b bits: from 1 through 512, default %d; total length of the secret\n\
69 -c keyfile: specify an alternate key file (requires -a)\n\
70 -k keyname: the name as it will be used in named.conf and rndc.conf\n\
71 -p port: the port named will listen on and rndc will connect to\n\
72 -r randomfile: a file containing random data\n\
73 -s addr: the address to which rndc should connect\n\
74 -t chrootdir: write a keyfile in chrootdir as well (requires -a)\n\
75 -u user: set the keyfile owner to \"user\" (requires -a)\n",
76 progname, keydef, DEFAULT_KEYLENGTH);
82 * Write an rndc.key file to 'keyfile'. If 'user' is non-NULL,
83 * make that user the owner of the file. The key will have
84 * the name 'keyname' and the secret in the buffer 'secret'.
87 write_key_file(const char *keyfile, const char *user,
88 const char *keyname, isc_buffer_t *secret )
92 fd = safe_create(keyfile);
94 fatal( "unable to create \"%s\"\n", keyfile);
96 if (set_user(fd, user) == -1)
97 fatal("unable to set file owner\n");
99 fprintf(fd, "key \"%s\" {\n\talgorithm hmac-md5;\n"
100 "\tsecret \"%.*s\";\n};\n", keyname,
101 (int)isc_buffer_usedlength(secret),
102 (char *)isc_buffer_base(secret));
105 fatal("write to %s failed\n", keyfile);
107 fatal("fclose(%s) failed\n", keyfile);
111 main(int argc, char **argv) {
112 isc_boolean_t show_final_mem = ISC_FALSE;
113 isc_buffer_t key_rawbuffer;
114 isc_buffer_t key_txtbuffer;
115 isc_region_t key_rawregion;
116 isc_mem_t *mctx = NULL;
117 isc_entropy_t *ectx = NULL;
118 isc_entropysource_t *entropy_source = NULL;
119 isc_result_t result = ISC_R_SUCCESS;
120 dst_key_t *key = NULL;
121 const char *keyname = NULL;
122 const char *randomfile = NULL;
123 const char *serveraddr = NULL;
124 char key_rawsecret[64];
125 char key_txtsecret[256];
130 int entropy_flags = 0;
131 int open_keyboard = ISC_ENTROPY_KEYBOARDMAYBE;
132 struct in_addr addr4_dummy;
133 struct in6_addr addr6_dummy;
134 char *chrootdir = NULL;
136 isc_boolean_t keyonly = ISC_FALSE;
139 keydef = keyfile = RNDC_KEYFILE;
141 result = isc_file_progname(*argv, program, sizeof(program));
142 if (result != ISC_R_SUCCESS)
143 memcpy(program, "rndc-confgen", 13);
146 keyname = DEFAULT_KEYNAME;
147 keysize = DEFAULT_KEYLENGTH;
148 serveraddr = DEFAULT_SERVER;
151 while ((ch = isc_commandline_parse(argc, argv,
152 "ab:c:hk:Mmp:r:s:t:u:Vy")) != -1) {
158 keysize = strtol(isc_commandline_argument, &p, 10);
159 if (*p != '\0' || keysize < 0)
160 fatal("-b requires a non-negative number");
161 if (keysize < 1 || keysize > 512)
162 fatal("-b must be in the range 1 through 512");
165 keyfile = isc_commandline_argument;
170 case 'y': /* Compatible with rndc -y. */
171 keyname = isc_commandline_argument;
174 isc_mem_debugging = 1;
178 show_final_mem = ISC_TRUE;
181 port = strtol(isc_commandline_argument, &p, 10);
182 if (*p != '\0' || port < 0 || port > 65535)
183 fatal("port '%s' out of range",
184 isc_commandline_argument);
187 randomfile = isc_commandline_argument;
190 serveraddr = isc_commandline_argument;
191 if (inet_pton(AF_INET, serveraddr, &addr4_dummy) != 1 &&
192 inet_pton(AF_INET6, serveraddr, &addr6_dummy) != 1)
193 fatal("-s should be an IPv4 or IPv6 address");
196 chrootdir = isc_commandline_argument;
199 user = isc_commandline_argument;
208 fatal("unexpected error parsing command arguments: "
214 argc -= isc_commandline_index;
215 argv += isc_commandline_index;
220 DO("create memory context", isc_mem_create(0, 0, &mctx));
222 DO("create entropy context", isc_entropy_create(mctx, &ectx));
224 if (randomfile != NULL && strcmp(randomfile, "keyboard") == 0) {
226 open_keyboard = ISC_ENTROPY_KEYBOARDYES;
228 DO("start entropy source", isc_entropy_usebestsource(ectx,
233 entropy_flags = ISC_ENTROPY_BLOCKING | ISC_ENTROPY_GOODONLY;
235 DO("initialize dst library", dst_lib_init(mctx, ectx, entropy_flags));
237 DO("generate key", dst_key_generate(dns_rootname, DST_ALG_HMACMD5,
240 dns_rdataclass_in, mctx, &key));
242 isc_buffer_init(&key_rawbuffer, &key_rawsecret, sizeof(key_rawsecret));
244 DO("dump key to buffer", dst_key_tobuffer(key, &key_rawbuffer));
246 isc_buffer_init(&key_txtbuffer, &key_txtsecret, sizeof(key_txtsecret));
247 isc_buffer_usedregion(&key_rawbuffer, &key_rawregion);
249 DO("bsse64 encode secret", isc_base64_totext(&key_rawregion, -1, "",
253 * Shut down the entropy source now so the "stop typing" message
254 * does not muck with the output.
256 if (entropy_source != NULL)
257 isc_entropy_destroysource(&entropy_source);
262 isc_entropy_detach(&ectx);
266 write_key_file(keyfile, chrootdir == NULL ? user : NULL,
267 keyname, &key_txtbuffer);
269 if (chrootdir != NULL) {
271 len = strlen(chrootdir) + strlen(keyfile) + 2;
272 buf = isc_mem_get(mctx, len);
274 fatal("isc_mem_get(%d) failed\n", len);
275 snprintf(buf, len, "%s/%s", chrootdir, keyfile);
277 write_key_file(buf, user, keyname, &key_txtbuffer);
278 isc_mem_put(mctx, buf, len);
282 # Start of rndc.conf\n\
284 algorithm hmac-md5;\n\
289 default-key \"%s\";\n\
290 default-server %s;\n\
293 # End of rndc.conf\n\
295 # Use with the following in named.conf, adjusting the allow list as needed:\n\
297 # algorithm hmac-md5;\n\
298 # secret \"%.*s\";\n\
303 # allow { %s; } keys { \"%s\"; };\n\
305 # End of named.conf\n",
307 (int)isc_buffer_usedlength(&key_txtbuffer),
308 (char *)isc_buffer_base(&key_txtbuffer),
309 keyname, serveraddr, port,
311 (int)isc_buffer_usedlength(&key_txtbuffer),
312 (char *)isc_buffer_base(&key_txtbuffer),
313 serveraddr, port, serveraddr, keyname);
317 isc_mem_stats(mctx, stderr);
319 isc_mem_destroy(&mctx);