STUN Network Monitor. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/event.h"
#include "asterisk/sched.h"
#include "asterisk/config.h"
#include "asterisk/stun.h"
#include "asterisk/netsock2.h"
#include "asterisk/lock.h"
#include <fcntl.h>

Include dependency graph for res_stun_monitor.c:

Go to the source code of this file.

Functions
static void	__reg_module (void)
static int	__reload (int startup)
static void	__unreg_module (void)
static int	load_config (int startup)
static int	load_module (void)
static int	reload (void)
static void	stun_close_sock (void)
static int	stun_monitor_request (const void *blarg)
static void	stun_purge_socket (void)
static int	stun_start_monitor (void)
static void	stun_stop_monitor (void)
static int	unload_module (void)
Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS \| AST_MODFLAG_LOAD_ORDER , .description = "STUN Network Monitor" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "7a1b8b48c852d7a7061c7e499b9bd0d2" , .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_CHANNEL_DEPEND }
struct {
struct sockaddr_in externaladdr
unsigned int externaladdr_known:1
ast_mutex_t lock
unsigned int monitor_enabled:1
unsigned int refresh
struct sockaddr_in stunaddr
int stunsock
}	args
static struct ast_module_info *	ast_module_info = &__mod_info
static const int	DEFAULT_MONITOR_REFRESH = 30
static struct ast_sched_thread *	sched
static const char	stun_conf_file [] = "res_stun_monitor.conf"

Detailed Description

STUN Network Monitor.

Author:: David Vossel <dvossel@digium.com>

Definition in file res_stun_monitor.c.

Function Documentation

static void __reg_module ( void ) [static]

Definition at line 310 of file res_stun_monitor.c.

static int __reload ( int startup ) [static]

Definition at line 259 of file res_stun_monitor.c.

References args, ast_mutex_lock, ast_mutex_unlock, load_config(), stun_start_monitor(), and stun_stop_monitor().

Referenced by load_module(), and reload().

{
   int res;

   ast_mutex_lock(&args.lock);
   if (!(res = load_config(startup)) && args.monitor_enabled) {
      res = stun_start_monitor();
   }
   ast_mutex_unlock(&args.lock);

   if ((res == -1) || !args.monitor_enabled) {
      args.monitor_enabled = 0;
      stun_stop_monitor();
   }

   return res;
}

static void __unreg_module ( void ) [static]

Definition at line 310 of file res_stun_monitor.c.

static int load_config ( int startup ) [static]

Definition at line 208 of file res_stun_monitor.c.

References args, ast_config_destroy(), ast_config_load2(), ast_log(), ast_parse_arg(), ast_set_flag, ast_variable_browse(), CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, DEFAULT_MONITOR_REFRESH, ast_variable::lineno, LOG_ERROR, LOG_NOTICE, LOG_WARNING, ast_variable::name, ast_variable::next, PARSE_INADDR, STANDARD_STUN_PORT, and ast_variable::value.

Referenced by __reload().

{
   struct ast_flags config_flags = { 0, };
   struct ast_config *cfg;
   struct ast_variable *v;

   if (!startup) {
      ast_set_flag(&config_flags, CONFIG_FLAG_FILEUNCHANGED);
   }

   if (!(cfg = ast_config_load2(stun_conf_file, "res_stun_monitor", config_flags)) ||
      cfg == CONFIG_STATUS_FILEINVALID) {
      ast_log(LOG_ERROR, "Unable to load config %s\n", stun_conf_file);
      return -1;
   }

   if (cfg == CONFIG_STATUS_FILEUNCHANGED && !startup) {
      return 0;
   }

   /* set defaults */
   args.monitor_enabled = 0;
   memset(&args.stunaddr, 0, sizeof(args.stunaddr));
   args.refresh = DEFAULT_MONITOR_REFRESH;

   for (v = ast_variable_browse(cfg, "general"); v; v = v->next) {
      if (!strcasecmp(v->name, "stunaddr")) {
         args.stunaddr.sin_port = htons(STANDARD_STUN_PORT);
         if (ast_parse_arg(v->value, PARSE_INADDR, &args.stunaddr)) {
            ast_log(LOG_WARNING, "Invalid STUN server address: %s\n", v->value);
         } else {
            ast_log(LOG_NOTICE, "STUN monitor enabled: %s\n", v->value);
            args.monitor_enabled = 1;
         }
      } else if (!strcasecmp(v->name, "stunrefresh")) {
         if ((sscanf(v->value, "%30u", &args.refresh) != 1) || !args.refresh) {
            ast_log(LOG_WARNING, "Invalid stunrefresh value '%s', must be an integer > 0 at line %d\n", v->value, v->lineno);
            args.refresh = DEFAULT_MONITOR_REFRESH;
         } else {
            ast_log(LOG_NOTICE, "STUN Monitor set to refresh every %d seconds\n", args.refresh);
         }
      } else {
         ast_log(LOG_WARNING, "SIP STUN: invalid config option %s at line %d\n", v->value, v->lineno);
      }
   }

   ast_config_destroy(cfg);

   return 0;
}

static int load_module ( void ) [static]

Definition at line 289 of file res_stun_monitor.c.

References __reload(), args, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, ast_mutex_destroy, ast_mutex_init, and stun_stop_monitor().

{
   ast_mutex_init(&args.lock);
   args.stunsock = -1;
   memset(&args.externaladdr, 0, sizeof(args.externaladdr));
   args.externaladdr_known = 0;
   sched = NULL;
   if (__reload(1)) {
      stun_stop_monitor();
      ast_mutex_destroy(&args.lock);
      return AST_MODULE_LOAD_DECLINE;
   }

   return AST_MODULE_LOAD_SUCCESS;
}

static int reload ( void ) [static]

Definition at line 277 of file res_stun_monitor.c.

References __reload().

{
   return __reload(0);
}

static void stun_close_sock ( void ) [inline, static]

Definition at line 54 of file res_stun_monitor.c.

References args.

Referenced by stun_start_monitor(), and stun_stop_monitor().

{
   if (args.stunsock != -1) {
      close(args.stunsock);
      args.stunsock = -1;
      memset(&args.externaladdr, 0, sizeof(args.externaladdr));
      args.externaladdr_known = 0;
   }
}

static int stun_monitor_request ( const void * blarg ) [static]

Definition at line 86 of file res_stun_monitor.c.

References args, ast_event_destroy(), AST_EVENT_IE_END, AST_EVENT_NETWORK_CHANGE, ast_event_new(), ast_event_queue(), ast_inet_ntoa(), ast_log(), ast_mutex_lock, ast_mutex_unlock, ast_strdupa, ast_stun_request(), LOG_ERROR, LOG_NOTICE, and stun_purge_socket().

Referenced by stun_start_monitor().

{
   int res;
   int generate_event = 0;
   struct sockaddr_in answer = { 0, };


   /* once the stun socket goes away, this scheduler item will go away as well */
   ast_mutex_lock(&args.lock);
   if (args.stunsock == -1) {
      ast_log(LOG_ERROR, "STUN monitor: can not send STUN request, socket is not open\n");
      goto monitor_request_cleanup;
   }

   stun_purge_socket();

   if (!(ast_stun_request(args.stunsock, &args.stunaddr, NULL, &answer)) &&
      (memcmp(&args.externaladdr, &answer, sizeof(args.externaladdr)))) {
      const char *newaddr = ast_strdupa(ast_inet_ntoa(answer.sin_addr));
      int newport = ntohs(answer.sin_port);

      ast_log(LOG_NOTICE, "STUN MONITOR: Old external address/port %s:%d now seen as %s:%d \n",
         ast_inet_ntoa(args.externaladdr.sin_addr), ntohs(args.externaladdr.sin_port),
         newaddr, newport);

      memcpy(&args.externaladdr, &answer, sizeof(args.externaladdr));

      if (args.externaladdr_known) {
         /* the external address was already known, and has changed... generate event. */
         generate_event = 1;

      } else {
         /* this was the first external address we found, do not alert listeners
          * until this address changes to something else. */
         args.externaladdr_known = 1;
      }
   }

   if (generate_event) {
      struct ast_event *event = ast_event_new(AST_EVENT_NETWORK_CHANGE, AST_EVENT_IE_END);
      if (!event) {
         ast_log(LOG_ERROR, "STUN monitor: could not create AST_EVENT_NETWORK_CHANGE event.\n");
         goto monitor_request_cleanup;
      }
      if (ast_event_queue(event)) {
         ast_event_destroy(event);
         event = NULL;
         ast_log(LOG_ERROR, "STUN monitor: could not queue AST_EVENT_NETWORK_CHANGE event.\n");
         goto monitor_request_cleanup;
      }
   }

monitor_request_cleanup:
   /* always refresh this scheduler item.  It will be removed elsewhere when
    * it is supposed to go away */
   res = args.refresh * 1000;
   ast_mutex_unlock(&args.lock);

   return res;
}

static void stun_purge_socket ( void ) [static]

Definition at line 71 of file res_stun_monitor.c.

References args.

Referenced by stun_monitor_request().

{
   int flags = fcntl(args.stunsock, F_GETFL);
   int res = 0;
   unsigned char reply_buf[1024];

   fcntl(args.stunsock, F_SETFL, flags | O_NONBLOCK);
   while (res != -1) {
      /* throw away everything in the buffer until we reach the end. */
      res = recv(args.stunsock, reply_buf, sizeof(reply_buf), 0);
   }
   fcntl(args.stunsock, F_SETFL, flags & ~O_NONBLOCK);
}

static int stun_start_monitor ( void ) [static]

Definition at line 164 of file res_stun_monitor.c.

References args, ast_connect(), ast_log(), ast_sched_thread_add_variable(), ast_sched_thread_create(), ast_sched_thread_destroy(), ast_sockaddr_from_sin, ast_sockaddr_stringify(), errno, LOG_ERROR, LOG_NOTICE, LOG_WARNING, stun_close_sock(), and stun_monitor_request().

Referenced by __reload().

{
   struct ast_sockaddr dst;
   /* clean up any previous open socket */
   stun_close_sock();

   /* create destination ast_sockaddr */
   ast_sockaddr_from_sin(&dst, &args.stunaddr);

   /* open new socket binding */
   args.stunsock = socket(AF_INET, SOCK_DGRAM, 0);
   if (args.stunsock < 0) {
      ast_log(LOG_WARNING, "Unable to create STUN socket: %s\n", strerror(errno));
      return -1;
   }

   if (ast_connect(args.stunsock, &dst) != 0) {
      ast_log(LOG_WARNING, "SIP STUN Failed to connect to %s\n", ast_sockaddr_stringify(&dst));
      stun_close_sock();
      return -1;
   }

   /* if scheduler thread is not started, make sure to start it now */
   if (sched) {
      return 0; /* already started */
   }

   if (!(sched = ast_sched_thread_create())) {
      ast_log(LOG_ERROR, "Failed to create stun monitor scheduler thread\n");
      stun_close_sock();
      return -1;
   }

   if (ast_sched_thread_add_variable(sched, (args.refresh * 1000), stun_monitor_request, NULL, 1) < 0) {
      ast_log(LOG_ERROR, "Unable to schedule STUN network monitor \n");
      sched = ast_sched_thread_destroy(sched);
      stun_close_sock();
      return -1;
   }

   ast_log(LOG_NOTICE, "STUN monitor started\n");
   return 0;
}

static void stun_stop_monitor ( void ) [static]

Definition at line 150 of file res_stun_monitor.c.

References ast_log(), ast_sched_thread_destroy(), LOG_NOTICE, and stun_close_sock().

Referenced by __reload(), load_module(), and unload_module().

{
   if (sched) {
      sched = ast_sched_thread_destroy(sched);
      ast_log(LOG_NOTICE, "STUN monitor stopped\n");
   }
   /* it is only safe to destroy the socket without holding arg->lock
    * after the sched thread is destroyed */
   stun_close_sock();
}

static int unload_module ( void ) [static]

Definition at line 282 of file res_stun_monitor.c.

References args, ast_mutex_destroy, and stun_stop_monitor().

{
   stun_stop_monitor();
   ast_mutex_destroy(&args.lock);
   return 0;
}

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "STUN Network Monitor" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "7a1b8b48c852d7a7061c7e499b9bd0d2" , .load = load_module, .unload = unload_module, .reload = reload, .load_pri = AST_MODPRI_CHANNEL_DEPEND } [static]

Definition at line 310 of file res_stun_monitor.c.

struct { ... } args [static]

Referenced by __reload(), acf_curl_helper(), acf_isexten_exec(), acf_jabberreceive_read(), acf_jabberstatus_read(), acf_meetme_info(), acf_odbc_read(), acf_odbc_write(), acf_rand_exec(), acf_strftime(), acf_strptime(), acf_transaction_read(), acf_transaction_write(), acf_version_exec(), acf_vmcount_exec(), add_agent(), add_cfg_entry(), add_rt_cfg_entry(), add_rt_multi_cfg_entry(), admin_exec(), adsi_process(), aes_helper(), agi_exec_full(), aji_join_exec(), aji_leave_exec(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), answer_exec_enable(), app_exec(), aqm_exec(), ast_cc_agent_callback(), ast_cc_agent_status_response(), ast_cli_command_full(), ast_eivr_senddtmf(), ast_func_read(), ast_func_read2(), ast_func_write(), ast_queue_log(), astman_get_variables(), asyncgoto_exec(), background_detect_exec(), build_profile(), calendar_query_exec(), calendar_query_result_exec(), callerid_read(), cc_agent_callback_helper(), cc_do_state_change(), cc_request_state_change(), cc_status_response(), cdr_read(), cdr_write(), celgenuserevent_exec(), chanavail_exec(), channel_admin_exec(), channel_set_debug(), chanspy_exec(), cli_odbc_read(), cli_odbc_write(), conf_exec(), confbridge_exec(), config_function_read(), controlplayback_exec(), count_exec(), cut_internal(), dahdi_send_callrerouting_facility_exec(), dahdiras_exec(), determine_starting_point(), dial_exec_full(), dial_trunk(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enable_jack_hook(), enum_query_read(), enum_result_read(), exec_exec(), extenspy_exec(), festival_exec(), file_count_line(), file_read(), file_write(), filter(), find_call(), find_conf(), find_parkinglot_by_exten_cb(), find_parkinglot_by_position_cb(), find_realtime_gw(), func_args(), func_header_read(), function_agent(), function_db_delete(), function_db_exists(), function_db_read(), function_db_write(), function_enum(), function_fieldnum_helper(), function_fieldqty_helper(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_write(), function_txtcidname(), gosubif_exec(), handle_verbose(), hint_read(), iconv_read(), import_helper(), isAnsweringMachine(), isexten_function_read(), jb_debug_output(), jb_error_output(), jb_warning_output(), kqueue_timer_cmp(), listfilter(), load_config(), load_module(), log_exec(), login_exec(), math(), misdn_call(), misdn_check_l2l1(), misdn_facility_exec(), misdn_request(), mixmonitor_exec(), my_pri_make_cc_dialstring(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), parkandannounce_exec(), pbx_builtin_answer(), pbx_builtin_background(), pbx_builtin_resetcdr(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), peek_read(), pickup_by_name_cb(), pickupchan_exec(), playback_exec(), pp_each_extension_helper(), pp_each_user_helper(), pqm_exec(), privacy_exec(), pvalAppCallWalkArgs(), pvalMacroCallWalkArgs(), ql_exec(), queue_exec(), queue_function_memberpenalty_read(), queue_function_memberpenalty_write(), rcvfax_exec(), realtimefield_read(), receivefax_exec(), record_exec(), recordthread(), reg_source_db(), regex(), reload_single_member(), replace(), retrydial_exec(), rqm_exec(), run_station(), saycountedadj_exec(), saycountednoun_exec(), sayunixtime_exec(), senddtmf_exec(), sendfax_exec(), sendurl_exec(), shared_read(), shared_write(), shift_pop(), sig_pri_call(), sig_pri_extract_called_num_subaddr(), sip_request_call(), sip_tcptls_client_args_destructor(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sndfax_exec(), softhangup_exec(), spawn_ras(), speech_background(), speech_load(), srv_result_read(), start_monitor_exec(), stun_close_sock(), stun_monitor_request(), stun_purge_socket(), stun_start_monitor(), timerfd_timer_cmp(), transfer_exec(), tryexec_exec(), unload_module(), unshift_push(), upqm_exec(), user_chan_cb(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_exec(), vm_execmain(), and zapateller_exec().