Set peer context and exten values so MACRO_EXTEN and MACRO_CONTEXT will be set
[asterisk/asterisk.git] / channels / iax2-provision.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  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * 
21  * \brief IAX Provisioning Protocol 
22  *
23  * \author Mark Spencer <markster@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <netdb.h>
31 #include <netinet/in.h>
32 #include <netinet/in_systm.h>
33 #include <netinet/ip.h>
34 #include <sys/socket.h>
35
36 #include "asterisk/config.h"
37 #include "asterisk/cli.h"
38 #include "asterisk/lock.h"
39 #include "asterisk/frame.h"
40 #include "asterisk/md5.h"
41 #include "asterisk/astdb.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/acl.h"
44 #include "iax2.h"
45 #include "iax2-provision.h"
46 #include "iax2-parser.h"
47
48 static int provinit = 0;
49
50 struct iax_template {
51         int dead;
52         char name[80];
53         char src[80];
54         char user[20];
55         char pass[20];
56         char lang[10];
57         unsigned short port;
58         unsigned int server;
59         unsigned short serverport;
60         unsigned int altserver;
61         unsigned int flags;
62         unsigned int format;
63         unsigned int tos;
64         AST_LIST_ENTRY(iax_template) list;
65 };
66
67 static AST_LIST_HEAD_NOLOCK_STATIC(templates, iax_template);
68
69 AST_MUTEX_DEFINE_STATIC(provlock);
70
71 static struct iax_flag {
72         char *name;
73         int value;
74 } iax_flags[] = {
75         { "register", PROV_FLAG_REGISTER },
76         { "secure", PROV_FLAG_SECURE },
77         { "heartbeat", PROV_FLAG_HEARTBEAT },
78         { "debug", PROV_FLAG_DEBUG },
79         { "disablecid", PROV_FLAG_DIS_CALLERID },
80         { "disablecw", PROV_FLAG_DIS_CALLWAIT },
81         { "disablecidcw", PROV_FLAG_DIS_CIDCW },
82         { "disable3way", PROV_FLAG_DIS_THREEWAY },
83 };
84
85 char *iax_provflags2str(char *buf, int buflen, unsigned int flags)
86 {
87         int x;
88
89         if (!buf || buflen < 1)
90                 return NULL;
91         
92         buf[0] = '\0';
93
94         for (x = 0; x < ARRAY_LEN(iax_flags); x++) {
95                 if (flags & iax_flags[x].value){
96                         strncat(buf, iax_flags[x].name, buflen - strlen(buf) - 1);
97                         strncat(buf, ",", buflen - strlen(buf) - 1);
98                 }
99         }
100
101         if (!ast_strlen_zero(buf)) 
102                 buf[strlen(buf) - 1] = '\0';
103         else
104                 strncpy(buf, "none", buflen - 1);
105
106         return buf;
107 }
108
109 static unsigned int iax_str2flags(const char *buf)
110 {
111         int x;
112         int len;
113         int found;
114         unsigned int flags = 0;
115         char *e;
116         while(buf && *buf) {
117                 e = strchr(buf, ',');
118                 if (e)
119                         len = e - buf;
120                 else
121                         len = 0;
122                 found = 0;
123                 for (x = 0; x < ARRAY_LEN(iax_flags); x++) {
124                         if ((len && !strncasecmp(iax_flags[x].name, buf, len)) ||
125                             (!len && !strcasecmp(iax_flags[x].name, buf))) {
126                                 flags |= iax_flags[x].value;
127                                 break;
128                         }
129                 }
130                 if (e) {
131                         buf = e + 1;
132                         while(*buf && (*buf < 33))
133                                 buf++;
134                 } else
135                         break;
136         }
137         return flags;
138 }
139
140 static void iax_template_copy(struct iax_template *dst, struct iax_template *src)
141 {
142         if (!dst || !src) {
143                 return;
144         }
145
146         dst->dead = src->dead;
147         ast_copy_string(dst->name, src->name, sizeof(dst->name));
148         ast_copy_string(dst->src, src->src, sizeof(dst->src));
149         ast_copy_string(dst->user, src->user, sizeof(dst->user));
150         ast_copy_string(dst->pass, src->pass, sizeof(dst->pass));
151         ast_copy_string(dst->lang, src->lang, sizeof(dst->lang));
152         dst->port = src->port;
153         dst->server = src->server;
154         dst->altserver = src->altserver;
155         dst->flags = src->flags;
156         dst->format = src->format;
157         dst->tos = src->tos;
158 }
159
160 static struct iax_template *iax_template_find(const char *s, int allowdead)
161 {
162         struct iax_template *cur;
163
164         AST_LIST_TRAVERSE(&templates, cur, list) {
165                 if (!strcasecmp(s, cur->name)) {
166                         if (!allowdead && cur->dead) {
167                                 cur = NULL;
168                         }
169                         break;
170                 }
171         }
172
173         return cur;
174 }
175
176 char *iax_prov_complete_template(const char *line, const char *word, int pos, int state)
177 {
178         struct iax_template *c;
179         int which=0;
180         char *ret = NULL;
181         int wordlen = strlen(word);
182
183         if (pos == 3) {
184                 ast_mutex_lock(&provlock);
185                 AST_LIST_TRAVERSE(&templates, c, list) {
186                         if (!strncasecmp(word, c->name, wordlen) && ++which > state) {
187                                 ret = ast_strdup(c->name);
188                                 break;
189                         }
190                 }
191                 ast_mutex_unlock(&provlock);
192         }
193         return ret;
194 }
195
196 static unsigned int prov_ver_calc(struct iax_ie_data *provdata)
197 {
198         struct MD5Context md5;
199         unsigned int tmp[4];
200         MD5Init(&md5);
201         MD5Update(&md5, provdata->buf, provdata->pos);
202         MD5Final((unsigned char *)tmp, &md5);
203         return tmp[0] ^ tmp[1] ^ tmp[2] ^ tmp[3];
204 }
205
206 int iax_provision_build(struct iax_ie_data *provdata, unsigned int *signature, const char *template, int force)
207 {
208         struct iax_template *cur;
209         unsigned int sig;
210         char tmp[40];
211         memset(provdata, 0, sizeof(*provdata));
212         ast_mutex_lock(&provlock);
213         cur = iax_template_find(template, 1);
214         /* If no match, try searching for '*' */
215         if (!cur)
216                 cur = iax_template_find("*", 1);
217         if (cur) {
218                 /* found it -- add information elements as appropriate */
219                 if (force || strlen(cur->user))
220                         iax_ie_append_str(provdata, PROV_IE_USER, cur->user);
221                 if (force || strlen(cur->pass))
222                         iax_ie_append_str(provdata, PROV_IE_PASS, cur->pass);
223                 if (force || strlen(cur->lang))
224                         iax_ie_append_str(provdata, PROV_IE_LANG, cur->lang);
225                 if (force || cur->port)
226                         iax_ie_append_short(provdata, PROV_IE_PORTNO, cur->port);
227                 if (force || cur->server)
228                         iax_ie_append_int(provdata, PROV_IE_SERVERIP, cur->server);
229                 if (force || cur->serverport)
230                         iax_ie_append_short(provdata, PROV_IE_SERVERPORT, cur->serverport);
231                 if (force || cur->altserver)
232                         iax_ie_append_int(provdata, PROV_IE_ALTSERVER, cur->altserver);
233                 if (force || cur->flags)
234                         iax_ie_append_int(provdata, PROV_IE_FLAGS, cur->flags);
235                 if (force || cur->format)
236                         iax_ie_append_int(provdata, PROV_IE_FORMAT, cur->format);
237                 if (force || cur->tos)
238                         iax_ie_append_byte(provdata, PROV_IE_TOS, cur->tos);
239                 
240                 /* Calculate checksum of message so far */
241                 sig = prov_ver_calc(provdata);
242                 if (signature)
243                         *signature = sig;
244                 /* Store signature */
245                 iax_ie_append_int(provdata, PROV_IE_PROVVER, sig);
246                 /* Cache signature for later verification so we need not recalculate all this */
247                 snprintf(tmp, sizeof(tmp), "v0x%08x", sig);
248                 ast_db_put("iax/provisioning/cache", template, tmp);
249         } else
250                 ast_db_put("iax/provisioning/cache", template, "u");
251         ast_mutex_unlock(&provlock);
252         return cur ? 0 : -1;
253 }
254
255 int iax_provision_version(unsigned int *version, const char *template, int force)
256 {
257         char tmp[80] = "";
258         struct iax_ie_data ied;
259         int ret=0;
260         memset(&ied, 0, sizeof(ied));
261
262         ast_mutex_lock(&provlock);
263         ast_db_get("iax/provisioning/cache", template, tmp, sizeof(tmp));
264         if (sscanf(tmp, "v%x", version) != 1) {
265                 if (strcmp(tmp, "u")) {
266                         ret = iax_provision_build(&ied, version, template, force);
267                         if (ret)
268                                 ast_debug(1, "Unable to create provisioning packet for '%s'\n", template);
269                 } else
270                         ret = -1;
271         } else
272                 ast_debug(1, "Retrieved cached version '%s' = '%08x'\n", tmp, *version);
273         ast_mutex_unlock(&provlock);
274         return ret;
275 }
276
277 static int iax_template_parse(struct iax_template *cur, struct ast_config *cfg, const char *s, const char *def)
278 {
279         struct ast_variable *v;
280         int foundportno = 0;
281         int foundserverportno = 0;
282         int x;
283         struct in_addr ia;
284         struct hostent *hp;
285         struct ast_hostent h;
286         struct iax_template *src, tmp;
287         const char *t;
288         if (def) {
289                 t = ast_variable_retrieve(cfg, s ,"template");
290                 src = NULL;
291                 if (t && strlen(t)) {
292                         src = iax_template_find(t, 0);
293                         if (!src)
294                                 ast_log(LOG_WARNING, "Unable to find base template '%s' for creating '%s'.  Trying '%s'\n", t, s, def);
295                         else
296                                 def = t;
297                 } 
298                 if (!src) {
299                         src = iax_template_find(def, 0);
300                         if (!src)
301                                 ast_log(LOG_WARNING, "Unable to locate default base template '%s' for creating '%s', omitting.\n", def, s);
302                 }
303                 if (!src)
304                         return -1;
305                 ast_mutex_lock(&provlock);
306                 /* Backup old data */
307                 iax_template_copy(&tmp, cur);
308                 /* Restore from src */
309                 iax_template_copy(cur, src);
310                 /* Restore important headers */
311                 memcpy(cur->name, tmp.name, sizeof(cur->name));
312                 cur->dead = tmp.dead;
313                 ast_mutex_unlock(&provlock);
314         }
315         if (def)
316                 strncpy(cur->src, def, sizeof(cur->src) - 1);
317         else
318                 cur->src[0] = '\0';
319         v = ast_variable_browse(cfg, s);
320         while(v) {
321                 if (!strcasecmp(v->name, "port") || !strcasecmp(v->name, "serverport")) {
322                         if ((sscanf(v->value, "%d", &x) == 1) && (x > 0) && (x < 65535)) {
323                                 if (!strcasecmp(v->name, "port")) {
324                                         cur->port = x;
325                                         foundportno = 1;
326                                 } else {
327                                         cur->serverport = x;
328                                         foundserverportno = 1;
329                                 }
330                         } else
331                                 ast_log(LOG_WARNING, "Ignoring invalid %s '%s' for '%s' at line %d\n", v->name, v->value, s, v->lineno);
332                 } else if (!strcasecmp(v->name, "server") || !strcasecmp(v->name, "altserver")) {
333                         hp = ast_gethostbyname(v->value, &h);
334                         if (hp) {
335                                 memcpy(&ia, hp->h_addr, sizeof(ia));
336                                 if (!strcasecmp(v->name, "server"))
337                                         cur->server = ntohl(ia.s_addr);
338                                 else
339                                         cur->altserver = ntohl(ia.s_addr);
340                         } else 
341                                 ast_log(LOG_WARNING, "Ignoring invalid %s '%s' for '%s' at line %d\n", v->name, v->value, s, v->lineno);
342                 } else if (!strcasecmp(v->name, "codec")) {
343                         if ((x = ast_getformatbyname(v->value)) > 0) {
344                                 cur->format = x;
345                         } else
346                                 ast_log(LOG_WARNING, "Ignoring invalid codec '%s' for '%s' at line %d\n", v->value, s, v->lineno);
347                 } else if (!strcasecmp(v->name, "tos")) {
348                         if (ast_str2tos(v->value, &cur->tos))
349                                 ast_log(LOG_WARNING, "Invalid tos value at line %d, refer to QoS documentation\n", v->lineno);
350                 } else if (!strcasecmp(v->name, "user")) {
351                         strncpy(cur->user, v->value, sizeof(cur->user) - 1);
352                         if (strcmp(cur->user, v->value))
353                                 ast_log(LOG_WARNING, "Truncating username from '%s' to '%s' for '%s' at line %d\n", v->value, cur->user, s, v->lineno);
354                 } else if (!strcasecmp(v->name, "pass")) {
355                         strncpy(cur->pass, v->value, sizeof(cur->pass) - 1);
356                         if (strcmp(cur->pass, v->value))
357                                 ast_log(LOG_WARNING, "Truncating password from '%s' to '%s' for '%s' at line %d\n", v->value, cur->pass, s, v->lineno);
358                 } else if (!strcasecmp(v->name, "language")) {
359                         strncpy(cur->lang, v->value, sizeof(cur->lang) - 1);
360                         if (strcmp(cur->lang, v->value))
361                                 ast_log(LOG_WARNING, "Truncating language from '%s' to '%s' for '%s' at line %d\n", v->value, cur->lang, s, v->lineno);
362                 } else if (!strcasecmp(v->name, "flags")) {
363                         cur->flags = iax_str2flags(v->value);
364                 } else if (!strncasecmp(v->name, "flags", 5) && strchr(v->name, '+')) {
365                         cur->flags |= iax_str2flags(v->value);
366                 } else if (!strncasecmp(v->name, "flags", 5) && strchr(v->name, '-')) {
367                         cur->flags &= ~iax_str2flags(v->value);
368                 } else if (strcasecmp(v->name, "template")) {
369                         ast_log(LOG_WARNING, "Unknown keyword '%s' in definition of '%s' at line %d\n", v->name, s, v->lineno);
370                 }
371                 v = v->next;
372         }
373         if (!foundportno)
374                 cur->port = IAX_DEFAULT_PORTNO;
375         if (!foundserverportno)
376                 cur->serverport = IAX_DEFAULT_PORTNO;
377         return 0;
378 }
379
380 static int iax_process_template(struct ast_config *cfg, char *s, char *def)
381 {
382         /* Find an already existing one if there */
383         struct iax_template *cur;
384         int mallocd = 0;
385
386         cur = iax_template_find(s, 1 /* allow dead */);
387         if (!cur) {
388                 mallocd = 1;
389                 cur = ast_calloc(1, sizeof(*cur));
390                 if (!cur) {
391                         ast_log(LOG_WARNING, "Out of memory!\n");
392                         return -1;
393                 }
394                 /* Initialize entry */
395                 strncpy(cur->name, s, sizeof(cur->name) - 1);
396                 cur->dead = 1;
397         }
398         if (!iax_template_parse(cur, cfg, s, def))
399                 cur->dead = 0;
400
401         /* Link if we're mallocd */
402         if (mallocd) {
403                 ast_mutex_lock(&provlock);
404                 AST_LIST_INSERT_HEAD(&templates, cur, list);
405                 ast_mutex_unlock(&provlock);
406         }
407         return 0;
408 }
409
410 static const char *ifthere(const char *s)
411 {
412         if (strlen(s))
413                 return s;
414         else
415                 return "<unspecified>";
416 }
417
418 static const char *iax_server(unsigned int addr)
419 {
420         struct in_addr ia;
421         
422         if (!addr)
423                 return "<unspecified>";
424         
425         ia.s_addr = htonl(addr);
426
427         return ast_inet_ntoa(ia);
428 }
429
430
431 static char *iax_show_provisioning(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
432 {
433         struct iax_template *cur;
434         char server[INET_ADDRSTRLEN];
435         char alternate[INET_ADDRSTRLEN];
436         char flags[80]; /* Has to be big enough for 'flags' too */
437         int found = 0;
438
439         switch (cmd) {
440         case CLI_INIT:
441                 e->command = "iax2 show provisioning";
442                 e->usage =
443                         "Usage: iax2 show provisioning [template]\n"
444                         "       Lists all known IAX provisioning templates or a\n"
445                         "       specific one if specified.\n";
446                 return NULL;
447         case CLI_GENERATE:
448                 return iax_prov_complete_template(a->line, a->word, a->pos, a->n);
449         }
450
451         if ((a->argc != 3) && (a->argc != 4))
452                 return CLI_SHOWUSAGE;
453
454         ast_mutex_lock(&provlock);
455         AST_LIST_TRAVERSE(&templates, cur, list) {
456                 if ((a->argc == 3) || (!strcasecmp(a->argv[3], cur->name)))  {
457                         if (found) 
458                                 ast_cli(a->fd, "\n");
459                         ast_copy_string(server, iax_server(cur->server), sizeof(server));
460                         ast_copy_string(alternate, iax_server(cur->altserver), sizeof(alternate));
461                         ast_cli(a->fd, "== %s ==\n", cur->name);
462                         ast_cli(a->fd, "Base Templ:   %s\n", strlen(cur->src) ? cur->src : "<none>");
463                         ast_cli(a->fd, "Username:     %s\n", ifthere(cur->user));
464                         ast_cli(a->fd, "Secret:       %s\n", ifthere(cur->pass));
465                         ast_cli(a->fd, "Language:     %s\n", ifthere(cur->lang));
466                         ast_cli(a->fd, "Bind Port:    %d\n", cur->port);
467                         ast_cli(a->fd, "Server:       %s\n", server);
468                         ast_cli(a->fd, "Server Port:  %d\n", cur->serverport);
469                         ast_cli(a->fd, "Alternate:    %s\n", alternate);
470                         ast_cli(a->fd, "Flags:        %s\n", iax_provflags2str(flags, sizeof(flags), cur->flags));
471                         ast_cli(a->fd, "Format:       %s\n", ast_getformatname(cur->format));
472                         ast_cli(a->fd, "TOS:          0x%x\n", cur->tos);
473                         found++;
474                 }
475         }
476         ast_mutex_unlock(&provlock);
477         if (!found) {
478                 if (a->argc == 3)
479                         ast_cli(a->fd, "No provisioning templates found\n");
480                 else
481                         ast_cli(a->fd, "No provisioning template matching '%s' found\n", a->argv[3]);
482         }
483         return CLI_SUCCESS;
484 }
485
486 static struct ast_cli_entry cli_iax2_provision[] = {
487         AST_CLI_DEFINE(iax_show_provisioning, "Display iax provisioning"),
488 };
489
490 static int iax_provision_init(void)
491 {
492         ast_cli_register_multiple(cli_iax2_provision, sizeof(cli_iax2_provision) / sizeof(struct ast_cli_entry));
493         provinit = 1;
494         return 0;
495 }
496
497 static void iax_provision_free_templates(int dead)
498 {
499         struct iax_template *cur;
500
501         /* Drop dead or not (depending on dead) entries while locked */
502         ast_mutex_lock(&provlock);
503         AST_LIST_TRAVERSE_SAFE_BEGIN(&templates, cur, list) {
504                 if ((dead && cur->dead) || !dead) {
505                         AST_LIST_REMOVE_CURRENT(list);
506                         ast_free(cur);
507                 }
508         }
509         AST_LIST_TRAVERSE_SAFE_END;
510         ast_mutex_unlock(&provlock);
511 }
512
513 int iax_provision_unload(void)
514 {
515         provinit = 0;
516         ast_cli_unregister_multiple(cli_iax2_provision, sizeof(cli_iax2_provision) / sizeof(struct ast_cli_entry));
517         iax_provision_free_templates(0 /* Remove all templates. */);
518
519         return 0;
520 }
521
522 int iax_provision_reload(int reload)
523 {
524         struct ast_config *cfg;
525         struct iax_template *cur;
526         char *cat;
527         int found = 0;
528         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
529         if (!provinit)
530                 iax_provision_init();
531         
532         cfg = ast_config_load2("iaxprov.conf", "chan_iax2", config_flags);
533         if (cfg != NULL && cfg != CONFIG_STATUS_FILEUNCHANGED && cfg != CONFIG_STATUS_FILEINVALID) {
534                 /* Mark all as dead.  No need for locking */
535                 AST_LIST_TRAVERSE(&templates, cur, list) {
536                         cur->dead = 1;
537                 }
538
539                 /* Load as appropriate */
540                 cat = ast_category_browse(cfg, NULL);
541                 while(cat) {
542                         if (strcasecmp(cat, "general")) {
543                                 iax_process_template(cfg, cat, found ? "default" : NULL);
544                                 found++;
545                                 ast_verb(3, "Loaded provisioning template '%s'\n", cat);
546                         }
547                         cat = ast_category_browse(cfg, cat);
548                 }
549                 ast_config_destroy(cfg);
550         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED)
551                 return 0;
552         else
553                 ast_log(LOG_NOTICE, "No IAX provisioning configuration found, IAX provisioning disabled.\n");
554
555         iax_provision_free_templates(1 /* remove only marked as dead */);
556
557         /* Purge cached signature DB entries */
558         ast_db_deltree("iax/provisioning/cache", NULL);
559         return 0;
560 }