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