Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

res_pjsip: Fix pjsip.conf type=global object default value handling.

Browse Source 
When a type=global section is not defined in pjsip.conf the global
defaults are not applied.  As a result the mandatory Max-Forwards header
is not added to SIP messages for res_pjsip/chan_pjsip.

The handling of pjsip.conf type=global objects has several problems:

1) If the global object is missing the defaults are not applied.

2) If the global object is missing the default_outbound_endpoint's default
value is not returned by ast_sip_global_default_outbound_endpoint().

3) Defines are needed so default values only need to be changed in one
place.

* Added a sorcery instance observer callback to check if there were any
type=global sections loaded.  If there were more than one then issue an
error message.  If there were none then apply the global defaults.

* Fixed ast_sip_global_default_outbound_endpoint() to return the
documented default when no type=global object is defined.

* Made defines for the global default values.

* Increased the default_useragent[] size because SVN version strings can
get lengthy and 128 characters may not be enough.

* Fixed an off-nominal code path ref leak in global_alloc() if the string
fields fail to initialize.

* Eliminated RAII_VAR in get_global_cfg() and
ast_sip_global_default_outbound_endpoint().

ASTERISK-24807 #close
Reported by: Anatoli

Review: https://reviewboard.asterisk.org/r/4467/
........

Merged revisions 432766 from http://svn.asterisk.org/svn/asterisk/branches/13


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@432767 65c4cc65-6c06-0410-ace0-fbb531ad65f3
changes/42/42/1
Richard Mudgett 11 years ago
parent 185d2e082a
commit 89b65f5dda
3 changed files with 129 additions and 30 deletions
Show Stats Download Patch File Download Diff File

15
include/asterisk/res_pjsip.h
Unescape View File

@ -1627,8 +1627,23 @@ void ast_sip_destroy_global_headers(void);
int ast_sip_add_global_request_header(const char *name, const char *value, int replace); int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
int ast_sip_add_global_response_header(const char *name, const char *value, int replace); int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
/*!
* \brief Initialize global type on a sorcery instance
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_initialize_sorcery_global(void); int ast_sip_initialize_sorcery_global(void);
/*!
* \brief Destroy global type on a sorcery instance
* \since 13.3.0
*
* \retval -1 failure
* \retval 0 success
*/
int ast_sip_destroy_sorcery_global(void);
/*! /*!
* \brief Retrieves the value associated with the given key. * \brief Retrieves the value associated with the given key.
* *

143
res/res_pjsip/config_global.c
Unescape View File

@ -27,10 +27,13 @@
#include "asterisk/ast_version.h" #include "asterisk/ast_version.h"
#define DEFAULT_MAX_FORWARDS 70 #define DEFAULT_MAX_FORWARDS 70
#define DEFAULT_KEEPALIVE_INTERVAL 0
#define DEFAULT_USERAGENT_PREFIX "Asterisk PBX" #define DEFAULT_USERAGENT_PREFIX "Asterisk PBX"
#define DEFAULT_OUTBOUND_ENDPOINT "default_outbound_endpoint" #define DEFAULT_OUTBOUND_ENDPOINT "default_outbound_endpoint"
#define DEFAULT_DEBUG "no"
#define DEFAULT_ENDPOINT_IDENTIFIER_ORDER "ip,username,anonymous"
static char default_useragent[128]; static char default_useragent[256];
struct global_config { struct global_config {
SORCERY_OBJECT(details); SORCERY_OBJECT(details);
@ -57,9 +60,11 @@ static void global_destructor(void *obj)
static void *global_alloc(const char *name) static void *global_alloc(const char *name)
{ {
struct global_config *cfg = ast_sorcery_generic_alloc(sizeof(*cfg), global_destructor); struct global_config *cfg;
cfg = ast_sorcery_generic_alloc(sizeof(*cfg), global_destructor);
if (!cfg || ast_string_field_init(cfg, 100)) { if (!cfg || ast_string_field_init(cfg, 100)) {
ao2_cleanup(cfg);
return NULL; return NULL;
} }
@ -81,78 +86,148 @@ static int global_apply(const struct ast_sorcery *sorcery, void *obj)
static struct global_config *get_global_cfg(void) static struct global_config *get_global_cfg(void)
{ {
RAII_VAR(struct ao2_container *, globals, ast_sorcery_retrieve_by_fields( struct global_config *cfg;
ast_sip_get_sorcery(), "global", AST_RETRIEVE_FLAG_MULTIPLE, struct ao2_container *globals;
NULL), ao2_cleanup);
globals = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "global",
AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
if (!globals) { if (!globals) {
return NULL; return NULL;
} }
return ao2_find(globals, NULL, 0); cfg = ao2_find(globals, NULL, 0);
ao2_ref(globals, -1);
return cfg;
} }
char *ast_sip_global_default_outbound_endpoint(void) char *ast_sip_global_default_outbound_endpoint(void)
{ {
RAII_VAR(struct global_config *, cfg, get_global_cfg(), ao2_cleanup); char *str;
struct global_config *cfg;
cfg = get_global_cfg();
if (!cfg) { if (!cfg) {
return NULL; return ast_strdup(DEFAULT_OUTBOUND_ENDPOINT);
} }
return ast_strdup(cfg->default_outbound_endpoint); str = ast_strdup(cfg->default_outbound_endpoint);
ao2_ref(cfg, -1);
return str;
} }
char *ast_sip_get_debug(void) char *ast_sip_get_debug(void)
{ {
char *res; char *res;
struct global_config *cfg = get_global_cfg(); struct global_config *cfg;
cfg = get_global_cfg();
if (!cfg) { if (!cfg) {
return ast_strdup("no"); return ast_strdup(DEFAULT_DEBUG);
} }
res = ast_strdup(cfg->debug); res = ast_strdup(cfg->debug);
ao2_ref(cfg, -1); ao2_ref(cfg, -1);
return res; return res;
} }
char *ast_sip_get_endpoint_identifier_order(void) char *ast_sip_get_endpoint_identifier_order(void)
{ {
char *res; char *res;
struct global_config *cfg = get_global_cfg(); struct global_config *cfg;
cfg = get_global_cfg();
if (!cfg) { if (!cfg) {
return ast_strdup("ip,username,anonymous"); return ast_strdup(DEFAULT_ENDPOINT_IDENTIFIER_ORDER);
} }
res = ast_strdup(cfg->endpoint_identifier_order); res = ast_strdup(cfg->endpoint_identifier_order);
ao2_ref(cfg, -1); ao2_ref(cfg, -1);
return res; return res;
} }
unsigned int ast_sip_get_keep_alive_interval(void) unsigned int ast_sip_get_keep_alive_interval(void)
{ {
unsigned int interval; unsigned int interval;
struct global_config *cfg = get_global_cfg(); struct global_config *cfg;
cfg = get_global_cfg();
if (!cfg) { if (!cfg) {
return 0; return DEFAULT_KEEPALIVE_INTERVAL;
} }
interval = cfg->keep_alive_interval; interval = cfg->keep_alive_interval;
ao2_ref(cfg, -1); ao2_ref(cfg, -1);
return interval; return interval;
} }
/*!
* \internal
* \brief Observer to set default global object if none exist.
*
* \param name Module name owning the sorcery instance.
* \param sorcery Instance being observed.
* \param object_type Name of object being observed.
* \param reloaded Non-zero if the object is being reloaded.
*
* \return Nothing
*/
static void global_loaded_observer(const char *name, const struct ast_sorcery *sorcery, const char *object_type, int reloaded)
{
struct ao2_container *globals;
struct global_config *cfg;
if (strcmp(object_type, "global")) {
/* Not interested */
return;
}
globals = ast_sorcery_retrieve_by_fields(sorcery, "global",
AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
if (globals) {
int count;
count = ao2_container_count(globals);
ao2_ref(globals, -1);
if (1 < count) {
ast_log(LOG_ERROR,
"At most one pjsip.conf type=global object can be defined. You have %d defined.\n",
count);
return;
}
if (count) {
return;
}
}
ast_debug(1, "No pjsip.conf type=global object exists so applying defaults.\n");
cfg = ast_sorcery_alloc(sorcery, "global", NULL);
if (!cfg) {
return;
}
global_apply(sorcery, cfg);
ao2_ref(cfg, -1);
}
static const struct ast_sorcery_instance_observer observer_callbacks_global = {
.object_type_loaded = global_loaded_observer,
};
int ast_sip_destroy_sorcery_global(void)
{
struct ast_sorcery *sorcery = ast_sip_get_sorcery();
ast_sorcery_instance_observer_remove(sorcery, &observer_callbacks_global);
return 0;
}
int ast_sip_initialize_sorcery_global(void) int ast_sip_initialize_sorcery_global(void)
{ {
struct ast_sorcery *sorcery = ast_sip_get_sorcery(); struct ast_sorcery *sorcery = ast_sip_get_sorcery();
snprintf(default_useragent, sizeof(default_useragent), "%s %s", DEFAULT_USERAGENT_PREFIX, ast_get_version()); snprintf(default_useragent, sizeof(default_useragent), "%s %s",
DEFAULT_USERAGENT_PREFIX, ast_get_version());
ast_sorcery_apply_default(sorcery, "global", "config", "pjsip.conf,criteria=type=global"); ast_sorcery_apply_default(sorcery, "global", "config", "pjsip.conf,criteria=type=global");
@ -161,18 +236,26 @@ int ast_sip_initialize_sorcery_global(void)
} }
ast_sorcery_object_field_register(sorcery, "global", "type", "", OPT_NOOP_T, 0, 0); ast_sorcery_object_field_register(sorcery, "global", "type", "", OPT_NOOP_T, 0, 0);
ast_sorcery_object_field_register(sorcery, "global", "max_forwards", __stringify(DEFAULT_MAX_FORWARDS), ast_sorcery_object_field_register(sorcery, "global", "max_forwards",
OPT_UINT_T, 0, FLDSET(struct global_config, max_forwards)); __stringify(DEFAULT_MAX_FORWARDS),
OPT_UINT_T, 0, FLDSET(struct global_config, max_forwards));
ast_sorcery_object_field_register(sorcery, "global", "user_agent", default_useragent, ast_sorcery_object_field_register(sorcery, "global", "user_agent", default_useragent,
OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, useragent)); OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, useragent));
ast_sorcery_object_field_register(sorcery, "global", "default_outbound_endpoint", DEFAULT_OUTBOUND_ENDPOINT, ast_sorcery_object_field_register(sorcery, "global", "default_outbound_endpoint",
OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, default_outbound_endpoint)); DEFAULT_OUTBOUND_ENDPOINT,
ast_sorcery_object_field_register(sorcery, "global", "debug", "no", OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, default_outbound_endpoint));
OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, debug)); ast_sorcery_object_field_register(sorcery, "global", "debug", DEFAULT_DEBUG,
ast_sorcery_object_field_register(sorcery, "global", "endpoint_identifier_order", "ip,username,anonymous", OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, debug));
OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, endpoint_identifier_order)); ast_sorcery_object_field_register(sorcery, "global", "endpoint_identifier_order",
ast_sorcery_object_field_register(sorcery, "global", "keep_alive_interval", "", DEFAULT_ENDPOINT_IDENTIFIER_ORDER,
OPT_UINT_T, 0, FLDSET(struct global_config, keep_alive_interval)); OPT_STRINGFIELD_T, 0, STRFLDSET(struct global_config, endpoint_identifier_order));
ast_sorcery_object_field_register(sorcery, "global", "keep_alive_interval",
__stringify(DEFAULT_KEEPALIVE_INTERVAL),
OPT_UINT_T, 0, FLDSET(struct global_config, keep_alive_interval));
if (ast_sorcery_instance_observer_add(sorcery, &observer_callbacks_global)) {
return -1;
}
return 0; return 0;
} }

1
res/res_pjsip/pjsip_configuration.c
Unescape View File

@ -1842,6 +1842,7 @@ int ast_res_pjsip_initialize_configuration(const struct ast_module_info *ast_mod
void ast_res_pjsip_destroy_configuration(void) void ast_res_pjsip_destroy_configuration(void)
{ {
ast_sip_destroy_sorcery_global();
ast_sip_destroy_sorcery_location(); ast_sip_destroy_sorcery_location();
ast_sip_destroy_sorcery_auth(); ast_sip_destroy_sorcery_auth();
ast_sip_destroy_sorcery_transport(); ast_sip_destroy_sorcery_transport();

Write Preview
Loading…
Cancel
Save