Asterisk - The Open Source Telephony Project GIT-master-754dea3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Modules Pages
Data Structures | Macros | Enumerations | Functions | Variables
manager.c File Reference

The Asterisk Management Interface - AMI. More...

#include "asterisk.h"
#include "asterisk/paths.h"
#include <ctype.h>
#include <sys/time.h>
#include <signal.h>
#include <sys/mman.h>
#include <sys/types.h>
#include <regex.h>
#include "asterisk/channel.h"
#include "asterisk/file.h"
#include "asterisk/manager.h"
#include "asterisk/module.h"
#include "asterisk/config.h"
#include "asterisk/callerid.h"
#include "asterisk/core_local.h"
#include "asterisk/lock.h"
#include "asterisk/cli.h"
#include "asterisk/app.h"
#include "asterisk/mwi.h"
#include "asterisk/pbx.h"
#include "asterisk/md5.h"
#include "asterisk/acl.h"
#include "asterisk/utils.h"
#include "asterisk/tcptls.h"
#include "asterisk/http.h"
#include "asterisk/ast_version.h"
#include "asterisk/threadstorage.h"
#include "asterisk/linkedlists.h"
#include "asterisk/term.h"
#include "asterisk/astobj2.h"
#include "asterisk/features.h"
#include "asterisk/security_events.h"
#include "asterisk/aoc.h"
#include "asterisk/strings.h"
#include "asterisk/stringfields.h"
#include "asterisk/presencestate.h"
#include "asterisk/stasis_message_router.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/stasis_bridges.h"
#include "asterisk/test.h"
#include "asterisk/json.h"
#include "asterisk/bridge.h"
#include "asterisk/bridge_after.h"
#include "asterisk/features_config.h"
#include "asterisk/rtp_engine.h"
#include "asterisk/format_cache.h"
#include "asterisk/translate.h"
#include "asterisk/taskprocessor.h"
#include "asterisk/message.h"
Include dependency graph for manager.c:

Go to the source code of this file.

Data Structures

struct  actions
 list of actions registered More...
 
struct  all_events
 
struct  ast_manager_user
 user descriptor, as read from the config file. More...
 
struct  event_filter_entry
 
struct  eventqent
 
struct  fast_originate_helper
 helper function for originate More...
 
struct  manager_hooks
 list of hooks registered More...
 
struct  mansession
 In case you didn't read that giant block of text above the mansession_session struct, the mansession is named this solely to keep the API the same in Asterisk. This structure really represents data that is different from Manager action to Manager action. The mansession_session pointer contained within points to session-specific data. More...
 
struct  mansession_session::mansession_datastores
 
struct  mansession_session
 
struct  originate_permissions_entry
 
struct  permalias
 
struct  users
 list of users found in the config file More...
 
struct  variable_count
 

Macros

#define any_manager_listeners(sessions)    ((sessions && ao2_container_count(sessions)) || !AST_RWLIST_EMPTY(&manager_hooks))
 
#define ASTMAN_APPEND_BUF_INITSIZE   256
 initial allocated size for the astman_append_buf and astman_send_*_va More...
 
#define DEFAULT_REALM   "asterisk"
 
#define EVENT_FLAG_SHUTDOWN   -1
 Fake event class used to end sessions at shutdown. More...
 
#define FORMAT   " %-25.25s %-15.55s\n"
 
#define FORMAT2   " %-25.25s %-15d\n"
 
#define FORMAT3   " %-25.25s %s\n"
 
#define GET_HEADER_FIRST_MATCH   0
 
#define GET_HEADER_LAST_MATCH   1
 
#define GET_HEADER_SKIP_EMPTY   2
 
#define HSMC_FORMAT   " %-*.*s %-.*s\n"
 
#define HSMCONN_FORMAT1   " %-15.15s %-55.55s %-10.10s %-10.10s %-8.8s %-8.8s %-10.10s %-10.10s\n"
 
#define HSMCONN_FORMAT2   " %-15.15s %-55.55s %-10d %-10d %-8d %-8d %-10.10d %-10.10d\n"
 
#define MANAGER_EVENT_BUF_INITSIZE   256
 
#define manager_event_sessions(sessions, category, event, contents, ...)    __manager_event_sessions(sessions, category, event, 0, NULL, __FILE__, __LINE__, __PRETTY_FUNCTION__, contents , ## __VA_ARGS__)
 
#define MAX_AUTH_PERM_STRING   150
 
#define MAX_BLACKLIST_CMD_LEN   2
 Descriptor for a manager session, either on the AMI socket or over HTTP. More...
 
#define MAX_VARS   128
 
#define MGR_SHOW_TERMINAL_WIDTH   80
 
#define MSG_MOREDATA   ((char *)astman_send_response)
 
#define ROW_FMT   "<tr><td colspan=\"2\" bgcolor=\"#f1f1ff\">%s</td></tr>\r\n"
 
#define TEST_STRING    "<form action=\"manager\" method=\"post\">\n\ Action: <select name=\"action\">\n\ <option value=\"\">-----&gt;</option>\n\ <option value=\"login\">login</option>\n\ <option value=\"command\">Command</option>\n\ <option value=\"waitevent\">waitevent</option>\n\ <option value=\"listcommands\">listcommands</option>\n\ </select>\n\ or <input name=\"action\"><br/>\n\ CLI Command <input name=\"command\"><br>\n\ user <input name=\"username\"> pass <input type=\"password\" name=\"secret\"><br>\n\ <input type=\"submit\">\n</form>\n"
 

Enumerations

enum  add_filter_result { FILTER_SUCCESS = 0 , FILTER_ALLOC_FAILED , FILTER_COMPILE_FAIL , FILTER_FORMAT_ERROR }
 
enum  error_type {
  UNKNOWN_ACTION = 1 , UNKNOWN_CATEGORY , UNSPECIFIED_CATEGORY , UNSPECIFIED_ARGUMENT ,
  FAILURE_ALLOCATION , FAILURE_NEWCAT , FAILURE_DELCAT , FAILURE_EMPTYCAT ,
  FAILURE_UPDATE , FAILURE_DELETE , FAILURE_APPEND , FAILURE_TEMPLATE
}
 
enum  event_filter_match_type {
  FILTER_MATCH_REGEX = 0 , FILTER_MATCH_EXACT , FILTER_MATCH_STARTS_WITH , FILTER_MATCH_ENDS_WITH ,
  FILTER_MATCH_CONTAINS , FILTER_MATCH_NONE
}
 
enum  mansession_message_parsing { MESSAGE_OKAY , MESSAGE_LINE_TOO_LONG }
 
enum  output_format { FORMAT_RAW , FORMAT_HTML , FORMAT_XML }
 

Functions

int __ast_manager_event_multichan (int category, const char *event, int chancount, struct ast_channel **chans, const char *file, int line, const char *func, const char *fmt,...)
 
static const char * __astman_get_header (const struct message *m, char *var, int mode)
 Return a matching header value. More...
 
static void __init_astman_append_buf (void)
 thread local buffer for astman_append More...
 
static int __init_manager (int reload, int by_external_config)
 
static void __init_manager_event_buf (void)
 
static void __init_userevent_buf (void)
 
static int __manager_event_sessions (struct ao2_container *sessions, int category, const char *event, int chancount, struct ast_channel **chans, const char *file, int line, const char *func, const char *fmt,...)
 
static int __manager_event_sessions_va (struct ao2_container *sessions, int category, const char *event, int chancount, struct ast_channel **chans, const char *file, int line, const char *func, const char *fmt, va_list ap)
 
static void __reg_module (void)
 
static void __unreg_module (void)
 
static void acl_change_stasis_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static void acl_change_stasis_subscribe (void)
 
static void acl_change_stasis_unsubscribe (void)
 
static struct ast_aoc_decodedaction_aoc_de_message (struct mansession *s, const struct message *m)
 
static struct ast_aoc_decodedaction_aoc_s_message (struct mansession *s, const struct message *m)
 
static int action_aoc_s_submessage (struct mansession *s, const struct message *m, struct ast_aoc_decoded *decoded)
 
static int action_aocmessage (struct mansession *s, const struct message *m)
 
static int action_atxfer (struct mansession *s, const struct message *m)
 
static int action_blind_transfer (struct mansession *s, const struct message *m)
 
static int action_cancel_atxfer (struct mansession *s, const struct message *m)
 
static int action_challenge (struct mansession *s, const struct message *m)
 
static int action_command (struct mansession *s, const struct message *m)
 Manager command "command" - execute CLI command. More...
 
static int action_coresettings (struct mansession *s, const struct message *m)
 Show PBX core settings information. More...
 
static int action_coreshowchannelmap (struct mansession *s, const struct message *m)
 Manager command "CoreShowChannelMap" - Lists all channels connected to the specified channel. More...
 
static int action_coreshowchannels (struct mansession *s, const struct message *m)
 Manager command "CoreShowChannels" - List currently defined channels and some information about them. More...
 
static int action_corestatus (struct mansession *s, const struct message *m)
 Show PBX core status information. More...
 
static int action_createconfig (struct mansession *s, const struct message *m)
 
static void action_destroy (void *obj)
 
static int action_events (struct mansession *s, const struct message *m)
 
static int action_extensionstate (struct mansession *s, const struct message *m)
 
static int action_filter (struct mansession *s, const struct message *m)
 Manager command to add an event filter to a manager session. More...
 
static struct manager_actionaction_find (const char *name)
 
static int action_getconfig (struct mansession *s, const struct message *m)
 
static int action_getconfigjson (struct mansession *s, const struct message *m)
 
static int action_getvar (struct mansession *s, const struct message *m)
 
static int action_hangup (struct mansession *s, const struct message *m)
 
static int action_listcategories (struct mansession *s, const struct message *m)
 
static int action_listcommands (struct mansession *s, const struct message *m)
 
static int action_loggerrotate (struct mansession *s, const struct message *m)
 Manager command "LoggerRotate" - reloads and rotates the logger in the same manner as the CLI command 'logger rotate'. More...
 
static int action_login (struct mansession *s, const struct message *m)
 
static int action_logoff (struct mansession *s, const struct message *m)
 
static int action_mailboxcount (struct mansession *s, const struct message *m)
 
static int action_mailboxstatus (struct mansession *s, const struct message *m)
 
static int action_originate (struct mansession *s, const struct message *m)
 
static int action_ping (struct mansession *s, const struct message *m)
 
static int action_presencestate (struct mansession *s, const struct message *m)
 
static int action_redirect (struct mansession *s, const struct message *m)
 action_redirect: The redirect manager command More...
 
static int action_reload (struct mansession *s, const struct message *m)
 Send a reload event. More...
 
static int action_sendtext (struct mansession *s, const struct message *m)
 
static int action_setvar (struct mansession *s, const struct message *m)
 
static int action_status (struct mansession *s, const struct message *m)
 Manager "status" command to show channels. More...
 
static int action_timeout (struct mansession *s, const struct message *m)
 
static int action_updateconfig (struct mansession *s, const struct message *m)
 
static int action_userevent (struct mansession *s, const struct message *m)
 
static int action_waitevent (struct mansession *s, const struct message *m)
 
static struct eventqentadvance_event (struct eventqent *e)
 
static AO2_GLOBAL_OBJ_STATIC (event_docs)
 A container of event documentation nodes. More...
 
static AO2_GLOBAL_OBJ_STATIC (mgr_sessions)
 
static int aocmessage_get_unit_entry (const struct message *m, struct ast_aoc_unit_entry *entry, unsigned int entry_num)
 
static int app_match (const char *app, const char *data, const char *search)
 
static int appdata_match (const char *app, const char *data, const char *search)
 
static void append_channel_vars (struct ast_str **pbuf, struct ast_channel *chan)
 
static int append_event (const char *str, int event_name_hash, int category)
 events are appended to a queue from where they can be dispatched to clients. More...
 
int ast_hook_send_action (struct manager_custom_hook *hook, const char *msg)
 access for hooks to send action messages to ami More...
 
static int ast_instring (const char *bigstr, const char *smallstr, const char delim)
 
int ast_manager_check_enabled (void)
 Check if AMI is enabled. More...
 
struct ast_manager_event_blobast_manager_event_blob_create (int event_flags, const char *manager_event, const char *extra_fields_fmt,...)
 Construct a ast_manager_event_blob. More...
 
struct stasis_message_routerast_manager_get_message_router (void)
 Get the stasis_message_router for AMI. More...
 
struct stasis_topicast_manager_get_topic (void)
 Get the Stasis Message Bus API topic for AMI. More...
 
int ast_manager_hangup_helper (struct mansession *s, const struct message *m, manager_hangup_handler_t hangup_handler, manager_hangup_cause_validator_t cause_validator)
 A manager helper function that hangs up a channel using a supplied channel type specific hangup function and cause code validator. More...
 
void ast_manager_publish_event (const char *type, int class_type, struct ast_json *obj)
 Publish an event to AMI. More...
 
int ast_manager_register2 (const char *action, int auth, int(*func)(struct mansession *s, const struct message *m), struct ast_module *module, const char *synopsis, const char *description)
 register a new command with manager, including online help. This is the preferred way to register a manager command More...
 
void ast_manager_register_hook (struct manager_custom_hook *hook)
 Add a custom hook to be called when an event is fired. More...
 
static int ast_manager_register_struct (struct manager_action *act)
 
struct ast_strast_manager_str_from_json_object (struct ast_json *blob, key_exclusion_cb exclusion_cb)
 Convert a JSON object into an AMI compatible string. More...
 
int ast_manager_unregister (const char *action)
 support functions to register/unregister AMI action handlers, More...
 
void ast_manager_unregister_hook (struct manager_custom_hook *hook)
 Delete a custom hook to be called when an event is fired. More...
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
int ast_str_append_event_header (struct ast_str **fields_string, const char *header, const char *value)
 append an event header to an ast string More...
 
int ast_webmanager_check_enabled (void)
 Check if AMI/HTTP is enabled. More...
 
static int ast_xml_doc_item_cmp_fn (const void *a, const void *b)
 
void astman_append (struct mansession *s, const char *fmt,...)
 
static void astman_append_headers (struct message *m, const struct ast_variable *params)
 Append additional headers into the message structure from params. More...
 
static void astman_append_json (struct mansession *s, const char *str)
 
int astman_datastore_add (struct mansession *s, struct ast_datastore *datastore)
 Add a datastore to a session. More...
 
struct ast_datastoreastman_datastore_find (struct mansession *s, const struct ast_datastore_info *info, const char *uid)
 Find a datastore on a session. More...
 
int astman_datastore_remove (struct mansession *s, struct ast_datastore *datastore)
 Remove a datastore from a session. More...
 
static void astman_flush (struct mansession *s, struct ast_str *buf)
 
static void astman_free_headers (struct message *m)
 Free headers inside message structure, but not the message structure itself. More...
 
const char * astman_get_header (const struct message *m, char *var)
 Return the first matching variable from an array. More...
 
struct ast_variableastman_get_variables (const struct message *m)
 Get a linked list of the Variable: headers. More...
 
struct ast_variableastman_get_variables_order (const struct message *m, enum variable_orders order)
 Get a linked list of the Variable: headers with order specified. More...
 
int astman_is_authed (uint32_t ident)
 Determine if a manager session ident is authenticated. More...
 
void astman_live_dangerously (int new_live_dangerously)
 Enable/disable the inclusion of 'dangerous' configurations outside of the ast_config_AST_CONFIG_DIR. More...
 
void astman_send_ack (struct mansession *s, const struct message *m, char *msg)
 Send ack in manager transaction. More...
 
void astman_send_error (struct mansession *s, const struct message *m, char *error)
 Send error in manager transaction. More...
 
void astman_send_error_va (struct mansession *s, const struct message *m, const char *fmt,...)
 Send error in manager transaction (with va_args support) More...
 
static void astman_send_list_complete (struct mansession *s, const struct message *m, const char *event_name, int count)
 
void astman_send_list_complete_end (struct mansession *s)
 End the list complete event. More...
 
void astman_send_list_complete_start (struct mansession *s, const struct message *m, const char *event_name, int count)
 Start the list complete event. More...
 
static struct ast_strastman_send_list_complete_start_common (struct mansession *s, const struct message *m, const char *event_name, int count)
 
void astman_send_listack (struct mansession *s, const struct message *m, char *msg, char *listflag)
 Send ack in manager transaction to begin a list. More...
 
void astman_send_response (struct mansession *s, const struct message *m, char *resp, char *msg)
 Send response in manager transaction. More...
 
static void astman_send_response_full (struct mansession *s, const struct message *m, char *resp, char *msg, char *listflag)
 send a response with an optional message, and terminate it with an empty line. m is used only to grab the 'ActionID' field. More...
 
static void astman_start_ack (struct mansession *s, const struct message *m)
 
int astman_verify_session_readpermissions (uint32_t ident, int perm)
 Verify a session's read permissions against a permission mask. More...
 
int astman_verify_session_writepermissions (uint32_t ident, int perm)
 Verify a session's write permissions against a permission mask. More...
 
static int async_goto_with_discard_bridge_after (struct ast_channel *chan, const char *context, const char *exten, int priority)
 
static int auth_http_callback (struct ast_tcptls_session_instance *ser, enum ast_http_method method, enum output_format format, const struct ast_sockaddr *remote_address, const char *uri, struct ast_variable *get_params, struct ast_variable *headers)
 
static int auth_manager_http_callback (struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_params, struct ast_variable *headers)
 
static int auth_mxml_http_callback (struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_params, struct ast_variable *headers)
 
static int auth_rawman_http_callback (struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_params, struct ast_variable *headers)
 
static int authenticate (struct mansession *s, const struct message *m)
 
static const char * authority_to_str (int authority, struct ast_str **res)
 Convert authority code to a list of options. Note that the EVENT_FLAG_ALL authority will always be returned. More...
 
static struct mansession_sessionbuild_mansession (const struct ast_sockaddr *addr)
 Allocate manager session structure and add it to the list of sessions. More...
 
static int check_blacklist (const char *cmd)
 
static int check_manager_session_inuse (const char *name)
 
static void close_mansession_file (struct mansession *s)
 
static int coreshowchannelmap_add_connected_channels (struct ao2_container *channel_map, struct ast_channel_snapshot *channel_snapshot, struct ast_bridge_snapshot *bridge_snapshot)
 Recursive function to get all channels in a bridge. Follow local channels as well. More...
 
static int coreshowchannelmap_add_to_map (struct ao2_container *c, const char *s)
 Helper function to add a channel name to the vector. More...
 
static void destroy_fast_originate_helper (struct fast_originate_helper *doomed)
 
static int do_message (struct mansession *s)
 
static void event_filter_destructor (void *obj)
 
static void * fast_originate (void *data)
 
static int file_in_modules_dir (const char *filename)
 Check if the given file path is in the modules dir or not. More...
 
static int filter_cmp_fn (void *obj, void *arg, void *data, int flags)
 
static struct mansession_sessionfind_session (uint32_t ident, int incinuse)
 
static struct mansession_sessionfind_session_by_nonce (const char *username, unsigned long nonce, int *stale)
 
static int function_amiclient (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 ${AMI_CLIENT()} Dialplan function - reads manager client data More...
 
static int function_capable_string_allowed_with_auths (const char *evaluating, int writepermlist)
 Checks to see if a string which can be used to evaluate functions should be rejected. More...
 
static void generate_status (struct mansession *s, struct ast_channel *chan, char **vars, int varc, int all_variables, char *id_text, int *count)
 
static int generic_http_callback (struct ast_tcptls_session_instance *ser, enum ast_http_method method, enum output_format format, const struct ast_sockaddr *remote_address, const char *uri, struct ast_variable *get_params, struct ast_variable *headers)
 
static int get_input (struct mansession *s, char *output)
 
static struct ast_manager_userget_manager_by_name_locked (const char *name)
 
static int get_manager_sessions_cb (void *obj, void *arg, void *data, int flags)
 Get number of logged in sessions for a login name. More...
 
static int get_perm (const char *instr)
 
static struct eventqentgrab_last (void)
 
static char * handle_kickmanconn (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager kick session. More...
 
static char * handle_manager_reload (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager reload. More...
 
static char * handle_manager_show_event (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_manager_show_events (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_manager_show_settings (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager show settings. More...
 
static char * handle_mandebug (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static void handle_parse_error (struct mansession *s, struct message *m, char *error)
 
static char * handle_showmanager (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_showmanagers (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_showmancmd (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_showmancmds (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager list commands. More...
 
static char * handle_showmanconn (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager list connected. More...
 
static char * handle_showmaneventq (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command manager list eventq. More...
 
static enum error_type handle_updates (struct mansession *s, const struct message *m, struct ast_config *cfg, const char *dfn)
 helper function for action_updateconfig More...
 
static int is_originate_app_permitted (const char *app, const char *data, int permission)
 
static int is_restricted_file (const char *filename)
 Check if a file is restricted or not. More...
 
static void json_escape (char *out, const char *in)
 
static void load_channelvars (struct ast_variable *var)
 
static void load_disabledevents (struct ast_variable *var)
 
static int load_module (void)
 
static void log_action (const struct message *m, const char *action)
 
static struct ast_variableman_do_variable_value (struct ast_variable *head, const char *hdr_val)
 
static enum add_filter_result manager_add_filter (const char *criteria, const char *filter_pattern, struct ao2_container *includefilters, struct ao2_container *excludefilters)
 Add an event filter to a manager session. More...
 
static void manager_default_msg_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int manager_displayconnects (struct mansession_session *session)
 Get displayconnects config option. More...
 
static void manager_event_blob_dtor (void *obj)
 
static void manager_free_user (struct ast_manager_user *user)
 
static void manager_generic_msg_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 
static int manager_http_callback (struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_params, struct ast_variable *headers)
 
static void manager_json_array_with_key (struct ast_json *obj, const char *key, size_t index, struct ast_str **res, key_exclusion_cb exclusion_cb)
 
static void manager_json_obj_with_key (struct ast_json *obj, const char *key, const char *parent_key, struct ast_str **res, key_exclusion_cb exclusion_cb)
 
static void manager_json_to_ast_str (struct ast_json *obj, const char *key, struct ast_str **res, key_exclusion_cb exclusion_cb)
 
static void manager_json_value_str_append (struct ast_json *value, const char *key, struct ast_str **res)
 
static int manager_modulecheck (struct mansession *s, const struct message *m)
 Manager function to check if module is loaded. More...
 
static int manager_moduleload (struct mansession *s, const struct message *m)
 
static void manager_set_defaults (void)
 
static void manager_shutdown (void)
 
static int manager_state_cb (const char *context, const char *exten, struct ast_state_cb_info *info, void *data)
 
static int manager_subscriptions_init (void)
 Initialize all Stasis Message Bus API topics and routers used by the various sub-components of AMI. More...
 
static int mansession_cmp_fn (void *obj, void *arg, int flags)
 
static enum ast_transport mansession_get_transport (const struct mansession *s)
 
static void mansession_lock (struct mansession *s)
 Lock the 'mansession' structure. More...
 
static void mansession_unlock (struct mansession *s)
 Unlock the 'mansession' structure. More...
 
static int match_eventdata (struct event_filter_entry *entry, const char *eventdata)
 Test eventdata against a filter entry. More...
 
static int mxml_http_callback (struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_params, struct ast_variable *headers)
 
static void print_event_instance (struct ast_cli_args *a, struct ast_xml_doc_item *instance)
 
static int process_events (struct mansession *s)
 
static int process_message (struct mansession *s, const struct message *m)
 Process an AMI message, performing desired action. Return 0 on success, -1 on error that require the session to be destroyed. More...
 
static void process_output (struct mansession *s, struct ast_str **out, struct ast_variable *params, enum output_format format)
 
static void purge_events (void)
 
static void purge_old_stuff (void *data)
 cleanup code called at each iteration of server_root, guaranteed to happen every 5 seconds at most More...
 
static int purge_sessions (int n_max)
 remove at most n_max stale session from the list. More...
 
static int queue_match (const char *app, const char *data, const char *search)
 
static int queue_read_action_payload (struct ast_channel *chan, const unsigned char *payload, size_t payload_size, enum ast_frame_read_action action)
 Queue a given read action containing a payload onto a channel. More...
 
static int queue_sendtext (struct ast_channel *chan, const char *body)
 Queue a read action to send a text message. More...
 
static int queue_sendtext_data (struct ast_channel *chan, const char *body, const char *content_type)
 Queue a read action to send a text data message. More...
 
static int rawman_http_callback (struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_params, struct ast_variable *headers)
 
static int reload_module (void)
 
static void report_auth_success (const struct mansession *s)
 
static void report_failed_acl (const struct mansession *s, const char *username)
 
static void report_failed_challenge_response (const struct mansession *s, const char *response, const char *expected_response)
 
static void report_inval_password (const struct mansession *s, const char *username)
 
static void report_invalid_user (const struct mansession *s, const char *username)
 
static void report_req_bad_format (const struct mansession *s, const char *action)
 
static void report_req_not_allowed (const struct mansession *s, const char *action)
 
static void report_session_limit (const struct mansession *s)
 
static int send_string (struct mansession *s, char *string)
 
static void session_destroy (struct mansession_session *s)
 
static void session_destructor (void *obj)
 
static void * session_do (void *data)
 The body of the individual manager session. Call get_input() to read one line at a time (or be woken up on new events), collect the lines in a message until found an empty line, and execute the request. In any case, deliver events asynchronously through process_events() (called from here if no line is available, or at the end of process_message(). ) More...
 
static int set_eventmask (struct mansession *s, const char *eventmask)
 Rather than braindead on,off this now can also accept a specific int mask value or a ',' delim list of mask strings (the same as manager.conf) -anthm. More...
 
static int should_send_event (struct ao2_container *includefilters, struct ao2_container *excludefilters, struct eventqent *eqe)
 
static int strings_to_mask (const char *string)
 
static int subscribe_all (void)
 
static int unload_module (void)
 
static struct mansession_sessionunref_mansession (struct mansession_session *s)
 Unreference manager session object. If no more references, then go ahead and delete it. More...
 
static const char * user_authority_to_str (int authority, struct ast_str **res)
 Convert authority code to a list of options for a user. This will only display those authority codes that have an explicit match on authority. More...
 
static int variable_count_cmp_fn (void *obj, void *vstr, int flags)
 
static int variable_count_hash_fn (const void *vvc, const int flags)
 
static void xml_copy_escape (struct ast_str **out, const char *src, int mode)
 
static void xml_translate (struct ast_str **out, char *in, struct ast_variable *get_vars, enum output_format format)
 Convert the input into XML or HTML. The input is supposed to be a sequence of lines of the form Name: value optionally followed by a blob of unformatted text. A blank line is a section separator. Basically, this is a mixture of the format of Manager Interface and CLI commands. The unformatted text is considered as a single value of a field named 'Opaque-data'. More...
 
 STASIS_MESSAGE_TYPE_DEFN (ast_manager_get_generic_type)
 Define AMI message types. More...
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Asterisk Manager Interface" , .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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CORE, .requires = "extconfig,acl,http", }
 
static struct stasis_subscriptionacl_change_sub
 
static struct actions actions = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
 
static struct all_events all_events = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
 
static int allowmultiplelogin = 1
 
static struct ast_http_uri amanageruri
 
static struct ast_http_uri amanagerxmluri
 
static struct ast_tcptls_session_args ami_desc
 
static struct ast_tls_config ami_tls_cfg
 
static struct ast_tcptls_session_args amis_desc
 
static struct ast_http_uri arawmanuri
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_threadstorage astman_append_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_astman_append_buf , .custom_init = NULL , }
 
static int authlimit
 
static int authtimeout
 
static int broken_events_action = 0
 
static struct ast_cli_entry cli_manager []
 
struct {
   const char *   words [AST_MAX_CMD_LEN]
 
command_blacklist []
 
static const char *const contenttype []
 
static int displayconnects = 1
 
static char global_realm [MAXHOSTNAMELEN]
 
static int httptimeout = 60
 
static int live_dangerously
 Set to true (non-zero) to globally allow all dangerous AMI actions to run. More...
 
static char * manager_channelvars
 
static int manager_debug = 0
 
static char * manager_disabledevents
 
static int manager_enabled = 0
 
static struct ast_threadstorage manager_event_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_manager_event_buf , .custom_init = NULL , }
 
static struct manager_hooks manager_hooks = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
 
static struct stasis_topicmanager_topic
 A stasis_topic that all topics AMI cares about will be forwarded to. More...
 
static struct ast_custom_function managerclient_function
 description of AMI_CLIENT dialplan function More...
 
static struct ast_http_uri manageruri
 
static struct ast_http_uri managerxmluri
 
static char * match_type_names []
 
static struct originate_permissions_entry originate_app_permissions []
 
static const struct permalias perms []
 
static struct ast_http_uri rawmanuri
 
static struct stasis_forwardrtp_topic_forwarder
 The stasis_subscription for forwarding the RTP topic to the AMI topic. More...
 
static struct stasis_forwardsecurity_topic_forwarder
 The stasis_subscription for forwarding the Security topic to the AMI topic. More...
 
static struct stasis_message_routerstasis_router
 The stasis_message_router for all Stasis Message Bus API messages. More...
 
static int subscribed = 0
 
static int timestampevents
 
static int unauth_sessions = 0
 
static struct ast_threadstorage userevent_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_userevent_buf , .custom_init = NULL , }
 
static struct users users = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
 
static int webmanager_enabled = 0
 
static int webregged = 0
 

Detailed Description

The Asterisk Management Interface - AMI.

Author
Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

OpenSSL http://www.openssl.org - for AMI/SSL

At the moment this file contains a number of functions, namely:

manager.conf

Definition in file manager.c.

Macro Definition Documentation

◆ FORMAT

#define FORMAT   " %-25.25s %-15.55s\n"

◆ FORMAT2

#define FORMAT2   " %-25.25s %-15d\n"

◆ FORMAT3

#define FORMAT3   " %-25.25s %s\n"

◆ HSMC_FORMAT

#define HSMC_FORMAT   " %-*.*s %-.*s\n"

◆ HSMCONN_FORMAT1

#define HSMCONN_FORMAT1   " %-15.15s %-55.55s %-10.10s %-10.10s %-8.8s %-8.8s %-10.10s %-10.10s\n"

◆ HSMCONN_FORMAT2

#define HSMCONN_FORMAT2   " %-15.15s %-55.55s %-10d %-10d %-8d %-8d %-10.10d %-10.10d\n"

◆ ROW_FMT

#define ROW_FMT   "<tr><td colspan=\"2\" bgcolor=\"#f1f1ff\">%s</td></tr>\r\n"

◆ TEST_STRING

#define TEST_STRING    "<form action=\"manager\" method=\"post\">\n\ Action: <select name=\"action\">\n\ <option value=\"\">-----&gt;</option>\n\ <option value=\"login\">login</option>\n\ <option value=\"command\">Command</option>\n\ <option value=\"waitevent\">waitevent</option>\n\ <option value=\"listcommands\">listcommands</option>\n\ </select>\n\ or <input name=\"action\"><br/>\n\ CLI Command <input name=\"command\"><br>\n\ user <input name=\"username\"> pass <input type=\"password\" name=\"secret\"><br>\n\ <input type=\"submit\">\n</form>\n"

Enumeration Type Documentation

◆ output_format

Enumerator
FORMAT_RAW 
FORMAT_HTML 
FORMAT_XML 

Definition at line 7909 of file manager.c.

7909 {
7910 FORMAT_RAW,
7912 FORMAT_XML,
7913};
@ FORMAT_RAW
Definition: manager.c:7910
@ FORMAT_HTML
Definition: manager.c:7911
@ FORMAT_XML
Definition: manager.c:7912

Function Documentation

◆ __init_manager()

static int __init_manager ( int  reload,
int  by_external_config 
)
static

Definition at line 9644 of file manager.c.

9645{
9646 struct ast_config *ucfg = NULL, *cfg = NULL;
9647 const char *val;
9648 char *cat = NULL;
9649 int newhttptimeout = 60;
9650 struct ast_manager_user *user = NULL;
9651 struct ast_variable *var;
9652 struct ast_flags config_flags = { (reload && !by_external_config) ? CONFIG_FLAG_FILEUNCHANGED : 0 };
9653 char a1[337];
9654 char a1_hash[256];
9655 struct ast_sockaddr ami_desc_local_address_tmp;
9656 struct ast_sockaddr amis_desc_local_address_tmp;
9657 int tls_was_enabled = 0;
9658 int acl_subscription_flag = 0;
9659
9660 if (!reload) {
9661 struct ao2_container *sessions;
9662#ifdef AST_XML_DOCS
9663 struct ao2_container *temp_event_docs;
9664#endif
9665 int res;
9666
9668 if (res != 0) {
9669 return -1;
9670 }
9671 manager_topic = stasis_topic_create("manager:core");
9672 if (!manager_topic) {
9673 return -1;
9674 }
9675
9676 /* Register default actions */
9716
9717#ifdef TEST_FRAMEWORK
9718 test_suite_forwarder = stasis_forward_all(ast_test_suite_topic(), manager_topic);
9719#endif
9720
9724
9725 /* Append placeholder event so master_eventq never runs dry */
9726 if (append_event("Event: Placeholder\r\n\r\n",
9727 ast_str_hash("Placeholder"), 0)) {
9728 return -1;
9729 }
9730
9731#ifdef AST_XML_DOCS
9732 temp_event_docs = ast_xmldoc_build_documentation("managerEvent");
9733 if (temp_event_docs) {
9734 ao2_t_global_obj_replace_unref(event_docs, temp_event_docs, "Toss old event docs");
9735 ao2_t_ref(temp_event_docs, -1, "Remove creation ref - container holds only ref now");
9736 }
9737#endif
9738
9739 /* If you have a NULL hash fn, you only need a single bucket */
9741 if (!sessions) {
9742 return -1;
9743 }
9745 ao2_ref(sessions, -1);
9746
9747 /* Initialize all settings before first configuration load. */
9749 }
9750
9751 cfg = ast_config_load2("manager.conf", "manager", config_flags);
9752 if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
9753 return 0;
9754 } else if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
9755 ast_log(LOG_NOTICE, "Unable to open AMI configuration manager.conf, or configuration is invalid.\n");
9756 return 0;
9757 }
9758
9759 /* If this wasn't performed due to a forced reload (because those can be created by ACL change events, we need to unsubscribe to ACL change events. */
9760 if (!by_external_config) {
9762 }
9763
9764 if (reload) {
9765 /* Reset all settings before reloading configuration */
9766 tls_was_enabled = ami_tls_cfg.enabled;
9768 }
9769
9770 ast_sockaddr_parse(&ami_desc_local_address_tmp, "[::]", 0);
9771 ast_sockaddr_set_port(&ami_desc_local_address_tmp, DEFAULT_MANAGER_PORT);
9772
9773 for (var = ast_variable_browse(cfg, "general"); var; var = var->next) {
9774 val = var->value;
9775
9776 /* read tls config options while preventing unsupported options from being set */
9777 if (strcasecmp(var->name, "tlscafile")
9778 && strcasecmp(var->name, "tlscapath")
9779 && strcasecmp(var->name, "tlscadir")
9780 && strcasecmp(var->name, "tlsverifyclient")
9781 && strcasecmp(var->name, "tlsdontverifyserver")
9782 && strcasecmp(var->name, "tlsclientmethod")
9783 && strcasecmp(var->name, "sslclientmethod")
9784 && !ast_tls_read_conf(&ami_tls_cfg, &amis_desc, var->name, val)) {
9785 continue;
9786 }
9787
9788 if (!strcasecmp(var->name, "enabled")) {
9790 } else if (!strcasecmp(var->name, "webenabled")) {
9792 } else if (!strcasecmp(var->name, "port")) {
9793 int bindport;
9794 if (ast_parse_arg(val, PARSE_UINT32|PARSE_IN_RANGE, &bindport, 1024, 65535)) {
9795 ast_log(LOG_WARNING, "Invalid port number '%s'\n", val);
9796 }
9797 ast_sockaddr_set_port(&ami_desc_local_address_tmp, bindport);
9798 } else if (!strcasecmp(var->name, "bindaddr")) {
9799 /* remember port if it has already been set */
9800 int setport = ast_sockaddr_port(&ami_desc_local_address_tmp);
9801
9803 ast_log(LOG_WARNING, "Invalid address '%s' specified, default '%s' will be used\n", val,
9804 ast_sockaddr_stringify_addr(&ami_desc_local_address_tmp));
9805 } else {
9806 ast_sockaddr_parse(&ami_desc_local_address_tmp, val, PARSE_PORT_IGNORE);
9807 }
9808
9809 if (setport) {
9810 ast_sockaddr_set_port(&ami_desc_local_address_tmp, setport);
9811 }
9812
9813 } else if (!strcasecmp(var->name, "brokeneventsaction")) {
9815 } else if (!strcasecmp(var->name, "allowmultiplelogin")) {
9817 } else if (!strcasecmp(var->name, "displayconnects")) {
9819 } else if (!strcasecmp(var->name, "timestampevents")) {
9821 } else if (!strcasecmp(var->name, "debug")) {
9823 } else if (!strcasecmp(var->name, "httptimeout")) {
9824 newhttptimeout = atoi(val);
9825 } else if (!strcasecmp(var->name, "authtimeout")) {
9826 int timeout = atoi(var->value);
9827
9828 if (timeout < 1) {
9829 ast_log(LOG_WARNING, "Invalid authtimeout value '%s', using default value\n", var->value);
9830 } else {
9831 authtimeout = timeout;
9832 }
9833 } else if (!strcasecmp(var->name, "authlimit")) {
9834 int limit = atoi(var->value);
9835
9836 if (limit < 1) {
9837 ast_log(LOG_WARNING, "Invalid authlimit value '%s', using default value\n", var->value);
9838 } else {
9839 authlimit = limit;
9840 }
9841 } else if (!strcasecmp(var->name, "channelvars")) {
9843 } else if (!strcasecmp(var->name, "disabledevents")) {
9845 } else {
9846 ast_log(LOG_NOTICE, "Invalid keyword <%s> = <%s> in manager.conf [general]\n",
9847 var->name, val);
9848 }
9849 }
9850
9851 if (manager_enabled && !subscribed) {
9852 if (subscribe_all() != 0) {
9853 ast_log(LOG_ERROR, "Manager subscription error\n");
9854 return -1;
9855 }
9856 }
9857
9858 ast_sockaddr_copy(&amis_desc_local_address_tmp, &amis_desc.local_address);
9859
9860 /* if the amis address has not been set, default is the same as non secure ami */
9861 if (ast_sockaddr_isnull(&amis_desc_local_address_tmp)) {
9862 ast_sockaddr_copy(&amis_desc_local_address_tmp, &ami_desc_local_address_tmp);
9863 }
9864
9865 /* if the amis address was not set, it will have non-secure ami port set; if
9866 amis address was set, we need to check that a port was set or not, if not
9867 use the default tls port */
9868 if (ast_sockaddr_port(&amis_desc_local_address_tmp) == 0 ||
9869 (ast_sockaddr_port(&ami_desc_local_address_tmp) == ast_sockaddr_port(&amis_desc_local_address_tmp))) {
9870
9871 ast_sockaddr_set_port(&amis_desc_local_address_tmp, DEFAULT_MANAGER_TLS_PORT);
9872 }
9873
9874 if (manager_enabled) {
9875 ast_sockaddr_copy(&ami_desc.local_address, &ami_desc_local_address_tmp);
9876 ast_sockaddr_copy(&amis_desc.local_address, &amis_desc_local_address_tmp);
9877 }
9878
9880
9881 /* First, get users from users.conf */
9882 ucfg = ast_config_load2("users.conf", "manager", config_flags);
9883 if (ucfg && (ucfg != CONFIG_STATUS_FILEUNCHANGED) && ucfg != CONFIG_STATUS_FILEINVALID) {
9884 const char *hasmanager;
9885 int genhasmanager = ast_true(ast_variable_retrieve(ucfg, "general", "hasmanager"));
9886
9887 while ((cat = ast_category_browse(ucfg, cat))) {
9888 if (!strcasecmp(cat, "general")) {
9889 continue;
9890 }
9891
9892 hasmanager = ast_variable_retrieve(ucfg, cat, "hasmanager");
9893 if ((!hasmanager && genhasmanager) || ast_true(hasmanager)) {
9894 const char *user_secret = ast_variable_retrieve(ucfg, cat, "secret");
9895 const char *user_read = ast_variable_retrieve(ucfg, cat, "read");
9896 const char *user_write = ast_variable_retrieve(ucfg, cat, "write");
9897 const char *user_displayconnects = ast_variable_retrieve(ucfg, cat, "displayconnects");
9898 const char *user_allowmultiplelogin = ast_variable_retrieve(ucfg, cat, "allowmultiplelogin");
9899 const char *user_writetimeout = ast_variable_retrieve(ucfg, cat, "writetimeout");
9900
9901 /* Look for an existing entry,
9902 * if none found - create one and add it to the list
9903 */
9904 if (!(user = get_manager_by_name_locked(cat))) {
9905 if (!(user = ast_calloc(1, sizeof(*user)))) {
9906 break;
9907 }
9908
9909 /* Copy name over */
9910 ast_copy_string(user->username, cat, sizeof(user->username));
9911 /* Insert into list */
9913 user->acl = NULL;
9914 user->keep = 1;
9915 user->readperm = -1;
9916 user->writeperm = -1;
9917 /* Default displayconnect from [general] */
9918 user->displayconnects = displayconnects;
9919 /* Default allowmultiplelogin from [general] */
9920 user->allowmultiplelogin = allowmultiplelogin;
9921 user->writetimeout = 100;
9922 }
9923
9924 if (!user_secret) {
9925 user_secret = ast_variable_retrieve(ucfg, "general", "secret");
9926 }
9927 if (!user_read) {
9928 user_read = ast_variable_retrieve(ucfg, "general", "read");
9929 }
9930 if (!user_write) {
9931 user_write = ast_variable_retrieve(ucfg, "general", "write");
9932 }
9933 if (!user_displayconnects) {
9934 user_displayconnects = ast_variable_retrieve(ucfg, "general", "displayconnects");
9935 }
9936 if (!user_allowmultiplelogin) {
9937 user_allowmultiplelogin = ast_variable_retrieve(ucfg, "general", "allowmultiplelogin");
9938 }
9939 if (!user_writetimeout) {
9940 user_writetimeout = ast_variable_retrieve(ucfg, "general", "writetimeout");
9941 }
9942
9943 if (!ast_strlen_zero(user_secret)) {
9944 ast_free(user->secret);
9945 user->secret = ast_strdup(user_secret);
9946 }
9947
9948 if (user_read) {
9949 user->readperm = get_perm(user_read);
9950 }
9951 if (user_write) {
9952 user->writeperm = get_perm(user_write);
9953 }
9954 if (user_displayconnects) {
9955 user->displayconnects = ast_true(user_displayconnects);
9956 }
9957 if (user_allowmultiplelogin) {
9958 user->allowmultiplelogin = ast_true(user_allowmultiplelogin);
9959 }
9960 if (user_writetimeout) {
9961 int value = atoi(user_writetimeout);
9962 if (value < 100) {
9963 ast_log(LOG_WARNING, "Invalid writetimeout value '%d' in users.conf\n", value);
9964 } else {
9965 user->writetimeout = value;
9966 }
9967 }
9968 }
9969 }
9970 ast_config_destroy(ucfg);
9971 }
9972
9973 /* cat is NULL here in any case */
9974
9975 while ((cat = ast_category_browse(cfg, cat))) {
9976 struct ast_acl_list *oldacl;
9977
9978 if (!strcasecmp(cat, "general")) {
9979 continue;
9980 }
9981
9982 /* Look for an existing entry, if none found - create one and add it to the list */
9983 if (!(user = get_manager_by_name_locked(cat))) {
9984 if (!(user = ast_calloc(1, sizeof(*user)))) {
9985 break;
9986 }
9987 /* Copy name over */
9988 ast_copy_string(user->username, cat, sizeof(user->username));
9989
9990 user->acl = NULL;
9991 user->readperm = 0;
9992 user->writeperm = 0;
9993 /* Default displayconnect from [general] */
9994 user->displayconnects = displayconnects;
9995 /* Default allowmultiplelogin from [general] */
9996 user->allowmultiplelogin = allowmultiplelogin;
9997 user->writetimeout = 100;
10000 if (!user->includefilters || !user->excludefilters) {
10002 break;
10003 }
10004
10005 /* Insert into list */
10007 } else {
10008 ao2_t_callback(user->includefilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all include filters");
10009 ao2_t_callback(user->excludefilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all exclude filters");
10010 }
10011
10012 /* Make sure we keep this user and don't destroy it during cleanup */
10013 user->keep = 1;
10014 oldacl = user->acl;
10015 user->acl = NULL;
10016 ast_variables_destroy(user->chanvars);
10017
10018 var = ast_variable_browse(cfg, cat);
10019 for (; var; var = var->next) {
10020 if (!strcasecmp(var->name, "secret")) {
10021 ast_free(user->secret);
10022 user->secret = ast_strdup(var->value);
10023 } else if (!strcasecmp(var->name, "deny") ||
10024 !strcasecmp(var->name, "permit") ||
10025 !strcasecmp(var->name, "acl")) {
10026 int acl_error = 0;
10027
10028 ast_append_acl(var->name, var->value, &user->acl, &acl_error, &acl_subscription_flag);
10029 if (acl_error) {
10030 ast_log(LOG_ERROR, "Invalid ACL '%s' for manager user '%s' on line %d. Deleting user\n",
10031 var->value, user->username, var->lineno);
10032 user->keep = 0;
10033 }
10034 } else if (!strcasecmp(var->name, "read") ) {
10035 user->readperm = get_perm(var->value);
10036 } else if (!strcasecmp(var->name, "write") ) {
10037 user->writeperm = get_perm(var->value);
10038 } else if (!strcasecmp(var->name, "displayconnects") ) {
10039 user->displayconnects = ast_true(var->value);
10040 } else if (!strcasecmp(var->name, "allowmultiplelogin") ) {
10041 user->allowmultiplelogin = ast_true(var->value);
10042 } else if (!strcasecmp(var->name, "writetimeout")) {
10043 int value = atoi(var->value);
10044 if (value < 100) {
10045 ast_log(LOG_WARNING, "Invalid writetimeout value '%s' at line %d\n", var->value, var->lineno);
10046 } else {
10047 user->writetimeout = value;
10048 }
10049 } else if (!strcasecmp(var->name, "setvar")) {
10050 struct ast_variable *tmpvar;
10051 char varbuf[256];
10052 char *varval;
10053 char *varname;
10054
10055 ast_copy_string(varbuf, var->value, sizeof(varbuf));
10056 varname = varbuf;
10057
10058 if ((varval = strchr(varname,'='))) {
10059 *varval++ = '\0';
10060 if ((tmpvar = ast_variable_new(varname, varval, ""))) {
10061 tmpvar->next = user->chanvars;
10062 user->chanvars = tmpvar;
10063 }
10064 }
10065 } else if (ast_begins_with(var->name, "eventfilter")) {
10066 const char *value = var->value;
10067 manager_add_filter(var->name, value, user->includefilters, user->excludefilters);
10068 } else {
10069 ast_debug(1, "%s is an unknown option.\n", var->name);
10070 }
10071 }
10072
10073 oldacl = ast_free_acl_list(oldacl);
10074 }
10075 ast_config_destroy(cfg);
10076
10077 /* Check the flag for named ACL event subscription and if we need to, register a subscription. */
10078 if (acl_subscription_flag && !by_external_config) {
10080 }
10081
10082 /* Perform cleanup - essentially prune out old users that no longer exist */
10084 if (user->keep) { /* valid record. clear flag for the next round */
10085 user->keep = 0;
10086
10087 /* Calculate A1 for Digest auth */
10088 snprintf(a1, sizeof(a1), "%s:%s:%s", user->username, global_realm, user->secret);
10089 ast_md5_hash(a1_hash,a1);
10090 ast_free(user->a1_hash);
10091 user->a1_hash = ast_strdup(a1_hash);
10092 continue;
10093 }
10094 /* We do not need to keep this user so take them out of the list */
10096 ast_debug(4, "Pruning user '%s'\n", user->username);
10098 }
10100
10102
10104 if (!webregged) {
10108
10112 webregged = 1;
10113 }
10114 } else {
10115 if (webregged) {
10119
10123 webregged = 0;
10124 }
10125 }
10126
10127 if (newhttptimeout > 0) {
10128 httptimeout = newhttptimeout;
10129 }
10130
10132 if (tls_was_enabled && !ami_tls_cfg.enabled) {
10134 } else if (ast_ssl_setup(amis_desc.tls_cfg)) {
10136 }
10137
10138 return 0;
10139}
void ast_append_acl(const char *sense, const char *stuff, struct ast_acl_list **path, int *error, int *named_acl_flag)
Add a rule to an ACL struct.
Definition: acl.c:429
struct ast_acl_list * ast_free_acl_list(struct ast_acl_list *acl)
Free a list of ACLs.
Definition: acl.c:233
#define var
Definition: ast_expr2f.c:605
#define ast_free(a)
Definition: astmm.h:180
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
#define ast_log
Definition: astobj2.c:42
#define ao2_t_ref(o, delta, tag)
Definition: astobj2.h:460
@ AO2_ALLOC_OPT_LOCK_MUTEX
Definition: astobj2.h:363
#define ao2_global_obj_replace_unref(holder, obj)
Replace an ao2 object in the global holder, throwing away any old object.
Definition: astobj2.h:901
#define ao2_t_global_obj_replace_unref(holder, obj, tag)
Definition: astobj2.h:904
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
@ OBJ_NODATA
Definition: astobj2.h:1044
@ OBJ_MULTIPLE
Definition: astobj2.h:1049
@ OBJ_UNLINK
Definition: astobj2.h:1039
#define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn)
Allocate and initialize a list container.
Definition: astobj2.h:1327
#define ao2_t_callback(c, flags, cb_fn, arg, tag)
Definition: astobj2.h:1696
static struct unistimsession * sessions
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition: cli.h:265
static int action_setvar(struct mansession *s, const struct message *m)
Definition: manager.c:3552
static int action_createconfig(struct mansession *s, const struct message *m)
Definition: manager.c:3097
static int manager_state_cb(const char *context, const char *exten, struct ast_state_cb_info *info, void *data)
Definition: manager.c:7727
static int action_loggerrotate(struct mansession *s, const struct message *m)
Manager command "LoggerRotate" - reloads and rotates the logger in the same manner as the CLI command...
Definition: manager.c:6830
static struct ast_manager_user * get_manager_by_name_locked(const char *name)
Definition: manager.c:1046
static void acl_change_stasis_subscribe(void)
Definition: manager.c:235
static int append_event(const char *str, int event_name_hash, int category)
events are appended to a queue from where they can be dispatched to clients.
Definition: manager.c:7495
static int manager_enabled
Definition: manager.c:170
static int action_sendtext(struct mansession *s, const struct message *m)
Definition: manager.c:3908
static int action_mailboxcount(struct mansession *s, const struct message *m)
Definition: manager.c:5443
static int action_getconfigjson(struct mansession *s, const struct message *m)
Definition: manager.c:2649
static int action_listcategories(struct mansession *s, const struct message *m)
Definition: manager.c:2573
static int action_hangup(struct mansession *s, const struct message *m)
Definition: manager.c:3546
static int action_listcommands(struct mansession *s, const struct message *m)
Definition: manager.c:3289
static int action_atxfer(struct mansession *s, const struct message *m)
Definition: manager.c:4148
static int action_timeout(struct mansession *s, const struct message *m)
Definition: manager.c:5534
static int action_coresettings(struct mansession *s, const struct message *m)
Show PBX core settings information.
Definition: manager.c:6463
static int mansession_cmp_fn(void *obj, void *arg, int flags)
Definition: manager.c:1003
static int displayconnects
Definition: manager.c:165
static int action_filter(struct mansession *s, const struct message *m)
Manager command to add an event filter to a manager session.
Definition: manager.c:5686
static int manager_debug
Definition: manager.c:173
static int action_mailboxstatus(struct mansession *s, const struct message *m)
Definition: manager.c:5426
static int action_login(struct mansession *s, const struct message *m)
Definition: manager.c:3358
static int action_getvar(struct mansession *s, const struct message *m)
Definition: manager.c:3585
static int action_blind_transfer(struct mansession *s, const struct message *m)
Definition: manager.c:4102
static int action_extensionstate(struct mansession *s, const struct message *m)
Definition: manager.c:5464
static int action_getconfig(struct mansession *s, const struct message *m)
Definition: manager.c:2501
static enum add_filter_result manager_add_filter(const char *criteria, const char *filter_pattern, struct ao2_container *includefilters, struct ao2_container *excludefilters)
Add an event filter to a manager session.
Definition: manager.c:5753
static int action_logoff(struct mansession *s, const struct message *m)
Definition: manager.c:3352
static int action_updateconfig(struct mansession *s, const struct message *m)
Definition: manager.c:3006
static int manager_moduleload(struct mansession *s, const struct message *m)
Definition: manager.c:6907
static void acl_change_stasis_unsubscribe(void)
Definition: manager.c:245
static int action_reload(struct mansession *s, const struct message *m)
Send a reload event.
Definition: manager.c:6549
static int authlimit
Definition: manager.c:175
static int action_aocmessage(struct mansession *s, const struct message *m)
Definition: manager.c:4938
static int action_events(struct mansession *s, const struct message *m)
Definition: manager.c:3308
static int action_redirect(struct mansession *s, const struct message *m)
action_redirect: The redirect manager command
Definition: manager.c:3957
static int action_presencestate(struct mansession *s, const struct message *m)
Definition: manager.c:5494
static int allowmultiplelogin
Definition: manager.c:166
static int action_cancel_atxfer(struct mansession *s, const struct message *m)
Definition: manager.c:4202
static char global_realm[MAXHOSTNAMELEN]
Definition: manager.c:180
static int action_originate(struct mansession *s, const struct message *m)
Definition: manager.c:5231
static int action_userevent(struct mansession *s, const struct message *m)
Definition: manager.c:6442
static int action_command(struct mansession *s, const struct message *m)
Manager command "command" - execute CLI command.
Definition: manager.c:4279
static int broken_events_action
Definition: manager.c:169
static int timestampevents
Definition: manager.c:167
static int subscribed
Definition: manager.c:171
static int authtimeout
Definition: manager.c:174
static int manager_modulecheck(struct mansession *s, const struct message *m)
Manager function to check if module is loaded.
Definition: manager.c:6842
static int webmanager_enabled
Definition: manager.c:172
static int action_status(struct mansession *s, const struct message *m)
Manager "status" command to show channels.
Definition: manager.c:3752
static int get_perm(const char *instr)
Definition: manager.c:866
static int action_coreshowchannels(struct mansession *s, const struct message *m)
Manager command "CoreShowChannels" - List currently defined channels and some information about them.
Definition: manager.c:6581
static int action_corestatus(struct mansession *s, const struct message *m)
Show PBX core status information.
Definition: manager.c:6507
static int action_challenge(struct mansession *s, const struct message *m)
Definition: manager.c:3407
static struct stasis_topic * manager_topic
A stasis_topic that all topics AMI cares about will be forwarded to.
Definition: manager.c:186
static int action_waitevent(struct mansession *s, const struct message *m)
Definition: manager.c:3171
static int action_coreshowchannelmap(struct mansession *s, const struct message *m)
Manager command "CoreShowChannelMap" - Lists all channels connected to the specified channel.
Definition: manager.c:6749
static int action_ping(struct mansession *s, const struct message *m)
Definition: manager.c:2429
static int httptimeout
Definition: manager.c:168
void ast_http_uri_unlink(struct ast_http_uri *urihandler)
Unregister a URI handler.
Definition: http.c:721
int ast_http_uri_link(struct ast_http_uri *urihandler)
Register a URI handler.
Definition: http.c:689
struct ast_config * ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags)
Load a config file.
Definition: main/config.c:3541
char * ast_category_browse(struct ast_config *config, const char *prev_name)
Browse categories.
Definition: extconf.c:3326
@ CONFIG_FLAG_FILEUNCHANGED
#define ast_variable_new(name, value, filename)
#define CONFIG_STATUS_FILEUNCHANGED
#define CONFIG_STATUS_FILEINVALID
int ast_parse_arg(const char *arg, enum ast_parse_flags flags, void *p_result,...)
The argument parsing routine.
Definition: main/config.c:4047
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition: extconf.c:1289
const char * ast_variable_retrieve(struct ast_config *config, const char *category, const char *variable)
Definition: main/config.c:869
void ast_variables_destroy(struct ast_variable *var)
Free variable list.
Definition: extconf.c:1262
struct ast_variable * ast_variable_browse(const struct ast_config *config, const char *category_name)
Definition: extconf.c:1215
#define ast_debug(level,...)
Log a DEBUG message.
#define LOG_ERROR
#define LOG_NOTICE
#define LOG_WARNING
#define AST_RWLIST_REMOVE_CURRENT
Definition: linkedlists.h:570
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
Definition: linkedlists.h:545
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:731
#define AST_RWLIST_TRAVERSE_SAFE_END
Definition: linkedlists.h:617
#define AST_RWLIST_INSERT_TAIL
Definition: linkedlists.h:741
static struct ast_tls_config ami_tls_cfg
Definition: manager.c:9108
static struct ast_tcptls_session_args ami_desc
Definition: manager.c:9109
static struct ast_http_uri managerxmluri
Definition: manager.c:8948
static struct ast_tcptls_session_args amis_desc
Definition: manager.c:9120
static struct ast_custom_function managerclient_function
description of AMI_CLIENT dialplan function
Definition: manager.c:9081
static void load_channelvars(struct ast_variable *var)
Definition: manager.c:9396
static struct ast_http_uri manageruri
Definition: manager.c:8940
static void manager_set_defaults(void)
Definition: manager.c:9616
static struct ast_http_uri arawmanuri
Definition: manager.c:8991
static struct ast_http_uri rawmanuri
Definition: manager.c:8932
static struct ast_cli_entry cli_manager[]
Definition: manager.c:9373
static void manager_free_user(struct ast_manager_user *user)
Definition: manager.c:9429
static struct ast_http_uri amanageruri
Definition: manager.c:9000
static int webregged
Definition: manager.c:9087
static int subscribe_all(void)
Definition: manager.c:9586
static struct ast_http_uri amanagerxmluri
Definition: manager.c:9009
static void load_disabledevents(struct ast_variable *var)
Definition: manager.c:9419
#define EVENT_FLAG_REPORTING
Definition: manager.h:84
#define ast_manager_register_xml_core(action, authority, func)
Register a manager callback using XML documentation to describe the manager.
Definition: manager.h:203
#define EVENT_FLAG_CONFIG
Definition: manager.h:82
#define EVENT_FLAG_SYSTEM
Definition: manager.h:75
struct stasis_message_type * ast_manager_get_generic_type(void)
Get the stasis_message_type for generic messages.
#define DEFAULT_MANAGER_PORT
Definition: manager.h:58
#define DEFAULT_MANAGER_TLS_PORT
Definition: manager.h:59
#define EVENT_FLAG_CALL
Definition: manager.h:76
#define EVENT_FLAG_COMMAND
Definition: manager.h:79
#define EVENT_FLAG_USER
Definition: manager.h:81
#define EVENT_FLAG_AOC
Definition: manager.h:91
#define EVENT_FLAG_ORIGINATE
Definition: manager.h:87
#define ast_sockaddr_port(addr)
Get the port number of a socket address.
Definition: netsock2.h:517
static void ast_sockaddr_copy(struct ast_sockaddr *dst, const struct ast_sockaddr *src)
Copies the data from one ast_sockaddr to another.
Definition: netsock2.h:167
int ast_sockaddr_parse(struct ast_sockaddr *addr, const char *str, int flags)
Parse an IPv4 or IPv6 address string.
Definition: netsock2.c:230
static int ast_sockaddr_isnull(const struct ast_sockaddr *addr)
Checks if the ast_sockaddr is null. "null" in this sense essentially means uninitialized,...
Definition: netsock2.h:127
#define ast_sockaddr_set_port(addr, port)
Sets the port number of a socket address.
Definition: netsock2.h:532
static char * ast_sockaddr_stringify_addr(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() to return an address only.
Definition: netsock2.h:286
int __ast_custom_function_register(struct ast_custom_function *acf, struct ast_module *mod)
Register a custom function.
int ast_extension_state_add(const char *context, const char *exten, ast_state_cb_type change_cb, void *data)
Add watcher for extension states.
Definition: pbx.c:3838
static int reload(void)
#define NULL
Definition: resample.c:96
struct stasis_topic * stasis_topic_create(const char *name)
Create a new topic.
Definition: stasis.c:644
#define STASIS_MESSAGE_TYPE_INIT(name)
Boiler-plate messaging macro for initializing message types.
Definition: stasis.h:1493
struct stasis_forward * stasis_forward_all(struct stasis_topic *from_topic, struct stasis_topic *to_topic)
Create a subscription which forwards all messages from one topic to another.
Definition: stasis.c:1605
static force_inline int attribute_pure ast_str_hash(const char *str)
Compute a hash value on a string.
Definition: strings.h:1259
int attribute_pure ast_true(const char *val)
Make sure something is true. Determine if a string containing a boolean value is "true"....
Definition: utils.c:2199
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425
static int force_inline attribute_pure ast_begins_with(const char *str, const char *prefix)
Checks whether a string begins with another.
Definition: strings.h:97
Generic container type.
Wrapper for an ast_acl linked list.
Definition: acl.h:76
Structure used to handle boolean flags.
Definition: utils.h:199
user descriptor, as read from the config file.
Definition: manager.c:346
Socket address structure.
Definition: netsock2.h:97
struct ast_sockaddr local_address
Definition: tcptls.h:131
struct ast_tls_config * tls_cfg
Definition: tcptls.h:135
int enabled
Definition: tcptls.h:89
Structure for variables, used for configurations and for channel variables.
struct ast_variable * next
structure to hold users read from users.conf
list of users found in the config file
Definition: ast_expr2.c:325
int value
Definition: syslog.c:37
void ast_tcptls_server_stop(struct ast_tcptls_session_args *desc)
Shutdown a running server if there is one.
Definition: tcptls.c:933
int ast_ssl_setup(struct ast_tls_config *cfg)
Set up an SSL server.
Definition: tcptls.c:577
void ast_tcptls_server_start(struct ast_tcptls_session_args *desc)
This is a generic (re)start routine for a TCP server, which does the socket/bind/listen and starts a ...
Definition: tcptls.c:768
int ast_tls_read_conf(struct ast_tls_config *tls_cfg, struct ast_tcptls_session_args *tls_desc, const char *varname, const char *value)
Used to parse conf files containing tls/ssl options.
Definition: tcptls.c:959
#define ARRAY_LEN(a)
Definition: utils.h:666
void ast_md5_hash(char *output, const char *input)
Produces MD5 hash based on input string.
Definition: utils.c:250
struct ao2_container * ast_xmldoc_build_documentation(const char *type)
Build the documentation for a particular source type.
Definition: xmldoc.c:2778

References __ast_custom_function_register(), acl_change_stasis_subscribe(), acl_change_stasis_unsubscribe(), action_aocmessage(), action_atxfer(), action_blind_transfer(), action_cancel_atxfer(), action_challenge(), action_command(), action_coresettings(), action_coreshowchannelmap(), action_coreshowchannels(), action_corestatus(), action_createconfig(), action_events(), action_extensionstate(), action_filter(), action_getconfig(), action_getconfigjson(), action_getvar(), action_hangup(), action_listcategories(), action_listcommands(), action_loggerrotate(), action_login(), action_logoff(), action_mailboxcount(), action_mailboxstatus(), action_originate(), action_ping(), action_presencestate(), action_redirect(), action_reload(), action_sendtext(), action_setvar(), action_status(), action_timeout(), action_updateconfig(), action_userevent(), action_waitevent(), allowmultiplelogin, amanageruri, amanagerxmluri, ami_desc, ami_tls_cfg, amis_desc, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_list, ao2_global_obj_replace_unref, ao2_ref, ao2_t_callback, ao2_t_global_obj_replace_unref, ao2_t_ref, append_event(), arawmanuri, ARRAY_LEN, ast_append_acl(), ast_begins_with(), ast_calloc, ast_category_browse(), ast_cli_register_multiple, ast_config_destroy(), ast_config_load2(), ast_copy_string(), ast_debug, ast_extension_state_add(), ast_free, ast_free_acl_list(), ast_http_uri_link(), ast_http_uri_unlink(), AST_LIST_INSERT_TAIL, ast_log, ast_manager_get_generic_type(), ast_manager_register_xml_core, ast_md5_hash(), ast_parse_arg(), AST_RWLIST_INSERT_TAIL, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_sockaddr_copy(), ast_sockaddr_isnull(), ast_sockaddr_parse(), ast_sockaddr_port, ast_sockaddr_set_port, ast_sockaddr_stringify_addr(), ast_ssl_setup(), ast_str_hash(), ast_strdup, ast_strlen_zero(), ast_tcptls_server_start(), ast_tcptls_server_stop(), ast_tls_read_conf(), ast_true(), ast_variable_browse(), ast_variable_new, ast_variable_retrieve(), ast_variables_destroy(), ast_xmldoc_build_documentation(), authlimit, authtimeout, broken_events_action, cli_manager, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, DEFAULT_MANAGER_PORT, DEFAULT_MANAGER_TLS_PORT, displayconnects, ast_tls_config::enabled, EVENT_FLAG_AOC, EVENT_FLAG_CALL, EVENT_FLAG_COMMAND, EVENT_FLAG_CONFIG, EVENT_FLAG_ORIGINATE, EVENT_FLAG_REPORTING, EVENT_FLAG_SYSTEM, EVENT_FLAG_USER, get_manager_by_name_locked(), get_perm(), global_realm, httptimeout, load_channelvars(), load_disabledevents(), ast_tcptls_session_args::local_address, LOG_ERROR, LOG_NOTICE, LOG_WARNING, manager_add_filter(), manager_debug, manager_enabled, manager_free_user(), manager_modulecheck(), manager_moduleload(), manager_set_defaults(), manager_state_cb(), manager_topic, managerclient_function, manageruri, managerxmluri, mansession_cmp_fn(), ast_variable::next, NULL, OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, PARSE_ADDR, PARSE_IN_RANGE, PARSE_PORT_IGNORE, PARSE_UINT32, rawmanuri, reload(), sessions, stasis_forward_all(), STASIS_MESSAGE_TYPE_INIT, stasis_topic_create(), subscribe_all(), subscribed, timestampevents, ast_tcptls_session_args::tls_cfg, value, var, webmanager_enabled, and webregged.

Referenced by acl_change_stasis_cb(), load_module(), and reload_module().

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 10276 of file manager.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 10276 of file manager.c.

◆ ast_manager_event_blob_create()

struct ast_manager_event_blob * ast_manager_event_blob_create ( int  event_flags,
const char *  manager_event,
const char *  extra_fields_fmt,
  ... 
)

Construct a ast_manager_event_blob.

Since
12

The returned object is AO2 managed, so clean up with ao2_cleanup().

Parameters
event_flagsFlags the event should be raised with.
manager_eventThe event to be raised, should be a string literal.
extra_fields_fmtFormat string for extra fields to include. Or NO_EXTRA_FIELDS for no extra fields.
Returns
New ast_manager_event_blob object.
Return values
NULLon error.

Definition at line 10237 of file manager.c.

10242{
10243 struct ast_manager_event_blob *ev;
10244 va_list argp;
10245
10246 ast_assert(extra_fields_fmt != NULL);
10248
10250 if (!ev) {
10251 return NULL;
10252 }
10253
10254 if (ast_string_field_init(ev, 20)) {
10255 ao2_ref(ev, -1);
10256 return NULL;
10257 }
10258
10261
10262 va_start(argp, extra_fields_fmt);
10263 ast_string_field_ptr_build_va(ev, &ev->extra_fields, extra_fields_fmt, argp);
10264 va_end(argp);
10265
10266 return ev;
10267}
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition: astobj2.h:367
#define ao2_alloc_options(data_size, destructor_fn, options)
Definition: astobj2.h:404
static void manager_event_blob_dtor(void *obj)
Definition: manager.c:10228
#define manager_event(category, event, contents,...)
External routines may send asterisk manager events this way.
Definition: manager.h:254
#define ast_string_field_ptr_build_va(x, ptr, fmt, args)
Set a field to a complex (built) value with prebuilt va_lists.
Definition: stringfields.h:573
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
Definition: stringfields.h:359
Struct containing info for an AMI event to send out.
Definition: manager.h:503
const ast_string_field extra_fields
Definition: manager.h:508
const char * manager_event
Definition: manager.h:505
#define ast_assert(a)
Definition: utils.h:739

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_ref, ast_assert, ast_string_field_init, ast_string_field_ptr_build_va, ast_manager_event_blob::event_flags, ast_manager_event_blob::extra_fields, manager_event, ast_manager_event_blob::manager_event, manager_event_blob_dtor(), and NULL.

Referenced by agent_login_to_ami(), agent_logoff_to_ami(), agi_channel_to_ami(), aoc_to_ami(), attended_transfer_to_ami(), blind_transfer_to_ami(), bridge_create(), bridge_destroy(), bridge_video_update(), call_pickup_to_ami(), cc_available_to_ami(), cc_callerrecalling_to_ami(), cc_callerstartmonitoring_to_ami(), cc_callerstopmonitoring_to_ami(), cc_failure_to_ami(), cc_monitorfailed_to_ami(), cc_offertimerstart_to_ami(), cc_recallcomplete_to_ami(), cc_requestacknowledged_to_ami(), cc_requested_to_ami(), channel_new_accountcode(), channel_new_callerid(), channel_new_connected_line(), channel_newexten(), channel_state_change(), contactstatus_to_ami(), dahdichannel_to_ami(), devstate_to_ami(), fake_ami(), local_message_to_ami(), multi_user_event_to_ami(), peerstatus_to_ami(), presence_state_to_ami(), queue_channel_to_ami(), queue_member_to_ami(), queue_multi_channel_to_ami(), rtcp_report_to_ami(), security_event_to_ami_blob(), system_registry_to_ami(), talking_start_to_ami(), talking_stop_to_ami(), and varset_to_ami().

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 10276 of file manager.c.

◆ ast_str_append_event_header()

int ast_str_append_event_header ( struct ast_str **  fields_string,
const char *  header,
const char *  value 
)

append an event header to an ast string

Since
12
Parameters
fields_stringpointer to an ast_string pointer. It may be a pointer to a NULL ast_str pointer, in which case the ast_str will be initialized.
headerThe header being applied
valuethe value of the header
Return values
0if successful
non-zeroon failure

Definition at line 10215 of file manager.c.

10217{
10218 if (!*fields_string) {
10219 *fields_string = ast_str_create(128);
10220 if (!*fields_string) {
10221 return -1;
10222 }
10223 }
10224
10225 return (ast_str_append(fields_string, 0, "%s: %s\r\n", header, value) < 0) ? -1 : 0;
10226}
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659

References ast_str_append(), ast_str_create, and value.

Referenced by confbridge_talking_cb(), get_bool_header(), and meetme_stasis_cb().

◆ ast_xml_doc_item_cmp_fn()

static int ast_xml_doc_item_cmp_fn ( const void *  a,
const void *  b 
)
static

Definition at line 9175 of file manager.c.

9176{
9177 struct ast_xml_doc_item **item_a = (struct ast_xml_doc_item **)a;
9178 struct ast_xml_doc_item **item_b = (struct ast_xml_doc_item **)b;
9179 return strcmp((*item_a)->name, (*item_b)->name);
9180}
Struct that contains the XML documentation for a particular item. Note that this is an ao2 ref counte...
Definition: xmldoc.h:56
static struct test_val b
static struct test_val a

References a, and b.

Referenced by handle_manager_show_events().

◆ astman_datastore_add()

int astman_datastore_add ( struct mansession s,
struct ast_datastore datastore 
)

Add a datastore to a session.

Return values
0success
non-zerofailure
Since
1.6.1

Definition at line 10176 of file manager.c.

10177{
10178 AST_LIST_INSERT_HEAD(&s->session->datastores, datastore, entry);
10179
10180 return 0;
10181}
#define AST_LIST_INSERT_HEAD(head, elm, field)
Inserts a list entry at the head of a list.
Definition: linkedlists.h:711
struct mansession_session::mansession_datastores datastores
struct mansession_session * session
Definition: manager.c:328

References AST_LIST_INSERT_HEAD, mansession_session::datastores, and mansession::session.

◆ astman_datastore_find()

struct ast_datastore * astman_datastore_find ( struct mansession s,
const struct ast_datastore_info info,
const char *  uid 
)

Find a datastore on a session.

Returns
pointer to the datastore if found
Return values
NULLif not found
Since
1.6.1

Definition at line 10188 of file manager.c.

10189{
10190 struct ast_datastore *datastore = NULL;
10191
10192 if (info == NULL)
10193 return NULL;
10194
10196 if (datastore->info != info) {
10197 continue;
10198 }
10199
10200 if (uid == NULL) {
10201 /* matched by type only */
10202 break;
10203 }
10204
10205 if ((datastore->uid != NULL) && !strcasecmp(uid, datastore->uid)) {
10206 /* Matched by type AND uid */
10207 break;
10208 }
10209 }
10211
10212 return datastore;
10213}
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
Definition: linkedlists.h:615
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
Definition: linkedlists.h:529
def info(msg)
Structure for a data store object.
Definition: datastore.h:64
const struct ast_datastore_info * info
Definition: datastore.h:67
const char * uid
Definition: datastore.h:65
struct ast_datastore::@216 entry

References AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, mansession_session::datastores, ast_datastore::entry, sip_to_pjsip::info(), ast_datastore::info, NULL, mansession::session, and ast_datastore::uid.

◆ astman_datastore_remove()

int astman_datastore_remove ( struct mansession s,
struct ast_datastore datastore 
)

Remove a datastore from a session.

Return values
0success
non-zerofailure
Since
1.6.1

Definition at line 10183 of file manager.c.

10184{
10185 return AST_LIST_REMOVE(&s->session->datastores, datastore, entry) ? 0 : -1;
10186}
#define AST_LIST_REMOVE(head, elm, field)
Removes a specific entry from a list.
Definition: linkedlists.h:856

References AST_LIST_REMOVE, mansession_session::datastores, and mansession::session.

◆ astman_is_authed()

int astman_is_authed ( uint32_t  ident)

Determine if a manager session ident is authenticated.

Definition at line 7998 of file manager.c.

7999{
8000 int authed;
8002
8003 if (!(session = find_session(ident, 0)))
8004 return 0;
8005
8006 authed = (session->authenticated != 0);
8007
8010
8011 return authed;
8012}
static struct ast_mansession session
#define ao2_unlock(a)
Definition: astobj2.h:729
static struct mansession_session * unref_mansession(struct mansession_session *s)
Unreference manager session object. If no more references, then go ahead and delete it.
Definition: manager.c:918
static struct mansession_session * find_session(uint32_t ident, int incinuse)
Definition: manager.c:7926

References ao2_unlock, find_session(), session, and unref_mansession().

Referenced by http_post_callback(), and static_callback().

◆ astman_verify_session_readpermissions()

int astman_verify_session_readpermissions ( uint32_t  ident,
int  perm 
)

Verify a session's read permissions against a permission mask.

Parameters
identsession identity
permpermission mask to verify
Return values
1if the session has the permission mask capabilities
0otherwise

Definition at line 8014 of file manager.c.

8015{
8016 int result = 0;
8018 struct ao2_container *sessions;
8019 struct ao2_iterator i;
8020
8021 if (ident == 0) {
8022 return 0;
8023 }
8024
8025 sessions = ao2_global_obj_ref(mgr_sessions);
8026 if (!sessions) {
8027 return 0;
8028 }
8030 ao2_ref(sessions, -1);
8031 while ((session = ao2_iterator_next(&i))) {
8033 if ((session->managerid == ident) && (session->readperm & perm)) {
8034 result = 1;
8037 break;
8038 }
8041 }
8043
8044 return result;
8045}
#define ao2_iterator_next(iter)
Definition: astobj2.h:1911
#define ao2_global_obj_ref(holder)
Get a reference to the object stored in the global holder.
Definition: astobj2.h:918
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
#define ao2_lock(a)
Definition: astobj2.h:717
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
static PGresult * result
Definition: cel_pgsql.c:84
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821

References ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, result, session, sessions, and unref_mansession().

◆ astman_verify_session_writepermissions()

int astman_verify_session_writepermissions ( uint32_t  ident,
int  perm 
)

Verify a session's write permissions against a permission mask.

Parameters
identsession identity
permpermission mask to verify
Return values
1if the session has the permission mask capabilities, otherwise 0
0otherwise

Definition at line 8047 of file manager.c.

8048{
8049 int result = 0;
8051 struct ao2_container *sessions;
8052 struct ao2_iterator i;
8053
8054 if (ident == 0) {
8055 return 0;
8056 }
8057
8058 sessions = ao2_global_obj_ref(mgr_sessions);
8059 if (!sessions) {
8060 return 0;
8061 }
8063 ao2_ref(sessions, -1);
8064 while ((session = ao2_iterator_next(&i))) {
8066 if ((session->managerid == ident) && (session->writeperm & perm)) {
8067 result = 1;
8070 break;
8071 }
8074 }
8076
8077 return result;
8078}

References ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, result, session, sessions, and unref_mansession().

Referenced by http_post_callback().

◆ auth_http_callback()

static int auth_http_callback ( struct ast_tcptls_session_instance ser,
enum ast_http_method  method,
enum output_format  format,
const struct ast_sockaddr remote_address,
const char *  uri,
struct ast_variable get_params,
struct ast_variable headers 
)
static

Definition at line 8576 of file manager.c.

8582{
8584 struct mansession s = { .session = NULL, .tcptls_session = ser };
8585 struct ast_variable *v, *params = get_params;
8586 char template[] = "/tmp/ast-http-XXXXXX"; /* template for temporary file */
8587 struct ast_str *http_header = NULL, *out = NULL;
8588 size_t result_size;
8589 struct message m = { 0 };
8590 int fd;
8591
8592 time_t time_now = time(NULL);
8593 unsigned long nonce = 0, nc;
8594 struct ast_http_digest d = { NULL, };
8595 struct ast_manager_user *user = NULL;
8596 int stale = 0;
8597 char resp_hash[256]="";
8598 /* Cache for user data */
8599 char u_username[80];
8600 int u_readperm;
8601 int u_writeperm;
8602 int u_writetimeout;
8603 int u_displayconnects;
8604
8606 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
8607 return 0;
8608 }
8609
8610 /* Find "Authorization: " header */
8611 for (v = headers; v; v = v->next) {
8612 if (!strcasecmp(v->name, "Authorization")) {
8613 break;
8614 }
8615 }
8616
8617 if (!v || ast_strlen_zero(v->value)) {
8618 goto out_401; /* Authorization Header not present - send auth request */
8619 }
8620
8621 /* Digest found - parse */
8622 if (ast_string_field_init(&d, 128)) {
8624 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8625 return 0;
8626 }
8627
8628 if (ast_parse_digest(v->value, &d, 0, 1)) {
8629 /* Error in Digest - send new one */
8630 nonce = 0;
8631 goto out_401;
8632 }
8633 if (sscanf(d.nonce, "%30lx", &nonce) != 1) {
8634 ast_log(LOG_WARNING, "Received incorrect nonce in Digest <%s>\n", d.nonce);
8635 nonce = 0;
8636 goto out_401;
8637 }
8638
8640 user = get_manager_by_name_locked(d.username);
8641 if(!user) {
8643 ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_sockaddr_stringify_addr(&session->addr), d.username);
8644 nonce = 0;
8645 goto out_401;
8646 }
8647
8648 /* --- We have User for this auth, now check ACL */
8649 if (user->acl && !ast_apply_acl(user->acl, remote_address, "Manager User ACL:")) {
8651 ast_log(LOG_NOTICE, "%s failed to pass IP ACL as '%s'\n", ast_sockaddr_stringify_addr(&session->addr), d.username);
8653 ast_http_error(ser, 403, "Permission denied", "Permission denied");
8654 return 0;
8655 }
8656
8657 /* --- We have auth, so check it */
8658
8659 /* compute the expected response to compare with what we received */
8660 {
8661 char *a2;
8662 /* ast_md5_hash outputs 32 characters plus NULL terminator. */
8663 char a2_hash[33];
8664 char resp[256];
8665
8666 /* XXX Now request method are hardcoded in A2 */
8667 if (ast_asprintf(&a2, "%s:%s", ast_get_http_method(method), d.uri) < 0) {
8670 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8671 return 0;
8672 }
8673
8674 ast_md5_hash(a2_hash, a2);
8675 ast_free(a2);
8676
8677 if (d.qop) {
8678 /* RFC 2617 */
8679 snprintf(resp, sizeof(resp), "%s:%08lx:%s:%s:auth:%s", user->a1_hash, nonce, d.nc, d.cnonce, a2_hash);
8680 } else {
8681 /* RFC 2069 */
8682 snprintf(resp, sizeof(resp), "%s:%08lx:%s", user->a1_hash, nonce, a2_hash);
8683 }
8684 ast_md5_hash(resp_hash, resp);
8685 }
8686
8687 if (strncasecmp(d.response, resp_hash, strlen(resp_hash))) {
8688 /* Something was wrong, so give the client to try with a new challenge */
8690 nonce = 0;
8691 goto out_401;
8692 }
8693
8694 /*
8695 * User are pass Digest authentication.
8696 * Now, cache the user data and unlock user list.
8697 */
8698 ast_copy_string(u_username, user->username, sizeof(u_username));
8699 u_readperm = user->readperm;
8700 u_writeperm = user->writeperm;
8701 u_displayconnects = user->displayconnects;
8702 u_writetimeout = user->writetimeout;
8704
8705 if (!(session = find_session_by_nonce(d.username, nonce, &stale))) {
8706 /*
8707 * Create new session.
8708 * While it is not in the list we don't need any locking
8709 */
8710 if (!(session = build_mansession(remote_address))) {
8712 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8713 return 0;
8714 }
8716
8717 ast_copy_string(session->username, u_username, sizeof(session->username));
8718 session->managerid = nonce;
8719 session->last_ev = grab_last();
8720 AST_LIST_HEAD_INIT_NOLOCK(&session->datastores);
8721
8722 session->readperm = u_readperm;
8723 session->writeperm = u_writeperm;
8724 session->writetimeout = u_writetimeout;
8725
8726 if (u_displayconnects) {
8727 ast_verb(2, "HTTP Manager '%s' logged in from %s\n", session->username, ast_sockaddr_stringify_addr(&session->addr));
8728 }
8729 session->noncetime = session->sessionstart = time_now;
8730 session->authenticated = 1;
8731 } else if (stale) {
8732 /*
8733 * Session found, but nonce is stale.
8734 *
8735 * This could be because an old request (w/old nonce) arrived.
8736 *
8737 * This may be as the result of http proxy usage (separate delay or
8738 * multipath) or in a situation where a page was refreshed too quickly
8739 * (seen in Firefox).
8740 *
8741 * In this situation, we repeat the 401 auth with the current nonce
8742 * value.
8743 */
8744 nonce = session->managerid;
8746 stale = 1;
8747 goto out_401;
8748 } else {
8749 sscanf(d.nc, "%30lx", &nc);
8750 if (session->nc >= nc || ((time_now - session->noncetime) > 62) ) {
8751 /*
8752 * Nonce time expired (> 2 minutes) or something wrong with nonce
8753 * counter.
8754 *
8755 * Create new nonce key and resend Digest auth request. Old nonce
8756 * is saved for stale checking...
8757 */
8758 session->nc = 0; /* Reset nonce counter */
8759 session->oldnonce = session->managerid;
8760 nonce = session->managerid = ast_random();
8761 session->noncetime = time_now;
8763 stale = 1;
8764 goto out_401;
8765 } else {
8766 session->nc = nc; /* All OK, save nonce counter */
8767 }
8768 }
8769
8770
8771 /* Reset session timeout. */
8772 session->sessiontimeout = time(NULL) + (httptimeout > 5 ? httptimeout : 5);
8774
8775 ast_mutex_init(&s.lock);
8776 s.session = session;
8777 fd = mkstemp(template); /* create a temporary file for command output */
8778 unlink(template);
8779 if (fd <= -1) {
8780 ast_http_error(ser, 500, "Server Error", "Internal Server Error (mkstemp failed)");
8781 goto auth_callback_out;
8782 }
8784 if (!s.stream) {
8785 ast_log(LOG_WARNING, "HTTP Manager, fdopen failed: %s!\n", strerror(errno));
8786 ast_http_error(ser, 500, "Server Error", "Internal Server Error (fdopen failed)");
8787 close(fd);
8788 goto auth_callback_out;
8789 }
8790
8791 if (method == AST_HTTP_POST) {
8792 params = ast_http_get_post_vars(ser, headers);
8793 if (!params) {
8794 switch (errno) {
8795 case EFBIG:
8796 ast_http_error(ser, 413, "Request Entity Too Large", "Body too large");
8798 goto auth_callback_out;
8799 case ENOMEM:
8801 ast_http_error(ser, 500, "Server Error", "Out of memory");
8803 goto auth_callback_out;
8804 case EIO:
8805 ast_http_error(ser, 400, "Bad Request", "Error parsing request body");
8807 goto auth_callback_out;
8808 }
8809 }
8810 }
8811
8812 astman_append_headers(&m, params);
8813
8814 if (process_message(&s, &m)) {
8815 if (u_displayconnects) {
8816 ast_verb(2, "HTTP Manager '%s' logged off from %s\n", session->username, ast_sockaddr_stringify_addr(&session->addr));
8817 }
8818
8819 session->needdestroy = 1;
8820 }
8821
8823
8824 result_size = lseek(ast_iostream_get_fd(s.stream), 0, SEEK_CUR); /* Calculate approx. size of result */
8825
8826 http_header = ast_str_create(80);
8827 out = ast_str_create(result_size * 2 + 512);
8828 if (http_header == NULL || out == NULL) {
8830 ast_http_error(ser, 500, "Server Error", "Internal Server Error (ast_str_create() out of memory)");
8832 goto auth_callback_out;
8833 }
8834
8835 ast_str_append(&http_header, 0, "Content-type: text/%s\r\n", contenttype[format]);
8836
8837 if (format == FORMAT_XML) {
8838 ast_str_append(&out, 0, "<ajax-response>\n");
8839 } else if (format == FORMAT_HTML) {
8840 ast_str_append(&out, 0,
8841 "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\r\n"
8842 "<html><head>\r\n"
8843 "<title>Asterisk&trade; Manager Interface</title>\r\n"
8844 "</head><body style=\"background-color: #ffffff;\">\r\n"
8845 "<form method=\"POST\">\r\n"
8846 "<table align=\"center\" style=\"background-color: #f1f1f1;\" width=\"500\">\r\n"
8847 "<tr><th colspan=\"2\" style=\"background-color: #f1f1ff;\"><h1>Manager Tester</h1></th></tr>\r\n"
8848 "<tr><th colspan=\"2\" style=\"background-color: #f1f1ff;\">Action: <input name=\"action\" /> Cmd: <input name=\"command\" /><br>"
8849 "<input type=\"submit\" value=\"Send request\" /></th></tr>\r\n");
8850 }
8851
8852 process_output(&s, &out, params, format);
8853
8854 if (format == FORMAT_XML) {
8855 ast_str_append(&out, 0, "</ajax-response>\n");
8856 } else if (format == FORMAT_HTML) {
8857 ast_str_append(&out, 0, "</table></form></body></html>\r\n");
8858 }
8859
8860 ast_http_send(ser, method, 200, NULL, http_header, out, 0, 0);
8861 http_header = NULL;
8862 out = NULL;
8863
8864auth_callback_out:
8866
8867 /* Clear resources and unlock manager session */
8868 if (method == AST_HTTP_POST && params) {
8869 ast_variables_destroy(params);
8870 }
8871
8872 ast_free(http_header);
8873 ast_free(out);
8874
8876 if (session->stream) {
8877 ast_iostream_close(session->stream);
8878 session->stream = NULL;
8879 }
8881
8882 if (session->needdestroy) {
8883 ast_debug(1, "Need destroy, doing it now!\n");
8885 }
8887 return 0;
8888
8889out_401:
8890 if (!nonce) {
8891 nonce = ast_random();
8892 }
8893
8894 ast_http_auth(ser, global_realm, nonce, nonce, stale, NULL);
8896 return 0;
8897}
enum ast_acl_sense ast_apply_acl(struct ast_acl_list *acl_list, const struct ast_sockaddr *addr, const char *purpose)
Apply a set of rules to a given IP address.
Definition: acl.c:799
#define ast_asprintf(ret, fmt,...)
A wrapper for asprintf()
Definition: astmm.h:267
static int process_message(struct mansession *s, const struct message *m)
Process an AMI message, performing desired action. Return 0 on success, -1 on error that require the ...
Definition: manager.c:7027
static struct mansession_session * build_mansession(const struct ast_sockaddr *addr)
Allocate manager session structure and add it to the list of sessions.
Definition: manager.c:970
static void astman_free_headers(struct message *m)
Free headers inside message structure, but not the message structure itself.
Definition: manager.c:1671
static void session_destroy(struct mansession_session *s)
Definition: manager.c:1010
static void astman_append_headers(struct message *m, const struct ast_variable *params)
Append additional headers into the message structure from params.
Definition: manager.c:1657
static struct eventqent * grab_last(void)
Definition: manager.c:698
void ast_http_send(struct ast_tcptls_session_instance *ser, enum ast_http_method method, int status_code, const char *status_title, struct ast_str *http_header, struct ast_str *out, int fd, unsigned int static_content)
Generic function for sending HTTP/1.1 response.
Definition: http.c:472
struct ast_variable * ast_http_get_post_vars(struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
Get post variables from client Request Entity-Body, if content type is application/x-www-form-urlenco...
Definition: http.c:1405
@ AST_HTTP_POST
Definition: http.h:61
@ AST_HTTP_GET
Definition: http.h:60
@ AST_HTTP_HEAD
Definition: http.h:62
const char * ast_get_http_method(enum ast_http_method method) attribute_pure
Return http method name string.
Definition: http.c:193
void ast_http_auth(struct ast_tcptls_session_instance *ser, const char *realm, const unsigned long nonce, const unsigned long opaque, int stale, const char *text)
Send http "401 Unauthorized" response and close socket.
Definition: http.c:638
void ast_http_request_close_on_completion(struct ast_tcptls_session_instance *ser)
Request the HTTP connection be closed after this HTTP request.
Definition: http.c:853
void ast_http_error(struct ast_tcptls_session_instance *ser, int status, const char *title, const char *text)
Send HTTP error message and close socket.
Definition: http.c:664
#define ast_verb(level,...)
struct ast_iostream * ast_iostream_from_fd(int *fd)
Create an iostream from a file descriptor.
Definition: iostream.c:611
int ast_iostream_get_fd(struct ast_iostream *stream)
Get an iostream's file descriptor.
Definition: iostream.c:85
int ast_iostream_close(struct ast_iostream *stream)
Close an iostream.
Definition: iostream.c:539
#define AST_LIST_HEAD_INIT_NOLOCK(head)
Initializes a list head structure.
Definition: linkedlists.h:681
#define ast_mutex_init(pmutex)
Definition: lock.h:190
#define ast_mutex_destroy(a)
Definition: lock.h:192
int errno
static void close_mansession_file(struct mansession *s)
Definition: manager.c:8321
static struct mansession_session * find_session_by_nonce(const char *username, unsigned long nonce, int *stale)
Definition: manager.c:7965
static void process_output(struct mansession *s, struct ast_str **out, struct ast_variable *params, enum output_format format)
Definition: manager.c:8331
static const char *const contenttype[]
Definition: manager.c:7915
const char * method
Definition: res_pjsip.c:1279
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition: stringfields.h:374
Support for dynamic strings.
Definition: strings.h:623
In case you didn't read that giant block of text above the mansession_session struct,...
Definition: manager.c:327
struct ast_iostream * stream
Definition: manager.c:329
ast_mutex_t lock
Definition: manager.c:334
static struct test_val d
FILE * out
Definition: utils/frame.c:33
int ast_parse_digest(const char *digest, struct ast_http_digest *d, int request, int pedantic)
Parse digest authorization header.
Definition: utils.c:2638
long int ast_random(void)
Definition: utils.c:2312

References ao2_lock, ao2_unlock, ast_apply_acl(), ast_asprintf, ast_copy_string(), ast_debug, ast_free, ast_get_http_method(), ast_http_auth(), ast_http_error(), AST_HTTP_GET, ast_http_get_post_vars(), AST_HTTP_HEAD, AST_HTTP_POST, ast_http_request_close_on_completion(), ast_http_send(), ast_iostream_close(), ast_iostream_from_fd(), ast_iostream_get_fd(), AST_LIST_HEAD_INIT_NOLOCK, ast_log, ast_md5_hash(), ast_mutex_destroy, ast_mutex_init, ast_parse_digest(), ast_random(), AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_sockaddr_stringify_addr(), ast_str_append(), ast_str_create, ast_string_field_free_memory, ast_string_field_init, ast_strlen_zero(), ast_variables_destroy(), ast_verb, astman_append_headers(), astman_free_headers(), build_mansession(), close_mansession_file(), contenttype, d, errno, find_session_by_nonce(), FORMAT_HTML, FORMAT_XML, get_manager_by_name_locked(), global_realm, grab_last(), httptimeout, mansession::lock, LOG_NOTICE, LOG_WARNING, method, ast_variable::name, ast_variable::next, NULL, out, process_message(), process_output(), mansession::session, session, session_destroy(), mansession::stream, and ast_variable::value.

Referenced by auth_manager_http_callback(), auth_mxml_http_callback(), and auth_rawman_http_callback().

◆ auth_manager_http_callback()

static int auth_manager_http_callback ( struct ast_tcptls_session_instance ser,
const struct ast_http_uri urih,
const char *  uri,
enum ast_http_method  method,
struct ast_variable get_params,
struct ast_variable headers 
)
static

Definition at line 8958 of file manager.c.

8959{
8960 int retval;
8961 struct ast_sockaddr ser_remote_address_tmp;
8962
8963 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8964 retval = auth_http_callback(ser, method, FORMAT_HTML, &ser_remote_address_tmp, uri, get_params, headers);
8965 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8966 return retval;
8967}
static int auth_http_callback(struct ast_tcptls_session_instance *ser, enum ast_http_method method, enum output_format format, const struct ast_sockaddr *remote_address, const char *uri, struct ast_variable *get_params, struct ast_variable *headers)
Definition: manager.c:8576
struct ast_sockaddr remote_address
Definition: tcptls.h:153

References ast_sockaddr_copy(), auth_http_callback(), FORMAT_HTML, method, and ast_tcptls_session_instance::remote_address.

◆ auth_mxml_http_callback()

static int auth_mxml_http_callback ( struct ast_tcptls_session_instance ser,
const struct ast_http_uri urih,
const char *  uri,
enum ast_http_method  method,
struct ast_variable get_params,
struct ast_variable headers 
)
static

Definition at line 8969 of file manager.c.

8970{
8971 int retval;
8972 struct ast_sockaddr ser_remote_address_tmp;
8973
8974 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8975 retval = auth_http_callback(ser, method, FORMAT_XML, &ser_remote_address_tmp, uri, get_params, headers);
8976 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8977 return retval;
8978}

References ast_sockaddr_copy(), auth_http_callback(), FORMAT_XML, method, and ast_tcptls_session_instance::remote_address.

◆ auth_rawman_http_callback()

static int auth_rawman_http_callback ( struct ast_tcptls_session_instance ser,
const struct ast_http_uri urih,
const char *  uri,
enum ast_http_method  method,
struct ast_variable get_params,
struct ast_variable headers 
)
static

Definition at line 8980 of file manager.c.

8981{
8982 int retval;
8983 struct ast_sockaddr ser_remote_address_tmp;
8984
8985 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8986 retval = auth_http_callback(ser, method, FORMAT_RAW, &ser_remote_address_tmp, uri, get_params, headers);
8987 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8988 return retval;
8989}

References ast_sockaddr_copy(), auth_http_callback(), FORMAT_RAW, method, and ast_tcptls_session_instance::remote_address.

◆ close_mansession_file()

static void close_mansession_file ( struct mansession s)
static

Definition at line 8321 of file manager.c.

8322{
8323 if (s->stream) {
8325 s->stream = NULL;
8326 } else {
8327 ast_log(LOG_ERROR, "Attempted to close file/file descriptor on mansession without a valid file or file descriptor.\n");
8328 }
8329}

References ast_iostream_close(), ast_log, LOG_ERROR, NULL, and mansession::stream.

Referenced by auth_http_callback(), generic_http_callback(), and process_output().

◆ find_session()

static struct mansession_session * find_session ( uint32_t  ident,
int  incinuse 
)
static

locate an http session in the list. The search key (ident) is the value of the mansession_id cookie (0 is not valid and means a session on the AMI socket).

Definition at line 7926 of file manager.c.

7927{
7928 struct ao2_container *sessions;
7930 struct ao2_iterator i;
7931
7932 if (ident == 0) {
7933 return NULL;
7934 }
7935
7936 sessions = ao2_global_obj_ref(mgr_sessions);
7937 if (!sessions) {
7938 return NULL;
7939 }
7941 ao2_ref(sessions, -1);
7942 while ((session = ao2_iterator_next(&i))) {
7944 if (session->managerid == ident && !session->needdestroy) {
7945 ast_atomic_fetchadd_int(&session->inuse, incinuse ? 1 : 0);
7946 break;
7947 }
7950 }
7952
7953 return session;
7954}
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition: lock.h:761

References ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, ast_atomic_fetchadd_int(), NULL, session, sessions, and unref_mansession().

Referenced by astman_is_authed(), generic_http_callback(), and manager_fax_session().

◆ find_session_by_nonce()

static struct mansession_session * find_session_by_nonce ( const char *  username,
unsigned long  nonce,
int *  stale 
)
static

locate an http session in the list. The search keys (nonce) and (username) is value from received "Authorization" http header. As well as in find_session() function, the value of the nonce can't be zero. (0 meansi, that the session used for AMI socket connection). Flag (stale) is set, if client used valid, but old, nonce value.

Definition at line 7965 of file manager.c.

7966{
7968 struct ao2_container *sessions;
7969 struct ao2_iterator i;
7970
7971 if (nonce == 0 || username == NULL || stale == NULL) {
7972 return NULL;
7973 }
7974
7975 sessions = ao2_global_obj_ref(mgr_sessions);
7976 if (!sessions) {
7977 return NULL;
7978 }
7980 ao2_ref(sessions, -1);
7981 while ((session = ao2_iterator_next(&i))) {
7983 if (!strcasecmp(session->username, username) && session->managerid == nonce) {
7984 *stale = 0;
7985 break;
7986 } else if (!strcasecmp(session->username, username) && session->oldnonce == nonce) {
7987 *stale = 1;
7988 break;
7989 }
7992 }
7994
7995 return session;
7996}

References ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, NULL, session, sessions, and unref_mansession().

Referenced by auth_http_callback().

◆ function_amiclient()

static int function_amiclient ( struct ast_channel chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
)
static

${AMI_CLIENT()} Dialplan function - reads manager client data

Definition at line 9034 of file manager.c.

9035{
9036 struct ast_manager_user *user = NULL;
9037
9040 AST_APP_ARG(param);
9041 );
9042
9043
9044 if (ast_strlen_zero(data) ) {
9045 ast_log(LOG_WARNING, "AMI_CLIENT() requires two arguments: AMI_CLIENT(<name>[,<arg>])\n");
9046 return -1;
9047 }
9049 args.name = ast_strip(args.name);
9050 args.param = ast_strip(args.param);
9051
9053 if (!(user = get_manager_by_name_locked(args.name))) {
9055 ast_log(LOG_ERROR, "There's no manager user called : \"%s\"\n", args.name);
9056 return -1;
9057 }
9059
9060 if (!strcasecmp(args.param, "sessions")) {
9061 int no_sessions = 0;
9062 struct ao2_container *sessions;
9063
9064 sessions = ao2_global_obj_ref(mgr_sessions);
9065 if (sessions) {
9066 ao2_callback_data(sessions, 0, get_manager_sessions_cb, /*login name*/ data, &no_sessions);
9067 ao2_ref(sessions, -1);
9068 }
9069 snprintf(buf, len, "%d", no_sessions);
9070 } else {
9071 ast_log(LOG_ERROR, "Invalid arguments provided to function AMI_CLIENT: %s\n", args.param);
9072 return -1;
9073
9074 }
9075
9076 return 0;
9077}
#define ao2_callback_data(container, flags, cb_fn, arg, data)
Definition: astobj2.h:1723
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
static const char name[]
Definition: format_mp3.c:68
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
#define AST_APP_ARG(name)
Define an application argument.
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:78
static int get_manager_sessions_cb(void *obj, void *arg, void *data, int flags)
Get number of logged in sessions for a login name.
Definition: manager.c:9019
char * ast_strip(char *s)
Strip leading/trailing whitespace from a string.
Definition: strings.h:223
const char * args

References ao2_callback_data, ao2_global_obj_ref, ao2_ref, args, AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, AST_STANDARD_APP_ARGS, ast_strip(), ast_strlen_zero(), buf, get_manager_by_name_locked(), get_manager_sessions_cb(), len(), LOG_ERROR, LOG_WARNING, name, NULL, and sessions.

◆ generic_http_callback()

static int generic_http_callback ( struct ast_tcptls_session_instance ser,
enum ast_http_method  method,
enum output_format  format,
const struct ast_sockaddr remote_address,
const char *  uri,
struct ast_variable get_params,
struct ast_variable headers 
)
static
Note
There is approximately a 1 in 1.8E19 chance that the following calculation will produce 0, which is an invalid ID, but due to the properties of the rand() function (and the constancy of s), that won't happen twice in a row.

Definition at line 8364 of file manager.c.

8370{
8371 struct mansession s = { .session = NULL, .tcptls_session = ser };
8373 uint32_t ident;
8374 int fd;
8375 int blastaway = 0;
8376 struct ast_variable *params = get_params;
8377 char template[] = "/tmp/ast-http-XXXXXX"; /* template for temporary file */
8378 struct ast_str *http_header = NULL, *out = NULL;
8379 struct message m = { 0 };
8380
8382 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
8383 return 0;
8384 }
8385
8386 ident = ast_http_manid_from_vars(headers);
8387
8388 if (!(session = find_session(ident, 1))) {
8389
8390 /**/
8391 /* Create new session.
8392 * While it is not in the list we don't need any locking
8393 */
8394 if (!(session = build_mansession(remote_address))) {
8396 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8397 return 0;
8398 }
8400 session->send_events = 0;
8401 session->inuse = 1;
8402 /*!
8403 * \note There is approximately a 1 in 1.8E19 chance that the following
8404 * calculation will produce 0, which is an invalid ID, but due to the
8405 * properties of the rand() function (and the constancy of s), that
8406 * won't happen twice in a row.
8407 */
8408 while ((session->managerid = ast_random() ^ (unsigned long) session) == 0) {
8409 }
8410 session->last_ev = grab_last();
8411 AST_LIST_HEAD_INIT_NOLOCK(&session->datastores);
8412 }
8414
8415 http_header = ast_str_create(128);
8416 out = ast_str_create(2048);
8417
8418 ast_mutex_init(&s.lock);
8419
8420 if (http_header == NULL || out == NULL) {
8422 ast_http_error(ser, 500, "Server Error", "Internal Server Error (ast_str_create() out of memory)");
8423 goto generic_callback_out;
8424 }
8425
8426 s.session = session;
8427 fd = mkstemp(template); /* create a temporary file for command output */
8428 unlink(template);
8429 if (fd <= -1) {
8430 ast_http_error(ser, 500, "Server Error", "Internal Server Error (mkstemp failed)");
8431 goto generic_callback_out;
8432 }
8434 if (!s.stream) {
8435 ast_log(LOG_WARNING, "HTTP Manager, fdopen failed: %s!\n", strerror(errno));
8436 ast_http_error(ser, 500, "Server Error", "Internal Server Error (fdopen failed)");
8437 close(fd);
8438 goto generic_callback_out;
8439 }
8440
8441 if (method == AST_HTTP_POST) {
8442 params = ast_http_get_post_vars(ser, headers);
8443 if (!params) {
8444 switch (errno) {
8445 case EFBIG:
8446 ast_http_error(ser, 413, "Request Entity Too Large", "Body too large");
8448 goto generic_callback_out;
8449 case ENOMEM:
8451 ast_http_error(ser, 500, "Server Error", "Out of memory");
8453 goto generic_callback_out;
8454 case EIO:
8455 ast_http_error(ser, 400, "Bad Request", "Error parsing request body");
8457 goto generic_callback_out;
8458 }
8459 }
8460 }
8461
8462 astman_append_headers(&m, params);
8463
8464 if (process_message(&s, &m)) {
8465 if (session->authenticated) {
8467 ast_verb(2, "HTTP Manager '%s' logged off from %s\n", session->username, ast_sockaddr_stringify_addr(&session->addr));
8468 }
8469 } else {
8470 if (displayconnects) {
8471 ast_verb(2, "HTTP Connect attempt from '%s' unable to authenticate\n", ast_sockaddr_stringify_addr(&session->addr));
8472 }
8473 }
8474 session->needdestroy = 1;
8475 }
8476
8478
8479 ast_str_append(&http_header, 0,
8480 "Content-type: text/%s\r\n"
8481 "Set-Cookie: mansession_id=\"%08x\"; Version=1; Max-Age=%d\r\n"
8482 "Pragma: SuppressEvents\r\n",
8483 contenttype[format],
8484 session->managerid, httptimeout);
8485
8486 if (format == FORMAT_XML) {
8487 ast_str_append(&out, 0, "<ajax-response>\n");
8488 } else if (format == FORMAT_HTML) {
8489 /*
8490 * When handling AMI-over-HTTP in HTML format, we provide a simple form for
8491 * debugging purposes. This HTML code should not be here, we
8492 * should read from some config file...
8493 */
8494
8495#define ROW_FMT "<tr><td colspan=\"2\" bgcolor=\"#f1f1ff\">%s</td></tr>\r\n"
8496#define TEST_STRING \
8497 "<form action=\"manager\" method=\"post\">\n\
8498 Action: <select name=\"action\">\n\
8499 <option value=\"\">-----&gt;</option>\n\
8500 <option value=\"login\">login</option>\n\
8501 <option value=\"command\">Command</option>\n\
8502 <option value=\"waitevent\">waitevent</option>\n\
8503 <option value=\"listcommands\">listcommands</option>\n\
8504 </select>\n\
8505 or <input name=\"action\"><br/>\n\
8506 CLI Command <input name=\"command\"><br>\n\
8507 user <input name=\"username\"> pass <input type=\"password\" name=\"secret\"><br>\n\
8508 <input type=\"submit\">\n</form>\n"
8509
8510 ast_str_append(&out, 0, "<title>Asterisk&trade; Manager Interface</title>");
8511 ast_str_append(&out, 0, "<body bgcolor=\"#ffffff\"><table align=center bgcolor=\"#f1f1f1\" width=\"500\">\r\n");
8512 ast_str_append(&out, 0, ROW_FMT, "<h1>Manager Tester</h1>");
8514 }
8515
8516 process_output(&s, &out, params, format);
8517
8518 if (format == FORMAT_XML) {
8519 ast_str_append(&out, 0, "</ajax-response>\n");
8520 } else if (format == FORMAT_HTML) {
8521 ast_str_append(&out, 0, "</table></body>\r\n");
8522 }
8523
8525 /* Reset HTTP timeout. If we're not authenticated, keep it extremely short */
8526 session->sessiontimeout = time(NULL) + ((session->authenticated || httptimeout < 5) ? httptimeout : 5);
8527
8528 if (session->needdestroy) {
8529 if (session->inuse == 1) {
8530 ast_debug(1, "Need destroy, doing it now!\n");
8531 blastaway = 1;
8532 } else {
8533 ast_debug(1, "Need destroy, but can't do it yet!\n");
8534 ast_mutex_lock(&session->notify_lock);
8535 if (session->waiting_thread != AST_PTHREADT_NULL) {
8536 pthread_kill(session->waiting_thread, SIGURG);
8537 }
8538 ast_mutex_unlock(&session->notify_lock);
8539 session->inuse--;
8540 }
8541 } else {
8542 session->inuse--;
8543 }
8545
8546 ast_http_send(ser, method, 200, NULL, http_header, out, 0, 0);
8547 http_header = NULL;
8548 out = NULL;
8549
8550generic_callback_out:
8552
8553 /* Clear resource */
8554
8555 if (method == AST_HTTP_POST && params) {
8556 ast_variables_destroy(params);
8557 }
8558 ast_free(http_header);
8559 ast_free(out);
8560
8561 if (session) {
8562 if (blastaway) {
8564 } else {
8565 if (session->stream) {
8566 ast_iostream_close(session->stream);
8567 session->stream = NULL;
8568 }
8570 }
8571 }
8572
8573 return 0;
8574}
static int manager_displayconnects(struct mansession_session *session)
Get displayconnects config option.
Definition: manager.c:1063
uint32_t ast_http_manid_from_vars(struct ast_variable *headers) attribute_pure
Return manager id, if exist, from request headers.
Definition: http.c:233
#define AST_PTHREADT_NULL
Definition: lock.h:70
#define ast_mutex_unlock(a)
Definition: lock.h:194
#define ast_mutex_lock(a)
Definition: lock.h:193
#define ROW_FMT
#define TEST_STRING

References ao2_lock, ao2_unlock, ast_debug, ast_free, ast_http_error(), AST_HTTP_GET, ast_http_get_post_vars(), AST_HTTP_HEAD, ast_http_manid_from_vars(), AST_HTTP_POST, ast_http_request_close_on_completion(), ast_http_send(), ast_iostream_close(), ast_iostream_from_fd(), AST_LIST_HEAD_INIT_NOLOCK, ast_log, ast_mutex_destroy, ast_mutex_init, ast_mutex_lock, ast_mutex_unlock, AST_PTHREADT_NULL, ast_random(), ast_sockaddr_stringify_addr(), ast_str_append(), ast_str_create, ast_variables_destroy(), ast_verb, astman_append_headers(), astman_free_headers(), build_mansession(), close_mansession_file(), contenttype, displayconnects, errno, find_session(), FORMAT_HTML, FORMAT_XML, grab_last(), httptimeout, mansession::lock, LOG_WARNING, manager_displayconnects(), method, NULL, out, process_message(), process_output(), ROW_FMT, mansession::session, session, session_destroy(), mansession::stream, TEST_STRING, and unref_mansession().

Referenced by manager_http_callback(), mxml_http_callback(), and rawman_http_callback().

◆ get_manager_sessions_cb()

static int get_manager_sessions_cb ( void *  obj,
void *  arg,
void *  data,
int  flags 
)
static

Get number of logged in sessions for a login name.

Definition at line 9019 of file manager.c.

9020{
9021 struct mansession_session *session = obj;
9022 const char *login = (char *)arg;
9023 int *no_sessions = data;
9024
9025 if (strcasecmp(session->username, login) == 0) {
9026 (*no_sessions)++;
9027 }
9028
9029 return 0;
9030}

References session.

Referenced by function_amiclient().

◆ handle_manager_show_event()

static char * handle_manager_show_event ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 9311 of file manager.c.

9312{
9314 struct ao2_iterator it_events;
9315 struct ast_xml_doc_item *item, *temp;
9316 int length;
9317
9318 if (cmd == CLI_INIT) {
9319 e->command = "manager show event";
9320 e->usage =
9321 "Usage: manager show event <eventname>\n"
9322 " Provides a detailed description a Manager interface event.\n";
9323 return NULL;
9324 }
9325
9326 events = ao2_global_obj_ref(event_docs);
9327 if (!events) {
9328 ast_cli(a->fd, "No manager event documentation loaded\n");
9329 return CLI_SUCCESS;
9330 }
9331
9332 if (cmd == CLI_GENERATE) {
9333 if (a->pos != 3) {
9334 return NULL;
9335 }
9336
9337 length = strlen(a->word);
9338 it_events = ao2_iterator_init(events, 0);
9339 while ((item = ao2_iterator_next(&it_events))) {
9340 if (!strncasecmp(a->word, item->name, length)) {
9342 ao2_ref(item, -1);
9343 break;
9344 }
9345 }
9346 ao2_ref(item, -1);
9347 }
9348 ao2_iterator_destroy(&it_events);
9349
9350 return NULL;
9351 }
9352
9353 if (a->argc != 4) {
9354 return CLI_SHOWUSAGE;
9355 }
9356
9357 if (!(item = ao2_find(events, a->argv[3], OBJ_KEY))) {
9358 ast_cli(a->fd, "Could not find event '%s'\n", a->argv[3]);
9359 return CLI_SUCCESS;
9360 }
9361
9362 ast_cli(a->fd, "Event: %s\n", a->argv[3]);
9363 for (temp = item; temp; temp = AST_LIST_NEXT(temp, next)) {
9364 print_event_instance(a, temp);
9365 }
9366
9367 ao2_ref(item, -1);
9368 return CLI_SUCCESS;
9369}
static const struct adsi_event events[]
Definition: app_adsiprog.c:88
#define OBJ_KEY
Definition: astobj2.h:1151
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define ao2_find(container, arg, flags)
Definition: astobj2.h:1736
#define CLI_SHOWUSAGE
Definition: cli.h:45
#define CLI_SUCCESS
Definition: cli.h:44
int ast_cli_completion_add(char *value)
Add a result to a request for completion options.
Definition: main/cli.c:2768
void ast_cli(int fd, const char *fmt,...)
Definition: clicompat.c:6
@ CLI_INIT
Definition: cli.h:152
@ CLI_GENERATE
Definition: cli.h:153
static void print_event_instance(struct ast_cli_args *a, struct ast_xml_doc_item *instance)
Definition: manager.c:9263
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:439
const char * name
char * command
Definition: cli.h:186
const char * usage
Definition: cli.h:177
struct ast_xml_doc_item * next
Definition: xmldoc.h:80
static struct aco_type item
Definition: test_config.c:1463
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941

References a, ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli(), ast_cli_completion_add(), AST_LIST_NEXT, ast_strdup, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, events, item, aco_type::name, ast_xml_doc_item::next, NULL, OBJ_KEY, print_event_instance(), RAII_VAR, and ast_cli_entry::usage.

◆ handle_manager_show_events()

static char * handle_manager_show_events ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 9182 of file manager.c.

9183{
9184 struct ao2_container *events;
9185 struct ao2_iterator *it_events;
9186 struct ast_xml_doc_item *item;
9187 struct ast_xml_doc_item **items;
9188 struct ast_str *buffer;
9189 int i = 0, totalitems = 0;
9190
9191 switch (cmd) {
9192 case CLI_INIT:
9193 e->command = "manager show events";
9194 e->usage =
9195 "Usage: manager show events\n"
9196 " Prints a listing of the available Asterisk manager interface events.\n";
9197 return NULL;
9198 case CLI_GENERATE:
9199 return NULL;
9200 }
9201 if (a->argc != 3) {
9202 return CLI_SHOWUSAGE;
9203 }
9204
9205 buffer = ast_str_create(128);
9206 if (!buffer) {
9207 return CLI_SUCCESS;
9208 }
9209
9210 events = ao2_global_obj_ref(event_docs);
9211 if (!events) {
9212 ast_cli(a->fd, "No manager event documentation loaded\n");
9213 ast_free(buffer);
9214 return CLI_SUCCESS;
9215 }
9216
9218 if (!(it_events = ao2_callback(events, OBJ_MULTIPLE | OBJ_NOLOCK, NULL, NULL))) {
9220 ast_log(AST_LOG_ERROR, "Unable to create iterator for events container\n");
9221 ast_free(buffer);
9222 ao2_ref(events, -1);
9223 return CLI_SUCCESS;
9224 }
9225 if (!(items = ast_calloc(sizeof(struct ast_xml_doc_item *), ao2_container_count(events)))) {
9227 ast_log(AST_LOG_ERROR, "Unable to create temporary sorting array for events\n");
9228 ao2_iterator_destroy(it_events);
9229 ast_free(buffer);
9230 ao2_ref(events, -1);
9231 return CLI_SUCCESS;
9232 }
9234
9235 while ((item = ao2_iterator_next(it_events))) {
9236 items[totalitems++] = item;
9237 ao2_ref(item, -1);
9238 }
9239
9240 qsort(items, totalitems, sizeof(struct ast_xml_doc_item *), ast_xml_doc_item_cmp_fn);
9241
9242 ast_cli(a->fd, "Events:\n");
9243 ast_cli(a->fd, " -------------------- -------------------- -------------------- \n");
9244 for (i = 0; i < totalitems; i++) {
9245 ast_str_append(&buffer, 0, " %-20.20s", items[i]->name);
9246 if ((i + 1) % 3 == 0) {
9247 ast_cli(a->fd, "%s\n", ast_str_buffer(buffer));
9248 ast_str_set(&buffer, 0, "%s", "");
9249 }
9250 }
9251 if ((i + 1) % 3 != 0) {
9252 ast_cli(a->fd, "%s\n", ast_str_buffer(buffer));
9253 }
9254
9255 ao2_iterator_destroy(it_events);
9256 ast_free(items);
9257 ao2_ref(events, -1);
9258 ast_free(buffer);
9259
9260 return CLI_SUCCESS;
9261}
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition: astobj2.h:1693
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
@ OBJ_NOLOCK
Assume that the ao2_container is already locked.
Definition: astobj2.h:1063
#define AST_LOG_ERROR
static int ast_xml_doc_item_cmp_fn(const void *a, const void *b)
Definition: manager.c:9175
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition: strings.h:1113

References a, ao2_callback, ao2_container_count(), ao2_global_obj_ref, ao2_iterator_destroy(), ao2_iterator_next, ao2_lock, ao2_ref, ao2_unlock, ast_calloc, ast_cli(), ast_free, ast_log, AST_LOG_ERROR, ast_str_append(), ast_str_buffer(), ast_str_create, ast_str_set(), ast_xml_doc_item_cmp_fn(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, events, item, name, NULL, OBJ_MULTIPLE, OBJ_NOLOCK, and ast_cli_entry::usage.

◆ handle_manager_show_settings()

static char * handle_manager_show_settings ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

CLI command manager show settings.

Definition at line 9131 of file manager.c.

9132{
9133 switch (cmd) {
9134 case CLI_INIT:
9135 e->command = "manager show settings";
9136 e->usage =
9137 "Usage: manager show settings\n"
9138 " Provides detailed list of the configuration of the Manager.\n";
9139 return NULL;
9140 case CLI_GENERATE:
9141 return NULL;
9142 }
9143#define FORMAT " %-25.25s %-15.55s\n"
9144#define FORMAT2 " %-25.25s %-15d\n"
9145#define FORMAT3 " %-25.25s %s\n"
9146 if (a->argc != 3) {
9147 return CLI_SHOWUSAGE;
9148 }
9149 ast_cli(a->fd, "\nGlobal Settings:\n");
9150 ast_cli(a->fd, "----------------\n");
9151 ast_cli(a->fd, FORMAT, "Manager (AMI):", AST_CLI_YESNO(manager_enabled));
9152 ast_cli(a->fd, FORMAT, "Web Manager (AMI/HTTP):", AST_CLI_YESNO(webmanager_enabled));
9153 ast_cli(a->fd, FORMAT, "TCP Bindaddress:", manager_enabled != 0 ? ast_sockaddr_stringify(&ami_desc.local_address) : "Disabled");
9154 ast_cli(a->fd, FORMAT2, "HTTP Timeout (seconds):", httptimeout);
9155 ast_cli(a->fd, FORMAT, "TLS Enable:", AST_CLI_YESNO(ami_tls_cfg.enabled));
9156 ast_cli(a->fd, FORMAT, "TLS Bindaddress:", ami_tls_cfg.enabled != 0 ? ast_sockaddr_stringify(&amis_desc.local_address) : "Disabled");
9157 ast_cli(a->fd, FORMAT, "TLS Certfile:", ami_tls_cfg.certfile);
9158 ast_cli(a->fd, FORMAT, "TLS Privatekey:", ami_tls_cfg.pvtfile);
9159 ast_cli(a->fd, FORMAT, "TLS Cipher:", ami_tls_cfg.cipher);
9160 ast_cli(a->fd, FORMAT, "Allow multiple login:", AST_CLI_YESNO(allowmultiplelogin));
9161 ast_cli(a->fd, FORMAT, "Display connects:", AST_CLI_YESNO(displayconnects));
9162 ast_cli(a->fd, FORMAT, "Timestamp events:", AST_CLI_YESNO(timestampevents));
9163 ast_cli(a->fd, FORMAT3, "Channel vars:", S_OR(manager_channelvars, ""));
9164 ast_cli(a->fd, FORMAT3, "Disabled events:", S_OR(manager_disabledevents, ""));
9165 ast_cli(a->fd, FORMAT, "Debug:", AST_CLI_YESNO(manager_debug));
9166#undef FORMAT
9167#undef FORMAT2
9168#undef FORMAT3
9169
9170 return CLI_SUCCESS;
9171}
#define AST_CLI_YESNO(x)
Return Yes or No depending on the argument.
Definition: cli.h:71
static char * manager_channelvars
Definition: manager.c:176
static char * manager_disabledevents
Definition: manager.c:177
#define FORMAT3
#define FORMAT
#define FORMAT2
static char * ast_sockaddr_stringify(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() with default format.
Definition: netsock2.h:256
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition: strings.h:80
char * certfile
Definition: tcptls.h:90
char * cipher
Definition: tcptls.h:92
char * pvtfile
Definition: tcptls.h:91

References a, allowmultiplelogin, ami_desc, ami_tls_cfg, amis_desc, ast_cli(), AST_CLI_YESNO, ast_sockaddr_stringify(), ast_tls_config::certfile, ast_tls_config::cipher, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, displayconnects, ast_tls_config::enabled, FORMAT, FORMAT2, FORMAT3, httptimeout, ast_tcptls_session_args::local_address, manager_channelvars, manager_debug, manager_disabledevents, manager_enabled, NULL, ast_tls_config::pvtfile, S_OR, timestampevents, ast_cli_entry::usage, and webmanager_enabled.

◆ load_channelvars()

static void load_channelvars ( struct ast_variable var)
static

Definition at line 9396 of file manager.c.

9397{
9398 char *parse = NULL;
9400 AST_APP_ARG(vars)[MAX_VARS];
9401 );
9402
9405
9406 /* parse the setting */
9409
9411}
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
void ast_channel_set_manager_vars(size_t varc, char **vars)
Sets the variables to be stored in the manager_vars field of all snapshots.
Definition: channel.c:7913
#define MAX_VARS
Definition: manager.c:209

References args, AST_APP_ARG, ast_channel_set_manager_vars(), AST_DECLARE_APP_ARGS, ast_free, AST_STANDARD_APP_ARGS, ast_strdup, ast_strdupa, manager_channelvars, MAX_VARS, NULL, and var.

Referenced by __init_manager().

◆ load_disabledevents()

static void load_disabledevents ( struct ast_variable var)
static

Definition at line 9419 of file manager.c.

References ast_free, ast_strdup, manager_disabledevents, and var.

Referenced by __init_manager().

◆ load_module()

static int load_module ( void  )
static

Definition at line 10158 of file manager.c.

10159{
10160 int rc = 0;
10163#ifdef TEST_FRAMEWORK
10164 AST_TEST_REGISTER(eventfilter_test_creation);
10165 AST_TEST_REGISTER(eventfilter_test_matching);
10166 AST_TEST_REGISTER(originate_permissions_test);
10167#endif
10168 return rc;
10169}
int ast_register_cleanup(void(*func)(void))
Register a function to be executed before Asterisk gracefully exits.
Definition: clicompat.c:19
static int __init_manager(int reload, int by_external_config)
Definition: manager.c:9644
static void manager_shutdown(void)
Definition: manager.c:9448
@ AST_MODULE_LOAD_FAILURE
Module could not be loaded properly.
Definition: module.h:102
@ AST_MODULE_LOAD_SUCCESS
Definition: module.h:70
#define AST_TEST_REGISTER(cb)
Definition: test.h:127

References __init_manager(), AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, ast_register_cleanup(), AST_TEST_REGISTER, and manager_shutdown().

◆ manager_event_blob_dtor()

static void manager_event_blob_dtor ( void *  obj)
static

Definition at line 10228 of file manager.c.

10229{
10230 struct ast_manager_event_blob *ev = obj;
10231
10233}

References ast_string_field_free_memory.

Referenced by ast_manager_event_blob_create().

◆ manager_free_user()

static void manager_free_user ( struct ast_manager_user user)
static

Definition at line 9429 of file manager.c.

9430{
9431 ast_free(user->a1_hash);
9432 ast_free(user->secret);
9433 if (user->includefilters) {
9434 ao2_t_ref(user->includefilters, -1, "decrement ref for include container, should be last one");
9435 }
9436 if (user->excludefilters) {
9437 ao2_t_ref(user->excludefilters, -1, "decrement ref for exclude container, should be last one");
9438 }
9439 user->acl = ast_free_acl_list(user->acl);
9440 ast_variables_destroy(user->chanvars);
9441 ast_free(user);
9442}

References ao2_t_ref, ast_free, ast_free_acl_list(), and ast_variables_destroy().

Referenced by __init_manager(), and manager_shutdown().

◆ manager_http_callback()

static int manager_http_callback ( struct ast_tcptls_session_instance ser,
const struct ast_http_uri urih,
const char *  uri,
enum ast_http_method  method,
struct ast_variable get_params,
struct ast_variable headers 
)
static

Definition at line 8899 of file manager.c.

8900{
8901 int retval;
8902 struct ast_sockaddr ser_remote_address_tmp;
8903
8904 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8905 retval = generic_http_callback(ser, method, FORMAT_HTML, &ser_remote_address_tmp, uri, get_params, headers);
8906 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8907 return retval;
8908}
static int generic_http_callback(struct ast_tcptls_session_instance *ser, enum ast_http_method method, enum output_format format, const struct ast_sockaddr *remote_address, const char *uri, struct ast_variable *get_params, struct ast_variable *headers)
Definition: manager.c:8364

References ast_sockaddr_copy(), FORMAT_HTML, generic_http_callback(), method, and ast_tcptls_session_instance::remote_address.

◆ manager_set_defaults()

static void manager_set_defaults ( void  )
static

Definition at line 9616 of file manager.c.

9617{
9618 manager_enabled = 0;
9619 displayconnects = 1;
9621 authtimeout = 30;
9622 authlimit = 50;
9623 manager_debug = 0; /* Debug disabled by default */
9624
9625 /* default values */
9627 sizeof(global_realm));
9630
9631 ami_tls_cfg.enabled = 0;
9642}
#define DEFAULT_REALM
Definition: manager.c:179
static void ast_sockaddr_setnull(struct ast_sockaddr *addr)
Sets address addr to null.
Definition: netsock2.h:138
const char * ast_config_AST_SYSTEM_NAME
Definition: options.c:170
char * capath
Definition: tcptls.h:94
char * cafile
Definition: tcptls.h:93
#define AST_CERTFILE
Definition: tcptls.h:63

References ami_desc, ami_tls_cfg, amis_desc, AST_CERTFILE, ast_config_AST_SYSTEM_NAME, ast_copy_string(), ast_free, ast_sockaddr_setnull(), ast_strdup, authlimit, authtimeout, broken_events_action, ast_tls_config::cafile, ast_tls_config::capath, ast_tls_config::certfile, ast_tls_config::cipher, DEFAULT_REALM, displayconnects, ast_tls_config::enabled, global_realm, ast_tcptls_session_args::local_address, manager_debug, manager_enabled, ast_tls_config::pvtfile, and S_OR.

Referenced by __init_manager().

◆ manager_shutdown()

static void manager_shutdown ( void  )
static

Definition at line 9448 of file manager.c.

9449{
9450 struct ast_manager_user *user;
9451
9452#ifdef TEST_FRAMEWORK
9453 AST_TEST_UNREGISTER(eventfilter_test_creation);
9454 AST_TEST_UNREGISTER(eventfilter_test_matching);
9455 AST_TEST_UNREGISTER(originate_permissions_test);
9456#endif
9457
9458 /* This event is not actually transmitted, but causes all TCP sessions to be closed */
9459 manager_event(EVENT_FLAG_SHUTDOWN, "CloseSession", "CloseSession: true\r\n");
9460
9461 ast_manager_unregister("Ping");
9462 ast_manager_unregister("Events");
9463 ast_manager_unregister("Logoff");
9464 ast_manager_unregister("Login");
9465 ast_manager_unregister("Challenge");
9466 ast_manager_unregister("Hangup");
9467 ast_manager_unregister("Status");
9468 ast_manager_unregister("Setvar");
9469 ast_manager_unregister("Getvar");
9470 ast_manager_unregister("GetConfig");
9471 ast_manager_unregister("GetConfigJSON");
9472 ast_manager_unregister("UpdateConfig");
9473 ast_manager_unregister("CreateConfig");
9474 ast_manager_unregister("ListCategories");
9475 ast_manager_unregister("Redirect");
9476 ast_manager_unregister("Atxfer");
9477 ast_manager_unregister("CancelAtxfer");
9478 ast_manager_unregister("Originate");
9479 ast_manager_unregister("Command");
9480 ast_manager_unregister("ExtensionState");
9481 ast_manager_unregister("PresenceState");
9482 ast_manager_unregister("AbsoluteTimeout");
9483 ast_manager_unregister("MailboxStatus");
9484 ast_manager_unregister("MailboxCount");
9485 ast_manager_unregister("ListCommands");
9486 ast_manager_unregister("SendText");
9487 ast_manager_unregister("UserEvent");
9488 ast_manager_unregister("WaitEvent");
9489 ast_manager_unregister("CoreSettings");
9490 ast_manager_unregister("CoreStatus");
9491 ast_manager_unregister("Reload");
9492 ast_manager_unregister("LoggerRotate");
9493 ast_manager_unregister("CoreShowChannels");
9494 ast_manager_unregister("CoreShowChannelMap");
9495 ast_manager_unregister("ModuleLoad");
9496 ast_manager_unregister("ModuleCheck");
9497 ast_manager_unregister("AOCMessage");
9498 ast_manager_unregister("Filter");
9499 ast_manager_unregister("BlindTransfer");
9502
9503#ifdef AST_XML_DOCS
9504 ao2_t_global_obj_release(event_docs, "Dispose of event_docs");
9505#endif
9506
9507#ifdef TEST_FRAMEWORK
9508 stasis_forward_cancel(test_suite_forwarder);
9509 test_suite_forwarder = NULL;
9510#endif
9511
9512 if (stasis_router) {
9515 }
9523
9526
9537
9538 ao2_global_obj_release(mgr_sessions);
9539
9540 while ((user = AST_LIST_REMOVE_HEAD(&users, list))) {
9542 }
9544
9547}
#define ao2_global_obj_release(holder)
Release the ao2 object held in the global holder.
Definition: astobj2.h:859
#define ao2_t_global_obj_release(holder, tag)
Definition: astobj2.h:861
int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
Unregister multiple commands.
Definition: clicompat.c:30
static struct stasis_message_router * stasis_router
The stasis_message_router for all Stasis Message Bus API messages.
Definition: manager.c:189
static struct stasis_forward * rtp_topic_forwarder
The stasis_subscription for forwarding the RTP topic to the AMI topic.
Definition: manager.c:192
static struct stasis_forward * security_topic_forwarder
The stasis_subscription for forwarding the Security topic to the AMI topic.
Definition: manager.c:195
#define EVENT_FLAG_SHUTDOWN
Fake event class used to end sessions at shutdown.
Definition: manager.c:212
int ast_manager_unregister(const char *action)
support functions to register/unregister AMI action handlers,
Definition: manager.c:7697
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
Definition: linkedlists.h:833
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
static char user[512]
#define STASIS_MESSAGE_TYPE_CLEANUP(name)
Boiler-plate messaging macro for cleaning up message types.
Definition: stasis.h:1515
struct stasis_forward * stasis_forward_cancel(struct stasis_forward *forward)
Definition: stasis.c:1575
void stasis_message_router_unsubscribe_and_join(struct stasis_message_router *router)
Unsubscribe the router from the upstream topic, blocking until the final message has been processed.
#define AST_TEST_UNREGISTER(cb)
Definition: test.h:128

References acl_change_stasis_unsubscribe(), ami_desc, ami_tls_cfg, amis_desc, ao2_cleanup, ao2_global_obj_release, ao2_t_global_obj_release, ARRAY_LEN, ast_cli_unregister_multiple(), ast_custom_function_unregister(), ast_free, AST_LIST_REMOVE_HEAD, ast_manager_get_generic_type(), ast_manager_unregister(), ast_tcptls_server_stop(), AST_TEST_UNREGISTER, ast_tls_config::cafile, ast_tls_config::capath, ast_tls_config::certfile, ast_tls_config::cipher, cli_manager, EVENT_FLAG_SHUTDOWN, manager_channelvars, manager_disabledevents, manager_event, manager_free_user(), manager_topic, managerclient_function, NULL, ast_tls_config::pvtfile, rtp_topic_forwarder, security_topic_forwarder, stasis_forward_cancel(), stasis_message_router_unsubscribe_and_join(), STASIS_MESSAGE_TYPE_CLEANUP, stasis_router, and user.

Referenced by load_module().

◆ manager_subscriptions_init()

static int manager_subscriptions_init ( void  )
static

Initialize all Stasis Message Bus API topics and routers used by the various sub-components of AMI.

Definition at line 9553 of file manager.c.

9554{
9555 int res = 0;
9556
9558 if (!rtp_topic_forwarder) {
9559 return -1;
9560 }
9561
9564 return -1;
9565 }
9566
9568 if (!stasis_router) {
9569 return -1;
9570 }
9573
9576
9579
9580 if (res != 0) {
9581 return -1;
9582 }
9583 return 0;
9584}
static void manager_default_msg_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: manager.c:572
static void manager_generic_msg_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: manager.c:603
struct stasis_topic * ast_rtp_topic(void)
Stasis Message Bus API topic for RTP and RTCP related messages
Definition: rtp_engine.c:3742
struct stasis_topic * ast_security_topic(void)
A stasis_topic which publishes messages for security related issues.
@ STASIS_SUBSCRIPTION_FORMATTER_AMI
Definition: stasis.h:311
int stasis_message_router_set_congestion_limits(struct stasis_message_router *router, long low_water, long high_water)
Set the high and low alert water marks of the stasis message router.
#define stasis_message_router_create(topic)
Create a new message router object.
int stasis_message_router_add(struct stasis_message_router *router, struct stasis_message_type *message_type, stasis_subscription_cb callback, void *data)
Add a route to a message router.
void stasis_message_router_set_formatters_default(struct stasis_message_router *router, stasis_subscription_cb callback, void *data, enum stasis_subscription_message_formatters formatters)
Sets the default route of a router with formatters.
#define AST_TASKPROCESSOR_HIGH_WATER_LEVEL
Definition: taskprocessor.h:64

References ast_manager_get_generic_type(), ast_rtp_topic(), ast_security_topic(), AST_TASKPROCESSOR_HIGH_WATER_LEVEL, manager_default_msg_cb(), manager_generic_msg_cb(), manager_topic, NULL, rtp_topic_forwarder, security_topic_forwarder, stasis_forward_all(), stasis_message_router_add(), stasis_message_router_create, stasis_message_router_set_congestion_limits(), stasis_message_router_set_formatters_default(), stasis_router, and STASIS_SUBSCRIPTION_FORMATTER_AMI.

Referenced by subscribe_all().

◆ mxml_http_callback()

static int mxml_http_callback ( struct ast_tcptls_session_instance ser,
const struct ast_http_uri urih,
const char *  uri,
enum ast_http_method  method,
struct ast_variable get_params,
struct ast_variable headers 
)
static

Definition at line 8910 of file manager.c.

8911{
8912 int retval;
8913 struct ast_sockaddr ser_remote_address_tmp;
8914
8915 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8916 retval = generic_http_callback(ser, method, FORMAT_XML, &ser_remote_address_tmp, uri, get_params, headers);
8917 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8918 return retval;
8919}

References ast_sockaddr_copy(), FORMAT_XML, generic_http_callback(), method, and ast_tcptls_session_instance::remote_address.

◆ process_output()

static void process_output ( struct mansession s,
struct ast_str **  out,
struct ast_variable params,
enum output_format  format 
)
static

Definition at line 8331 of file manager.c.

8332{
8333 char *buf;
8334 off_t l;
8335 int fd;
8336
8337 if (!s->stream)
8338 return;
8339
8340 /* Ensure buffer is NULL-terminated */
8341 ast_iostream_write(s->stream, "", 1);
8342
8343 fd = ast_iostream_get_fd(s->stream);
8344
8345 l = lseek(fd, 0, SEEK_CUR);
8346 if (l > 0) {
8347 if (MAP_FAILED == (buf = mmap(NULL, l, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0))) {
8348 ast_log(LOG_WARNING, "mmap failed. Manager output was not processed\n");
8349 } else {
8350 if (format == FORMAT_XML || format == FORMAT_HTML) {
8351 xml_translate(out, buf, params, format);
8352 } else {
8353 ast_str_append(out, 0, "%s", buf);
8354 }
8355 munmap(buf, l);
8356 }
8357 } else if (format == FORMAT_XML || format == FORMAT_HTML) {
8358 xml_translate(out, "", params, format);
8359 }
8360
8362}
ssize_t ast_iostream_write(struct ast_iostream *stream, const void *buffer, size_t count)
Write data to an iostream.
Definition: iostream.c:385
static void xml_translate(struct ast_str **out, char *in, struct ast_variable *get_vars, enum output_format format)
Convert the input into XML or HTML. The input is supposed to be a sequence of lines of the form Name:...
Definition: manager.c:8203

References ast_iostream_get_fd(), ast_iostream_write(), ast_log, ast_str_append(), buf, close_mansession_file(), FORMAT_HTML, FORMAT_XML, LOG_WARNING, NULL, out, mansession::stream, and xml_translate().

Referenced by auth_http_callback(), and generic_http_callback().

◆ purge_old_stuff()

static void purge_old_stuff ( void *  data)
static

cleanup code called at each iteration of server_root, guaranteed to happen every 5 seconds at most

Definition at line 9092 of file manager.c.

9093{
9094 struct ast_tcptls_session_args *ser = data;
9095 /* purge_sessions will return the number of sessions actually purged,
9096 * up to a maximum of it's arguments, purge one at a time, keeping a
9097 * purge interval of 1ms as long as we purged a session, otherwise
9098 * revert to a purge check every 5s
9099 */
9100 if (purge_sessions(1) == 1) {
9101 ser->poll_timeout = 1;
9102 } else {
9103 ser->poll_timeout = 5000;
9104 }
9105 purge_events();
9106}
static void purge_events(void)
Definition: manager.c:718
static int purge_sessions(int n_max)
remove at most n_max stale session from the list.
Definition: manager.c:7455
arguments for the accepting thread
Definition: tcptls.h:130

References ast_tcptls_session_args::poll_timeout, purge_events(), and purge_sessions().

◆ rawman_http_callback()

static int rawman_http_callback ( struct ast_tcptls_session_instance ser,
const struct ast_http_uri urih,
const char *  uri,
enum ast_http_method  method,
struct ast_variable get_params,
struct ast_variable headers 
)
static

Definition at line 8921 of file manager.c.

8922{
8923 int retval;
8924 struct ast_sockaddr ser_remote_address_tmp;
8925
8926 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8927 retval = generic_http_callback(ser, method, FORMAT_RAW, &ser_remote_address_tmp, uri, get_params, headers);
8928 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8929 return retval;
8930}

References ast_sockaddr_copy(), FORMAT_RAW, generic_http_callback(), method, and ast_tcptls_session_instance::remote_address.

◆ subscribe_all()

static int subscribe_all ( void  )
static

Definition at line 9586 of file manager.c.

9587{
9589 ast_log(AST_LOG_ERROR, "Failed to initialize manager subscriptions\n");
9590 return -1;
9591 }
9592 if (manager_system_init()) {
9593 ast_log(AST_LOG_ERROR, "Failed to initialize manager system handling\n");
9594 return -1;
9595 }
9596 if (manager_channels_init()) {
9597 ast_log(AST_LOG_ERROR, "Failed to initialize manager channel handling\n");
9598 return -1;
9599 }
9600 if (manager_mwi_init()) {
9601 ast_log(AST_LOG_ERROR, "Failed to initialize manager MWI handling\n");
9602 return -1;
9603 }
9604 if (manager_bridging_init()) {
9605 return -1;
9606 }
9607 if (manager_endpoints_init()) {
9608 ast_log(AST_LOG_ERROR, "Failed to initialize manager endpoints handling\n");
9609 return -1;
9610 }
9611
9612 subscribed = 1;
9613 return 0;
9614}
static int manager_subscriptions_init(void)
Initialize all Stasis Message Bus API topics and routers used by the various sub-components of AMI.
Definition: manager.c:9553
int manager_mwi_init(void)
Initialize support for AMI MWI events.
Definition: manager_mwi.c:160
int manager_bridging_init(void)
Initialize support for AMI channel events.
int manager_endpoints_init(void)
Initialize support for AMI endpoint events.
int manager_system_init(void)
Initialize support for AMI system events.
int manager_channels_init(void)
Initialize support for AMI channel events.

References ast_log, AST_LOG_ERROR, manager_bridging_init(), manager_channels_init(), manager_endpoints_init(), manager_mwi_init(), manager_subscriptions_init(), manager_system_init(), and subscribed.

Referenced by __init_manager().

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 10153 of file manager.c.

10154{
10155 return 0;
10156}

◆ variable_count_cmp_fn()

static int variable_count_cmp_fn ( void *  obj,
void *  vstr,
int  flags 
)
static

Definition at line 8164 of file manager.c.

8165{
8166 /* Due to the simplicity of struct variable_count, it makes no difference
8167 * if you pass in objects or strings, the same operation applies. This is
8168 * due to the fact that the hash occurs on the first element, which means
8169 * the address of both the struct and the string are exactly the same. */
8170 struct variable_count *vc = obj;
8171 char *str = vstr;
8172 return !strcmp(vc->varname, str) ? CMP_MATCH | CMP_STOP : 0;
8173}
const char * str
Definition: app_jack.c:150
@ CMP_MATCH
Definition: astobj2.h:1027
@ CMP_STOP
Definition: astobj2.h:1028
char * varname
Definition: manager.c:8153

References CMP_MATCH, CMP_STOP, str, and variable_count::varname.

Referenced by xml_translate().

◆ variable_count_hash_fn()

static int variable_count_hash_fn ( const void *  vvc,
const int  flags 
)
static

Definition at line 8157 of file manager.c.

8158{
8159 const struct variable_count *vc = vvc;
8160
8161 return ast_str_hash(vc->varname);
8162}

References ast_str_hash(), and variable_count::varname.

Referenced by xml_translate().

◆ xml_copy_escape()

static void xml_copy_escape ( struct ast_str **  out,
const char *  src,
int  mode 
)
static

Definition at line 8085 of file manager.c.

8086{
8087 /* store in a local buffer to avoid calling ast_str_append too often */
8088 char buf[256];
8089 char *dst = buf;
8090 const char *save = src;
8091 int space = sizeof(buf);
8092 /* repeat until done and nothing to flush */
8093 for ( ; *src || dst != buf ; src++) {
8094 if (*src == '\0' || space < 10) { /* flush */
8095 *dst++ = '\0';
8096 ast_str_append(out, 0, "%s", buf);
8097 dst = buf;
8098 space = sizeof(buf);
8099 if (*src == '\0') {
8100 break;
8101 }
8102 }
8103
8104 if (mode & 2) {
8105 if (save == src && isdigit(*src)) {
8106 /* The first character of an XML attribute cannot be a digit */
8107 *dst++ = '_';
8108 *dst++ = *src;
8109 space -= 2;
8110 continue;
8111 } else if (!isalnum(*src)) {
8112 /* Replace non-alphanumeric with an underscore */
8113 *dst++ = '_';
8114 space--;
8115 continue;
8116 }
8117 }
8118 switch (*src) {
8119 case '<':
8120 strcpy(dst, "&lt;");
8121 dst += 4;
8122 space -= 4;
8123 break;
8124 case '>':
8125 strcpy(dst, "&gt;");
8126 dst += 4;
8127 space -= 4;
8128 break;
8129 case '\"':
8130 strcpy(dst, "&quot;");
8131 dst += 6;
8132 space -= 6;
8133 break;
8134 case '\'':
8135 strcpy(dst, "&apos;");
8136 dst += 6;
8137 space -= 6;
8138 break;
8139 case '&':
8140 strcpy(dst, "&amp;");
8141 dst += 5;
8142 space -= 5;
8143 break;
8144
8145 default:
8146 *dst++ = mode ? tolower(*src) : *src;
8147 space--;
8148 }
8149 }
8150}

References ast_str_append(), buf, and out.

Referenced by xml_translate().

◆ xml_translate()

static void xml_translate ( struct ast_str **  out,
char *  in,
struct ast_variable get_vars,
enum output_format  format 
)
static

Convert the input into XML or HTML. The input is supposed to be a sequence of lines of the form Name: value optionally followed by a blob of unformatted text. A blank line is a section separator. Basically, this is a mixture of the format of Manager Interface and CLI commands. The unformatted text is considered as a single value of a field named 'Opaque-data'.

At the moment the output format is the following (but it may change depending on future requirements so don't count too much on it when writing applications):

General: the unformatted text is used as a value of XML output: to be completed

*   Each section is within <response type="object" id="xxx">
*   where xxx is taken from ajaxdest variable or defaults to unknown
*   Each row is reported as an attribute Name="value" of an XML
*   entity named from the variable ajaxobjtype, default to "generic"
* 

HTML output: each Name-value pair is output as a single row of a two-column table. Sections (blank lines in the input) are separated by a


Definition at line 8203 of file manager.c.

8204{
8205 struct ast_variable *v;
8206 const char *dest = NULL;
8207 char *var, *val;
8208 const char *objtype = NULL;
8209 int in_data = 0; /* parsing data */
8210 int inobj = 0;
8211 int xml = (format == FORMAT_XML);
8212 struct variable_count *vc = NULL;
8213 struct ao2_container *vco = NULL;
8214
8215 if (xml) {
8216 /* dest and objtype need only for XML format */
8217 for (v = get_vars; v; v = v->next) {
8218 if (!strcasecmp(v->name, "ajaxdest")) {
8219 dest = v->value;
8220 } else if (!strcasecmp(v->name, "ajaxobjtype")) {
8221 objtype = v->value;
8222 }
8223 }
8224 if (ast_strlen_zero(dest)) {
8225 dest = "unknown";
8226 }
8227 if (ast_strlen_zero(objtype)) {
8228 objtype = "generic";
8229 }
8230 }
8231
8232 /* we want to stop when we find an empty line */
8233 while (in && *in) {
8234 val = strsep(&in, "\r\n"); /* mark start and end of line */
8235 if (in && *in == '\n') { /* remove trailing \n if any */
8236 in++;
8237 }
8239 ast_debug(5, "inobj %d in_data %d line <%s>\n", inobj, in_data, val);
8240 if (ast_strlen_zero(val)) {
8241 /* empty line */
8242 if (in_data) {
8243 /* close data in Opaque mode */
8244 ast_str_append(out, 0, xml ? "'" : "</td></tr>\n");
8245 in_data = 0;
8246 }
8247
8248 if (inobj) {
8249 /* close block */
8250 ast_str_append(out, 0, xml ? " /></response>\n" :
8251 "<tr><td colspan=\"2\"><hr></td></tr>\r\n");
8252 inobj = 0;
8253 ao2_ref(vco, -1);
8254 vco = NULL;
8255 }
8256 continue;
8257 }
8258
8259 if (!inobj) {
8260 /* start new block */
8261 if (xml) {
8262 ast_str_append(out, 0, "<response type='object' id='%s'><%s", dest, objtype);
8263 }
8266 inobj = 1;
8267 }
8268
8269 if (in_data) {
8270 /* Process data field in Opaque mode. This is a
8271 * followup, so we re-add line feeds. */
8272 ast_str_append(out, 0, xml ? "\n" : "<br>\n");
8273 xml_copy_escape(out, val, 0); /* data field */
8274 continue;
8275 }
8276
8277 /* We expect "Name: value" line here */
8278 var = strsep(&val, ":");
8279 if (val) {
8280 /* found the field name */
8283 } else {
8284 /* field name not found, switch to opaque mode */
8285 val = var;
8286 var = "Opaque-data";
8287 in_data = 1;
8288 }
8289
8290
8291 ast_str_append(out, 0, xml ? " " : "<tr><td>");
8292 if ((vc = ao2_find(vco, var, 0))) {
8293 vc->count++;
8294 } else {
8295 /* Create a new entry for this one */
8296 vc = ao2_alloc(sizeof(*vc), NULL);
8297 vc->varname = var;
8298 vc->count = 1;
8299 ao2_link(vco, vc);
8300 }
8301
8302 xml_copy_escape(out, var, xml ? 1 | 2 : 0); /* data name */
8303 if (vc->count > 1) {
8304 ast_str_append(out, 0, "-%d", vc->count);
8305 }
8306 ao2_ref(vc, -1);
8307 ast_str_append(out, 0, xml ? "='" : "</td><td>");
8308 xml_copy_escape(out, val, 0); /* data field */
8309 if (!in_data || !*in) {
8310 ast_str_append(out, 0, xml ? "'" : "</td></tr>\n");
8311 }
8312 }
8313
8314 if (inobj) {
8315 ast_str_append(out, 0, xml ? " /></response>\n" :
8316 "<tr><td colspan=\"2\"><hr></td></tr>\r\n");
8317 ao2_ref(vco, -1);
8318 }
8319}
char * strsep(char **str, const char *delims)
#define ao2_link(container, obj)
Add an object to a container.
Definition: astobj2.h:1532
#define ao2_alloc(data_size, destructor_fn)
Definition: astobj2.h:409
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Allocate and initialize a hash container with the desired number of buckets.
Definition: astobj2.h:1303
static void xml_copy_escape(struct ast_str **out, const char *src, int mode)
Definition: manager.c:8085
static int variable_count_cmp_fn(void *obj, void *vstr, int flags)
Definition: manager.c:8164
static int variable_count_hash_fn(const void *vvc, const int flags)
Definition: manager.c:8157
char * ast_trim_blanks(char *str)
Trims trailing whitespace characters from a string.
Definition: strings.h:186
char * ast_skip_blanks(const char *str)
Gets a pointer to the first non-whitespace character in a string.
Definition: strings.h:161
FILE * in
Definition: utils/frame.c:33

References ao2_alloc, AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ao2_find, ao2_link, ao2_ref, ast_debug, ast_skip_blanks(), ast_str_append(), ast_strlen_zero(), ast_trim_blanks(), variable_count::count, FORMAT_XML, in, ast_variable::name, ast_variable::next, NULL, out, strsep(), ast_variable::value, var, variable_count_cmp_fn(), variable_count_hash_fn(), variable_count::varname, and xml_copy_escape().

Referenced by process_output().

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Asterisk Manager Interface" , .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 = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CORE, .requires = "extconfig,acl,http", }
static

Definition at line 10276 of file manager.c.

◆ amanageruri

struct ast_http_uri amanageruri
static

Definition at line 9000 of file manager.c.

Referenced by __init_manager().

◆ amanagerxmluri

struct ast_http_uri amanagerxmluri
static

Definition at line 9009 of file manager.c.

Referenced by __init_manager().

◆ ami_desc

struct ast_tcptls_session_args ami_desc
static

◆ ami_tls_cfg

struct ast_tls_config ami_tls_cfg
static

◆ amis_desc

struct ast_tcptls_session_args amis_desc
static

◆ arawmanuri

struct ast_http_uri arawmanuri
static

Definition at line 8991 of file manager.c.

Referenced by __init_manager().

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info
static

Definition at line 10276 of file manager.c.

◆ cli_manager

struct ast_cli_entry cli_manager[]
static

Definition at line 9373 of file manager.c.

Referenced by __init_manager(), and manager_shutdown().

◆ contenttype

const char* const contenttype[]
static
Initial value:
= {
[FORMAT_RAW] = "plain",
[FORMAT_HTML] = "html",
[FORMAT_XML] = "xml",
}

Definition at line 7915 of file manager.c.

Referenced by auth_http_callback(), and generic_http_callback().

◆ managerclient_function

struct ast_custom_function managerclient_function
static
Initial value:
= {
.name = "AMI_CLIENT",
.read_max = 12,
}
static int function_amiclient(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
${AMI_CLIENT()} Dialplan function - reads manager client data
Definition: manager.c:9034

description of AMI_CLIENT dialplan function

Definition at line 9081 of file manager.c.

Referenced by __init_manager(), and manager_shutdown().

◆ manageruri

struct ast_http_uri manageruri
static

Definition at line 8940 of file manager.c.

Referenced by __init_manager().

◆ managerxmluri

struct ast_http_uri managerxmluri
static

Definition at line 8948 of file manager.c.

Referenced by __init_manager().

◆ rawmanuri

struct ast_http_uri rawmanuri
static

Definition at line 8932 of file manager.c.

Referenced by __init_manager().

◆ webregged

int webregged = 0
static

Definition at line 9087 of file manager.c.

Referenced by __init_manager().

◆ words

const char* words[AST_MAX_CMD_LEN]

Definition at line 226 of file manager.c.

Referenced by check_blacklist().