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