Asterisk - The Open Source Telephony Project GIT-master-f36a736
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/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 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 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 restrictedFile (const char *filename)
 Check if a file is restricted or not. More...
 
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 7811 of file manager.c.

7811 {
7812 FORMAT_RAW,
7814 FORMAT_XML,
7815};
@ FORMAT_RAW
Definition: manager.c:7812
@ FORMAT_HTML
Definition: manager.c:7813
@ FORMAT_XML
Definition: manager.c:7814

Function Documentation

◆ __init_manager()

static int __init_manager ( int  reload,
int  by_external_config 
)
static

Definition at line 9535 of file manager.c.

9536{
9537 struct ast_config *ucfg = NULL, *cfg = NULL;
9538 const char *val;
9539 char *cat = NULL;
9540 int newhttptimeout = 60;
9541 struct ast_manager_user *user = NULL;
9542 struct ast_variable *var;
9543 struct ast_flags config_flags = { (reload && !by_external_config) ? CONFIG_FLAG_FILEUNCHANGED : 0 };
9544 char a1[337];
9545 char a1_hash[256];
9546 struct ast_sockaddr ami_desc_local_address_tmp;
9547 struct ast_sockaddr amis_desc_local_address_tmp;
9548 int tls_was_enabled = 0;
9549 int acl_subscription_flag = 0;
9550
9551 if (!reload) {
9552 struct ao2_container *sessions;
9553#ifdef AST_XML_DOCS
9554 struct ao2_container *temp_event_docs;
9555#endif
9556 int res;
9557
9559 if (res != 0) {
9560 return -1;
9561 }
9562 manager_topic = stasis_topic_create("manager:core");
9563 if (!manager_topic) {
9564 return -1;
9565 }
9566
9567 /* Register default actions */
9607
9608#ifdef TEST_FRAMEWORK
9609 test_suite_forwarder = stasis_forward_all(ast_test_suite_topic(), manager_topic);
9610#endif
9611
9615
9616 /* Append placeholder event so master_eventq never runs dry */
9617 if (append_event("Event: Placeholder\r\n\r\n",
9618 ast_str_hash("Placeholder"), 0)) {
9619 return -1;
9620 }
9621
9622#ifdef AST_XML_DOCS
9623 temp_event_docs = ast_xmldoc_build_documentation("managerEvent");
9624 if (temp_event_docs) {
9625 ao2_t_global_obj_replace_unref(event_docs, temp_event_docs, "Toss old event docs");
9626 ao2_t_ref(temp_event_docs, -1, "Remove creation ref - container holds only ref now");
9627 }
9628#endif
9629
9630 /* If you have a NULL hash fn, you only need a single bucket */
9632 if (!sessions) {
9633 return -1;
9634 }
9636 ao2_ref(sessions, -1);
9637
9638 /* Initialize all settings before first configuration load. */
9640 }
9641
9642 cfg = ast_config_load2("manager.conf", "manager", config_flags);
9643 if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
9644 return 0;
9645 } else if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
9646 ast_log(LOG_NOTICE, "Unable to open AMI configuration manager.conf, or configuration is invalid.\n");
9647 return 0;
9648 }
9649
9650 /* 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. */
9651 if (!by_external_config) {
9653 }
9654
9655 if (reload) {
9656 /* Reset all settings before reloading configuration */
9657 tls_was_enabled = ami_tls_cfg.enabled;
9659 }
9660
9661 ast_sockaddr_parse(&ami_desc_local_address_tmp, "[::]", 0);
9662 ast_sockaddr_set_port(&ami_desc_local_address_tmp, DEFAULT_MANAGER_PORT);
9663
9664 for (var = ast_variable_browse(cfg, "general"); var; var = var->next) {
9665 val = var->value;
9666
9667 /* read tls config options while preventing unsupported options from being set */
9668 if (strcasecmp(var->name, "tlscafile")
9669 && strcasecmp(var->name, "tlscapath")
9670 && strcasecmp(var->name, "tlscadir")
9671 && strcasecmp(var->name, "tlsverifyclient")
9672 && strcasecmp(var->name, "tlsdontverifyserver")
9673 && strcasecmp(var->name, "tlsclientmethod")
9674 && strcasecmp(var->name, "sslclientmethod")
9675 && !ast_tls_read_conf(&ami_tls_cfg, &amis_desc, var->name, val)) {
9676 continue;
9677 }
9678
9679 if (!strcasecmp(var->name, "enabled")) {
9681 } else if (!strcasecmp(var->name, "webenabled")) {
9683 } else if (!strcasecmp(var->name, "port")) {
9684 int bindport;
9685 if (ast_parse_arg(val, PARSE_UINT32|PARSE_IN_RANGE, &bindport, 1024, 65535)) {
9686 ast_log(LOG_WARNING, "Invalid port number '%s'\n", val);
9687 }
9688 ast_sockaddr_set_port(&ami_desc_local_address_tmp, bindport);
9689 } else if (!strcasecmp(var->name, "bindaddr")) {
9690 /* remember port if it has already been set */
9691 int setport = ast_sockaddr_port(&ami_desc_local_address_tmp);
9692
9694 ast_log(LOG_WARNING, "Invalid address '%s' specified, default '%s' will be used\n", val,
9695 ast_sockaddr_stringify_addr(&ami_desc_local_address_tmp));
9696 } else {
9697 ast_sockaddr_parse(&ami_desc_local_address_tmp, val, PARSE_PORT_IGNORE);
9698 }
9699
9700 if (setport) {
9701 ast_sockaddr_set_port(&ami_desc_local_address_tmp, setport);
9702 }
9703
9704 } else if (!strcasecmp(var->name, "brokeneventsaction")) {
9706 } else if (!strcasecmp(var->name, "allowmultiplelogin")) {
9708 } else if (!strcasecmp(var->name, "displayconnects")) {
9710 } else if (!strcasecmp(var->name, "timestampevents")) {
9712 } else if (!strcasecmp(var->name, "debug")) {
9714 } else if (!strcasecmp(var->name, "httptimeout")) {
9715 newhttptimeout = atoi(val);
9716 } else if (!strcasecmp(var->name, "authtimeout")) {
9717 int timeout = atoi(var->value);
9718
9719 if (timeout < 1) {
9720 ast_log(LOG_WARNING, "Invalid authtimeout value '%s', using default value\n", var->value);
9721 } else {
9722 authtimeout = timeout;
9723 }
9724 } else if (!strcasecmp(var->name, "authlimit")) {
9725 int limit = atoi(var->value);
9726
9727 if (limit < 1) {
9728 ast_log(LOG_WARNING, "Invalid authlimit value '%s', using default value\n", var->value);
9729 } else {
9730 authlimit = limit;
9731 }
9732 } else if (!strcasecmp(var->name, "channelvars")) {
9734 } else if (!strcasecmp(var->name, "disabledevents")) {
9736 } else {
9737 ast_log(LOG_NOTICE, "Invalid keyword <%s> = <%s> in manager.conf [general]\n",
9738 var->name, val);
9739 }
9740 }
9741
9742 if (manager_enabled && !subscribed) {
9743 if (subscribe_all() != 0) {
9744 ast_log(LOG_ERROR, "Manager subscription error\n");
9745 return -1;
9746 }
9747 }
9748
9749 ast_sockaddr_copy(&amis_desc_local_address_tmp, &amis_desc.local_address);
9750
9751 /* if the amis address has not been set, default is the same as non secure ami */
9752 if (ast_sockaddr_isnull(&amis_desc_local_address_tmp)) {
9753 ast_sockaddr_copy(&amis_desc_local_address_tmp, &ami_desc_local_address_tmp);
9754 }
9755
9756 /* if the amis address was not set, it will have non-secure ami port set; if
9757 amis address was set, we need to check that a port was set or not, if not
9758 use the default tls port */
9759 if (ast_sockaddr_port(&amis_desc_local_address_tmp) == 0 ||
9760 (ast_sockaddr_port(&ami_desc_local_address_tmp) == ast_sockaddr_port(&amis_desc_local_address_tmp))) {
9761
9762 ast_sockaddr_set_port(&amis_desc_local_address_tmp, DEFAULT_MANAGER_TLS_PORT);
9763 }
9764
9765 if (manager_enabled) {
9766 ast_sockaddr_copy(&ami_desc.local_address, &ami_desc_local_address_tmp);
9767 ast_sockaddr_copy(&amis_desc.local_address, &amis_desc_local_address_tmp);
9768 }
9769
9771
9772 /* First, get users from users.conf */
9773 ucfg = ast_config_load2("users.conf", "manager", config_flags);
9774 if (ucfg && (ucfg != CONFIG_STATUS_FILEUNCHANGED) && ucfg != CONFIG_STATUS_FILEINVALID) {
9775 const char *hasmanager;
9776 int genhasmanager = ast_true(ast_variable_retrieve(ucfg, "general", "hasmanager"));
9777
9778 while ((cat = ast_category_browse(ucfg, cat))) {
9779 if (!strcasecmp(cat, "general")) {
9780 continue;
9781 }
9782
9783 hasmanager = ast_variable_retrieve(ucfg, cat, "hasmanager");
9784 if ((!hasmanager && genhasmanager) || ast_true(hasmanager)) {
9785 const char *user_secret = ast_variable_retrieve(ucfg, cat, "secret");
9786 const char *user_read = ast_variable_retrieve(ucfg, cat, "read");
9787 const char *user_write = ast_variable_retrieve(ucfg, cat, "write");
9788 const char *user_displayconnects = ast_variable_retrieve(ucfg, cat, "displayconnects");
9789 const char *user_allowmultiplelogin = ast_variable_retrieve(ucfg, cat, "allowmultiplelogin");
9790 const char *user_writetimeout = ast_variable_retrieve(ucfg, cat, "writetimeout");
9791
9792 /* Look for an existing entry,
9793 * if none found - create one and add it to the list
9794 */
9795 if (!(user = get_manager_by_name_locked(cat))) {
9796 if (!(user = ast_calloc(1, sizeof(*user)))) {
9797 break;
9798 }
9799
9800 /* Copy name over */
9801 ast_copy_string(user->username, cat, sizeof(user->username));
9802 /* Insert into list */
9804 user->acl = NULL;
9805 user->keep = 1;
9806 user->readperm = -1;
9807 user->writeperm = -1;
9808 /* Default displayconnect from [general] */
9809 user->displayconnects = displayconnects;
9810 /* Default allowmultiplelogin from [general] */
9811 user->allowmultiplelogin = allowmultiplelogin;
9812 user->writetimeout = 100;
9813 }
9814
9815 if (!user_secret) {
9816 user_secret = ast_variable_retrieve(ucfg, "general", "secret");
9817 }
9818 if (!user_read) {
9819 user_read = ast_variable_retrieve(ucfg, "general", "read");
9820 }
9821 if (!user_write) {
9822 user_write = ast_variable_retrieve(ucfg, "general", "write");
9823 }
9824 if (!user_displayconnects) {
9825 user_displayconnects = ast_variable_retrieve(ucfg, "general", "displayconnects");
9826 }
9827 if (!user_allowmultiplelogin) {
9828 user_allowmultiplelogin = ast_variable_retrieve(ucfg, "general", "allowmultiplelogin");
9829 }
9830 if (!user_writetimeout) {
9831 user_writetimeout = ast_variable_retrieve(ucfg, "general", "writetimeout");
9832 }
9833
9834 if (!ast_strlen_zero(user_secret)) {
9835 ast_free(user->secret);
9836 user->secret = ast_strdup(user_secret);
9837 }
9838
9839 if (user_read) {
9840 user->readperm = get_perm(user_read);
9841 }
9842 if (user_write) {
9843 user->writeperm = get_perm(user_write);
9844 }
9845 if (user_displayconnects) {
9846 user->displayconnects = ast_true(user_displayconnects);
9847 }
9848 if (user_allowmultiplelogin) {
9849 user->allowmultiplelogin = ast_true(user_allowmultiplelogin);
9850 }
9851 if (user_writetimeout) {
9852 int value = atoi(user_writetimeout);
9853 if (value < 100) {
9854 ast_log(LOG_WARNING, "Invalid writetimeout value '%d' in users.conf\n", value);
9855 } else {
9856 user->writetimeout = value;
9857 }
9858 }
9859 }
9860 }
9861 ast_config_destroy(ucfg);
9862 }
9863
9864 /* cat is NULL here in any case */
9865
9866 while ((cat = ast_category_browse(cfg, cat))) {
9867 struct ast_acl_list *oldacl;
9868
9869 if (!strcasecmp(cat, "general")) {
9870 continue;
9871 }
9872
9873 /* Look for an existing entry, if none found - create one and add it to the list */
9874 if (!(user = get_manager_by_name_locked(cat))) {
9875 if (!(user = ast_calloc(1, sizeof(*user)))) {
9876 break;
9877 }
9878 /* Copy name over */
9879 ast_copy_string(user->username, cat, sizeof(user->username));
9880
9881 user->acl = NULL;
9882 user->readperm = 0;
9883 user->writeperm = 0;
9884 /* Default displayconnect from [general] */
9885 user->displayconnects = displayconnects;
9886 /* Default allowmultiplelogin from [general] */
9887 user->allowmultiplelogin = allowmultiplelogin;
9888 user->writetimeout = 100;
9891 if (!user->includefilters || !user->excludefilters) {
9893 break;
9894 }
9895
9896 /* Insert into list */
9898 } else {
9899 ao2_t_callback(user->includefilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all include filters");
9900 ao2_t_callback(user->excludefilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all exclude filters");
9901 }
9902
9903 /* Make sure we keep this user and don't destroy it during cleanup */
9904 user->keep = 1;
9905 oldacl = user->acl;
9906 user->acl = NULL;
9907 ast_variables_destroy(user->chanvars);
9908
9909 var = ast_variable_browse(cfg, cat);
9910 for (; var; var = var->next) {
9911 if (!strcasecmp(var->name, "secret")) {
9912 ast_free(user->secret);
9913 user->secret = ast_strdup(var->value);
9914 } else if (!strcasecmp(var->name, "deny") ||
9915 !strcasecmp(var->name, "permit") ||
9916 !strcasecmp(var->name, "acl")) {
9917 int acl_error = 0;
9918
9919 ast_append_acl(var->name, var->value, &user->acl, &acl_error, &acl_subscription_flag);
9920 if (acl_error) {
9921 ast_log(LOG_ERROR, "Invalid ACL '%s' for manager user '%s' on line %d. Deleting user\n",
9922 var->value, user->username, var->lineno);
9923 user->keep = 0;
9924 }
9925 } else if (!strcasecmp(var->name, "read") ) {
9926 user->readperm = get_perm(var->value);
9927 } else if (!strcasecmp(var->name, "write") ) {
9928 user->writeperm = get_perm(var->value);
9929 } else if (!strcasecmp(var->name, "displayconnects") ) {
9930 user->displayconnects = ast_true(var->value);
9931 } else if (!strcasecmp(var->name, "allowmultiplelogin") ) {
9932 user->allowmultiplelogin = ast_true(var->value);
9933 } else if (!strcasecmp(var->name, "writetimeout")) {
9934 int value = atoi(var->value);
9935 if (value < 100) {
9936 ast_log(LOG_WARNING, "Invalid writetimeout value '%s' at line %d\n", var->value, var->lineno);
9937 } else {
9938 user->writetimeout = value;
9939 }
9940 } else if (!strcasecmp(var->name, "setvar")) {
9941 struct ast_variable *tmpvar;
9942 char varbuf[256];
9943 char *varval;
9944 char *varname;
9945
9946 ast_copy_string(varbuf, var->value, sizeof(varbuf));
9947 varname = varbuf;
9948
9949 if ((varval = strchr(varname,'='))) {
9950 *varval++ = '\0';
9951 if ((tmpvar = ast_variable_new(varname, varval, ""))) {
9952 tmpvar->next = user->chanvars;
9953 user->chanvars = tmpvar;
9954 }
9955 }
9956 } else if (ast_begins_with(var->name, "eventfilter")) {
9957 const char *value = var->value;
9958 manager_add_filter(var->name, value, user->includefilters, user->excludefilters);
9959 } else {
9960 ast_debug(1, "%s is an unknown option.\n", var->name);
9961 }
9962 }
9963
9964 oldacl = ast_free_acl_list(oldacl);
9965 }
9966 ast_config_destroy(cfg);
9967
9968 /* Check the flag for named ACL event subscription and if we need to, register a subscription. */
9969 if (acl_subscription_flag && !by_external_config) {
9971 }
9972
9973 /* Perform cleanup - essentially prune out old users that no longer exist */
9975 if (user->keep) { /* valid record. clear flag for the next round */
9976 user->keep = 0;
9977
9978 /* Calculate A1 for Digest auth */
9979 snprintf(a1, sizeof(a1), "%s:%s:%s", user->username, global_realm, user->secret);
9980 ast_md5_hash(a1_hash,a1);
9981 ast_free(user->a1_hash);
9982 user->a1_hash = ast_strdup(a1_hash);
9983 continue;
9984 }
9985 /* We do not need to keep this user so take them out of the list */
9987 ast_debug(4, "Pruning user '%s'\n", user->username);
9989 }
9991
9993
9995 if (!webregged) {
9999
10003 webregged = 1;
10004 }
10005 } else {
10006 if (webregged) {
10010
10014 webregged = 0;
10015 }
10016 }
10017
10018 if (newhttptimeout > 0) {
10019 httptimeout = newhttptimeout;
10020 }
10021
10023 if (tls_was_enabled && !ami_tls_cfg.enabled) {
10025 } else if (ast_ssl_setup(amis_desc.tls_cfg)) {
10027 }
10028
10029 return 0;
10030}
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:3469
static int action_createconfig(struct mansession *s, const struct message *m)
Definition: manager.c:3070
static int manager_state_cb(const char *context, const char *exten, struct ast_state_cb_info *info, void *data)
Definition: manager.c:7638
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:6741
static struct ast_manager_user * get_manager_by_name_locked(const char *name)
Definition: manager.c:1045
static void acl_change_stasis_subscribe(void)
Definition: manager.c:234
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:7406
static int manager_enabled
Definition: manager.c:169
static int action_sendtext(struct mansession *s, const struct message *m)
Definition: manager.c:3825
static int action_mailboxcount(struct mansession *s, const struct message *m)
Definition: manager.c:5354
static int action_getconfigjson(struct mansession *s, const struct message *m)
Definition: manager.c:2622
static int action_listcategories(struct mansession *s, const struct message *m)
Definition: manager.c:2556
static int action_hangup(struct mansession *s, const struct message *m)
Definition: manager.c:3463
static int action_listcommands(struct mansession *s, const struct message *m)
Definition: manager.c:3206
static int action_atxfer(struct mansession *s, const struct message *m)
Definition: manager.c:4059
static int action_timeout(struct mansession *s, const struct message *m)
Definition: manager.c:5445
static int action_coresettings(struct mansession *s, const struct message *m)
Show PBX core settings information.
Definition: manager.c:6374
static int mansession_cmp_fn(void *obj, void *arg, int flags)
Definition: manager.c:1002
static int displayconnects
Definition: manager.c:164
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:5597
static int manager_debug
Definition: manager.c:172
static int action_mailboxstatus(struct mansession *s, const struct message *m)
Definition: manager.c:5337
static int action_login(struct mansession *s, const struct message *m)
Definition: manager.c:3275
static int action_getvar(struct mansession *s, const struct message *m)
Definition: manager.c:3502
static int action_blind_transfer(struct mansession *s, const struct message *m)
Definition: manager.c:4013
static int action_extensionstate(struct mansession *s, const struct message *m)
Definition: manager.c:5375
static int action_getconfig(struct mansession *s, const struct message *m)
Definition: manager.c:2484
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:5664
static int action_logoff(struct mansession *s, const struct message *m)
Definition: manager.c:3269
static int action_updateconfig(struct mansession *s, const struct message *m)
Definition: manager.c:2979
static int manager_moduleload(struct mansession *s, const struct message *m)
Definition: manager.c:6818
static void acl_change_stasis_unsubscribe(void)
Definition: manager.c:244
static int action_reload(struct mansession *s, const struct message *m)
Send a reload event.
Definition: manager.c:6460
static int authlimit
Definition: manager.c:174
static int action_aocmessage(struct mansession *s, const struct message *m)
Definition: manager.c:4849
static int action_events(struct mansession *s, const struct message *m)
Definition: manager.c:3225
static int action_redirect(struct mansession *s, const struct message *m)
action_redirect: The redirect manager command
Definition: manager.c:3868
static int action_presencestate(struct mansession *s, const struct message *m)
Definition: manager.c:5405
static int allowmultiplelogin
Definition: manager.c:165
static int action_cancel_atxfer(struct mansession *s, const struct message *m)
Definition: manager.c:4113
static char global_realm[MAXHOSTNAMELEN]
Definition: manager.c:179
static int action_originate(struct mansession *s, const struct message *m)
Definition: manager.c:5142
static int action_userevent(struct mansession *s, const struct message *m)
Definition: manager.c:6353
static int action_command(struct mansession *s, const struct message *m)
Manager command "command" - execute CLI command.
Definition: manager.c:4190
static int broken_events_action
Definition: manager.c:168
static int timestampevents
Definition: manager.c:166
static int subscribed
Definition: manager.c:170
static int authtimeout
Definition: manager.c:173
static int manager_modulecheck(struct mansession *s, const struct message *m)
Manager function to check if module is loaded.
Definition: manager.c:6753
static int webmanager_enabled
Definition: manager.c:171
static int action_status(struct mansession *s, const struct message *m)
Manager "status" command to show channels.
Definition: manager.c:3669
static int get_perm(const char *instr)
Definition: manager.c:865
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:6492
static int action_corestatus(struct mansession *s, const struct message *m)
Show PBX core status information.
Definition: manager.c:6418
static int action_challenge(struct mansession *s, const struct message *m)
Definition: manager.c:3324
static struct stasis_topic * manager_topic
A stasis_topic that all topics AMI cares about will be forwarded to.
Definition: manager.c:185
static int action_waitevent(struct mansession *s, const struct message *m)
Definition: manager.c:3088
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:6660
static int action_ping(struct mansession *s, const struct message *m)
Definition: manager.c:2412
static int httptimeout
Definition: manager.c:167
void ast_http_uri_unlink(struct ast_http_uri *urihandler)
Unregister a URI handler.
Definition: http.c:708
int ast_http_uri_link(struct ast_http_uri *urihandler)
Register a URI handler.
Definition: http.c:676
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:3336
char * ast_category_browse(struct ast_config *config, const char *prev_name)
Browse categories.
Definition: extconf.c:3326
#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:3842
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:784
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
@ CONFIG_FLAG_FILEUNCHANGED
#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:9010
static struct ast_tcptls_session_args ami_desc
Definition: manager.c:9011
static struct ast_http_uri managerxmluri
Definition: manager.c:8850
static struct ast_tcptls_session_args amis_desc
Definition: manager.c:9022
static struct ast_custom_function managerclient_function
description of AMI_CLIENT dialplan function
Definition: manager.c:8983
static void load_channelvars(struct ast_variable *var)
Definition: manager.c:9287
static struct ast_http_uri manageruri
Definition: manager.c:8842
static void manager_set_defaults(void)
Definition: manager.c:9507
static struct ast_http_uri arawmanuri
Definition: manager.c:8893
static struct ast_http_uri rawmanuri
Definition: manager.c:8834
static struct ast_cli_entry cli_manager[]
Definition: manager.c:9264
static void manager_free_user(struct ast_manager_user *user)
Definition: manager.c:9320
static struct ast_http_uri amanageruri
Definition: manager.c:8902
static int webregged
Definition: manager.c:8989
static int subscribe_all(void)
Definition: manager.c:9477
static struct ast_http_uri amanagerxmluri
Definition: manager.c:8911
static void load_disabledevents(struct ast_variable *var)
Definition: manager.c:9310
#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:202
#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:3823
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:618
#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:1579
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:345
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:925
int ast_ssl_setup(struct ast_tls_config *cfg)
Set up an SSL server.
Definition: tcptls.c:570
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:760
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:951
#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:2684

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 10167 of file manager.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 10167 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 10128 of file manager.c.

10133{
10134 struct ast_manager_event_blob *ev;
10135 va_list argp;
10136
10137 ast_assert(extra_fields_fmt != NULL);
10139
10141 if (!ev) {
10142 return NULL;
10143 }
10144
10145 if (ast_string_field_init(ev, 20)) {
10146 ao2_ref(ev, -1);
10147 return NULL;
10148 }
10149
10152
10153 va_start(argp, extra_fields_fmt);
10154 ast_string_field_ptr_build_va(ev, &ev->extra_fields, extra_fields_fmt, argp);
10155 va_end(argp);
10156
10157 return ev;
10158}
@ 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:10119
#define manager_event(category, event, contents,...)
External routines may send asterisk manager events this way.
Definition: manager.h:253
#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:502
const ast_string_field extra_fields
Definition: manager.h:507
const char * manager_event
Definition: manager.h:504
#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 10167 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 10106 of file manager.c.

10108{
10109 if (!*fields_string) {
10110 *fields_string = ast_str_create(128);
10111 if (!*fields_string) {
10112 return -1;
10113 }
10114 }
10115
10116 return (ast_str_append(fields_string, 0, "%s: %s\r\n", header, value) < 0) ? -1 : 0;
10117}
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 9077 of file manager.c.

9078{
9079 struct ast_xml_doc_item **item_a = (struct ast_xml_doc_item **)a;
9080 struct ast_xml_doc_item **item_b = (struct ast_xml_doc_item **)b;
9081 return strcmp((*item_a)->name, (*item_b)->name);
9082}
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 10067 of file manager.c.

10068{
10069 AST_LIST_INSERT_HEAD(&s->session->datastores, datastore, entry);
10070
10071 return 0;
10072}
#define AST_LIST_INSERT_HEAD(head, elm, field)
Inserts a list entry at the head of a list.
Definition: linkedlists.h:711
Definition: search.h:40
struct mansession_session::mansession_datastores datastores
struct mansession_session * session
Definition: manager.c:327

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 10079 of file manager.c.

10080{
10081 struct ast_datastore *datastore = NULL;
10082
10083 if (info == NULL)
10084 return NULL;
10085
10087 if (datastore->info != info) {
10088 continue;
10089 }
10090
10091 if (uid == NULL) {
10092 /* matched by type only */
10093 break;
10094 }
10095
10096 if ((datastore->uid != NULL) && !strcasecmp(uid, datastore->uid)) {
10097 /* Matched by type AND uid */
10098 break;
10099 }
10100 }
10102
10103 return datastore;
10104}
#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

References AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, mansession_session::datastores, 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 10074 of file manager.c.

10075{
10076 return AST_LIST_REMOVE(&s->session->datastores, datastore, entry) ? 0 : -1;
10077}
#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 7900 of file manager.c.

7901{
7902 int authed;
7904
7905 if (!(session = find_session(ident, 0)))
7906 return 0;
7907
7908 authed = (session->authenticated != 0);
7909
7912
7913 return authed;
7914}
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:917
static struct mansession_session * find_session(uint32_t ident, int incinuse)
Definition: manager.c:7828

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 7916 of file manager.c.

7917{
7918 int result = 0;
7920 struct ao2_container *sessions;
7921 struct ao2_iterator i;
7922
7923 if (ident == 0) {
7924 return 0;
7925 }
7926
7927 sessions = ao2_global_obj_ref(mgr_sessions);
7928 if (!sessions) {
7929 return 0;
7930 }
7932 ao2_ref(sessions, -1);
7933 while ((session = ao2_iterator_next(&i))) {
7935 if ((session->managerid == ident) && (session->readperm & perm)) {
7936 result = 1;
7939 break;
7940 }
7943 }
7945
7946 return result;
7947}
#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 7949 of file manager.c.

7950{
7951 int result = 0;
7953 struct ao2_container *sessions;
7954 struct ao2_iterator i;
7955
7956 if (ident == 0) {
7957 return 0;
7958 }
7959
7960 sessions = ao2_global_obj_ref(mgr_sessions);
7961 if (!sessions) {
7962 return 0;
7963 }
7965 ao2_ref(sessions, -1);
7966 while ((session = ao2_iterator_next(&i))) {
7968 if ((session->managerid == ident) && (session->writeperm & perm)) {
7969 result = 1;
7972 break;
7973 }
7976 }
7978
7979 return result;
7980}

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 8478 of file manager.c.

8484{
8486 struct mansession s = { .session = NULL, .tcptls_session = ser };
8487 struct ast_variable *v, *params = get_params;
8488 char template[] = "/tmp/ast-http-XXXXXX"; /* template for temporary file */
8489 struct ast_str *http_header = NULL, *out = NULL;
8490 size_t result_size;
8491 struct message m = { 0 };
8492 int fd;
8493
8494 time_t time_now = time(NULL);
8495 unsigned long nonce = 0, nc;
8496 struct ast_http_digest d = { NULL, };
8497 struct ast_manager_user *user = NULL;
8498 int stale = 0;
8499 char resp_hash[256]="";
8500 /* Cache for user data */
8501 char u_username[80];
8502 int u_readperm;
8503 int u_writeperm;
8504 int u_writetimeout;
8505 int u_displayconnects;
8506
8508 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
8509 return 0;
8510 }
8511
8512 /* Find "Authorization: " header */
8513 for (v = headers; v; v = v->next) {
8514 if (!strcasecmp(v->name, "Authorization")) {
8515 break;
8516 }
8517 }
8518
8519 if (!v || ast_strlen_zero(v->value)) {
8520 goto out_401; /* Authorization Header not present - send auth request */
8521 }
8522
8523 /* Digest found - parse */
8524 if (ast_string_field_init(&d, 128)) {
8526 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8527 return 0;
8528 }
8529
8530 if (ast_parse_digest(v->value, &d, 0, 1)) {
8531 /* Error in Digest - send new one */
8532 nonce = 0;
8533 goto out_401;
8534 }
8535 if (sscanf(d.nonce, "%30lx", &nonce) != 1) {
8536 ast_log(LOG_WARNING, "Received incorrect nonce in Digest <%s>\n", d.nonce);
8537 nonce = 0;
8538 goto out_401;
8539 }
8540
8542 user = get_manager_by_name_locked(d.username);
8543 if(!user) {
8545 ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_sockaddr_stringify_addr(&session->addr), d.username);
8546 nonce = 0;
8547 goto out_401;
8548 }
8549
8550 /* --- We have User for this auth, now check ACL */
8551 if (user->acl && !ast_apply_acl(user->acl, remote_address, "Manager User ACL:")) {
8553 ast_log(LOG_NOTICE, "%s failed to pass IP ACL as '%s'\n", ast_sockaddr_stringify_addr(&session->addr), d.username);
8555 ast_http_error(ser, 403, "Permission denied", "Permission denied");
8556 return 0;
8557 }
8558
8559 /* --- We have auth, so check it */
8560
8561 /* compute the expected response to compare with what we received */
8562 {
8563 char *a2;
8564 /* ast_md5_hash outputs 32 characters plus NULL terminator. */
8565 char a2_hash[33];
8566 char resp[256];
8567
8568 /* XXX Now request method are hardcoded in A2 */
8569 if (ast_asprintf(&a2, "%s:%s", ast_get_http_method(method), d.uri) < 0) {
8572 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8573 return 0;
8574 }
8575
8576 ast_md5_hash(a2_hash, a2);
8577 ast_free(a2);
8578
8579 if (d.qop) {
8580 /* RFC 2617 */
8581 snprintf(resp, sizeof(resp), "%s:%08lx:%s:%s:auth:%s", user->a1_hash, nonce, d.nc, d.cnonce, a2_hash);
8582 } else {
8583 /* RFC 2069 */
8584 snprintf(resp, sizeof(resp), "%s:%08lx:%s", user->a1_hash, nonce, a2_hash);
8585 }
8586 ast_md5_hash(resp_hash, resp);
8587 }
8588
8589 if (strncasecmp(d.response, resp_hash, strlen(resp_hash))) {
8590 /* Something was wrong, so give the client to try with a new challenge */
8592 nonce = 0;
8593 goto out_401;
8594 }
8595
8596 /*
8597 * User are pass Digest authentication.
8598 * Now, cache the user data and unlock user list.
8599 */
8600 ast_copy_string(u_username, user->username, sizeof(u_username));
8601 u_readperm = user->readperm;
8602 u_writeperm = user->writeperm;
8603 u_displayconnects = user->displayconnects;
8604 u_writetimeout = user->writetimeout;
8606
8607 if (!(session = find_session_by_nonce(d.username, nonce, &stale))) {
8608 /*
8609 * Create new session.
8610 * While it is not in the list we don't need any locking
8611 */
8612 if (!(session = build_mansession(remote_address))) {
8614 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8615 return 0;
8616 }
8618
8619 ast_copy_string(session->username, u_username, sizeof(session->username));
8620 session->managerid = nonce;
8621 session->last_ev = grab_last();
8622 AST_LIST_HEAD_INIT_NOLOCK(&session->datastores);
8623
8624 session->readperm = u_readperm;
8625 session->writeperm = u_writeperm;
8626 session->writetimeout = u_writetimeout;
8627
8628 if (u_displayconnects) {
8629 ast_verb(2, "HTTP Manager '%s' logged in from %s\n", session->username, ast_sockaddr_stringify_addr(&session->addr));
8630 }
8631 session->noncetime = session->sessionstart = time_now;
8632 session->authenticated = 1;
8633 } else if (stale) {
8634 /*
8635 * Session found, but nonce is stale.
8636 *
8637 * This could be because an old request (w/old nonce) arrived.
8638 *
8639 * This may be as the result of http proxy usage (separate delay or
8640 * multipath) or in a situation where a page was refreshed too quickly
8641 * (seen in Firefox).
8642 *
8643 * In this situation, we repeat the 401 auth with the current nonce
8644 * value.
8645 */
8646 nonce = session->managerid;
8648 stale = 1;
8649 goto out_401;
8650 } else {
8651 sscanf(d.nc, "%30lx", &nc);
8652 if (session->nc >= nc || ((time_now - session->noncetime) > 62) ) {
8653 /*
8654 * Nonce time expired (> 2 minutes) or something wrong with nonce
8655 * counter.
8656 *
8657 * Create new nonce key and resend Digest auth request. Old nonce
8658 * is saved for stale checking...
8659 */
8660 session->nc = 0; /* Reset nonce counter */
8661 session->oldnonce = session->managerid;
8662 nonce = session->managerid = ast_random();
8663 session->noncetime = time_now;
8665 stale = 1;
8666 goto out_401;
8667 } else {
8668 session->nc = nc; /* All OK, save nonce counter */
8669 }
8670 }
8671
8672
8673 /* Reset session timeout. */
8674 session->sessiontimeout = time(NULL) + (httptimeout > 5 ? httptimeout : 5);
8676
8677 ast_mutex_init(&s.lock);
8678 s.session = session;
8679 fd = mkstemp(template); /* create a temporary file for command output */
8680 unlink(template);
8681 if (fd <= -1) {
8682 ast_http_error(ser, 500, "Server Error", "Internal Server Error (mkstemp failed)");
8683 goto auth_callback_out;
8684 }
8686 if (!s.stream) {
8687 ast_log(LOG_WARNING, "HTTP Manager, fdopen failed: %s!\n", strerror(errno));
8688 ast_http_error(ser, 500, "Server Error", "Internal Server Error (fdopen failed)");
8689 close(fd);
8690 goto auth_callback_out;
8691 }
8692
8693 if (method == AST_HTTP_POST) {
8694 params = ast_http_get_post_vars(ser, headers);
8695 if (!params) {
8696 switch (errno) {
8697 case EFBIG:
8698 ast_http_error(ser, 413, "Request Entity Too Large", "Body too large");
8700 goto auth_callback_out;
8701 case ENOMEM:
8703 ast_http_error(ser, 500, "Server Error", "Out of memory");
8705 goto auth_callback_out;
8706 case EIO:
8707 ast_http_error(ser, 400, "Bad Request", "Error parsing request body");
8709 goto auth_callback_out;
8710 }
8711 }
8712 }
8713
8714 astman_append_headers(&m, params);
8715
8716 if (process_message(&s, &m)) {
8717 if (u_displayconnects) {
8718 ast_verb(2, "HTTP Manager '%s' logged off from %s\n", session->username, ast_sockaddr_stringify_addr(&session->addr));
8719 }
8720
8721 session->needdestroy = 1;
8722 }
8723
8725
8726 result_size = lseek(ast_iostream_get_fd(s.stream), 0, SEEK_CUR); /* Calculate approx. size of result */
8727
8728 http_header = ast_str_create(80);
8729 out = ast_str_create(result_size * 2 + 512);
8730 if (http_header == NULL || out == NULL) {
8732 ast_http_error(ser, 500, "Server Error", "Internal Server Error (ast_str_create() out of memory)");
8734 goto auth_callback_out;
8735 }
8736
8737 ast_str_append(&http_header, 0, "Content-type: text/%s\r\n", contenttype[format]);
8738
8739 if (format == FORMAT_XML) {
8740 ast_str_append(&out, 0, "<ajax-response>\n");
8741 } else if (format == FORMAT_HTML) {
8742 ast_str_append(&out, 0,
8743 "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\r\n"
8744 "<html><head>\r\n"
8745 "<title>Asterisk&trade; Manager Interface</title>\r\n"
8746 "</head><body style=\"background-color: #ffffff;\">\r\n"
8747 "<form method=\"POST\">\r\n"
8748 "<table align=\"center\" style=\"background-color: #f1f1f1;\" width=\"500\">\r\n"
8749 "<tr><th colspan=\"2\" style=\"background-color: #f1f1ff;\"><h1>Manager Tester</h1></th></tr>\r\n"
8750 "<tr><th colspan=\"2\" style=\"background-color: #f1f1ff;\">Action: <input name=\"action\" /> Cmd: <input name=\"command\" /><br>"
8751 "<input type=\"submit\" value=\"Send request\" /></th></tr>\r\n");
8752 }
8753
8754 process_output(&s, &out, params, format);
8755
8756 if (format == FORMAT_XML) {
8757 ast_str_append(&out, 0, "</ajax-response>\n");
8758 } else if (format == FORMAT_HTML) {
8759 ast_str_append(&out, 0, "</table></form></body></html>\r\n");
8760 }
8761
8762 ast_http_send(ser, method, 200, NULL, http_header, out, 0, 0);
8763 http_header = NULL;
8764 out = NULL;
8765
8766auth_callback_out:
8768
8769 /* Clear resources and unlock manager session */
8770 if (method == AST_HTTP_POST && params) {
8771 ast_variables_destroy(params);
8772 }
8773
8774 ast_free(http_header);
8775 ast_free(out);
8776
8778 if (session->stream) {
8779 ast_iostream_close(session->stream);
8780 session->stream = NULL;
8781 }
8783
8784 if (session->needdestroy) {
8785 ast_debug(1, "Need destroy, doing it now!\n");
8787 }
8789 return 0;
8790
8791out_401:
8792 if (!nonce) {
8793 nonce = ast_random();
8794 }
8795
8796 ast_http_auth(ser, global_realm, nonce, nonce, stale, NULL);
8798 return 0;
8799}
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:6938
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:969
static void astman_free_headers(struct message *m)
Free headers inside message structure, but not the message structure itself.
Definition: manager.c:1654
static void session_destroy(struct mansession_session *s)
Definition: manager.c:1009
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:1640
static struct eventqent * grab_last(void)
Definition: manager.c:697
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:459
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:1356
@ 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:625
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:840
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:651
#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:186
#define ast_mutex_destroy(a)
Definition: lock.h:188
int errno
static void close_mansession_file(struct mansession *s)
Definition: manager.c:8223
static struct mansession_session * find_session_by_nonce(const char *username, unsigned long nonce, int *stale)
Definition: manager.c:7867
static void process_output(struct mansession *s, struct ast_str **out, struct ast_variable *params, enum output_format format)
Definition: manager.c:8233
static const char *const contenttype[]
Definition: manager.c:7817
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:326
struct ast_iostream * stream
Definition: manager.c:328
ast_mutex_t lock
Definition: manager.c:333
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 8860 of file manager.c.

8861{
8862 int retval;
8863 struct ast_sockaddr ser_remote_address_tmp;
8864
8865 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8866 retval = auth_http_callback(ser, method, FORMAT_HTML, &ser_remote_address_tmp, uri, get_params, headers);
8867 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8868 return retval;
8869}
static ENTRY retval
Definition: hsearch.c:50
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:8478
struct ast_sockaddr remote_address
Definition: tcptls.h:152

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

◆ 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 8871 of file manager.c.

8872{
8873 int retval;
8874 struct ast_sockaddr ser_remote_address_tmp;
8875
8876 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8877 retval = auth_http_callback(ser, method, FORMAT_XML, &ser_remote_address_tmp, uri, get_params, headers);
8878 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8879 return retval;
8880}

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

◆ 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 8882 of file manager.c.

8883{
8884 int retval;
8885 struct ast_sockaddr ser_remote_address_tmp;
8886
8887 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8888 retval = auth_http_callback(ser, method, FORMAT_RAW, &ser_remote_address_tmp, uri, get_params, headers);
8889 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8890 return retval;
8891}

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

◆ close_mansession_file()

static void close_mansession_file ( struct mansession s)
static

Definition at line 8223 of file manager.c.

8224{
8225 if (s->stream) {
8227 s->stream = NULL;
8228 } else {
8229 ast_log(LOG_ERROR, "Attempted to close file/file descriptor on mansession without a valid file or file descriptor.\n");
8230 }
8231}

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 7828 of file manager.c.

7829{
7830 struct ao2_container *sessions;
7832 struct ao2_iterator i;
7833
7834 if (ident == 0) {
7835 return NULL;
7836 }
7837
7838 sessions = ao2_global_obj_ref(mgr_sessions);
7839 if (!sessions) {
7840 return NULL;
7841 }
7843 ao2_ref(sessions, -1);
7844 while ((session = ao2_iterator_next(&i))) {
7846 if (session->managerid == ident && !session->needdestroy) {
7847 ast_atomic_fetchadd_int(&session->inuse, incinuse ? 1 : 0);
7848 break;
7849 }
7852 }
7854
7855 return session;
7856}
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:757

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 7867 of file manager.c.

7868{
7870 struct ao2_container *sessions;
7871 struct ao2_iterator i;
7872
7873 if (nonce == 0 || username == NULL || stale == NULL) {
7874 return NULL;
7875 }
7876
7877 sessions = ao2_global_obj_ref(mgr_sessions);
7878 if (!sessions) {
7879 return NULL;
7880 }
7882 ao2_ref(sessions, -1);
7883 while ((session = ao2_iterator_next(&i))) {
7885 if (!strcasecmp(session->username, username) && session->managerid == nonce) {
7886 *stale = 0;
7887 break;
7888 } else if (!strcasecmp(session->username, username) && session->oldnonce == nonce) {
7889 *stale = 1;
7890 break;
7891 }
7894 }
7896
7897 return session;
7898}

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 8936 of file manager.c.

8937{
8938 struct ast_manager_user *user = NULL;
8939
8942 AST_APP_ARG(param);
8943 );
8944
8945
8946 if (ast_strlen_zero(data) ) {
8947 ast_log(LOG_WARNING, "AMI_CLIENT() requires two arguments: AMI_CLIENT(<name>[,<arg>])\n");
8948 return -1;
8949 }
8951 args.name = ast_strip(args.name);
8952 args.param = ast_strip(args.param);
8953
8955 if (!(user = get_manager_by_name_locked(args.name))) {
8957 ast_log(LOG_ERROR, "There's no manager user called : \"%s\"\n", args.name);
8958 return -1;
8959 }
8961
8962 if (!strcasecmp(args.param, "sessions")) {
8963 int no_sessions = 0;
8964 struct ao2_container *sessions;
8965
8966 sessions = ao2_global_obj_ref(mgr_sessions);
8967 if (sessions) {
8968 ao2_callback_data(sessions, 0, get_manager_sessions_cb, /*login name*/ data, &no_sessions);
8969 ao2_ref(sessions, -1);
8970 }
8971 snprintf(buf, len, "%d", no_sessions);
8972 } else {
8973 ast_log(LOG_ERROR, "Invalid arguments provided to function AMI_CLIENT: %s\n", args.param);
8974 return -1;
8975
8976 }
8977
8978 return 0;
8979}
#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:8921
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 8266 of file manager.c.

8272{
8273 struct mansession s = { .session = NULL, .tcptls_session = ser };
8275 uint32_t ident;
8276 int fd;
8277 int blastaway = 0;
8278 struct ast_variable *params = get_params;
8279 char template[] = "/tmp/ast-http-XXXXXX"; /* template for temporary file */
8280 struct ast_str *http_header = NULL, *out = NULL;
8281 struct message m = { 0 };
8282
8284 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
8285 return 0;
8286 }
8287
8288 ident = ast_http_manid_from_vars(headers);
8289
8290 if (!(session = find_session(ident, 1))) {
8291
8292 /**/
8293 /* Create new session.
8294 * While it is not in the list we don't need any locking
8295 */
8296 if (!(session = build_mansession(remote_address))) {
8298 ast_http_error(ser, 500, "Server Error", "Internal Server Error (out of memory)");
8299 return 0;
8300 }
8302 session->send_events = 0;
8303 session->inuse = 1;
8304 /*!
8305 * \note There is approximately a 1 in 1.8E19 chance that the following
8306 * calculation will produce 0, which is an invalid ID, but due to the
8307 * properties of the rand() function (and the constancy of s), that
8308 * won't happen twice in a row.
8309 */
8310 while ((session->managerid = ast_random() ^ (unsigned long) session) == 0) {
8311 }
8312 session->last_ev = grab_last();
8313 AST_LIST_HEAD_INIT_NOLOCK(&session->datastores);
8314 }
8316
8317 http_header = ast_str_create(128);
8318 out = ast_str_create(2048);
8319
8320 ast_mutex_init(&s.lock);
8321
8322 if (http_header == NULL || out == NULL) {
8324 ast_http_error(ser, 500, "Server Error", "Internal Server Error (ast_str_create() out of memory)");
8325 goto generic_callback_out;
8326 }
8327
8328 s.session = session;
8329 fd = mkstemp(template); /* create a temporary file for command output */
8330 unlink(template);
8331 if (fd <= -1) {
8332 ast_http_error(ser, 500, "Server Error", "Internal Server Error (mkstemp failed)");
8333 goto generic_callback_out;
8334 }
8336 if (!s.stream) {
8337 ast_log(LOG_WARNING, "HTTP Manager, fdopen failed: %s!\n", strerror(errno));
8338 ast_http_error(ser, 500, "Server Error", "Internal Server Error (fdopen failed)");
8339 close(fd);
8340 goto generic_callback_out;
8341 }
8342
8343 if (method == AST_HTTP_POST) {
8344 params = ast_http_get_post_vars(ser, headers);
8345 if (!params) {
8346 switch (errno) {
8347 case EFBIG:
8348 ast_http_error(ser, 413, "Request Entity Too Large", "Body too large");
8350 goto generic_callback_out;
8351 case ENOMEM:
8353 ast_http_error(ser, 500, "Server Error", "Out of memory");
8355 goto generic_callback_out;
8356 case EIO:
8357 ast_http_error(ser, 400, "Bad Request", "Error parsing request body");
8359 goto generic_callback_out;
8360 }
8361 }
8362 }
8363
8364 astman_append_headers(&m, params);
8365
8366 if (process_message(&s, &m)) {
8367 if (session->authenticated) {
8369 ast_verb(2, "HTTP Manager '%s' logged off from %s\n", session->username, ast_sockaddr_stringify_addr(&session->addr));
8370 }
8371 } else {
8372 if (displayconnects) {
8373 ast_verb(2, "HTTP Connect attempt from '%s' unable to authenticate\n", ast_sockaddr_stringify_addr(&session->addr));
8374 }
8375 }
8376 session->needdestroy = 1;
8377 }
8378
8380
8381 ast_str_append(&http_header, 0,
8382 "Content-type: text/%s\r\n"
8383 "Set-Cookie: mansession_id=\"%08x\"; Version=1; Max-Age=%d\r\n"
8384 "Pragma: SuppressEvents\r\n",
8385 contenttype[format],
8386 session->managerid, httptimeout);
8387
8388 if (format == FORMAT_XML) {
8389 ast_str_append(&out, 0, "<ajax-response>\n");
8390 } else if (format == FORMAT_HTML) {
8391 /*
8392 * When handling AMI-over-HTTP in HTML format, we provide a simple form for
8393 * debugging purposes. This HTML code should not be here, we
8394 * should read from some config file...
8395 */
8396
8397#define ROW_FMT "<tr><td colspan=\"2\" bgcolor=\"#f1f1ff\">%s</td></tr>\r\n"
8398#define TEST_STRING \
8399 "<form action=\"manager\" method=\"post\">\n\
8400 Action: <select name=\"action\">\n\
8401 <option value=\"\">-----&gt;</option>\n\
8402 <option value=\"login\">login</option>\n\
8403 <option value=\"command\">Command</option>\n\
8404 <option value=\"waitevent\">waitevent</option>\n\
8405 <option value=\"listcommands\">listcommands</option>\n\
8406 </select>\n\
8407 or <input name=\"action\"><br/>\n\
8408 CLI Command <input name=\"command\"><br>\n\
8409 user <input name=\"username\"> pass <input type=\"password\" name=\"secret\"><br>\n\
8410 <input type=\"submit\">\n</form>\n"
8411
8412 ast_str_append(&out, 0, "<title>Asterisk&trade; Manager Interface</title>");
8413 ast_str_append(&out, 0, "<body bgcolor=\"#ffffff\"><table align=center bgcolor=\"#f1f1f1\" width=\"500\">\r\n");
8414 ast_str_append(&out, 0, ROW_FMT, "<h1>Manager Tester</h1>");
8416 }
8417
8418 process_output(&s, &out, params, format);
8419
8420 if (format == FORMAT_XML) {
8421 ast_str_append(&out, 0, "</ajax-response>\n");
8422 } else if (format == FORMAT_HTML) {
8423 ast_str_append(&out, 0, "</table></body>\r\n");
8424 }
8425
8427 /* Reset HTTP timeout. If we're not authenticated, keep it extremely short */
8428 session->sessiontimeout = time(NULL) + ((session->authenticated || httptimeout < 5) ? httptimeout : 5);
8429
8430 if (session->needdestroy) {
8431 if (session->inuse == 1) {
8432 ast_debug(1, "Need destroy, doing it now!\n");
8433 blastaway = 1;
8434 } else {
8435 ast_debug(1, "Need destroy, but can't do it yet!\n");
8436 ast_mutex_lock(&session->notify_lock);
8437 if (session->waiting_thread != AST_PTHREADT_NULL) {
8438 pthread_kill(session->waiting_thread, SIGURG);
8439 }
8440 ast_mutex_unlock(&session->notify_lock);
8441 session->inuse--;
8442 }
8443 } else {
8444 session->inuse--;
8445 }
8447
8448 ast_http_send(ser, method, 200, NULL, http_header, out, 0, 0);
8449 http_header = NULL;
8450 out = NULL;
8451
8452generic_callback_out:
8454
8455 /* Clear resource */
8456
8457 if (method == AST_HTTP_POST && params) {
8458 ast_variables_destroy(params);
8459 }
8460 ast_free(http_header);
8461 ast_free(out);
8462
8463 if (session) {
8464 if (blastaway) {
8466 } else {
8467 if (session->stream) {
8468 ast_iostream_close(session->stream);
8469 session->stream = NULL;
8470 }
8472 }
8473 }
8474
8475 return 0;
8476}
static int manager_displayconnects(struct mansession_session *session)
Get displayconnects config option.
Definition: manager.c:1062
uint32_t ast_http_manid_from_vars(struct ast_variable *headers) attribute_pure
Return manager id, if exist, from request headers.
Definition: http.c:220
#define AST_PTHREADT_NULL
Definition: lock.h:66
#define ast_mutex_unlock(a)
Definition: lock.h:190
#define ast_mutex_lock(a)
Definition: lock.h:189
#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 8921 of file manager.c.

8922{
8923 struct mansession_session *session = obj;
8924 const char *login = (char *)arg;
8925 int *no_sessions = data;
8926
8927 if (strcasecmp(session->username, login) == 0) {
8928 (*no_sessions)++;
8929 }
8930
8931 return 0;
8932}

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 9202 of file manager.c.

9203{
9205 struct ao2_iterator it_events;
9206 struct ast_xml_doc_item *item, *temp;
9207 int length;
9208
9209 if (cmd == CLI_INIT) {
9210 e->command = "manager show event";
9211 e->usage =
9212 "Usage: manager show event <eventname>\n"
9213 " Provides a detailed description a Manager interface event.\n";
9214 return NULL;
9215 }
9216
9217 events = ao2_global_obj_ref(event_docs);
9218 if (!events) {
9219 ast_cli(a->fd, "No manager event documentation loaded\n");
9220 return CLI_SUCCESS;
9221 }
9222
9223 if (cmd == CLI_GENERATE) {
9224 if (a->pos != 3) {
9225 return NULL;
9226 }
9227
9228 length = strlen(a->word);
9229 it_events = ao2_iterator_init(events, 0);
9230 while ((item = ao2_iterator_next(&it_events))) {
9231 if (!strncasecmp(a->word, item->name, length)) {
9233 ao2_ref(item, -1);
9234 break;
9235 }
9236 }
9237 ao2_ref(item, -1);
9238 }
9239 ao2_iterator_destroy(&it_events);
9240
9241 return NULL;
9242 }
9243
9244 if (a->argc != 4) {
9245 return CLI_SHOWUSAGE;
9246 }
9247
9248 if (!(item = ao2_find(events, a->argv[3], OBJ_KEY))) {
9249 ast_cli(a->fd, "Could not find event '%s'\n", a->argv[3]);
9250 return CLI_SUCCESS;
9251 }
9252
9253 ast_cli(a->fd, "Event: %s\n", a->argv[3]);
9254 for (temp = item; temp; temp = AST_LIST_NEXT(temp, next)) {
9255 print_event_instance(a, temp);
9256 }
9257
9258 ao2_ref(item, -1);
9259 return CLI_SUCCESS;
9260}
static const struct adsi_event events[]
Definition: app_adsiprog.c:85
#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:9165
#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 9084 of file manager.c.

9085{
9086 struct ao2_container *events;
9087 struct ao2_iterator *it_events;
9088 struct ast_xml_doc_item *item;
9089 struct ast_xml_doc_item **items;
9090 struct ast_str *buffer;
9091 int i = 0, totalitems = 0;
9092
9093 switch (cmd) {
9094 case CLI_INIT:
9095 e->command = "manager show events";
9096 e->usage =
9097 "Usage: manager show events\n"
9098 " Prints a listing of the available Asterisk manager interface events.\n";
9099 return NULL;
9100 case CLI_GENERATE:
9101 return NULL;
9102 }
9103 if (a->argc != 3) {
9104 return CLI_SHOWUSAGE;
9105 }
9106
9107 buffer = ast_str_create(128);
9108 if (!buffer) {
9109 return CLI_SUCCESS;
9110 }
9111
9112 events = ao2_global_obj_ref(event_docs);
9113 if (!events) {
9114 ast_cli(a->fd, "No manager event documentation loaded\n");
9115 ast_free(buffer);
9116 return CLI_SUCCESS;
9117 }
9118
9120 if (!(it_events = ao2_callback(events, OBJ_MULTIPLE | OBJ_NOLOCK, NULL, NULL))) {
9122 ast_log(AST_LOG_ERROR, "Unable to create iterator for events container\n");
9123 ast_free(buffer);
9124 ao2_ref(events, -1);
9125 return CLI_SUCCESS;
9126 }
9127 if (!(items = ast_calloc(sizeof(struct ast_xml_doc_item *), ao2_container_count(events)))) {
9129 ast_log(AST_LOG_ERROR, "Unable to create temporary sorting array for events\n");
9130 ao2_iterator_destroy(it_events);
9131 ast_free(buffer);
9132 ao2_ref(events, -1);
9133 return CLI_SUCCESS;
9134 }
9136
9137 while ((item = ao2_iterator_next(it_events))) {
9138 items[totalitems++] = item;
9139 ao2_ref(item, -1);
9140 }
9141
9142 qsort(items, totalitems, sizeof(struct ast_xml_doc_item *), ast_xml_doc_item_cmp_fn);
9143
9144 ast_cli(a->fd, "Events:\n");
9145 ast_cli(a->fd, " -------------------- -------------------- -------------------- \n");
9146 for (i = 0; i < totalitems; i++) {
9147 ast_str_append(&buffer, 0, " %-20.20s", items[i]->name);
9148 if ((i + 1) % 3 == 0) {
9149 ast_cli(a->fd, "%s\n", ast_str_buffer(buffer));
9150 ast_str_set(&buffer, 0, "%s", "");
9151 }
9152 }
9153 if ((i + 1) % 3 != 0) {
9154 ast_cli(a->fd, "%s\n", ast_str_buffer(buffer));
9155 }
9156
9157 ao2_iterator_destroy(it_events);
9158 ast_free(items);
9159 ao2_ref(events, -1);
9160 ast_free(buffer);
9161
9162 return CLI_SUCCESS;
9163}
#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:9077
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 9033 of file manager.c.

9034{
9035 switch (cmd) {
9036 case CLI_INIT:
9037 e->command = "manager show settings";
9038 e->usage =
9039 "Usage: manager show settings\n"
9040 " Provides detailed list of the configuration of the Manager.\n";
9041 return NULL;
9042 case CLI_GENERATE:
9043 return NULL;
9044 }
9045#define FORMAT " %-25.25s %-15.55s\n"
9046#define FORMAT2 " %-25.25s %-15d\n"
9047#define FORMAT3 " %-25.25s %s\n"
9048 if (a->argc != 3) {
9049 return CLI_SHOWUSAGE;
9050 }
9051 ast_cli(a->fd, "\nGlobal Settings:\n");
9052 ast_cli(a->fd, "----------------\n");
9053 ast_cli(a->fd, FORMAT, "Manager (AMI):", AST_CLI_YESNO(manager_enabled));
9054 ast_cli(a->fd, FORMAT, "Web Manager (AMI/HTTP):", AST_CLI_YESNO(webmanager_enabled));
9055 ast_cli(a->fd, FORMAT, "TCP Bindaddress:", manager_enabled != 0 ? ast_sockaddr_stringify(&ami_desc.local_address) : "Disabled");
9056 ast_cli(a->fd, FORMAT2, "HTTP Timeout (seconds):", httptimeout);
9057 ast_cli(a->fd, FORMAT, "TLS Enable:", AST_CLI_YESNO(ami_tls_cfg.enabled));
9058 ast_cli(a->fd, FORMAT, "TLS Bindaddress:", ami_tls_cfg.enabled != 0 ? ast_sockaddr_stringify(&amis_desc.local_address) : "Disabled");
9059 ast_cli(a->fd, FORMAT, "TLS Certfile:", ami_tls_cfg.certfile);
9060 ast_cli(a->fd, FORMAT, "TLS Privatekey:", ami_tls_cfg.pvtfile);
9061 ast_cli(a->fd, FORMAT, "TLS Cipher:", ami_tls_cfg.cipher);
9062 ast_cli(a->fd, FORMAT, "Allow multiple login:", AST_CLI_YESNO(allowmultiplelogin));
9063 ast_cli(a->fd, FORMAT, "Display connects:", AST_CLI_YESNO(displayconnects));
9064 ast_cli(a->fd, FORMAT, "Timestamp events:", AST_CLI_YESNO(timestampevents));
9065 ast_cli(a->fd, FORMAT3, "Channel vars:", S_OR(manager_channelvars, ""));
9066 ast_cli(a->fd, FORMAT3, "Disabled events:", S_OR(manager_disabledevents, ""));
9067 ast_cli(a->fd, FORMAT, "Debug:", AST_CLI_YESNO(manager_debug));
9068#undef FORMAT
9069#undef FORMAT2
9070#undef FORMAT3
9071
9072 return CLI_SUCCESS;
9073}
#define AST_CLI_YESNO(x)
Return Yes or No depending on the argument.
Definition: cli.h:71
static char * manager_channelvars
Definition: manager.c:175
static char * manager_disabledevents
Definition: manager.c:176
#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 9287 of file manager.c.

9288{
9289 char *parse = NULL;
9291 AST_APP_ARG(vars)[MAX_VARS];
9292 );
9293
9296
9297 /* parse the setting */
9300
9302}
#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:7909
#define MAX_VARS
Definition: manager.c:208

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 9310 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 10049 of file manager.c.

10050{
10051 int rc = 0;
10054#ifdef TEST_FRAMEWORK
10055 AST_TEST_REGISTER(eventfilter_test_creation);
10056 AST_TEST_REGISTER(eventfilter_test_matching);
10057 AST_TEST_REGISTER(originate_permissions_test);
10058#endif
10059 return rc;
10060}
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:9535
static void manager_shutdown(void)
Definition: manager.c:9339
@ 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 10119 of file manager.c.

10120{
10121 struct ast_manager_event_blob *ev = obj;
10122
10124}

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 9320 of file manager.c.

9321{
9322 ast_free(user->a1_hash);
9323 ast_free(user->secret);
9324 if (user->includefilters) {
9325 ao2_t_ref(user->includefilters, -1, "decrement ref for include container, should be last one");
9326 }
9327 if (user->excludefilters) {
9328 ao2_t_ref(user->excludefilters, -1, "decrement ref for exclude container, should be last one");
9329 }
9330 user->acl = ast_free_acl_list(user->acl);
9331 ast_variables_destroy(user->chanvars);
9332 ast_free(user);
9333}

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 8801 of file manager.c.

8802{
8803 int retval;
8804 struct ast_sockaddr ser_remote_address_tmp;
8805
8806 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8807 retval = generic_http_callback(ser, method, FORMAT_HTML, &ser_remote_address_tmp, uri, get_params, headers);
8808 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8809 return retval;
8810}
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:8266

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

◆ manager_set_defaults()

static void manager_set_defaults ( void  )
static

Definition at line 9507 of file manager.c.

9508{
9509 manager_enabled = 0;
9510 displayconnects = 1;
9512 authtimeout = 30;
9513 authlimit = 50;
9514 manager_debug = 0; /* Debug disabled by default */
9515
9516 /* default values */
9518 sizeof(global_realm));
9521
9522 ami_tls_cfg.enabled = 0;
9533}
#define DEFAULT_REALM
Definition: manager.c:178
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 9339 of file manager.c.

9340{
9341 struct ast_manager_user *user;
9342
9343#ifdef TEST_FRAMEWORK
9344 AST_TEST_UNREGISTER(eventfilter_test_creation);
9345 AST_TEST_UNREGISTER(eventfilter_test_matching);
9346 AST_TEST_UNREGISTER(originate_permissions_test);
9347#endif
9348
9349 /* This event is not actually transmitted, but causes all TCP sessions to be closed */
9350 manager_event(EVENT_FLAG_SHUTDOWN, "CloseSession", "CloseSession: true\r\n");
9351
9352 ast_manager_unregister("Ping");
9353 ast_manager_unregister("Events");
9354 ast_manager_unregister("Logoff");
9355 ast_manager_unregister("Login");
9356 ast_manager_unregister("Challenge");
9357 ast_manager_unregister("Hangup");
9358 ast_manager_unregister("Status");
9359 ast_manager_unregister("Setvar");
9360 ast_manager_unregister("Getvar");
9361 ast_manager_unregister("GetConfig");
9362 ast_manager_unregister("GetConfigJSON");
9363 ast_manager_unregister("UpdateConfig");
9364 ast_manager_unregister("CreateConfig");
9365 ast_manager_unregister("ListCategories");
9366 ast_manager_unregister("Redirect");
9367 ast_manager_unregister("Atxfer");
9368 ast_manager_unregister("CancelAtxfer");
9369 ast_manager_unregister("Originate");
9370 ast_manager_unregister("Command");
9371 ast_manager_unregister("ExtensionState");
9372 ast_manager_unregister("PresenceState");
9373 ast_manager_unregister("AbsoluteTimeout");
9374 ast_manager_unregister("MailboxStatus");
9375 ast_manager_unregister("MailboxCount");
9376 ast_manager_unregister("ListCommands");
9377 ast_manager_unregister("SendText");
9378 ast_manager_unregister("UserEvent");
9379 ast_manager_unregister("WaitEvent");
9380 ast_manager_unregister("CoreSettings");
9381 ast_manager_unregister("CoreStatus");
9382 ast_manager_unregister("Reload");
9383 ast_manager_unregister("LoggerRotate");
9384 ast_manager_unregister("CoreShowChannels");
9385 ast_manager_unregister("CoreShowChannelMap");
9386 ast_manager_unregister("ModuleLoad");
9387 ast_manager_unregister("ModuleCheck");
9388 ast_manager_unregister("AOCMessage");
9389 ast_manager_unregister("Filter");
9390 ast_manager_unregister("BlindTransfer");
9393
9394#ifdef AST_XML_DOCS
9395 ao2_t_global_obj_release(event_docs, "Dispose of event_docs");
9396#endif
9397
9398#ifdef TEST_FRAMEWORK
9399 stasis_forward_cancel(test_suite_forwarder);
9400 test_suite_forwarder = NULL;
9401#endif
9402
9403 if (stasis_router) {
9406 }
9414
9417
9428
9429 ao2_global_obj_release(mgr_sessions);
9430
9431 while ((user = AST_LIST_REMOVE_HEAD(&users, list))) {
9433 }
9435
9438}
#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:188
static struct stasis_forward * rtp_topic_forwarder
The stasis_subscription for forwarding the RTP topic to the AMI topic.
Definition: manager.c:191
static struct stasis_forward * security_topic_forwarder
The stasis_subscription for forwarding the Security topic to the AMI topic.
Definition: manager.c:194
#define EVENT_FLAG_SHUTDOWN
Fake event class used to end sessions at shutdown.
Definition: manager.c:211
int ast_manager_unregister(const char *action)
support functions to register/unregister AMI action handlers,
Definition: manager.c:7608
#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:1549
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 9444 of file manager.c.

9445{
9446 int res = 0;
9447
9449 if (!rtp_topic_forwarder) {
9450 return -1;
9451 }
9452
9455 return -1;
9456 }
9457
9459 if (!stasis_router) {
9460 return -1;
9461 }
9464
9467
9470
9471 if (res != 0) {
9472 return -1;
9473 }
9474 return 0;
9475}
static void manager_default_msg_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: manager.c:571
static void manager_generic_msg_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
Definition: manager.c:602
struct stasis_topic * ast_rtp_topic(void)
Stasis Message Bus API topic for RTP and RTCP related messages
Definition: rtp_engine.c:3736
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 8812 of file manager.c.

8813{
8814 int retval;
8815 struct ast_sockaddr ser_remote_address_tmp;
8816
8817 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8818 retval = generic_http_callback(ser, method, FORMAT_XML, &ser_remote_address_tmp, uri, get_params, headers);
8819 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8820 return retval;
8821}

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

◆ 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 8233 of file manager.c.

8234{
8235 char *buf;
8236 off_t l;
8237 int fd;
8238
8239 if (!s->stream)
8240 return;
8241
8242 /* Ensure buffer is NULL-terminated */
8243 ast_iostream_write(s->stream, "", 1);
8244
8245 fd = ast_iostream_get_fd(s->stream);
8246
8247 l = lseek(fd, 0, SEEK_CUR);
8248 if (l > 0) {
8249 if (MAP_FAILED == (buf = mmap(NULL, l, PROT_READ | PROT_WRITE, MAP_PRIVATE, fd, 0))) {
8250 ast_log(LOG_WARNING, "mmap failed. Manager output was not processed\n");
8251 } else {
8252 if (format == FORMAT_XML || format == FORMAT_HTML) {
8253 xml_translate(out, buf, params, format);
8254 } else {
8255 ast_str_append(out, 0, "%s", buf);
8256 }
8257 munmap(buf, l);
8258 }
8259 } else if (format == FORMAT_XML || format == FORMAT_HTML) {
8260 xml_translate(out, "", params, format);
8261 }
8262
8264}
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:8105

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 8994 of file manager.c.

8995{
8996 struct ast_tcptls_session_args *ser = data;
8997 /* purge_sessions will return the number of sessions actually purged,
8998 * up to a maximum of it's arguments, purge one at a time, keeping a
8999 * purge interval of 1ms as long as we purged a session, otherwise
9000 * revert to a purge check every 5s
9001 */
9002 if (purge_sessions(1) == 1) {
9003 ser->poll_timeout = 1;
9004 } else {
9005 ser->poll_timeout = 5000;
9006 }
9007 purge_events();
9008}
static void purge_events(void)
Definition: manager.c:717
static int purge_sessions(int n_max)
remove at most n_max stale session from the list.
Definition: manager.c:7366
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 8823 of file manager.c.

8824{
8825 int retval;
8826 struct ast_sockaddr ser_remote_address_tmp;
8827
8828 ast_sockaddr_copy(&ser_remote_address_tmp, &ser->remote_address);
8829 retval = generic_http_callback(ser, method, FORMAT_RAW, &ser_remote_address_tmp, uri, get_params, headers);
8830 ast_sockaddr_copy(&ser->remote_address, &ser_remote_address_tmp);
8831 return retval;
8832}

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

◆ subscribe_all()

static int subscribe_all ( void  )
static

Definition at line 9477 of file manager.c.

9478{
9480 ast_log(AST_LOG_ERROR, "Failed to initialize manager subscriptions\n");
9481 return -1;
9482 }
9483 if (manager_system_init()) {
9484 ast_log(AST_LOG_ERROR, "Failed to initialize manager system handling\n");
9485 return -1;
9486 }
9487 if (manager_channels_init()) {
9488 ast_log(AST_LOG_ERROR, "Failed to initialize manager channel handling\n");
9489 return -1;
9490 }
9491 if (manager_mwi_init()) {
9492 ast_log(AST_LOG_ERROR, "Failed to initialize manager MWI handling\n");
9493 return -1;
9494 }
9495 if (manager_bridging_init()) {
9496 return -1;
9497 }
9498 if (manager_endpoints_init()) {
9499 ast_log(AST_LOG_ERROR, "Failed to initialize manager endpoints handling\n");
9500 return -1;
9501 }
9502
9503 subscribed = 1;
9504 return 0;
9505}
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:9444
int manager_mwi_init(void)
Initialize support for AMI MWI events.
Definition: manager_mwi.c:155
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 10044 of file manager.c.

10045{
10046 return 0;
10047}

◆ variable_count_cmp_fn()

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

Definition at line 8066 of file manager.c.

8067{
8068 /* Due to the simplicity of struct variable_count, it makes no difference
8069 * if you pass in objects or strings, the same operation applies. This is
8070 * due to the fact that the hash occurs on the first element, which means
8071 * the address of both the struct and the string are exactly the same. */
8072 struct variable_count *vc = obj;
8073 char *str = vstr;
8074 return !strcmp(vc->varname, str) ? CMP_MATCH | CMP_STOP : 0;
8075}
const char * str
Definition: app_jack.c:147
@ CMP_MATCH
Definition: astobj2.h:1027
@ CMP_STOP
Definition: astobj2.h:1028
char * varname
Definition: manager.c:8055

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 8059 of file manager.c.

8060{
8061 const struct variable_count *vc = vvc;
8062
8063 return ast_str_hash(vc->varname);
8064}

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 7987 of file manager.c.

7988{
7989 /* store in a local buffer to avoid calling ast_str_append too often */
7990 char buf[256];
7991 char *dst = buf;
7992 const char *save = src;
7993 int space = sizeof(buf);
7994 /* repeat until done and nothing to flush */
7995 for ( ; *src || dst != buf ; src++) {
7996 if (*src == '\0' || space < 10) { /* flush */
7997 *dst++ = '\0';
7998 ast_str_append(out, 0, "%s", buf);
7999 dst = buf;
8000 space = sizeof(buf);
8001 if (*src == '\0') {
8002 break;
8003 }
8004 }
8005
8006 if (mode & 2) {
8007 if (save == src && isdigit(*src)) {
8008 /* The first character of an XML attribute cannot be a digit */
8009 *dst++ = '_';
8010 *dst++ = *src;
8011 space -= 2;
8012 continue;
8013 } else if (!isalnum(*src)) {
8014 /* Replace non-alphanumeric with an underscore */
8015 *dst++ = '_';
8016 space--;
8017 continue;
8018 }
8019 }
8020 switch (*src) {
8021 case '<':
8022 strcpy(dst, "&lt;");
8023 dst += 4;
8024 space -= 4;
8025 break;
8026 case '>':
8027 strcpy(dst, "&gt;");
8028 dst += 4;
8029 space -= 4;
8030 break;
8031 case '\"':
8032 strcpy(dst, "&quot;");
8033 dst += 6;
8034 space -= 6;
8035 break;
8036 case '\'':
8037 strcpy(dst, "&apos;");
8038 dst += 6;
8039 space -= 6;
8040 break;
8041 case '&':
8042 strcpy(dst, "&amp;");
8043 dst += 5;
8044 space -= 5;
8045 break;
8046
8047 default:
8048 *dst++ = mode ? tolower(*src) : *src;
8049 space--;
8050 }
8051 }
8052}

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 8105 of file manager.c.

8106{
8107 struct ast_variable *v;
8108 const char *dest = NULL;
8109 char *var, *val;
8110 const char *objtype = NULL;
8111 int in_data = 0; /* parsing data */
8112 int inobj = 0;
8113 int xml = (format == FORMAT_XML);
8114 struct variable_count *vc = NULL;
8115 struct ao2_container *vco = NULL;
8116
8117 if (xml) {
8118 /* dest and objtype need only for XML format */
8119 for (v = get_vars; v; v = v->next) {
8120 if (!strcasecmp(v->name, "ajaxdest")) {
8121 dest = v->value;
8122 } else if (!strcasecmp(v->name, "ajaxobjtype")) {
8123 objtype = v->value;
8124 }
8125 }
8126 if (ast_strlen_zero(dest)) {
8127 dest = "unknown";
8128 }
8129 if (ast_strlen_zero(objtype)) {
8130 objtype = "generic";
8131 }
8132 }
8133
8134 /* we want to stop when we find an empty line */
8135 while (in && *in) {
8136 val = strsep(&in, "\r\n"); /* mark start and end of line */
8137 if (in && *in == '\n') { /* remove trailing \n if any */
8138 in++;
8139 }
8141 ast_debug(5, "inobj %d in_data %d line <%s>\n", inobj, in_data, val);
8142 if (ast_strlen_zero(val)) {
8143 /* empty line */
8144 if (in_data) {
8145 /* close data in Opaque mode */
8146 ast_str_append(out, 0, xml ? "'" : "</td></tr>\n");
8147 in_data = 0;
8148 }
8149
8150 if (inobj) {
8151 /* close block */
8152 ast_str_append(out, 0, xml ? " /></response>\n" :
8153 "<tr><td colspan=\"2\"><hr></td></tr>\r\n");
8154 inobj = 0;
8155 ao2_ref(vco, -1);
8156 vco = NULL;
8157 }
8158 continue;
8159 }
8160
8161 if (!inobj) {
8162 /* start new block */
8163 if (xml) {
8164 ast_str_append(out, 0, "<response type='object' id='%s'><%s", dest, objtype);
8165 }
8168 inobj = 1;
8169 }
8170
8171 if (in_data) {
8172 /* Process data field in Opaque mode. This is a
8173 * followup, so we re-add line feeds. */
8174 ast_str_append(out, 0, xml ? "\n" : "<br>\n");
8175 xml_copy_escape(out, val, 0); /* data field */
8176 continue;
8177 }
8178
8179 /* We expect "Name: value" line here */
8180 var = strsep(&val, ":");
8181 if (val) {
8182 /* found the field name */
8185 } else {
8186 /* field name not found, switch to opaque mode */
8187 val = var;
8188 var = "Opaque-data";
8189 in_data = 1;
8190 }
8191
8192
8193 ast_str_append(out, 0, xml ? " " : "<tr><td>");
8194 if ((vc = ao2_find(vco, var, 0))) {
8195 vc->count++;
8196 } else {
8197 /* Create a new entry for this one */
8198 vc = ao2_alloc(sizeof(*vc), NULL);
8199 vc->varname = var;
8200 vc->count = 1;
8201 ao2_link(vco, vc);
8202 }
8203
8204 xml_copy_escape(out, var, xml ? 1 | 2 : 0); /* data name */
8205 if (vc->count > 1) {
8206 ast_str_append(out, 0, "-%d", vc->count);
8207 }
8208 ao2_ref(vc, -1);
8209 ast_str_append(out, 0, xml ? "='" : "</td><td>");
8210 xml_copy_escape(out, val, 0); /* data field */
8211 if (!in_data || !*in) {
8212 ast_str_append(out, 0, xml ? "'" : "</td></tr>\n");
8213 }
8214 }
8215
8216 if (inobj) {
8217 ast_str_append(out, 0, xml ? " /></response>\n" :
8218 "<tr><td colspan=\"2\"><hr></td></tr>\r\n");
8219 ao2_ref(vco, -1);
8220 }
8221}
#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
char * strsep(char **str, const char *delims)
static void xml_copy_escape(struct ast_str **out, const char *src, int mode)
Definition: manager.c:7987
static int variable_count_cmp_fn(void *obj, void *vstr, int flags)
Definition: manager.c:8066
static int variable_count_hash_fn(const void *vvc, const int flags)
Definition: manager.c:8059
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 10167 of file manager.c.

◆ amanageruri

struct ast_http_uri amanageruri
static

Definition at line 8902 of file manager.c.

Referenced by __init_manager().

◆ amanagerxmluri

struct ast_http_uri amanagerxmluri
static

Definition at line 8911 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 8893 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 10167 of file manager.c.

◆ cli_manager

struct ast_cli_entry cli_manager[]
static

Definition at line 9264 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 7817 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:8936

description of AMI_CLIENT dialplan function

Definition at line 8983 of file manager.c.

Referenced by __init_manager(), and manager_shutdown().

◆ manageruri

struct ast_http_uri manageruri
static

Definition at line 8842 of file manager.c.

Referenced by __init_manager().

◆ managerxmluri

struct ast_http_uri managerxmluri
static

Definition at line 8850 of file manager.c.

Referenced by __init_manager().

◆ rawmanuri

struct ast_http_uri rawmanuri
static

Definition at line 8834 of file manager.c.

Referenced by __init_manager().

◆ webregged

int webregged = 0
static

Definition at line 8989 of file manager.c.

Referenced by __init_manager().

◆ words

const char* words[AST_MAX_CMD_LEN]

Definition at line 225 of file manager.c.

Referenced by check_blacklist().