contrib/bind-9.3/bin/rndc/rndc-confgen.c

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 2001, 2003  Internet Software Consortium.
   4  *
   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.
   8  *
   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.
  16  */
  17
  18 /* $Id: rndc-confgen.c,v 1.9.2.6.2.5 2004/09/28 07:14:57 marka Exp $ */
  19
  20 #include <config.h>
  21
  22 #include <stdlib.h>
  23 #include <stdarg.h>
  24
  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>
  30 #include <isc/file.h>
  31 #include <isc/keyboard.h>
  32 #include <isc/mem.h>
  33 #include <isc/net.h>
  34 #include <isc/print.h>
  35 #include <isc/result.h>
  36 #include <isc/string.h>
  37 #include <isc/time.h>
  38 #include <isc/util.h>
  39
  40 #include <dns/keyvalues.h>
  41 #include <dns/name.h>
  42
  43 #include <dst/dst.h>
  44 #include <rndc/os.h>
  45
  46 #include "util.h"
  47
  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
  52
  53 static char program[256];
  54 char *progname;
  55
  56 isc_boolean_t verbose = ISC_FALSE;
  57
  58 const char *keyfile, *keydef;
  59
  60 static void
  61 usage(int status) {
  62
  63         fprintf(stderr, "\
  64 Usage:\n\
  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);
  77
  78         exit (status);
  79 }
  80
  81 /*
  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'.
  85  */
  86 static void
  87 write_key_file(const char *keyfile, const char *user,
  88                const char *keyname, isc_buffer_t *secret )
  89 {
  90         FILE *fd;
  91
  92         fd = safe_create(keyfile);
  93         if (fd == NULL)
  94                 fatal( "unable to create \"%s\"\n", keyfile);
  95         if (user != NULL) {
  96                 if (set_user(fd, user) == -1)
  97                         fatal("unable to set file owner\n");
  98         }
  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));
 103         fflush(fd);
 104         if (ferror(fd))
 105                 fatal("write to %s failed\n", keyfile);
 106         if (fclose(fd))
 107                 fatal("fclose(%s) failed\n", keyfile);
 108         fprintf(stderr, "wrote key file \"%s\"\n", keyfile);
 109 }
 110
 111 int
 112 main(int argc, char **argv) {
 113         isc_boolean_t show_final_mem = ISC_FALSE;
 114         isc_buffer_t key_rawbuffer;
 115         isc_buffer_t key_txtbuffer;
 116         isc_region_t key_rawregion;
 117         isc_mem_t *mctx = NULL;
 118         isc_entropy_t *ectx = NULL;
 119         isc_entropysource_t *entropy_source = NULL;
 120         isc_result_t result = ISC_R_SUCCESS;
 121         dst_key_t *key = NULL;
 122         const char *keyname = NULL;
 123         const char *randomfile = NULL;
 124         const char *serveraddr = NULL;
 125         char key_rawsecret[64];
 126         char key_txtsecret[256];
 127         char *p;
 128         int ch;
 129         int port;
 130         int keysize;
 131         int entropy_flags = 0;
 132         int open_keyboard = ISC_ENTROPY_KEYBOARDMAYBE;
 133         struct in_addr addr4_dummy;
 134         struct in6_addr addr6_dummy;
 135         char *chrootdir = NULL;
 136         char *user = NULL;
 137         isc_boolean_t keyonly = ISC_FALSE;
 138         int len;
 139
 140         keydef = keyfile = RNDC_KEYFILE;
 141
 142         result = isc_file_progname(*argv, program, sizeof(program));
 143         if (result != ISC_R_SUCCESS)
 144                 memcpy(program, "rndc-confgen", 13);
 145         progname = program;
 146
 147         keyname = DEFAULT_KEYNAME;
 148         keysize = DEFAULT_KEYLENGTH;
 149         serveraddr = DEFAULT_SERVER;
 150         port = DEFAULT_PORT;
 151
 152         while ((ch = isc_commandline_parse(argc, argv,
 153                                            "ab:c:hk:Mmp:r:s:t:u:Vy")) != -1) {
 154                 switch (ch) {
 155                 case 'a':
 156                         keyonly = ISC_TRUE;
 157                         break;
 158                 case 'b':
 159                         keysize = strtol(isc_commandline_argument, &p, 10);
 160                         if (*p != '\0' || keysize < 0)
 161                                 fatal("-b requires a non-negative number");
 162                         if (keysize < 1 || keysize > 512)
 163                                 fatal("-b must be in the range 1 through 512");
 164                         break;
 165                 case 'c':
 166                         keyfile = isc_commandline_argument;
 167                         break;
 168                 case 'h':
 169                         usage(0);
 170                 case 'k':
 171                 case 'y':       /* Compatible with rndc -y. */
 172                         keyname = isc_commandline_argument;
 173                         break;
 174                 case 'M':
 175                         isc_mem_debugging = ISC_MEM_DEBUGTRACE;
 176                         break;
 177
 178                 case 'm':
 179                         show_final_mem = ISC_TRUE;
 180                         break;
 181                 case 'p':
 182                         port = strtol(isc_commandline_argument, &p, 10);
 183                         if (*p != '\0' || port < 0 || port > 65535)
 184                                 fatal("port '%s' out of range",
 185                                       isc_commandline_argument);
 186                         break;
 187                 case 'r':
 188                         randomfile = isc_commandline_argument;
 189                         break;
 190                 case 's':
 191                         serveraddr = isc_commandline_argument;
 192                         if (inet_pton(AF_INET, serveraddr, &addr4_dummy) != 1 &&
 193                             inet_pton(AF_INET6, serveraddr, &addr6_dummy) != 1)
 194                                 fatal("-s should be an IPv4 or IPv6 address");
 195                         break;
 196                 case 't':
 197                         chrootdir = isc_commandline_argument;
 198                         break;
 199                 case 'u':
 200                         user = isc_commandline_argument;
 201                         break;
 202                 case 'V':
 203                         verbose = ISC_TRUE;
 204                         break;
 205                 case '?':
 206                         usage(1);
 207                         break;
 208                 default:
 209                         fatal("unexpected error parsing command arguments: "
 210                               "got %c\n", ch);
 211                         break;
 212                 }
 213         }
 214
 215         argc -= isc_commandline_index;
 216         argv += isc_commandline_index;
 217
 218         if (argc > 0)
 219                 usage(1);
 220
 221         DO("create memory context", isc_mem_create(0, 0, &mctx));
 222
 223         DO("create entropy context", isc_entropy_create(mctx, &ectx));
 224
 225         if (randomfile != NULL && strcmp(randomfile, "keyboard") == 0) {
 226                 randomfile = NULL;
 227                 open_keyboard = ISC_ENTROPY_KEYBOARDYES;
 228         }
 229         DO("start entropy source", isc_entropy_usebestsource(ectx,
 230                                                              &entropy_source,
 231                                                              randomfile,
 232                                                              open_keyboard));
 233
 234         entropy_flags = ISC_ENTROPY_BLOCKING | ISC_ENTROPY_GOODONLY;
 235
 236         DO("initialize dst library", dst_lib_init(mctx, ectx, entropy_flags));
 237
 238         DO("generate key", dst_key_generate(dns_rootname, DST_ALG_HMACMD5,
 239                                             keysize, 0, 0,
 240                                             DNS_KEYPROTO_ANY,
 241                                             dns_rdataclass_in, mctx, &key));
 242
 243         isc_buffer_init(&key_rawbuffer, &key_rawsecret, sizeof(key_rawsecret));
 244
 245         DO("dump key to buffer", dst_key_tobuffer(key, &key_rawbuffer));
 246
 247         isc_buffer_init(&key_txtbuffer, &key_txtsecret, sizeof(key_txtsecret));
 248         isc_buffer_usedregion(&key_rawbuffer, &key_rawregion);
 249
 250         DO("bsse64 encode secret", isc_base64_totext(&key_rawregion, -1, "",
 251                                                      &key_txtbuffer));
 252
 253         /*
 254          * Shut down the entropy source now so the "stop typing" message
 255          * does not muck with the output.
 256          */
 257         if (entropy_source != NULL)
 258                 isc_entropy_destroysource(&entropy_source);
 259
 260         if (key != NULL)
 261                 dst_key_free(&key);
 262
 263         isc_entropy_detach(&ectx);
 264         dst_lib_destroy();
 265
 266         if (keyonly) {
 267                 write_key_file(keyfile, chrootdir == NULL ? user : NULL,
 268                                keyname, &key_txtbuffer);
 269
 270                 if (chrootdir != NULL) {
 271                         char *buf;
 272                         len = strlen(chrootdir) + strlen(keyfile) + 2;
 273                         buf = isc_mem_get(mctx, len);
 274                         if (buf == NULL)
 275                                 fatal("isc_mem_get(%d) failed\n", len);
 276                         snprintf(buf, len, "%s%s%s", chrootdir,
 277                                  (*keyfile != '/') ? "/" : "", keyfile);
 278
 279                         write_key_file(buf, user, keyname, &key_txtbuffer);
 280                         isc_mem_put(mctx, buf, len);
 281                 }
 282         } else {
 283                 printf("\
 284 # Start of rndc.conf\n\
 285 key \"%s\" {\n\
 286         algorithm hmac-md5;\n\
 287         secret \"%.*s\";\n\
 288 };\n\
 289 \n\
 290 options {\n\
 291         default-key \"%s\";\n\
 292         default-server %s;\n\
 293         default-port %d;\n\
 294 };\n\
 295 # End of rndc.conf\n\
 296 \n\
 297 # Use with the following in named.conf, adjusting the allow list as needed:\n\
 298 # key \"%s\" {\n\
 299 #       algorithm hmac-md5;\n\
 300 #       secret \"%.*s\";\n\
 301 # };\n\
 302 # \n\
 303 # controls {\n\
 304 #       inet %s port %d\n\
 305 #               allow { %s; } keys { \"%s\"; };\n\
 306 # };\n\
 307 # End of named.conf\n",
 308                        keyname,
 309                        (int)isc_buffer_usedlength(&key_txtbuffer),
 310                        (char *)isc_buffer_base(&key_txtbuffer),
 311                        keyname, serveraddr, port,
 312                        keyname,
 313                        (int)isc_buffer_usedlength(&key_txtbuffer),
 314                        (char *)isc_buffer_base(&key_txtbuffer),
 315                        serveraddr, port, serveraddr, keyname);
 316         }
 317
 318         if (show_final_mem)
 319                 isc_mem_stats(mctx, stderr);
 320
 321         isc_mem_destroy(&mctx);
 322
 323         return (0);
 324 }