contrib/bind9/lib/dns/dst_parse.c

   1 /*
   2  * Portions Copyright (C) 2004-2010  Internet Systems Consortium, Inc. ("ISC")
   3  * Portions Copyright (C) 1999-2002  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or 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 AND NETWORK ASSOCIATES DISCLAIMS
  10  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  11  * WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE
  12  * FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
  15  * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  *
  17  * Portions Copyright (C) 1995-2000 by Network Associates, Inc.
  18  *
  19  * Permission to use, copy, modify, and/or distribute this software for any
  20  * purpose with or without fee is hereby granted, provided that the above
  21  * copyright notice and this permission notice appear in all copies.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC AND NETWORK ASSOCIATES DISCLAIMS
  24  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
  25  * WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE
  26  * FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  27  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  28  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
  29  * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  30  */
  31
  32 /*%
  33  * Principal Author: Brian Wellington
  34  * $Id: dst_parse.c,v 1.14.120.6 2010/01/15 19:38:53 each Exp $
  35  */
  36
  37 #include <config.h>
  38
  39 #include <isc/base64.h>
  40 #include <isc/dir.h>
  41 #include <isc/fsaccess.h>
  42 #include <isc/lex.h>
  43 #include <isc/mem.h>
  44 #include <isc/string.h>
  45 #include <isc/util.h>
  46
  47 #include "dst_internal.h"
  48 #include "dst_parse.h"
  49 #include "dst/result.h"
  50
  51 #define DST_AS_STR(t) ((t).value.as_textregion.base)
  52
  53 #define PRIVATE_KEY_STR "Private-key-format:"
  54 #define ALGORITHM_STR "Algorithm:"
  55
  56 struct parse_map {
  57         const int value;
  58         const char *tag;
  59 };
  60
  61 static struct parse_map map[] = {
  62         {TAG_RSA_MODULUS, "Modulus:"},
  63         {TAG_RSA_PUBLICEXPONENT, "PublicExponent:"},
  64         {TAG_RSA_PRIVATEEXPONENT, "PrivateExponent:"},
  65         {TAG_RSA_PRIME1, "Prime1:"},
  66         {TAG_RSA_PRIME2, "Prime2:"},
  67         {TAG_RSA_EXPONENT1, "Exponent1:"},
  68         {TAG_RSA_EXPONENT2, "Exponent2:"},
  69         {TAG_RSA_COEFFICIENT, "Coefficient:"},
  70         {TAG_RSA_ENGINE, "Engine:" },
  71         {TAG_RSA_LABEL, "Label:" },
  72         {TAG_RSA_PIN, "PIN:" },
  73
  74         {TAG_DH_PRIME, "Prime(p):"},
  75         {TAG_DH_GENERATOR, "Generator(g):"},
  76         {TAG_DH_PRIVATE, "Private_value(x):"},
  77         {TAG_DH_PUBLIC, "Public_value(y):"},
  78
  79         {TAG_DSA_PRIME, "Prime(p):"},
  80         {TAG_DSA_SUBPRIME, "Subprime(q):"},
  81         {TAG_DSA_BASE, "Base(g):"},
  82         {TAG_DSA_PRIVATE, "Private_value(x):"},
  83         {TAG_DSA_PUBLIC, "Public_value(y):"},
  84
  85         {TAG_HMACMD5_KEY, "Key:"},
  86         {TAG_HMACMD5_BITS, "Bits:"},
  87
  88         {TAG_HMACSHA1_KEY, "Key:"},
  89         {TAG_HMACSHA1_BITS, "Bits:"},
  90
  91         {TAG_HMACSHA224_KEY, "Key:"},
  92         {TAG_HMACSHA224_BITS, "Bits:"},
  93
  94         {TAG_HMACSHA256_KEY, "Key:"},
  95         {TAG_HMACSHA256_BITS, "Bits:"},
  96
  97         {TAG_HMACSHA384_KEY, "Key:"},
  98         {TAG_HMACSHA384_BITS, "Bits:"},
  99
 100         {TAG_HMACSHA512_KEY, "Key:"},
 101         {TAG_HMACSHA512_BITS, "Bits:"},
 102
 103         {0, NULL}
 104 };
 105
 106 static int
 107 find_value(const char *s, const unsigned int alg) {
 108         int i;
 109
 110         for (i = 0; ; i++) {
 111                 if (map[i].tag == NULL)
 112                         return (-1);
 113                 else if (strcasecmp(s, map[i].tag) == 0 &&
 114                          TAG_ALG(map[i].value) == alg)
 115                         return (map[i].value);
 116         }
 117 }
 118
 119 static const char *
 120 find_tag(const int value) {
 121         int i;
 122
 123         for (i = 0; ; i++) {
 124                 if (map[i].tag == NULL)
 125                         return (NULL);
 126                 else if (value == map[i].value)
 127                         return (map[i].tag);
 128         }
 129 }
 130
 131 static int
 132 check_rsa(const dst_private_t *priv) {
 133         int i, j;
 134         isc_boolean_t have[RSA_NTAGS];
 135         isc_boolean_t ok;
 136         unsigned int mask;
 137
 138         for (i = 0; i < RSA_NTAGS; i++)
 139                 have[i] = ISC_FALSE;
 140         for (j = 0; j < priv->nelements; j++) {
 141                 for (i = 0; i < RSA_NTAGS; i++)
 142                         if (priv->elements[j].tag == TAG(DST_ALG_RSAMD5, i))
 143                                 break;
 144                 if (i == RSA_NTAGS)
 145                         return (-1);
 146                 have[i] = ISC_TRUE;
 147         }
 148
 149         mask = ~0;
 150         mask <<= sizeof(mask) * 8 - TAG_SHIFT;
 151         mask >>= sizeof(mask) * 8 - TAG_SHIFT;
 152
 153         if (have[TAG_RSA_ENGINE & mask])
 154                 ok = have[TAG_RSA_MODULUS & mask] &&
 155                      have[TAG_RSA_PUBLICEXPONENT & mask] &&
 156                      have[TAG_RSA_LABEL & mask];
 157         else
 158                 ok = have[TAG_RSA_MODULUS & mask] &&
 159                      have[TAG_RSA_PUBLICEXPONENT & mask] &&
 160                      have[TAG_RSA_PRIVATEEXPONENT & mask] &&
 161                      have[TAG_RSA_PRIME1 & mask] &&
 162                      have[TAG_RSA_PRIME2 & mask] &&
 163                      have[TAG_RSA_EXPONENT1 & mask] &&
 164                      have[TAG_RSA_EXPONENT2 & mask] &&
 165                      have[TAG_RSA_COEFFICIENT & mask];
 166         return (ok ? 0 : -1 );
 167 }
 168
 169 static int
 170 check_dh(const dst_private_t *priv) {
 171         int i, j;
 172         if (priv->nelements != DH_NTAGS)
 173                 return (-1);
 174         for (i = 0; i < DH_NTAGS; i++) {
 175                 for (j = 0; j < priv->nelements; j++)
 176                         if (priv->elements[j].tag == TAG(DST_ALG_DH, i))
 177                                 break;
 178                 if (j == priv->nelements)
 179                         return (-1);
 180         }
 181         return (0);
 182 }
 183
 184 static int
 185 check_dsa(const dst_private_t *priv) {
 186         int i, j;
 187         if (priv->nelements != DSA_NTAGS)
 188                 return (-1);
 189         for (i = 0; i < DSA_NTAGS; i++) {
 190                 for (j = 0; j < priv->nelements; j++)
 191                         if (priv->elements[j].tag == TAG(DST_ALG_DSA, i))
 192                                 break;
 193                 if (j == priv->nelements)
 194                         return (-1);
 195         }
 196         return (0);
 197 }
 198
 199 static int
 200 check_hmac_md5(const dst_private_t *priv, isc_boolean_t old) {
 201         int i, j;
 202
 203         if (priv->nelements != HMACMD5_NTAGS) {
 204                 /*
 205                  * If this is a good old format and we are accepting
 206                  * the old format return success.
 207                  */
 208                 if (old && priv->nelements == OLD_HMACMD5_NTAGS &&
 209                     priv->elements[0].tag == TAG_HMACMD5_KEY)
 210                         return (0);
 211                 return (-1);
 212         }
 213         /*
 214          * We must be new format at this point.
 215          */
 216         for (i = 0; i < HMACMD5_NTAGS; i++) {
 217                 for (j = 0; j < priv->nelements; j++)
 218                         if (priv->elements[j].tag == TAG(DST_ALG_HMACMD5, i))
 219                                 break;
 220                 if (j == priv->nelements)
 221                         return (-1);
 222         }
 223         return (0);
 224 }
 225
 226 static int
 227 check_hmac_sha(const dst_private_t *priv, unsigned int ntags,
 228                unsigned int alg)
 229 {
 230         unsigned int i, j;
 231         if (priv->nelements != ntags)
 232                 return (-1);
 233         for (i = 0; i < ntags; i++) {
 234                 for (j = 0; j < priv->nelements; j++)
 235                         if (priv->elements[j].tag == TAG(alg, i))
 236                                 break;
 237                 if (j == priv->nelements)
 238                         return (-1);
 239         }
 240         return (0);
 241 }
 242
 243 static int
 244 check_data(const dst_private_t *priv, const unsigned int alg,
 245            isc_boolean_t old)
 246 {
 247         /* XXXVIX this switch statement is too sparse to gen a jump table. */
 248         switch (alg) {
 249         case DST_ALG_RSAMD5:
 250         case DST_ALG_RSASHA1:
 251                 return (check_rsa(priv));
 252         case DST_ALG_DH:
 253                 return (check_dh(priv));
 254         case DST_ALG_DSA:
 255                 return (check_dsa(priv));
 256         case DST_ALG_HMACMD5:
 257                 return (check_hmac_md5(priv, old));
 258         case DST_ALG_HMACSHA1:
 259                 return (check_hmac_sha(priv, HMACSHA1_NTAGS, alg));
 260         case DST_ALG_HMACSHA224:
 261                 return (check_hmac_sha(priv, HMACSHA224_NTAGS, alg));
 262         case DST_ALG_HMACSHA256:
 263                 return (check_hmac_sha(priv, HMACSHA256_NTAGS, alg));
 264         case DST_ALG_HMACSHA384:
 265                 return (check_hmac_sha(priv, HMACSHA384_NTAGS, alg));
 266         case DST_ALG_HMACSHA512:
 267                 return (check_hmac_sha(priv, HMACSHA512_NTAGS, alg));
 268         default:
 269                 return (DST_R_UNSUPPORTEDALG);
 270         }
 271 }
 272
 273 void
 274 dst__privstruct_free(dst_private_t *priv, isc_mem_t *mctx) {
 275         int i;
 276
 277         if (priv == NULL)
 278                 return;
 279         for (i = 0; i < priv->nelements; i++) {
 280                 if (priv->elements[i].data == NULL)
 281                         continue;
 282                 memset(priv->elements[i].data, 0, MAXFIELDSIZE);
 283                 isc_mem_put(mctx, priv->elements[i].data, MAXFIELDSIZE);
 284         }
 285         priv->nelements = 0;
 286 }
 287
 288 int
 289 dst__privstruct_parse(dst_key_t *key, unsigned int alg, isc_lex_t *lex,
 290                       isc_mem_t *mctx, dst_private_t *priv)
 291 {
 292         int n = 0, major, minor;
 293         isc_buffer_t b;
 294         isc_token_t token;
 295         unsigned char *data = NULL;
 296         unsigned int opt = ISC_LEXOPT_EOL;
 297         isc_result_t ret;
 298
 299         REQUIRE(priv != NULL);
 300
 301         priv->nelements = 0;
 302         memset(priv->elements, 0, sizeof(priv->elements));
 303
 304 #define NEXTTOKEN(lex, opt, token)                              \
 305         do {                                                    \
 306                 ret = isc_lex_gettoken(lex, opt, token);        \
 307                 if (ret != ISC_R_SUCCESS)                       \
 308                         goto fail;                              \
 309         } while (0)
 310
 311 #define READLINE(lex, opt, token)                               \
 312         do {                                                    \
 313                 ret = isc_lex_gettoken(lex, opt, token);        \
 314                 if (ret == ISC_R_EOF)                           \
 315                         break;                                  \
 316                 else if (ret != ISC_R_SUCCESS)                  \
 317                         goto fail;                              \
 318         } while ((*token).type != isc_tokentype_eol)
 319
 320         /*
 321          * Read the description line.
 322          */
 323         NEXTTOKEN(lex, opt, &token);
 324         if (token.type != isc_tokentype_string ||
 325             strcmp(DST_AS_STR(token), PRIVATE_KEY_STR) != 0)
 326         {
 327                 ret = DST_R_INVALIDPRIVATEKEY;
 328                 goto fail;
 329         }
 330
 331         NEXTTOKEN(lex, opt, &token);
 332         if (token.type != isc_tokentype_string ||
 333             (DST_AS_STR(token))[0] != 'v')
 334         {
 335                 ret = DST_R_INVALIDPRIVATEKEY;
 336                 goto fail;
 337         }
 338         if (sscanf(DST_AS_STR(token), "v%d.%d", &major, &minor) != 2)
 339         {
 340                 ret = DST_R_INVALIDPRIVATEKEY;
 341                 goto fail;
 342         }
 343
 344         if (major > MAJOR_VERSION ||
 345             (major == MAJOR_VERSION && minor > MINOR_VERSION))
 346         {
 347                 ret = DST_R_INVALIDPRIVATEKEY;
 348                 goto fail;
 349         }
 350
 351         READLINE(lex, opt, &token);
 352
 353         /*
 354          * Read the algorithm line.
 355          */
 356         NEXTTOKEN(lex, opt, &token);
 357         if (token.type != isc_tokentype_string ||
 358             strcmp(DST_AS_STR(token), ALGORITHM_STR) != 0)
 359         {
 360                 ret = DST_R_INVALIDPRIVATEKEY;
 361                 goto fail;
 362         }
 363
 364         NEXTTOKEN(lex, opt | ISC_LEXOPT_NUMBER, &token);
 365         if (token.type != isc_tokentype_number ||
 366             token.value.as_ulong != (unsigned long) dst_key_alg(key))
 367         {
 368                 ret = DST_R_INVALIDPRIVATEKEY;
 369                 goto fail;
 370         }
 371
 372         READLINE(lex, opt, &token);
 373
 374         /*
 375          * Read the key data.
 376          */
 377         for (n = 0; n < MAXFIELDS; n++) {
 378                 int tag;
 379                 isc_region_t r;
 380
 381                 do {
 382                         ret = isc_lex_gettoken(lex, opt, &token);
 383                         if (ret == ISC_R_EOF)
 384                                 goto done;
 385                         if (ret != ISC_R_SUCCESS)
 386                                 goto fail;
 387                 } while (token.type == isc_tokentype_eol);
 388
 389                 if (token.type != isc_tokentype_string) {
 390                         ret = DST_R_INVALIDPRIVATEKEY;
 391                         goto fail;
 392                 }
 393
 394                 tag = find_value(DST_AS_STR(token), alg);
 395                 if (tag < 0 || TAG_ALG(tag) != alg) {
 396                         ret = DST_R_INVALIDPRIVATEKEY;
 397                         goto fail;
 398                 }
 399                 priv->elements[n].tag = tag;
 400
 401                 data = (unsigned char *) isc_mem_get(mctx, MAXFIELDSIZE);
 402                 if (data == NULL)
 403                         goto fail;
 404
 405                 isc_buffer_init(&b, data, MAXFIELDSIZE);
 406                 ret = isc_base64_tobuffer(lex, &b, -1);
 407                 if (ret != ISC_R_SUCCESS)
 408                         goto fail;
 409                 isc_buffer_usedregion(&b, &r);
 410                 priv->elements[n].length = r.length;
 411                 priv->elements[n].data = r.base;
 412
 413                 READLINE(lex, opt, &token);
 414                 data = NULL;
 415         }
 416  done:
 417         priv->nelements = n;
 418
 419         if (check_data(priv, alg, ISC_TRUE) < 0)
 420                 goto fail;
 421
 422         return (ISC_R_SUCCESS);
 423
 424 fail:
 425         priv->nelements = n;
 426         dst__privstruct_free(priv, mctx);
 427         if (data != NULL)
 428                 isc_mem_put(mctx, data, MAXFIELDSIZE);
 429
 430         return (ret);
 431 }
 432
 433 int
 434 dst__privstruct_writefile(const dst_key_t *key, const dst_private_t *priv,
 435                           const char *directory)
 436 {
 437         FILE *fp;
 438         int ret, i;
 439         isc_result_t iret;
 440         char filename[ISC_DIR_NAMEMAX];
 441         char buffer[MAXFIELDSIZE * 2];
 442         isc_buffer_t b;
 443         isc_fsaccess_t access;
 444
 445         REQUIRE(priv != NULL);
 446
 447         if (check_data(priv, dst_key_alg(key), ISC_FALSE) < 0)
 448                 return (DST_R_INVALIDPRIVATEKEY);
 449
 450         isc_buffer_init(&b, filename, sizeof(filename));
 451         ret = dst_key_buildfilename(key, DST_TYPE_PRIVATE, directory, &b);
 452         if (ret != ISC_R_SUCCESS)
 453                 return (ret);
 454
 455         if ((fp = fopen(filename, "w")) == NULL)
 456                 return (DST_R_WRITEERROR);
 457
 458         access = 0;
 459         isc_fsaccess_add(ISC_FSACCESS_OWNER,
 460                          ISC_FSACCESS_READ | ISC_FSACCESS_WRITE,
 461                          &access);
 462         (void)isc_fsaccess_set(filename, access);
 463
 464         /* XXXDCL return value should be checked for full filesystem */
 465         fprintf(fp, "%s v%d.%d\n", PRIVATE_KEY_STR, MAJOR_VERSION,
 466                 MINOR_VERSION);
 467
 468         fprintf(fp, "%s %d ", ALGORITHM_STR, dst_key_alg(key));
 469         /* XXXVIX this switch statement is too sparse to gen a jump table. */
 470         switch (dst_key_alg(key)) {
 471         case DST_ALG_RSAMD5:
 472                 fprintf(fp, "(RSA)\n");
 473                 break;
 474         case DST_ALG_DH:
 475                 fprintf(fp, "(DH)\n");
 476                 break;
 477         case DST_ALG_DSA:
 478                 fprintf(fp, "(DSA)\n");
 479                 break;
 480         case DST_ALG_RSASHA1:
 481                 fprintf(fp, "(RSASHA1)\n");
 482                 break;
 483         case DST_ALG_NSEC3DSA:
 484                 fprintf(fp, "(NSEC3DSA)\n");
 485                 break;
 486         case DST_ALG_NSEC3RSASHA1:
 487                 fprintf(fp, "(NSEC3RSASHA1)\n");
 488                 break;
 489         case DST_ALG_RSASHA256:
 490                 fprintf(fp, "(RSASHA256)\n");
 491                 break;
 492         case DST_ALG_RSASHA512:
 493                 fprintf(fp, "(RSASHA512)\n");
 494                 break;
 495         case DST_ALG_HMACMD5:
 496                 fprintf(fp, "(HMAC_MD5)\n");
 497                 break;
 498         case DST_ALG_HMACSHA1:
 499                 fprintf(fp, "(HMAC_SHA1)\n");
 500                 break;
 501         case DST_ALG_HMACSHA224:
 502                 fprintf(fp, "(HMAC_SHA224)\n");
 503                 break;
 504         case DST_ALG_HMACSHA256:
 505                 fprintf(fp, "(HMAC_SHA256)\n");
 506                 break;
 507         case DST_ALG_HMACSHA384:
 508                 fprintf(fp, "(HMAC_SHA384)\n");
 509                 break;
 510         case DST_ALG_HMACSHA512:
 511                 fprintf(fp, "(HMAC_SHA512)\n");
 512                 break;
 513         default:
 514                 fprintf(fp, "(?)\n");
 515                 break;
 516         }
 517
 518         for (i = 0; i < priv->nelements; i++) {
 519                 isc_buffer_t b;
 520                 isc_region_t r;
 521                 const char *s;
 522
 523                 s = find_tag(priv->elements[i].tag);
 524
 525                 r.base = priv->elements[i].data;
 526                 r.length = priv->elements[i].length;
 527                 isc_buffer_init(&b, buffer, sizeof(buffer));
 528                 iret = isc_base64_totext(&r, sizeof(buffer), "", &b);
 529                 if (iret != ISC_R_SUCCESS) {
 530                         fclose(fp);
 531                         return (DST_R_INVALIDPRIVATEKEY);
 532                 }
 533                 isc_buffer_usedregion(&b, &r);
 534
 535                 fprintf(fp, "%s ", s);
 536                 isc_util_fwrite(r.base, 1, r.length, fp);
 537                 fprintf(fp, "\n");
 538         }
 539
 540         fflush(fp);
 541         iret = ferror(fp) ? DST_R_WRITEERROR : ISC_R_SUCCESS;
 542         fclose(fp);
 543         return (iret);
 544 }
 545
 546 /*! \file */