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