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