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