rndc-confgen.c 7.29 KB
Newer Older
1
/*
Tinderbox User's avatar
Tinderbox User committed
2
 * Copyright (C) 2004, 2005, 2007-2009, 2011, 2013  Internet Systems Consortium, Inc. ("ISC")
Automatic Updater's avatar
Automatic Updater committed
3
 * Copyright (C) 2001, 2003  Internet Software Consortium.
4
 *
Automatic Updater's avatar
Automatic Updater committed
5
 * Permission to use, copy, modify, and/or distribute this software for any
6 7 8
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
Mark Andrews's avatar
Mark Andrews committed
9 10 11 12 13 14 15
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
16 17
 */

Automatic Updater's avatar
Automatic Updater committed
18
/* $Id: rndc-confgen.c,v 1.7 2011/03/12 04:59:46 tbox Exp $ */
19 20 21 22 23 24 25 26 27 28 29

/*! \file */

/**
 * rndc-confgen generates configuration files for rndc. It can be used
 * as a convenient alternative to writing the rndc.conf file and the
 * corresponding controls and key statements in named.conf by hand.
 * Alternatively, it can be run with the -a option to set up a
 * rndc.key file and avoid the need for a rndc.conf file and a
 * controls statement altogether.
 */
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

#include <config.h>

#include <stdlib.h>
#include <stdarg.h>

#include <isc/assertions.h>
#include <isc/base64.h>
#include <isc/buffer.h>
#include <isc/commandline.h>
#include <isc/entropy.h>
#include <isc/file.h>
#include <isc/keyboard.h>
#include <isc/mem.h>
#include <isc/net.h>
45
#include <isc/print.h>
46 47 48 49 50 51 52 53 54
#include <isc/result.h>
#include <isc/string.h>
#include <isc/time.h>
#include <isc/util.h>

#include <dns/keyvalues.h>
#include <dns/name.h>

#include <dst/dst.h>
55
#include <confgen/os.h>
56 57

#include "util.h"
58
#include "keygen.h"
59 60 61 62 63

#define DEFAULT_KEYNAME		"rndc-key"
#define DEFAULT_SERVER		"127.0.0.1"
#define DEFAULT_PORT		953

64
static char program[256];
65
const char *progname;
66

67 68
isc_boolean_t verbose = ISC_FALSE;

Mark Andrews's avatar
Mark Andrews committed
69 70
const char *keyfile, *keydef;

Francis Dupont's avatar
Francis Dupont committed
71 72 73
ISC_PLATFORM_NORETURN_PRE static void
usage(int status) ISC_PLATFORM_NORETURN_POST;

74 75
static void
usage(int status) {
Mark Andrews's avatar
Mark Andrews committed
76

77 78
	fprintf(stderr, "\
Usage:\n\
79
 %s [-a] [-b bits] [-c keyfile] [-k keyname] [-p port] [-r randomfile] \
Mark Andrews's avatar
Mark Andrews committed
80
[-s addr] [-t chrootdir] [-u user]\n\
81
  -a:		 generate just the key clause and write it to keyfile (%s)\n\
82 83
  -A alg:	 algorithm (default hmac-md5)\n\
  -b bits:	 from 1 through 512, default 256; total length of the secret\n\
84 85 86 87 88 89 90
  -c keyfile:	 specify an alternate key file (requires -a)\n\
  -k keyname:	 the name as it will be used  in named.conf and rndc.conf\n\
  -p port:	 the port named will listen on and rndc will connect to\n\
  -r randomfile: source of random data (use \"keyboard\" for key timing)\n\
  -s addr:	 the address to which rndc should connect\n\
  -t chrootdir:	 write a keyfile in chrootdir as well (requires -a)\n\
  -u user:	 set the keyfile owner to \"user\" (requires -a)\n",
91
		 progname, keydef);
92 93 94 95 96 97 98 99

	exit (status);
}

int
main(int argc, char **argv) {
	isc_boolean_t show_final_mem = ISC_FALSE;
	isc_buffer_t key_txtbuffer;
100
	char key_txtsecret[256];
101 102 103 104 105
	isc_mem_t *mctx = NULL;
	isc_result_t result = ISC_R_SUCCESS;
	const char *keyname = NULL;
	const char *randomfile = NULL;
	const char *serveraddr = NULL;
106 107
	dns_secalg_t alg;
	const char *algname;
108 109 110
	char *p;
	int ch;
	int port;
111
	int keysize = -1;
112 113
	struct in_addr addr4_dummy;
	struct in6_addr addr6_dummy;
Mark Andrews's avatar
Mark Andrews committed
114 115 116 117 118
	char *chrootdir = NULL;
	char *user = NULL;
	isc_boolean_t keyonly = ISC_FALSE;
	int len;

Automatic Updater's avatar
Automatic Updater committed
119
	keydef = keyfile = RNDC_KEYFILE;
120

121
	result = isc_file_progname(*argv, program, sizeof(program));
122
	if (result != ISC_R_SUCCESS)
123 124
		memcpy(program, "rndc-confgen", 13);
	progname = program;
125 126

	keyname = DEFAULT_KEYNAME;
127
	alg = DST_ALG_HMACMD5;
128 129 130
	serveraddr = DEFAULT_SERVER;
	port = DEFAULT_PORT;

131 132
	isc_commandline_errprint = ISC_FALSE;

Mark Andrews's avatar
Mark Andrews committed
133
	while ((ch = isc_commandline_parse(argc, argv,
134 135
					   "aA:b:c:hk:Mmp:r:s:t:u:Vy")) != -1)
	{
136
		switch (ch) {
Mark Andrews's avatar
Mark Andrews committed
137 138 139
		case 'a':
			keyonly = ISC_TRUE;
			break;
140 141 142 143 144 145
		case 'A':
			algname = isc_commandline_argument;
			alg = alg_fromtext(algname);
			if (alg == DST_ALG_UNKNOWN)
				fatal("Unsupported algorithm '%s'", algname);
			break;
146 147 148 149 150
		case 'b':
			keysize = strtol(isc_commandline_argument, &p, 10);
			if (*p != '\0' || keysize < 0)
				fatal("-b requires a non-negative number");
			break;
Mark Andrews's avatar
Mark Andrews committed
151 152 153
		case 'c':
			keyfile = isc_commandline_argument;
			break;
154 155 156 157 158 159 160
		case 'h':
			usage(0);
		case 'k':
		case 'y':	/* Compatible with rndc -y. */
			keyname = isc_commandline_argument;
			break;
		case 'M':
161
			isc_mem_debugging = ISC_MEM_DEBUGTRACE;
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
			break;

		case 'm':
			show_final_mem = ISC_TRUE;
			break;
		case 'p':
			port = strtol(isc_commandline_argument, &p, 10);
			if (*p != '\0' || port < 0 || port > 65535)
				fatal("port '%s' out of range",
				      isc_commandline_argument);
			break;
		case 'r':
			randomfile = isc_commandline_argument;
			break;
		case 's':
			serveraddr = isc_commandline_argument;
178 179
			if (inet_pton(AF_INET, serveraddr, &addr4_dummy) != 1 &&
			    inet_pton(AF_INET6, serveraddr, &addr6_dummy) != 1)
180
				fatal("-s should be an IPv4 or IPv6 address");
Mark Andrews's avatar
Mark Andrews committed
181 182 183 184 185 186
			break;
		case 't':
			chrootdir = isc_commandline_argument;
			break;
		case 'u':
			user = isc_commandline_argument;
187 188 189 190 191
			break;
		case 'V':
			verbose = ISC_TRUE;
			break;
		case '?':
192 193 194 195 196 197
			if (isc_commandline_option != '?') {
				fprintf(stderr, "%s: invalid argument -%c\n",
					program, isc_commandline_option);
				usage(1);
			} else
				usage(0);
198 199
			break;
		default:
200 201 202
			fprintf(stderr, "%s: unhandled option -%c\n",
				program, isc_commandline_option);
			exit(1);
203 204 205 206 207
		}
	}

	argc -= isc_commandline_index;
	argv += isc_commandline_index;
208
	POST(argv);
209 210 211 212

	if (argc > 0)
		usage(1);

213 214 215 216
	if (keysize < 0)
		keysize = alg_bits(alg);
	algname = alg_totext(alg);

217 218 219
	DO("create memory context", isc_mem_create(0, 0, &mctx));
	isc_buffer_init(&key_txtbuffer, &key_txtsecret, sizeof(key_txtsecret));

220
	generate_key(mctx, randomfile, alg, keysize, &key_txtbuffer);
221

Mark Andrews's avatar
Mark Andrews committed
222
	if (keyonly) {
223
		write_key_file(keyfile, chrootdir == NULL ? user : NULL,
224
			       keyname, &key_txtbuffer, alg);
225 226 227 228 229

		if (chrootdir != NULL) {
			char *buf;
			len = strlen(chrootdir) + strlen(keyfile) + 2;
			buf = isc_mem_get(mctx, len);
230 231
			if (buf == NULL)
				fatal("isc_mem_get(%d) failed\n", len);
232 233
			snprintf(buf, len, "%s%s%s", chrootdir,
				 (*keyfile != '/') ? "/" : "", keyfile);
Automatic Updater's avatar
Automatic Updater committed
234

235
			write_key_file(buf, user, keyname, &key_txtbuffer, alg);
Mark Andrews's avatar
Mark Andrews committed
236 237 238 239
			isc_mem_put(mctx, buf, len);
		}
	} else {
		printf("\
240 241
# Start of rndc.conf\n\
key \"%s\" {\n\
242
	algorithm %s;\n\
243 244 245 246 247 248 249 250 251 252 253 254
	secret \"%.*s\";\n\
};\n\
\n\
options {\n\
	default-key \"%s\";\n\
	default-server %s;\n\
	default-port %d;\n\
};\n\
# End of rndc.conf\n\
\n\
# Use with the following in named.conf, adjusting the allow list as needed:\n\
# key \"%s\" {\n\
255
# 	algorithm %s;\n\
256 257 258 259 260 261 262 263
# 	secret \"%.*s\";\n\
# };\n\
# \n\
# controls {\n\
# 	inet %s port %d\n\
# 		allow { %s; } keys { \"%s\"; };\n\
# };\n\
# End of named.conf\n",
264
		       keyname, algname,
Mark Andrews's avatar
Mark Andrews committed
265 266 267
		       (int)isc_buffer_usedlength(&key_txtbuffer),
		       (char *)isc_buffer_base(&key_txtbuffer),
		       keyname, serveraddr, port,
268
		       keyname, algname,
Mark Andrews's avatar
Mark Andrews committed
269 270 271 272
		       (int)isc_buffer_usedlength(&key_txtbuffer),
		       (char *)isc_buffer_base(&key_txtbuffer),
		       serveraddr, port, serveraddr, keyname);
	}
273 274 275 276 277 278 279 280

	if (show_final_mem)
		isc_mem_stats(mctx, stderr);

	isc_mem_destroy(&mctx);

	return (0);
}