main/enum.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2006, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * Funding provided by nic.at
   9  *
  10  * See http://www.asterisk.org for more information about
  11  * the Asterisk project. Please do not directly contact
  12  * any of the maintainers of this project for assistance;
  13  * the project provides a web site, mailing lists and IRC
  14  * channels for your use.
  15  *
  16  * This program is free software, distributed under the terms of
  17  * the GNU General Public License Version 2. See the LICENSE file
  18  * at the top of the source tree.
  19  */
  20
  21 /*! \file
  22  *
  23  * \brief ENUM Support for Asterisk
  24  *
  25  * \author Mark Spencer <markster@digium.com>
  26  *
  27  * \arg Funding provided by nic.at
  28  *
  29  * \par Enum standards
  30  *
  31  * - NAPTR records: http://ietf.nri.reston.va.us/rfc/rfc2915.txt
  32  * - DNS SRV records: http://www.ietf.org/rfc/rfc2782.txt
  33  * - ENUM http://www.ietf.org/rfc/rfc3761.txt
  34  * - ENUM for H.323: http://www.ietf.org/rfc/rfc3762.txt
  35  * - ENUM SIP: http://www.ietf.org/rfc/rfc3764.txt
  36  * - IANA ENUM Services: http://www.iana.org/assignments/enum-services
  37  *
  38  * - I-ENUM:
  39  *   http://tools.ietf.org/wg/enum/draft-ietf-enum-combined/
  40  *   http://tools.ietf.org/wg/enum/draft-ietf-enum-branch-location-record/
  41  *
  42  * \par Possible improvement
  43  * \todo Implement a caching mechanism for multile enum lookups
  44  * - See https://issues.asterisk.org/view.php?id=6739
  45  * \todo The service type selection needs to be redone.
  46  */
  47
  48 /*! \li \ref enum.c uses the configuration file \ref enum.conf
  49  * \addtogroup configuration_file Configuration Files
  50  */
  51
  52 /*!
  53  * \page enum.conf enum.conf
  54  * \verbinclude enum.conf.sample
  55  */
  56
  57 /*** MODULEINFO
  58         <support_level>core</support_level>
  59  ***/
  60
  61 #include "asterisk.h"
  62
  63 #include <sys/socket.h>
  64 #include <netinet/in.h>
  65 #include <arpa/nameser.h>
  66 #ifdef __APPLE__
  67 #include <arpa/nameser_compat.h>
  68 #endif
  69 #include <resolv.h>
  70 #include <ctype.h>
  71 #include <regex.h>
  72
  73 #include "asterisk/enum.h"
  74 #include "asterisk/dns.h"
  75 #include "asterisk/channel.h"
  76 #include "asterisk/config.h"
  77 #include "asterisk/utils.h"
  78 #include "asterisk/manager.h"
  79
  80 #ifdef __APPLE__
  81 #undef T_NAPTR
  82 #define T_NAPTR 35
  83 #endif
  84
  85 #ifdef __APPLE__
  86 #undef T_TXT
  87 #define T_TXT 16
  88 #endif
  89
  90 static char ienum_branchlabel[32] = "i";
  91 /* how to do infrastructure enum branch location resolution? */
  92 #define ENUMLOOKUP_BLR_CC       0
  93 #define ENUMLOOKUP_BLR_TXT      1
  94 #define ENUMLOOKUP_BLR_EBL      2
  95 static int ebl_alg = ENUMLOOKUP_BLR_CC;
  96
  97 /* EBL record provisional type code */
  98 #define T_EBL      65300
  99
 100 AST_MUTEX_DEFINE_STATIC(enumlock);
 101
 102 /*! \brief Determine the length of a country code when given an E.164 string */
 103 /*
 104  * Input: E.164 number w/o leading +
 105  *
 106  * Output: number of digits in the country code
 107  *         0 on invalid number
 108  *
 109  * Algorithm:
 110  *   3 digits is the default length of a country code.
 111  *   country codes 1 and 7 are a single digit.
 112  *   the following country codes are two digits: 20, 27, 30-34, 36, 39,
 113  *     40, 41, 43-49, 51-58, 60-66, 81, 82, 84, 86, 90-95, 98.
 114  */
 115 static int cclen(const char *number)
 116 {
 117         int cc;
 118         char digits[3] = "";
 119
 120         if (!number || (strlen(number) < 3)) {
 121                 return 0;
 122         }
 123
 124         strncpy(digits, number, 2);
 125
 126         if (!sscanf(digits, "%30d", &cc)) {
 127                 return 0;
 128         }
 129
 130         if (cc / 10 == 1 || cc / 10 == 7)
 131                 return 1;
 132
 133         if (cc == 20 || cc == 27 || (cc >= 30 && cc <= 34) || cc == 36 ||
 134             cc == 39 || cc == 40 || cc == 41 || (cc >= 40 && cc <= 41) ||
 135             (cc >= 43 && cc <= 49) || (cc >= 51 && cc <= 58) ||
 136             (cc >= 60 && cc <= 66) || cc == 81 || cc == 82 || cc == 84 ||
 137             cc == 86 || (cc >= 90 && cc <= 95) || cc == 98) {
 138                 return 2;
 139         }
 140
 141         return 3;
 142 }
 143
 144 struct txt_context {
 145         char txt[1024];         /* TXT record in TXT lookup */
 146         int txtlen;             /* Length */
 147 };
 148
 149 /*! \brief Callback for TXT record lookup, /ol version */
 150 static int txt_callback(void *context, unsigned char *answer, int len, unsigned char *fullanswer)
 151 {
 152         struct txt_context *c = context;
 153         unsigned int i;
 154
 155         c->txt[0] = 0;  /* default to empty */
 156         c->txtlen = 0;
 157
 158         if (answer == NULL) {
 159                 return 0;
 160         }
 161
 162         /* RFC1035:
 163          *
 164          * <character-string> is a single length octet followed by that number of characters.
 165          * TXT-DATA        One or more <character-string>s.
 166          *
 167          * We only take the first string here.
 168          */
 169
 170         i = *answer++;
 171         len -= 1;
 172
 173         if (i > len) {  /* illegal packet */
 174                 ast_log(LOG_WARNING, "txt_callback: malformed TXT record.\n");
 175                 return 0;
 176         }
 177
 178         if (i >= sizeof(c->txt)) {      /* too long? */
 179                 ast_log(LOG_WARNING, "txt_callback: TXT record too long.\n");
 180                 i = sizeof(c->txt) - 1;
 181         }
 182
 183         ast_copy_string(c->txt, (char *)answer, i + 1);  /* this handles the \0 termination */
 184         c->txtlen = i;
 185
 186         return 1;
 187 }
 188
 189 /*! \brief Determine the branch location record as stored in a TXT record */
 190 /*
 191  * Input: CC code
 192  *
 193  * Output: number of digits in the number before the i-enum branch
 194  *
 195  * Algorithm:  Build <ienum_branchlabel>.c.c.<suffix> and look for a TXT lookup.
 196  *              Return atoi(TXT-record).
 197  *              Return -1 on not found.
 198  *
 199  */
 200 static int blr_txt(const char *cc, const char *suffix)
 201 {
 202         struct txt_context context;
 203         char domain[128] = "";
 204         char *p1, *p2;
 205         int ret;
 206
 207         ast_mutex_lock(&enumlock);
 208
 209         ast_verb(4, "blr_txt()  cc='%s', suffix='%s', c_bl='%s'\n", cc, suffix, ienum_branchlabel);
 210
 211         if (sizeof(domain) < (strlen(cc) * 2 + strlen(ienum_branchlabel) + strlen(suffix) + 2)) {
 212                 ast_mutex_unlock(&enumlock);
 213                 ast_log(LOG_WARNING, "ERROR: string sizing in blr_txt.\n");
 214                 return -1;
 215         }
 216
 217         p1 = domain + snprintf(domain, sizeof(domain), "%s.", ienum_branchlabel);
 218         ast_mutex_unlock(&enumlock);
 219
 220         for (p2 = (char *) cc + strlen(cc) - 1; p2 >= cc; p2--) {
 221                 if (isdigit(*p2)) {
 222                         *p1++ = *p2;
 223                         *p1++ = '.';
 224                 }
 225         }
 226         strcat(p1, suffix);
 227
 228         ast_verb(4, "blr_txt() FQDN for TXT record: %s, cc was %s\n", domain, cc);
 229
 230         ret = ast_search_dns(&context, domain, C_IN, T_TXT, txt_callback);
 231
 232         if (ret > 0) {
 233                 ret = atoi(context.txt);
 234
 235                 if ((ret >= 0) && (ret < 20)) {
 236                         ast_verb(3, "blr_txt() BLR TXT record for %s is %d (apex: %s)\n", cc, ret, suffix);
 237                         return ret;
 238                 }
 239         }
 240
 241         ast_verb(3, "blr_txt() BLR TXT record for %s not found (apex: %s)\n", cc, suffix);
 242
 243         return -1;
 244 }
 245
 246 struct ebl_context {
 247         unsigned char pos;
 248         char separator[256];            /* label to insert */
 249         int sep_len;                    /* Length */
 250         char apex[256];                 /* new Apex */
 251         int apex_len;                   /* Length */
 252 };
 253
 254 /*! \brief Callback for EBL record lookup */
 255 static int ebl_callback(void *context, unsigned char *answer, int len, unsigned char *fullanswer)
 256 {
 257         struct ebl_context *c = context;
 258         int i;
 259
 260         c->pos = 0;     /* default to empty */
 261         c->separator[0] = 0;
 262         c->sep_len = 0;
 263         c->apex[0] = 0;
 264         c->apex_len = 0;
 265
 266         if (answer == NULL) {
 267                 return 0;
 268         }
 269
 270         /* draft-lendl-enum-branch-location-record-00
 271          *
 272          *      0  1  2  3  4  5  6  7
 273          *    +--+--+--+--+--+--+--+--+
 274          *    |       POSITION        |
 275          *    +--+--+--+--+--+--+--+--+
 276          *    /       SEPARATOR       /
 277          *    +--+--+--+--+--+--+--+--+
 278          *    /         APEX          /
 279          *    +--+--+--+--+--+--+--+--+
 280          *
 281          *  where POSITION is a single byte, SEPARATOR is a <character-string>
 282          *  and APEX is a <domain-name>.
 283          *
 284          */
 285
 286         c->pos = *answer++;
 287         len -= 1;
 288
 289         if ((c->pos > 15) || len < 2) { /* illegal packet */
 290                 ast_log(LOG_WARNING, "ebl_callback: malformed EBL record.\n");
 291                 return 0;
 292         }
 293
 294         i = *answer++;
 295         len -= 1;
 296         if (i > len) {  /* illegal packet */
 297                 ast_log(LOG_WARNING, "ebl_callback: malformed EBL record.\n");
 298                 return 0;
 299         }
 300
 301         ast_copy_string(c->separator, (char *)answer, i + 1);
 302         c->sep_len = i;
 303
 304         answer += i;
 305         len -= i;
 306
 307         if ((i = dn_expand((unsigned char *)fullanswer, (unsigned char *)answer + len,
 308                                 (unsigned char *)answer, c->apex, sizeof(c->apex) - 1)) < 0) {
 309                 ast_log(LOG_WARNING, "Failed to expand hostname\n");
 310                 return 0;
 311         }
 312         c->apex[i] = 0;
 313         c->apex_len = i;
 314
 315         return 1;
 316 }
 317
 318 /*! \brief Evaluate the I-ENUM branch as stored in an EBL record */
 319 /*
 320  * Input: CC code
 321  *
 322  * Output: number of digits in the number before the i-enum branch
 323  *
 324  * Algorithm:  Build <ienum_branchlabel>.c.c.<suffix> and look for an EBL record
 325  *              Return pos and fill in separator and apex.
 326  *              Return -1 on not found.
 327  *
 328  */
 329 static int blr_ebl(const char *cc, const char *suffix, char *separator, int sep_len, char* apex, int apex_len)
 330 {
 331         struct ebl_context context;
 332         char domain[128] = "";
 333         char *p1,*p2;
 334         int ret;
 335
 336         ast_mutex_lock(&enumlock);
 337
 338         ast_verb(4, "blr_ebl()  cc='%s', suffix='%s', c_bl='%s'\n", cc, suffix, ienum_branchlabel);
 339
 340         if (sizeof(domain) < (strlen(cc) * 2 + strlen(ienum_branchlabel) + strlen(suffix) + 2)) {
 341                 ast_mutex_unlock(&enumlock);
 342                 ast_log(LOG_WARNING, "ERROR: string sizing in blr_EBL.\n");
 343                 return -1;
 344         }
 345
 346         p1 = domain + snprintf(domain, sizeof(domain), "%s.", ienum_branchlabel);
 347         ast_mutex_unlock(&enumlock);
 348
 349         for (p2 = (char *) cc + strlen(cc) - 1; p2 >= cc; p2--) {
 350                 if (isdigit(*p2)) {
 351                         *p1++ = *p2;
 352                         *p1++ = '.';
 353                 }
 354         }
 355         strcat(p1, suffix);
 356
 357         ast_verb(4, "blr_ebl() FQDN for EBL record: %s, cc was %s\n", domain, cc);
 358
 359         ret = ast_search_dns(&context, domain, C_IN, T_EBL, ebl_callback);
 360         if (ret > 0) {
 361                 ret = context.pos;
 362
 363                 if ((ret >= 0) && (ret < 20)) {
 364                         ast_verb(3, "blr_txt() BLR EBL record for %s is %d/%s/%s)\n", cc, ret, context.separator, context.apex);
 365                         ast_copy_string(separator, context.separator, sep_len);
 366                         ast_copy_string(apex, context.apex, apex_len);
 367                         return ret;
 368                 }
 369         }
 370         ast_verb(3, "blr_txt() BLR EBL record for %s not found (apex: %s)\n", cc, suffix);
 371         return -1;
 372 }
 373
 374 /*! \brief Parse NAPTR record information elements */
 375 static unsigned int parse_ie(char *data, unsigned int maxdatalen, unsigned char *src, unsigned int srclen)
 376 {
 377         unsigned int len, olen;
 378
 379         len = olen = (unsigned int) src[0];
 380         src++;
 381         srclen--;
 382
 383         if (len > srclen) {
 384                 ast_log(LOG_WARNING, "ENUM parsing failed: Wanted %u characters, got %u\n", len, srclen);
 385                 return -1;
 386         }
 387
 388         if (len > maxdatalen)
 389                 len = maxdatalen;
 390         memcpy(data, src, len);
 391
 392         return olen + 1;
 393 }
 394
 395 /*! \brief Parse DNS NAPTR record used in ENUM ---*/
 396 static int parse_naptr(unsigned char *dst, int dstsize, char *tech, int techsize, unsigned char *answer, int len, unsigned char *naptrinput)
 397 {
 398         char tech_return[80];
 399         char *oanswer = (char *)answer;
 400         char flags[512] = "";
 401         char services[512] = "";
 402         char *p;
 403         char regexp[512] = "";
 404         char repl[512] = "";
 405         char tempdst[512] = "";
 406         char errbuff[512] = "";
 407         char delim;
 408         char *delim2;
 409         char *pattern, *subst, *d;
 410         int res;
 411         int regexp_len, rc;
 412         static const int max_bt = 10; /* max num of regexp backreference allowed, must remain 10 to guarantee a valid backreference index */
 413         int size, matchindex; /* size is the size of the backreference sub. */
 414         size_t d_len = sizeof(tempdst) - 1;
 415         regex_t preg;
 416         regmatch_t pmatch[max_bt];
 417
 418         tech_return[0] = '\0';
 419         dst[0] = '\0';
 420
 421         if (len < sizeof(struct naptr)) {
 422                 ast_log(LOG_WARNING, "NAPTR record length too short\n");
 423                 return -1;
 424         }
 425         answer += sizeof(struct naptr);
 426         len -= sizeof(struct naptr);
 427         if ((res = parse_ie(flags, sizeof(flags) - 1, answer, len)) < 0) {
 428                 ast_log(LOG_WARNING, "Failed to get flags from NAPTR record\n");
 429                 return -1;
 430         } else {
 431                 answer += res;
 432                 len -= res;
 433         }
 434
 435         if ((res = parse_ie(services, sizeof(services) - 1, answer, len)) < 0) {
 436                 ast_log(LOG_WARNING, "Failed to get services from NAPTR record\n");
 437                 return -1;
 438         } else {
 439                 answer += res;
 440                 len -= res;
 441         }
 442         if ((res = parse_ie(regexp, sizeof(regexp) - 1, answer, len)) < 0) {
 443                 ast_log(LOG_WARNING, "Failed to get regexp from NAPTR record\n");
 444                 return -1;
 445         } else {
 446                 answer += res;
 447                 len -= res;
 448         }
 449
 450         if ((res = dn_expand((unsigned char *)oanswer, (unsigned char *)answer + len, (unsigned char *)answer, repl, sizeof(repl) - 1)) < 0) {
 451                 ast_log(LOG_WARNING, "Failed to expand hostname\n");
 452                 return -1;
 453         }
 454
 455         ast_debug(3, "NAPTR input='%s', flags='%s', services='%s', regexp='%s', repl='%s'\n",
 456                 naptrinput, flags, services, regexp, repl);
 457
 458
 459         if (tolower(flags[0]) != 'u') {
 460                 ast_log(LOG_WARNING, "NAPTR Flag must be 'U' or 'u'.\n");
 461                 return -1;
 462         }
 463
 464         p = strstr(services, "e2u+");
 465         if (p == NULL)
 466                 p = strstr(services, "E2U+");
 467         if (p){
 468                 p = p + 4;
 469                 if (strchr(p, ':')){
 470                         p = strchr(p, ':') + 1;
 471                 }
 472                 ast_copy_string(tech_return, p, sizeof(tech_return));
 473         } else {
 474
 475                 p = strstr(services, "+e2u");
 476                 if (p == NULL)
 477                         p = strstr(services, "+E2U");
 478                 if (p) {
 479                         *p = 0;
 480                         p = strchr(services, ':');
 481                         if (p)
 482                                 *p = 0;
 483                         ast_copy_string(tech_return, services, sizeof(tech_return));
 484                 }
 485         }
 486
 487         regexp_len = strlen(regexp);
 488         if (regexp_len < 7) {
 489                 ast_log(LOG_WARNING, "Regex too short to be meaningful.\n");
 490                 return -1;
 491         }
 492
 493         /* this takes the first character of the regexp (which is a delimiter)
 494          * and uses that character to find the index of the second delimiter */
 495         delim = regexp[0];
 496         delim2 = strchr(regexp + 1, delim);
 497         if ((delim2 == NULL) || (regexp[regexp_len - 1] != delim)) {  /* is the second delimiter found, and is the end of the regexp a delimiter */
 498                 ast_log(LOG_WARNING, "Regex delimiter error (on \"%s\").\n", regexp);
 499                 return -1;
 500         } else if (strchr((delim2 + 1), delim) == NULL) { /* if the second delimiter is found, make sure there is a third instance.  this could be the end one instead of the middle */
 501                 ast_log(LOG_WARNING, "Regex delimiter error (on \"%s\").\n", regexp);
 502                 return -1;
 503         }
 504         pattern = regexp + 1;   /* pattern is the regex without the begining and ending delimiter */
 505         *delim2 = 0;    /* zero out the middle delimiter */
 506         subst   = delim2 + 1; /* dst substring is everything after the second delimiter. */
 507         regexp[regexp_len - 1] = 0; /* zero out the last delimiter */
 508
 509 /*
 510  * now do the regex wizardry.
 511  */
 512
 513         if (regcomp(&preg, pattern, REG_EXTENDED | REG_NEWLINE)) {
 514                 ast_log(LOG_WARNING, "NAPTR Regex compilation error (regex = \"%s\").\n", regexp);
 515                 return -1;
 516         }
 517
 518         if (preg.re_nsub > ARRAY_LEN(pmatch)) {
 519                 ast_log(LOG_WARNING, "NAPTR Regex compilation error: too many subs.\n");
 520                 regfree(&preg);
 521                 return -1;
 522         }
 523         /* pmatch is an array containing the substring indexes for the regex backreference sub.
 524          * max_bt is the maximum number of backreferences allowed to be stored in pmatch */
 525         if ((rc = regexec(&preg, (char *) naptrinput, max_bt, pmatch, 0))) {
 526                 regerror(rc, &preg, errbuff, sizeof(errbuff));
 527                 ast_log(LOG_WARNING, "NAPTR Regex match failed. Reason: %s\n", errbuff);
 528                 regfree(&preg);
 529                 return -1;
 530         }
 531         regfree(&preg);
 532
 533         d = tempdst;
 534         d_len--;
 535
 536         /* perform the backreference sub. Search the subst for backreferences,
 537          * when a backreference is found, retrieve the backreferences number.
 538          * use the backreference number as an index for pmatch to retrieve the
 539          * beginning and ending indexes of the substring to insert as the backreference.
 540          * if no backreference is found, continue copying the subst into tempdst */
 541         while (*subst && (d_len > 0)) {
 542                 if ((subst[0] == '\\') && isdigit(subst[1])) { /* is this character the beginning of a backreference */
 543                         matchindex = (int) (subst[1] - '0');
 544                         if (matchindex >= ARRAY_LEN(pmatch)) {
 545                                 ast_log(LOG_WARNING, "Error during regex substitution. Invalid pmatch index.\n");
 546                                 return -1;
 547                         }
 548                         /* pmatch len is 10. we are garanteed a single char 0-9 is a valid index */
 549                         size = pmatch[matchindex].rm_eo - pmatch[matchindex].rm_so;
 550                         if (size > d_len) {
 551                                 ast_log(LOG_WARNING, "Not enough space during NAPTR regex substitution.\n");
 552                                 return -1;
 553                         }
 554                         /* are the pmatch indexes valid for the input length */
 555                         if ((strlen((char *) naptrinput) >= pmatch[matchindex].rm_eo) && (pmatch[matchindex].rm_so <= pmatch[matchindex].rm_eo)) {
 556                                 memcpy(d, (naptrinput + (int) pmatch[matchindex].rm_so), size);  /* copy input substring into backreference marker */
 557                                 d_len -= size;
 558                                 subst += 2;  /* skip over backreference characters to next valid character */
 559                                 d += size;
 560                         } else {
 561                                 ast_log(LOG_WARNING, "Error during regex substitution. Invalid backreference index.\n");
 562                                 return -1;
 563                         }
 564                 } else if (isprint(*subst)) {
 565                         *d++ = *subst++;
 566                         d_len--;
 567                 } else {
 568                         ast_log(LOG_WARNING, "Error during regex substitution.\n");
 569                         return -1;
 570                 }
 571         }
 572         *d = 0;
 573         ast_copy_string((char *) dst, tempdst, dstsize);
 574         dst[dstsize - 1] = '\0';
 575
 576         if (*tech != '\0'){ /* check if it is requested NAPTR */
 577                 if (!strncasecmp(tech, "ALL", techsize)){
 578                         return 0; /* return or count any RR */
 579                 }
 580                 if (!strncasecmp(tech_return, tech, sizeof(tech_return) < techsize ? sizeof(tech_return): techsize)){
 581                         ast_copy_string(tech, tech_return, techsize);
 582                         return 0; /* we got our RR */
 583                 } else { /* go to the next RR in the DNS answer */
 584                         return 1;
 585                 }
 586         }
 587
 588         /* tech was not specified, return first parsed RR */
 589         ast_copy_string(tech, tech_return, techsize);
 590
 591         return 0;
 592 }
 593
 594 /* do not return requested value, just count RRs and return thei number in dst */
 595 #define ENUMLOOKUP_OPTIONS_COUNT       1
 596 /* do an ISN style lookup */
 597 #define ENUMLOOKUP_OPTIONS_ISN          2
 598 /* do a infrastructure ENUM lookup */
 599 #define ENUMLOOKUP_OPTIONS_IENUM        4
 600 /* do a direct DNS lookup: no reversal */
 601 #define ENUMLOOKUP_OPTIONS_DIRECT       8
 602
 603 /*! \brief Callback from ENUM lookup function */
 604 static int enum_callback(void *context, unsigned char *answer, int len, unsigned char *fullanswer)
 605 {
 606         struct enum_context *c = context;
 607         void *p = NULL;
 608         int res;
 609
 610         res = parse_naptr((unsigned char *)c->dst, c->dstlen, c->tech, c->techlen, answer, len, (unsigned char *)c->naptrinput);
 611
 612         if (res < 0) {
 613                 ast_log(LOG_WARNING, "Failed to parse naptr\n");
 614                 return -1;
 615         } else if ((res == 0) && !ast_strlen_zero(c->dst)) { /* ok, we got needed NAPTR */
 616                 if (c->options & ENUMLOOKUP_OPTIONS_COUNT) { /* counting RRs */
 617                         c->count++;
 618                         snprintf(c->dst, c->dstlen, "%d", c->count);
 619                 } else  {
 620                         if ((p = ast_realloc(c->naptr_rrs, sizeof(*c->naptr_rrs) * (c->naptr_rrs_count + 1)))) {
 621                                 c->naptr_rrs = p;
 622                                 memcpy(&c->naptr_rrs[c->naptr_rrs_count].naptr, answer, sizeof(c->naptr_rrs->naptr));
 623                                 c->naptr_rrs[c->naptr_rrs_count].result = ast_strdup(c->dst);
 624                                 c->naptr_rrs[c->naptr_rrs_count].tech = ast_strdup(c->tech);
 625                                 c->naptr_rrs[c->naptr_rrs_count].sort_pos = c->naptr_rrs_count;
 626                                 c->naptr_rrs_count++;
 627                         }
 628                         c->dst[0] = 0;
 629                 }
 630                 return 0;
 631         }
 632
 633         return 0;
 634 }
 635
 636 /* ENUM lookup */
 637 int ast_get_enum(struct ast_channel *chan, const char *number, char *dst, int dstlen, char *tech, int techlen, char* suffix, char* options, unsigned int record, struct enum_context **argcontext)
 638 {
 639         struct enum_context *context;
 640         char tmp[512];
 641         char domain[256];
 642         char left[128];
 643         char middle[128];
 644         char naptrinput[128];
 645         char apex[128] = "";
 646         int ret = -1;
 647         /* for ISN rewrite */
 648         char *p1 = NULL;
 649         char *p2 = NULL;
 650         char *p3 = NULL;
 651         int k = 0;
 652         int i = 0;
 653         int z = 0;
 654         int spaceleft = 0;
 655         struct timeval time_start, time_end;
 656
 657         if (ast_strlen_zero(suffix)) {
 658                 ast_log(LOG_WARNING, "ast_get_enum need a suffix parameter now.\n");
 659                 return -1;
 660         }
 661
 662         ast_debug(2, "num='%s', tech='%s', suffix='%s', options='%s', record=%u\n", number, tech, suffix, options, record);
 663
 664 /*
 665   We don't need that any more, that "n" preceding the number has been replaced by a flag
 666   in the options paramter.
 667         ast_copy_string(naptrinput, number, sizeof(naptrinput));
 668 */
 669 /*
 670  * The "number" parameter includes a leading '+' if it's a full E.164 number (and not ISN)
 671  * We need to preserve that as the regex inside NAPTRs expect the +.
 672  *
 673  * But for the domain generation, the '+' is a nuissance, so we get rid of it.
 674 */
 675         ast_copy_string(naptrinput, number[0] == 'n' ? number + 1 : number, sizeof(naptrinput));
 676         if (number[0] == '+') {
 677                 number++;
 678         }
 679
 680         if (!(context = ast_calloc(1, sizeof(*context)))) {
 681                 return -1;
 682         }
 683
 684         if ((p3 = strchr(naptrinput, '*'))) {
 685                 *p3='\0';
 686         }
 687
 688         context->naptrinput = naptrinput;       /* The number */
 689         context->dst = dst;                     /* Return string */
 690         context->dstlen = dstlen;
 691         context->tech = tech;
 692         context->techlen = techlen;
 693         context->options = 0;
 694         context->position = record > 0 ? record : 1;
 695         context->count = 0;
 696         context->naptr_rrs = NULL;
 697         context->naptr_rrs_count = 0;
 698
 699         /*
 700          * Process options:
 701          *
 702          *      c       Return count, not URI
 703          *      i       Use infrastructure ENUM
 704          *      s       Do ISN transformation
 705          *      d       Direct DNS query: no reversing.
 706          *
 707          */
 708         if (options != NULL) {
 709                 if (strchr(options,'s')) {
 710                         context->options |= ENUMLOOKUP_OPTIONS_ISN;
 711                 } else if (strchr(options,'i')) {
 712                         context->options |= ENUMLOOKUP_OPTIONS_IENUM;
 713                 } else if (strchr(options,'d')) {
 714                         context->options |= ENUMLOOKUP_OPTIONS_DIRECT;
 715                 }
 716                 if (strchr(options,'c')) {
 717                         context->options |= ENUMLOOKUP_OPTIONS_COUNT;
 718                 }
 719                 if (strchr(number,'*')) {
 720                         context->options |= ENUMLOOKUP_OPTIONS_ISN;
 721                 }
 722         }
 723         ast_debug(2, "ENUM options(%s): pos=%d, options='%d'\n", options, context->position, context->options);
 724         ast_debug(1, "n='%s', tech='%s', suffix='%s', options='%d', record='%d'\n",
 725                         number, tech, suffix, context->options, context->position);
 726
 727         /*
 728          * This code does more than simple RFC3261 ENUM. All these rewriting
 729          * schemes have in common that they build the FQDN for the NAPTR lookup
 730          * by concatenating
 731          *    - a number which needs be flipped and "."-seperated       (left)
 732          *    - some fixed string                                       (middle)
 733          *    - an Apex.                                                (apex)
 734          *
 735          * The RFC3261 ENUM is: left=full number, middle="", apex=from args.
 736          * ISN:  number = "middle*left", apex=from args
 737          * I-ENUM: EBL parameters build the split, can change apex
 738          * Direct: left="", middle=argument, apex=from args
 739          *
 740          */
 741
 742         /* default: the whole number will be flipped, no middle domain component */
 743         ast_copy_string(left, number, sizeof(left));
 744         middle[0] = '\0';
 745         /*
 746          * I-ENUM can change the apex, thus we copy it
 747          */
 748         ast_copy_string(apex, suffix, sizeof(apex));
 749         /* ISN rewrite */
 750         if ((context->options & ENUMLOOKUP_OPTIONS_ISN) && (p1 = strchr(number, '*'))) {
 751                 *p1++ = '\0';
 752                 ast_copy_string(left, number, sizeof(left));
 753                 ast_copy_string(middle, p1, sizeof(middle) - 1);
 754                 strcat(middle, ".");
 755                 ast_debug(2, "ISN ENUM: left=%s, middle='%s'\n", left, middle);
 756         /* Direct DNS lookup rewrite */
 757         } else if (context->options & ENUMLOOKUP_OPTIONS_DIRECT) {
 758                 left[0] = 0; /* nothing to flip around */
 759                 ast_copy_string(middle, number, sizeof(middle) - 1);
 760                 strcat(middle, ".");
 761                 ast_debug(2, "DIRECT ENUM:  middle='%s'\n", middle);
 762         /* Infrastructure ENUM rewrite */
 763         } else if (context->options & ENUMLOOKUP_OPTIONS_IENUM) {
 764                 int sdl = 0;
 765                 char cc[8];
 766                 char sep[256], n_apex[256];
 767                 int cc_len = cclen(number);
 768                 sdl = cc_len;
 769                 ast_mutex_lock(&enumlock);
 770                 ast_copy_string(sep, ienum_branchlabel, sizeof(sep)); /* default */
 771                 ast_mutex_unlock(&enumlock);
 772
 773                 switch (ebl_alg) {
 774                 case ENUMLOOKUP_BLR_EBL:
 775                         ast_copy_string(cc, number, cc_len); /* cclen() never returns more than 3 */
 776                         sdl = blr_ebl(cc, suffix, sep, sizeof(sep) - 1, n_apex, sizeof(n_apex) - 1);
 777
 778                         if (sdl >= 0) {
 779                                 ast_copy_string(apex, n_apex, sizeof(apex));
 780                                 ast_debug(2, "EBL ENUM: sep=%s, apex='%s'\n", sep, n_apex);
 781                         } else {
 782                                 sdl = cc_len;
 783                         }
 784                         break;
 785                 case ENUMLOOKUP_BLR_TXT:
 786                         ast_copy_string(cc, number, cc_len); /* cclen() never returns more than 3 */
 787                         sdl = blr_txt(cc, suffix);
 788
 789                         if (sdl < 0) {
 790                                 sdl = cc_len;
 791                         }
 792                         break;
 793
 794                 case ENUMLOOKUP_BLR_CC: /* BLR is at the country-code level */
 795                 default:
 796                         sdl = cc_len;
 797                         break;
 798                 }
 799
 800                 if (sdl > strlen(number)) {     /* Number too short for this sdl? */
 801                         ast_log(LOG_WARNING, "I-ENUM: subdomain location %d behind number %s\n", sdl, number);
 802                         ast_free(context);
 803                         return 0;
 804                 }
 805                 ast_copy_string(left, number + sdl, sizeof(left));
 806
 807                 ast_mutex_lock(&enumlock);
 808                 ast_copy_string(middle, sep, sizeof(middle) - 1);
 809                 strcat(middle, ".");
 810                 ast_mutex_unlock(&enumlock);
 811
 812                 /* check the space we need for middle */
 813                 if ((sdl * 2 + strlen(middle) + 2) > sizeof(middle)) {
 814                         ast_log(LOG_WARNING, "ast_get_enum: not enough space for I-ENUM rewrite.\n");
 815                         ast_free(context);
 816                         return -1;
 817                 }
 818
 819                 p1 = middle + strlen(middle);
 820                 for (p2 = (char *) number + sdl - 1; p2 >= number; p2--) {
 821                         if (isdigit(*p2)) {
 822                                 *p1++ = *p2;
 823                                 *p1++ = '.';
 824                         }
 825                 }
 826                 *p1 = '\0';
 827
 828                 ast_debug(2, "I-ENUM: cclen=%d, left=%s, middle='%s', apex='%s'\n", cc_len, left, middle, apex);
 829         }
 830
 831         if (strlen(left) * 2 + 2 > sizeof(domain)) {
 832                 ast_log(LOG_WARNING, "string to long in ast_get_enum\n");
 833                 ast_free(context);
 834                 return -1;
 835         }
 836
 837         /* flip left into domain */
 838         p1 = domain;
 839         for (p2 = left + strlen(left); p2 >= left; p2--) {
 840                 if (isdigit(*p2)) {
 841                         *p1++ = *p2;
 842                         *p1++ = '.';
 843                 }
 844         }
 845         *p1 = '\0';
 846
 847         if (chan && ast_autoservice_start(chan) < 0) {
 848                 ast_free(context);
 849                 return -1;
 850         }
 851
 852         spaceleft = sizeof(tmp) - 2;
 853         ast_copy_string(tmp, domain, spaceleft);
 854         spaceleft -= strlen(domain);
 855
 856         if (*middle) {
 857                 strncat(tmp, middle, spaceleft);
 858                 spaceleft -= strlen(middle);
 859         }
 860
 861         strncat(tmp,apex,spaceleft);
 862         time_start = ast_tvnow();
 863         ret = ast_search_dns(context, tmp, C_IN, T_NAPTR, enum_callback);
 864         time_end = ast_tvnow();
 865
 866         ast_debug(2, "profiling: %s, %s, %" PRIi64 " ms\n",
 867                         (ret == 0) ? "OK" : "FAIL", tmp, ast_tvdiff_ms(time_end, time_start));
 868
 869         if (ret < 0) {
 870                 ast_debug(1, "No such number found: %s (%s)\n", tmp, strerror(errno));
 871                 context->naptr_rrs_count = -1;
 872                 strcpy(dst, "0");
 873                 ret = 0;
 874         }
 875
 876         if (context->naptr_rrs_count >= context->position && ! (context->options & ENUMLOOKUP_OPTIONS_COUNT)) {
 877                 /* sort array by NAPTR order/preference */
 878                 for (k = 0; k < context->naptr_rrs_count; k++) {
 879                         for (i = 0; i < context->naptr_rrs_count; i++) {
 880                                 /* use order first and then preference to compare */
 881                                 if ((ntohs(context->naptr_rrs[k].naptr.order) < ntohs(context->naptr_rrs[i].naptr.order)
 882                                      && context->naptr_rrs[k].sort_pos > context->naptr_rrs[i].sort_pos)
 883                                      || (ntohs(context->naptr_rrs[k].naptr.order) > ntohs(context->naptr_rrs[i].naptr.order)
 884                                      && context->naptr_rrs[k].sort_pos < context->naptr_rrs[i].sort_pos)) {
 885                                         z = context->naptr_rrs[k].sort_pos;
 886                                         context->naptr_rrs[k].sort_pos = context->naptr_rrs[i].sort_pos;
 887                                         context->naptr_rrs[i].sort_pos = z;
 888                                         continue;
 889                                 }
 890                                 if (ntohs(context->naptr_rrs[k].naptr.order) == ntohs(context->naptr_rrs[i].naptr.order)) {
 891                                         if ((ntohs(context->naptr_rrs[k].naptr.pref) < ntohs(context->naptr_rrs[i].naptr.pref)
 892                                              && context->naptr_rrs[k].sort_pos > context->naptr_rrs[i].sort_pos)
 893                                              || (ntohs(context->naptr_rrs[k].naptr.pref) > ntohs(context->naptr_rrs[i].naptr.pref)
 894                                              && context->naptr_rrs[k].sort_pos < context->naptr_rrs[i].sort_pos)) {
 895                                                 z = context->naptr_rrs[k].sort_pos;
 896                                                 context->naptr_rrs[k].sort_pos = context->naptr_rrs[i].sort_pos;
 897                                                 context->naptr_rrs[i].sort_pos = z;
 898                                         }
 899                                 }
 900                         }
 901                 }
 902                 for (k = 0; k < context->naptr_rrs_count; k++) {
 903                         if (context->naptr_rrs[k].sort_pos == context->position - 1) {
 904                                 ast_copy_string(context->dst, context->naptr_rrs[k].result, dstlen);
 905                                 ast_copy_string(context->tech, context->naptr_rrs[k].tech, techlen);
 906                                 break;
 907                         }
 908                 }
 909         } else if (!(context->options & ENUMLOOKUP_OPTIONS_COUNT)) {
 910                 context->dst[0] = 0;
 911         } else if ((context->options & ENUMLOOKUP_OPTIONS_COUNT)) {
 912                 snprintf(context->dst, context->dstlen, "%d", context->naptr_rrs_count + context->count);
 913         }
 914
 915         if (chan) {
 916                 ret |= ast_autoservice_stop(chan);
 917         }
 918
 919         if (!argcontext) {
 920                 for (k = 0; k < context->naptr_rrs_count; k++) {
 921                         ast_free(context->naptr_rrs[k].result);
 922                         ast_free(context->naptr_rrs[k].tech);
 923                 }
 924                 ast_free(context->naptr_rrs);
 925                 ast_free(context);
 926         } else {
 927                 *argcontext = context;
 928         }
 929
 930         return ret;
 931 }
 932
 933 int ast_get_txt(struct ast_channel *chan, const char *number, char *txt, int txtlen, char *suffix)
 934 {
 935         struct txt_context context;
 936         char tmp[259 + 512];
 937         int pos = strlen(number) - 1;
 938         int newpos = 0;
 939         int ret = -1;
 940
 941         ast_debug(4, "ast_get_txt: Number = '%s', suffix = '%s'\n", number, suffix);
 942
 943         if (chan && ast_autoservice_start(chan) < 0) {
 944                 return -1;
 945         }
 946
 947         if (pos > 128) {
 948                 pos = 128;
 949         }
 950
 951         while (pos >= 0) {
 952                 if (isdigit(number[pos])) {
 953                         tmp[newpos++] = number[pos];
 954                         tmp[newpos++] = '.';
 955                 }
 956                 pos--;
 957         }
 958
 959         ast_copy_string(&tmp[newpos], suffix, sizeof(tmp) - newpos);
 960
 961         if (ret < 0) {
 962                 ast_debug(2, "No such number found in ENUM: %s (%s)\n", tmp, strerror(errno));
 963                 ret = 0;
 964         } else {
 965                 ast_copy_string(txt, context.txt, txtlen);
 966         }
 967         if (chan) {
 968                 ret |= ast_autoservice_stop(chan);
 969         }
 970         return ret;
 971 }
 972
 973 /*! \brief Initialize the ENUM support subsystem */
 974 static int private_enum_init(int reload)
 975 {
 976         struct ast_config *cfg;
 977         const char *string;
 978         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
 979
 980         if ((cfg = ast_config_load2("enum.conf", "enum", config_flags)) == CONFIG_STATUS_FILEUNCHANGED)
 981                 return 0;
 982         if (cfg == CONFIG_STATUS_FILEMISSING || cfg == CONFIG_STATUS_FILEUNCHANGED || cfg == CONFIG_STATUS_FILEINVALID) {
 983                 return 0;
 984         }
 985
 986         /* Destroy existing list */
 987         ast_mutex_lock(&enumlock);
 988         if (cfg) {
 989                 if ((string = ast_variable_retrieve(cfg, "ienum", "branchlabel"))) {
 990                         ast_copy_string(ienum_branchlabel, string, sizeof(ienum_branchlabel));
 991                 }
 992
 993                 if ((string = ast_variable_retrieve(cfg, "ienum", "ebl_alg"))) {
 994                         ebl_alg = ENUMLOOKUP_BLR_CC; /* default */
 995
 996                         if (!strcasecmp(string, "txt"))
 997                                 ebl_alg = ENUMLOOKUP_BLR_TXT;
 998                         else if (!strcasecmp(string, "ebl"))
 999                                 ebl_alg = ENUMLOOKUP_BLR_EBL;
1000                         else if (!strcasecmp(string, "cc"))
1001                                 ebl_alg = ENUMLOOKUP_BLR_CC;
1002                         else
1003                                 ast_log(LOG_WARNING, "No valid parameter for ienum/ebl_alg.\n");
1004                 }
1005                 ast_config_destroy(cfg);
1006         }
1007         ast_mutex_unlock(&enumlock);
1008         return 0;
1009 }
1010
1011 int ast_enum_init(void)
1012 {
1013         return private_enum_init(0);
1014 }
1015
1016 int ast_enum_reload(void)
1017 {
1018         return private_enum_init(1);
1019 }