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