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