Mon Oct 8 12:39:23 2012

Asterisk developer's documentation


iax2-provision.h File Reference

IAX2 Provisioning protocol. More...

#include "iax2-parser.h"

Go to the source code of this file.

Defines

#define PROV_FLAG_DEBUG   (1 << 3)
#define PROV_FLAG_DIS_CALLERID   (1 << 4)
#define PROV_FLAG_DIS_CALLWAIT   (1 << 5)
#define PROV_FLAG_DIS_CIDCW   (1 << 6)
#define PROV_FLAG_DIS_THREEWAY   (1 << 7)
#define PROV_FLAG_HEARTBEAT   (1 << 2)
#define PROV_FLAG_REGISTER   (1 << 0)
#define PROV_FLAG_SECURE   (1 << 1)
#define PROV_IE_AESKEY   14
#define PROV_IE_ALTSERVER   19
#define PROV_IE_FLAGS   12
#define PROV_IE_FORMAT   13
#define PROV_IE_GATEWAY   4
#define PROV_IE_IPADDR   2
#define PROV_IE_LANG   10
#define PROV_IE_NEWAESKEY   17
#define PROV_IE_PASS   7
#define PROV_IE_PORTNO   5
#define PROV_IE_PROVVER   18
#define PROV_IE_SERVERIP   15
#define PROV_IE_SERVERPASS   9
#define PROV_IE_SERVERPORT   16
#define PROV_IE_SERVERUSER   8
#define PROV_IE_SUBNET   3
#define PROV_IE_TOS   11
#define PROV_IE_USEDHCP   1
#define PROV_IE_USER   6

Functions

char * iax_prov_complete_template (const char *line, const char *word, int pos, int state)
char * iax_provflags2str (char *buf, int buflen, unsigned int flags)
int iax_provision_build (struct iax_ie_data *provdata, unsigned int *signature, const char *template, int force)
int iax_provision_reload (int reload)
int iax_provision_unload (void)
int iax_provision_version (unsigned int *signature, const char *template, int force)


Detailed Description

IAX2 Provisioning protocol.

Definition in file iax2-provision.h.


Define Documentation

#define PROV_FLAG_DEBUG   (1 << 3)

Definition at line 41 of file iax2-provision.h.

#define PROV_FLAG_DIS_CALLERID   (1 << 4)

Definition at line 43 of file iax2-provision.h.

#define PROV_FLAG_DIS_CALLWAIT   (1 << 5)

Definition at line 44 of file iax2-provision.h.

#define PROV_FLAG_DIS_CIDCW   (1 << 6)

Definition at line 45 of file iax2-provision.h.

#define PROV_FLAG_DIS_THREEWAY   (1 << 7)

Definition at line 46 of file iax2-provision.h.

#define PROV_FLAG_HEARTBEAT   (1 << 2)

Definition at line 40 of file iax2-provision.h.

#define PROV_FLAG_REGISTER   (1 << 0)

Definition at line 38 of file iax2-provision.h.

#define PROV_FLAG_SECURE   (1 << 1)

Definition at line 39 of file iax2-provision.h.

#define PROV_IE_AESKEY   14

Definition at line 31 of file iax2-provision.h.

#define PROV_IE_ALTSERVER   19

Definition at line 36 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_FLAGS   12

Definition at line 29 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_FORMAT   13

Definition at line 30 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_GATEWAY   4

Definition at line 21 of file iax2-provision.h.

#define PROV_IE_IPADDR   2

Definition at line 19 of file iax2-provision.h.

#define PROV_IE_LANG   10

Definition at line 27 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_NEWAESKEY   17

Definition at line 34 of file iax2-provision.h.

#define PROV_IE_PASS   7

Definition at line 24 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_PORTNO   5

Definition at line 22 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_PROVVER   18

Definition at line 35 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_SERVERIP   15

Definition at line 32 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_SERVERPASS   9

Definition at line 26 of file iax2-provision.h.

#define PROV_IE_SERVERPORT   16

Definition at line 33 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_SERVERUSER   8

Definition at line 25 of file iax2-provision.h.

#define PROV_IE_SUBNET   3

Definition at line 20 of file iax2-provision.h.

#define PROV_IE_TOS   11

Definition at line 28 of file iax2-provision.h.

Referenced by iax_provision_build().

#define PROV_IE_USEDHCP   1

Definition at line 18 of file iax2-provision.h.

#define PROV_IE_USER   6

Definition at line 23 of file iax2-provision.h.

Referenced by iax_provision_build().


Function Documentation

char* iax_prov_complete_template ( const char *  line,
const char *  word,
int  pos,
int  state 
)

Definition at line 178 of file iax2-provision.c.

References AST_LIST_TRAVERSE, ast_mutex_lock, ast_mutex_unlock, ast_strdup, iax_template::list, iax_template::name, and provlock.

Referenced by handle_cli_iax2_provision(), and iax_show_provisioning().

00179 {
00180    struct iax_template *c;
00181    int which=0;
00182    char *ret = NULL;
00183    int wordlen = strlen(word);
00184 
00185    if (pos == 3) {
00186       ast_mutex_lock(&provlock);
00187       AST_LIST_TRAVERSE(&templates, c, list) {
00188          if (!strncasecmp(word, c->name, wordlen) && ++which > state) {
00189             ret = ast_strdup(c->name);
00190             break;
00191          }
00192       }
00193       ast_mutex_unlock(&provlock);
00194    }
00195    return ret;
00196 }

char* iax_provflags2str ( char *  buf,
int  buflen,
unsigned int  flags 
)

Definition at line 89 of file iax2-provision.c.

References ARRAY_LEN, ast_strlen_zero(), iax_flags, iax_template::name, and value.

Referenced by dump_prov_flags(), and iax_show_provisioning().

00090 {
00091    int x;
00092 
00093    if (!buf || buflen < 1)
00094       return NULL;
00095    
00096    buf[0] = '\0';
00097 
00098    for (x = 0; x < ARRAY_LEN(iax_flags); x++) {
00099       if (flags & iax_flags[x].value){
00100          strncat(buf, iax_flags[x].name, buflen - strlen(buf) - 1);
00101          strncat(buf, ",", buflen - strlen(buf) - 1);
00102       }
00103    }
00104 
00105    if (!ast_strlen_zero(buf)) 
00106       buf[strlen(buf) - 1] = '\0';
00107    else
00108       strncpy(buf, "none", buflen - 1);
00109 
00110    return buf;
00111 }

int iax_provision_build ( struct iax_ie_data provdata,
unsigned int *  signature,
const char *  template,
int  force 
)

Definition at line 208 of file iax2-provision.c.

References iax_template::altserver, ast_db_put(), ast_mutex_lock, ast_mutex_unlock, iax_template::flags, iax_template::format, iax_ie_append_byte(), iax_ie_append_int(), iax_ie_append_short(), iax_ie_append_str(), iax_template_find(), iax_template::lang, iax_template::pass, iax_template::port, PROV_IE_ALTSERVER, PROV_IE_FLAGS, PROV_IE_FORMAT, PROV_IE_LANG, PROV_IE_PASS, PROV_IE_PORTNO, PROV_IE_PROVVER, PROV_IE_SERVERIP, PROV_IE_SERVERPORT, PROV_IE_TOS, PROV_IE_USER, prov_ver_calc(), provlock, iax_template::server, iax_template::serverport, iax_template::tos, and iax_template::user.

Referenced by iax2_provision(), and iax_provision_version().

00209 {
00210    struct iax_template *cur;
00211    unsigned int sig;
00212    char tmp[40];
00213    memset(provdata, 0, sizeof(*provdata));
00214    ast_mutex_lock(&provlock);
00215    cur = iax_template_find(template, 1);
00216    /* If no match, try searching for '*' */
00217    if (!cur)
00218       cur = iax_template_find("*", 1);
00219    if (cur) {
00220       /* found it -- add information elements as appropriate */
00221       if (force || strlen(cur->user))
00222          iax_ie_append_str(provdata, PROV_IE_USER, cur->user);
00223       if (force || strlen(cur->pass))
00224          iax_ie_append_str(provdata, PROV_IE_PASS, cur->pass);
00225       if (force || strlen(cur->lang))
00226          iax_ie_append_str(provdata, PROV_IE_LANG, cur->lang);
00227       if (force || cur->port)
00228          iax_ie_append_short(provdata, PROV_IE_PORTNO, cur->port);
00229       if (force || cur->server)
00230          iax_ie_append_int(provdata, PROV_IE_SERVERIP, cur->server);
00231       if (force || cur->serverport)
00232          iax_ie_append_short(provdata, PROV_IE_SERVERPORT, cur->serverport);
00233       if (force || cur->altserver)
00234          iax_ie_append_int(provdata, PROV_IE_ALTSERVER, cur->altserver);
00235       if (force || cur->flags)
00236          iax_ie_append_int(provdata, PROV_IE_FLAGS, cur->flags);
00237       if (force || cur->format)
00238          iax_ie_append_int(provdata, PROV_IE_FORMAT, cur->format);
00239       if (force || cur->tos)
00240          iax_ie_append_byte(provdata, PROV_IE_TOS, cur->tos);
00241       
00242       /* Calculate checksum of message so far */
00243       sig = prov_ver_calc(provdata);
00244       if (signature)
00245          *signature = sig;
00246       /* Store signature */
00247       iax_ie_append_int(provdata, PROV_IE_PROVVER, sig);
00248       /* Cache signature for later verification so we need not recalculate all this */
00249       snprintf(tmp, sizeof(tmp), "v0x%08x", sig);
00250       ast_db_put("iax/provisioning/cache", template, tmp);
00251    } else
00252       ast_db_put("iax/provisioning/cache", template, "u");
00253    ast_mutex_unlock(&provlock);
00254    return cur ? 0 : -1;
00255 }

int iax_provision_reload ( int  reload  ) 

Definition at line 528 of file iax2-provision.c.

References ast_category_browse(), ast_config_destroy(), ast_config_load2(), ast_db_deltree(), AST_LIST_TRAVERSE, ast_log(), ast_verb, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, iax_template::dead, iax_process_template(), iax_provision_free_templates(), iax_provision_init(), iax_template::list, and LOG_NOTICE.

Referenced by load_module(), and reload_config().

00529 {
00530    struct ast_config *cfg;
00531    struct iax_template *cur;
00532    char *cat;
00533    int found = 0;
00534    struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
00535    if (!provinit)
00536       iax_provision_init();
00537    
00538    cfg = ast_config_load2("iaxprov.conf", "chan_iax2", config_flags);
00539    if (cfg != NULL && cfg != CONFIG_STATUS_FILEUNCHANGED && cfg != CONFIG_STATUS_FILEINVALID) {
00540       /* Mark all as dead.  No need for locking */
00541       AST_LIST_TRAVERSE(&templates, cur, list) {
00542          cur->dead = 1;
00543       }
00544 
00545       /* Load as appropriate */
00546       cat = ast_category_browse(cfg, NULL);
00547       while(cat) {
00548          if (strcasecmp(cat, "general")) {
00549             iax_process_template(cfg, cat, found ? "default" : NULL);
00550             found++;
00551             ast_verb(3, "Loaded provisioning template '%s'\n", cat);
00552          }
00553          cat = ast_category_browse(cfg, cat);
00554       }
00555       ast_config_destroy(cfg);
00556    } else if (cfg == CONFIG_STATUS_FILEUNCHANGED)
00557       return 0;
00558    else
00559       ast_log(LOG_NOTICE, "No IAX provisioning configuration found, IAX provisioning disabled.\n");
00560 
00561    iax_provision_free_templates(1 /* remove only marked as dead */);
00562 
00563    /* Purge cached signature DB entries */
00564    ast_db_deltree("iax/provisioning/cache", NULL);
00565    return 0;
00566 }

int iax_provision_unload ( void   ) 

Definition at line 519 of file iax2-provision.c.

References ast_cli_unregister_multiple(), cli_iax2_provision, and iax_provision_free_templates().

Referenced by __unload_module().

00520 {
00521    provinit = 0;
00522    ast_cli_unregister_multiple(cli_iax2_provision, sizeof(cli_iax2_provision) / sizeof(struct ast_cli_entry));
00523    iax_provision_free_templates(0 /* Remove all templates. */);
00524 
00525    return 0;
00526 }

int iax_provision_version ( unsigned int *  signature,
const char *  template,
int  force 
)

Definition at line 257 of file iax2-provision.c.

References ast_db_get(), ast_debug, ast_log(), ast_mutex_lock, ast_mutex_unlock, iax_provision_build(), LOG_ERROR, and provlock.

Referenced by check_provisioning().

00258 {
00259    char tmp[80] = "";
00260    struct iax_ie_data ied;
00261    int ret=0;
00262    memset(&ied, 0, sizeof(ied));
00263 
00264    ast_mutex_lock(&provlock);
00265    if (!(ast_db_get("iax/provisioning/cache", template, tmp, sizeof(tmp)))) {
00266       ast_log(LOG_ERROR, "ast_db_get failed to retrieve iax/provisioning/cache\n");
00267       ast_mutex_unlock(&provlock);
00268       return -1;
00269    }
00270    if (sscanf(tmp, "v%30x", version) != 1) {
00271       if (strcmp(tmp, "u")) {
00272          ret = iax_provision_build(&ied, version, template, force);
00273          if (ret)
00274             ast_debug(1, "Unable to create provisioning packet for '%s'\n", template);
00275       } else
00276          ret = -1;
00277    } else
00278       ast_debug(1, "Retrieved cached version '%s' = '%08x'\n", tmp, *version);
00279    ast_mutex_unlock(&provlock);
00280    return ret;
00281 }


Generated on Mon Oct 8 12:39:23 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7