contrib/bind9/lib/dns/rcode.c

   1 /*
   2  * Copyright (C) 2004-2008  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1998-2003  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 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: rcode.c,v 1.8 2008/09/25 04:02:38 tbox Exp $ */
  19
  20 #include <config.h>
  21 #include <ctype.h>
  22
  23 #include <isc/buffer.h>
  24 #include <isc/parseint.h>
  25 #include <isc/print.h>
  26 #include <isc/region.h>
  27 #include <isc/result.h>
  28 #include <isc/stdio.h>
  29 #include <isc/stdlib.h>
  30 #include <isc/string.h>
  31 #include <isc/types.h>
  32 #include <isc/util.h>
  33
  34 #include <dns/cert.h>
  35 #include <dns/keyflags.h>
  36 #include <dns/keyvalues.h>
  37 #include <dns/rcode.h>
  38 #include <dns/rdataclass.h>
  39 #include <dns/result.h>
  40 #include <dns/secalg.h>
  41 #include <dns/secproto.h>
  42
  43 #define RETERR(x) \
  44         do { \
  45                 isc_result_t _r = (x); \
  46                 if (_r != ISC_R_SUCCESS) \
  47                         return (_r); \
  48         } while (0)
  49
  50 #define NUMBERSIZE sizeof("037777777777") /* 2^32-1 octal + NUL */
  51
  52 #define RCODENAMES \
  53         /* standard rcodes */ \
  54         { dns_rcode_noerror, "NOERROR", 0}, \
  55         { dns_rcode_formerr, "FORMERR", 0}, \
  56         { dns_rcode_servfail, "SERVFAIL", 0}, \
  57         { dns_rcode_nxdomain, "NXDOMAIN", 0}, \
  58         { dns_rcode_notimp, "NOTIMP", 0}, \
  59         { dns_rcode_refused, "REFUSED", 0}, \
  60         { dns_rcode_yxdomain, "YXDOMAIN", 0}, \
  61         { dns_rcode_yxrrset, "YXRRSET", 0}, \
  62         { dns_rcode_nxrrset, "NXRRSET", 0}, \
  63         { dns_rcode_notauth, "NOTAUTH", 0}, \
  64         { dns_rcode_notzone, "NOTZONE", 0},
  65
  66 #define ERCODENAMES \
  67         /* extended rcodes */ \
  68         { dns_rcode_badvers, "BADVERS", 0}, \
  69         { 0, NULL, 0 }
  70
  71 #define TSIGRCODENAMES \
  72         /* extended rcodes */ \
  73         { dns_tsigerror_badsig, "BADSIG", 0}, \
  74         { dns_tsigerror_badkey, "BADKEY", 0}, \
  75         { dns_tsigerror_badtime, "BADTIME", 0}, \
  76         { dns_tsigerror_badmode, "BADMODE", 0}, \
  77         { dns_tsigerror_badname, "BADNAME", 0}, \
  78         { dns_tsigerror_badalg, "BADALG", 0}, \
  79         { dns_tsigerror_badtrunc, "BADTRUNC", 0}, \
  80         { 0, NULL, 0 }
  81
  82 /* RFC2538 section 2.1 */
  83
  84 #define CERTNAMES \
  85         { 1, "PKIX", 0}, \
  86         { 2, "SPKI", 0}, \
  87         { 3, "PGP", 0}, \
  88         { 253, "URI", 0}, \
  89         { 254, "OID", 0}, \
  90         { 0, NULL, 0}
  91
  92 /* RFC2535 section 7, RFC3110 */
  93
  94 #define SECALGNAMES \
  95         { DNS_KEYALG_RSAMD5, "RSAMD5", 0 }, \
  96         { DNS_KEYALG_RSAMD5, "RSA", 0 }, \
  97         { DNS_KEYALG_DH, "DH", 0 }, \
  98         { DNS_KEYALG_DSA, "DSA", 0 }, \
  99         { DNS_KEYALG_NSEC3DSA, "NSEC3DSA", 0 }, \
 100         { DNS_KEYALG_ECC, "ECC", 0 }, \
 101         { DNS_KEYALG_RSASHA1, "RSASHA1", 0 }, \
 102         { DNS_KEYALG_NSEC3RSASHA1, "NSEC3RSASHA1", 0 }, \
 103         { DNS_KEYALG_INDIRECT, "INDIRECT", 0 }, \
 104         { DNS_KEYALG_PRIVATEDNS, "PRIVATEDNS", 0 }, \
 105         { DNS_KEYALG_PRIVATEOID, "PRIVATEOID", 0 }, \
 106         { 0, NULL, 0}
 107
 108 /* RFC2535 section 7.1 */
 109
 110 #define SECPROTONAMES \
 111         {   0,    "NONE", 0 }, \
 112         {   1,    "TLS", 0 }, \
 113         {   2,    "EMAIL", 0 }, \
 114         {   3,    "DNSSEC", 0 }, \
 115         {   4,    "IPSEC", 0 }, \
 116         { 255,    "ALL", 0 }, \
 117         { 0, NULL, 0}
 118
 119 #define HASHALGNAMES \
 120         { 1, "SHA-1", 0 }, \
 121         { 0, NULL, 0 }
 122
 123 struct tbl {
 124         unsigned int    value;
 125         const char      *name;
 126         int             flags;
 127 };
 128
 129 static struct tbl rcodes[] = { RCODENAMES ERCODENAMES };
 130 static struct tbl tsigrcodes[] = { RCODENAMES TSIGRCODENAMES };
 131 static struct tbl certs[] = { CERTNAMES };
 132 static struct tbl secalgs[] = { SECALGNAMES };
 133 static struct tbl secprotos[] = { SECPROTONAMES };
 134 static struct tbl hashalgs[] = { HASHALGNAMES };
 135
 136 static struct keyflag {
 137         const char *name;
 138         unsigned int value;
 139         unsigned int mask;
 140 } keyflags[] = {
 141         { "NOCONF", 0x4000, 0xC000 },
 142         { "NOAUTH", 0x8000, 0xC000 },
 143         { "NOKEY",  0xC000, 0xC000 },
 144         { "FLAG2",  0x2000, 0x2000 },
 145         { "EXTEND", 0x1000, 0x1000 },
 146         { "FLAG4",  0x0800, 0x0800 },
 147         { "FLAG5",  0x0400, 0x0400 },
 148         { "USER",   0x0000, 0x0300 },
 149         { "ZONE",   0x0100, 0x0300 },
 150         { "HOST",   0x0200, 0x0300 },
 151         { "NTYP3",  0x0300, 0x0300 },
 152         { "FLAG8",  0x0080, 0x0080 },
 153         { "FLAG9",  0x0040, 0x0040 },
 154         { "FLAG10", 0x0020, 0x0020 },
 155         { "FLAG11", 0x0010, 0x0010 },
 156         { "SIG0",   0x0000, 0x000F },
 157         { "SIG1",   0x0001, 0x000F },
 158         { "SIG2",   0x0002, 0x000F },
 159         { "SIG3",   0x0003, 0x000F },
 160         { "SIG4",   0x0004, 0x000F },
 161         { "SIG5",   0x0005, 0x000F },
 162         { "SIG6",   0x0006, 0x000F },
 163         { "SIG7",   0x0007, 0x000F },
 164         { "SIG8",   0x0008, 0x000F },
 165         { "SIG9",   0x0009, 0x000F },
 166         { "SIG10",  0x000A, 0x000F },
 167         { "SIG11",  0x000B, 0x000F },
 168         { "SIG12",  0x000C, 0x000F },
 169         { "SIG13",  0x000D, 0x000F },
 170         { "SIG14",  0x000E, 0x000F },
 171         { "SIG15",  0x000F, 0x000F },
 172         { "KSK",  DNS_KEYFLAG_KSK, DNS_KEYFLAG_KSK },
 173         { NULL,     0, 0 }
 174 };
 175
 176 static isc_result_t
 177 str_totext(const char *source, isc_buffer_t *target) {
 178         unsigned int l;
 179         isc_region_t region;
 180
 181         isc_buffer_availableregion(target, &region);
 182         l = strlen(source);
 183
 184         if (l > region.length)
 185                 return (ISC_R_NOSPACE);
 186
 187         memcpy(region.base, source, l);
 188         isc_buffer_add(target, l);
 189         return (ISC_R_SUCCESS);
 190 }
 191
 192 static isc_result_t
 193 maybe_numeric(unsigned int *valuep, isc_textregion_t *source,
 194               unsigned int max, isc_boolean_t hex_allowed)
 195 {
 196         isc_result_t result;
 197         isc_uint32_t n;
 198         char buffer[NUMBERSIZE];
 199
 200         if (! isdigit(source->base[0] & 0xff) ||
 201             source->length > NUMBERSIZE - 1)
 202                 return (ISC_R_BADNUMBER);
 203
 204         /*
 205          * We have a potential number.  Try to parse it with
 206          * isc_parse_uint32().  isc_parse_uint32() requires
 207          * null termination, so we must make a copy.
 208          */
 209         strncpy(buffer, source->base, NUMBERSIZE);
 210         INSIST(buffer[source->length] == '\0');
 211
 212         result = isc_parse_uint32(&n, buffer, 10);
 213         if (result == ISC_R_BADNUMBER && hex_allowed)
 214                 result = isc_parse_uint32(&n, buffer, 16);
 215         if (result != ISC_R_SUCCESS)
 216                 return (result);
 217         if (n > max)
 218                 return (ISC_R_RANGE);
 219         *valuep = n;
 220         return (ISC_R_SUCCESS);
 221 }
 222
 223 static isc_result_t
 224 dns_mnemonic_fromtext(unsigned int *valuep, isc_textregion_t *source,
 225                       struct tbl *table, unsigned int max)
 226 {
 227         isc_result_t result;
 228         int i;
 229
 230         result = maybe_numeric(valuep, source, max, ISC_FALSE);
 231         if (result != ISC_R_BADNUMBER)
 232                 return (result);
 233
 234         for (i = 0; table[i].name != NULL; i++) {
 235                 unsigned int n;
 236                 n = strlen(table[i].name);
 237                 if (n == source->length &&
 238                     strncasecmp(source->base, table[i].name, n) == 0) {
 239                         *valuep = table[i].value;
 240                         return (ISC_R_SUCCESS);
 241                 }
 242         }
 243         return (DNS_R_UNKNOWN);
 244 }
 245
 246 static isc_result_t
 247 dns_mnemonic_totext(unsigned int value, isc_buffer_t *target,
 248                     struct tbl *table)
 249 {
 250         int i = 0;
 251         char buf[sizeof("4294967296")];
 252         while (table[i].name != NULL) {
 253                 if (table[i].value == value) {
 254                         return (str_totext(table[i].name, target));
 255                 }
 256                 i++;
 257         }
 258         snprintf(buf, sizeof(buf), "%u", value);
 259         return (str_totext(buf, target));
 260 }
 261
 262 isc_result_t
 263 dns_rcode_fromtext(dns_rcode_t *rcodep, isc_textregion_t *source) {
 264         unsigned int value;
 265         RETERR(dns_mnemonic_fromtext(&value, source, rcodes, 0xffff));
 266         *rcodep = value;
 267         return (ISC_R_SUCCESS);
 268 }
 269
 270 isc_result_t
 271 dns_rcode_totext(dns_rcode_t rcode, isc_buffer_t *target) {
 272         return (dns_mnemonic_totext(rcode, target, rcodes));
 273 }
 274
 275 isc_result_t
 276 dns_tsigrcode_fromtext(dns_rcode_t *rcodep, isc_textregion_t *source) {
 277         unsigned int value;
 278         RETERR(dns_mnemonic_fromtext(&value, source, tsigrcodes, 0xffff));
 279         *rcodep = value;
 280         return (ISC_R_SUCCESS);
 281 }
 282
 283 isc_result_t
 284 dns_tsigrcode_totext(dns_rcode_t rcode, isc_buffer_t *target) {
 285         return (dns_mnemonic_totext(rcode, target, tsigrcodes));
 286 }
 287
 288 isc_result_t
 289 dns_cert_fromtext(dns_cert_t *certp, isc_textregion_t *source) {
 290         unsigned int value;
 291         RETERR(dns_mnemonic_fromtext(&value, source, certs, 0xffff));
 292         *certp = value;
 293         return (ISC_R_SUCCESS);
 294 }
 295
 296 isc_result_t
 297 dns_cert_totext(dns_cert_t cert, isc_buffer_t *target) {
 298         return (dns_mnemonic_totext(cert, target, certs));
 299 }
 300
 301 isc_result_t
 302 dns_secalg_fromtext(dns_secalg_t *secalgp, isc_textregion_t *source) {
 303         unsigned int value;
 304         RETERR(dns_mnemonic_fromtext(&value, source, secalgs, 0xff));
 305         *secalgp = value;
 306         return (ISC_R_SUCCESS);
 307 }
 308
 309 isc_result_t
 310 dns_secalg_totext(dns_secalg_t secalg, isc_buffer_t *target) {
 311         return (dns_mnemonic_totext(secalg, target, secalgs));
 312 }
 313
 314 isc_result_t
 315 dns_secproto_fromtext(dns_secproto_t *secprotop, isc_textregion_t *source) {
 316         unsigned int value;
 317         RETERR(dns_mnemonic_fromtext(&value, source, secprotos, 0xff));
 318         *secprotop = value;
 319         return (ISC_R_SUCCESS);
 320 }
 321
 322 isc_result_t
 323 dns_secproto_totext(dns_secproto_t secproto, isc_buffer_t *target) {
 324         return (dns_mnemonic_totext(secproto, target, secprotos));
 325 }
 326
 327 isc_result_t
 328 dns_hashalg_fromtext(unsigned char *hashalg, isc_textregion_t *source) {
 329         unsigned int value;
 330         RETERR(dns_mnemonic_fromtext(&value, source, hashalgs, 0xff));
 331         *hashalg = value;
 332         return (ISC_R_SUCCESS);
 333 }
 334
 335 isc_result_t
 336 dns_keyflags_fromtext(dns_keyflags_t *flagsp, isc_textregion_t *source)
 337 {
 338         isc_result_t result;
 339         char *text, *end;
 340         unsigned int value, mask;
 341
 342         result = maybe_numeric(&value, source, 0xffff, ISC_TRUE);
 343         if (result == ISC_R_SUCCESS) {
 344                 *flagsp = value;
 345                 return (ISC_R_SUCCESS);
 346         }
 347         if (result != ISC_R_BADNUMBER)
 348                 return (result);
 349
 350         text = source->base;
 351         end = source->base + source->length;
 352         value = mask = 0;
 353
 354         while (text < end) {
 355                 struct keyflag *p;
 356                 unsigned int len;
 357                 char *delim = memchr(text, '|', end - text);
 358                 if (delim != NULL)
 359                         len = delim - text;
 360                 else
 361                         len = end - text;
 362                 for (p = keyflags; p->name != NULL; p++) {
 363                         if (strncasecmp(p->name, text, len) == 0)
 364                                 break;
 365                 }
 366                 if (p->name == NULL)
 367                         return (DNS_R_UNKNOWNFLAG);
 368                 value |= p->value;
 369 #ifdef notyet
 370                 if ((mask & p->mask) != 0)
 371                         warn("overlapping key flags");
 372 #endif
 373                 mask |= p->mask;
 374                 text += len;
 375                 if (delim != NULL)
 376                         text++; /* Skip "|" */
 377         }
 378         *flagsp = value;
 379         return (ISC_R_SUCCESS);
 380 }
 381
 382 /*
 383  * This uses lots of hard coded values, but how often do we actually
 384  * add classes?
 385  */
 386 isc_result_t
 387 dns_rdataclass_fromtext(dns_rdataclass_t *classp, isc_textregion_t *source) {
 388 #define COMPARE(string, rdclass) \
 389         if (((sizeof(string) - 1) == source->length) \
 390             && (strncasecmp(source->base, string, source->length) == 0)) { \
 391                 *classp = rdclass; \
 392                 return (ISC_R_SUCCESS); \
 393         }
 394
 395         switch (tolower((unsigned char)source->base[0])) {
 396         case 'a':
 397                 COMPARE("any", dns_rdataclass_any);
 398                 break;
 399         case 'c':
 400                 /*
 401                  * RFC1035 says the mnemonic for the CHAOS class is CH,
 402                  * but historical BIND practice is to call it CHAOS.
 403                  * We will accept both forms, but only generate CH.
 404                  */
 405                 COMPARE("ch", dns_rdataclass_chaos);
 406                 COMPARE("chaos", dns_rdataclass_chaos);
 407
 408                 if (source->length > 5 &&
 409                     source->length < (5 + sizeof("65000")) &&
 410                     strncasecmp("class", source->base, 5) == 0) {
 411                         char buf[sizeof("65000")];
 412                         char *endp;
 413                         unsigned int val;
 414
 415                         strncpy(buf, source->base + 5, source->length - 5);
 416                         buf[source->length - 5] = '\0';
 417                         val = strtoul(buf, &endp, 10);
 418                         if (*endp == '\0' && val <= 0xffff) {
 419                                 *classp = (dns_rdataclass_t)val;
 420                                 return (ISC_R_SUCCESS);
 421                         }
 422                 }
 423                 break;
 424         case 'h':
 425                 COMPARE("hs", dns_rdataclass_hs);
 426                 COMPARE("hesiod", dns_rdataclass_hs);
 427                 break;
 428         case 'i':
 429                 COMPARE("in", dns_rdataclass_in);
 430                 break;
 431         case 'n':
 432                 COMPARE("none", dns_rdataclass_none);
 433                 break;
 434         case 'r':
 435                 COMPARE("reserved0", dns_rdataclass_reserved0);
 436                 break;
 437         }
 438
 439 #undef COMPARE
 440
 441         return (DNS_R_UNKNOWN);
 442 }
 443
 444 isc_result_t
 445 dns_rdataclass_totext(dns_rdataclass_t rdclass, isc_buffer_t *target) {
 446         char buf[sizeof("CLASS65535")];
 447
 448         switch (rdclass) {
 449         case dns_rdataclass_any:
 450                 return (str_totext("ANY", target));
 451         case dns_rdataclass_chaos:
 452                 return (str_totext("CH", target));
 453         case dns_rdataclass_hs:
 454                 return (str_totext("HS", target));
 455         case dns_rdataclass_in:
 456                 return (str_totext("IN", target));
 457         case dns_rdataclass_none:
 458                 return (str_totext("NONE", target));
 459         case dns_rdataclass_reserved0:
 460                 return (str_totext("RESERVED0", target));
 461         default:
 462                 snprintf(buf, sizeof(buf), "CLASS%u", rdclass);
 463                 return (str_totext(buf, target));
 464         }
 465 }
 466
 467 void
 468 dns_rdataclass_format(dns_rdataclass_t rdclass,
 469                       char *array, unsigned int size)
 470 {
 471         isc_result_t result;
 472         isc_buffer_t buf;
 473
 474         isc_buffer_init(&buf, array, size);
 475         result = dns_rdataclass_totext(rdclass, &buf);
 476         /*
 477          * Null terminate.
 478          */
 479         if (result == ISC_R_SUCCESS) {
 480                 if (isc_buffer_availablelength(&buf) >= 1)
 481                         isc_buffer_putuint8(&buf, 0);
 482                 else
 483                         result = ISC_R_NOSPACE;
 484         }
 485         if (result != ISC_R_SUCCESS) {
 486                 snprintf(array, size, "<unknown>");
 487                 array[size - 1] = '\0';
 488         }
 489 }