Wed Oct 28 11:52:43 2009

Asterisk developer's documentation


iax2-provision.h File Reference

IAX2 Provisioning protocol. More...

#include "iax2-parser.h"

Include dependency graph for iax2-provision.h:

This graph shows which files directly or indirectly include this file:

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 176 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().

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

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

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

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

Referenced by dump_prov_flags(), and iax_show_provisioning().

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

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

Definition at line 206 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().

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

int iax_provision_reload ( int  reload  ) 

Definition at line 522 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_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().

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

int iax_provision_unload ( void   ) 

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

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

Referenced by __unload_module().

00514 {
00515    provinit = 0;
00516    ast_cli_unregister_multiple(cli_iax2_provision, sizeof(cli_iax2_provision) / sizeof(struct ast_cli_entry));
00517    iax_provision_free_templates(0 /* Remove all templates. */);
00518 
00519    return 0;
00520 }

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

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

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

Referenced by check_provisioning().

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


Generated on Wed Oct 28 11:52:43 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6