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