Add the ability to dynamically specify weights for responses to DUNDi queries.
[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  * \par Possible improvement
39  * \todo Implement a caching mechanism for multile enum lookups
40  * - See http://bugs.digium.com/view.php?id=6739
41  */
42
43 #include "asterisk.h"
44
45 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
46
47 #include <sys/types.h>
48 #include <sys/socket.h>
49 #include <netinet/in.h>
50 #include <arpa/nameser.h>
51 #ifdef __APPLE__
52 #if __APPLE_CC__ >= 1495
53 #include <arpa/nameser_compat.h>
54 #endif
55 #endif
56 #include <resolv.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include <ctype.h>
60 #include <regex.h>
61 #include <unistd.h>
62 #include <errno.h>
63
64 #include "asterisk/logger.h"
65 #include "asterisk/options.h"
66 #include "asterisk/enum.h"
67 #include "asterisk/dns.h"
68 #include "asterisk/channel.h"
69 #include "asterisk/config.h"
70 #include "asterisk/utils.h"
71
72 #ifdef __APPLE__
73 #undef T_NAPTR
74 #define T_NAPTR 35
75 #endif
76
77 #ifdef __APPLE__
78 #undef T_TXT
79 #define T_TXT 16
80 #endif
81
82 #define TOPLEV "e164.arpa."     /*!< The IETF Enum standard root, managed by the ITU */
83
84 /* Linked list from config file */
85 static struct enum_search {
86         char toplev[512];
87         struct enum_search *next;
88 } *toplevs;
89
90 static int enumver;
91
92 AST_MUTEX_DEFINE_STATIC(enumlock);
93
94 struct naptr {
95         unsigned short order;
96         unsigned short pref;
97 } __attribute__ ((__packed__));
98
99 /*! \brief Parse NAPTR record information elements */
100 static unsigned int parse_ie(char *data, unsigned int maxdatalen, unsigned char *src, unsigned int srclen)
101 {
102         unsigned int len, olen;
103
104         len = olen = (unsigned int) src[0];
105         src++;
106         srclen--;
107
108         if (len > srclen) {
109                 ast_log(LOG_WARNING, "ENUM parsing failed: Wanted %d characters, got %d\n", len, srclen);
110                 return -1;
111         }
112
113         if (len > maxdatalen)
114                 len = maxdatalen;
115         memcpy(data, src, len);
116
117         return olen + 1;
118 }
119
120 /*! \brief Parse DNS NAPTR record used in ENUM ---*/
121 static int parse_naptr(char *dst, int dstsize, char *tech, int techsize, unsigned char *answer, int len, char *naptrinput)
122 {
123         char tech_return[80];
124         unsigned char *oanswer = answer;
125         char flags[512] = "";
126         char services[512] = "";
127         char *p;
128         char regexp[512] = "";
129         char repl[512] = "";
130         char temp[512] = "";
131         char delim;
132         char *delim2;
133         char *pattern, *subst, *d;
134         int res;
135         int regexp_len, size, backref;
136         int d_len = sizeof(temp) - 1;
137         regex_t preg;
138         regmatch_t pmatch[9];
139
140         tech_return[0] = '\0';
141
142         dst[0] = '\0';
143
144         if (len < sizeof(struct naptr)) {
145                 ast_log(LOG_WARNING, "NAPTR record length too short\n");
146                 return -1;
147         }
148         answer += sizeof(struct naptr);
149         len -= sizeof(struct naptr);
150         if ((res = parse_ie(flags, sizeof(flags) - 1, answer, len)) < 0) {
151                 ast_log(LOG_WARNING, "Failed to get flags from NAPTR record\n");
152                 return -1;
153         } else {
154                 answer += res;
155                 len -= res;
156         }
157         if ((res = parse_ie(services, sizeof(services) - 1, answer, len)) < 0) {
158                 ast_log(LOG_WARNING, "Failed to get services from NAPTR record\n");
159                 return -1;
160         } else {
161                 answer += res;
162                 len -= res;
163         }
164         if ((res = parse_ie(regexp, sizeof(regexp) - 1, answer, len)) < 0) {
165                 ast_log(LOG_WARNING, "Failed to get regexp from NAPTR record\n");
166                 return -1;
167         } else {
168                 answer += res;
169                 len -= res;
170         }
171
172         if ((res = dn_expand(oanswer, answer + len, answer, repl, sizeof(repl) - 1)) < 0) {
173                 ast_log(LOG_WARNING, "Failed to expand hostname\n");
174                 return -1;
175         }
176
177         if (option_debug > 2)   /* Advanced NAPTR debugging */
178                 ast_log(LOG_DEBUG, "NAPTR input='%s', flags='%s', services='%s', regexp='%s', repl='%s'\n",
179                         naptrinput, flags, services, regexp, repl);
180
181         if (tolower(flags[0]) != 'u') {
182                 ast_log(LOG_WARNING, "NAPTR Flag must be 'U' or 'u'.\n");
183                 return -1;
184         }
185
186         p = strstr(services, "e2u+");
187         if (p == NULL)
188                 p = strstr(services, "E2U+");
189         if (p){
190                 p = p + 4;
191                 if (strchr(p, ':')){
192                         p = strchr(p, ':') + 1;
193                 }
194                 ast_copy_string(tech_return, p, sizeof(tech_return));
195         } else {
196
197                 p = strstr(services, "+e2u");
198                 if (p == NULL)
199                         p = strstr(services, "+E2U");
200                 if (p) {
201                         *p = 0;
202                         p = strchr(services, ':');
203                         if (p)
204                                 *p = 0;
205                         ast_copy_string(tech_return, services, sizeof(tech_return));
206                 }
207         }
208
209         /* DEDBUGGING STUB
210         ast_copy_string(regexp, "!^\\+43(.*)$!\\1@bla.fasel!", sizeof(regexp) - 1);
211         */
212
213         regexp_len = strlen(regexp);
214         if (regexp_len < 7) {
215                 ast_log(LOG_WARNING, "Regex too short to be meaningful.\n");
216                 return -1;
217         }
218
219
220         delim = regexp[0];
221         delim2 = strchr(regexp + 1, delim);
222         if ((delim2 == NULL) || (regexp[regexp_len-1] != delim)) {
223                 ast_log(LOG_WARNING, "Regex delimiter error (on \"%s\").\n",regexp);
224                 return -1;
225         }
226
227         pattern = regexp + 1;
228         *delim2 = 0;
229         subst   = delim2 + 1;
230         regexp[regexp_len-1] = 0;
231
232 /*
233  * now do the regex wizardry.
234  */
235
236         if (regcomp(&preg, pattern, REG_EXTENDED | REG_NEWLINE)) {
237                 ast_log(LOG_WARNING, "NAPTR Regex compilation error (regex = \"%s\").\n",regexp);
238                 return -1;
239         }
240
241         if (preg.re_nsub > 9) {
242                 ast_log(LOG_WARNING, "NAPTR Regex compilation error: too many subs.\n");
243                 regfree(&preg);
244                 return -1;
245         }
246
247         if (regexec(&preg, naptrinput, 9, pmatch, 0)) {
248                 ast_log(LOG_WARNING, "NAPTR Regex match failed.\n");
249                 regfree(&preg);
250                 return -1;
251         }
252         regfree(&preg);
253
254         d = temp;
255         d_len--;
256         while (*subst && (d_len > 0)) {
257                 if ((subst[0] == '\\') && isdigit(subst[1]) && (pmatch[subst[1]-'0'].rm_so != -1)) {
258                         backref = subst[1]-'0';
259                         size = pmatch[backref].rm_eo - pmatch[backref].rm_so;
260                         if (size > d_len) {
261                                 ast_log(LOG_WARNING, "Not enough space during NAPTR regex substitution.\n");
262                                 return -1;
263                                 }
264                         memcpy(d, naptrinput + pmatch[backref].rm_so, size);
265                         d += size;
266                         d_len -= size;
267                         subst += 2;
268                 } else if (isprint(*subst)) {
269                         *d++ = *subst++;
270                         d_len--;
271                 } else {
272                         ast_log(LOG_WARNING, "Error during regex substitution.\n");
273                         return -1;
274                 }
275         }
276         *d = 0;
277         ast_copy_string(dst, temp, dstsize);
278         dst[dstsize - 1] = '\0';
279
280         if (*tech != '\0'){ /* check if it is requested NAPTR */
281                 if (!strncasecmp(tech, "ALL", techsize)){
282                         return 1; /* return or count any RR */
283                 }
284                 if (!strncasecmp(tech_return, tech, sizeof(tech_return)<techsize?sizeof(tech_return):techsize)){
285                         ast_copy_string(tech, tech_return, techsize);
286                         return 1; /* we got out RR */
287                 } else { /* go to the next RR in the DNS answer */
288                         return 0;
289                 }
290         }
291
292         /* tech was not specified, return first parsed RR */
293         ast_copy_string(tech, tech_return, techsize);
294
295         return 1;
296 }
297
298 /* do not return requested value, just count RRs and return thei number in dst */
299 #define ENUMLOOKUP_OPTIONS_COUNT       1
300
301 struct enum_naptr_rr {
302         struct naptr naptr; /* order and preference of RR */
303         char *result; /* result of naptr parsing,e.g.: tel:+5553 */
304         char *tech; /* Technology (from URL scheme) */
305         int sort_pos; /* sort position */
306 };
307
308 struct enum_context {
309         char *dst;      /* Destination part of URL from ENUM */
310         int dstlen;     /* Length */
311         char *tech;     /* Technology (from URL scheme) */
312         int techlen;    /* Length */
313         char *txt;      /* TXT record in TXT lookup */
314         int txtlen;     /* Length */
315         char *naptrinput;       /* The number to lookup */
316         int position; /* used as counter for RRs or specifies position of required RR */
317         int options; /* options , see ENUMLOOKUP_OPTIONS_* defined above */
318         struct enum_naptr_rr *naptr_rrs; /* array of parsed NAPTR RRs */
319         int naptr_rrs_count; /* Size of array naptr_rrs */
320 };
321
322 /*! \brief Callback for TXT record lookup */
323 static int txt_callback(void *context, unsigned char *answer, int len, unsigned char *fullanswer)
324 {
325         struct enum_context *c = (struct enum_context *)context;
326
327         if (answer == NULL) {
328                 c->txt = NULL;
329                 c->txtlen = 0;
330                 return 0;
331         }
332
333         /* skip over first byte, as for some reason it's a vertical tab character */
334         answer += 1;
335         len -= 1;
336
337         /* answer is not null-terminated, but should be */
338         /* this is safe to do, as answer has extra bytes on the end we can
339          * safely overwrite with a null */
340         answer[len] = '\0';
341         /* now increment len so that len includes the null, so that we can
342          * compare apples to apples */
343         len +=1;
344
345         /* finally, copy the answer into c->txt */
346         ast_copy_string(c->txt, (const char *) answer, len < c->txtlen ? len : (c->txtlen));
347
348         /* just to be safe, let's make sure c->txt is null terminated */
349         c->txt[(c->txtlen)-1] = '\0';
350
351         return 1;
352 }
353
354 /*! \brief Callback from ENUM lookup function */
355 static int enum_callback(void *context, unsigned char *answer, int len, unsigned char *fullanswer)
356 {
357         struct enum_context *c = context;
358         void *p = NULL;
359         int res;
360
361         res = parse_naptr(c->dst, c->dstlen, c->tech, c->techlen, answer, len, c->naptrinput);
362
363         if (res < 0) {
364                 ast_log(LOG_WARNING, "Failed to parse naptr :(\n");
365                 return -1;
366         } else if (res > 0 && !ast_strlen_zero(c->dst)){ /* ok, we got needed NAPTR */
367                 if (c->options & ENUMLOOKUP_OPTIONS_COUNT){ /* counting RRs */
368                         c->position++;
369                         snprintf(c->dst, c->dstlen, "%d", c->position);
370                 } else  {
371                         if ((p = ast_realloc(c->naptr_rrs, sizeof(*c->naptr_rrs) * (c->naptr_rrs_count + 1)))) {
372                                 c->naptr_rrs = p;
373                                 memcpy(&c->naptr_rrs[c->naptr_rrs_count].naptr, answer, sizeof(c->naptr_rrs->naptr));
374                                 c->naptr_rrs[c->naptr_rrs_count].result = strdup(c->dst);
375                                 c->naptr_rrs[c->naptr_rrs_count].tech = strdup(c->tech);
376                                 c->naptr_rrs[c->naptr_rrs_count].sort_pos = c->naptr_rrs_count;
377                                 c->naptr_rrs_count++;
378                         }
379                         c->dst[0] = 0;
380                 }
381                 return 0;
382         }
383
384         if (c->options & ENUMLOOKUP_OPTIONS_COUNT)      { /* counting RRs */
385                 snprintf(c->dst, c->dstlen, "%d", c->position);
386         }
387
388         return 0;
389 }
390
391 /*! \brief ENUM lookup */
392 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)
393 {
394         struct enum_context context;
395         char tmp[259 + 512];
396         char naptrinput[512];
397         int pos = strlen(number) - 1;
398         int newpos = 0;
399         int ret = -1;
400         struct enum_search *s = NULL;
401         int version = -1;
402         /* for ISN rewrite */
403         char *p1 = NULL;
404         char *p2 = NULL;
405         int k = 0;
406         int i = 0;
407         int z = 0;
408
409         ast_copy_string(naptrinput, number[0] == 'n' ? number+1 : number, sizeof(naptrinput));
410
411         context.naptrinput = naptrinput;        /* The number */
412         context.dst = dst;                      /* Return string */
413         context.dstlen = dstlen;
414         context.tech = tech;
415         context.techlen = techlen;
416         context.options = 0;
417         context.position = record;
418         context.naptr_rrs = NULL;
419         context.naptr_rrs_count = 0;
420
421         if (options != NULL) {
422                 if (*options == 'c') {
423                         context.options = ENUMLOOKUP_OPTIONS_COUNT;
424                         context.position = 0;
425                 }
426         }
427
428         ast_log(LOG_DEBUG, "ast_get_enum(): n='%s', tech='%s', suffix='%s', options='%d', record='%d'\n",
429                         number, tech, suffix, context.options, context.position);
430
431         if (pos > 128)
432                 pos = 128;
433
434         /* ISN rewrite */
435         p1 = strchr(number, '*');
436
437         if (number[0] == 'n') { /* do not perform ISN rewrite ('n' is testing flag) */
438                 p1 = NULL;
439                 k = 1; /* strip 'n' from number */
440         }
441
442         if (p1 != NULL) {
443                 p2 = p1+1;
444                 while (p1 > number){
445                         p1--;
446                         tmp[newpos++] = *p1;
447                         tmp[newpos++] = '.';
448                 }
449                 if (*p2) {
450                         while (*p2 && newpos < 128){
451                                 tmp[newpos++] = *p2;
452                                 p2++;
453                         }
454                         tmp[newpos++] = '.';
455                 }
456
457         } else {
458                 while (pos >= k) {
459                         if (isdigit(number[pos])) {
460                                 tmp[newpos++] = number[pos];
461                                 tmp[newpos++] = '.';
462                         }
463                         pos--;
464                 }
465         }
466
467         if (chan && ast_autoservice_start(chan) < 0)
468                 return -1;
469
470         if(suffix) {
471                 ast_copy_string(tmp + newpos, suffix, sizeof(tmp) - newpos);
472                 ret = ast_search_dns(&context, tmp, C_IN, T_NAPTR, enum_callback);
473                 ast_log(LOG_DEBUG, "ast_get_enum: ast_search_dns(%s) returned %d\n", tmp, ret);
474         } else {
475                 ret = -1;               /* this is actually dead code since the demise of app_enum.c */
476                 for (;;) {
477                         ast_mutex_lock(&enumlock);
478                         if (version != enumver) {
479                                 /* Ooh, a reload... */
480                                 s = toplevs;
481                                 version = enumver;
482                         } else {
483                                 s = s->next;
484                         }
485                         ast_mutex_unlock(&enumlock);
486
487                         if (!s)
488                                 break;
489         
490                         ast_copy_string(tmp + newpos, s->toplev, sizeof(tmp) - newpos);
491                         ret = ast_search_dns(&context, tmp, C_IN, T_NAPTR, enum_callback);
492                         ast_log(LOG_DEBUG, "ast_get_enum: ast_search_dns(%s) returned %d\n", tmp, ret);
493                         if (ret > 0)
494                                 break;
495                 }
496         }
497
498         if (ret < 0) {
499                 if (option_debug)
500                         ast_log(LOG_DEBUG, "No such number found: %s (%s)\n", tmp, strerror(errno));
501                 strcpy(dst, "0");
502                 ret = 0;
503         }
504
505         if (context.naptr_rrs_count >= context.position && ! (context.options & ENUMLOOKUP_OPTIONS_COUNT)) {
506                 /* sort array by NAPTR order/preference */
507                 for (k = 0; k < context.naptr_rrs_count; k++) {
508                         for (i = 0; i < context.naptr_rrs_count; i++) {
509                                 /* use order first and then preference to compare */
510                                 if ((ntohs(context.naptr_rrs[k].naptr.order) < ntohs(context.naptr_rrs[i].naptr.order)
511                                                 && context.naptr_rrs[k].sort_pos > context.naptr_rrs[i].sort_pos)
512                                         || (ntohs(context.naptr_rrs[k].naptr.order) > ntohs(context.naptr_rrs[i].naptr.order)
513                                                 && context.naptr_rrs[k].sort_pos < context.naptr_rrs[i].sort_pos)){
514                                         z = context.naptr_rrs[k].sort_pos;
515                                         context.naptr_rrs[k].sort_pos = context.naptr_rrs[i].sort_pos;
516                                         context.naptr_rrs[i].sort_pos = z;
517                                         continue;
518                                 }
519                                 if (ntohs(context.naptr_rrs[k].naptr.order) == ntohs(context.naptr_rrs[i].naptr.order)) {
520                                         if ((ntohs(context.naptr_rrs[k].naptr.pref) < ntohs(context.naptr_rrs[i].naptr.pref)
521                                                         && context.naptr_rrs[k].sort_pos > context.naptr_rrs[i].sort_pos)
522                                                 || (ntohs(context.naptr_rrs[k].naptr.pref) > ntohs(context.naptr_rrs[i].naptr.pref)
523                                                         && context.naptr_rrs[k].sort_pos < context.naptr_rrs[i].sort_pos)){
524                                                 z = context.naptr_rrs[k].sort_pos;
525                                                 context.naptr_rrs[k].sort_pos = context.naptr_rrs[i].sort_pos;
526                                                 context.naptr_rrs[i].sort_pos = z;
527                                         }
528                                 }
529                         }
530                 }
531                 for (k = 0; k < context.naptr_rrs_count; k++) {
532                         if (context.naptr_rrs[k].sort_pos == context.position-1) {
533                                 ast_copy_string(context.dst, context.naptr_rrs[k].result, dstlen);
534                                 ast_copy_string(context.tech, context.naptr_rrs[k].tech, techlen);
535                                 break;
536                         }
537                 }
538         } else if (!(context.options & ENUMLOOKUP_OPTIONS_COUNT)) {
539                 context.dst[0] = 0;
540         }
541         if (chan)
542                 ret |= ast_autoservice_stop(chan);
543
544         for (k = 0; k < context.naptr_rrs_count; k++) {
545                 free(context.naptr_rrs[k].result);
546                 free(context.naptr_rrs[k].tech);
547         }
548
549         free(context.naptr_rrs);
550
551         return ret;
552 }
553
554 /*! \brief Get TXT record from DNS.
555         Really has nothing to do with enum, but anyway...
556  */
557 int ast_get_txt(struct ast_channel *chan, const char *number, char *dst, int dstlen, char *tech, int techlen, char *txt, int txtlen)
558 {
559         struct enum_context context;
560         char tmp[259 + 512];
561         char naptrinput[512] = "+";
562         int pos = strlen(number) - 1;
563         int newpos = 0;
564         int ret = -1;
565         struct enum_search *s = NULL;
566         int version = -1;
567
568         strncat(naptrinput, number, sizeof(naptrinput) - 2);
569
570         context.naptrinput = naptrinput;
571         context.dst = dst;
572         context.dstlen = dstlen;
573         context.tech = tech;
574         context.techlen = techlen;
575         context.txt = txt;
576         context.txtlen = txtlen;
577
578         if (pos > 128)
579                 pos = 128;
580         while (pos >= 0) {
581                 tmp[newpos++] = number[pos--];
582                 tmp[newpos++] = '.';
583         }
584
585         if (chan && ast_autoservice_start(chan) < 0)
586                 return -1;
587
588         for (;;) {
589                 ast_mutex_lock(&enumlock);
590                 if (version != enumver) {
591                         /* Ooh, a reload... */
592                         s = toplevs;
593                         version = enumver;
594                 } else {
595                         s = s->next;
596                 }
597                 if (s) {
598                         ast_copy_string(tmp + newpos, s->toplev, sizeof(tmp) - newpos);
599                 }
600                 ast_mutex_unlock(&enumlock);
601                 if (!s)
602                         break;
603
604                 ret = ast_search_dns(&context, tmp, C_IN, T_TXT, txt_callback);
605                 if (ret > 0)
606                         break;
607         }
608         if (ret < 0) {
609                 if (option_debug > 1)
610                         ast_log(LOG_DEBUG, "No such number found in ENUM: %s (%s)\n", tmp, strerror(errno));
611                 ret = 0;
612         }
613         if (chan)
614                 ret |= ast_autoservice_stop(chan);
615         return ret;
616 }
617
618 /*! \brief Add enum tree to linked list */
619 static struct enum_search *enum_newtoplev(char *s)
620 {
621         struct enum_search *tmp;
622
623         if ((tmp = ast_calloc(1, sizeof(*tmp)))) {              
624                 ast_copy_string(tmp->toplev, s, sizeof(tmp->toplev));
625         }
626         return tmp;
627 }
628
629 /*! \brief Initialize the ENUM support subsystem */
630 int ast_enum_init(void)
631 {
632         struct ast_config *cfg;
633         struct enum_search *s, *sl;
634         struct ast_variable *v;
635
636         /* Destroy existing list */
637         ast_mutex_lock(&enumlock);
638         s = toplevs;
639         while (s) {
640                 sl = s;
641                 s = s->next;
642                 free(sl);
643         }
644         toplevs = NULL;
645         cfg = ast_config_load("enum.conf");
646         if (cfg) {
647                 sl = NULL;
648                 v = ast_variable_browse(cfg, "general");
649                 while (v) {
650                         if (!strcasecmp(v->name, "search")) {
651                                 s = enum_newtoplev(v->value);
652                                 if (s) {
653                                         if (sl)
654                                                 sl->next = s;
655                                         else
656                                                 toplevs = s;
657                                         sl = s;
658                                 }
659                         }
660                         v = v->next;
661                 }
662                 ast_config_destroy(cfg);
663         } else {
664                 toplevs = enum_newtoplev(TOPLEV);
665         }
666         enumver++;
667         ast_mutex_unlock(&enumlock);
668         return 0;
669 }
670
671 int ast_enum_reload(void)
672 {
673         return ast_enum_init();
674 }