2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2006, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
8 * Funding provided by nic.at
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.
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.
23 * \brief ENUM Support for Asterisk
25 * \author Mark Spencer <markster@digium.com>
27 * \arg Funding provided by nic.at
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
38 * \par Possible improvement
39 * \todo Implement a caching mechanism for multile enum lookups
40 * - See http://bugs.digium.com/view.php?id=6739
45 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
47 #include <sys/types.h>
48 #include <sys/socket.h>
49 #include <netinet/in.h>
50 #include <arpa/nameser.h>
51 #if __APPLE_CC__ >= 1495
52 #include <arpa/nameser_compat.h>
62 #include "asterisk/logger.h"
63 #include "asterisk/options.h"
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"
80 #define TOPLEV "e164.arpa." /*!< The IETF Enum standard root, managed by the ITU */
82 /* Linked list from config file */
83 static struct enum_search {
85 struct enum_search *next;
88 static int enumver = 0;
90 AST_MUTEX_DEFINE_STATIC(enumlock);
95 } __attribute__ ((__packed__));
97 /*! \brief Parse NAPTR record information elements */
98 static unsigned int parse_ie(char *data, unsigned int maxdatalen, char *src, unsigned int srclen)
100 unsigned int len, olen;
102 len = olen = (unsigned int) src[0];
107 ast_log(LOG_WARNING, "ENUM parsing failed: Wanted %d characters, got %d\n", len, srclen);
111 if (len > maxdatalen)
113 memcpy(data, src, len);
118 /*! \brief Parse DNS NAPTR record used in ENUM ---*/
119 static int parse_naptr(unsigned char *dst, int dstsize, char *tech, int techsize, unsigned char *answer, int len, unsigned char *naptrinput)
121 char tech_return[80];
122 char *oanswer = answer;
123 char flags[512] = "";
124 char services[512] = "";
126 char regexp[512] = "";
131 char *pattern, *subst, *d;
133 int regexp_len, size, backref;
134 int d_len = sizeof(temp) - 1;
136 regmatch_t pmatch[9];
138 tech_return[0] = '\0';
142 if (len < sizeof(struct naptr)) {
143 ast_log(LOG_WARNING, "NAPTR record length too short\n");
146 answer += sizeof(struct naptr);
147 len -= sizeof(struct naptr);
148 if ((res = parse_ie(flags, sizeof(flags) - 1, answer, len)) < 0) {
149 ast_log(LOG_WARNING, "Failed to get flags from NAPTR record\n");
155 if ((res = parse_ie(services, sizeof(services) - 1, answer, len)) < 0) {
156 ast_log(LOG_WARNING, "Failed to get services from NAPTR record\n");
162 if ((res = parse_ie(regexp, sizeof(regexp) - 1, answer, len)) < 0) {
163 ast_log(LOG_WARNING, "Failed to get regexp from NAPTR record\n");
170 if ((res = dn_expand((unsigned char *)oanswer, (unsigned char *)answer + len, (unsigned char *)answer, repl, sizeof(repl) - 1)) < 0) {
171 ast_log(LOG_WARNING, "Failed to expand hostname\n");
175 if (option_debug > 2) /* Advanced NAPTR debugging */
176 ast_log(LOG_DEBUG, "NAPTR input='%s', flags='%s', services='%s', regexp='%s', repl='%s'\n",
177 naptrinput, flags, services, regexp, repl);
179 if (tolower(flags[0]) != 'u') {
180 ast_log(LOG_WARNING, "NAPTR Flag must be 'U' or 'u'.\n");
184 p = strstr(services, "e2u+");
186 p = strstr(services, "E2U+");
190 p = strchr(p, ':') + 1;
192 ast_copy_string(tech_return, p, sizeof(tech_return));
195 p = strstr(services, "+e2u");
197 p = strstr(services, "+E2U");
200 p = strchr(services, ':');
203 ast_copy_string(tech_return, services, sizeof(tech_return));
208 ast_copy_string(regexp, "!^\\+43(.*)$!\\1@bla.fasel!", sizeof(regexp) - 1);
211 regexp_len = strlen(regexp);
212 if (regexp_len < 7) {
213 ast_log(LOG_WARNING, "Regex too short to be meaningful.\n");
219 delim2 = strchr(regexp + 1, delim);
220 if ((delim2 == NULL) || (regexp[regexp_len-1] != delim)) {
221 ast_log(LOG_WARNING, "Regex delimiter error (on \"%s\").\n",regexp);
225 pattern = regexp + 1;
228 regexp[regexp_len-1] = 0;
231 printf("Pattern: %s\n", pattern);
232 printf("Subst: %s\n", subst);
233 printf("Input: %s\n", naptrinput);
237 * now do the regex wizardry.
240 if (regcomp(&preg, pattern, REG_EXTENDED | REG_NEWLINE)) {
241 ast_log(LOG_WARNING, "NAPTR Regex compilation error (regex = \"%s\").\n",regexp);
245 if (preg.re_nsub > 9) {
246 ast_log(LOG_WARNING, "NAPTR Regex compilation error: too many subs.\n");
251 if (regexec(&preg, naptrinput, 9, pmatch, 0)) {
252 ast_log(LOG_WARNING, "NAPTR Regex match failed.\n");
260 while (*subst && (d_len > 0)) {
261 if ((subst[0] == '\\') && isdigit(subst[1]) && (pmatch[subst[1]-'0'].rm_so != -1)) {
262 backref = subst[1]-'0';
263 size = pmatch[backref].rm_eo - pmatch[backref].rm_so;
265 ast_log(LOG_WARNING, "Not enough space during NAPTR regex substitution.\n");
268 memcpy(d, naptrinput + pmatch[backref].rm_so, size);
272 } else if (isprint(*subst)) {
276 ast_log(LOG_WARNING, "Error during regex substitution.\n");
281 ast_copy_string(dst, temp, dstsize);
282 dst[dstsize - 1] = '\0';
284 if (*tech != '\0'){ /* check if it is requested NAPTR */
285 if (!strncasecmp(tech, "ALL", techsize)){
286 return 1; /* return or count any RR */
288 if (!strncasecmp(tech_return, tech, sizeof(tech_return)<techsize?sizeof(tech_return):techsize)){
289 ast_copy_string(tech, tech_return, techsize);
290 return 1; /* we got out RR */
291 } else { /* go to the next RR in the DNS answer */
296 /* tech was not specified, return first parsed RR */
297 ast_copy_string(tech, tech_return, techsize);
302 /* do not return requested value, just count RRs and return thei number in dst */
303 #define ENUMLOOKUP_OPTIONS_COUNT 1
305 struct enum_naptr_rr {
306 struct naptr naptr; /* order and preference of RR */
307 char *result; /* result of naptr parsing,e.g.: tel:+5553 */
308 char *tech; /* Technology (from URL scheme) */
309 int sort_pos; /* sort position */
312 struct enum_context {
313 char *dst; /* Destination part of URL from ENUM */
314 int dstlen; /* Length */
315 char *tech; /* Technology (from URL scheme) */
316 int techlen; /* Length */
317 char *txt; /* TXT record in TXT lookup */
318 int txtlen; /* Length */
319 char *naptrinput; /* The number to lookup */
320 int position; /* used as counter for RRs or specifies position of required RR */
321 int options; /* options , see ENUMLOOKUP_OPTIONS_* defined above */
322 struct enum_naptr_rr *naptr_rrs; /* array of parsed NAPTR RRs */
323 int naptr_rrs_count; /* Size of array naptr_rrs */
326 /*! \brief Callback for TXT record lookup */
327 static int txt_callback(void *context, char *answer, int len, char *fullanswer)
329 struct enum_context *c = (struct enum_context *)context;
331 printf("ENUMTXT Called\n");
334 if (answer == NULL) {
340 /* skip over first byte, as for some reason it's a vertical tab character */
344 /* answer is not null-terminated, but should be */
345 /* this is safe to do, as answer has extra bytes on the end we can
346 safely overwrite with a null */
348 /* now increment len so that len includes the null, so that we can
349 compare apples to apples */
352 /* finally, copy the answer into c->txt */
353 ast_copy_string(c->txt, answer, len < c->txtlen ? len : (c->txtlen));
355 /* just to be safe, let's make sure c->txt is null terminated */
356 c->txt[(c->txtlen)-1] = '\0';
361 /*! \brief Callback from ENUM lookup function */
362 static int enum_callback(void *context, char *answer, int len, char *fullanswer)
364 struct enum_context *c = context;
368 res = parse_naptr(c->dst, c->dstlen, c->tech, c->techlen, answer, len, c->naptrinput);
371 ast_log(LOG_WARNING, "Failed to parse naptr :(\n");
373 } else if (res > 0 && !ast_strlen_zero(c->dst)){ /* ok, we got needed NAPTR */
374 if (c->options & ENUMLOOKUP_OPTIONS_COUNT){ /* counting RRs */
376 snprintf(c->dst, c->dstlen, "%d", c->position);
378 if ((p = ast_realloc(c->naptr_rrs, sizeof(*c->naptr_rrs) * (c->naptr_rrs_count + 1)))) {
380 memcpy(&c->naptr_rrs[c->naptr_rrs_count].naptr, answer, sizeof(c->naptr_rrs->naptr));
381 /* printf("order=%d, pref=%d\n", ntohs(c->naptr_rrs[c->naptr_rrs_count].naptr.order), ntohs(c->naptr_rrs[c->naptr_rrs_count].naptr.pref)); */
382 c->naptr_rrs[c->naptr_rrs_count].result = strdup(c->dst);
383 c->naptr_rrs[c->naptr_rrs_count].tech = strdup(c->tech);
384 c->naptr_rrs[c->naptr_rrs_count].sort_pos = c->naptr_rrs_count;
385 c->naptr_rrs_count++;
392 if (c->options & ENUMLOOKUP_OPTIONS_COUNT) { /* counting RRs */
393 snprintf(c->dst, c->dstlen, "%d", c->position);
399 /*! \brief ENUM lookup */
400 int ast_get_enum(struct ast_channel *chan, const char *number, char *dst, int dstlen, char *tech, int techlen, char* suffix, char* options)
402 struct enum_context context;
404 char naptrinput[512];
405 int pos = strlen(number) - 1;
408 struct enum_search *s = NULL;
410 /* for ISN rewrite */
417 ast_copy_string(naptrinput, number[0] == 'n' ? number+1 : number, sizeof(naptrinput));
419 context.naptrinput = naptrinput; /* The number */
420 context.dst = dst; /* Return string */
421 context.dstlen = dstlen;
423 context.techlen = techlen;
425 context.position = 1;
426 context.naptr_rrs = NULL;
427 context.naptr_rrs_count = 0;
429 if (options != NULL) {
430 if (*options == 'c') {
431 context.options = ENUMLOOKUP_OPTIONS_COUNT;
432 context.position = 0;
434 context.position = atoi(options);
435 if (context.position < 1)
436 context.position = 1;
444 p1 = strchr(number, '*');
446 if (number[0] == 'n') { /* do not perform ISN rewrite ('n' is testing flag) */
448 k = 1; /* strip 'n' from number */
459 while(*p2 && newpos < 128){
468 if (isdigit(number[pos])) {
469 tmp[newpos++] = number[pos];
476 if (chan && ast_autoservice_start(chan) < 0)
480 ast_mutex_lock(&enumlock);
481 if (version != enumver) {
482 /* Ooh, a reload... */
488 ast_copy_string(tmp + newpos, suffix ? suffix : s->toplev, sizeof(tmp) - newpos);
489 ast_mutex_unlock(&enumlock);
492 ret = ast_search_dns(&context, tmp, C_IN, T_NAPTR, enum_callback);
499 ast_log(LOG_DEBUG, "No such number found: %s (%s)\n", tmp, strerror(errno));
504 if (context.naptr_rrs_count >= context.position && ! (context.options & ENUMLOOKUP_OPTIONS_COUNT)) {
505 /* sort array by NAPTR order/preference */
506 for (k=0; k<context.naptr_rrs_count; k++) {
507 for (i=0; i<context.naptr_rrs_count; i++) {
508 /* use order first and then preference to compare */
509 if ((ntohs(context.naptr_rrs[k].naptr.order) < ntohs(context.naptr_rrs[i].naptr.order)
510 && context.naptr_rrs[k].sort_pos > context.naptr_rrs[i].sort_pos)
511 || (ntohs(context.naptr_rrs[k].naptr.order) > ntohs(context.naptr_rrs[i].naptr.order)
512 && context.naptr_rrs[k].sort_pos < context.naptr_rrs[i].sort_pos)){
513 z = context.naptr_rrs[k].sort_pos;
514 context.naptr_rrs[k].sort_pos = context.naptr_rrs[i].sort_pos;
515 context.naptr_rrs[i].sort_pos = z;
518 if (ntohs(context.naptr_rrs[k].naptr.order) == ntohs(context.naptr_rrs[i].naptr.order)) {
519 if ((ntohs(context.naptr_rrs[k].naptr.pref) < ntohs(context.naptr_rrs[i].naptr.pref)
520 && context.naptr_rrs[k].sort_pos > context.naptr_rrs[i].sort_pos)
521 || (ntohs(context.naptr_rrs[k].naptr.pref) > ntohs(context.naptr_rrs[i].naptr.pref)
522 && context.naptr_rrs[k].sort_pos < context.naptr_rrs[i].sort_pos)){
523 z = context.naptr_rrs[k].sort_pos;
524 context.naptr_rrs[k].sort_pos = context.naptr_rrs[i].sort_pos;
525 context.naptr_rrs[i].sort_pos = z;
530 for (k=0; k<context.naptr_rrs_count; k++) {
531 if (context.naptr_rrs[k].sort_pos == context.position-1) {
532 ast_copy_string(context.dst, context.naptr_rrs[k].result, dstlen);
533 ast_copy_string(context.tech, context.naptr_rrs[k].tech, techlen);
537 } else if (!(context.options & ENUMLOOKUP_OPTIONS_COUNT)) {
541 ret |= ast_autoservice_stop(chan);
543 for (k=0; k<context.naptr_rrs_count; k++) {
544 free(context.naptr_rrs[k].result);
545 free(context.naptr_rrs[k].tech);
548 free(context.naptr_rrs);
553 /*! \brief Get TXT record from DNS.
554 Really has nothing to do with enum, but anyway...
556 int ast_get_txt(struct ast_channel *chan, const char *number, char *dst, int dstlen, char *tech, int techlen, char *txt, int txtlen)
558 struct enum_context context;
560 char naptrinput[512] = "+";
561 int pos = strlen(number) - 1;
564 struct enum_search *s = NULL;
567 strncat(naptrinput, number, sizeof(naptrinput) - 2);
569 context.naptrinput = naptrinput;
571 context.dstlen = dstlen;
573 context.techlen = techlen;
575 context.txtlen = txtlen;
580 tmp[newpos++] = number[pos--];
584 if (chan && ast_autoservice_start(chan) < 0)
588 ast_mutex_lock(&enumlock);
589 if (version != enumver) {
590 /* Ooh, a reload... */
597 ast_copy_string(tmp + newpos, s->toplev, sizeof(tmp) - newpos);
599 ast_mutex_unlock(&enumlock);
603 ret = ast_search_dns(&context, tmp, C_IN, T_TXT, txt_callback);
608 if (option_debug > 1)
609 ast_log(LOG_DEBUG, "No such number found in ENUM: %s (%s)\n", tmp, strerror(errno));
613 ret |= ast_autoservice_stop(chan);
617 /*! \brief Add enum tree to linked list */
618 static struct enum_search *enum_newtoplev(char *s)
620 struct enum_search *tmp;
622 if ((tmp = ast_calloc(1, sizeof(*tmp)))) {
623 ast_copy_string(tmp->toplev, s, sizeof(tmp->toplev));
628 /*! \brief Initialize the ENUM support subsystem */
629 int ast_enum_init(void)
631 struct ast_config *cfg;
632 struct enum_search *s, *sl;
633 struct ast_variable *v;
635 /* Destroy existing list */
636 ast_mutex_lock(&enumlock);
644 cfg = ast_config_load("enum.conf");
647 v = ast_variable_browse(cfg, "general");
649 if (!strcasecmp(v->name, "search")) {
650 s = enum_newtoplev(v->value);
661 ast_config_destroy(cfg);
663 toplevs = enum_newtoplev(TOPLEV);
666 ast_mutex_unlock(&enumlock);
670 int ast_enum_reload(void)
672 return ast_enum_init();