2 * Portions Copyright (C) 2004-2010 Internet Systems Consortium, Inc. ("ISC")
3 * Portions Copyright (C) 1999-2002 Internet Software Consortium.
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.
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.
17 * Portions Copyright (C) 1995-2000 by Network Associates, Inc.
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.
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.
33 * Principal Author: Brian Wellington
34 * $Id: dst_parse.c,v 1.27 2010-12-23 04:07:58 marka Exp $
39 #include <isc/base64.h>
41 #include <isc/fsaccess.h>
44 #include <isc/stdtime.h>
45 #include <isc/string.h>
50 #include "dst_internal.h"
51 #include "dst_parse.h"
52 #include "dst/result.h"
54 #define DST_AS_STR(t) ((t).value.as_textregion.base)
56 #define PRIVATE_KEY_STR "Private-key-format:"
57 #define ALGORITHM_STR "Algorithm:"
59 #define TIMING_NTAGS (DST_MAX_TIMES + 1)
60 static const char *timetags[TIMING_NTAGS] = {
70 #define NUMERIC_NTAGS (DST_MAX_NUMERIC + 1)
71 static const char *numerictags[NUMERIC_NTAGS] = {
83 static struct parse_map map[] = {
84 {TAG_RSA_MODULUS, "Modulus:"},
85 {TAG_RSA_PUBLICEXPONENT, "PublicExponent:"},
86 {TAG_RSA_PRIVATEEXPONENT, "PrivateExponent:"},
87 {TAG_RSA_PRIME1, "Prime1:"},
88 {TAG_RSA_PRIME2, "Prime2:"},
89 {TAG_RSA_EXPONENT1, "Exponent1:"},
90 {TAG_RSA_EXPONENT2, "Exponent2:"},
91 {TAG_RSA_COEFFICIENT, "Coefficient:"},
92 {TAG_RSA_ENGINE, "Engine:" },
93 {TAG_RSA_LABEL, "Label:" },
94 {TAG_RSA_PIN, "PIN:" },
96 {TAG_DH_PRIME, "Prime(p):"},
97 {TAG_DH_GENERATOR, "Generator(g):"},
98 {TAG_DH_PRIVATE, "Private_value(x):"},
99 {TAG_DH_PUBLIC, "Public_value(y):"},
101 {TAG_DSA_PRIME, "Prime(p):"},
102 {TAG_DSA_SUBPRIME, "Subprime(q):"},
103 {TAG_DSA_BASE, "Base(g):"},
104 {TAG_DSA_PRIVATE, "Private_value(x):"},
105 {TAG_DSA_PUBLIC, "Public_value(y):"},
107 {TAG_GOST_PRIVASN1, "GostAsn1:"},
109 {TAG_HMACMD5_KEY, "Key:"},
110 {TAG_HMACMD5_BITS, "Bits:"},
112 {TAG_HMACSHA1_KEY, "Key:"},
113 {TAG_HMACSHA1_BITS, "Bits:"},
115 {TAG_HMACSHA224_KEY, "Key:"},
116 {TAG_HMACSHA224_BITS, "Bits:"},
118 {TAG_HMACSHA256_KEY, "Key:"},
119 {TAG_HMACSHA256_BITS, "Bits:"},
121 {TAG_HMACSHA384_KEY, "Key:"},
122 {TAG_HMACSHA384_BITS, "Bits:"},
124 {TAG_HMACSHA512_KEY, "Key:"},
125 {TAG_HMACSHA512_BITS, "Bits:"},
131 find_value(const char *s, const unsigned int alg) {
134 for (i = 0; map[i].tag != NULL; i++) {
135 if (strcasecmp(s, map[i].tag) == 0 &&
136 (TAG_ALG(map[i].value) == alg))
137 return (map[i].value);
143 find_tag(const int value) {
147 if (map[i].tag == NULL)
149 else if (value == map[i].value)
155 find_metadata(const char *s, const char *tags[], int ntags) {
158 for (i = 0; i < ntags; i++) {
159 if (strcasecmp(s, tags[i]) == 0)
167 find_timedata(const char *s) {
168 return (find_metadata(s, timetags, TIMING_NTAGS));
172 find_numericdata(const char *s) {
173 return (find_metadata(s, numerictags, NUMERIC_NTAGS));
177 check_rsa(const dst_private_t *priv) {
179 isc_boolean_t have[RSA_NTAGS];
183 for (i = 0; i < RSA_NTAGS; i++)
185 for (j = 0; j < priv->nelements; j++) {
186 for (i = 0; i < RSA_NTAGS; i++)
187 if (priv->elements[j].tag == TAG(DST_ALG_RSAMD5, i))
195 mask <<= sizeof(mask) * 8 - TAG_SHIFT;
196 mask >>= sizeof(mask) * 8 - TAG_SHIFT;
198 if (have[TAG_RSA_ENGINE & mask])
199 ok = have[TAG_RSA_MODULUS & mask] &&
200 have[TAG_RSA_PUBLICEXPONENT & mask] &&
201 have[TAG_RSA_LABEL & mask];
203 ok = have[TAG_RSA_MODULUS & mask] &&
204 have[TAG_RSA_PUBLICEXPONENT & mask] &&
205 have[TAG_RSA_PRIVATEEXPONENT & mask] &&
206 have[TAG_RSA_PRIME1 & mask] &&
207 have[TAG_RSA_PRIME2 & mask] &&
208 have[TAG_RSA_EXPONENT1 & mask] &&
209 have[TAG_RSA_EXPONENT2 & mask] &&
210 have[TAG_RSA_COEFFICIENT & mask];
211 return (ok ? 0 : -1 );
215 check_dh(const dst_private_t *priv) {
217 if (priv->nelements != DH_NTAGS)
219 for (i = 0; i < DH_NTAGS; i++) {
220 for (j = 0; j < priv->nelements; j++)
221 if (priv->elements[j].tag == TAG(DST_ALG_DH, i))
223 if (j == priv->nelements)
230 check_dsa(const dst_private_t *priv) {
232 if (priv->nelements != DSA_NTAGS)
234 for (i = 0; i < DSA_NTAGS; i++) {
235 for (j = 0; j < priv->nelements; j++)
236 if (priv->elements[j].tag == TAG(DST_ALG_DSA, i))
238 if (j == priv->nelements)
245 check_gost(const dst_private_t *priv) {
246 if (priv->nelements != GOST_NTAGS)
248 if (priv->elements[0].tag != TAG(DST_ALG_ECCGOST, 0))
254 check_hmac_md5(const dst_private_t *priv, isc_boolean_t old) {
257 if (priv->nelements != HMACMD5_NTAGS) {
259 * If this is a good old format and we are accepting
260 * the old format return success.
262 if (old && priv->nelements == OLD_HMACMD5_NTAGS &&
263 priv->elements[0].tag == TAG_HMACMD5_KEY)
268 * We must be new format at this point.
270 for (i = 0; i < HMACMD5_NTAGS; i++) {
271 for (j = 0; j < priv->nelements; j++)
272 if (priv->elements[j].tag == TAG(DST_ALG_HMACMD5, i))
274 if (j == priv->nelements)
281 check_hmac_sha(const dst_private_t *priv, unsigned int ntags,
285 if (priv->nelements != ntags)
287 for (i = 0; i < ntags; i++) {
288 for (j = 0; j < priv->nelements; j++)
289 if (priv->elements[j].tag == TAG(alg, i))
291 if (j == priv->nelements)
298 check_data(const dst_private_t *priv, const unsigned int alg,
301 /* XXXVIX this switch statement is too sparse to gen a jump table. */
304 case DST_ALG_RSASHA1:
305 return (check_rsa(priv));
307 return (check_dh(priv));
309 return (check_dsa(priv));
310 case DST_ALG_ECCGOST:
311 return (check_gost(priv));
312 case DST_ALG_HMACMD5:
313 return (check_hmac_md5(priv, old));
314 case DST_ALG_HMACSHA1:
315 return (check_hmac_sha(priv, HMACSHA1_NTAGS, alg));
316 case DST_ALG_HMACSHA224:
317 return (check_hmac_sha(priv, HMACSHA224_NTAGS, alg));
318 case DST_ALG_HMACSHA256:
319 return (check_hmac_sha(priv, HMACSHA256_NTAGS, alg));
320 case DST_ALG_HMACSHA384:
321 return (check_hmac_sha(priv, HMACSHA384_NTAGS, alg));
322 case DST_ALG_HMACSHA512:
323 return (check_hmac_sha(priv, HMACSHA512_NTAGS, alg));
325 return (DST_R_UNSUPPORTEDALG);
330 dst__privstruct_free(dst_private_t *priv, isc_mem_t *mctx) {
335 for (i = 0; i < priv->nelements; i++) {
336 if (priv->elements[i].data == NULL)
338 memset(priv->elements[i].data, 0, MAXFIELDSIZE);
339 isc_mem_put(mctx, priv->elements[i].data, MAXFIELDSIZE);
345 dst__privstruct_parse(dst_key_t *key, unsigned int alg, isc_lex_t *lex,
346 isc_mem_t *mctx, dst_private_t *priv)
348 int n = 0, major, minor;
351 unsigned char *data = NULL;
352 unsigned int opt = ISC_LEXOPT_EOL;
356 REQUIRE(priv != NULL);
359 memset(priv->elements, 0, sizeof(priv->elements));
361 #define NEXTTOKEN(lex, opt, token) \
363 ret = isc_lex_gettoken(lex, opt, token); \
364 if (ret != ISC_R_SUCCESS) \
368 #define READLINE(lex, opt, token) \
370 ret = isc_lex_gettoken(lex, opt, token); \
371 if (ret == ISC_R_EOF) \
373 else if (ret != ISC_R_SUCCESS) \
375 } while ((*token).type != isc_tokentype_eol)
378 * Read the description line.
380 NEXTTOKEN(lex, opt, &token);
381 if (token.type != isc_tokentype_string ||
382 strcmp(DST_AS_STR(token), PRIVATE_KEY_STR) != 0)
384 ret = DST_R_INVALIDPRIVATEKEY;
388 NEXTTOKEN(lex, opt, &token);
389 if (token.type != isc_tokentype_string ||
390 (DST_AS_STR(token))[0] != 'v')
392 ret = DST_R_INVALIDPRIVATEKEY;
395 if (sscanf(DST_AS_STR(token), "v%d.%d", &major, &minor) != 2)
397 ret = DST_R_INVALIDPRIVATEKEY;
401 if (major > DST_MAJOR_VERSION) {
402 ret = DST_R_INVALIDPRIVATEKEY;
407 * Store the private key format version number
409 dst_key_setprivateformat(key, major, minor);
411 READLINE(lex, opt, &token);
414 * Read the algorithm line.
416 NEXTTOKEN(lex, opt, &token);
417 if (token.type != isc_tokentype_string ||
418 strcmp(DST_AS_STR(token), ALGORITHM_STR) != 0)
420 ret = DST_R_INVALIDPRIVATEKEY;
424 NEXTTOKEN(lex, opt | ISC_LEXOPT_NUMBER, &token);
425 if (token.type != isc_tokentype_number ||
426 token.value.as_ulong != (unsigned long) dst_key_alg(key))
428 ret = DST_R_INVALIDPRIVATEKEY;
432 READLINE(lex, opt, &token);
437 for (n = 0; n < MAXFIELDS; n++) {
441 ret = isc_lex_gettoken(lex, opt, &token);
442 if (ret == ISC_R_EOF)
444 if (ret != ISC_R_SUCCESS)
446 } while (token.type == isc_tokentype_eol);
448 if (token.type != isc_tokentype_string) {
449 ret = DST_R_INVALIDPRIVATEKEY;
453 /* Numeric metadata */
454 tag = find_numericdata(DST_AS_STR(token));
456 INSIST(tag < NUMERIC_NTAGS);
458 NEXTTOKEN(lex, opt | ISC_LEXOPT_NUMBER, &token);
459 if (token.type != isc_tokentype_number) {
460 ret = DST_R_INVALIDPRIVATEKEY;
464 dst_key_setnum(key, tag, token.value.as_ulong);
468 /* Timing metadata */
469 tag = find_timedata(DST_AS_STR(token));
471 INSIST(tag < TIMING_NTAGS);
473 NEXTTOKEN(lex, opt, &token);
474 if (token.type != isc_tokentype_string) {
475 ret = DST_R_INVALIDPRIVATEKEY;
479 ret = dns_time32_fromtext(DST_AS_STR(token), &when);
480 if (ret != ISC_R_SUCCESS)
483 dst_key_settime(key, tag, when);
489 tag = find_value(DST_AS_STR(token), alg);
490 if (tag < 0 && minor > DST_MINOR_VERSION)
493 ret = DST_R_INVALIDPRIVATEKEY;
497 priv->elements[n].tag = tag;
499 data = (unsigned char *) isc_mem_get(mctx, MAXFIELDSIZE);
503 isc_buffer_init(&b, data, MAXFIELDSIZE);
504 ret = isc_base64_tobuffer(lex, &b, -1);
505 if (ret != ISC_R_SUCCESS)
508 isc_buffer_usedregion(&b, &r);
509 priv->elements[n].length = r.length;
510 priv->elements[n].data = r.base;
514 READLINE(lex, opt, &token);
518 if (check_data(priv, alg, ISC_TRUE) < 0)
521 return (ISC_R_SUCCESS);
524 dst__privstruct_free(priv, mctx);
526 isc_mem_put(mctx, data, MAXFIELDSIZE);
532 dst__privstruct_writefile(const dst_key_t *key, const dst_private_t *priv,
533 const char *directory)
538 char filename[ISC_DIR_NAMEMAX];
539 char buffer[MAXFIELDSIZE * 2];
540 isc_fsaccess_t access;
547 REQUIRE(priv != NULL);
549 if (check_data(priv, dst_key_alg(key), ISC_FALSE) < 0)
550 return (DST_R_INVALIDPRIVATEKEY);
552 isc_buffer_init(&b, filename, sizeof(filename));
553 ret = dst_key_buildfilename(key, DST_TYPE_PRIVATE, directory, &b);
554 if (ret != ISC_R_SUCCESS)
557 if ((fp = fopen(filename, "w")) == NULL)
558 return (DST_R_WRITEERROR);
561 isc_fsaccess_add(ISC_FSACCESS_OWNER,
562 ISC_FSACCESS_READ | ISC_FSACCESS_WRITE,
564 (void)isc_fsaccess_set(filename, access);
566 dst_key_getprivateformat(key, &major, &minor);
567 if (major == 0 && minor == 0) {
568 major = DST_MAJOR_VERSION;
569 minor = DST_MINOR_VERSION;
572 /* XXXDCL return value should be checked for full filesystem */
573 fprintf(fp, "%s v%d.%d\n", PRIVATE_KEY_STR, major, minor);
575 fprintf(fp, "%s %d ", ALGORITHM_STR, dst_key_alg(key));
577 /* XXXVIX this switch statement is too sparse to gen a jump table. */
578 switch (dst_key_alg(key)) {
580 fprintf(fp, "(RSA)\n");
583 fprintf(fp, "(DH)\n");
586 fprintf(fp, "(DSA)\n");
588 case DST_ALG_RSASHA1:
589 fprintf(fp, "(RSASHA1)\n");
591 case DST_ALG_NSEC3RSASHA1:
592 fprintf(fp, "(NSEC3RSASHA1)\n");
594 case DST_ALG_NSEC3DSA:
595 fprintf(fp, "(NSEC3DSA)\n");
597 case DST_ALG_RSASHA256:
598 fprintf(fp, "(RSASHA256)\n");
600 case DST_ALG_RSASHA512:
601 fprintf(fp, "(RSASHA512)\n");
603 case DST_ALG_ECCGOST:
604 fprintf(fp, "(ECC-GOST)\n");
606 case DST_ALG_HMACMD5:
607 fprintf(fp, "(HMAC_MD5)\n");
609 case DST_ALG_HMACSHA1:
610 fprintf(fp, "(HMAC_SHA1)\n");
612 case DST_ALG_HMACSHA224:
613 fprintf(fp, "(HMAC_SHA224)\n");
615 case DST_ALG_HMACSHA256:
616 fprintf(fp, "(HMAC_SHA256)\n");
618 case DST_ALG_HMACSHA384:
619 fprintf(fp, "(HMAC_SHA384)\n");
621 case DST_ALG_HMACSHA512:
622 fprintf(fp, "(HMAC_SHA512)\n");
625 fprintf(fp, "(?)\n");
629 for (i = 0; i < priv->nelements; i++) {
632 s = find_tag(priv->elements[i].tag);
634 r.base = priv->elements[i].data;
635 r.length = priv->elements[i].length;
636 isc_buffer_init(&b, buffer, sizeof(buffer));
637 result = isc_base64_totext(&r, sizeof(buffer), "", &b);
638 if (result != ISC_R_SUCCESS) {
640 return (DST_R_INVALIDPRIVATEKEY);
642 isc_buffer_usedregion(&b, &r);
644 fprintf(fp, "%s ", s);
645 isc_util_fwrite(r.base, 1, r.length, fp);
649 /* Add the metadata tags */
650 if (major > 1 || (major == 1 && minor >= 3)) {
651 for (i = 0; i < NUMERIC_NTAGS; i++) {
652 result = dst_key_getnum(key, i, &value);
653 if (result != ISC_R_SUCCESS)
655 fprintf(fp, "%s %u\n", numerictags[i], value);
657 for (i = 0; i < TIMING_NTAGS; i++) {
658 result = dst_key_gettime(key, i, &when);
659 if (result != ISC_R_SUCCESS)
662 isc_buffer_init(&b, buffer, sizeof(buffer));
663 result = dns_time32_totext(when, &b);
664 if (result != ISC_R_SUCCESS)
667 isc_buffer_usedregion(&b, &r);
669 fprintf(fp, "%s ", timetags[i]);
670 isc_util_fwrite(r.base, 1, r.length, fp);
676 result = ferror(fp) ? DST_R_WRITEERROR : ISC_R_SUCCESS;