2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2006, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
21 * \brief The Asterisk Management Interface - AMI
23 * \author Mark Spencer <markster@digium.com>
25 * OpenSSL http://www.openssl.org - for AMI/SSL
27 * At the moment this file contains a number of functions, namely:
29 * - data structures storing AMI state
30 * - AMI-related API functions, used by internal asterisk components
31 * - handlers for AMI-related CLI functions
32 * - handlers for AMI functions (available through the AMI socket)
33 * - the code for the main AMI listener thread and individual session threads
34 * - the http handlers invoked for AMI-over-HTTP by the threads in main/http.c
39 /*! \addtogroup Group_AMI AMI functions
45 <support_level>core</support_level>
50 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
52 #include "asterisk/_private.h"
53 #include "asterisk/paths.h" /* use various ast_config_AST_* */
58 #include <sys/types.h>
61 #include "asterisk/channel.h"
62 #include "asterisk/file.h"
63 #include "asterisk/manager.h"
64 #include "asterisk/module.h"
65 #include "asterisk/config.h"
66 #include "asterisk/callerid.h"
67 #include "asterisk/lock.h"
68 #include "asterisk/cli.h"
69 #include "asterisk/app.h"
70 #include "asterisk/pbx.h"
71 #include "asterisk/md5.h"
72 #include "asterisk/acl.h"
73 #include "asterisk/utils.h"
74 #include "asterisk/tcptls.h"
75 #include "asterisk/http.h"
76 #include "asterisk/ast_version.h"
77 #include "asterisk/threadstorage.h"
78 #include "asterisk/linkedlists.h"
79 #include "asterisk/term.h"
80 #include "asterisk/astobj2.h"
81 #include "asterisk/features.h"
82 #include "asterisk/security_events.h"
83 #include "asterisk/event.h"
84 #include "asterisk/aoc.h"
85 #include "asterisk/stringfields.h"
86 #include "asterisk/presencestate.h"
89 <manager name="Ping" language="en_US">
94 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
97 <para>A 'Ping' action will ellicit a 'Pong' response. Used to keep the
98 manager connection open.</para>
101 <manager name="Events" language="en_US">
106 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
107 <parameter name="EventMask" required="true">
110 <para>If all events should be sent.</para>
113 <para>If no events should be sent.</para>
115 <enum name="system,call,log,...">
116 <para>To select which flags events should have to be sent.</para>
122 <para>Enable/Disable sending of events to this manager client.</para>
125 <manager name="Logoff" language="en_US">
130 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
133 <para>Logoff the current manager session.</para>
136 <manager name="Login" language="en_US">
141 <parameter name="ActionID">
142 <para>ActionID for this transaction. Will be returned.</para>
144 <parameter name="Username" required="true">
145 <para>Username to login with as specified in manager.conf.</para>
147 <parameter name="Secret">
148 <para>Secret to login with as specified in manager.conf.</para>
152 <para>Login Manager.</para>
155 <manager name="Challenge" language="en_US">
157 Generate Challenge for MD5 Auth.
160 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
161 <parameter name="AuthType" required="true">
162 <para>Digest algorithm to use in the challenge. Valid values are:</para>
169 <para>Generate a challenge for MD5 authentication.</para>
172 <manager name="Hangup" language="en_US">
177 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
178 <parameter name="Channel" required="true">
179 <para>The exact channel name to be hungup, or to use a regular expression, set this parameter to: /regex/</para>
180 <para>Example exact channel: SIP/provider-0000012a</para>
181 <para>Example regular expression: /^SIP/provider-.*$/</para>
183 <parameter name="Cause">
184 <para>Numeric hangup cause.</para>
188 <para>Hangup a channel.</para>
191 <manager name="Status" language="en_US">
196 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
197 <parameter name="Channel" required="true">
198 <para>The name of the channel to query for status.</para>
200 <parameter name="Variables">
201 <para>Comma <literal>,</literal> separated list of variable to include.</para>
205 <para>Will return the status information of each channel along with the
206 value for the specified channel variables.</para>
209 <manager name="Setvar" language="en_US">
211 Set a channel variable.
214 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
215 <parameter name="Channel">
216 <para>Channel to set variable for.</para>
218 <parameter name="Variable" required="true">
219 <para>Variable name.</para>
221 <parameter name="Value" required="true">
222 <para>Variable value.</para>
226 <para>Set a global or local channel variable.</para>
228 <para>If a channel name is not provided then the variable is global.</para>
232 <manager name="Getvar" language="en_US">
234 Gets a channel variable.
237 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
238 <parameter name="Channel">
239 <para>Channel to read variable from.</para>
241 <parameter name="Variable" required="true">
242 <para>Variable name.</para>
246 <para>Get the value of a global or local channel variable.</para>
248 <para>If a channel name is not provided then the variable is global.</para>
252 <manager name="GetConfig" language="en_US">
254 Retrieve configuration.
257 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
258 <parameter name="Filename" required="true">
259 <para>Configuration filename (e.g. <filename>foo.conf</filename>).</para>
261 <parameter name="Category">
262 <para>Category in configuration file.</para>
266 <para>This action will dump the contents of a configuration
267 file by category and contents or optionally by specified category only.</para>
270 <manager name="GetConfigJSON" language="en_US">
272 Retrieve configuration (JSON format).
275 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
276 <parameter name="Filename" required="true">
277 <para>Configuration filename (e.g. <filename>foo.conf</filename>).</para>
281 <para>This action will dump the contents of a configuration file by category
282 and contents in JSON format. This only makes sense to be used using rawman over
283 the HTTP interface.</para>
286 <manager name="UpdateConfig" language="en_US">
288 Update basic configuration.
291 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
292 <parameter name="SrcFilename" required="true">
293 <para>Configuration filename to read (e.g. <filename>foo.conf</filename>).</para>
295 <parameter name="DstFilename" required="true">
296 <para>Configuration filename to write (e.g. <filename>foo.conf</filename>)</para>
298 <parameter name="Reload">
299 <para>Whether or not a reload should take place (or name of specific module).</para>
301 <parameter name="Action-XXXXXX">
302 <para>Action to take.</para>
303 <para>X's represent 6 digit number beginning with 000000.</para>
305 <enum name="NewCat" />
306 <enum name="RenameCat" />
307 <enum name="DelCat" />
308 <enum name="EmptyCat" />
309 <enum name="Update" />
310 <enum name="Delete" />
311 <enum name="Append" />
312 <enum name="Insert" />
315 <parameter name="Cat-XXXXXX">
316 <para>Category to operate on.</para>
317 <xi:include xpointer="xpointer(/docs/manager[@name='UpdateConfig']/syntax/parameter[@name='Action-XXXXXX']/para[2])" />
319 <parameter name="Var-XXXXXX">
320 <para>Variable to work on.</para>
321 <xi:include xpointer="xpointer(/docs/manager[@name='UpdateConfig']/syntax/parameter[@name='Action-XXXXXX']/para[2])" />
323 <parameter name="Value-XXXXXX">
324 <para>Value to work on.</para>
325 <xi:include xpointer="xpointer(/docs/manager[@name='UpdateConfig']/syntax/parameter[@name='Action-XXXXXX']/para[2])" />
327 <parameter name="Match-XXXXXX">
328 <para>Extra match required to match line.</para>
329 <xi:include xpointer="xpointer(/docs/manager[@name='UpdateConfig']/syntax/parameter[@name='Action-XXXXXX']/para[2])" />
331 <parameter name="Line-XXXXXX">
332 <para>Line in category to operate on (used with delete and insert actions).</para>
333 <xi:include xpointer="xpointer(/docs/manager[@name='UpdateConfig']/syntax/parameter[@name='Action-XXXXXX']/para[2])" />
337 <para>This action will modify, create, or delete configuration elements
338 in Asterisk configuration files.</para>
341 <manager name="CreateConfig" language="en_US">
343 Creates an empty file in the configuration directory.
346 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
347 <parameter name="Filename" required="true">
348 <para>The configuration filename to create (e.g. <filename>foo.conf</filename>).</para>
352 <para>This action will create an empty file in the configuration
353 directory. This action is intended to be used before an UpdateConfig
357 <manager name="ListCategories" language="en_US">
359 List categories in configuration file.
362 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
363 <parameter name="Filename" required="true">
364 <para>Configuration filename (e.g. <filename>foo.conf</filename>).</para>
368 <para>This action will dump the categories in a given file.</para>
371 <manager name="Redirect" language="en_US">
373 Redirect (transfer) a call.
376 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
377 <parameter name="Channel" required="true">
378 <para>Channel to redirect.</para>
380 <parameter name="ExtraChannel">
381 <para>Second call leg to transfer (optional).</para>
383 <parameter name="Exten" required="true">
384 <para>Extension to transfer to.</para>
386 <parameter name="ExtraExten">
387 <para>Extension to transfer extrachannel to (optional).</para>
389 <parameter name="Context" required="true">
390 <para>Context to transfer to.</para>
392 <parameter name="ExtraContext">
393 <para>Context to transfer extrachannel to (optional).</para>
395 <parameter name="Priority" required="true">
396 <para>Priority to transfer to.</para>
398 <parameter name="ExtraPriority">
399 <para>Priority to transfer extrachannel to (optional).</para>
403 <para>Redirect (transfer) a call.</para>
406 <manager name="Atxfer" language="en_US">
411 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
412 <parameter name="Channel" required="true">
413 <para>Transferer's channel.</para>
415 <parameter name="Exten" required="true">
416 <para>Extension to transfer to.</para>
418 <parameter name="Context" required="true">
419 <para>Context to transfer to.</para>
421 <parameter name="Priority" required="true">
422 <para>Priority to transfer to.</para>
426 <para>Attended transfer.</para>
429 <manager name="Originate" language="en_US">
434 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
435 <parameter name="Channel" required="true">
436 <para>Channel name to call.</para>
438 <parameter name="Exten">
439 <para>Extension to use (requires <literal>Context</literal> and
440 <literal>Priority</literal>)</para>
442 <parameter name="Context">
443 <para>Context to use (requires <literal>Exten</literal> and
444 <literal>Priority</literal>)</para>
446 <parameter name="Priority">
447 <para>Priority to use (requires <literal>Exten</literal> and
448 <literal>Context</literal>)</para>
450 <parameter name="Application">
451 <para>Application to execute.</para>
453 <parameter name="Data">
454 <para>Data to use (requires <literal>Application</literal>).</para>
456 <parameter name="Timeout" default="30000">
457 <para>How long to wait for call to be answered (in ms.).</para>
459 <parameter name="CallerID">
460 <para>Caller ID to be set on the outgoing channel.</para>
462 <parameter name="Variable">
463 <para>Channel variable to set, multiple Variable: headers are allowed.</para>
465 <parameter name="Account">
466 <para>Account code.</para>
468 <parameter name="EarlyMedia">
469 <para>Set to <literal>true</literal> to force call bridge on early media..</para>
471 <parameter name="Async">
472 <para>Set to <literal>true</literal> for fast origination.</para>
474 <parameter name="Codecs">
475 <para>Comma-separated list of codecs to use for this call.</para>
479 <para>Generates an outgoing call to a
480 <replaceable>Extension</replaceable>/<replaceable>Context</replaceable>/<replaceable>Priority</replaceable>
481 or <replaceable>Application</replaceable>/<replaceable>Data</replaceable></para>
484 <ref type="managerEvent">OriginateResponse</ref>
487 <managerEvent language="en_US" name="OriginateResponse">
488 <managerEventInstance class="EVENT_FLAG_CALL">
489 <synopsis>Raised in response to an Originate command.</synopsis>
491 <parameter name="ActionID" required="false"/>
492 <parameter name="Resonse">
494 <enum name="Failure"/>
495 <enum name="Success"/>
498 <parameter name="Channel"/>
499 <parameter name="Context"/>
500 <parameter name="Exten"/>
501 <parameter name="Reason"/>
502 <parameter name="Uniqueid"/>
503 <parameter name="CallerIDNum"/>
504 <parameter name="CallerIDName"/>
507 <ref type="manager">Originate</ref>
509 </managerEventInstance>
511 <manager name="Command" language="en_US">
513 Execute Asterisk CLI Command.
516 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
517 <parameter name="Command" required="true">
518 <para>Asterisk CLI command to run.</para>
522 <para>Run a CLI command.</para>
525 <manager name="ExtensionState" language="en_US">
527 Check Extension Status.
530 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
531 <parameter name="Exten" required="true">
532 <para>Extension to check state on.</para>
534 <parameter name="Context" required="true">
535 <para>Context for extension.</para>
539 <para>Report the extension state for given extension. If the extension has a hint,
540 will use devicestate to check the status of the device connected to the extension.</para>
541 <para>Will return an <literal>Extension Status</literal> message. The response will include
542 the hint for the extension and the status.</para>
545 <manager name="PresenceState" language="en_US">
550 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
551 <parameter name="Provider" required="true">
552 <para>Presence Provider to check the state of</para>
556 <para>Report the presence state for the given presence provider.</para>
557 <para>Will return a <literal>Presence State</literal> message. The response will include the
558 presence state and, if set, a presence subtype and custom message.</para>
561 <manager name="AbsoluteTimeout" language="en_US">
563 Set absolute timeout.
566 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
567 <parameter name="Channel" required="true">
568 <para>Channel name to hangup.</para>
570 <parameter name="Timeout" required="true">
571 <para>Maximum duration of the call (sec).</para>
575 <para>Hangup a channel after a certain time. Acknowledges set time with
576 <literal>Timeout Set</literal> message.</para>
579 <manager name="MailboxStatus" language="en_US">
584 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
585 <parameter name="Mailbox" required="true">
586 <para>Full mailbox ID <replaceable>mailbox</replaceable>@<replaceable>vm-context</replaceable>.</para>
590 <para>Checks a voicemail account for status.</para>
591 <para>Returns number of messages.</para>
592 <para>Message: Mailbox Status.</para>
593 <para>Mailbox: <replaceable>mailboxid</replaceable>.</para>
594 <para>Waiting: <literal>0</literal> if messages waiting, <literal>1</literal>
595 if no messages waiting.</para>
598 <manager name="MailboxCount" language="en_US">
600 Check Mailbox Message Count.
603 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
604 <parameter name="Mailbox" required="true">
605 <para>Full mailbox ID <replaceable>mailbox</replaceable>@<replaceable>vm-context</replaceable>.</para>
609 <para>Checks a voicemail account for new messages.</para>
610 <para>Returns number of urgent, new and old messages.</para>
611 <para>Message: Mailbox Message Count</para>
612 <para>Mailbox: <replaceable>mailboxid</replaceable></para>
613 <para>UrgentMessages: <replaceable>count</replaceable></para>
614 <para>NewMessages: <replaceable>count</replaceable></para>
615 <para>OldMessages: <replaceable>count</replaceable></para>
618 <manager name="ListCommands" language="en_US">
620 List available manager commands.
623 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
626 <para>Returns the action name and synopsis for every action that
627 is available to the user.</para>
630 <manager name="SendText" language="en_US">
632 Send text message to channel.
635 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
636 <parameter name="Channel" required="true">
637 <para>Channel to send message to.</para>
639 <parameter name="Message" required="true">
640 <para>Message to send.</para>
644 <para>Sends A Text Message to a channel while in a call.</para>
647 <manager name="UserEvent" language="en_US">
649 Send an arbitrary event.
652 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
653 <parameter name="UserEvent" required="true">
654 <para>Event string to send.</para>
656 <parameter name="Header1">
657 <para>Content1.</para>
659 <parameter name="HeaderN">
660 <para>ContentN.</para>
664 <para>Send an event to manager sessions.</para>
667 <manager name="WaitEvent" language="en_US">
669 Wait for an event to occur.
672 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
673 <parameter name="Timeout" required="true">
674 <para>Maximum time (in seconds) to wait for events, <literal>-1</literal> means forever.</para>
678 <para>This action will ellicit a <literal>Success</literal> response. Whenever
679 a manager event is queued. Once WaitEvent has been called on an HTTP manager
680 session, events will be generated and queued.</para>
683 <manager name="CoreSettings" language="en_US">
685 Show PBX core settings (version etc).
688 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
691 <para>Query for Core PBX settings.</para>
694 <manager name="CoreStatus" language="en_US">
696 Show PBX core status variables.
699 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
702 <para>Query for Core PBX status.</para>
705 <manager name="Reload" language="en_US">
710 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
711 <parameter name="Module">
712 <para>Name of the module to reload.</para>
716 <para>Send a reload event.</para>
719 <manager name="CoreShowChannels" language="en_US">
721 List currently active channels.
724 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
727 <para>List currently defined channels and some information about them.</para>
730 <manager name="ModuleLoad" language="en_US">
735 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
736 <parameter name="Module">
737 <para>Asterisk module name (including .so extension) or subsystem identifier:</para>
740 <enum name="dnsmgr" />
741 <enum name="extconfig" />
744 <enum name="manager" />
746 <enum name="logger" />
747 <enum name="features" />
749 <enum name="udptl" />
750 <enum name="indications" />
755 <parameter name="LoadType" required="true">
756 <para>The operation to be done on module. Subsystem identifiers may only
760 <enum name="unload" />
761 <enum name="reload" />
763 <para>If no module is specified for a <literal>reload</literal> loadtype,
764 all modules are reloaded.</para>
768 <para>Loads, unloads or reloads an Asterisk module in a running system.</para>
771 <manager name="ModuleCheck" language="en_US">
773 Check if module is loaded.
776 <parameter name="Module" required="true">
777 <para>Asterisk module name (not including extension).</para>
781 <para>Checks if Asterisk module is loaded. Will return Success/Failure.
782 For success returns, the module revision number is included.</para>
785 <manager name="AOCMessage" language="en_US">
787 Generate an Advice of Charge message on a channel.
790 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
791 <parameter name="Channel" required="true">
792 <para>Channel name to generate the AOC message on.</para>
794 <parameter name="ChannelPrefix">
795 <para>Partial channel prefix. By using this option one can match the beginning part
796 of a channel name without having to put the entire name in. For example
797 if a channel name is SIP/snom-00000001 and this value is set to SIP/snom, then
798 that channel matches and the message will be sent. Note however that only
799 the first matched channel has the message sent on it. </para>
801 <parameter name="MsgType" required="true">
802 <para>Defines what type of AOC message to create, AOC-D or AOC-E</para>
808 <parameter name="ChargeType" required="true">
809 <para>Defines what kind of charge this message represents.</para>
813 <enum name="Currency" />
817 <parameter name="UnitAmount(0)">
818 <para>This represents the amount of units charged. The ETSI AOC standard specifies that
819 this value along with the optional UnitType value are entries in a list. To accommodate this
820 these values take an index value starting at 0 which can be used to generate this list of
821 unit entries. For Example, If two unit entires were required this could be achieved by setting the
822 paramter UnitAmount(0)=1234 and UnitAmount(1)=5678. Note that UnitAmount at index 0 is
823 required when ChargeType=Unit, all other entries in the list are optional.
826 <parameter name="UnitType(0)">
827 <para>Defines the type of unit. ETSI AOC standard specifies this as an integer
828 value between 1 and 16, but this value is left open to accept any positive
829 integer. Like the UnitAmount parameter, this value represents a list entry
830 and has an index parameter that starts at 0.
833 <parameter name="CurrencyName">
834 <para>Specifies the currency's name. Note that this value is truncated after 10 characters.</para>
836 <parameter name="CurrencyAmount">
837 <para>Specifies the charge unit amount as a positive integer. This value is required
838 when ChargeType==Currency.</para>
840 <parameter name="CurrencyMultiplier">
841 <para>Specifies the currency multiplier. This value is required when ChargeType==Currency.</para>
843 <enum name="OneThousandth" />
844 <enum name="OneHundredth" />
845 <enum name="OneTenth" />
848 <enum name="Hundred" />
849 <enum name="Thousand" />
852 <parameter name="TotalType" default="Total">
853 <para>Defines what kind of AOC-D total is represented.</para>
855 <enum name="Total" />
856 <enum name="SubTotal" />
859 <parameter name="AOCBillingId">
860 <para>Represents a billing ID associated with an AOC-D or AOC-E message. Note
861 that only the first 3 items of the enum are valid AOC-D billing IDs</para>
863 <enum name="Normal" />
864 <enum name="ReverseCharge" />
865 <enum name="CreditCard" />
866 <enum name="CallFwdUnconditional" />
867 <enum name="CallFwdBusy" />
868 <enum name="CallFwdNoReply" />
869 <enum name="CallDeflection" />
870 <enum name="CallTransfer" />
873 <parameter name="ChargingAssociationId">
874 <para>Charging association identifier. This is optional for AOC-E and can be
875 set to any value between -32768 and 32767</para>
877 <parameter name="ChargingAssociationNumber">
878 <para>Represents the charging association party number. This value is optional
881 <parameter name="ChargingAssociationPlan">
882 <para>Integer representing the charging plan associated with the ChargingAssociationNumber.
883 The value is bits 7 through 1 of the Q.931 octet containing the type-of-number and
884 numbering-plan-identification fields.</para>
888 <para>Generates an AOC-D or AOC-E message on a channel.</para>
891 <function name="AMI_CLIENT" language="en_US">
893 Checks attributes of manager accounts
896 <parameter name="loginname" required="true">
897 <para>Login name, specified in manager.conf</para>
899 <parameter name="field" required="true">
900 <para>The manager account attribute to return</para>
902 <enum name="sessions"><para>The number of sessions for this AMI account</para></enum>
908 Currently, the only supported parameter is "sessions" which will return the current number of
909 active sessions for this AMI account.
913 <manager name="Filter" language="en_US">
915 Dynamically add filters for the current manager session.
918 <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
919 <parameter name="Operation">
922 <para>Add a filter.</para>
926 <parameter name="Filter">
927 <para>Filters can be whitelist or blacklist</para>
928 <para>Example whitelist filter: "Event: Newchannel"</para>
929 <para>Example blacklist filter: "!Channel: DAHDI.*"</para>
930 <para>This filter option is used to whitelist or blacklist events per user to be
931 reported with regular expressions and are allowed if both the regex matches
932 and the user has read access as defined in manager.conf. Filters are assumed to be for whitelisting
933 unless preceeded by an exclamation point, which marks it as being black.
934 Evaluation of the filters is as follows:</para>
935 <para>- If no filters are configured all events are reported as normal.</para>
936 <para>- If there are white filters only: implied black all filter processed first, then white filters.</para>
937 <para>- If there are black filters only: implied white all filter processed first, then black filters.</para>
938 <para>- If there are both white and black filters: implied black all filter processed first, then white
939 filters, and lastly black filters.</para>
943 <para>The filters added are only used for the current session.
944 Once the connection is closed the filters are removed.</para>
945 <para>This comand requires the system permission because
946 this command can be used to create filters that may bypass
947 filters defined in manager.conf</para>
950 <manager name="FilterList" language="en_US">
952 Show current event filters for this session
955 <para>The filters displayed are for the current session. Only those filters defined in
956 manager.conf will be present upon starting a new session.</para>
964 UNSPECIFIED_CATEGORY,
965 UNSPECIFIED_ARGUMENT,
975 enum add_filter_result {
982 * Linked list of events.
983 * Global events are appended to the list by append_event().
984 * The usecount is the number of stored pointers to the element,
985 * excluding the list pointers. So an element that is only in
986 * the list has a usecount of 0, not 1.
988 * Clients have a pointer to the last event processed, and for each
989 * of these clients we track the usecount of the elements.
990 * If we have a pointer to an entry in the list, it is safe to navigate
991 * it forward because elements will not be deleted, but only appended.
992 * The worst that can happen is seeing the pointer still NULL.
994 * When the usecount of an element drops to 0, and the element is the
995 * first in the list, we can remove it. Removal is done within the
996 * main thread, which is woken up for the purpose.
998 * For simplicity of implementation, we make sure the list is never empty.
1001 int usecount; /*!< # of clients who still need the event */
1003 unsigned int seq; /*!< sequence number */
1004 struct timeval tv; /*!< When event was allocated */
1005 AST_RWLIST_ENTRY(eventqent) eq_next;
1006 char eventdata[1]; /*!< really variable size, allocated by append_event() */
1009 static AST_RWLIST_HEAD_STATIC(all_events, eventqent);
1011 static int displayconnects = 1;
1012 static int allowmultiplelogin = 1;
1013 static int timestampevents;
1014 static int httptimeout = 60;
1015 static int broken_events_action = 0;
1016 static int manager_enabled = 0;
1017 static int webmanager_enabled = 0;
1018 static int manager_debug = 0; /*!< enable some debugging code in the manager */
1019 static int authtimeout;
1020 static int authlimit;
1021 static char *manager_channelvars;
1023 #define DEFAULT_REALM "asterisk"
1024 static char global_realm[MAXHOSTNAMELEN]; /*!< Default realm */
1026 static int block_sockets;
1027 static int unauth_sessions = 0;
1028 static struct ast_event_sub *acl_change_event_subscription;
1031 * Descriptor for a manager session, either on the AMI socket or over HTTP.
1034 * AMI session have managerid == 0; the entry is created upon a connect,
1035 * and destroyed with the socket.
1036 * HTTP sessions have managerid != 0, the value is used as a search key
1037 * to lookup sessions (using the mansession_id cookie, or nonce key from
1038 * Digest Authentication http header).
1040 #define MAX_BLACKLIST_CMD_LEN 2
1041 static const struct {
1042 const char *words[AST_MAX_CMD_LEN];
1043 } command_blacklist[] = {
1044 {{ "module", "load", NULL }},
1045 {{ "module", "unload", NULL }},
1046 {{ "restart", "gracefully", NULL }},
1049 static void acl_change_event_cb(const struct ast_event *event, void *userdata);
1051 static void acl_change_event_subscribe(void)
1053 if (!acl_change_event_subscription) {
1054 acl_change_event_subscription = ast_event_subscribe(AST_EVENT_ACL_CHANGE,
1055 acl_change_event_cb, "Manager must react to Named ACL changes", NULL, AST_EVENT_IE_END);
1059 static void acl_change_event_unsubscribe(void)
1061 if (acl_change_event_subscription) {
1062 acl_change_event_subscription = ast_event_unsubscribe(acl_change_event_subscription);
1066 /* In order to understand what the heck is going on with the
1067 * mansession_session and mansession structs, we need to have a bit of a history
1070 * In the beginning, there was the mansession. The mansession contained data that was
1071 * intrinsic to a manager session, such as the time that it started, the name of the logged-in
1072 * user, etc. In addition to these parameters were the f and fd parameters. For typical manager
1073 * sessions, these were used to represent the TCP socket over which the AMI session was taking
1074 * place. It makes perfect sense for these fields to be a part of the session-specific data since
1075 * the session actually defines this information.
1077 * Then came the HTTP AMI sessions. With these, the f and fd fields need to be opened and closed
1078 * for every single action that occurs. Thus the f and fd fields aren't really specific to the session
1079 * but rather to the action that is being executed. Because a single session may execute many commands
1080 * at once, some sort of safety needed to be added in order to be sure that we did not end up with fd
1081 * leaks from one action overwriting the f and fd fields used by a previous action before the previous action
1082 * has had a chance to properly close its handles.
1084 * The initial idea to solve this was to use thread synchronization, but this prevented multiple actions
1085 * from being run at the same time in a single session. Some manager actions may block for a long time, thus
1086 * creating a large queue of actions to execute. In addition, this fix did not address the basic architectural
1087 * issue that for HTTP manager sessions, the f and fd variables are not really a part of the session, but are
1088 * part of the action instead.
1090 * The new idea was to create a structure on the stack for each HTTP Manager action. This structure would
1091 * contain the action-specific information, such as which file to write to. In order to maintain expectations
1092 * of action handlers and not have to change the public API of the manager code, we would need to name this
1093 * new stacked structure 'mansession' and contain within it the old mansession struct that we used to use.
1094 * We renamed the old mansession struct 'mansession_session' to hopefully convey that what is in this structure
1095 * is session-specific data. The structure that it is wrapped in, called a 'mansession' really contains action-specific
1098 struct mansession_session {
1099 /*! \todo XXX need to document which fields it is protecting */
1100 struct ast_sockaddr addr; /*!< address we are connecting from */
1101 FILE *f; /*!< fdopen() on the underlying fd */
1102 int fd; /*!< descriptor used for output. Either the socket (AMI) or a temporary file (HTTP) */
1103 int inuse; /*!< number of HTTP sessions using this entry */
1104 int needdestroy; /*!< Whether an HTTP session should be destroyed */
1105 pthread_t waiting_thread; /*!< Sleeping thread using this descriptor */
1106 uint32_t managerid; /*!< Unique manager identifier, 0 for AMI sessions */
1107 time_t sessionstart; /*!< Session start time */
1108 struct timeval sessionstart_tv; /*!< Session start time */
1109 time_t sessiontimeout; /*!< Session timeout if HTTP */
1110 char username[80]; /*!< Logged in username */
1111 char challenge[10]; /*!< Authentication challenge */
1112 int authenticated; /*!< Authentication status */
1113 int readperm; /*!< Authorization for reading */
1114 int writeperm; /*!< Authorization for writing */
1115 char inbuf[1025]; /*!< Buffer - we use the extra byte to add a '\\0' and simplify parsing */
1116 int inlen; /*!< number of buffered bytes */
1117 struct ao2_container *whitefilters; /*!< Manager event filters - white list */
1118 struct ao2_container *blackfilters; /*!< Manager event filters - black list */
1119 struct ast_variable *chanvars; /*!< Channel variables to set for originate */
1120 int send_events; /*!< XXX what ? */
1121 struct eventqent *last_ev; /*!< last event processed. */
1122 int writetimeout; /*!< Timeout for ast_carefulwrite() */
1124 int pending_event; /*!< Pending events indicator in case when waiting_thread is NULL */
1125 time_t noncetime; /*!< Timer for nonce value expiration */
1126 unsigned long oldnonce; /*!< Stale nonce value */
1127 unsigned long nc; /*!< incremental nonce counter */
1128 AST_LIST_HEAD_NOLOCK(mansession_datastores, ast_datastore) datastores; /*!< Data stores on the session */
1129 AST_LIST_ENTRY(mansession_session) list;
1132 enum mansession_message_parsing {
1134 MESSAGE_LINE_TOO_LONG
1137 /*! \brief In case you didn't read that giant block of text above the mansession_session struct, the
1138 * \ref struct mansession is named this solely to keep the API the same in Asterisk. This structure really
1139 * represents data that is different from Manager action to Manager action. The mansession_session pointer
1140 * contained within points to session-specific data.
1143 struct mansession_session *session;
1144 struct ast_tcptls_session_instance *tcptls_session;
1147 enum mansession_message_parsing parsing;
1149 struct manager_custom_hook *hook;
1153 static struct ao2_container *sessions = NULL;
1155 struct manager_channel_variable {
1156 AST_LIST_ENTRY(manager_channel_variable) entry;
1157 unsigned int isfunc:1;
1158 char name[0]; /* allocate off the end the real size. */
1161 static AST_RWLIST_HEAD_STATIC(channelvars, manager_channel_variable);
1163 /*! \brief user descriptor, as read from the config file.
1165 * \note It is still missing some fields -- e.g. we can have multiple permit and deny
1166 * lines which are not supported here, and readperm/writeperm/writetimeout
1169 struct ast_manager_user {
1171 char *secret; /*!< Secret for logging in */
1172 int readperm; /*!< Authorization for reading */
1173 int writeperm; /*!< Authorization for writing */
1174 int writetimeout; /*!< Per user Timeout for ast_carefulwrite() */
1175 int displayconnects; /*!< XXX unused */
1176 int keep; /*!< mark entries created on a reload */
1177 struct ao2_container *whitefilters; /*!< Manager event filters - white list */
1178 struct ao2_container *blackfilters; /*!< Manager event filters - black list */
1179 struct ast_acl_list *acl; /*!< ACL setting */
1180 char *a1_hash; /*!< precalculated A1 for Digest auth */
1181 struct ast_variable *chanvars; /*!< Channel variables to set for originate */
1182 AST_RWLIST_ENTRY(ast_manager_user) list;
1185 /*! \brief list of users found in the config file */
1186 static AST_RWLIST_HEAD_STATIC(users, ast_manager_user);
1188 /*! \brief list of actions registered */
1189 static AST_RWLIST_HEAD_STATIC(actions, manager_action);
1191 /*! \brief list of hooks registered */
1192 static AST_RWLIST_HEAD_STATIC(manager_hooks, manager_custom_hook);
1194 /*! \brief A container of event documentation nodes */
1195 AO2_GLOBAL_OBJ_STATIC(event_docs);
1197 static void free_channelvars(void);
1199 static enum add_filter_result manager_add_filter(const char *filter_pattern, struct ao2_container *whitefilters, struct ao2_container *blackfilters);
1203 * \brief Find a registered action object.
1205 * \param name Name of AMI action to find.
1207 * \return Reffed action found or NULL
1209 static struct manager_action *action_find(const char *name)
1211 struct manager_action *act;
1213 AST_RWLIST_RDLOCK(&actions);
1214 AST_RWLIST_TRAVERSE(&actions, act, list) {
1215 if (!strcasecmp(name, act->action)) {
1216 ao2_t_ref(act, +1, "found action object");
1220 AST_RWLIST_UNLOCK(&actions);
1225 /*! \brief Add a custom hook to be called when an event is fired */
1226 void ast_manager_register_hook(struct manager_custom_hook *hook)
1228 AST_RWLIST_WRLOCK(&manager_hooks);
1229 AST_RWLIST_INSERT_TAIL(&manager_hooks, hook, list);
1230 AST_RWLIST_UNLOCK(&manager_hooks);
1233 /*! \brief Delete a custom hook to be called when an event is fired */
1234 void ast_manager_unregister_hook(struct manager_custom_hook *hook)
1236 AST_RWLIST_WRLOCK(&manager_hooks);
1237 AST_RWLIST_REMOVE(&manager_hooks, hook, list);
1238 AST_RWLIST_UNLOCK(&manager_hooks);
1241 int check_manager_enabled(void)
1243 return manager_enabled;
1246 int check_webmanager_enabled(void)
1248 return (webmanager_enabled && manager_enabled);
1252 * Grab a reference to the last event, update usecount as needed.
1253 * Can handle a NULL pointer.
1255 static struct eventqent *grab_last(void)
1257 struct eventqent *ret;
1259 AST_RWLIST_WRLOCK(&all_events);
1260 ret = AST_RWLIST_LAST(&all_events);
1261 /* the list is never empty now, but may become so when
1262 * we optimize it in the future, so be prepared.
1265 ast_atomic_fetchadd_int(&ret->usecount, 1);
1267 AST_RWLIST_UNLOCK(&all_events);
1272 * Purge unused events. Remove elements from the head
1273 * as long as their usecount is 0 and there is a next element.
1275 static void purge_events(void)
1277 struct eventqent *ev;
1278 struct timeval now = ast_tvnow();
1280 AST_RWLIST_WRLOCK(&all_events);
1281 while ( (ev = AST_RWLIST_FIRST(&all_events)) &&
1282 ev->usecount == 0 && AST_RWLIST_NEXT(ev, eq_next)) {
1283 AST_RWLIST_REMOVE_HEAD(&all_events, eq_next);
1287 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&all_events, ev, eq_next) {
1288 /* Never release the last event */
1289 if (!AST_RWLIST_NEXT(ev, eq_next)) {
1293 /* 2.5 times whatever the HTTP timeout is (maximum 2.5 hours) is the maximum time that we will definitely cache an event */
1294 if (ev->usecount == 0 && ast_tvdiff_sec(now, ev->tv) > (httptimeout > 3600 ? 3600 : httptimeout) * 2.5) {
1295 AST_RWLIST_REMOVE_CURRENT(eq_next);
1299 AST_RWLIST_TRAVERSE_SAFE_END;
1300 AST_RWLIST_UNLOCK(&all_events);
1304 * helper functions to convert back and forth between
1305 * string and numeric representation of set of flags
1307 static const struct permalias {
1311 { EVENT_FLAG_SYSTEM, "system" },
1312 { EVENT_FLAG_CALL, "call" },
1313 { EVENT_FLAG_LOG, "log" },
1314 { EVENT_FLAG_VERBOSE, "verbose" },
1315 { EVENT_FLAG_COMMAND, "command" },
1316 { EVENT_FLAG_AGENT, "agent" },
1317 { EVENT_FLAG_USER, "user" },
1318 { EVENT_FLAG_CONFIG, "config" },
1319 { EVENT_FLAG_DTMF, "dtmf" },
1320 { EVENT_FLAG_REPORTING, "reporting" },
1321 { EVENT_FLAG_CDR, "cdr" },
1322 { EVENT_FLAG_DIALPLAN, "dialplan" },
1323 { EVENT_FLAG_ORIGINATE, "originate" },
1324 { EVENT_FLAG_AGI, "agi" },
1325 { EVENT_FLAG_CC, "cc" },
1326 { EVENT_FLAG_AOC, "aoc" },
1327 { EVENT_FLAG_TEST, "test" },
1328 { EVENT_FLAG_MESSAGE, "message" },
1333 /*! \brief Checks to see if a string which can be used to evaluate functions should be rejected */
1334 static int function_capable_string_allowed_with_auths(const char *evaluating, int writepermlist)
1336 if (!(writepermlist & EVENT_FLAG_SYSTEM)
1338 strstr(evaluating, "SHELL") || /* NoOp(${SHELL(rm -rf /)}) */
1339 strstr(evaluating, "EVAL") /* NoOp(${EVAL(${some_var_containing_SHELL})}) */
1346 /*! \brief Convert authority code to a list of options */
1347 static const char *authority_to_str(int authority, struct ast_str **res)
1352 ast_str_reset(*res);
1353 for (i = 0; i < ARRAY_LEN(perms) - 1; i++) {
1354 if (authority & perms[i].num) {
1355 ast_str_append(res, 0, "%s%s", sep, perms[i].label);
1360 if (ast_str_strlen(*res) == 0) /* replace empty string with something sensible */
1361 ast_str_append(res, 0, "<none>");
1363 return ast_str_buffer(*res);
1366 /*! Tells you if smallstr exists inside bigstr
1367 which is delim by delim and uses no buf or stringsep
1368 ast_instring("this|that|more","this",'|') == 1;
1370 feel free to move this to app.c -anthm */
1371 static int ast_instring(const char *bigstr, const char *smallstr, const char delim)
1373 const char *val = bigstr, *next;
1376 if ((next = strchr(val, delim))) {
1377 if (!strncmp(val, smallstr, (next - val))) {
1383 return !strcmp(smallstr, val);
1385 } while (*(val = (next + 1)));
1390 static int get_perm(const char *instr)
1398 for (x = 0; x < ARRAY_LEN(perms); x++) {
1399 if (ast_instring(instr, perms[x].label, ',')) {
1400 ret |= perms[x].num;
1408 * A number returns itself, false returns 0, true returns all flags,
1409 * other strings return the flags that are set.
1411 static int strings_to_mask(const char *string)
1415 if (ast_strlen_zero(string)) {
1419 for (p = string; *p; p++) {
1420 if (*p < '0' || *p > '9') {
1424 if (!*p) { /* all digits */
1425 return atoi(string);
1427 if (ast_false(string)) {
1430 if (ast_true(string)) { /* all permissions */
1432 for (x = 0; x < ARRAY_LEN(perms); x++) {
1433 ret |= perms[x].num;
1437 return get_perm(string);
1440 /*! \brief Unreference manager session object.
1441 If no more references, then go ahead and delete it */
1442 static struct mansession_session *unref_mansession(struct mansession_session *s)
1444 int refcount = ao2_ref(s, -1);
1445 if (manager_debug) {
1446 ast_debug(1, "Mansession: %p refcount now %d\n", s, refcount - 1);
1451 static void event_filter_destructor(void *obj)
1453 regex_t *regex_filter = obj;
1454 regfree(regex_filter);
1457 static void session_destructor(void *obj)
1459 struct mansession_session *session = obj;
1460 struct eventqent *eqe = session->last_ev;
1461 struct ast_datastore *datastore;
1463 /* Get rid of each of the data stores on the session */
1464 while ((datastore = AST_LIST_REMOVE_HEAD(&session->datastores, entry))) {
1465 /* Free the data store */
1466 ast_datastore_free(datastore);
1469 if (session->f != NULL) {
1473 ast_atomic_fetchadd_int(&eqe->usecount, -1);
1475 if (session->chanvars) {
1476 ast_variables_destroy(session->chanvars);
1479 if (session->whitefilters) {
1480 ao2_t_callback(session->whitefilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all white filters");
1481 ao2_t_ref(session->whitefilters, -1 , "decrement ref for white container, should be last one");
1484 if (session->blackfilters) {
1485 ao2_t_callback(session->blackfilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all black filters");
1486 ao2_t_ref(session->blackfilters, -1 , "decrement ref for black container, should be last one");
1490 /*! \brief Allocate manager session structure and add it to the list of sessions */
1491 static struct mansession_session *build_mansession(const struct ast_sockaddr *addr)
1493 struct mansession_session *newsession;
1495 if (!(newsession = ao2_alloc(sizeof(*newsession), session_destructor))) {
1499 if (!(newsession->whitefilters = ao2_container_alloc(1, NULL, NULL))) {
1500 ao2_ref(newsession, -1);
1504 if (!(newsession->blackfilters = ao2_container_alloc(1, NULL, NULL))) {
1505 ao2_ref(newsession, -1); /* session_destructor will cleanup the other filter */
1509 newsession->fd = -1;
1510 newsession->waiting_thread = AST_PTHREADT_NULL;
1511 newsession->writetimeout = 100;
1512 newsession->send_events = -1;
1513 ast_sockaddr_copy(&newsession->addr, addr);
1515 ao2_link(sessions, newsession);
1520 static int mansession_cmp_fn(void *obj, void *arg, int flags)
1522 struct mansession_session *s = obj;
1524 return !strcasecmp(s->username, str) ? CMP_MATCH : 0;
1527 static void session_destroy(struct mansession_session *s)
1529 unref_mansession(s);
1530 ao2_unlink(sessions, s);
1534 static int check_manager_session_inuse(const char *name)
1536 struct mansession_session *session = ao2_find(sessions, (char *) name, 0);
1541 unref_mansession(session);
1548 * lookup an entry in the list of registered users.
1549 * must be called with the list lock held.
1551 static struct ast_manager_user *get_manager_by_name_locked(const char *name)
1553 struct ast_manager_user *user = NULL;
1555 AST_RWLIST_TRAVERSE(&users, user, list) {
1556 if (!strcasecmp(user->username, name)) {
1564 /*! \brief Get displayconnects config option.
1565 * \param session manager session to get parameter from.
1566 * \return displayconnects config option value.
1568 static int manager_displayconnects (struct mansession_session *session)
1570 struct ast_manager_user *user = NULL;
1573 AST_RWLIST_RDLOCK(&users);
1574 if ((user = get_manager_by_name_locked (session->username))) {
1575 ret = user->displayconnects;
1577 AST_RWLIST_UNLOCK(&users);
1582 static char *handle_showmancmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1584 struct manager_action *cur;
1585 struct ast_str *authority;
1589 char syntax_title[64], description_title[64], synopsis_title[64], seealso_title[64], arguments_title[64];
1594 e->command = "manager show command";
1596 "Usage: manager show command <actionname> [<actionname> [<actionname> [...]]]\n"
1597 " Shows the detailed description for a specific Asterisk manager interface command.\n";
1600 l = strlen(a->word);
1602 AST_RWLIST_RDLOCK(&actions);
1603 AST_RWLIST_TRAVERSE(&actions, cur, list) {
1604 if (!strncasecmp(a->word, cur->action, l) && ++which > a->n) {
1605 ret = ast_strdup(cur->action);
1606 break; /* make sure we exit even if ast_strdup() returns NULL */
1609 AST_RWLIST_UNLOCK(&actions);
1612 authority = ast_str_alloca(80);
1614 return CLI_SHOWUSAGE;
1618 /* setup the titles */
1619 term_color(synopsis_title, "[Synopsis]\n", COLOR_MAGENTA, 0, 40);
1620 term_color(description_title, "[Description]\n", COLOR_MAGENTA, 0, 40);
1621 term_color(syntax_title, "[Syntax]\n", COLOR_MAGENTA, 0, 40);
1622 term_color(seealso_title, "[See Also]\n", COLOR_MAGENTA, 0, 40);
1623 term_color(arguments_title, "[Arguments]\n", COLOR_MAGENTA, 0, 40);
1626 AST_RWLIST_RDLOCK(&actions);
1627 AST_RWLIST_TRAVERSE(&actions, cur, list) {
1628 for (num = 3; num < a->argc; num++) {
1629 if (!strcasecmp(cur->action, a->argv[num])) {
1631 if (cur->docsrc == AST_XML_DOC) {
1632 ast_cli(a->fd, "%s%s\n\n%s%s\n\n%s%s\n\n%s%s\n\n%s%s\n\n",
1634 ast_xmldoc_printable(S_OR(cur->syntax, "Not available"), 1),
1636 ast_xmldoc_printable(S_OR(cur->synopsis, "Not available"), 1),
1638 ast_xmldoc_printable(S_OR(cur->description, "Not available"), 1),
1640 ast_xmldoc_printable(S_OR(cur->arguments, "Not available"), 1),
1642 ast_xmldoc_printable(S_OR(cur->seealso, "Not available"), 1));
1646 ast_cli(a->fd, "Action: %s\nSynopsis: %s\nPrivilege: %s\n%s\n",
1647 cur->action, cur->synopsis,
1648 authority_to_str(cur->authority, &authority),
1649 S_OR(cur->description, ""));
1654 AST_RWLIST_UNLOCK(&actions);
1659 static char *handle_mandebug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1663 e->command = "manager set debug [on|off]";
1664 e->usage = "Usage: manager set debug [on|off]\n Show, enable, disable debugging of the manager code.\n";
1671 ast_cli(a->fd, "manager debug is %s\n", manager_debug? "on" : "off");
1672 } else if (a->argc == 4) {
1673 if (!strcasecmp(a->argv[3], "on")) {
1675 } else if (!strcasecmp(a->argv[3], "off")) {
1678 return CLI_SHOWUSAGE;
1684 static char *handle_showmanager(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1686 struct ast_manager_user *user = NULL;
1689 struct ast_str *rauthority = ast_str_alloca(128);
1690 struct ast_str *wauthority = ast_str_alloca(128);
1691 struct ast_variable *v;
1695 e->command = "manager show user";
1697 " Usage: manager show user <user>\n"
1698 " Display all information related to the manager user specified.\n";
1701 l = strlen(a->word);
1706 AST_RWLIST_RDLOCK(&users);
1707 AST_RWLIST_TRAVERSE(&users, user, list) {
1708 if ( !strncasecmp(a->word, user->username, l) && ++which > a->n ) {
1709 ret = ast_strdup(user->username);
1713 AST_RWLIST_UNLOCK(&users);
1718 return CLI_SHOWUSAGE;
1721 AST_RWLIST_RDLOCK(&users);
1723 if (!(user = get_manager_by_name_locked(a->argv[3]))) {
1724 ast_cli(a->fd, "There is no manager called %s\n", a->argv[3]);
1725 AST_RWLIST_UNLOCK(&users);
1729 ast_cli(a->fd, "\n");
1736 "displayconnects: %s\n",
1737 (user->username ? user->username : "(N/A)"),
1738 (user->secret ? "<Set>" : "(N/A)"),
1739 ((user->acl && !ast_acl_list_is_empty(user->acl)) ? "yes" : "no"),
1740 authority_to_str(user->readperm, &rauthority),
1741 authority_to_str(user->writeperm, &wauthority),
1742 (user->displayconnects ? "yes" : "no"));
1743 ast_cli(a->fd, " Variables: \n");
1744 for (v = user->chanvars ; v ; v = v->next) {
1745 ast_cli(a->fd, " %s = %s\n", v->name, v->value);
1748 AST_RWLIST_UNLOCK(&users);
1753 static char *handle_showmanagers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1755 struct ast_manager_user *user = NULL;
1759 e->command = "manager show users";
1761 "Usage: manager show users\n"
1762 " Prints a listing of all managers that are currently configured on that\n"
1769 return CLI_SHOWUSAGE;
1772 AST_RWLIST_RDLOCK(&users);
1774 /* If there are no users, print out something along those lines */
1775 if (AST_RWLIST_EMPTY(&users)) {
1776 ast_cli(a->fd, "There are no manager users.\n");
1777 AST_RWLIST_UNLOCK(&users);
1781 ast_cli(a->fd, "\nusername\n--------\n");
1783 AST_RWLIST_TRAVERSE(&users, user, list) {
1784 ast_cli(a->fd, "%s\n", user->username);
1788 AST_RWLIST_UNLOCK(&users);
1790 ast_cli(a->fd,"-------------------\n"
1791 "%d manager users configured.\n", count_amu);
1795 /*! \brief CLI command manager list commands */
1796 static char *handle_showmancmds(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1798 struct manager_action *cur;
1799 struct ast_str *authority;
1800 #define HSMC_FORMAT " %-15.15s %-15.15s %-55.55s\n"
1803 e->command = "manager show commands";
1805 "Usage: manager show commands\n"
1806 " Prints a listing of all the available Asterisk manager interface commands.\n";
1811 authority = ast_str_alloca(80);
1812 ast_cli(a->fd, HSMC_FORMAT, "Action", "Privilege", "Synopsis");
1813 ast_cli(a->fd, HSMC_FORMAT, "------", "---------", "--------");
1815 AST_RWLIST_RDLOCK(&actions);
1816 AST_RWLIST_TRAVERSE(&actions, cur, list) {
1817 ast_cli(a->fd, HSMC_FORMAT, cur->action, authority_to_str(cur->authority, &authority), cur->synopsis);
1819 AST_RWLIST_UNLOCK(&actions);
1824 /*! \brief CLI command manager list connected */
1825 static char *handle_showmanconn(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1827 struct mansession_session *session;
1828 time_t now = time(NULL);
1829 #define HSMCONN_FORMAT1 " %-15.15s %-55.55s %-10.10s %-10.10s %-8.8s %-8.8s %-5.5s %-5.5s\n"
1830 #define HSMCONN_FORMAT2 " %-15.15s %-55.55s %-10d %-10d %-8d %-8d %-5.5d %-5.5d\n"
1832 struct ao2_iterator i;
1836 e->command = "manager show connected";
1838 "Usage: manager show connected\n"
1839 " Prints a listing of the users that are currently connected to the\n"
1840 "Asterisk manager interface.\n";
1846 ast_cli(a->fd, HSMCONN_FORMAT1, "Username", "IP Address", "Start", "Elapsed", "FileDes", "HttpCnt", "Read", "Write");
1848 i = ao2_iterator_init(sessions, 0);
1849 while ((session = ao2_iterator_next(&i))) {
1851 ast_cli(a->fd, HSMCONN_FORMAT2, session->username, ast_sockaddr_stringify_addr(&session->addr), (int)(session->sessionstart), (int)(now - session->sessionstart), session->fd, session->inuse, session->readperm, session->writeperm);
1853 ao2_unlock(session);
1854 unref_mansession(session);
1856 ao2_iterator_destroy(&i);
1857 ast_cli(a->fd, "%d users connected.\n", count);
1862 /*! \brief CLI command manager list eventq */
1863 /* Should change to "manager show connected" */
1864 static char *handle_showmaneventq(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1866 struct eventqent *s;
1869 e->command = "manager show eventq";
1871 "Usage: manager show eventq\n"
1872 " Prints a listing of all events pending in the Asterisk manger\n"
1878 AST_RWLIST_RDLOCK(&all_events);
1879 AST_RWLIST_TRAVERSE(&all_events, s, eq_next) {
1880 ast_cli(a->fd, "Usecount: %d\n", s->usecount);
1881 ast_cli(a->fd, "Category: %d\n", s->category);
1882 ast_cli(a->fd, "Event:\n%s", s->eventdata);
1884 AST_RWLIST_UNLOCK(&all_events);
1889 /*! \brief CLI command manager reload */
1890 static char *handle_manager_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1894 e->command = "manager reload";
1896 "Usage: manager reload\n"
1897 " Reloads the manager configuration.\n";
1903 return CLI_SHOWUSAGE;
1909 static struct eventqent *advance_event(struct eventqent *e)
1911 struct eventqent *next;
1913 AST_RWLIST_RDLOCK(&all_events);
1914 if ((next = AST_RWLIST_NEXT(e, eq_next))) {
1915 ast_atomic_fetchadd_int(&next->usecount, 1);
1916 ast_atomic_fetchadd_int(&e->usecount, -1);
1918 AST_RWLIST_UNLOCK(&all_events);
1922 #define GET_HEADER_FIRST_MATCH 0
1923 #define GET_HEADER_LAST_MATCH 1
1924 #define GET_HEADER_SKIP_EMPTY 2
1927 * \brief Return a matching header value.
1930 * Generic function to return either the first or the last
1931 * matching header from a list of variables, possibly skipping
1934 * \note At the moment there is only one use of this function in
1935 * this file, so we make it static.
1937 * \note Never returns NULL.
1939 static const char *__astman_get_header(const struct message *m, char *var, int mode)
1941 int x, l = strlen(var);
1942 const char *result = "";
1948 for (x = 0; x < m->hdrcount; x++) {
1949 const char *h = m->headers[x];
1950 if (!strncasecmp(var, h, l) && h[l] == ':') {
1951 const char *value = h + l + 1;
1952 value = ast_skip_blanks(value); /* ignore leading spaces in the value */
1953 /* found a potential candidate */
1954 if ((mode & GET_HEADER_SKIP_EMPTY) && ast_strlen_zero(value)) {
1955 continue; /* not interesting */
1957 if (mode & GET_HEADER_LAST_MATCH) {
1958 result = value; /* record the last match so far */
1969 * \brief Return the first matching variable from an array.
1971 * \note This is the legacy function and is implemented in
1972 * therms of __astman_get_header().
1974 * \note Never returns NULL.
1976 const char *astman_get_header(const struct message *m, char *var)
1978 return __astman_get_header(m, var, GET_HEADER_FIRST_MATCH);
1983 * \brief Process one "Variable:" header value string.
1985 * \param head Current list of AMI variables to get new values added.
1986 * \param hdr_val Header value string to process.
1988 * \return New variable list head.
1990 static struct ast_variable *man_do_variable_value(struct ast_variable *head, const char *hdr_val)
1993 AST_DECLARE_APP_ARGS(args,
1994 AST_APP_ARG(vars)[64];
1997 hdr_val = ast_skip_blanks(hdr_val); /* ignore leading spaces in the value */
1998 parse = ast_strdupa(hdr_val);
2000 /* Break the header value string into name=val pair items. */
2001 AST_STANDARD_APP_ARGS(args, parse);
2005 /* Process each name=val pair item. */
2006 for (y = 0; y < args.argc; y++) {
2007 struct ast_variable *cur;
2011 if (!args.vars[y]) {
2014 var = val = args.vars[y];
2017 /* XXX We may wish to trim whitespace from the strings. */
2018 if (!val || ast_strlen_zero(var)) {
2022 /* Create new variable list node and prepend it to the list. */
2023 cur = ast_variable_new(var, val, "");
2034 struct ast_variable *astman_get_variables(const struct message *m)
2038 struct ast_variable *head = NULL;
2040 static const char var_hdr[] = "Variable:";
2042 /* Process all "Variable:" headers. */
2043 varlen = strlen(var_hdr);
2044 for (x = 0; x < m->hdrcount; x++) {
2045 if (strncasecmp(var_hdr, m->headers[x], varlen)) {
2048 head = man_do_variable_value(head, m->headers[x] + varlen);
2054 /*! \brief access for hooks to send action messages to ami */
2055 int ast_hook_send_action(struct manager_custom_hook *hook, const char *msg)
2059 struct manager_action *act_found;
2060 struct mansession s = {.session = NULL, };
2061 struct message m = { 0 };
2071 /* Create our own copy of the AMI action msg string. */
2072 src = dup_str = ast_strdup(msg);
2077 /* convert msg string to message struct */
2078 curlen = strlen(src);
2079 for (x = 0; x < curlen; x++) {
2080 int cr; /* set if we have \r */
2081 if (src[x] == '\r' && x+1 < curlen && src[x+1] == '\n')
2082 cr = 2; /* Found. Update length to include \r\n */
2083 else if (src[x] == '\n')
2084 cr = 1; /* also accept \n only */
2087 /* don't keep empty lines */
2088 if (x && m.hdrcount < ARRAY_LEN(m.headers)) {
2089 /* ... but trim \r\n and terminate the header string */
2091 m.headers[m.hdrcount++] = src;
2094 curlen -= x; /* remaining size */
2095 src += x; /* update pointer */
2096 x = -1; /* reset loop */
2099 action = astman_get_header(&m, "Action");
2100 if (strcasecmp(action, "login")) {
2101 act_found = action_find(action);
2104 * we have to simulate a session for this action request
2105 * to be able to pass it down for processing
2106 * This is necessary to meet the previous design of manager.c
2109 s.f = (void*)1; /* set this to something so our request will make it through all functions that test it*/
2111 ao2_lock(act_found);
2112 if (act_found->registered && act_found->func) {
2113 if (act_found->module) {
2114 ast_module_ref(act_found->module);
2116 ao2_unlock(act_found);
2117 ret = act_found->func(&s, &m);
2118 ao2_lock(act_found);
2119 if (act_found->module) {
2120 ast_module_unref(act_found->module);
2125 ao2_unlock(act_found);
2126 ao2_t_ref(act_found, -1, "done with found action object");
2135 * helper function to send a string to the socket.
2136 * Return -1 on error (e.g. buffer full).
2138 static int send_string(struct mansession *s, char *string)
2141 FILE *f = s->f ? s->f : s->session->f;
2142 int fd = s->f ? s->fd : s->session->fd;
2144 /* It's a result from one of the hook's action invocation */
2147 * to send responses, we're using the same function
2148 * as for receiving events. We call the event "HookResponse"
2150 s->hook->helper(EVENT_FLAG_HOOKRESPONSE, "HookResponse", string);
2154 if ((res = ast_careful_fwrite(f, fd, string, strlen(string), s->session->writetimeout))) {
2162 * \brief thread local buffer for astman_append
2164 * \note This can not be defined within the astman_append() function
2165 * because it declares a couple of functions that get used to
2166 * initialize the thread local storage key.
2168 AST_THREADSTORAGE(astman_append_buf);
2170 AST_THREADSTORAGE(userevent_buf);
2172 /*! \brief initial allocated size for the astman_append_buf and astman_send_*_va */
2173 #define ASTMAN_APPEND_BUF_INITSIZE 256
2176 * utility functions for creating AMI replies
2178 void astman_append(struct mansession *s, const char *fmt, ...)
2181 struct ast_str *buf;
2183 if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
2188 ast_str_set_va(&buf, 0, fmt, ap);
2191 if (s->f != NULL || s->session->f != NULL) {
2192 send_string(s, ast_str_buffer(buf));
2194 ast_verbose("fd == -1 in astman_append, should not happen\n");
2198 /*! \note NOTE: XXX this comment is unclear and possibly wrong.
2199 Callers of astman_send_error(), astman_send_response() or astman_send_ack() must EITHER
2200 hold the session lock _or_ be running in an action callback (in which case s->session->busy will
2201 be non-zero). In either of these cases, there is no need to lock-protect the session's
2202 fd, since no other output will be sent (events will be queued), and no input will
2203 be read until either the current action finishes or get_input() obtains the session
2207 /*! \todo XXX MSG_MOREDATA should go to a header file. */
2208 #define MSG_MOREDATA ((char *)astman_send_response)
2210 /*! \brief send a response with an optional message,
2211 * and terminate it with an empty line.
2212 * m is used only to grab the 'ActionID' field.
2214 * Use the explicit constant MSG_MOREDATA to remove the empty line.
2215 * XXX MSG_MOREDATA should go to a header file.
2217 static void astman_send_response_full(struct mansession *s, const struct message *m, char *resp, char *msg, char *listflag)
2219 const char *id = astman_get_header(m, "ActionID");
2221 astman_append(s, "Response: %s\r\n", resp);
2222 if (!ast_strlen_zero(id)) {
2223 astman_append(s, "ActionID: %s\r\n", id);
2226 astman_append(s, "EventList: %s\r\n", listflag); /* Start, complete, cancelled */
2228 if (msg == MSG_MOREDATA) {
2231 astman_append(s, "Message: %s\r\n\r\n", msg);
2233 astman_append(s, "\r\n");
2237 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg)
2239 astman_send_response_full(s, m, resp, msg, NULL);
2242 void astman_send_error(struct mansession *s, const struct message *m, char *error)
2244 astman_send_response_full(s, m, "Error", error, NULL);
2247 void astman_send_error_va(struct mansession *s, const struct message *m, const char *fmt, ...)
2250 struct ast_str *buf;
2252 if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
2257 ast_str_set_va(&buf, 0, fmt, ap);
2260 astman_send_response_full(s, m, "Error", ast_str_buffer(buf), NULL);
2264 void astman_send_ack(struct mansession *s, const struct message *m, char *msg)
2266 astman_send_response_full(s, m, "Success", msg, NULL);
2269 static void astman_start_ack(struct mansession *s, const struct message *m)
2271 astman_send_response_full(s, m, "Success", MSG_MOREDATA, NULL);
2274 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag)
2276 astman_send_response_full(s, m, "Success", msg, listflag);
2279 /*! \brief Lock the 'mansession' structure. */
2280 static void mansession_lock(struct mansession *s)
2282 ast_mutex_lock(&s->lock);
2285 /*! \brief Unlock the 'mansession' structure. */
2286 static void mansession_unlock(struct mansession *s)
2288 ast_mutex_unlock(&s->lock);
2292 Rather than braindead on,off this now can also accept a specific int mask value
2293 or a ',' delim list of mask strings (the same as manager.conf) -anthm
2295 static int set_eventmask(struct mansession *s, const char *eventmask)
2297 int maskint = strings_to_mask(eventmask);
2299 ao2_lock(s->session);
2301 s->session->send_events = maskint;
2303 ao2_unlock(s->session);
2308 static enum ast_security_event_transport_type mansession_get_transport(const struct mansession *s)
2310 return s->tcptls_session->parent->tls_cfg ? AST_SECURITY_EVENT_TRANSPORT_TLS :
2311 AST_SECURITY_EVENT_TRANSPORT_TCP;
2314 static void report_invalid_user(const struct mansession *s, const char *username)
2316 char session_id[32];
2317 struct ast_security_event_inval_acct_id inval_acct_id = {
2318 .common.event_type = AST_SECURITY_EVENT_INVAL_ACCT_ID,
2319 .common.version = AST_SECURITY_EVENT_INVAL_ACCT_ID_VERSION,
2320 .common.service = "AMI",
2321 .common.account_id = username,
2322 .common.session_tv = &s->session->sessionstart_tv,
2323 .common.local_addr = {
2324 .addr = &s->tcptls_session->parent->local_address,
2325 .transport = mansession_get_transport(s),
2327 .common.remote_addr = {
2328 .addr = &s->session->addr,
2329 .transport = mansession_get_transport(s),
2331 .common.session_id = session_id,
2334 snprintf(session_id, sizeof(session_id), "%p", s);
2336 ast_security_event_report(AST_SEC_EVT(&inval_acct_id));
2339 static void report_failed_acl(const struct mansession *s, const char *username)
2341 char session_id[32];
2342 struct ast_security_event_failed_acl failed_acl_event = {
2343 .common.event_type = AST_SECURITY_EVENT_FAILED_ACL,
2344 .common.version = AST_SECURITY_EVENT_FAILED_ACL_VERSION,
2345 .common.service = "AMI",
2346 .common.account_id = username,
2347 .common.session_tv = &s->session->sessionstart_tv,
2348 .common.local_addr = {
2349 .addr = &s->tcptls_session->parent->local_address,
2350 .transport = mansession_get_transport(s),
2352 .common.remote_addr = {
2353 .addr = &s->session->addr,
2354 .transport = mansession_get_transport(s),
2356 .common.session_id = session_id,
2359 snprintf(session_id, sizeof(session_id), "%p", s->session);
2361 ast_security_event_report(AST_SEC_EVT(&failed_acl_event));
2364 static void report_inval_password(const struct mansession *s, const char *username)
2366 char session_id[32];
2367 struct ast_security_event_inval_password inval_password = {
2368 .common.event_type = AST_SECURITY_EVENT_INVAL_PASSWORD,
2369 .common.version = AST_SECURITY_EVENT_INVAL_PASSWORD_VERSION,
2370 .common.service = "AMI",
2371 .common.account_id = username,
2372 .common.session_tv = &s->session->sessionstart_tv,
2373 .common.local_addr = {
2374 .addr = &s->tcptls_session->parent->local_address,
2375 .transport = mansession_get_transport(s),
2377 .common.remote_addr = {
2378 .addr = &s->session->addr,
2379 .transport = mansession_get_transport(s),
2381 .common.session_id = session_id,
2384 snprintf(session_id, sizeof(session_id), "%p", s->session);
2386 ast_security_event_report(AST_SEC_EVT(&inval_password));
2389 static void report_auth_success(const struct mansession *s)
2391 char session_id[32];
2392 struct ast_security_event_successful_auth successful_auth = {
2393 .common.event_type = AST_SECURITY_EVENT_SUCCESSFUL_AUTH,
2394 .common.version = AST_SECURITY_EVENT_SUCCESSFUL_AUTH_VERSION,
2395 .common.service = "AMI",
2396 .common.account_id = s->session->username,
2397 .common.session_tv = &s->session->sessionstart_tv,
2398 .common.local_addr = {
2399 .addr = &s->tcptls_session->parent->local_address,
2400 .transport = mansession_get_transport(s),
2402 .common.remote_addr = {
2403 .addr = &s->session->addr,
2404 .transport = mansession_get_transport(s),
2406 .common.session_id = session_id,
2409 snprintf(session_id, sizeof(session_id), "%p", s->session);
2411 ast_security_event_report(AST_SEC_EVT(&successful_auth));
2414 static void report_req_not_allowed(const struct mansession *s, const char *action)
2416 char session_id[32];
2417 char request_type[64];
2418 struct ast_security_event_req_not_allowed req_not_allowed = {
2419 .common.event_type = AST_SECURITY_EVENT_REQ_NOT_ALLOWED,
2420 .common.version = AST_SECURITY_EVENT_REQ_NOT_ALLOWED_VERSION,
2421 .common.service = "AMI",
2422 .common.account_id = s->session->username,
2423 .common.session_tv = &s->session->sessionstart_tv,
2424 .common.local_addr = {
2425 .addr = &s->tcptls_session->parent->local_address,
2426 .transport = mansession_get_transport(s),
2428 .common.remote_addr = {
2429 .addr = &s->session->addr,
2430 .transport = mansession_get_transport(s),
2432 .common.session_id = session_id,
2434 .request_type = request_type,
2437 snprintf(session_id, sizeof(session_id), "%p", s->session);
2438 snprintf(request_type, sizeof(request_type), "Action: %s", action);
2440 ast_security_event_report(AST_SEC_EVT(&req_not_allowed));
2443 static void report_req_bad_format(const struct mansession *s, const char *action)
2445 char session_id[32];
2446 char request_type[64];
2447 struct ast_security_event_req_bad_format req_bad_format = {
2448 .common.event_type = AST_SECURITY_EVENT_REQ_BAD_FORMAT,
2449 .common.version = AST_SECURITY_EVENT_REQ_BAD_FORMAT_VERSION,
2450 .common.service = "AMI",
2451 .common.account_id = s->session->username,
2452 .common.session_tv = &s->session->sessionstart_tv,
2453 .common.local_addr = {
2454 .addr = &s->tcptls_session->parent->local_address,
2455 .transport = mansession_get_transport(s),
2457 .common.remote_addr = {
2458 .addr = &s->session->addr,
2459 .transport = mansession_get_transport(s),
2461 .common.session_id = session_id,
2463 .request_type = request_type,
2466 snprintf(session_id, sizeof(session_id), "%p", s->session);
2467 snprintf(request_type, sizeof(request_type), "Action: %s", action);
2469 ast_security_event_report(AST_SEC_EVT(&req_bad_format));
2472 static void report_failed_challenge_response(const struct mansession *s,
2473 const char *response, const char *expected_response)
2475 char session_id[32];
2476 struct ast_security_event_chal_resp_failed chal_resp_failed = {
2477 .common.event_type = AST_SECURITY_EVENT_CHAL_RESP_FAILED,
2478 .common.version = AST_SECURITY_EVENT_CHAL_RESP_FAILED_VERSION,
2479 .common.service = "AMI",
2480 .common.account_id = s->session->username,
2481 .common.session_tv = &s->session->sessionstart_tv,
2482 .common.local_addr = {
2483 .addr = &s->tcptls_session->parent->local_address,
2484 .transport = mansession_get_transport(s),
2486 .common.remote_addr = {
2487 .addr = &s->session->addr,
2488 .transport = mansession_get_transport(s),
2490 .common.session_id = session_id,
2492 .challenge = s->session->challenge,
2493 .response = response,
2494 .expected_response = expected_response,
2497 snprintf(session_id, sizeof(session_id), "%p", s->session);
2499 ast_security_event_report(AST_SEC_EVT(&chal_resp_failed));
2502 static void report_session_limit(const struct mansession *s)
2504 char session_id[32];
2505 struct ast_security_event_session_limit session_limit = {
2506 .common.event_type = AST_SECURITY_EVENT_SESSION_LIMIT,
2507 .common.version = AST_SECURITY_EVENT_SESSION_LIMIT_VERSION,
2508 .common.service = "AMI",
2509 .common.account_id = s->session->username,
2510 .common.session_tv = &s->session->sessionstart_tv,
2511 .common.local_addr = {
2512 .addr = &s->tcptls_session->parent->local_address,
2513 .transport = mansession_get_transport(s),
2515 .common.remote_addr = {
2516 .addr = &s->session->addr,
2517 .transport = mansession_get_transport(s),
2519 .common.session_id = session_id,
2522 snprintf(session_id, sizeof(session_id), "%p", s->session);
2524 ast_security_event_report(AST_SEC_EVT(&session_limit));
2528 * Here we start with action_ handlers for AMI actions,
2529 * and the internal functions used by them.
2530 * Generally, the handlers are called action_foo()
2533 /* helper function for action_login() */
2534 static int authenticate(struct mansession *s, const struct message *m)
2536 const char *username = astman_get_header(m, "Username");
2537 const char *password = astman_get_header(m, "Secret");
2539 struct ast_manager_user *user = NULL;
2540 regex_t *regex_filter;
2541 struct ao2_iterator filter_iter;
2543 if (ast_strlen_zero(username)) { /* missing username */
2547 /* locate user in locked state */
2548 AST_RWLIST_WRLOCK(&users);
2550 if (!(user = get_manager_by_name_locked(username))) {
2551 report_invalid_user(s, username);
2552 ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2553 } else if (user->acl && (ast_apply_acl(user->acl, &s->session->addr, "Manager User ACL: ") == AST_SENSE_DENY)) {
2554 report_failed_acl(s, username);
2555 ast_log(LOG_NOTICE, "%s failed to pass IP ACL as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2556 } else if (!strcasecmp(astman_get_header(m, "AuthType"), "MD5")) {
2557 const char *key = astman_get_header(m, "Key");
2558 if (!ast_strlen_zero(key) && !ast_strlen_zero(s->session->challenge) && user->secret) {
2561 char md5key[256] = "";
2562 struct MD5Context md5;
2563 unsigned char digest[16];
2566 MD5Update(&md5, (unsigned char *) s->session->challenge, strlen(s->session->challenge));
2567 MD5Update(&md5, (unsigned char *) user->secret, strlen(user->secret));
2568 MD5Final(digest, &md5);
2569 for (x = 0; x < 16; x++)
2570 len += sprintf(md5key + len, "%2.2x", digest[x]);
2571 if (!strcmp(md5key, key)) {
2574 report_failed_challenge_response(s, key, md5key);
2577 ast_debug(1, "MD5 authentication is not possible. challenge: '%s'\n",
2578 S_OR(s->session->challenge, ""));
2580 } else if (user->secret) {
2581 if (!strcmp(password, user->secret)) {
2584 report_inval_password(s, username);
2589 ast_log(LOG_NOTICE, "%s failed to authenticate as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2590 AST_RWLIST_UNLOCK(&users);
2596 /* All of the user parameters are copied to the session so that in the event
2597 * of a reload and a configuration change, the session parameters are not
2599 ast_copy_string(s->session->username, username, sizeof(s->session->username));
2600 s->session->readperm = user->readperm;
2601 s->session->writeperm = user->writeperm;
2602 s->session->writetimeout = user->writetimeout;
2603 if (user->chanvars) {
2604 s->session->chanvars = ast_variables_dup(user->chanvars);
2607 filter_iter = ao2_iterator_init(user->whitefilters, 0);
2608 while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2609 ao2_t_link(s->session->whitefilters, regex_filter, "add white user filter to session");
2610 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2612 ao2_iterator_destroy(&filter_iter);
2614 filter_iter = ao2_iterator_init(user->blackfilters, 0);
2615 while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2616 ao2_t_link(s->session->blackfilters, regex_filter, "add black user filter to session");
2617 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2619 ao2_iterator_destroy(&filter_iter);
2621 s->session->sessionstart = time(NULL);
2622 s->session->sessionstart_tv = ast_tvnow();
2623 set_eventmask(s, astman_get_header(m, "Events"));
2625 report_auth_success(s);
2627 AST_RWLIST_UNLOCK(&users);
2631 static int action_ping(struct mansession *s, const struct message *m)
2633 const char *actionid = astman_get_header(m, "ActionID");
2634 struct timeval now = ast_tvnow();
2636 astman_append(s, "Response: Success\r\n");
2637 if (!ast_strlen_zero(actionid)){
2638 astman_append(s, "ActionID: %s\r\n", actionid);
2643 "Timestamp: %ld.%06lu\r\n"
2645 (long) now.tv_sec, (unsigned long) now.tv_usec);
2649 static int action_getconfig(struct mansession *s, const struct message *m)
2651 struct ast_config *cfg;
2652 const char *fn = astman_get_header(m, "Filename");
2653 const char *category = astman_get_header(m, "Category");
2656 char *cur_category = NULL;
2657 struct ast_variable *v;
2658 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2660 if (ast_strlen_zero(fn)) {
2661 astman_send_error(s, m, "Filename not specified");
2664 cfg = ast_config_load2(fn, "manager", config_flags);
2665 if (cfg == CONFIG_STATUS_FILEMISSING) {
2666 astman_send_error(s, m, "Config file not found");
2668 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2669 astman_send_error(s, m, "Config file has invalid format");
2673 astman_start_ack(s, m);
2674 while ((cur_category = ast_category_browse(cfg, cur_category))) {
2675 if (ast_strlen_zero(category) || (!ast_strlen_zero(category) && !strcmp(category, cur_category))) {
2677 astman_append(s, "Category-%06d: %s\r\n", catcount, cur_category);
2678 for (v = ast_variable_browse(cfg, cur_category); v; v = v->next) {
2679 astman_append(s, "Line-%06d-%06d: %s=%s\r\n", catcount, lineno++, v->name, v->value);
2684 if (!ast_strlen_zero(category) && catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
2685 astman_append(s, "No categories found\r\n");
2687 ast_config_destroy(cfg);
2688 astman_append(s, "\r\n");
2693 static int action_listcategories(struct mansession *s, const struct message *m)
2695 struct ast_config *cfg;
2696 const char *fn = astman_get_header(m, "Filename");
2697 char *category = NULL;
2698 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2701 if (ast_strlen_zero(fn)) {
2702 astman_send_error(s, m, "Filename not specified");
2705 if (!(cfg = ast_config_load2(fn, "manager", config_flags))) {
2706 astman_send_error(s, m, "Config file not found");
2708 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2709 astman_send_error(s, m, "Config file has invalid format");
2712 astman_start_ack(s, m);
2713 while ((category = ast_category_browse(cfg, category))) {
2714 astman_append(s, "Category-%06d: %s\r\n", catcount, category);
2717 if (catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
2718 astman_append(s, "Error: no categories found\r\n");
2720 ast_config_destroy(cfg);
2721 astman_append(s, "\r\n");
2729 /*! The amount of space in out must be at least ( 2 * strlen(in) + 1 ) */
2730 static void json_escape(char *out, const char *in)
2733 if (*in == '\\' || *in == '\"') {
2743 * \brief Append a JSON escaped string to the manager stream.
2745 * \param s AMI stream to append a string.
2746 * \param str String to append to the stream after JSON escaping it.
2750 static void astman_append_json(struct mansession *s, const char *str)
2754 buf = ast_alloca(2 * strlen(str) + 1);
2755 json_escape(buf, str);
2756 astman_append(s, "%s", buf);
2759 static int action_getconfigjson(struct mansession *s, const struct message *m)
2761 struct ast_config *cfg;
2762 const char *fn = astman_get_header(m, "Filename");
2763 char *category = NULL;
2764 struct ast_variable *v;
2766 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2768 if (ast_strlen_zero(fn)) {
2769 astman_send_error(s, m, "Filename not specified");
2773 if (!(cfg = ast_config_load2(fn, "manager", config_flags))) {
2774 astman_send_error(s, m, "Config file not found");
2776 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2777 astman_send_error(s, m, "Config file has invalid format");
2781 astman_start_ack(s, m);
2782 astman_append(s, "JSON: {");
2783 while ((category = ast_category_browse(cfg, category))) {
2786 astman_append(s, "%s\"", comma1 ? "," : "");
2787 astman_append_json(s, category);
2788 astman_append(s, "\":[");
2790 for (v = ast_variable_browse(cfg, category); v; v = v->next) {
2791 astman_append(s, "%s\"", comma2 ? "," : "");
2792 astman_append_json(s, v->name);
2793 astman_append(s, "\":\"");
2794 astman_append_json(s, v->value);
2795 astman_append(s, "\"");
2798 astman_append(s, "]");
2800 astman_append(s, "}\r\n\r\n");
2802 ast_config_destroy(cfg);
2807 /*! \brief helper function for action_updateconfig */
2808 static enum error_type handle_updates(struct mansession *s, const struct message *m, struct ast_config *cfg, const char *dfn)
2812 const char *action, *cat, *var, *value, *match, *line;
2813 struct ast_category *category;
2814 struct ast_variable *v;
2815 struct ast_str *str1 = ast_str_create(16), *str2 = ast_str_create(16);
2816 enum error_type result = 0;
2818 for (x = 0; x < 100000; x++) { /* 100000 = the max number of allowed updates + 1 */
2819 unsigned int object = 0;
2821 snprintf(hdr, sizeof(hdr), "Action-%06d", x);
2822 action = astman_get_header(m, hdr);
2823 if (ast_strlen_zero(action)) /* breaks the for loop if no action header */
2824 break; /* this could cause problems if actions come in misnumbered */
2826 snprintf(hdr, sizeof(hdr), "Cat-%06d", x);
2827 cat = astman_get_header(m, hdr);
2828 if (ast_strlen_zero(cat)) { /* every action needs a category */
2829 result = UNSPECIFIED_CATEGORY;
2833 snprintf(hdr, sizeof(hdr), "Var-%06d", x);
2834 var = astman_get_header(m, hdr);
2836 snprintf(hdr, sizeof(hdr), "Value-%06d", x);
2837 value = astman_get_header(m, hdr);
2839 if (!ast_strlen_zero(value) && *value == '>') {
2844 snprintf(hdr, sizeof(hdr), "Match-%06d", x);
2845 match = astman_get_header(m, hdr);
2847 snprintf(hdr, sizeof(hdr), "Line-%06d", x);
2848 line = astman_get_header(m, hdr);
2850 if (!strcasecmp(action, "newcat")) {
2851 if (ast_category_get(cfg,cat)) { /* check to make sure the cat doesn't */
2852 result = FAILURE_NEWCAT; /* already exist */
2855 if (!(category = ast_category_new(cat, dfn, -1))) {
2856 result = FAILURE_ALLOCATION;
2859 if (ast_strlen_zero(match)) {
2860 ast_category_append(cfg, category);
2862 ast_category_insert(cfg, category, match);
2864 } else if (!strcasecmp(action, "renamecat")) {
2865 if (ast_strlen_zero(value)) {
2866 result = UNSPECIFIED_ARGUMENT;
2869 if (!(category = ast_category_get(cfg, cat))) {
2870 result = UNKNOWN_CATEGORY;
2873 ast_category_rename(category, value);
2874 } else if (!strcasecmp(action, "delcat")) {
2875 if (ast_category_delete(cfg, cat)) {
2876 result = FAILURE_DELCAT;
2879 } else if (!strcasecmp(action, "emptycat")) {
2880 if (ast_category_empty(cfg, cat)) {
2881 result = FAILURE_EMPTYCAT;
2884 } else if (!strcasecmp(action, "update")) {
2885 if (ast_strlen_zero(var)) {
2886 result = UNSPECIFIED_ARGUMENT;
2889 if (!(category = ast_category_get(cfg,cat))) {
2890 result = UNKNOWN_CATEGORY;
2893 if (ast_variable_update(category, var, value, match, object)) {
2894 result = FAILURE_UPDATE;
2897 } else if (!strcasecmp(action, "delete")) {
2898 if ((ast_strlen_zero(var) && ast_strlen_zero(line))) {
2899 result = UNSPECIFIED_ARGUMENT;
2902 if (!(category = ast_category_get(cfg, cat))) {
2903 result = UNKNOWN_CATEGORY;
2906 if (ast_variable_delete(category, var, match, line)) {
2907 result = FAILURE_DELETE;
2910 } else if (!strcasecmp(action, "append")) {
2911 if (ast_strlen_zero(var)) {
2912 result = UNSPECIFIED_ARGUMENT;
2915 if (!(category = ast_category_get(cfg, cat))) {
2916 result = UNKNOWN_CATEGORY;
2919 if (!(v = ast_variable_new(var, value, dfn))) {
2920 result = FAILURE_ALLOCATION;
2923 if (object || (match && !strcasecmp(match, "object"))) {
2926 ast_variable_append(category, v);
2927 } else if (!strcasecmp(action, "insert")) {
2928 if (ast_strlen_zero(var) || ast_strlen_zero(line)) {
2929 result = UNSPECIFIED_ARGUMENT;
2932 if (!(category = ast_category_get(cfg, cat))) {
2933 result = UNKNOWN_CATEGORY;
2936 if (!(v = ast_variable_new(var, value, dfn))) {
2937 result = FAILURE_ALLOCATION;
2940 ast_variable_insert(category, v, line);
2943 ast_log(LOG_WARNING, "Action-%06d: %s not handled\n", x, action);
2944 result = UNKNOWN_ACTION;
2953 static int action_updateconfig(struct mansession *s, const struct message *m)
2955 struct ast_config *cfg;
2956 const char *sfn = astman_get_header(m, "SrcFilename");
2957 const char *dfn = astman_get_header(m, "DstFilename");
2959 const char *rld = astman_get_header(m, "Reload");
2960 struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2961 enum error_type result;
2963 if (ast_strlen_zero(sfn) || ast_strlen_zero(dfn)) {
2964 astman_send_error(s, m, "Filename not specified");
2967 if (!(cfg = ast_config_load2(sfn, "manager", config_flags))) {
2968 astman_send_error(s, m, "Config file not found");
2970 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2971 astman_send_error(s, m, "Config file has invalid format");
2974 result = handle_updates(s, m, cfg, dfn);
2976 ast_include_rename(cfg, sfn, dfn); /* change the include references from dfn to sfn, so things match up */
2977 res = ast_config_text_file_save(dfn, cfg, "Manager");
2978 ast_config_destroy(cfg);
2980 astman_send_error(s, m, "Save of config failed");
2983 astman_send_ack(s, m, NULL);
2984 if (!ast_strlen_zero(rld)) {
2985 if (ast_true(rld)) {
2988 ast_module_reload(rld);
2991 ast_config_destroy(cfg);
2993 case UNKNOWN_ACTION:
2994 astman_send_error(s, m, "Unknown action command");
2996 case UNKNOWN_CATEGORY:
2997 astman_send_error(s, m, "Given category does not exist");
2999 case UNSPECIFIED_CATEGORY:
3000 astman_send_error(s, m, "Category not specified");
3002 case UNSPECIFIED_ARGUMENT:
3003 astman_send_error(s, m, "Problem with category, value, or line (if required)");
3005 case FAILURE_ALLOCATION:
3006 astman_send_error(s, m, "Memory allocation failure, this should not happen");
3008 case FAILURE_NEWCAT:
3009 astman_send_error(s, m, "Create category did not complete successfully");
3011 case FAILURE_DELCAT:
3012 astman_send_error(s, m, "Delete category did not complete successfully");
3014 case FAILURE_EMPTYCAT:
3015 astman_send_error(s, m, "Empty category did not complete successfully");
3017 case FAILURE_UPDATE:
3018 astman_send_error(s, m, "Update did not complete successfully");
3020 case FAILURE_DELETE:
3021 astman_send_error(s, m, "Delete did not complete successfully");
3023 case FAILURE_APPEND:
3024 astman_send_error(s, m, "Append did not complete successfully");
3031 static int action_createconfig(struct mansession *s, const struct message *m)
3034 const char *fn = astman_get_header(m, "Filename");
3035 struct ast_str *filepath = ast_str_alloca(PATH_MAX);
3036 ast_str_set(&filepath, 0, "%s/", ast_config_AST_CONFIG_DIR);
3037 ast_str_append(&filepath, 0, "%s", fn);
3039 if ((fd = open(ast_str_buffer(filepath), O_CREAT | O_EXCL, AST_FILE_MODE)) != -1) {
3041 astman_send_ack(s, m, "New configuration file created successfully");
3043 astman_send_error(s, m, strerror(errno));
3049 static int action_waitevent(struct mansession *s, const struct message *m)
3051 const char *timeouts = astman_get_header(m, "Timeout");
3055 const char *id = astman_get_header(m, "ActionID");
3058 if (!ast_strlen_zero(id)) {
3059 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
3064 if (!ast_strlen_zero(timeouts)) {
3065 sscanf(timeouts, "%30i", &timeout);
3069 /* XXX maybe put an upper bound, or prevent the use of 0 ? */
3072 ao2_lock(s->session);
3073 if (s->session->waiting_thread != AST_PTHREADT_NULL) {
3074 pthread_kill(s->session->waiting_thread, SIGURG);
3077 if (s->session->managerid) { /* AMI-over-HTTP session */
3079 * Make sure the timeout is within the expire time of the session,
3080 * as the client will likely abort the request if it does not see
3081 * data coming after some amount of time.
3083 time_t now = time(NULL);
3084 int max = s->session->sessiontimeout - now - 10;
3086 if (max < 0) { /* We are already late. Strange but possible. */
3089 if (timeout < 0 || timeout > max) {
3092 if (!s->session->send_events) { /* make sure we record events */
3093 s->session->send_events = -1;
3096 ao2_unlock(s->session);
3098 /* XXX should this go inside the lock ? */
3099 s->session->waiting_thread = pthread_self(); /* let new events wake up this thread */
3100 ast_debug(1, "Starting waiting for an event!\n");
3102 for (x = 0; x < timeout || timeout < 0; x++) {
3103 ao2_lock(s->session);
3104 if (AST_RWLIST_NEXT(s->session->last_ev, eq_next)) {
3107 /* We can have multiple HTTP session point to the same mansession entry.
3108 * The way we deal with it is not very nice: newcomers kick out the previous
3109 * HTTP session. XXX this needs to be improved.
3111 if (s->session->waiting_thread != pthread_self()) {
3114 if (s->session->needdestroy) {
3117 ao2_unlock(s->session);
3121 if (s->session->managerid == 0) { /* AMI session */
3122 if (ast_wait_for_input(s->session->fd, 1000)) {
3125 } else { /* HTTP session */
3129 ast_debug(1, "Finished waiting for an event!\n");
3131 ao2_lock(s->session);
3132 if (s->session->waiting_thread == pthread_self()) {
3133 struct eventqent *eqe = s->session->last_ev;
3134 astman_send_response(s, m, "Success", "Waiting for Event completed.");
3135 while ((eqe = advance_event(eqe))) {
3136 if (((s->session->readperm & eqe->category) == eqe->category) &&
3137 ((s->session->send_events & eqe->category) == eqe->category)) {
3138 astman_append(s, "%s", eqe->eventdata);
3140 s->session->last_ev = eqe;
3143 "Event: WaitEventComplete\r\n"
3146 s->session->waiting_thread = AST_PTHREADT_NULL;
3148 ast_debug(1, "Abandoning event request!\n");
3150 ao2_unlock(s->session);
3155 static int action_listcommands(struct mansession *s, const struct message *m)
3157 struct manager_action *cur;
3158 struct ast_str *temp = ast_str_alloca(256);
3160 astman_start_ack(s, m);
3161 AST_RWLIST_RDLOCK(&actions);
3162 AST_RWLIST_TRAVERSE(&actions, cur, list) {
3163 if ((s->session->writeperm & cur->authority) || cur->authority == 0) {
3164 astman_append(s, "%s: %s (Priv: %s)\r\n",
3165 cur->action, cur->synopsis, authority_to_str(cur->authority, &temp));
3168 AST_RWLIST_UNLOCK(&actions);
3169 astman_append(s, "\r\n");
3174 static int action_events(struct mansession *s, const struct message *m)
3176 const char *mask = astman_get_header(m, "EventMask");
3178 const char *id = astman_get_header(m, "ActionID");
3181 if (!ast_strlen_zero(id)) {
3182 snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", id);
3187 res = set_eventmask(s, mask);
3188 if (broken_events_action) {
3189 /* if this option is set we should not return a response on
3190 * error, or when all events are set */
3193 for (x = 0; x < ARRAY_LEN(perms); x++) {
3194 if (!strcasecmp(perms[x].label, "all") && res == perms[x].num) {
3198 astman_append(s, "Response: Success\r\n%s"
3199 "Events: On\r\n\r\n", id_text);
3200 } else if (res == 0)
3201 astman_append(s, "Response: Success\r\n%s"
3202 "Events: Off\r\n\r\n", id_text);
3207 astman_append(s, "Response: Success\r\n%s"
3208 "Events: On\r\n\r\n", id_text);
3210 astman_append(s, "Response: Success\r\n%s"
3211 "Events: Off\r\n\r\n", id_text);
3213 astman_send_error(s, m, "Invalid event mask");
3218 static int action_logoff(struct mansession *s, const struct message *m)
3220 astman_send_response(s, m, "Goodbye", "Thanks for all the fish.");
3224 static int action_login(struct mansession *s, const struct message *m)
3227 /* still authenticated - don't process again */
3228 if (s->session->authenticated) {
3229 astman_send_ack(s, m, "Already authenticated");
3233 if (authenticate(s, m)) {
3235 astman_send_error(s, m, "Authentication failed");
3238 s->session->authenticated = 1;
3239 ast_atomic_fetchadd_int(&unauth_sessions, -1);
3240 if (manager_displayconnects(s->session)) {
3241 ast_verb(2, "%sManager '%s' logged on from %s\n", (s->session->managerid ? "HTTP " : ""), s->session->username, ast_sockaddr_stringify_addr(&s->session->addr));
3243 astman_send_ack(s, m, "Authentication accepted");
3244 if ((s->session->send_events & EVENT_FLAG_SYSTEM)
3245 && ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
3246 struct ast_str *auth = ast_str_alloca(80);
3247 const char *cat_str = authority_to_str(EVENT_FLAG_SYSTEM, &auth);
3248 astman_append(s, "Event: FullyBooted\r\n"
3250 "Status: Fully Booted\r\n\r\n", cat_str);
3255 static int action_challenge(struct mansession *s, const struct message *m)
3257 const char *authtype = astman_get_header(m, "AuthType");
3259 if (!strcasecmp(authtype, "MD5")) {
3260 if (ast_strlen_zero(s->session->challenge)) {
3261 snprintf(s->session->challenge, sizeof(s->session->challenge), "%ld", ast_random());
3264 astman_start_ack(s, m);
3265 astman_append(s, "Challenge: %s\r\n\r\n", s->session->challenge);
3266 mansession_unlock(s);
3268 astman_send_error(s, m, "Must specify AuthType");
3273 static int action_hangup(struct mansession *s, const struct message *m)
3275 struct ast_channel *c = NULL;
3276 int causecode = 0; /* all values <= 0 mean 'do not set hangupcause in channel' */
3277 const char *id = astman_get_header(m, "ActionID");
3278 const char *name_or_regex = astman_get_header(m, "Channel");
3279 const char *cause = astman_get_header(m, "Cause");
3282 struct ast_channel_iterator *iter = NULL;
3283 struct ast_str *regex_string;
3284 int channels_matched = 0;
3286 if (ast_strlen_zero(name_or_regex)) {
3287 astman_send_error(s, m, "No channel specified");
3291 if (!ast_strlen_zero(id)) {
3292 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
3297 if (!ast_strlen_zero(cause)) {
3299 causecode = strtol(cause, &endptr, 10);
3300 if (causecode < 0 || causecode > 127 || *endptr != '\0') {
3301 ast_log(LOG_NOTICE, "Invalid 'Cause: %s' in manager action Hangup\n", cause);
3302 /* keep going, better to hangup without cause than to not hang up at all */
3303 causecode = 0; /* do not set channel's hangupcause */
3307 /************************************************/
3308 /* Regular explicit match channel byname hangup */
3310 if (name_or_regex[0] != '/') {
3311 if (!(c = ast_channel_get_by_name(name_or_regex))) {
3312 ast_log(LOG_NOTICE, "!!!!!!!!!! Can't find channel to hang up!\n");
3313 astman_send_error(s, m, "No such channel");
3317 ast_verb(3, "%sManager '%s' from %s, hanging up channel: %s\n",
3318 (s->session->managerid ? "HTTP " : ""),
3319 s->session->username,
3320 ast_sockaddr_stringify_addr(&s->session->addr),
3321 ast_channel_name(c));
3323 ast_channel_softhangup_withcause_locked(c, causecode);
3324 c = ast_channel_unref(c);
3326 astman_send_ack(s, m, "Channel Hungup");
3331 /***********************************************/
3332 /* find and hangup any channels matching regex */
3334 regex_string = ast_str_create(strlen(name_or_regex));
3335 if (!regex_string) {
3336 astman_send_error(s, m, "Memory Allocation Failure");
3340 /* Make "/regex/" into "regex" */
3341 if (ast_regex_string_to_regex_pattern(name_or_regex, ®ex_string) != 0) {
3342 astman_send_error(s, m, "Regex format invalid, Channel param should be /regex/");
3343 ast_free(regex_string);
3347 /* if regex compilation fails, hangup fails */
3348 if (regcomp(®exbuf, ast_str_buffer(regex_string), REG_EXTENDED | REG_NOSUB)) {
3349 astman_send_error_va(s, m, "Regex compile failed on: %s\n", name_or_regex);
3350 ast_free(regex_string);
3354 astman_send_listack(s, m, "Channels hung up will follow", "start");
3356 iter = ast_channel_iterator_all_new();
3358 for (; (c = ast_channel_iterator_next(iter)); ast_channel_unref(c)) {
3359 if (regexec(®exbuf, ast_channel_name(c), 0, NULL, 0)) {
3363 ast_verb(3, "%sManager '%s' from %s, hanging up channel: %s\n",
3364 (s->session->managerid ? "HTTP " : ""),
3365 s->session->username,
3366 ast_sockaddr_stringify_addr(&s->session->addr),
3367 ast_channel_name(c));
3369 ast_channel_softhangup_withcause_locked(c, causecode);
3373 "Event: ChannelHungup\r\n"
3376 "\r\n", ast_channel_name(c), idText);
3378 ast_channel_iterator_destroy(iter);
3382 ast_free(regex_string);
3385 "Event: ChannelsHungupListComplete\r\n"
3386 "EventList: Complete\r\n"
3389 "\r\n", channels_matched, idText);
3394 static int action_setvar(struct mansession *s, const struct message *m)
3396 struct ast_channel *c = NULL;
3397 const char *name = astman_get_header(m, "Channel");
3398 const char *varname = astman_get_header(m, "Variable");
3399 const char *varval = astman_get_header(m, "Value");
3402 if (ast_strlen_zero(varname)) {
3403 astman_send_error(s, m, "No variable specified");
3407 if (!ast_strlen_zero(name)) {
3408 if (!(c = ast_channel_get_by_name(name))) {
3409 astman_send_error(s, m, "No such channel");
3414 res = pbx_builtin_setvar_helper(c, varname, S_OR(varval, ""));
3417 c = ast_channel_unref(c);
3420 astman_send_ack(s, m, "Variable Set");
3422 astman_send_error(s, m, "Variable not set");
3427 static int action_getvar(struct mansession *s, const struct message *m)
3429 struct ast_channel *c = NULL;
3430 const char *name = astman_get_header(m, "Channel");
3431 const char *varname = astman_get_header(m, "Variable");
3433 char workspace[1024];
3435 if (ast_strlen_zero(varname)) {
3436 astman_send_error(s, m, "No variable specified");
3440 /* We don't want users with insufficient permissions using certain functions. */
3441 if (!(function_capable_string_allowed_with_auths(varname, s->session->writeperm))) {
3442 astman_send_error(s, m, "GetVar Access Forbidden: Variable");
3446 if (!ast_strlen_zero(name)) {
3447 if (!(c = ast_channel_get_by_name(name))) {
3448 astman_send_error(s, m, "No such channel");
3453 workspace[0] = '\0';
3454 if (varname[strlen(varname) - 1] == ')') {
3456 c = ast_dummy_channel_alloc();
3458 ast_func_read(c, (char *) varname, workspace, sizeof(workspace));
3460 ast_log(LOG_ERROR, "Unable to allocate bogus channel for variable substitution. Function results may be blank.\n");
3462 ast_func_read(c, (char *) varname, workspace, sizeof(workspace));
3466 pbx_retrieve_variable(c, varname, &varval, workspace, sizeof(workspace), NULL);
3470 c = ast_channel_unref(c);
3473 astman_start_ack(s, m);
3474 astman_append(s, "Variable: %s\r\nValue: %s\r\n\r\n", varname, S_OR(varval, ""));
3479 /*! \brief Manager "status" command to show channels */
3480 /* Needs documentation... */
3481 static int action_status(struct mansession *s, const struct message *m)
3483 const char *name = astman_get_header(m, "Channel");
3484 const char *cvariables = astman_get_header(m, "Variables");
3485 char *variables = ast_strdupa(S_OR(cvariables,&nbs
projects / asterisk/asterisk.git / blob