12aa851c7e07c06d1392b793abcc38b463cdd8ae
[asterisk/asterisk.git] / main / manager.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
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.
13  *
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.
17  */
18
19 /*! \file
20  *
21  * \brief The Asterisk Management Interface - AMI
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \extref OpenSSL http://www.openssl.org - for AMI/SSL
26  *
27  * At the moment this file contains a number of functions, namely:
28  *
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
35  *
36  * \ref amiconf
37  */
38
39 /*! \addtogroup Group_AMI AMI functions
40 */
41 /*! @{
42  Doxygen group */
43
44 /*** MODULEINFO
45         <support_level>core</support_level>
46  ***/
47
48 #include "asterisk.h"
49
50 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
51
52 #include "asterisk/_private.h"
53 #include "asterisk/paths.h"     /* use various ast_config_AST_* */
54 #include <ctype.h>
55 #include <sys/time.h>
56 #include <signal.h>
57 #include <sys/mman.h>
58 #include <sys/types.h>
59 #include <regex.h>
60
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"
87
88 /*** DOCUMENTATION
89         <manager name="Ping" language="en_US">
90                 <synopsis>
91                         Keepalive command.
92                 </synopsis>
93                 <syntax>
94                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
95                 </syntax>
96                 <description>
97                         <para>A 'Ping' action will ellicit a 'Pong' response. Used to keep the
98                         manager connection open.</para>
99                 </description>
100         </manager>
101         <manager name="Events" language="en_US">
102                 <synopsis>
103                         Control Event Flow.
104                 </synopsis>
105                 <syntax>
106                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
107                         <parameter name="EventMask" required="true">
108                                 <enumlist>
109                                         <enum name="on">
110                                                 <para>If all events should be sent.</para>
111                                         </enum>
112                                         <enum name="off">
113                                                 <para>If no events should be sent.</para>
114                                         </enum>
115                                         <enum name="system,call,log,...">
116                                                 <para>To select which flags events should have to be sent.</para>
117                                         </enum>
118                                 </enumlist>
119                         </parameter>
120                 </syntax>
121                 <description>
122                         <para>Enable/Disable sending of events to this manager client.</para>
123                 </description>
124         </manager>
125         <manager name="Logoff" language="en_US">
126                 <synopsis>
127                         Logoff Manager.
128                 </synopsis>
129                 <syntax>
130                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
131                 </syntax>
132                 <description>
133                         <para>Logoff the current manager session.</para>
134                 </description>
135         </manager>
136         <manager name="Login" language="en_US">
137                 <synopsis>
138                         Login Manager.
139                 </synopsis>
140                 <syntax>
141                         <parameter name="ActionID">
142                                 <para>ActionID for this transaction. Will be returned.</para>
143                         </parameter>
144                         <parameter name="Username" required="true">
145                                 <para>Username to login with as specified in manager.conf.</para>
146                         </parameter>
147                         <parameter name="Secret">
148                                 <para>Secret to login with as specified in manager.conf.</para>
149                         </parameter>
150                 </syntax>
151                 <description>
152                         <para>Login Manager.</para>
153                 </description>
154         </manager>
155         <manager name="Challenge" language="en_US">
156                 <synopsis>
157                         Generate Challenge for MD5 Auth.
158                 </synopsis>
159                 <syntax>
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>
163                                 <enumlist>
164                                         <enum name="MD5" />
165                                 </enumlist>
166                         </parameter>
167                 </syntax>
168                 <description>
169                         <para>Generate a challenge for MD5 authentication.</para>
170                 </description>
171         </manager>
172         <manager name="Hangup" language="en_US">
173                 <synopsis>
174                         Hangup channel.
175                 </synopsis>
176                 <syntax>
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>
182                         </parameter>
183                         <parameter name="Cause">
184                                 <para>Numeric hangup cause.</para>
185                         </parameter>
186                 </syntax>
187                 <description>
188                         <para>Hangup a channel.</para>
189                 </description>
190         </manager>
191         <manager name="Status" language="en_US">
192                 <synopsis>
193                         List channel status.
194                 </synopsis>
195                 <syntax>
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>
199                         </parameter>
200                         <parameter name="Variables">
201                                 <para>Comma <literal>,</literal> separated list of variable to include.</para>
202                         </parameter>
203                 </syntax>
204                 <description>
205                         <para>Will return the status information of each channel along with the
206                         value for the specified channel variables.</para>
207                 </description>
208         </manager>
209         <manager name="Setvar" language="en_US">
210                 <synopsis>
211                         Set a channel variable.
212                 </synopsis>
213                 <syntax>
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>
217                         </parameter>
218                         <parameter name="Variable" required="true">
219                                 <para>Variable name.</para>
220                         </parameter>
221                         <parameter name="Value" required="true">
222                                 <para>Variable value.</para>
223                         </parameter>
224                 </syntax>
225                 <description>
226                         <para>Set a global or local channel variable.</para>
227                         <note>
228                                 <para>If a channel name is not provided then the variable is global.</para>
229                         </note>
230                 </description>
231         </manager>
232         <manager name="Getvar" language="en_US">
233                 <synopsis>
234                         Gets a channel variable.
235                 </synopsis>
236                 <syntax>
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>
240                         </parameter>
241                         <parameter name="Variable" required="true">
242                                 <para>Variable name.</para>
243                         </parameter>
244                 </syntax>
245                 <description>
246                         <para>Get the value of a global or local channel variable.</para>
247                         <note>
248                                 <para>If a channel name is not provided then the variable is global.</para>
249                         </note>
250                 </description>
251         </manager>
252         <manager name="GetConfig" language="en_US">
253                 <synopsis>
254                         Retrieve configuration.
255                 </synopsis>
256                 <syntax>
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>
260                         </parameter>
261                         <parameter name="Category">
262                                 <para>Category in configuration file.</para>
263                         </parameter>
264                 </syntax>
265                 <description>
266                         <para>This action will dump the contents of a configuration
267                         file by category and contents or optionally by specified category only.</para>
268                 </description>
269         </manager>
270         <manager name="GetConfigJSON" language="en_US">
271                 <synopsis>
272                         Retrieve configuration (JSON format).
273                 </synopsis>
274                 <syntax>
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>
278                         </parameter>
279                 </syntax>
280                 <description>
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>
284                 </description>
285         </manager>
286         <manager name="UpdateConfig" language="en_US">
287                 <synopsis>
288                         Update basic configuration.
289                 </synopsis>
290                 <syntax>
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>
294                         </parameter>
295                         <parameter name="DstFilename" required="true">
296                                 <para>Configuration filename to write (e.g. <filename>foo.conf</filename>)</para>
297                         </parameter>
298                         <parameter name="Reload">
299                                 <para>Whether or not a reload should take place (or name of specific module).</para>
300                         </parameter>
301                         <parameter name="Action-XXXXXX">
302                                 <para>Action to take.</para>
303                                 <para>X's represent 6 digit number beginning with 000000.</para>
304                                 <enumlist>
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" />
313                                 </enumlist>
314                         </parameter>
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])" />
318                         </parameter>
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])" />
322                         </parameter>
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])" />
326                         </parameter>
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])" />
330                         </parameter>
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])" />
334                         </parameter>
335                 </syntax>
336                 <description>
337                         <para>This action will modify, create, or delete configuration elements
338                         in Asterisk configuration files.</para>
339                 </description>
340         </manager>
341         <manager name="CreateConfig" language="en_US">
342                 <synopsis>
343                         Creates an empty file in the configuration directory.
344                 </synopsis>
345                 <syntax>
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>
349                         </parameter>
350                 </syntax>
351                 <description>
352                         <para>This action will create an empty file in the configuration
353                         directory. This action is intended to be used before an UpdateConfig
354                         action.</para>
355                 </description>
356         </manager>
357         <manager name="ListCategories" language="en_US">
358                 <synopsis>
359                         List categories in configuration file.
360                 </synopsis>
361                 <syntax>
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>
365                         </parameter>
366                 </syntax>
367                 <description>
368                         <para>This action will dump the categories in a given file.</para>
369                 </description>
370         </manager>
371         <manager name="Redirect" language="en_US">
372                 <synopsis>
373                         Redirect (transfer) a call.
374                 </synopsis>
375                 <syntax>
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>
379                         </parameter>
380                         <parameter name="ExtraChannel">
381                                 <para>Second call leg to transfer (optional).</para>
382                         </parameter>
383                         <parameter name="Exten" required="true">
384                                 <para>Extension to transfer to.</para>
385                         </parameter>
386                         <parameter name="ExtraExten">
387                                 <para>Extension to transfer extrachannel to (optional).</para>
388                         </parameter>
389                         <parameter name="Context" required="true">
390                                 <para>Context to transfer to.</para>
391                         </parameter>
392                         <parameter name="ExtraContext">
393                                 <para>Context to transfer extrachannel to (optional).</para>
394                         </parameter>
395                         <parameter name="Priority" required="true">
396                                 <para>Priority to transfer to.</para>
397                         </parameter>
398                         <parameter name="ExtraPriority">
399                                 <para>Priority to transfer extrachannel to (optional).</para>
400                         </parameter>
401                 </syntax>
402                 <description>
403                         <para>Redirect (transfer) a call.</para>
404                 </description>
405         </manager>
406         <manager name="Atxfer" language="en_US">
407                 <synopsis>
408                         Attended transfer.
409                 </synopsis>
410                 <syntax>
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>
414                         </parameter>
415                         <parameter name="Exten" required="true">
416                                 <para>Extension to transfer to.</para>
417                         </parameter>
418                         <parameter name="Context" required="true">
419                                 <para>Context to transfer to.</para>
420                         </parameter>
421                         <parameter name="Priority" required="true">
422                                 <para>Priority to transfer to.</para>
423                         </parameter>
424                 </syntax>
425                 <description>
426                         <para>Attended transfer.</para>
427                 </description>
428         </manager>
429         <manager name="Originate" language="en_US">
430                 <synopsis>
431                         Originate a call.
432                 </synopsis>
433                 <syntax>
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>
437                         </parameter>
438                         <parameter name="Exten">
439                                 <para>Extension to use (requires <literal>Context</literal> and
440                                 <literal>Priority</literal>)</para>
441                         </parameter>
442                         <parameter name="Context">
443                                 <para>Context to use (requires <literal>Exten</literal> and
444                                 <literal>Priority</literal>)</para>
445                         </parameter>
446                         <parameter name="Priority">
447                                 <para>Priority to use (requires <literal>Exten</literal> and
448                                 <literal>Context</literal>)</para>
449                         </parameter>
450                         <parameter name="Application">
451                                 <para>Application to execute.</para>
452                         </parameter>
453                         <parameter name="Data">
454                                 <para>Data to use (requires <literal>Application</literal>).</para>
455                         </parameter>
456                         <parameter name="Timeout" default="30000">
457                                 <para>How long to wait for call to be answered (in ms.).</para>
458                         </parameter>
459                         <parameter name="CallerID">
460                                 <para>Caller ID to be set on the outgoing channel.</para>
461                         </parameter>
462                         <parameter name="Variable">
463                                 <para>Channel variable to set, multiple Variable: headers are allowed.</para>
464                         </parameter>
465                         <parameter name="Account">
466                                 <para>Account code.</para>
467                         </parameter>
468                         <parameter name="Async">
469                                 <para>Set to <literal>true</literal> for fast origination.</para>
470                         </parameter>
471                         <parameter name="Codecs">
472                                 <para>Comma-separated list of codecs to use for this call.</para>
473                         </parameter>
474                 </syntax>
475                 <description>
476                         <para>Generates an outgoing call to a
477                         <replaceable>Extension</replaceable>/<replaceable>Context</replaceable>/<replaceable>Priority</replaceable>
478                         or <replaceable>Application</replaceable>/<replaceable>Data</replaceable></para>
479                 </description>
480                 <see-also>
481                         <ref type="managerEvent">OriginateResponse</ref>
482                 </see-also>
483         </manager>
484         <managerEvent language="en_US" name="OriginateResponse">
485                 <managerEventInstance class="EVENT_FLAG_CALL">
486                         <synopsis>Raised in response to an Originate command.</synopsis>
487                         <syntax>
488                                 <parameter name="ActionID" required="false"/>
489                                 <parameter name="Resonse">
490                                         <enumlist>
491                                                 <enum name="Failure"/>
492                                                 <enum name="Success"/>
493                                         </enumlist>
494                                 </parameter>
495                                 <parameter name="Channel"/>
496                                 <parameter name="Context"/>
497                                 <parameter name="Exten"/>
498                                 <parameter name="Reason"/>
499                                 <parameter name="Uniqueid"/>
500                                 <parameter name="CallerIDNum"/>
501                                 <parameter name="CallerIDName"/>
502                         </syntax>
503                         <see-also>
504                                 <ref type="manager">Originate</ref>
505                         </see-also>
506                 </managerEventInstance>
507         </managerEvent>
508         <manager name="Command" language="en_US">
509                 <synopsis>
510                         Execute Asterisk CLI Command.
511                 </synopsis>
512                 <syntax>
513                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
514                         <parameter name="Command" required="true">
515                                 <para>Asterisk CLI command to run.</para>
516                         </parameter>
517                 </syntax>
518                 <description>
519                         <para>Run a CLI command.</para>
520                 </description>
521         </manager>
522         <manager name="ExtensionState" language="en_US">
523                 <synopsis>
524                         Check Extension Status.
525                 </synopsis>
526                 <syntax>
527                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
528                         <parameter name="Exten" required="true">
529                                 <para>Extension to check state on.</para>
530                         </parameter>
531                         <parameter name="Context" required="true">
532                                 <para>Context for extension.</para>
533                         </parameter>
534                 </syntax>
535                 <description>
536                         <para>Report the extension state for given extension. If the extension has a hint,
537                         will use devicestate to check the status of the device connected to the extension.</para>
538                         <para>Will return an <literal>Extension Status</literal> message. The response will include
539                         the hint for the extension and the status.</para>
540                 </description>
541         </manager>
542         <manager name="PresenceState" language="en_US">
543                 <synopsis>
544                         Check Presence State
545                 </synopsis>
546                 <syntax>
547                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
548                         <parameter name="Provider" required="true">
549                                 <para>Presence Provider to check the state of</para>
550                         </parameter>
551                 </syntax>
552                 <description>
553                         <para>Report the presence state for the given presence provider.</para>
554                         <para>Will return a <literal>Presence State</literal> message. The response will include the
555                         presence state and, if set, a presence subtype and custom message.</para>
556                 </description>
557         </manager>
558         <manager name="AbsoluteTimeout" language="en_US">
559                 <synopsis>
560                         Set absolute timeout.
561                 </synopsis>
562                 <syntax>
563                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
564                         <parameter name="Channel" required="true">
565                                 <para>Channel name to hangup.</para>
566                         </parameter>
567                         <parameter name="Timeout" required="true">
568                                 <para>Maximum duration of the call (sec).</para>
569                         </parameter>
570                 </syntax>
571                 <description>
572                         <para>Hangup a channel after a certain time. Acknowledges set time with
573                         <literal>Timeout Set</literal> message.</para>
574                 </description>
575         </manager>
576         <manager name="MailboxStatus" language="en_US">
577                 <synopsis>
578                         Check mailbox.
579                 </synopsis>
580                 <syntax>
581                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
582                         <parameter name="Mailbox" required="true">
583                                 <para>Full mailbox ID <replaceable>mailbox</replaceable>@<replaceable>vm-context</replaceable>.</para>
584                         </parameter>
585                 </syntax>
586                 <description>
587                         <para>Checks a voicemail account for status.</para>
588                         <para>Returns number of messages.</para>
589                         <para>Message: Mailbox Status.</para>
590                         <para>Mailbox: <replaceable>mailboxid</replaceable>.</para>
591                         <para>Waiting: <replaceable>count</replaceable>.</para>
592                 </description>
593         </manager>
594         <manager name="MailboxCount" language="en_US">
595                 <synopsis>
596                         Check Mailbox Message Count.
597                 </synopsis>
598                 <syntax>
599                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
600                         <parameter name="Mailbox" required="true">
601                                 <para>Full mailbox ID <replaceable>mailbox</replaceable>@<replaceable>vm-context</replaceable>.</para>
602                         </parameter>
603                 </syntax>
604                 <description>
605                         <para>Checks a voicemail account for new messages.</para>
606                         <para>Returns number of urgent, new and old messages.</para>
607                         <para>Message: Mailbox Message Count</para>
608                         <para>Mailbox: <replaceable>mailboxid</replaceable></para>
609                         <para>UrgentMessages: <replaceable>count</replaceable></para>
610                         <para>NewMessages: <replaceable>count</replaceable></para>
611                         <para>OldMessages: <replaceable>count</replaceable></para>
612                 </description>
613         </manager>
614         <manager name="ListCommands" language="en_US">
615                 <synopsis>
616                         List available manager commands.
617                 </synopsis>
618                 <syntax>
619                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
620                 </syntax>
621                 <description>
622                         <para>Returns the action name and synopsis for every action that
623                         is available to the user.</para>
624                 </description>
625         </manager>
626         <manager name="SendText" language="en_US">
627                 <synopsis>
628                         Send text message to channel.
629                 </synopsis>
630                 <syntax>
631                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
632                         <parameter name="Channel" required="true">
633                                 <para>Channel to send message to.</para>
634                         </parameter>
635                         <parameter name="Message" required="true">
636                                 <para>Message to send.</para>
637                         </parameter>
638                 </syntax>
639                 <description>
640                         <para>Sends A Text Message to a channel while in a call.</para>
641                 </description>
642         </manager>
643         <manager name="UserEvent" language="en_US">
644                 <synopsis>
645                         Send an arbitrary event.
646                 </synopsis>
647                 <syntax>
648                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
649                         <parameter name="UserEvent" required="true">
650                                 <para>Event string to send.</para>
651                         </parameter>
652                         <parameter name="Header1">
653                                 <para>Content1.</para>
654                         </parameter>
655                         <parameter name="HeaderN">
656                                 <para>ContentN.</para>
657                         </parameter>
658                 </syntax>
659                 <description>
660                         <para>Send an event to manager sessions.</para>
661                 </description>
662         </manager>
663         <manager name="WaitEvent" language="en_US">
664                 <synopsis>
665                         Wait for an event to occur.
666                 </synopsis>
667                 <syntax>
668                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
669                         <parameter name="Timeout" required="true">
670                                 <para>Maximum time (in seconds) to wait for events, <literal>-1</literal> means forever.</para>
671                         </parameter>
672                 </syntax>
673                 <description>
674                         <para>This action will ellicit a <literal>Success</literal> response. Whenever
675                         a manager event is queued. Once WaitEvent has been called on an HTTP manager
676                         session, events will be generated and queued.</para>
677                 </description>
678         </manager>
679         <manager name="CoreSettings" language="en_US">
680                 <synopsis>
681                         Show PBX core settings (version etc).
682                 </synopsis>
683                 <syntax>
684                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
685                 </syntax>
686                 <description>
687                         <para>Query for Core PBX settings.</para>
688                 </description>
689         </manager>
690         <manager name="CoreStatus" language="en_US">
691                 <synopsis>
692                         Show PBX core status variables.
693                 </synopsis>
694                 <syntax>
695                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
696                 </syntax>
697                 <description>
698                         <para>Query for Core PBX status.</para>
699                 </description>
700         </manager>
701         <manager name="Reload" language="en_US">
702                 <synopsis>
703                         Send a reload event.
704                 </synopsis>
705                 <syntax>
706                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
707                         <parameter name="Module">
708                                 <para>Name of the module to reload.</para>
709                         </parameter>
710                 </syntax>
711                 <description>
712                         <para>Send a reload event.</para>
713                 </description>
714         </manager>
715         <manager name="CoreShowChannels" language="en_US">
716                 <synopsis>
717                         List currently active channels.
718                 </synopsis>
719                 <syntax>
720                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
721                 </syntax>
722                 <description>
723                         <para>List currently defined channels and some information about them.</para>
724                 </description>
725         </manager>
726         <manager name="ModuleLoad" language="en_US">
727                 <synopsis>
728                         Module management.
729                 </synopsis>
730                 <syntax>
731                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
732                         <parameter name="Module">
733                                 <para>Asterisk module name (including .so extension) or subsystem identifier:</para>
734                                 <enumlist>
735                                         <enum name="cdr" />
736                                         <enum name="enum" />
737                                         <enum name="dnsmgr" />
738                                         <enum name="extconfig" />
739                                         <enum name="manager" />
740                                         <enum name="rtp" />
741                                         <enum name="http" />
742                                 </enumlist>
743                         </parameter>
744                         <parameter name="LoadType" required="true">
745                                 <para>The operation to be done on module.</para>
746                                 <enumlist>
747                                         <enum name="load" />
748                                         <enum name="unload" />
749                                         <enum name="reload" />
750                                 </enumlist>
751                                 <para>If no module is specified for a <literal>reload</literal> loadtype,
752                                 all modules are reloaded.</para>
753                         </parameter>
754                 </syntax>
755                 <description>
756                         <para>Loads, unloads or reloads an Asterisk module in a running system.</para>
757                 </description>
758         </manager>
759         <manager name="ModuleCheck" language="en_US">
760                 <synopsis>
761                         Check if module is loaded.
762                 </synopsis>
763                 <syntax>
764                         <parameter name="Module" required="true">
765                                 <para>Asterisk module name (not including extension).</para>
766                         </parameter>
767                 </syntax>
768                 <description>
769                         <para>Checks if Asterisk module is loaded. Will return Success/Failure.
770                         For success returns, the module revision number is included.</para>
771                 </description>
772         </manager>
773         <manager name="AOCMessage" language="en_US">
774                 <synopsis>
775                         Generate an Advice of Charge message on a channel.
776                 </synopsis>
777                 <syntax>
778                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
779                         <parameter name="Channel" required="true">
780                                 <para>Channel name to generate the AOC message on.</para>
781                         </parameter>
782                         <parameter name="ChannelPrefix">
783                                 <para>Partial channel prefix.  By using this option one can match the beginning part
784                                 of a channel name without having to put the entire name in.  For example
785                                 if a channel name is SIP/snom-00000001 and this value is set to SIP/snom, then
786                                 that channel matches and the message will be sent.  Note however that only
787                                 the first matched channel has the message sent on it. </para>
788                         </parameter>
789                         <parameter name="MsgType" required="true">
790                                 <para>Defines what type of AOC message to create, AOC-D or AOC-E</para>
791                                 <enumlist>
792                                         <enum name="D" />
793                                         <enum name="E" />
794                                 </enumlist>
795                         </parameter>
796                         <parameter name="ChargeType" required="true">
797                                 <para>Defines what kind of charge this message represents.</para>
798                                 <enumlist>
799                                         <enum name="NA" />
800                                         <enum name="FREE" />
801                                         <enum name="Currency" />
802                                         <enum name="Unit" />
803                                 </enumlist>
804                         </parameter>
805                         <parameter name="UnitAmount(0)">
806                                 <para>This represents the amount of units charged. The ETSI AOC standard specifies that
807                                 this value along with the optional UnitType value are entries in a list.  To accommodate this
808                                 these values take an index value starting at 0 which can be used to generate this list of
809                                 unit entries.  For Example, If two unit entires were required this could be achieved by setting the
810                                 paramter UnitAmount(0)=1234 and UnitAmount(1)=5678.  Note that UnitAmount at index 0 is
811                                 required when ChargeType=Unit, all other entries in the list are optional.
812                                 </para>
813                         </parameter>
814                         <parameter name="UnitType(0)">
815                                 <para>Defines the type of unit.  ETSI AOC standard specifies this as an integer
816                                 value between 1 and 16, but this value is left open to accept any positive
817                                 integer.  Like the UnitAmount parameter, this value represents a list entry
818                                 and has an index parameter that starts at 0.
819                                 </para>
820                         </parameter>
821                         <parameter name="CurrencyName">
822                                 <para>Specifies the currency's name.  Note that this value is truncated after 10 characters.</para>
823                         </parameter>
824                         <parameter name="CurrencyAmount">
825                                 <para>Specifies the charge unit amount as a positive integer.  This value is required
826                                 when ChargeType==Currency.</para>
827                         </parameter>
828                         <parameter name="CurrencyMultiplier">
829                                 <para>Specifies the currency multiplier.  This value is required when ChargeType==Currency.</para>
830                                 <enumlist>
831                                         <enum name="OneThousandth" />
832                                         <enum name="OneHundredth" />
833                                         <enum name="OneTenth" />
834                                         <enum name="One" />
835                                         <enum name="Ten" />
836                                         <enum name="Hundred" />
837                                         <enum name="Thousand" />
838                                 </enumlist>
839                         </parameter>
840                         <parameter name="TotalType" default="Total">
841                                 <para>Defines what kind of AOC-D total is represented.</para>
842                                 <enumlist>
843                                         <enum name="Total" />
844                                         <enum name="SubTotal" />
845                                 </enumlist>
846                         </parameter>
847                         <parameter name="AOCBillingId">
848                                 <para>Represents a billing ID associated with an AOC-D or AOC-E message. Note
849                                 that only the first 3 items of the enum are valid AOC-D billing IDs</para>
850                                 <enumlist>
851                                         <enum name="Normal" />
852                                         <enum name="ReverseCharge" />
853                                         <enum name="CreditCard" />
854                                         <enum name="CallFwdUnconditional" />
855                                         <enum name="CallFwdBusy" />
856                                         <enum name="CallFwdNoReply" />
857                                         <enum name="CallDeflection" />
858                                         <enum name="CallTransfer" />
859                                 </enumlist>
860                         </parameter>
861                         <parameter name="ChargingAssociationId">
862                                 <para>Charging association identifier.  This is optional for AOC-E and can be
863                                 set to any value between -32768 and 32767</para>
864                         </parameter>
865                         <parameter name="ChargingAssociationNumber">
866                                 <para>Represents the charging association party number.  This value is optional
867                                 for AOC-E.</para>
868                         </parameter>
869                         <parameter name="ChargingAssociationPlan">
870                                 <para>Integer representing the charging plan associated with the ChargingAssociationNumber.
871                                 The value is bits 7 through 1 of the Q.931 octet containing the type-of-number and
872                                 numbering-plan-identification fields.</para>
873                         </parameter>
874                 </syntax>
875                 <description>
876                         <para>Generates an AOC-D or AOC-E message on a channel.</para>
877                 </description>
878         </manager>
879         <function name="AMI_CLIENT" language="en_US">
880                 <synopsis>
881                         Checks attributes of manager accounts
882                 </synopsis>
883                 <syntax>
884                         <parameter name="loginname" required="true">
885                                 <para>Login name, specified in manager.conf</para>
886                         </parameter>
887                         <parameter name="field" required="true">
888                                 <para>The manager account attribute to return</para>
889                                 <enumlist>
890                                         <enum name="sessions"><para>The number of sessions for this AMI account</para></enum>
891                                 </enumlist>
892                         </parameter>
893                 </syntax>
894                 <description>
895                         <para>
896                                 Currently, the only supported  parameter is "sessions" which will return the current number of
897                                 active sessions for this AMI account.
898                         </para>
899                 </description>
900         </function>
901         <manager name="Filter" language="en_US">
902                 <synopsis>
903                         Dynamically add filters for the current manager session.
904                 </synopsis>
905                 <syntax>
906                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
907                         <parameter name="Operation">
908                                 <enumlist>
909                                         <enum name="Add">
910                                                 <para>Add a filter.</para>
911                                         </enum>
912                                 </enumlist>
913                         </parameter>
914                         <parameter name="Filter">
915                                 <para>Filters can be whitelist or blacklist</para>
916                                 <para>Example whitelist filter: "Event: Newchannel"</para>
917                                 <para>Example blacklist filter: "!Channel: DAHDI.*"</para>
918                                 <para>This filter option is used to whitelist or blacklist events per user to be
919                                 reported with regular expressions and are allowed if both the regex matches
920                                 and the user has read access as defined in manager.conf. Filters are assumed to be for whitelisting
921                                 unless preceeded by an exclamation point, which marks it as being black.
922                                 Evaluation of the filters is as follows:</para>
923                                 <para>- If no filters are configured all events are reported as normal.</para>
924                                 <para>- If there are white filters only: implied black all filter processed first, then white filters.</para>
925                                 <para>- If there are black filters only: implied white all filter processed first, then black filters.</para>
926                                 <para>- If there are both white and black filters: implied black all filter processed first, then white
927                                 filters, and lastly black filters.</para>
928                         </parameter>
929                 </syntax>
930                 <description>
931                         <para>The filters added are only used for the current session.
932                         Once the connection is closed the filters are removed.</para>
933                         <para>This comand requires the system permission because
934                         this command can be used to create filters that may bypass
935                         filters defined in manager.conf</para>
936                 </description>
937         </manager>
938         <manager name="FilterList" language="en_US">
939                 <synopsis>
940                         Show current event filters for this session
941                 </synopsis>
942                 <description>
943                         <para>The filters displayed are for the current session.  Only those filters defined in
944                         manager.conf will be present upon starting a new session.</para>
945                 </description>
946         </manager>
947  ***/
948
949 enum error_type {
950         UNKNOWN_ACTION = 1,
951         UNKNOWN_CATEGORY,
952         UNSPECIFIED_CATEGORY,
953         UNSPECIFIED_ARGUMENT,
954         FAILURE_ALLOCATION,
955         FAILURE_NEWCAT,
956         FAILURE_DELCAT,
957         FAILURE_EMPTYCAT,
958         FAILURE_UPDATE,
959         FAILURE_DELETE,
960         FAILURE_APPEND
961 };
962
963 enum add_filter_result {
964         FILTER_SUCCESS,
965         FILTER_ALLOC_FAILED,
966         FILTER_COMPILE_FAIL,
967 };
968
969 /*!
970  * Linked list of events.
971  * Global events are appended to the list by append_event().
972  * The usecount is the number of stored pointers to the element,
973  * excluding the list pointers. So an element that is only in
974  * the list has a usecount of 0, not 1.
975  *
976  * Clients have a pointer to the last event processed, and for each
977  * of these clients we track the usecount of the elements.
978  * If we have a pointer to an entry in the list, it is safe to navigate
979  * it forward because elements will not be deleted, but only appended.
980  * The worst that can happen is seeing the pointer still NULL.
981  *
982  * When the usecount of an element drops to 0, and the element is the
983  * first in the list, we can remove it. Removal is done within the
984  * main thread, which is woken up for the purpose.
985  *
986  * For simplicity of implementation, we make sure the list is never empty.
987  */
988 struct eventqent {
989         int usecount;           /*!< # of clients who still need the event */
990         int category;
991         unsigned int seq;       /*!< sequence number */
992         struct timeval tv;  /*!< When event was allocated */
993         AST_RWLIST_ENTRY(eventqent) eq_next;
994         char eventdata[1];      /*!< really variable size, allocated by append_event() */
995 };
996
997 static AST_RWLIST_HEAD_STATIC(all_events, eventqent);
998
999 static int displayconnects = 1;
1000 static int allowmultiplelogin = 1;
1001 static int timestampevents;
1002 static int httptimeout = 60;
1003 static int broken_events_action = 0;
1004 static int manager_enabled = 0;
1005 static int webmanager_enabled = 0;
1006 static int manager_debug = 0;   /*!< enable some debugging code in the manager */
1007 static int authtimeout;
1008 static int authlimit;
1009 static char *manager_channelvars;
1010
1011 #define DEFAULT_REALM           "asterisk"
1012 static char global_realm[MAXHOSTNAMELEN];       /*!< Default realm */
1013
1014 static int block_sockets;
1015 static int unauth_sessions = 0;
1016 static struct ast_event_sub *acl_change_event_subscription;
1017
1018 /*! \brief
1019  * Descriptor for a manager session, either on the AMI socket or over HTTP.
1020  *
1021  * \note
1022  * AMI session have managerid == 0; the entry is created upon a connect,
1023  * and destroyed with the socket.
1024  * HTTP sessions have managerid != 0, the value is used as a search key
1025  * to lookup sessions (using the mansession_id cookie, or nonce key from
1026  * Digest Authentication http header).
1027  */
1028 #define MAX_BLACKLIST_CMD_LEN 2
1029 static const struct {
1030         const char *words[AST_MAX_CMD_LEN];
1031 } command_blacklist[] = {
1032         {{ "module", "load", NULL }},
1033         {{ "module", "unload", NULL }},
1034         {{ "restart", "gracefully", NULL }},
1035 };
1036
1037 static void acl_change_event_cb(const struct ast_event *event, void *userdata);
1038
1039 static void acl_change_event_subscribe(void)
1040 {
1041         if (!acl_change_event_subscription) {
1042                 acl_change_event_subscription = ast_event_subscribe(AST_EVENT_ACL_CHANGE,
1043                         acl_change_event_cb, "Manager must react to Named ACL changes", NULL, AST_EVENT_IE_END);
1044         }
1045 }
1046
1047 static void acl_change_event_unsubscribe(void)
1048 {
1049         if (acl_change_event_subscription) {
1050                 acl_change_event_subscription = ast_event_unsubscribe(acl_change_event_subscription);
1051         }
1052 }
1053
1054 /* In order to understand what the heck is going on with the
1055  * mansession_session and mansession structs, we need to have a bit of a history
1056  * lesson.
1057  *
1058  * In the beginning, there was the mansession. The mansession contained data that was
1059  * intrinsic to a manager session, such as the time that it started, the name of the logged-in
1060  * user, etc. In addition to these parameters were the f and fd parameters. For typical manager
1061  * sessions, these were used to represent the TCP socket over which the AMI session was taking
1062  * place. It makes perfect sense for these fields to be a part of the session-specific data since
1063  * the session actually defines this information.
1064  *
1065  * Then came the HTTP AMI sessions. With these, the f and fd fields need to be opened and closed
1066  * for every single action that occurs. Thus the f and fd fields aren't really specific to the session
1067  * but rather to the action that is being executed. Because a single session may execute many commands
1068  * at once, some sort of safety needed to be added in order to be sure that we did not end up with fd
1069  * leaks from one action overwriting the f and fd fields used by a previous action before the previous action
1070  * has had a chance to properly close its handles.
1071  *
1072  * The initial idea to solve this was to use thread synchronization, but this prevented multiple actions
1073  * from being run at the same time in a single session. Some manager actions may block for a long time, thus
1074  * creating a large queue of actions to execute. In addition, this fix did not address the basic architectural
1075  * issue that for HTTP manager sessions, the f and fd variables are not really a part of the session, but are
1076  * part of the action instead.
1077  *
1078  * The new idea was to create a structure on the stack for each HTTP Manager action. This structure would
1079  * contain the action-specific information, such as which file to write to. In order to maintain expectations
1080  * of action handlers and not have to change the public API of the manager code, we would need to name this
1081  * new stacked structure 'mansession' and contain within it the old mansession struct that we used to use.
1082  * We renamed the old mansession struct 'mansession_session' to hopefully convey that what is in this structure
1083  * is session-specific data. The structure that it is wrapped in, called a 'mansession' really contains action-specific
1084  * data.
1085  */
1086 struct mansession_session {
1087                                 /*! \todo XXX need to document which fields it is protecting */
1088         struct ast_sockaddr addr;       /*!< address we are connecting from */
1089         FILE *f;                /*!< fdopen() on the underlying fd */
1090         int fd;                 /*!< descriptor used for output. Either the socket (AMI) or a temporary file (HTTP) */
1091         int inuse;              /*!< number of HTTP sessions using this entry */
1092         int needdestroy;        /*!< Whether an HTTP session should be destroyed */
1093         pthread_t waiting_thread;       /*!< Sleeping thread using this descriptor */
1094         uint32_t managerid;     /*!< Unique manager identifier, 0 for AMI sessions */
1095         time_t sessionstart;    /*!< Session start time */
1096         struct timeval sessionstart_tv; /*!< Session start time */
1097         time_t sessiontimeout;  /*!< Session timeout if HTTP */
1098         char username[80];      /*!< Logged in username */
1099         char challenge[10];     /*!< Authentication challenge */
1100         int authenticated;      /*!< Authentication status */
1101         int readperm;           /*!< Authorization for reading */
1102         int writeperm;          /*!< Authorization for writing */
1103         char inbuf[1025];       /*!< Buffer -  we use the extra byte to add a '\0' and simplify parsing */
1104         int inlen;              /*!< number of buffered bytes */
1105         struct ao2_container *whitefilters;     /*!< Manager event filters - white list */
1106         struct ao2_container *blackfilters;     /*!< Manager event filters - black list */
1107         struct ast_variable *chanvars;  /*!< Channel variables to set for originate */
1108         int send_events;        /*!<  XXX what ? */
1109         struct eventqent *last_ev;      /*!< last event processed. */
1110         int writetimeout;       /*!< Timeout for ast_carefulwrite() */
1111         time_t authstart;
1112         int pending_event;         /*!< Pending events indicator in case when waiting_thread is NULL */
1113         time_t noncetime;       /*!< Timer for nonce value expiration */
1114         unsigned long oldnonce; /*!< Stale nonce value */
1115         unsigned long nc;       /*!< incremental  nonce counter */
1116         AST_LIST_HEAD_NOLOCK(mansession_datastores, ast_datastore) datastores; /*!< Data stores on the session */
1117         AST_LIST_ENTRY(mansession_session) list;
1118 };
1119
1120 /*! \brief In case you didn't read that giant block of text above the mansession_session struct, the
1121  * \ref struct mansession is named this solely to keep the API the same in Asterisk. This structure really
1122  * represents data that is different from Manager action to Manager action. The mansession_session pointer
1123  * contained within points to session-specific data.
1124  */
1125 struct mansession {
1126         struct mansession_session *session;
1127         struct ast_tcptls_session_instance *tcptls_session;
1128         FILE *f;
1129         int fd;
1130         int write_error:1;
1131         struct manager_custom_hook *hook;
1132         ast_mutex_t lock;
1133 };
1134
1135 static struct ao2_container *sessions = NULL;
1136
1137 struct manager_channel_variable {
1138         AST_LIST_ENTRY(manager_channel_variable) entry;
1139         unsigned int isfunc:1;
1140         char name[0]; /* allocate off the end the real size. */
1141 };
1142
1143 static AST_RWLIST_HEAD_STATIC(channelvars, manager_channel_variable);
1144
1145 /*! \brief user descriptor, as read from the config file.
1146  *
1147  * \note It is still missing some fields -- e.g. we can have multiple permit and deny
1148  * lines which are not supported here, and readperm/writeperm/writetimeout
1149  * are not stored.
1150  */
1151 struct ast_manager_user {
1152         char username[80];
1153         char *secret;                   /*!< Secret for logging in */
1154         int readperm;                   /*!< Authorization for reading */
1155         int writeperm;                  /*!< Authorization for writing */
1156         int writetimeout;               /*!< Per user Timeout for ast_carefulwrite() */
1157         int displayconnects;            /*!< XXX unused */
1158         int keep;                       /*!< mark entries created on a reload */
1159         struct ao2_container *whitefilters; /*!< Manager event filters - white list */
1160         struct ao2_container *blackfilters; /*!< Manager event filters - black list */
1161         struct ast_acl_list *acl;       /*!< ACL setting */
1162         char *a1_hash;                  /*!< precalculated A1 for Digest auth */
1163         struct ast_variable *chanvars;  /*!< Channel variables to set for originate */
1164         AST_RWLIST_ENTRY(ast_manager_user) list;
1165 };
1166
1167 /*! \brief list of users found in the config file */
1168 static AST_RWLIST_HEAD_STATIC(users, ast_manager_user);
1169
1170 /*! \brief list of actions registered */
1171 static AST_RWLIST_HEAD_STATIC(actions, manager_action);
1172
1173 /*! \brief list of hooks registered */
1174 static AST_RWLIST_HEAD_STATIC(manager_hooks, manager_custom_hook);
1175
1176 /*! \brief A container of event documentation nodes */
1177 AO2_GLOBAL_OBJ_STATIC(event_docs);
1178
1179 static void free_channelvars(void);
1180
1181 static enum add_filter_result manager_add_filter(const char *filter_pattern, struct ao2_container *whitefilters, struct ao2_container *blackfilters);
1182
1183 /*!
1184  * \internal
1185  * \brief Find a registered action object.
1186  *
1187  * \param name Name of AMI action to find.
1188  *
1189  * \return Reffed action found or NULL
1190  */
1191 static struct manager_action *action_find(const char *name)
1192 {
1193         struct manager_action *act;
1194
1195         AST_RWLIST_RDLOCK(&actions);
1196         AST_RWLIST_TRAVERSE(&actions, act, list) {
1197                 if (!strcasecmp(name, act->action)) {
1198                         ao2_t_ref(act, +1, "found action object");
1199                         break;
1200                 }
1201         }
1202         AST_RWLIST_UNLOCK(&actions);
1203
1204         return act;
1205 }
1206
1207 /*! \brief Add a custom hook to be called when an event is fired */
1208 void ast_manager_register_hook(struct manager_custom_hook *hook)
1209 {
1210         AST_RWLIST_WRLOCK(&manager_hooks);
1211         AST_RWLIST_INSERT_TAIL(&manager_hooks, hook, list);
1212         AST_RWLIST_UNLOCK(&manager_hooks);
1213 }
1214
1215 /*! \brief Delete a custom hook to be called when an event is fired */
1216 void ast_manager_unregister_hook(struct manager_custom_hook *hook)
1217 {
1218         AST_RWLIST_WRLOCK(&manager_hooks);
1219         AST_RWLIST_REMOVE(&manager_hooks, hook, list);
1220         AST_RWLIST_UNLOCK(&manager_hooks);
1221 }
1222
1223 int check_manager_enabled(void)
1224 {
1225         return manager_enabled;
1226 }
1227
1228 int check_webmanager_enabled(void)
1229 {
1230         return (webmanager_enabled && manager_enabled);
1231 }
1232
1233 /*!
1234  * Grab a reference to the last event, update usecount as needed.
1235  * Can handle a NULL pointer.
1236  */
1237 static struct eventqent *grab_last(void)
1238 {
1239         struct eventqent *ret;
1240
1241         AST_RWLIST_WRLOCK(&all_events);
1242         ret = AST_RWLIST_LAST(&all_events);
1243         /* the list is never empty now, but may become so when
1244          * we optimize it in the future, so be prepared.
1245          */
1246         if (ret) {
1247                 ast_atomic_fetchadd_int(&ret->usecount, 1);
1248         }
1249         AST_RWLIST_UNLOCK(&all_events);
1250         return ret;
1251 }
1252
1253 /*!
1254  * Purge unused events. Remove elements from the head
1255  * as long as their usecount is 0 and there is a next element.
1256  */
1257 static void purge_events(void)
1258 {
1259         struct eventqent *ev;
1260         struct timeval now = ast_tvnow();
1261
1262         AST_RWLIST_WRLOCK(&all_events);
1263         while ( (ev = AST_RWLIST_FIRST(&all_events)) &&
1264             ev->usecount == 0 && AST_RWLIST_NEXT(ev, eq_next)) {
1265                 AST_RWLIST_REMOVE_HEAD(&all_events, eq_next);
1266                 ast_free(ev);
1267         }
1268
1269         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&all_events, ev, eq_next) {
1270                 /* Never release the last event */
1271                 if (!AST_RWLIST_NEXT(ev, eq_next)) {
1272                         break;
1273                 }
1274
1275                 /* 2.5 times whatever the HTTP timeout is (maximum 2.5 hours) is the maximum time that we will definitely cache an event */
1276                 if (ev->usecount == 0 && ast_tvdiff_sec(now, ev->tv) > (httptimeout > 3600 ? 3600 : httptimeout) * 2.5) {
1277                         AST_RWLIST_REMOVE_CURRENT(eq_next);
1278                         ast_free(ev);
1279                 }
1280         }
1281         AST_RWLIST_TRAVERSE_SAFE_END;
1282         AST_RWLIST_UNLOCK(&all_events);
1283 }
1284
1285 /*!
1286  * helper functions to convert back and forth between
1287  * string and numeric representation of set of flags
1288  */
1289 static const struct permalias {
1290         int num;
1291         const char *label;
1292 } perms[] = {
1293         { EVENT_FLAG_SYSTEM, "system" },
1294         { EVENT_FLAG_CALL, "call" },
1295         { EVENT_FLAG_LOG, "log" },
1296         { EVENT_FLAG_VERBOSE, "verbose" },
1297         { EVENT_FLAG_COMMAND, "command" },
1298         { EVENT_FLAG_AGENT, "agent" },
1299         { EVENT_FLAG_USER, "user" },
1300         { EVENT_FLAG_CONFIG, "config" },
1301         { EVENT_FLAG_DTMF, "dtmf" },
1302         { EVENT_FLAG_REPORTING, "reporting" },
1303         { EVENT_FLAG_CDR, "cdr" },
1304         { EVENT_FLAG_DIALPLAN, "dialplan" },
1305         { EVENT_FLAG_ORIGINATE, "originate" },
1306         { EVENT_FLAG_AGI, "agi" },
1307         { EVENT_FLAG_CC, "cc" },
1308         { EVENT_FLAG_AOC, "aoc" },
1309         { EVENT_FLAG_TEST, "test" },
1310         { EVENT_FLAG_MESSAGE, "message" },
1311         { INT_MAX, "all" },
1312         { 0, "none" },
1313 };
1314
1315 /*! \brief Checks to see if a string which can be used to evaluate functions should be rejected */
1316 static int function_capable_string_allowed_with_auths(const char *evaluating, int writepermlist)
1317 {
1318         if (!(writepermlist & EVENT_FLAG_SYSTEM)
1319                 && (
1320                         strstr(evaluating, "SHELL") ||       /* NoOp(${SHELL(rm -rf /)})  */
1321                         strstr(evaluating, "EVAL")           /* NoOp(${EVAL(${some_var_containing_SHELL})}) */
1322                 )) {
1323                 return 0;
1324         }
1325         return 1;
1326 }
1327
1328 /*! \brief Convert authority code to a list of options */
1329 static const char *authority_to_str(int authority, struct ast_str **res)
1330 {
1331         int i;
1332         char *sep = "";
1333
1334         ast_str_reset(*res);
1335         for (i = 0; i < ARRAY_LEN(perms) - 1; i++) {
1336                 if (authority & perms[i].num) {
1337                         ast_str_append(res, 0, "%s%s", sep, perms[i].label);
1338                         sep = ",";
1339                 }
1340         }
1341
1342         if (ast_str_strlen(*res) == 0)  /* replace empty string with something sensible */
1343                 ast_str_append(res, 0, "<none>");
1344
1345         return ast_str_buffer(*res);
1346 }
1347
1348 /*! Tells you if smallstr exists inside bigstr
1349    which is delim by delim and uses no buf or stringsep
1350    ast_instring("this|that|more","this",'|') == 1;
1351
1352    feel free to move this to app.c -anthm */
1353 static int ast_instring(const char *bigstr, const char *smallstr, const char delim)
1354 {
1355         const char *val = bigstr, *next;
1356
1357         do {
1358                 if ((next = strchr(val, delim))) {
1359                         if (!strncmp(val, smallstr, (next - val))) {
1360                                 return 1;
1361                         } else {
1362                                 continue;
1363                         }
1364                 } else {
1365                         return !strcmp(smallstr, val);
1366                 }
1367         } while (*(val = (next + 1)));
1368
1369         return 0;
1370 }
1371
1372 static int get_perm(const char *instr)
1373 {
1374         int x = 0, ret = 0;
1375
1376         if (!instr) {
1377                 return 0;
1378         }
1379
1380         for (x = 0; x < ARRAY_LEN(perms); x++) {
1381                 if (ast_instring(instr, perms[x].label, ',')) {
1382                         ret |= perms[x].num;
1383                 }
1384         }
1385
1386         return ret;
1387 }
1388
1389 /*!
1390  * A number returns itself, false returns 0, true returns all flags,
1391  * other strings return the flags that are set.
1392  */
1393 static int strings_to_mask(const char *string)
1394 {
1395         const char *p;
1396
1397         if (ast_strlen_zero(string)) {
1398                 return -1;
1399         }
1400
1401         for (p = string; *p; p++) {
1402                 if (*p < '0' || *p > '9') {
1403                         break;
1404                 }
1405         }
1406         if (!*p) { /* all digits */
1407                 return atoi(string);
1408         }
1409         if (ast_false(string)) {
1410                 return 0;
1411         }
1412         if (ast_true(string)) { /* all permissions */
1413                 int x, ret = 0;
1414                 for (x = 0; x < ARRAY_LEN(perms); x++) {
1415                         ret |= perms[x].num;
1416                 }
1417                 return ret;
1418         }
1419         return get_perm(string);
1420 }
1421
1422 /*! \brief Unreference manager session object.
1423      If no more references, then go ahead and delete it */
1424 static struct mansession_session *unref_mansession(struct mansession_session *s)
1425 {
1426         int refcount = ao2_ref(s, -1);
1427         if (manager_debug) {
1428                 ast_debug(1, "Mansession: %p refcount now %d\n", s, refcount - 1);
1429         }
1430         return s;
1431 }
1432
1433 static void event_filter_destructor(void *obj)
1434 {
1435         regex_t *regex_filter = obj;
1436         regfree(regex_filter);
1437 }
1438
1439 static void session_destructor(void *obj)
1440 {
1441         struct mansession_session *session = obj;
1442         struct eventqent *eqe = session->last_ev;
1443         struct ast_datastore *datastore;
1444
1445         /* Get rid of each of the data stores on the session */
1446         while ((datastore = AST_LIST_REMOVE_HEAD(&session->datastores, entry))) {
1447                 /* Free the data store */
1448                 ast_datastore_free(datastore);
1449         }
1450
1451         if (session->f != NULL) {
1452                 fclose(session->f);
1453         }
1454         if (eqe) {
1455                 ast_atomic_fetchadd_int(&eqe->usecount, -1);
1456         }
1457         if (session->chanvars) {
1458                 ast_variables_destroy(session->chanvars);
1459         }
1460
1461         if (session->whitefilters) {
1462                 ao2_t_callback(session->whitefilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all white filters");
1463                 ao2_t_ref(session->whitefilters, -1 , "decrement ref for white container, should be last one");
1464         }
1465
1466         if (session->blackfilters) {
1467                 ao2_t_callback(session->blackfilters, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL, "unlink all black filters");
1468                 ao2_t_ref(session->blackfilters, -1 , "decrement ref for black container, should be last one");
1469         }
1470 }
1471
1472 /*! \brief Allocate manager session structure and add it to the list of sessions */
1473 static struct mansession_session *build_mansession(const struct ast_sockaddr *addr)
1474 {
1475         struct mansession_session *newsession;
1476
1477         if (!(newsession = ao2_alloc(sizeof(*newsession), session_destructor))) {
1478                 return NULL;
1479         }
1480
1481         if (!(newsession->whitefilters = ao2_container_alloc(1, NULL, NULL))) {
1482                 ao2_ref(newsession, -1);
1483                 return NULL;
1484         }
1485
1486         if (!(newsession->blackfilters = ao2_container_alloc(1, NULL, NULL))) {
1487                 ao2_ref(newsession, -1); /* session_destructor will cleanup the other filter */
1488                 return NULL;
1489         }
1490
1491         newsession->fd = -1;
1492         newsession->waiting_thread = AST_PTHREADT_NULL;
1493         newsession->writetimeout = 100;
1494         newsession->send_events = -1;
1495         ast_sockaddr_copy(&newsession->addr, addr);
1496
1497         ao2_link(sessions, newsession);
1498
1499         return newsession;
1500 }
1501
1502 static int mansession_cmp_fn(void *obj, void *arg, int flags)
1503 {
1504         struct mansession_session *s = obj;
1505         char *str = arg;
1506         return !strcasecmp(s->username, str) ? CMP_MATCH : 0;
1507 }
1508
1509 static void session_destroy(struct mansession_session *s)
1510 {
1511         unref_mansession(s);
1512         ao2_unlink(sessions, s);
1513 }
1514
1515
1516 static int check_manager_session_inuse(const char *name)
1517 {
1518         struct mansession_session *session = ao2_find(sessions, (char *) name, 0);
1519         int inuse = 0;
1520
1521         if (session) {
1522                 inuse = 1;
1523                 unref_mansession(session);
1524         }
1525         return inuse;
1526 }
1527
1528
1529 /*!
1530  * lookup an entry in the list of registered users.
1531  * must be called with the list lock held.
1532  */
1533 static struct ast_manager_user *get_manager_by_name_locked(const char *name)
1534 {
1535         struct ast_manager_user *user = NULL;
1536
1537         AST_RWLIST_TRAVERSE(&users, user, list) {
1538                 if (!strcasecmp(user->username, name)) {
1539                         break;
1540                 }
1541         }
1542
1543         return user;
1544 }
1545
1546 /*! \brief Get displayconnects config option.
1547  *  \param session manager session to get parameter from.
1548  *  \return displayconnects config option value.
1549  */
1550 static int manager_displayconnects (struct mansession_session *session)
1551 {
1552         struct ast_manager_user *user = NULL;
1553         int ret = 0;
1554
1555         AST_RWLIST_RDLOCK(&users);
1556         if ((user = get_manager_by_name_locked (session->username))) {
1557                 ret = user->displayconnects;
1558         }
1559         AST_RWLIST_UNLOCK(&users);
1560
1561         return ret;
1562 }
1563
1564 static char *handle_showmancmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1565 {
1566         struct manager_action *cur;
1567         struct ast_str *authority;
1568         int num, l, which;
1569         char *ret = NULL;
1570 #ifdef AST_XML_DOCS
1571         char syntax_title[64], description_title[64], synopsis_title[64], seealso_title[64], arguments_title[64];
1572 #endif
1573
1574         switch (cmd) {
1575         case CLI_INIT:
1576                 e->command = "manager show command";
1577                 e->usage =
1578                         "Usage: manager show command <actionname> [<actionname> [<actionname> [...]]]\n"
1579                         "       Shows the detailed description for a specific Asterisk manager interface command.\n";
1580                 return NULL;
1581         case CLI_GENERATE:
1582                 l = strlen(a->word);
1583                 which = 0;
1584                 AST_RWLIST_RDLOCK(&actions);
1585                 AST_RWLIST_TRAVERSE(&actions, cur, list) {
1586                         if (!strncasecmp(a->word, cur->action, l) && ++which > a->n) {
1587                                 ret = ast_strdup(cur->action);
1588                                 break;  /* make sure we exit even if ast_strdup() returns NULL */
1589                         }
1590                 }
1591                 AST_RWLIST_UNLOCK(&actions);
1592                 return ret;
1593         }
1594         authority = ast_str_alloca(80);
1595         if (a->argc < 4) {
1596                 return CLI_SHOWUSAGE;
1597         }
1598
1599 #ifdef AST_XML_DOCS
1600         /* setup the titles */
1601         term_color(synopsis_title, "[Synopsis]\n", COLOR_MAGENTA, 0, 40);
1602         term_color(description_title, "[Description]\n", COLOR_MAGENTA, 0, 40);
1603         term_color(syntax_title, "[Syntax]\n", COLOR_MAGENTA, 0, 40);
1604         term_color(seealso_title, "[See Also]\n", COLOR_MAGENTA, 0, 40);
1605         term_color(arguments_title, "[Arguments]\n", COLOR_MAGENTA, 0, 40);
1606 #endif
1607
1608         AST_RWLIST_RDLOCK(&actions);
1609         AST_RWLIST_TRAVERSE(&actions, cur, list) {
1610                 for (num = 3; num < a->argc; num++) {
1611                         if (!strcasecmp(cur->action, a->argv[num])) {
1612 #ifdef AST_XML_DOCS
1613                                 if (cur->docsrc == AST_XML_DOC) {
1614                                         ast_cli(a->fd, "%s%s\n\n%s%s\n\n%s%s\n\n%s%s\n\n%s%s\n\n",
1615                                                 syntax_title,
1616                                                 ast_xmldoc_printable(S_OR(cur->syntax, "Not available"), 1),
1617                                                 synopsis_title,
1618                                                 ast_xmldoc_printable(S_OR(cur->synopsis, "Not available"), 1),
1619                                                 description_title,
1620                                                 ast_xmldoc_printable(S_OR(cur->description, "Not available"), 1),
1621                                                 arguments_title,
1622                                                 ast_xmldoc_printable(S_OR(cur->arguments, "Not available"), 1),
1623                                                 seealso_title,
1624                                                 ast_xmldoc_printable(S_OR(cur->seealso, "Not available"), 1));
1625                                 } else
1626 #endif
1627                                 {
1628                                         ast_cli(a->fd, "Action: %s\nSynopsis: %s\nPrivilege: %s\n%s\n",
1629                                                 cur->action, cur->synopsis,
1630                                                 authority_to_str(cur->authority, &authority),
1631                                                 S_OR(cur->description, ""));
1632                                 }
1633                         }
1634                 }
1635         }
1636         AST_RWLIST_UNLOCK(&actions);
1637
1638         return CLI_SUCCESS;
1639 }
1640
1641 static char *handle_mandebug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1642 {
1643         switch (cmd) {
1644         case CLI_INIT:
1645                 e->command = "manager set debug [on|off]";
1646                 e->usage = "Usage: manager set debug [on|off]\n Show, enable, disable debugging of the manager code.\n";
1647                 return NULL;
1648         case CLI_GENERATE:
1649                 return NULL;
1650         }
1651
1652         if (a->argc == 3) {
1653                 ast_cli(a->fd, "manager debug is %s\n", manager_debug? "on" : "off");
1654         } else if (a->argc == 4) {
1655                 if (!strcasecmp(a->argv[3], "on")) {
1656                         manager_debug = 1;
1657                 } else if (!strcasecmp(a->argv[3], "off")) {
1658                         manager_debug = 0;
1659                 } else {
1660                         return CLI_SHOWUSAGE;
1661                 }
1662         }
1663         return CLI_SUCCESS;
1664 }
1665
1666 static char *handle_showmanager(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1667 {
1668         struct ast_manager_user *user = NULL;
1669         int l, which;
1670         char *ret = NULL;
1671         struct ast_str *rauthority = ast_str_alloca(128);
1672         struct ast_str *wauthority = ast_str_alloca(128);
1673         struct ast_variable *v;
1674
1675         switch (cmd) {
1676         case CLI_INIT:
1677                 e->command = "manager show user";
1678                 e->usage =
1679                         " Usage: manager show user <user>\n"
1680                         "        Display all information related to the manager user specified.\n";
1681                 return NULL;
1682         case CLI_GENERATE:
1683                 l = strlen(a->word);
1684                 which = 0;
1685                 if (a->pos != 3) {
1686                         return NULL;
1687                 }
1688                 AST_RWLIST_RDLOCK(&users);
1689                 AST_RWLIST_TRAVERSE(&users, user, list) {
1690                         if ( !strncasecmp(a->word, user->username, l) && ++which > a->n ) {
1691                                 ret = ast_strdup(user->username);
1692                                 break;
1693                         }
1694                 }
1695                 AST_RWLIST_UNLOCK(&users);
1696                 return ret;
1697         }
1698
1699         if (a->argc != 4) {
1700                 return CLI_SHOWUSAGE;
1701         }
1702
1703         AST_RWLIST_RDLOCK(&users);
1704
1705         if (!(user = get_manager_by_name_locked(a->argv[3]))) {
1706                 ast_cli(a->fd, "There is no manager called %s\n", a->argv[3]);
1707                 AST_RWLIST_UNLOCK(&users);
1708                 return CLI_SUCCESS;
1709         }
1710
1711         ast_cli(a->fd, "\n");
1712         ast_cli(a->fd,
1713                 "       username: %s\n"
1714                 "         secret: %s\n"
1715                 "            ACL: %s\n"
1716                 "      read perm: %s\n"
1717                 "     write perm: %s\n"
1718                 "displayconnects: %s\n",
1719                 (user->username ? user->username : "(N/A)"),
1720                 (user->secret ? "<Set>" : "(N/A)"),
1721                 ((user->acl && !ast_acl_list_is_empty(user->acl)) ? "yes" : "no"),
1722                 authority_to_str(user->readperm, &rauthority),
1723                 authority_to_str(user->writeperm, &wauthority),
1724                 (user->displayconnects ? "yes" : "no"));
1725         ast_cli(a->fd, "      Variables: \n");
1726                 for (v = user->chanvars ; v ; v = v->next) {
1727                         ast_cli(a->fd, "                 %s = %s\n", v->name, v->value);
1728                 }
1729
1730         AST_RWLIST_UNLOCK(&users);
1731
1732         return CLI_SUCCESS;
1733 }
1734
1735 static char *handle_showmanagers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1736 {
1737         struct ast_manager_user *user = NULL;
1738         int count_amu = 0;
1739         switch (cmd) {
1740         case CLI_INIT:
1741                 e->command = "manager show users";
1742                 e->usage =
1743                         "Usage: manager show users\n"
1744                         "       Prints a listing of all managers that are currently configured on that\n"
1745                         " system.\n";
1746                 return NULL;
1747         case CLI_GENERATE:
1748                 return NULL;
1749         }
1750         if (a->argc != 3) {
1751                 return CLI_SHOWUSAGE;
1752         }
1753
1754         AST_RWLIST_RDLOCK(&users);
1755
1756         /* If there are no users, print out something along those lines */
1757         if (AST_RWLIST_EMPTY(&users)) {
1758                 ast_cli(a->fd, "There are no manager users.\n");
1759                 AST_RWLIST_UNLOCK(&users);
1760                 return CLI_SUCCESS;
1761         }
1762
1763         ast_cli(a->fd, "\nusername\n--------\n");
1764
1765         AST_RWLIST_TRAVERSE(&users, user, list) {
1766                 ast_cli(a->fd, "%s\n", user->username);
1767                 count_amu++;
1768         }
1769
1770         AST_RWLIST_UNLOCK(&users);
1771
1772         ast_cli(a->fd,"-------------------\n"
1773                       "%d manager users configured.\n", count_amu);
1774         return CLI_SUCCESS;
1775 }
1776
1777 /*! \brief  CLI command  manager list commands */
1778 static char *handle_showmancmds(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1779 {
1780         struct manager_action *cur;
1781         struct ast_str *authority;
1782 #define HSMC_FORMAT "  %-15.15s  %-15.15s  %-55.55s\n"
1783         switch (cmd) {
1784         case CLI_INIT:
1785                 e->command = "manager show commands";
1786                 e->usage =
1787                         "Usage: manager show commands\n"
1788                         "       Prints a listing of all the available Asterisk manager interface commands.\n";
1789                 return NULL;
1790         case CLI_GENERATE:
1791                 return NULL;
1792         }
1793         authority = ast_str_alloca(80);
1794         ast_cli(a->fd, HSMC_FORMAT, "Action", "Privilege", "Synopsis");
1795         ast_cli(a->fd, HSMC_FORMAT, "------", "---------", "--------");
1796
1797         AST_RWLIST_RDLOCK(&actions);
1798         AST_RWLIST_TRAVERSE(&actions, cur, list) {
1799                 ast_cli(a->fd, HSMC_FORMAT, cur->action, authority_to_str(cur->authority, &authority), cur->synopsis);
1800         }
1801         AST_RWLIST_UNLOCK(&actions);
1802
1803         return CLI_SUCCESS;
1804 }
1805
1806 /*! \brief CLI command manager list connected */
1807 static char *handle_showmanconn(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1808 {
1809         struct mansession_session *session;
1810         time_t now = time(NULL);
1811 #define HSMCONN_FORMAT1 "  %-15.15s  %-55.55s  %-10.10s  %-10.10s  %-8.8s  %-8.8s  %-5.5s  %-5.5s\n"
1812 #define HSMCONN_FORMAT2 "  %-15.15s  %-55.55s  %-10d  %-10d  %-8d  %-8d  %-5.5d  %-5.5d\n"
1813         int count = 0;
1814         struct ao2_iterator i;
1815
1816         switch (cmd) {
1817         case CLI_INIT:
1818                 e->command = "manager show connected";
1819                 e->usage =
1820                         "Usage: manager show connected\n"
1821                         "       Prints a listing of the users that are currently connected to the\n"
1822                         "Asterisk manager interface.\n";
1823                 return NULL;
1824         case CLI_GENERATE:
1825                 return NULL;
1826         }
1827
1828         ast_cli(a->fd, HSMCONN_FORMAT1, "Username", "IP Address", "Start", "Elapsed", "FileDes", "HttpCnt", "Read", "Write");
1829
1830         i = ao2_iterator_init(sessions, 0);
1831         while ((session = ao2_iterator_next(&i))) {
1832                 ao2_lock(session);
1833                 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);
1834                 count++;
1835                 ao2_unlock(session);
1836                 unref_mansession(session);
1837         }
1838         ao2_iterator_destroy(&i);
1839         ast_cli(a->fd, "%d users connected.\n", count);
1840
1841         return CLI_SUCCESS;
1842 }
1843
1844 /*! \brief CLI command manager list eventq */
1845 /* Should change to "manager show connected" */
1846 static char *handle_showmaneventq(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1847 {
1848         struct eventqent *s;
1849         switch (cmd) {
1850         case CLI_INIT:
1851                 e->command = "manager show eventq";
1852                 e->usage =
1853                         "Usage: manager show eventq\n"
1854                         "       Prints a listing of all events pending in the Asterisk manger\n"
1855                         "event queue.\n";
1856                 return NULL;
1857         case CLI_GENERATE:
1858                 return NULL;
1859         }
1860         AST_RWLIST_RDLOCK(&all_events);
1861         AST_RWLIST_TRAVERSE(&all_events, s, eq_next) {
1862                 ast_cli(a->fd, "Usecount: %d\n", s->usecount);
1863                 ast_cli(a->fd, "Category: %d\n", s->category);
1864                 ast_cli(a->fd, "Event:\n%s", s->eventdata);
1865         }
1866         AST_RWLIST_UNLOCK(&all_events);
1867
1868         return CLI_SUCCESS;
1869 }
1870
1871 /*! \brief CLI command manager reload */
1872 static char *handle_manager_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1873 {
1874         switch (cmd) {
1875         case CLI_INIT:
1876                 e->command = "manager reload";
1877                 e->usage =
1878                         "Usage: manager reload\n"
1879                         "       Reloads the manager configuration.\n";
1880                 return NULL;
1881         case CLI_GENERATE:
1882                 return NULL;
1883         }
1884         if (a->argc > 2) {
1885                 return CLI_SHOWUSAGE;
1886         }
1887         reload_manager();
1888         return CLI_SUCCESS;
1889 }
1890
1891 static struct eventqent *advance_event(struct eventqent *e)
1892 {
1893         struct eventqent *next;
1894
1895         AST_RWLIST_RDLOCK(&all_events);
1896         if ((next = AST_RWLIST_NEXT(e, eq_next))) {
1897                 ast_atomic_fetchadd_int(&next->usecount, 1);
1898                 ast_atomic_fetchadd_int(&e->usecount, -1);
1899         }
1900         AST_RWLIST_UNLOCK(&all_events);
1901         return next;
1902 }
1903
1904 #define GET_HEADER_FIRST_MATCH  0
1905 #define GET_HEADER_LAST_MATCH   1
1906 #define GET_HEADER_SKIP_EMPTY   2
1907
1908 /*!
1909  * \brief Return a matching header value.
1910  *
1911  * \details
1912  * Generic function to return either the first or the last
1913  * matching header from a list of variables, possibly skipping
1914  * empty strings.
1915  *
1916  * \note At the moment there is only one use of this function in
1917  * this file, so we make it static.
1918  *
1919  * \note Never returns NULL.
1920  */
1921 static const char *__astman_get_header(const struct message *m, char *var, int mode)
1922 {
1923         int x, l = strlen(var);
1924         const char *result = "";
1925
1926         for (x = 0; x < m->hdrcount; x++) {
1927                 const char *h = m->headers[x];
1928                 if (!strncasecmp(var, h, l) && h[l] == ':') {
1929                         const char *value = h + l + 1;
1930                         value = ast_skip_blanks(value); /* ignore leading spaces in the value */
1931                         /* found a potential candidate */
1932                         if ((mode & GET_HEADER_SKIP_EMPTY) && ast_strlen_zero(value)) {
1933                                 continue;       /* not interesting */
1934                         }
1935                         if (mode & GET_HEADER_LAST_MATCH) {
1936                                 result = value; /* record the last match so far */
1937                         } else {
1938                                 return value;
1939                         }
1940                 }
1941         }
1942
1943         return result;
1944 }
1945
1946 /*!
1947  * \brief Return the first matching variable from an array.
1948  *
1949  * \note This is the legacy function and is implemented in
1950  * therms of __astman_get_header().
1951  *
1952  * \note Never returns NULL.
1953  */
1954 const char *astman_get_header(const struct message *m, char *var)
1955 {
1956         return __astman_get_header(m, var, GET_HEADER_FIRST_MATCH);
1957 }
1958
1959 /*!
1960  * \internal
1961  * \brief Process one "Variable:" header value string.
1962  *
1963  * \param head Current list of AMI variables to get new values added.
1964  * \param hdr_val Header value string to process.
1965  *
1966  * \return New variable list head.
1967  */
1968 static struct ast_variable *man_do_variable_value(struct ast_variable *head, const char *hdr_val)
1969 {
1970         char *parse;
1971         AST_DECLARE_APP_ARGS(args,
1972                 AST_APP_ARG(vars)[64];
1973         );
1974
1975         hdr_val = ast_skip_blanks(hdr_val); /* ignore leading spaces in the value */
1976         parse = ast_strdupa(hdr_val);
1977
1978         /* Break the header value string into name=val pair items. */
1979         AST_STANDARD_APP_ARGS(args, parse);
1980         if (args.argc) {
1981                 int y;
1982
1983                 /* Process each name=val pair item. */
1984                 for (y = 0; y < args.argc; y++) {
1985                         struct ast_variable *cur;
1986                         char *var;
1987                         char *val;
1988
1989                         if (!args.vars[y]) {
1990                                 continue;
1991                         }
1992                         var = val = args.vars[y];
1993                         strsep(&val, "=");
1994
1995                         /* XXX We may wish to trim whitespace from the strings. */
1996                         if (!val || ast_strlen_zero(var)) {
1997                                 continue;
1998                         }
1999
2000                         /* Create new variable list node and prepend it to the list. */
2001                         cur = ast_variable_new(var, val, "");
2002                         if (cur) {
2003                                 cur->next = head;
2004                                 head = cur;
2005                         }
2006                 }
2007         }
2008
2009         return head;
2010 }
2011
2012 struct ast_variable *astman_get_variables(const struct message *m)
2013 {
2014         int varlen;
2015         int x;
2016         struct ast_variable *head = NULL;
2017
2018         static const char var_hdr[] = "Variable:";
2019
2020         /* Process all "Variable:" headers. */
2021         varlen = strlen(var_hdr);
2022         for (x = 0; x < m->hdrcount; x++) {
2023                 if (strncasecmp(var_hdr, m->headers[x], varlen)) {
2024                         continue;
2025                 }
2026                 head = man_do_variable_value(head, m->headers[x] + varlen);
2027         }
2028
2029         return head;
2030 }
2031
2032 /*! \brief access for hooks to send action messages to ami */
2033 int ast_hook_send_action(struct manager_custom_hook *hook, const char *msg)
2034 {
2035         const char *action;
2036         int ret = 0;
2037         struct manager_action *act_found;
2038         struct mansession s = {.session = NULL, };
2039         struct message m = { 0 };
2040         char *dup_str;
2041         char *src;
2042         int x = 0;
2043         int curlen;
2044
2045         if (hook == NULL) {
2046                 return -1;
2047         }
2048
2049         /* Create our own copy of the AMI action msg string. */
2050         src = dup_str = ast_strdup(msg);
2051         if (!dup_str) {
2052                 return -1;
2053         }
2054
2055         /* convert msg string to message struct */
2056         curlen = strlen(src);
2057         for (x = 0; x < curlen; x++) {
2058                 int cr; /* set if we have \r */
2059                 if (src[x] == '\r' && x+1 < curlen && src[x+1] == '\n')
2060                         cr = 2; /* Found. Update length to include \r\n */
2061                 else if (src[x] == '\n')
2062                         cr = 1; /* also accept \n only */
2063                 else
2064                         continue;
2065                 /* don't keep empty lines */
2066                 if (x && m.hdrcount < ARRAY_LEN(m.headers)) {
2067                         /* ... but trim \r\n and terminate the header string */
2068                         src[x] = '\0';
2069                         m.headers[m.hdrcount++] = src;
2070                 }
2071                 x += cr;
2072                 curlen -= x;            /* remaining size */
2073                 src += x;               /* update pointer */
2074                 x = -1;                 /* reset loop */
2075         }
2076
2077         action = astman_get_header(&m, "Action");
2078         if (strcasecmp(action, "login")) {
2079                 act_found = action_find(action);
2080                 if (act_found) {
2081                         /*
2082                          * we have to simulate a session for this action request
2083                          * to be able to pass it down for processing
2084                          * This is necessary to meet the previous design of manager.c
2085                          */
2086                         s.hook = hook;
2087                         s.f = (void*)1; /* set this to something so our request will make it through all functions that test it*/
2088
2089                         ao2_lock(act_found);
2090                         if (act_found->registered && act_found->func) {
2091                                 if (act_found->module) {
2092                                         ast_module_ref(act_found->module);
2093                                 }
2094                                 ao2_unlock(act_found);
2095                                 ret = act_found->func(&s, &m);
2096                                 ao2_lock(act_found);
2097                                 if (act_found->module) {
2098                                         ast_module_unref(act_found->module);
2099                                 }
2100                         } else {
2101                                 ret = -1;
2102                         }
2103                         ao2_unlock(act_found);
2104                         ao2_t_ref(act_found, -1, "done with found action object");
2105                 }
2106         }
2107         ast_free(dup_str);
2108         return ret;
2109 }
2110
2111
2112 /*!
2113  * helper function to send a string to the socket.
2114  * Return -1 on error (e.g. buffer full).
2115  */
2116 static int send_string(struct mansession *s, char *string)
2117 {
2118         int res;
2119         FILE *f = s->f ? s->f : s->session->f;
2120         int fd = s->f ? s->fd : s->session->fd;
2121
2122         /* It's a result from one of the hook's action invocation */
2123         if (s->hook) {
2124                 /*
2125                  * to send responses, we're using the same function
2126                  * as for receiving events. We call the event "HookResponse"
2127                  */
2128                 s->hook->helper(EVENT_FLAG_HOOKRESPONSE, "HookResponse", string);
2129                 return 0;
2130         }
2131
2132         if ((res = ast_careful_fwrite(f, fd, string, strlen(string), s->session->writetimeout))) {
2133                 s->write_error = 1;
2134         }
2135
2136         return res;
2137 }
2138
2139 /*!
2140  * \brief thread local buffer for astman_append
2141  *
2142  * \note This can not be defined within the astman_append() function
2143  *       because it declares a couple of functions that get used to
2144  *       initialize the thread local storage key.
2145  */
2146 AST_THREADSTORAGE(astman_append_buf);
2147
2148 AST_THREADSTORAGE(userevent_buf);
2149
2150 /*! \brief initial allocated size for the astman_append_buf and astman_send_*_va */
2151 #define ASTMAN_APPEND_BUF_INITSIZE   256
2152
2153 /*!
2154  * utility functions for creating AMI replies
2155  */
2156 void astman_append(struct mansession *s, const char *fmt, ...)
2157 {
2158         va_list ap;
2159         struct ast_str *buf;
2160
2161         if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
2162                 return;
2163         }
2164
2165         va_start(ap, fmt);
2166         ast_str_set_va(&buf, 0, fmt, ap);
2167         va_end(ap);
2168
2169         if (s->f != NULL || s->session->f != NULL) {
2170                 send_string(s, ast_str_buffer(buf));
2171         } else {
2172                 ast_verbose("fd == -1 in astman_append, should not happen\n");
2173         }
2174 }
2175
2176 /*! \note NOTE: XXX this comment is unclear and possibly wrong.
2177    Callers of astman_send_error(), astman_send_response() or astman_send_ack() must EITHER
2178    hold the session lock _or_ be running in an action callback (in which case s->session->busy will
2179    be non-zero). In either of these cases, there is no need to lock-protect the session's
2180    fd, since no other output will be sent (events will be queued), and no input will
2181    be read until either the current action finishes or get_input() obtains the session
2182    lock.
2183  */
2184
2185 /*! \todo XXX MSG_MOREDATA should go to a header file. */
2186 #define MSG_MOREDATA    ((char *)astman_send_response)
2187
2188 /*! \brief send a response with an optional message,
2189  * and terminate it with an empty line.
2190  * m is used only to grab the 'ActionID' field.
2191  *
2192  * Use the explicit constant MSG_MOREDATA to remove the empty line.
2193  * XXX MSG_MOREDATA should go to a header file.
2194  */
2195 static void astman_send_response_full(struct mansession *s, const struct message *m, char *resp, char *msg, char *listflag)
2196 {
2197         const char *id = astman_get_header(m, "ActionID");
2198
2199         astman_append(s, "Response: %s\r\n", resp);
2200         if (!ast_strlen_zero(id)) {
2201                 astman_append(s, "ActionID: %s\r\n", id);
2202         }
2203         if (listflag) {
2204                 astman_append(s, "EventList: %s\r\n", listflag);        /* Start, complete, cancelled */
2205         }
2206         if (msg == MSG_MOREDATA) {
2207                 return;
2208         } else if (msg) {
2209                 astman_append(s, "Message: %s\r\n\r\n", msg);
2210         } else {
2211                 astman_append(s, "\r\n");
2212         }
2213 }
2214
2215 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg)
2216 {
2217         astman_send_response_full(s, m, resp, msg, NULL);
2218 }
2219
2220 void astman_send_error(struct mansession *s, const struct message *m, char *error)
2221 {
2222         astman_send_response_full(s, m, "Error", error, NULL);
2223 }
2224
2225 void astman_send_error_va(struct mansession *s, const struct message *m, const char *fmt, ...)
2226 {
2227         va_list ap;
2228         struct ast_str *buf;
2229
2230         if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
2231                 return;
2232         }
2233
2234         va_start(ap, fmt);
2235         ast_str_set_va(&buf, 0, fmt, ap);
2236         va_end(ap);
2237
2238         astman_send_response_full(s, m, "Error", ast_str_buffer(buf), NULL);
2239         ast_free(buf);
2240 }
2241
2242 void astman_send_ack(struct mansession *s, const struct message *m, char *msg)
2243 {
2244         astman_send_response_full(s, m, "Success", msg, NULL);
2245 }
2246
2247 static void astman_start_ack(struct mansession *s, const struct message *m)
2248 {
2249         astman_send_response_full(s, m, "Success", MSG_MOREDATA, NULL);
2250 }
2251
2252 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag)
2253 {
2254         astman_send_response_full(s, m, "Success", msg, listflag);
2255 }
2256
2257 /*! \brief Lock the 'mansession' structure. */
2258 static void mansession_lock(struct mansession *s)
2259 {
2260         ast_mutex_lock(&s->lock);
2261 }
2262
2263 /*! \brief Unlock the 'mansession' structure. */
2264 static void mansession_unlock(struct mansession *s)
2265 {
2266         ast_mutex_unlock(&s->lock);
2267 }
2268
2269 /*! \brief
2270    Rather than braindead on,off this now can also accept a specific int mask value
2271    or a ',' delim list of mask strings (the same as manager.conf) -anthm
2272 */
2273 static int set_eventmask(struct mansession *s, const char *eventmask)
2274 {
2275         int maskint = strings_to_mask(eventmask);
2276
2277         ao2_lock(s->session);
2278         if (maskint >= 0) {
2279                 s->session->send_events = maskint;
2280         }
2281         ao2_unlock(s->session);
2282
2283         return maskint;
2284 }
2285
2286 static enum ast_security_event_transport_type mansession_get_transport(const struct mansession *s)
2287 {
2288         return s->tcptls_session->parent->tls_cfg ? AST_SECURITY_EVENT_TRANSPORT_TLS :
2289                         AST_SECURITY_EVENT_TRANSPORT_TCP;
2290 }
2291
2292 static void report_invalid_user(const struct mansession *s, const char *username)
2293 {
2294         char session_id[32];
2295         struct ast_security_event_inval_acct_id inval_acct_id = {
2296                 .common.event_type = AST_SECURITY_EVENT_INVAL_ACCT_ID,
2297                 .common.version    = AST_SECURITY_EVENT_INVAL_ACCT_ID_VERSION,
2298                 .common.service    = "AMI",
2299                 .common.account_id = username,
2300                 .common.session_tv = &s->session->sessionstart_tv,
2301                 .common.local_addr = {
2302                         .addr      = &s->tcptls_session->parent->local_address,
2303                         .transport = mansession_get_transport(s),
2304                 },
2305                 .common.remote_addr = {
2306                         .addr      = &s->session->addr,
2307                         .transport = mansession_get_transport(s),
2308                 },
2309                 .common.session_id = session_id,
2310         };
2311
2312         snprintf(session_id, sizeof(session_id), "%p", s);
2313
2314         ast_security_event_report(AST_SEC_EVT(&inval_acct_id));
2315 }
2316
2317 static void report_failed_acl(const struct mansession *s, const char *username)
2318 {
2319         char session_id[32];
2320         struct ast_security_event_failed_acl failed_acl_event = {
2321                 .common.event_type = AST_SECURITY_EVENT_FAILED_ACL,
2322                 .common.version    = AST_SECURITY_EVENT_FAILED_ACL_VERSION,
2323                 .common.service    = "AMI",
2324                 .common.account_id = username,
2325                 .common.session_tv = &s->session->sessionstart_tv,
2326                 .common.local_addr = {
2327                         .addr      = &s->tcptls_session->parent->local_address,
2328                         .transport = mansession_get_transport(s),
2329                 },
2330                 .common.remote_addr = {
2331                         .addr      = &s->session->addr,
2332                         .transport = mansession_get_transport(s),
2333                 },
2334                 .common.session_id = session_id,
2335         };
2336
2337         snprintf(session_id, sizeof(session_id), "%p", s->session);
2338
2339         ast_security_event_report(AST_SEC_EVT(&failed_acl_event));
2340 }
2341
2342 static void report_inval_password(const struct mansession *s, const char *username)
2343 {
2344         char session_id[32];
2345         struct ast_security_event_inval_password inval_password = {
2346                 .common.event_type = AST_SECURITY_EVENT_INVAL_PASSWORD,
2347                 .common.version    = AST_SECURITY_EVENT_INVAL_PASSWORD_VERSION,
2348                 .common.service    = "AMI",
2349                 .common.account_id = username,
2350                 .common.session_tv = &s->session->sessionstart_tv,
2351                 .common.local_addr = {
2352                         .addr      = &s->tcptls_session->parent->local_address,
2353                         .transport = mansession_get_transport(s),
2354                 },
2355                 .common.remote_addr = {
2356                         .addr      = &s->session->addr,
2357                         .transport = mansession_get_transport(s),
2358                 },
2359                 .common.session_id = session_id,
2360         };
2361
2362         snprintf(session_id, sizeof(session_id), "%p", s->session);
2363
2364         ast_security_event_report(AST_SEC_EVT(&inval_password));
2365 }
2366
2367 static void report_auth_success(const struct mansession *s)
2368 {
2369         char session_id[32];
2370         struct ast_security_event_successful_auth successful_auth = {
2371                 .common.event_type = AST_SECURITY_EVENT_SUCCESSFUL_AUTH,
2372                 .common.version    = AST_SECURITY_EVENT_SUCCESSFUL_AUTH_VERSION,
2373                 .common.service    = "AMI",
2374                 .common.account_id = s->session->username,
2375                 .common.session_tv = &s->session->sessionstart_tv,
2376                 .common.local_addr = {
2377                         .addr      = &s->tcptls_session->parent->local_address,
2378                         .transport = mansession_get_transport(s),
2379                 },
2380                 .common.remote_addr = {
2381                         .addr      = &s->session->addr,
2382                         .transport = mansession_get_transport(s),
2383                 },
2384                 .common.session_id = session_id,
2385         };
2386
2387         snprintf(session_id, sizeof(session_id), "%p", s->session);
2388
2389         ast_security_event_report(AST_SEC_EVT(&successful_auth));
2390 }
2391
2392 static void report_req_not_allowed(const struct mansession *s, const char *action)
2393 {
2394         char session_id[32];
2395         char request_type[64];
2396         struct ast_security_event_req_not_allowed req_not_allowed = {
2397                 .common.event_type = AST_SECURITY_EVENT_REQ_NOT_ALLOWED,
2398                 .common.version    = AST_SECURITY_EVENT_REQ_NOT_ALLOWED_VERSION,
2399                 .common.service    = "AMI",
2400                 .common.account_id = s->session->username,
2401                 .common.session_tv = &s->session->sessionstart_tv,
2402                 .common.local_addr = {
2403                         .addr      = &s->tcptls_session->parent->local_address,
2404                         .transport = mansession_get_transport(s),
2405                 },
2406                 .common.remote_addr = {
2407                         .addr      = &s->session->addr,
2408                         .transport = mansession_get_transport(s),
2409                 },
2410                 .common.session_id = session_id,
2411
2412                 .request_type      = request_type,
2413         };
2414
2415         snprintf(session_id, sizeof(session_id), "%p", s->session);
2416         snprintf(request_type, sizeof(request_type), "Action: %s", action);
2417
2418         ast_security_event_report(AST_SEC_EVT(&req_not_allowed));
2419 }
2420
2421 static void report_req_bad_format(const struct mansession *s, const char *action)
2422 {
2423         char session_id[32];
2424         char request_type[64];
2425         struct ast_security_event_req_bad_format req_bad_format = {
2426                 .common.event_type = AST_SECURITY_EVENT_REQ_BAD_FORMAT,
2427                 .common.version    = AST_SECURITY_EVENT_REQ_BAD_FORMAT_VERSION,
2428                 .common.service    = "AMI",
2429                 .common.account_id = s->session->username,
2430                 .common.session_tv = &s->session->sessionstart_tv,
2431                 .common.local_addr = {
2432                         .addr      = &s->tcptls_session->parent->local_address,
2433                         .transport = mansession_get_transport(s),
2434                 },
2435                 .common.remote_addr = {
2436                         .addr      = &s->session->addr,
2437                         .transport = mansession_get_transport(s),
2438                 },
2439                 .common.session_id = session_id,
2440
2441                 .request_type      = request_type,
2442         };
2443
2444         snprintf(session_id, sizeof(session_id), "%p", s->session);
2445         snprintf(request_type, sizeof(request_type), "Action: %s", action);
2446
2447         ast_security_event_report(AST_SEC_EVT(&req_bad_format));
2448 }
2449
2450 static void report_failed_challenge_response(const struct mansession *s,
2451                 const char *response, const char *expected_response)
2452 {
2453         char session_id[32];
2454         struct ast_security_event_chal_resp_failed chal_resp_failed = {
2455                 .common.event_type = AST_SECURITY_EVENT_CHAL_RESP_FAILED,
2456                 .common.version    = AST_SECURITY_EVENT_CHAL_RESP_FAILED_VERSION,
2457                 .common.service    = "AMI",
2458                 .common.account_id = s->session->username,
2459                 .common.session_tv = &s->session->sessionstart_tv,
2460                 .common.local_addr = {
2461                         .addr      = &s->tcptls_session->parent->local_address,
2462                         .transport = mansession_get_transport(s),
2463                 },
2464                 .common.remote_addr = {
2465                         .addr      = &s->session->addr,
2466                         .transport = mansession_get_transport(s),
2467                 },
2468                 .common.session_id = session_id,
2469
2470                 .challenge         = s->session->challenge,
2471                 .response          = response,
2472                 .expected_response = expected_response,
2473         };
2474
2475         snprintf(session_id, sizeof(session_id), "%p", s->session);
2476
2477         ast_security_event_report(AST_SEC_EVT(&chal_resp_failed));
2478 }
2479
2480 static void report_session_limit(const struct mansession *s)
2481 {
2482         char session_id[32];
2483         struct ast_security_event_session_limit session_limit = {
2484                 .common.event_type = AST_SECURITY_EVENT_SESSION_LIMIT,
2485                 .common.version    = AST_SECURITY_EVENT_SESSION_LIMIT_VERSION,
2486                 .common.service    = "AMI",
2487                 .common.account_id = s->session->username,
2488                 .common.session_tv = &s->session->sessionstart_tv,
2489                 .common.local_addr = {
2490                         .addr      = &s->tcptls_session->parent->local_address,
2491                         .transport = mansession_get_transport(s),
2492                 },
2493                 .common.remote_addr = {
2494                         .addr      = &s->session->addr,
2495                         .transport = mansession_get_transport(s),
2496                 },
2497                 .common.session_id = session_id,
2498         };
2499
2500         snprintf(session_id, sizeof(session_id), "%p", s->session);
2501
2502         ast_security_event_report(AST_SEC_EVT(&session_limit));
2503 }
2504
2505 /*
2506  * Here we start with action_ handlers for AMI actions,
2507  * and the internal functions used by them.
2508  * Generally, the handlers are called action_foo()
2509  */
2510
2511 /* helper function for action_login() */
2512 static int authenticate(struct mansession *s, const struct message *m)
2513 {
2514         const char *username = astman_get_header(m, "Username");
2515         const char *password = astman_get_header(m, "Secret");
2516         int error = -1;
2517         struct ast_manager_user *user = NULL;
2518         regex_t *regex_filter;
2519         struct ao2_iterator filter_iter;
2520
2521         if (ast_strlen_zero(username)) {        /* missing username */
2522                 return -1;
2523         }
2524
2525         /* locate user in locked state */
2526         AST_RWLIST_WRLOCK(&users);
2527
2528         if (!(user = get_manager_by_name_locked(username))) {
2529                 report_invalid_user(s, username);
2530                 ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2531         } else if (user->acl && (ast_apply_acl(user->acl, &s->session->addr, "Manager User ACL: ") == AST_SENSE_DENY)) {
2532                 report_failed_acl(s, username);
2533                 ast_log(LOG_NOTICE, "%s failed to pass IP ACL as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2534         } else if (!strcasecmp(astman_get_header(m, "AuthType"), "MD5")) {
2535                 const char *key = astman_get_header(m, "Key");
2536                 if (!ast_strlen_zero(key) && !ast_strlen_zero(s->session->challenge) && user->secret) {
2537                         int x;
2538                         int len = 0;
2539                         char md5key[256] = "";
2540                         struct MD5Context md5;
2541                         unsigned char digest[16];
2542
2543                         MD5Init(&md5);
2544                         MD5Update(&md5, (unsigned char *) s->session->challenge, strlen(s->session->challenge));
2545                         MD5Update(&md5, (unsigned char *) user->secret, strlen(user->secret));
2546                         MD5Final(digest, &md5);
2547                         for (x = 0; x < 16; x++)
2548                                 len += sprintf(md5key + len, "%2.2x", digest[x]);
2549                         if (!strcmp(md5key, key)) {
2550                                 error = 0;
2551                         } else {
2552                                 report_failed_challenge_response(s, key, md5key);
2553                         }
2554                 } else {
2555                         ast_debug(1, "MD5 authentication is not possible.  challenge: '%s'\n",
2556                                 S_OR(s->session->challenge, ""));
2557                 }
2558         } else if (user->secret) {
2559                 if (!strcmp(password, user->secret)) {
2560                         error = 0;
2561                 } else {
2562                         report_inval_password(s, username);
2563                 }
2564         }
2565
2566         if (error) {
2567                 ast_log(LOG_NOTICE, "%s failed to authenticate as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2568                 AST_RWLIST_UNLOCK(&users);
2569                 return -1;
2570         }
2571
2572         /* auth complete */
2573
2574         /* All of the user parameters are copied to the session so that in the event
2575         * of a reload and a configuration change, the session parameters are not
2576         * changed. */
2577         ast_copy_string(s->session->username, username, sizeof(s->session->username));
2578         s->session->readperm = user->readperm;
2579         s->session->writeperm = user->writeperm;
2580         s->session->writetimeout = user->writetimeout;
2581         if (user->chanvars) {
2582                 s->session->chanvars = ast_variables_dup(user->chanvars);
2583         }
2584
2585         filter_iter = ao2_iterator_init(user->whitefilters, 0);
2586         while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2587                 ao2_t_link(s->session->whitefilters, regex_filter, "add white user filter to session");
2588                 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2589         }
2590         ao2_iterator_destroy(&filter_iter);
2591
2592         filter_iter = ao2_iterator_init(user->blackfilters, 0);
2593         while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2594                 ao2_t_link(s->session->blackfilters, regex_filter, "add black user filter to session");
2595                 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2596         }
2597         ao2_iterator_destroy(&filter_iter);
2598
2599         s->session->sessionstart = time(NULL);
2600         s->session->sessionstart_tv = ast_tvnow();
2601         set_eventmask(s, astman_get_header(m, "Events"));
2602
2603         report_auth_success(s);
2604
2605         AST_RWLIST_UNLOCK(&users);
2606         return 0;
2607 }
2608
2609 static int action_ping(struct mansession *s, const struct message *m)
2610 {
2611         const char *actionid = astman_get_header(m, "ActionID");
2612         struct timeval now = ast_tvnow();
2613
2614         astman_append(s, "Response: Success\r\n");
2615         if (!ast_strlen_zero(actionid)){
2616                 astman_append(s, "ActionID: %s\r\n", actionid);
2617         }
2618         astman_append(
2619                 s,
2620                 "Ping: Pong\r\n"
2621                 "Timestamp: %ld.%06lu\r\n"
2622                 "\r\n",
2623                 (long) now.tv_sec, (unsigned long) now.tv_usec);
2624         return 0;
2625 }
2626
2627 static int action_getconfig(struct mansession *s, const struct message *m)
2628 {
2629         struct ast_config *cfg;
2630         const char *fn = astman_get_header(m, "Filename");
2631         const char *category = astman_get_header(m, "Category");
2632         int catcount = 0;
2633         int lineno = 0;
2634         char *cur_category = NULL;
2635         struct ast_variable *v;
2636         struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2637
2638         if (ast_strlen_zero(fn)) {
2639                 astman_send_error(s, m, "Filename not specified");
2640                 return 0;
2641         }
2642         cfg = ast_config_load2(fn, "manager", config_flags);
2643         if (cfg == CONFIG_STATUS_FILEMISSING) {
2644                 astman_send_error(s, m, "Config file not found");
2645                 return 0;
2646         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2647                 astman_send_error(s, m, "Config file has invalid format");
2648                 return 0;
2649         }
2650
2651         astman_start_ack(s, m);
2652         while ((cur_category = ast_category_browse(cfg, cur_category))) {
2653                 if (ast_strlen_zero(category) || (!ast_strlen_zero(category) && !strcmp(category, cur_category))) {
2654                         lineno = 0;
2655                         astman_append(s, "Category-%06d: %s\r\n", catcount, cur_category);
2656                         for (v = ast_variable_browse(cfg, cur_category); v; v = v->next) {
2657                                 astman_append(s, "Line-%06d-%06d: %s=%s\r\n", catcount, lineno++, v->name, v->value);
2658                         }
2659                         catcount++;
2660                 }
2661         }
2662         if (!ast_strlen_zero(category) && catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
2663                 astman_append(s, "No categories found\r\n");
2664         }
2665         ast_config_destroy(cfg);
2666         astman_append(s, "\r\n");
2667
2668         return 0;
2669 }
2670
2671 static int action_listcategories(struct mansession *s, const struct message *m)
2672 {
2673         struct ast_config *cfg;
2674         const char *fn = astman_get_header(m, "Filename");
2675         char *category = NULL;
2676         struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2677         int catcount = 0;
2678
2679         if (ast_strlen_zero(fn)) {
2680                 astman_send_error(s, m, "Filename not specified");
2681                 return 0;
2682         }
2683         if (!(cfg = ast_config_load2(fn, "manager", config_flags))) {
2684                 astman_send_error(s, m, "Config file not found");
2685                 return 0;
2686         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2687                 astman_send_error(s, m, "Config file has invalid format");
2688                 return 0;
2689         }
2690         astman_start_ack(s, m);
2691         while ((category = ast_category_browse(cfg, category))) {
2692                 astman_append(s, "Category-%06d: %s\r\n", catcount, category);
2693                 catcount++;
2694         }
2695         if (catcount == 0) { /* TODO: actually, a config with no categories doesn't even get loaded */
2696                 astman_append(s, "Error: no categories found\r\n");
2697         }
2698         ast_config_destroy(cfg);
2699         astman_append(s, "\r\n");
2700
2701         return 0;
2702 }
2703
2704
2705
2706
2707 /*! The amount of space in out must be at least ( 2 * strlen(in) + 1 ) */
2708 static void json_escape(char *out, const char *in)
2709 {
2710         for (; *in; in++) {
2711                 if (*in == '\\' || *in == '\"') {
2712                         *out++ = '\\';
2713                 }
2714                 *out++ = *in;
2715         }
2716         *out = '\0';
2717 }
2718
2719 /*!
2720  * \internal
2721  * \brief Append a JSON escaped string to the manager stream.
2722  *
2723  * \param s AMI stream to append a string.
2724  * \param str String to append to the stream after JSON escaping it.
2725  *
2726  * \return Nothing
2727  */
2728 static void astman_append_json(struct mansession *s, const char *str)
2729 {
2730         char *buf;
2731
2732         buf = ast_alloca(2 * strlen(str) + 1);
2733         json_escape(buf, str);
2734         astman_append(s, "%s", buf);
2735 }
2736
2737 static int action_getconfigjson(struct mansession *s, const struct message *m)
2738 {
2739         struct ast_config *cfg;
2740         const char *fn = astman_get_header(m, "Filename");
2741         char *category = NULL;
2742         struct ast_variable *v;
2743         int comma1 = 0;
2744         struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2745
2746         if (ast_strlen_zero(fn)) {
2747                 astman_send_error(s, m, "Filename not specified");
2748                 return 0;
2749         }
2750
2751         if (!(cfg = ast_config_load2(fn, "manager", config_flags))) {
2752                 astman_send_error(s, m, "Config file not found");
2753                 return 0;
2754         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2755                 astman_send_error(s, m, "Config file has invalid format");
2756                 return 0;
2757         }
2758
2759         astman_start_ack(s, m);
2760         astman_append(s, "JSON: {");
2761         while ((category = ast_category_browse(cfg, category))) {
2762                 int comma2 = 0;
2763
2764                 astman_append(s, "%s\"", comma1 ? "," : "");
2765                 astman_append_json(s, category);
2766                 astman_append(s, "\":[");
2767                 comma1 = 1;
2768                 for (v = ast_variable_browse(cfg, category); v; v = v->next) {
2769                         astman_append(s, "%s\"", comma2 ? "," : "");
2770                         astman_append_json(s, v->name);
2771                         astman_append(s, "\":\"");
2772                         astman_append_json(s, v->value);
2773                         astman_append(s, "\"");
2774                         comma2 = 1;
2775                 }
2776                 astman_append(s, "]");
2777         }
2778         astman_append(s, "}\r\n\r\n");
2779
2780         ast_config_destroy(cfg);
2781
2782         return 0;
2783 }
2784
2785 /*! \brief helper function for action_updateconfig */
2786 static enum error_type handle_updates(struct mansession *s, const struct message *m, struct ast_config *cfg, const char *dfn)
2787 {
2788         int x;
2789         char hdr[40];
2790         const char *action, *cat, *var, *value, *match, *line;
2791         struct ast_category *category;
2792         struct ast_variable *v;
2793         struct ast_str *str1 = ast_str_create(16), *str2 = ast_str_create(16);
2794         enum error_type result = 0;
2795
2796         for (x = 0; x < 100000; x++) {  /* 100000 = the max number of allowed updates + 1 */
2797                 unsigned int object = 0;
2798
2799                 snprintf(hdr, sizeof(hdr), "Action-%06d", x);
2800                 action = astman_get_header(m, hdr);
2801                 if (ast_strlen_zero(action))            /* breaks the for loop if no action header */
2802                         break;                          /* this could cause problems if actions come in misnumbered */
2803
2804                 snprintf(hdr, sizeof(hdr), "Cat-%06d", x);
2805                 cat = astman_get_header(m, hdr);
2806                 if (ast_strlen_zero(cat)) {             /* every action needs a category */
2807                         result =  UNSPECIFIED_CATEGORY;
2808                         break;
2809                 }
2810
2811                 snprintf(hdr, sizeof(hdr), "Var-%06d", x);
2812                 var = astman_get_header(m, hdr);
2813
2814                 snprintf(hdr, sizeof(hdr), "Value-%06d", x);
2815                 value = astman_get_header(m, hdr);
2816
2817                 if (!ast_strlen_zero(value) && *value == '>') {
2818                         object = 1;
2819                         value++;
2820                 }
2821
2822                 snprintf(hdr, sizeof(hdr), "Match-%06d", x);
2823                 match = astman_get_header(m, hdr);
2824
2825                 snprintf(hdr, sizeof(hdr), "Line-%06d", x);
2826                 line = astman_get_header(m, hdr);
2827
2828                 if (!strcasecmp(action, "newcat")) {
2829                         if (ast_category_get(cfg,cat)) {        /* check to make sure the cat doesn't */
2830                                 result = FAILURE_NEWCAT;        /* already exist */
2831                                 break;
2832                         }
2833                         if (!(category = ast_category_new(cat, dfn, -1))) {
2834                                 result = FAILURE_ALLOCATION;
2835                                 break;
2836                         }
2837                         if (ast_strlen_zero(match)) {
2838                                 ast_category_append(cfg, category);
2839                         } else {
2840                                 ast_category_insert(cfg, category, match);
2841                         }
2842                 } else if (!strcasecmp(action, "renamecat")) {
2843                         if (ast_strlen_zero(value)) {
2844                                 result = UNSPECIFIED_ARGUMENT;
2845                                 break;
2846                         }
2847                         if (!(category = ast_category_get(cfg, cat))) {
2848                                 result = UNKNOWN_CATEGORY;
2849                                 break;
2850                         }
2851                         ast_category_rename(category, value);
2852                 } else if (!strcasecmp(action, "delcat")) {
2853                         if (ast_category_delete(cfg, cat)) {
2854                                 result = FAILURE_DELCAT;
2855                                 break;
2856                         }
2857                 } else if (!strcasecmp(action, "emptycat")) {
2858                         if (ast_category_empty(cfg, cat)) {
2859                                 result = FAILURE_EMPTYCAT;
2860                                 break;
2861                         }
2862                 } else if (!strcasecmp(action, "update")) {
2863                         if (ast_strlen_zero(var)) {
2864                                 result = UNSPECIFIED_ARGUMENT;
2865                                 break;
2866                         }
2867                         if (!(category = ast_category_get(cfg,cat))) {
2868                                 result = UNKNOWN_CATEGORY;
2869                                 break;
2870                         }
2871                         if (ast_variable_update(category, var, value, match, object)) {
2872                                 result = FAILURE_UPDATE;
2873                                 break;
2874                         }
2875                 } else if (!strcasecmp(action, "delete")) {
2876                         if ((ast_strlen_zero(var) && ast_strlen_zero(line))) {
2877                                 result = UNSPECIFIED_ARGUMENT;
2878                                 break;
2879                         }
2880                         if (!(category = ast_category_get(cfg, cat))) {
2881                                 result = UNKNOWN_CATEGORY;
2882                                 break;
2883                         }
2884                         if (ast_variable_delete(category, var, match, line)) {
2885                                 result = FAILURE_DELETE;
2886                                 break;
2887                         }
2888                 } else if (!strcasecmp(action, "append")) {
2889                         if (ast_strlen_zero(var)) {
2890                                 result = UNSPECIFIED_ARGUMENT;
2891                                 break;
2892                         }
2893                         if (!(category = ast_category_get(cfg, cat))) {
2894                                 result = UNKNOWN_CATEGORY;
2895                                 break;
2896                         }
2897                         if (!(v = ast_variable_new(var, value, dfn))) {
2898                                 result = FAILURE_ALLOCATION;
2899                                 break;
2900                         }
2901                         if (object || (match && !strcasecmp(match, "object"))) {
2902                                 v->object = 1;
2903                         }
2904                         ast_variable_append(category, v);
2905                 } else if (!strcasecmp(action, "insert")) {
2906                         if (ast_strlen_zero(var) || ast_strlen_zero(line)) {
2907                                 result = UNSPECIFIED_ARGUMENT;
2908                                 break;
2909                         }
2910                         if (!(category = ast_category_get(cfg, cat))) {
2911                                 result = UNKNOWN_CATEGORY;
2912                                 break;
2913                         }
2914                         if (!(v = ast_variable_new(var, value, dfn))) {
2915                                 result = FAILURE_ALLOCATION;
2916                                 break;
2917                         }
2918                         ast_variable_insert(category, v, line);
2919                 }
2920                 else {
2921                         ast_log(LOG_WARNING, "Action-%06d: %s not handled\n", x, action);
2922                         result = UNKNOWN_ACTION;
2923                         break;
2924                 }
2925         }
2926         ast_free(str1);
2927         ast_free(str2);
2928         return result;
2929 }
2930
2931 static int action_updateconfig(struct mansession *s, const struct message *m)
2932 {
2933         struct ast_config *cfg;
2934         const char *sfn = astman_get_header(m, "SrcFilename");
2935         const char *dfn = astman_get_header(m, "DstFilename");
2936         int res;
2937         const char *rld = astman_get_header(m, "Reload");
2938         struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
2939         enum error_type result;
2940
2941         if (ast_strlen_zero(sfn) || ast_strlen_zero(dfn)) {
2942                 astman_send_error(s, m, "Filename not specified");
2943                 return 0;
2944         }
2945         if (!(cfg = ast_config_load2(sfn, "manager", config_flags))) {
2946                 astman_send_error(s, m, "Config file not found");
2947                 return 0;
2948         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
2949                 astman_send_error(s, m, "Config file has invalid format");
2950                 return 0;
2951         }
2952         result = handle_updates(s, m, cfg, dfn);
2953         if (!result) {
2954                 ast_include_rename(cfg, sfn, dfn); /* change the include references from dfn to sfn, so things match up */
2955                 res = ast_config_text_file_save(dfn, cfg, "Manager");
2956                 ast_config_destroy(cfg);
2957                 if (res) {
2958                         astman_send_error(s, m, "Save of config failed");
2959                         return 0;
2960                 }
2961                 astman_send_ack(s, m, NULL);
2962                 if (!ast_strlen_zero(rld)) {
2963                         if (ast_true(rld)) {
2964                                 rld = NULL;
2965                         }
2966                         ast_module_reload(rld);
2967                 }
2968         } else {
2969                 ast_config_destroy(cfg);
2970                 switch(result) {
2971                 case UNKNOWN_ACTION:
2972                         astman_send_error(s, m, "Unknown action command");
2973                         break;
2974                 case UNKNOWN_CATEGORY:
2975                         astman_send_error(s, m, "Given category does not exist");
2976                         break;
2977                 case UNSPECIFIED_CATEGORY:
2978                         astman_send_error(s, m, "Category not specified");
2979                         break;
2980                 case UNSPECIFIED_ARGUMENT:
2981                         astman_send_error(s, m, "Problem with category, value, or line (if required)");
2982                         break;
2983                 case FAILURE_ALLOCATION:
2984                         astman_send_error(s, m, "Memory allocation failure, this should not happen");
2985                         break;
2986                 case FAILURE_NEWCAT:
2987                         astman_send_error(s, m, "Create category did not complete successfully");
2988                         break;
2989                 case FAILURE_DELCAT:
2990                         astman_send_error(s, m, "Delete category did not complete successfully");
2991                         break;
2992                 case FAILURE_EMPTYCAT:
2993                         astman_send_error(s, m, "Empty category did not complete successfully");
2994                         break;
2995                 case FAILURE_UPDATE:
2996                         astman_send_error(s, m, "Update did not complete successfully");
2997                         break;
2998                 case FAILURE_DELETE:
2999                         astman_send_error(s, m, "Delete did not complete successfully");
3000                         break;
3001                 case FAILURE_APPEND:
3002                         astman_send_error(s, m, "Append did not complete successfully");
3003                         break;
3004                 }
3005         }
3006         return 0;
3007 }
3008
3009 static int action_createconfig(struct mansession *s, const struct message *m)
3010 {
3011         int fd;
3012         const char *fn = astman_get_header(m, "Filename");
3013         struct ast_str *filepath = ast_str_alloca(PATH_MAX);
3014         ast_str_set(&filepath, 0, "%s/", ast_config_AST_CONFIG_DIR);
3015         ast_str_append(&filepath, 0, "%s", fn);
3016
3017         if ((fd = open(ast_str_buffer(filepath), O_CREAT | O_EXCL, AST_FILE_MODE)) != -1) {
3018                 close(fd);
3019                 astman_send_ack(s, m, "New configuration file created successfully");
3020         } else {
3021                 astman_send_error(s, m, strerror(errno));
3022         }
3023
3024         return 0;
3025 }
3026
3027 static int action_waitevent(struct mansession *s, const struct message *m)
3028 {
3029         const char *timeouts = astman_get_header(m, "Timeout");
3030         int timeout = -1;
3031         int x;
3032         int needexit = 0;
3033         const char *id = astman_get_header(m, "ActionID");
3034         char idText[256];
3035
3036         if (!ast_strlen_zero(id)) {
3037                 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
3038         } else {
3039                 idText[0] = '\0';
3040         }
3041
3042         if (!ast_strlen_zero(timeouts)) {
3043                 sscanf(timeouts, "%30i", &timeout);
3044                 if (timeout < -1) {
3045                         timeout = -1;
3046                 }
3047                 /* XXX maybe put an upper bound, or prevent the use of 0 ? */
3048         }
3049
3050         ao2_lock(s->session);
3051         if (s->session->waiting_thread != AST_PTHREADT_NULL) {
3052                 pthread_kill(s->session->waiting_thread, SIGURG);
3053         }
3054
3055         if (s->session->managerid) { /* AMI-over-HTTP session */
3056                 /*
3057                  * Make sure the timeout is within the expire time of the session,
3058                  * as the client will likely abort the request if it does not see
3059                  * data coming after some amount of time.
3060                  */
3061                 time_t now = time(NULL);
3062                 int max = s->session->sessiontimeout - now - 10;
3063
3064                 if (max < 0) {  /* We are already late. Strange but possible. */
3065                         max = 0;
3066                 }
3067                 if (timeout < 0 || timeout > max) {
3068                         timeout = max;
3069                 }
3070                 if (!s->session->send_events) { /* make sure we record events */
3071                         s->session->send_events = -1;
3072                 }
3073         }
3074         ao2_unlock(s->session);
3075
3076         /* XXX should this go inside the lock ? */
3077         s->session->waiting_thread = pthread_self();    /* let new events wake up this thread */
3078         ast_debug(1, "Starting waiting for an event!\n");
3079
3080         for (x = 0; x < timeout || timeout < 0; x++) {
3081                 ao2_lock(s->session);
3082                 if (AST_RWLIST_NEXT(s->session->last_ev, eq_next)) {
3083                         needexit = 1;
3084                 }
3085                 /* We can have multiple HTTP session point to the same mansession entry.
3086                  * The way we deal with it is not very nice: newcomers kick out the previous
3087                  * HTTP session. XXX this needs to be improved.
3088                  */
3089                 if (s->session->waiting_thread != pthread_self()) {
3090                         needexit = 1;
3091                 }
3092                 if (s->session->needdestroy) {
3093                         needexit = 1;
3094                 }
3095                 ao2_unlock(s->session);
3096                 if (needexit) {
3097                         break;
3098                 }
3099                 if (s->session->managerid == 0) {       /* AMI session */
3100                         if (ast_wait_for_input(s->session->fd, 1000)) {
3101                                 break;
3102                         }
3103                 } else {        /* HTTP session */
3104                         sleep(1);
3105                 }
3106         }
3107         ast_debug(1, "Finished waiting for an event!\n");
3108
3109         ao2_lock(s->session);
3110         if (s->session->waiting_thread == pthread_self()) {
3111                 struct eventqent *eqe = s->session->last_ev;
3112                 astman_send_response(s, m, "Success", "Waiting for Event completed.");
3113                 while ((eqe = advance_event(eqe))) {
3114                         if (((s->session->readperm & eqe->category) == eqe->category) &&
3115                             ((s->session->send_events & eqe->category) == eqe->category)) {
3116                                 astman_append(s, "%s", eqe->eventdata);
3117                         }
3118                         s->session->last_ev = eqe;
3119                 }
3120                 astman_append(s,
3121                         "Event: WaitEventComplete\r\n"
3122                         "%s"
3123                         "\r\n", idText);
3124                 s->session->waiting_thread = AST_PTHREADT_NULL;
3125         } else {
3126                 ast_debug(1, "Abandoning event request!\n");
3127         }
3128         ao2_unlock(s->session);
3129
3130         return 0;
3131 }
3132
3133 static int action_listcommands(struct mansession *s, const struct message *m)
3134 {
3135         struct manager_action *cur;
3136         struct ast_str *temp = ast_str_alloca(256);
3137
3138         astman_start_ack(s, m);
3139         AST_RWLIST_RDLOCK(&actions);
3140         AST_RWLIST_TRAVERSE(&actions, cur, list) {
3141                 if ((s->session->writeperm & cur->authority) || cur->authority == 0) {
3142                         astman_append(s, "%s: %s (Priv: %s)\r\n",
3143                                 cur->action, cur->synopsis, authority_to_str(cur->authority, &temp));
3144                 }
3145         }
3146         AST_RWLIST_UNLOCK(&actions);
3147         astman_append(s, "\r\n");
3148
3149         return 0;
3150 }
3151
3152 static int action_events(struct mansession *s, const struct message *m)
3153 {
3154         const char *mask = astman_get_header(m, "EventMask");
3155         int res, x;
3156         const char *id = astman_get_header(m, "ActionID");
3157         char id_text[256];
3158
3159         if (!ast_strlen_zero(id)) {
3160                 snprintf(id_text, sizeof(id_text), "ActionID: %s\r\n", id);
3161         } else {
3162                 id_text[0] = '\0';
3163         }
3164
3165         res = set_eventmask(s, mask);
3166         if (broken_events_action) {
3167                 /* if this option is set we should not return a response on
3168                  * error, or when all events are set */
3169
3170                 if (res > 0) {
3171                         for (x = 0; x < ARRAY_LEN(perms); x++) {
3172                                 if (!strcasecmp(perms[x].label, "all") && res == perms[x].num) {
3173                                         return 0;
3174                                 }
3175                         }
3176                         astman_append(s, "Response: Success\r\n%s"
3177                                          "Events: On\r\n\r\n", id_text);
3178                 } else if (res == 0)
3179                         astman_append(s, "Response: Success\r\n%s"
3180                                          "Events: Off\r\n\r\n", id_text);
3181                 return 0;
3182         }
3183
3184         if (res > 0)
3185                 astman_append(s, "Response: Success\r\n%s"
3186                                  "Events: On\r\n\r\n", id_text);
3187         else if (res == 0)
3188                 astman_append(s, "Response: Success\r\n%s"
3189                                  "Events: Off\r\n\r\n", id_text);
3190         else
3191                 astman_send_error(s, m, "Invalid event mask");
3192
3193         return 0;
3194 }
3195
3196 static int action_logoff(struct mansession *s, const struct message *m)
3197 {
3198         astman_send_response(s, m, "Goodbye", "Thanks for all the fish.");
3199         return -1;
3200 }
3201
3202 static int action_login(struct mansession *s, const struct message *m)
3203 {
3204
3205         /* still authenticated - don't process again */
3206         if (s->session->authenticated) {
3207                 astman_send_ack(s, m, "Already authenticated");
3208                 return 0;
3209         }
3210
3211         if (authenticate(s, m)) {
3212                 sleep(1);
3213                 astman_send_error(s, m, "Authentication failed");
3214                 return -1;
3215         }
3216         s->session->authenticated = 1;
3217         ast_atomic_fetchadd_int(&unauth_sessions, -1);
3218         if (manager_displayconnects(s->session)) {
3219                 ast_verb(2, "%sManager '%s' logged on from %s\n", (s->session->managerid ? "HTTP " : ""), s->session->username, ast_sockaddr_stringify_addr(&s->session->addr));
3220         }
3221         astman_send_ack(s, m, "Authentication accepted");
3222         if ((s->session->send_events & EVENT_FLAG_SYSTEM)
3223                 && ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
3224                 struct ast_str *auth = ast_str_alloca(80);
3225                 const char *cat_str = authority_to_str(EVENT_FLAG_SYSTEM, &auth);
3226                 astman_append(s, "Event: FullyBooted\r\n"
3227                         "Privilege: %s\r\n"
3228                         "Status: Fully Booted\r\n\r\n", cat_str);
3229         }
3230         return 0;
3231 }
3232
3233 static int action_challenge(struct mansession *s, const struct message *m)
3234 {
3235         const char *authtype = astman_get_header(m, "AuthType");
3236
3237         if (!strcasecmp(authtype, "MD5")) {
3238                 if (ast_strlen_zero(s->session->challenge)) {
3239                         snprintf(s->session->challenge, sizeof(s->session->challenge), "%ld", ast_random());
3240                 }
3241                 mansession_lock(s);
3242                 astman_start_ack(s, m);
3243                 astman_append(s, "Challenge: %s\r\n\r\n", s->session->challenge);
3244                 mansession_unlock(s);
3245         } else {
3246                 astman_send_error(s, m, "Must specify AuthType");
3247         }
3248         return 0;
3249 }
3250
3251 static int action_hangup(struct mansession *s, const struct message *m)
3252 {
3253         struct ast_channel *c = NULL;
3254         int causecode = 0; /* all values <= 0 mean 'do not set hangupcause in channel' */
3255         const char *id = astman_get_header(m, "ActionID");
3256         const char *name_or_regex = astman_get_header(m, "Channel");
3257         const char *cause = astman_get_header(m, "Cause");
3258         char idText[256];
3259         regex_t regexbuf;
3260         struct ast_channel_iterator *iter = NULL;
3261         struct ast_str *regex_string;
3262         int channels_matched = 0;
3263
3264         if (ast_strlen_zero(name_or_regex)) {
3265                 astman_send_error(s, m, "No channel specified");
3266                 return 0;
3267         }
3268
3269         if (!ast_strlen_zero(id)) {
3270                 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
3271         } else {
3272                 idText[0] = '\0';
3273         }
3274
3275         if (!ast_strlen_zero(cause)) {
3276                 char *endptr;
3277                 causecode = strtol(cause, &endptr, 10);
3278                 if (causecode < 0 || causecode > 127 || *endptr != '\0') {
3279                         ast_log(LOG_NOTICE, "Invalid 'Cause: %s' in manager action Hangup\n", cause);
3280                         /* keep going, better to hangup without cause than to not hang up at all */
3281                         causecode = 0; /* do not set channel's hangupcause */
3282                 }
3283         }
3284
3285         /************************************************/
3286         /* Regular explicit match channel byname hangup */
3287
3288         if (name_or_regex[0] != '/') {
3289                 if (!(c = ast_channel_get_by_name(name_or_regex))) {
3290                         ast_log(LOG_NOTICE, "!!!!!!!!!! Can't find channel to hang up!\n");
3291                         astman_send_error(s, m, "No such channel");
3292                         return 0;
3293                 }
3294
3295                 ast_verb(3, "%sManager '%s' from %s, hanging up channel: %s\n",
3296                         (s->session->managerid ? "HTTP " : ""),
3297                         s->session->username,
3298                         ast_sockaddr_stringify_addr(&s->session->addr),
3299                         ast_channel_name(c));
3300
3301                 ast_channel_softhangup_withcause_locked(c, causecode);
3302                 c = ast_channel_unref(c);
3303
3304                 astman_send_ack(s, m, "Channel Hungup");
3305
3306                 return 0;
3307         }
3308
3309         /***********************************************/
3310         /* find and hangup any channels matching regex */
3311
3312         regex_string = ast_str_create(strlen(name_or_regex));
3313         if (!regex_string) {
3314                 astman_send_error(s, m, "Memory Allocation Failure");
3315                 return 0;
3316         }
3317
3318         /* Make "/regex/" into "regex" */
3319         if (ast_regex_string_to_regex_pattern(name_or_regex, &regex_string) != 0) {
3320                 astman_send_error(s, m, "Regex format invalid, Channel param should be /regex/");
3321                 ast_free(regex_string);
3322                 return 0;
3323         }
3324
3325         /* if regex compilation fails, hangup fails */
3326         if (regcomp(&regexbuf, ast_str_buffer(regex_string), REG_EXTENDED | REG_NOSUB)) {
3327                 astman_send_error_va(s, m, "Regex compile failed on: %s\n", name_or_regex);
3328                 ast_free(regex_string);
3329                 return 0;
3330         }
3331
3332         astman_send_listack(s, m, "Channels hung up will follow", "start");
3333
3334         iter = ast_channel_iterator_all_new();
3335         if (iter) {
3336                 for (; (c = ast_channel_iterator_next(iter)); ast_channel_unref(c)) {
3337                         if (regexec(&regexbuf, ast_channel_name(c), 0, NULL, 0)) {
3338                                 continue;
3339                         }
3340
3341                         ast_verb(3, "%sManager '%s' from %s, hanging up channel: %s\n",
3342                                 (s->session->managerid ? "HTTP " : ""),
3343                                 s->session->username,
3344                                 ast_sockaddr_stringify_addr(&s->session->addr),
3345                                 ast_channel_name(c));
3346
3347                         ast_channel_softhangup_withcause_locked(c, causecode);
3348                         channels_matched++;
3349
3350                         astman_append(s,
3351                                 "Event: ChannelHungup\r\n"
3352                                 "Channel: %s\r\n"
3353                                 "%s"
3354                                 "\r\n", ast_channel_name(c), idText);
3355                 }
3356                 ast_channel_iterator_destroy(iter);
3357         }
3358
3359         regfree(&regexbuf);
3360         ast_free(regex_string);
3361
3362         astman_append(s,
3363                 "Event: ChannelsHungupListComplete\r\n"
3364                 "EventList: Complete\r\n"
3365                 "ListItems: %d\r\n"
3366                 "%s"
3367                 "\r\n", channels_matched, idText);
3368
3369         return 0;
3370 }
3371
3372 static int action_setvar(struct mansession *s, const struct message *m)
3373 {
3374         struct ast_channel *c = NULL;
3375         const char *name = astman_get_header(m, "Channel");
3376         const char *varname = astman_get_header(m, "Variable");
3377         const char *varval = astman_get_header(m, "Value");
3378         int res = 0;
3379
3380         if (ast_strlen_zero(varname)) {
3381                 astman_send_error(s, m, "No variable specified");
3382                 return 0;
3383         }
3384
3385         if (!ast_strlen_zero(name)) {
3386                 if (!(c = ast_channel_get_by_name(name))) {
3387                         astman_send_error(s, m, "No such channel");
3388                         return 0;
3389                 }
3390         }
3391
3392         res = pbx_builtin_setvar_helper(c, varname, S_OR(varval, ""));
3393
3394         if (c) {
3395                 c = ast_channel_unref(c);
3396         }
3397         if (res == 0) {
3398                 astman_send_ack(s, m, "Variable Set");
3399         } else {
3400                 astman_send_error(s, m, "Variable not set");
3401         }
3402         return 0;
3403 }
3404
3405 static int action_getvar(struct mansession *s, const struct message *m)
3406 {
3407         struct ast_channel *c = NULL;
3408         const char *name = astman_get_header(m, "Channel");
3409         const char *varname = astman_get_header(m, "Variable");
3410         char *varval;
3411         char workspace[1024];
3412
3413         if (ast_strlen_zero(varname)) {
3414                 astman_send_error(s, m, "No variable specified");
3415                 return 0;
3416         }
3417
3418         /* We don't want users with insufficient permissions using certain functions. */
3419         if (!(function_capable_string_allowed_with_auths(varname, s->session->writeperm))) {
3420                 astman_send_error(s, m, "GetVar Access Forbidden: Variable");
3421                 return 0;
3422         }
3423
3424         if (!ast_strlen_zero(name)) {
3425                 if (!(c = ast_channel_get_by_name(name))) {
3426                         astman_send_error(s, m, "No such channel");
3427                         return 0;
3428                 }
3429         }
3430
3431         workspace[0] = '\0';
3432         if (varname[strlen(varname) - 1] == ')') {
3433                 if (!c) {
3434                         c = ast_dummy_channel_alloc();
3435                         if (c) {
3436                                 ast_func_read(c, (char *) varname, workspace, sizeof(workspace));
3437                         } else
3438                                 ast_log(LOG_ERROR, "Unable to allocate bogus channel for variable substitution.  Function results may be blank.\n");
3439                 } else {
3440                         ast_func_read(c, (char *) varname, workspace, sizeof(workspace));
3441                 }
3442                 varval = workspace;
3443         } else {
3444                 pbx_retrieve_variable(c, varname, &varval, workspace, sizeof(workspace), NULL);
3445         }
3446
3447         if (c) {
3448                 c = ast_channel_unref(c);
3449         }
3450
3451         astman_start_ack(s, m);
3452         astman_append(s, "Variable: %s\r\nValue: %s\r\n\r\n", varname, S_OR(varval, ""));
3453
3454         return 0;
3455 }
3456
3457 /*! \brief Manager "status" command to show channels */
3458 /* Needs documentation... */
3459 static int action_status(struct mansession *s, const struct message *m)
3460 {
3461         const char *name = astman_get_header(m, "Channel");
3462         const char *cvariables = astman_get_header(m, "Variables");
3463         char *variables = ast_strdupa(S_OR(cvariables, ""));
3464         struct ast_channel *c;
3465         char bridge[256];
3466         struct timeval now = ast_tvnow();
3467         long elapsed_seconds = 0;
3468         int channels = 0;
3469         int all = ast_strlen_zero(name); /* set if we want all channels */
3470         const char *id = astman_get_header(m, "ActionID");
3471         char idText[256];
3472         AST_DECLARE_APP_ARGS(vars,
3473                 AST_APP_ARG(name)[100];
3474         );
3475         struct ast_str *str = ast_str_create(1000);
3476         struct ast_channel_iterator *iter = NULL;
3477
3478         if (!ast_strlen_zero(id)) {
3479                 snprintf(idText, sizeof(idText), "ActionID: %s\r\n", id);
3480         } else {
3481                 idText[0] = '\0';
3482         }
3483
3484         if (!(function_capable_string_allowed_with_auths(variables, s->session->writeperm))) {
3485                 astman_send_error(s, m, "Status Access Forbidden: Variables");
3486                 return 0;
3487         }
3488
3489         if (all) {
3490                 if (!(iter = ast_channel_iterator_all_new())) {
3491                        &nb