AST-2014-007: Fix DOS by consuming the number of allowed HTTP connections.
[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                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
851                         <parameter name="Module" required="true">
852                                 <para>Asterisk module name (not including extension).</para>
853                         </parameter>
854                 </syntax>
855                 <description>
856                         <para>Checks if Asterisk module is loaded. Will return Success/Failure.
857                         For success returns, the module revision number is included.</para>
858                 </description>
859         </manager>
860         <manager name="AOCMessage" language="en_US">
861                 <synopsis>
862                         Generate an Advice of Charge message on a channel.
863                 </synopsis>
864                 <syntax>
865                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
866                         <parameter name="Channel" required="true">
867                                 <para>Channel name to generate the AOC message on.</para>
868                         </parameter>
869                         <parameter name="ChannelPrefix">
870                                 <para>Partial channel prefix.  By using this option one can match the beginning part
871                                 of a channel name without having to put the entire name in.  For example
872                                 if a channel name is SIP/snom-00000001 and this value is set to SIP/snom, then
873                                 that channel matches and the message will be sent.  Note however that only
874                                 the first matched channel has the message sent on it. </para>
875                         </parameter>
876                         <parameter name="MsgType" required="true">
877                                 <para>Defines what type of AOC message to create, AOC-D or AOC-E</para>
878                                 <enumlist>
879                                         <enum name="D" />
880                                         <enum name="E" />
881                                 </enumlist>
882                         </parameter>
883                         <parameter name="ChargeType" required="true">
884                                 <para>Defines what kind of charge this message represents.</para>
885                                 <enumlist>
886                                         <enum name="NA" />
887                                         <enum name="FREE" />
888                                         <enum name="Currency" />
889                                         <enum name="Unit" />
890                                 </enumlist>
891                         </parameter>
892                         <parameter name="UnitAmount(0)">
893                                 <para>This represents the amount of units charged. The ETSI AOC standard specifies that
894                                 this value along with the optional UnitType value are entries in a list.  To accommodate this
895                                 these values take an index value starting at 0 which can be used to generate this list of
896                                 unit entries.  For Example, If two unit entires were required this could be achieved by setting the
897                                 paramter UnitAmount(0)=1234 and UnitAmount(1)=5678.  Note that UnitAmount at index 0 is
898                                 required when ChargeType=Unit, all other entries in the list are optional.
899                                 </para>
900                         </parameter>
901                         <parameter name="UnitType(0)">
902                                 <para>Defines the type of unit.  ETSI AOC standard specifies this as an integer
903                                 value between 1 and 16, but this value is left open to accept any positive
904                                 integer.  Like the UnitAmount parameter, this value represents a list entry
905                                 and has an index parameter that starts at 0.
906                                 </para>
907                         </parameter>
908                         <parameter name="CurrencyName">
909                                 <para>Specifies the currency's name.  Note that this value is truncated after 10 characters.</para>
910                         </parameter>
911                         <parameter name="CurrencyAmount">
912                                 <para>Specifies the charge unit amount as a positive integer.  This value is required
913                                 when ChargeType==Currency.</para>
914                         </parameter>
915                         <parameter name="CurrencyMultiplier">
916                                 <para>Specifies the currency multiplier.  This value is required when ChargeType==Currency.</para>
917                                 <enumlist>
918                                         <enum name="OneThousandth" />
919                                         <enum name="OneHundredth" />
920                                         <enum name="OneTenth" />
921                                         <enum name="One" />
922                                         <enum name="Ten" />
923                                         <enum name="Hundred" />
924                                         <enum name="Thousand" />
925                                 </enumlist>
926                         </parameter>
927                         <parameter name="TotalType" default="Total">
928                                 <para>Defines what kind of AOC-D total is represented.</para>
929                                 <enumlist>
930                                         <enum name="Total" />
931                                         <enum name="SubTotal" />
932                                 </enumlist>
933                         </parameter>
934                         <parameter name="AOCBillingId">
935                                 <para>Represents a billing ID associated with an AOC-D or AOC-E message. Note
936                                 that only the first 3 items of the enum are valid AOC-D billing IDs</para>
937                                 <enumlist>
938                                         <enum name="Normal" />
939                                         <enum name="ReverseCharge" />
940                                         <enum name="CreditCard" />
941                                         <enum name="CallFwdUnconditional" />
942                                         <enum name="CallFwdBusy" />
943                                         <enum name="CallFwdNoReply" />
944                                         <enum name="CallDeflection" />
945                                         <enum name="CallTransfer" />
946                                 </enumlist>
947                         </parameter>
948                         <parameter name="ChargingAssociationId">
949                                 <para>Charging association identifier.  This is optional for AOC-E and can be
950                                 set to any value between -32768 and 32767</para>
951                         </parameter>
952                         <parameter name="ChargingAssociationNumber">
953                                 <para>Represents the charging association party number.  This value is optional
954                                 for AOC-E.</para>
955                         </parameter>
956                         <parameter name="ChargingAssociationPlan">
957                                 <para>Integer representing the charging plan associated with the ChargingAssociationNumber.
958                                 The value is bits 7 through 1 of the Q.931 octet containing the type-of-number and
959                                 numbering-plan-identification fields.</para>
960                         </parameter>
961                 </syntax>
962                 <description>
963                         <para>Generates an AOC-D or AOC-E message on a channel.</para>
964                 </description>
965         </manager>
966         <function name="AMI_CLIENT" language="en_US">
967                 <synopsis>
968                         Checks attributes of manager accounts
969                 </synopsis>
970                 <syntax>
971                         <parameter name="loginname" required="true">
972                                 <para>Login name, specified in manager.conf</para>
973                         </parameter>
974                         <parameter name="field" required="true">
975                                 <para>The manager account attribute to return</para>
976                                 <enumlist>
977                                         <enum name="sessions"><para>The number of sessions for this AMI account</para></enum>
978                                 </enumlist>
979                         </parameter>
980                 </syntax>
981                 <description>
982                         <para>
983                                 Currently, the only supported  parameter is "sessions" which will return the current number of
984                                 active sessions for this AMI account.
985                         </para>
986                 </description>
987         </function>
988         <manager name="Filter" language="en_US">
989                 <synopsis>
990                         Dynamically add filters for the current manager session.
991                 </synopsis>
992                 <syntax>
993                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
994                         <parameter name="Operation">
995                                 <enumlist>
996                                         <enum name="Add">
997                                                 <para>Add a filter.</para>
998                                         </enum>
999                                 </enumlist>
1000                         </parameter>
1001                         <parameter name="Filter">
1002                                 <para>Filters can be whitelist or blacklist</para>
1003                                 <para>Example whitelist filter: "Event: Newchannel"</para>
1004                                 <para>Example blacklist filter: "!Channel: DAHDI.*"</para>
1005                                 <para>This filter option is used to whitelist or blacklist events per user to be
1006                                 reported with regular expressions and are allowed if both the regex matches
1007                                 and the user has read access as defined in manager.conf. Filters are assumed to be for whitelisting
1008                                 unless preceeded by an exclamation point, which marks it as being black.
1009                                 Evaluation of the filters is as follows:</para>
1010                                 <para>- If no filters are configured all events are reported as normal.</para>
1011                                 <para>- If there are white filters only: implied black all filter processed first, then white filters.</para>
1012                                 <para>- If there are black filters only: implied white all filter processed first, then black filters.</para>
1013                                 <para>- If there are both white and black filters: implied black all filter processed first, then white
1014                                 filters, and lastly black filters.</para>
1015                         </parameter>
1016                 </syntax>
1017                 <description>
1018                         <para>The filters added are only used for the current session.
1019                         Once the connection is closed the filters are removed.</para>
1020                         <para>This comand requires the system permission because
1021                         this command can be used to create filters that may bypass
1022                         filters defined in manager.conf</para>
1023                 </description>
1024         </manager>
1025         <manager name="FilterList" language="en_US">
1026                 <synopsis>
1027                         Show current event filters for this session
1028                 </synopsis>
1029                 <description>
1030                         <para>The filters displayed are for the current session.  Only those filters defined in
1031                         manager.conf will be present upon starting a new session.</para>
1032                 </description>
1033         </manager>
1034         <manager name="BlindTransfer" language="en_US">
1035                 <synopsis>
1036                         Blind transfer channel(s) to the given destination
1037                 </synopsis>
1038                 <syntax>
1039                         <parameter name="Channel" required="true">
1040                         </parameter>
1041                         <parameter name="Context">
1042                         </parameter>
1043                         <parameter name="Exten">
1044                         </parameter>
1045                 </syntax>
1046                 <description>
1047                         <para>Redirect all channels currently bridged to the specified channel to the specified destination.</para>
1048                 </description>
1049                 <see-also>
1050                         <ref type="manager">Redirect</ref>
1051                 </see-also>
1052         </manager>
1053  ***/
1054
1055 /*! \addtogroup Group_AMI AMI functions
1056 */
1057 /*! @{
1058  Doxygen group */
1059
1060 enum error_type {
1061         UNKNOWN_ACTION = 1,
1062         UNKNOWN_CATEGORY,
1063         UNSPECIFIED_CATEGORY,
1064         UNSPECIFIED_ARGUMENT,
1065         FAILURE_ALLOCATION,
1066         FAILURE_NEWCAT,
1067         FAILURE_DELCAT,
1068         FAILURE_EMPTYCAT,
1069         FAILURE_UPDATE,
1070         FAILURE_DELETE,
1071         FAILURE_APPEND
1072 };
1073
1074 enum add_filter_result {
1075         FILTER_SUCCESS,
1076         FILTER_ALLOC_FAILED,
1077         FILTER_COMPILE_FAIL,
1078 };
1079
1080 /*!
1081  * Linked list of events.
1082  * Global events are appended to the list by append_event().
1083  * The usecount is the number of stored pointers to the element,
1084  * excluding the list pointers. So an element that is only in
1085  * the list has a usecount of 0, not 1.
1086  *
1087  * Clients have a pointer to the last event processed, and for each
1088  * of these clients we track the usecount of the elements.
1089  * If we have a pointer to an entry in the list, it is safe to navigate
1090  * it forward because elements will not be deleted, but only appended.
1091  * The worst that can happen is seeing the pointer still NULL.
1092  *
1093  * When the usecount of an element drops to 0, and the element is the
1094  * first in the list, we can remove it. Removal is done within the
1095  * main thread, which is woken up for the purpose.
1096  *
1097  * For simplicity of implementation, we make sure the list is never empty.
1098  */
1099 struct eventqent {
1100         int usecount;           /*!< # of clients who still need the event */
1101         int category;
1102         unsigned int seq;       /*!< sequence number */
1103         struct timeval tv;  /*!< When event was allocated */
1104         AST_RWLIST_ENTRY(eventqent) eq_next;
1105         char eventdata[1];      /*!< really variable size, allocated by append_event() */
1106 };
1107
1108 static AST_RWLIST_HEAD_STATIC(all_events, eventqent);
1109
1110 static int displayconnects = 1;
1111 static int allowmultiplelogin = 1;
1112 static int timestampevents;
1113 static int httptimeout = 60;
1114 static int broken_events_action = 0;
1115 static int manager_enabled = 0;
1116 static int subscribed = 0;
1117 static int webmanager_enabled = 0;
1118 static int manager_debug = 0;   /*!< enable some debugging code in the manager */
1119 static int authtimeout;
1120 static int authlimit;
1121 static char *manager_channelvars;
1122
1123 #define DEFAULT_REALM           "asterisk"
1124 static char global_realm[MAXHOSTNAMELEN];       /*!< Default realm */
1125
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                 fflush(session->f);
1773                 fclose(session->f);
1774         }
1775         if (eqe) {
1776                 ast_atomic_fetchadd_int(&eqe->usecount, -1);
1777         }
1778         if (session->chanvars) {
1779                 ast_variables_destroy(session->chanvars);
1780         }
1781
1782         if (session->whitefilters) {
1783                 ao2_t_ref(session->whitefilters, -1, "decrement ref for white container, should be last one");
1784         }
1785
1786         if (session->blackfilters) {
1787                 ao2_t_ref(session->blackfilters, -1, "decrement ref for black container, should be last one");
1788         }
1789 }
1790
1791 /*! \brief Allocate manager session structure and add it to the list of sessions */
1792 static struct mansession_session *build_mansession(const struct ast_sockaddr *addr)
1793 {
1794         struct ao2_container *sessions;
1795         struct mansession_session *newsession;
1796
1797         newsession = ao2_alloc(sizeof(*newsession), session_destructor);
1798         if (!newsession) {
1799                 return NULL;
1800         }
1801
1802         newsession->whitefilters = ao2_container_alloc(1, NULL, NULL);
1803         newsession->blackfilters = ao2_container_alloc(1, NULL, NULL);
1804         if (!newsession->whitefilters || !newsession->blackfilters) {
1805                 ao2_ref(newsession, -1);
1806                 return NULL;
1807         }
1808
1809         newsession->fd = -1;
1810         newsession->waiting_thread = AST_PTHREADT_NULL;
1811         newsession->writetimeout = 100;
1812         newsession->send_events = -1;
1813         ast_sockaddr_copy(&newsession->addr, addr);
1814
1815         sessions = ao2_global_obj_ref(mgr_sessions);
1816         if (sessions) {
1817                 ao2_link(sessions, newsession);
1818                 ao2_ref(sessions, -1);
1819         }
1820
1821         return newsession;
1822 }
1823
1824 static int mansession_cmp_fn(void *obj, void *arg, int flags)
1825 {
1826         struct mansession_session *s = obj;
1827         char *str = arg;
1828         return !strcasecmp(s->username, str) ? CMP_MATCH : 0;
1829 }
1830
1831 static void session_destroy(struct mansession_session *s)
1832 {
1833         struct ao2_container *sessions;
1834
1835         sessions = ao2_global_obj_ref(mgr_sessions);
1836         if (sessions) {
1837                 ao2_unlink(sessions, s);
1838                 ao2_ref(sessions, -1);
1839         }
1840         unref_mansession(s);
1841 }
1842
1843
1844 static int check_manager_session_inuse(const char *name)
1845 {
1846         struct ao2_container *sessions;
1847         struct mansession_session *session;
1848         int inuse = 0;
1849
1850         sessions = ao2_global_obj_ref(mgr_sessions);
1851         if (sessions) {
1852                 session = ao2_find(sessions, (char *) name, 0);
1853                 ao2_ref(sessions, -1);
1854                 if (session) {
1855                         unref_mansession(session);
1856                         inuse = 1;
1857                 }
1858         }
1859         return inuse;
1860 }
1861
1862
1863 /*!
1864  * lookup an entry in the list of registered users.
1865  * must be called with the list lock held.
1866  */
1867 static struct ast_manager_user *get_manager_by_name_locked(const char *name)
1868 {
1869         struct ast_manager_user *user = NULL;
1870
1871         AST_RWLIST_TRAVERSE(&users, user, list) {
1872                 if (!strcasecmp(user->username, name)) {
1873                         break;
1874                 }
1875         }
1876
1877         return user;
1878 }
1879
1880 /*! \brief Get displayconnects config option.
1881  *  \param session manager session to get parameter from.
1882  *  \return displayconnects config option value.
1883  */
1884 static int manager_displayconnects(struct mansession_session *session)
1885 {
1886         struct ast_manager_user *user = NULL;
1887         int ret = 0;
1888
1889         AST_RWLIST_RDLOCK(&users);
1890         if ((user = get_manager_by_name_locked(session->username))) {
1891                 ret = user->displayconnects;
1892         }
1893         AST_RWLIST_UNLOCK(&users);
1894
1895         return ret;
1896 }
1897
1898 static char *handle_showmancmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1899 {
1900         struct manager_action *cur;
1901         struct ast_str *authority;
1902         int num, l, which;
1903         char *ret = NULL;
1904 #ifdef AST_XML_DOCS
1905         char syntax_title[64], description_title[64], synopsis_title[64], seealso_title[64], arguments_title[64], privilege_title[64];
1906 #endif
1907
1908         switch (cmd) {
1909         case CLI_INIT:
1910                 e->command = "manager show command";
1911                 e->usage =
1912                         "Usage: manager show command <actionname> [<actionname> [<actionname> [...]]]\n"
1913                         "       Shows the detailed description for a specific Asterisk manager interface command.\n";
1914                 return NULL;
1915         case CLI_GENERATE:
1916                 l = strlen(a->word);
1917                 which = 0;
1918                 AST_RWLIST_RDLOCK(&actions);
1919                 AST_RWLIST_TRAVERSE(&actions, cur, list) {
1920                         if (!strncasecmp(a->word, cur->action, l) && ++which > a->n) {
1921                                 ret = ast_strdup(cur->action);
1922                                 break;  /* make sure we exit even if ast_strdup() returns NULL */
1923                         }
1924                 }
1925                 AST_RWLIST_UNLOCK(&actions);
1926                 return ret;
1927         }
1928         authority = ast_str_alloca(80);
1929         if (a->argc < 4) {
1930                 return CLI_SHOWUSAGE;
1931         }
1932
1933 #ifdef AST_XML_DOCS
1934         /* setup the titles */
1935         term_color(synopsis_title, "[Synopsis]\n", COLOR_MAGENTA, 0, 40);
1936         term_color(description_title, "[Description]\n", COLOR_MAGENTA, 0, 40);
1937         term_color(syntax_title, "[Syntax]\n", COLOR_MAGENTA, 0, 40);
1938         term_color(seealso_title, "[See Also]\n", COLOR_MAGENTA, 0, 40);
1939         term_color(arguments_title, "[Arguments]\n", COLOR_MAGENTA, 0, 40);
1940         term_color(privilege_title, "[Privilege]\n", COLOR_MAGENTA, 0, 40);
1941 #endif
1942
1943         AST_RWLIST_RDLOCK(&actions);
1944         AST_RWLIST_TRAVERSE(&actions, cur, list) {
1945                 for (num = 3; num < a->argc; num++) {
1946                         if (!strcasecmp(cur->action, a->argv[num])) {
1947                                 authority_to_str(cur->authority, &authority);
1948
1949 #ifdef AST_XML_DOCS
1950                                 if (cur->docsrc == AST_XML_DOC) {
1951                                         char *syntax = ast_xmldoc_printable(S_OR(cur->syntax, "Not available"), 1);
1952                                         char *synopsis = ast_xmldoc_printable(S_OR(cur->synopsis, "Not available"), 1);
1953                                         char *description = ast_xmldoc_printable(S_OR(cur->description, "Not available"), 1);
1954                                         char *arguments = ast_xmldoc_printable(S_OR(cur->arguments, "Not available"), 1);
1955                                         char *seealso = ast_xmldoc_printable(S_OR(cur->seealso, "Not available"), 1);
1956                                         char *privilege = ast_xmldoc_printable(S_OR(authority->str, "Not available"), 1);
1957                                         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",
1958                                                 syntax_title, syntax,
1959                                                 synopsis_title, synopsis,
1960                                                 description_title, description,
1961                                                 arguments_title, arguments,
1962                                                 seealso_title, seealso,
1963                                                 privilege_title, privilege);
1964                                 } else
1965 #endif
1966                                 {
1967                                         ast_cli(a->fd, "Action: %s\nSynopsis: %s\nPrivilege: %s\n%s\n",
1968                                                 cur->action, cur->synopsis,
1969                                                 authority->str,
1970                                                 S_OR(cur->description, ""));
1971                                 }
1972                         }
1973                 }
1974         }
1975         AST_RWLIST_UNLOCK(&actions);
1976
1977         return CLI_SUCCESS;
1978 }
1979
1980 static char *handle_mandebug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1981 {
1982         switch (cmd) {
1983         case CLI_INIT:
1984                 e->command = "manager set debug [on|off]";
1985                 e->usage = "Usage: manager set debug [on|off]\n Show, enable, disable debugging of the manager code.\n";
1986                 return NULL;
1987         case CLI_GENERATE:
1988                 return NULL;
1989         }
1990
1991         if (a->argc == 3) {
1992                 ast_cli(a->fd, "manager debug is %s\n", manager_debug? "on" : "off");
1993         } else if (a->argc == 4) {
1994                 if (!strcasecmp(a->argv[3], "on")) {
1995                         manager_debug = 1;
1996                 } else if (!strcasecmp(a->argv[3], "off")) {
1997                         manager_debug = 0;
1998                 } else {
1999                         return CLI_SHOWUSAGE;
2000                 }
2001         }
2002         return CLI_SUCCESS;
2003 }
2004
2005 static char *handle_showmanager(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2006 {
2007         struct ast_manager_user *user = NULL;
2008         int l, which;
2009         char *ret = NULL;
2010         struct ast_str *rauthority = ast_str_alloca(128);
2011         struct ast_str *wauthority = ast_str_alloca(128);
2012         struct ast_variable *v;
2013
2014         switch (cmd) {
2015         case CLI_INIT:
2016                 e->command = "manager show user";
2017                 e->usage =
2018                         " Usage: manager show user <user>\n"
2019                         "        Display all information related to the manager user specified.\n";
2020                 return NULL;
2021         case CLI_GENERATE:
2022                 l = strlen(a->word);
2023                 which = 0;
2024                 if (a->pos != 3) {
2025                         return NULL;
2026                 }
2027                 AST_RWLIST_RDLOCK(&users);
2028                 AST_RWLIST_TRAVERSE(&users, user, list) {
2029                         if ( !strncasecmp(a->word, user->username, l) && ++which > a->n ) {
2030                                 ret = ast_strdup(user->username);
2031                                 break;
2032                         }
2033                 }
2034                 AST_RWLIST_UNLOCK(&users);
2035                 return ret;
2036         }
2037
2038         if (a->argc != 4) {
2039                 return CLI_SHOWUSAGE;
2040         }
2041
2042         AST_RWLIST_RDLOCK(&users);
2043
2044         if (!(user = get_manager_by_name_locked(a->argv[3]))) {
2045                 ast_cli(a->fd, "There is no manager called %s\n", a->argv[3]);
2046                 AST_RWLIST_UNLOCK(&users);
2047                 return CLI_SUCCESS;
2048         }
2049
2050         ast_cli(a->fd, "\n");
2051         ast_cli(a->fd,
2052                 "          username: %s\n"
2053                 "            secret: %s\n"
2054                 "               ACL: %s\n"
2055                 "         read perm: %s\n"
2056                 "        write perm: %s\n"
2057                 "   displayconnects: %s\n"
2058                 "allowmultiplelogin: %s\n",
2059                 (user->username ? user->username : "(N/A)"),
2060                 (user->secret ? "<Set>" : "(N/A)"),
2061                 ((user->acl && !ast_acl_list_is_empty(user->acl)) ? "yes" : "no"),
2062                 user_authority_to_str(user->readperm, &rauthority),
2063                 user_authority_to_str(user->writeperm, &wauthority),
2064                 (user->displayconnects ? "yes" : "no"),
2065                 (user->allowmultiplelogin ? "yes" : "no"));
2066         ast_cli(a->fd, "         Variables: \n");
2067                 for (v = user->chanvars ; v ; v = v->next) {
2068                         ast_cli(a->fd, "                 %s = %s\n", v->name, v->value);
2069                 }
2070
2071         AST_RWLIST_UNLOCK(&users);
2072
2073         return CLI_SUCCESS;
2074 }
2075
2076 static char *handle_showmanagers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2077 {
2078         struct ast_manager_user *user = NULL;
2079         int count_amu = 0;
2080         switch (cmd) {
2081         case CLI_INIT:
2082                 e->command = "manager show users";
2083                 e->usage =
2084                         "Usage: manager show users\n"
2085                         "       Prints a listing of all managers that are currently configured on that\n"
2086                         " system.\n";
2087                 return NULL;
2088         case CLI_GENERATE:
2089                 return NULL;
2090         }
2091         if (a->argc != 3) {
2092                 return CLI_SHOWUSAGE;
2093         }
2094
2095         AST_RWLIST_RDLOCK(&users);
2096
2097         /* If there are no users, print out something along those lines */
2098         if (AST_RWLIST_EMPTY(&users)) {
2099                 ast_cli(a->fd, "There are no manager users.\n");
2100                 AST_RWLIST_UNLOCK(&users);
2101                 return CLI_SUCCESS;
2102         }
2103
2104         ast_cli(a->fd, "\nusername\n--------\n");
2105
2106         AST_RWLIST_TRAVERSE(&users, user, list) {
2107                 ast_cli(a->fd, "%s\n", user->username);
2108                 count_amu++;
2109         }
2110
2111         AST_RWLIST_UNLOCK(&users);
2112
2113         ast_cli(a->fd,"-------------------\n"
2114                       "%d manager users configured.\n", count_amu);
2115         return CLI_SUCCESS;
2116 }
2117
2118 /*! \brief  CLI command  manager list commands */
2119 static char *handle_showmancmds(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2120 {
2121         struct manager_action *cur;
2122         int name_len = 1;
2123         int space_remaining;
2124 #define HSMC_FORMAT "  %-*.*s  %-.*s\n"
2125         switch (cmd) {
2126         case CLI_INIT:
2127                 e->command = "manager show commands";
2128                 e->usage =
2129                         "Usage: manager show commands\n"
2130                         "       Prints a listing of all the available Asterisk manager interface commands.\n";
2131                 return NULL;
2132         case CLI_GENERATE:
2133                 return NULL;
2134         }
2135
2136         AST_RWLIST_RDLOCK(&actions);
2137         AST_RWLIST_TRAVERSE(&actions, cur, list) {
2138                 int incoming_len = strlen(cur->action);
2139                 if (incoming_len > name_len) {
2140                         name_len = incoming_len;
2141                 }
2142         }
2143
2144         space_remaining = MGR_SHOW_TERMINAL_WIDTH - name_len - 4;
2145         if (space_remaining < 0) {
2146                 space_remaining = 0;
2147         }
2148
2149         ast_cli(a->fd, HSMC_FORMAT, name_len, name_len, "Action", space_remaining, "Synopsis");
2150         ast_cli(a->fd, HSMC_FORMAT, name_len, name_len, "------", space_remaining, "--------");
2151
2152         AST_RWLIST_TRAVERSE(&actions, cur, list) {
2153                 ast_cli(a->fd, HSMC_FORMAT, name_len, name_len, cur->action, space_remaining, cur->synopsis);
2154         }
2155         AST_RWLIST_UNLOCK(&actions);
2156
2157         return CLI_SUCCESS;
2158 }
2159
2160 /*! \brief CLI command manager list connected */
2161 static char *handle_showmanconn(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2162 {
2163         struct ao2_container *sessions;
2164         struct mansession_session *session;
2165         time_t now = time(NULL);
2166 #define HSMCONN_FORMAT1 "  %-15.15s  %-55.55s  %-10.10s  %-10.10s  %-8.8s  %-8.8s  %-5.5s  %-5.5s\n"
2167 #define HSMCONN_FORMAT2 "  %-15.15s  %-55.55s  %-10d  %-10d  %-8d  %-8d  %-5.5d  %-5.5d\n"
2168         int count = 0;
2169         struct ao2_iterator i;
2170
2171         switch (cmd) {
2172         case CLI_INIT:
2173                 e->command = "manager show connected";
2174                 e->usage =
2175                         "Usage: manager show connected\n"
2176                         "       Prints a listing of the users that are currently connected to the\n"
2177                         "Asterisk manager interface.\n";
2178                 return NULL;
2179         case CLI_GENERATE:
2180                 return NULL;
2181         }
2182
2183         ast_cli(a->fd, HSMCONN_FORMAT1, "Username", "IP Address", "Start", "Elapsed", "FileDes", "HttpCnt", "Read", "Write");
2184
2185         sessions = ao2_global_obj_ref(mgr_sessions);
2186         if (sessions) {
2187                 i = ao2_iterator_init(sessions, 0);
2188                 ao2_ref(sessions, -1);
2189                 while ((session = ao2_iterator_next(&i))) {
2190                         ao2_lock(session);
2191                         ast_cli(a->fd, HSMCONN_FORMAT2, session->username,
2192                                 ast_sockaddr_stringify_addr(&session->addr),
2193                                 (int) (session->sessionstart),
2194                                 (int) (now - session->sessionstart),
2195                                 session->fd,
2196                                 session->inuse,
2197                                 session->readperm,
2198                                 session->writeperm);
2199                         count++;
2200                         ao2_unlock(session);
2201                         unref_mansession(session);
2202                 }
2203                 ao2_iterator_destroy(&i);
2204         }
2205         ast_cli(a->fd, "%d users connected.\n", count);
2206
2207         return CLI_SUCCESS;
2208 }
2209
2210 /*! \brief CLI command manager list eventq */
2211 /* Should change to "manager show connected" */
2212 static char *handle_showmaneventq(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2213 {
2214         struct eventqent *s;
2215         switch (cmd) {
2216         case CLI_INIT:
2217                 e->command = "manager show eventq";
2218                 e->usage =
2219                         "Usage: manager show eventq\n"
2220                         "       Prints a listing of all events pending in the Asterisk manger\n"
2221                         "event queue.\n";
2222                 return NULL;
2223         case CLI_GENERATE:
2224                 return NULL;
2225         }
2226         AST_RWLIST_RDLOCK(&all_events);
2227         AST_RWLIST_TRAVERSE(&all_events, s, eq_next) {
2228                 ast_cli(a->fd, "Usecount: %d\n", s->usecount);
2229                 ast_cli(a->fd, "Category: %d\n", s->category);
2230                 ast_cli(a->fd, "Event:\n%s", s->eventdata);
2231         }
2232         AST_RWLIST_UNLOCK(&all_events);
2233
2234         return CLI_SUCCESS;
2235 }
2236
2237 /*! \brief CLI command manager reload */
2238 static char *handle_manager_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2239 {
2240         switch (cmd) {
2241         case CLI_INIT:
2242                 e->command = "manager reload";
2243                 e->usage =
2244                         "Usage: manager reload\n"
2245                         "       Reloads the manager configuration.\n";
2246                 return NULL;
2247         case CLI_GENERATE:
2248                 return NULL;
2249         }
2250         if (a->argc > 2) {
2251                 return CLI_SHOWUSAGE;
2252         }
2253         reload_manager();
2254         return CLI_SUCCESS;
2255 }
2256
2257 static struct eventqent *advance_event(struct eventqent *e)
2258 {
2259         struct eventqent *next;
2260
2261         AST_RWLIST_RDLOCK(&all_events);
2262         if ((next = AST_RWLIST_NEXT(e, eq_next))) {
2263                 ast_atomic_fetchadd_int(&next->usecount, 1);
2264                 ast_atomic_fetchadd_int(&e->usecount, -1);
2265         }
2266         AST_RWLIST_UNLOCK(&all_events);
2267         return next;
2268 }
2269
2270 #define GET_HEADER_FIRST_MATCH  0
2271 #define GET_HEADER_LAST_MATCH   1
2272 #define GET_HEADER_SKIP_EMPTY   2
2273
2274 /*!
2275  * \brief Return a matching header value.
2276  *
2277  * \details
2278  * Generic function to return either the first or the last
2279  * matching header from a list of variables, possibly skipping
2280  * empty strings.
2281  *
2282  * \note At the moment there is only one use of this function in
2283  * this file, so we make it static.
2284  *
2285  * \note Never returns NULL.
2286  */
2287 static const char *__astman_get_header(const struct message *m, char *var, int mode)
2288 {
2289         int x, l = strlen(var);
2290         const char *result = "";
2291
2292         if (!m) {
2293                 return result;
2294         }
2295
2296         for (x = 0; x < m->hdrcount; x++) {
2297                 const char *h = m->headers[x];
2298                 if (!strncasecmp(var, h, l) && h[l] == ':') {
2299                         const char *value = h + l + 1;
2300                         value = ast_skip_blanks(value); /* ignore leading spaces in the value */
2301                         /* found a potential candidate */
2302                         if ((mode & GET_HEADER_SKIP_EMPTY) && ast_strlen_zero(value)) {
2303                                 continue;       /* not interesting */
2304                         }
2305                         if (mode & GET_HEADER_LAST_MATCH) {
2306                                 result = value; /* record the last match so far */
2307                         } else {
2308                                 return value;
2309                         }
2310                 }
2311         }
2312
2313         return result;
2314 }
2315
2316 /*!
2317  * \brief Return the first matching variable from an array.
2318  *
2319  * \note This is the legacy function and is implemented in
2320  * therms of __astman_get_header().
2321  *
2322  * \note Never returns NULL.
2323  */
2324 const char *astman_get_header(const struct message *m, char *var)
2325 {
2326         return __astman_get_header(m, var, GET_HEADER_FIRST_MATCH);
2327 }
2328
2329 /*!
2330  * \internal
2331  * \brief Process one "Variable:" header value string.
2332  *
2333  * \param head Current list of AMI variables to get new values added.
2334  * \param hdr_val Header value string to process.
2335  *
2336  * \return New variable list head.
2337  */
2338 static struct ast_variable *man_do_variable_value(struct ast_variable *head, const char *hdr_val)
2339 {
2340         char *parse;
2341         AST_DECLARE_APP_ARGS(args,
2342                 AST_APP_ARG(vars)[64];
2343         );
2344
2345         hdr_val = ast_skip_blanks(hdr_val); /* ignore leading spaces in the value */
2346         parse = ast_strdupa(hdr_val);
2347
2348         /* Break the header value string into name=val pair items. */
2349         AST_STANDARD_APP_ARGS(args, parse);
2350         if (args.argc) {
2351                 int y;
2352
2353                 /* Process each name=val pair item. */
2354                 for (y = 0; y < args.argc; y++) {
2355                         struct ast_variable *cur;
2356                         char *var;
2357                         char *val;
2358
2359                         if (!args.vars[y]) {
2360                                 continue;
2361                         }
2362                         var = val = args.vars[y];
2363                         strsep(&val, "=");
2364
2365                         /* XXX We may wish to trim whitespace from the strings. */
2366                         if (!val || ast_strlen_zero(var)) {
2367                                 continue;
2368                         }
2369
2370                         /* Create new variable list node and prepend it to the list. */
2371                         cur = ast_variable_new(var, val, "");
2372                         if (cur) {
2373                                 cur->next = head;
2374                                 head = cur;
2375                         }
2376                 }
2377         }
2378
2379         return head;
2380 }
2381
2382 struct ast_variable *astman_get_variables(const struct message *m)
2383 {
2384         return astman_get_variables_order(m, ORDER_REVERSE);
2385 }
2386
2387 struct ast_variable *astman_get_variables_order(const struct message *m,
2388         enum variable_orders order)
2389 {
2390         int varlen;
2391         int x;
2392         struct ast_variable *head = NULL;
2393
2394         static const char var_hdr[] = "Variable:";
2395
2396         /* Process all "Variable:" headers. */
2397         varlen = strlen(var_hdr);
2398         for (x = 0; x < m->hdrcount; x++) {
2399                 if (strncasecmp(var_hdr, m->headers[x], varlen)) {
2400                         continue;
2401                 }
2402                 head = man_do_variable_value(head, m->headers[x] + varlen);
2403         }
2404
2405         if (order == ORDER_NATURAL) {
2406                 head = ast_variables_reverse(head);
2407         }
2408
2409         return head;
2410 }
2411
2412 /*! \brief access for hooks to send action messages to ami */
2413 int ast_hook_send_action(struct manager_custom_hook *hook, const char *msg)
2414 {
2415         const char *action;
2416         int ret = 0;
2417         struct manager_action *act_found;
2418         struct mansession s = {.session = NULL, };
2419         struct message m = { 0 };
2420         char *dup_str;
2421         char *src;
2422         int x = 0;
2423         int curlen;
2424
2425         if (hook == NULL) {
2426                 return -1;
2427         }
2428
2429         /* Create our own copy of the AMI action msg string. */
2430         src = dup_str = ast_strdup(msg);
2431         if (!dup_str) {
2432                 return -1;
2433         }
2434
2435         /* convert msg string to message struct */
2436         curlen = strlen(src);
2437         for (x = 0; x < curlen; x++) {
2438                 int cr; /* set if we have \r */
2439                 if (src[x] == '\r' && x+1 < curlen && src[x+1] == '\n')
2440                         cr = 2; /* Found. Update length to include \r\n */
2441                 else if (src[x] == '\n')
2442                         cr = 1; /* also accept \n only */
2443                 else
2444                         continue;
2445                 /* don't keep empty lines */
2446                 if (x && m.hdrcount < ARRAY_LEN(m.headers)) {
2447                         /* ... but trim \r\n and terminate the header string */
2448                         src[x] = '\0';
2449                         m.headers[m.hdrcount++] = src;
2450                 }
2451                 x += cr;
2452                 curlen -= x;            /* remaining size */
2453                 src += x;               /* update pointer */
2454                 x = -1;                 /* reset loop */
2455         }
2456
2457         action = astman_get_header(&m, "Action");
2458         if (strcasecmp(action, "login")) {
2459                 act_found = action_find(action);
2460                 if (act_found) {
2461                         /*
2462                          * we have to simulate a session for this action request
2463                          * to be able to pass it down for processing
2464                          * This is necessary to meet the previous design of manager.c
2465                          */
2466                         s.hook = hook;
2467                         s.f = (void*)1; /* set this to something so our request will make it through all functions that test it*/
2468
2469                         ao2_lock(act_found);
2470                         if (act_found->registered && act_found->func) {
2471                                 if (act_found->module) {
2472                                         ast_module_ref(act_found->module);
2473                                 }
2474                                 ao2_unlock(act_found);
2475                                 ret = act_found->func(&s, &m);
2476                                 ao2_lock(act_found);
2477                                 if (act_found->module) {
2478                                         ast_module_unref(act_found->module);
2479                                 }
2480                         } else {
2481                                 ret = -1;
2482                         }
2483                         ao2_unlock(act_found);
2484                         ao2_t_ref(act_found, -1, "done with found action object");
2485                 }
2486         }
2487         ast_free(dup_str);
2488         return ret;
2489 }
2490
2491
2492 /*!
2493  * helper function to send a string to the socket.
2494  * Return -1 on error (e.g. buffer full).
2495  */
2496 static int send_string(struct mansession *s, char *string)
2497 {
2498         int res;
2499         FILE *f = s->f ? s->f : s->session->f;
2500         int fd = s->f ? s->fd : s->session->fd;
2501
2502         /* It's a result from one of the hook's action invocation */
2503         if (s->hook) {
2504                 /*
2505                  * to send responses, we're using the same function
2506                  * as for receiving events. We call the event "HookResponse"
2507                  */
2508                 s->hook->helper(EVENT_FLAG_HOOKRESPONSE, "HookResponse", string);
2509                 return 0;
2510         }
2511
2512         if ((res = ast_careful_fwrite(f, fd, string, strlen(string), s->session->writetimeout))) {
2513                 s->write_error = 1;
2514         }
2515
2516         return res;
2517 }
2518
2519 /*!
2520  * \brief thread local buffer for astman_append
2521  *
2522  * \note This can not be defined within the astman_append() function
2523  *       because it declares a couple of functions that get used to
2524  *       initialize the thread local storage key.
2525  */
2526 AST_THREADSTORAGE(astman_append_buf);
2527
2528 AST_THREADSTORAGE(userevent_buf);
2529
2530 /*! \brief initial allocated size for the astman_append_buf and astman_send_*_va */
2531 #define ASTMAN_APPEND_BUF_INITSIZE   256
2532
2533 /*!
2534  * utility functions for creating AMI replies
2535  */
2536 void astman_append(struct mansession *s, const char *fmt, ...)
2537 {
2538         va_list ap;
2539         struct ast_str *buf;
2540
2541         if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
2542                 return;
2543         }
2544
2545         va_start(ap, fmt);
2546         ast_str_set_va(&buf, 0, fmt, ap);
2547         va_end(ap);
2548
2549         if (s->f != NULL || s->session->f != NULL) {
2550                 send_string(s, ast_str_buffer(buf));
2551         } else {
2552                 ast_verbose("fd == -1 in astman_append, should not happen\n");
2553         }
2554 }
2555
2556 /*! \note NOTE: XXX this comment is unclear and possibly wrong.
2557    Callers of astman_send_error(), astman_send_response() or astman_send_ack() must EITHER
2558    hold the session lock _or_ be running in an action callback (in which case s->session->busy will
2559    be non-zero). In either of these cases, there is no need to lock-protect the session's
2560    fd, since no other output will be sent (events will be queued), and no input will
2561    be read until either the current action finishes or get_input() obtains the session
2562    lock.
2563  */
2564
2565 /*! \todo XXX MSG_MOREDATA should go to a header file. */
2566 #define MSG_MOREDATA    ((char *)astman_send_response)
2567
2568 /*! \brief send a response with an optional message,
2569  * and terminate it with an empty line.
2570  * m is used only to grab the 'ActionID' field.
2571  *
2572  * Use the explicit constant MSG_MOREDATA to remove the empty line.
2573  * XXX MSG_MOREDATA should go to a header file.
2574  */
2575 static void astman_send_response_full(struct mansession *s, const struct message *m, char *resp, char *msg, char *listflag)
2576 {
2577         const char *id = astman_get_header(m, "ActionID");
2578
2579         astman_append(s, "Response: %s\r\n", resp);
2580         if (!ast_strlen_zero(id)) {
2581                 astman_append(s, "ActionID: %s\r\n", id);
2582         }
2583         if (listflag) {
2584                 astman_append(s, "EventList: %s\r\n", listflag);        /* Start, complete, cancelled */
2585         }
2586         if (msg == MSG_MOREDATA) {
2587                 return;
2588         } else if (msg) {
2589                 astman_append(s, "Message: %s\r\n\r\n", msg);
2590         } else {
2591                 astman_append(s, "\r\n");
2592         }
2593 }
2594
2595 void astman_send_response(struct mansession *s, const struct message *m, char *resp, char *msg)
2596 {
2597         astman_send_response_full(s, m, resp, msg, NULL);
2598 }
2599
2600 void astman_send_error(struct mansession *s, const struct message *m, char *error)
2601 {
2602         astman_send_response_full(s, m, "Error", error, NULL);
2603 }
2604
2605 void astman_send_error_va(struct mansession *s, const struct message *m, const char *fmt, ...)
2606 {
2607         va_list ap;
2608         struct ast_str *buf;
2609         char *msg;
2610
2611         if (!(buf = ast_str_thread_get(&astman_append_buf, ASTMAN_APPEND_BUF_INITSIZE))) {
2612                 return;
2613         }
2614
2615         va_start(ap, fmt);
2616         ast_str_set_va(&buf, 0, fmt, ap);
2617         va_end(ap);
2618
2619         /* astman_append will use the same underlying buffer, so copy the message out
2620          * before sending the response */
2621         msg = ast_str_buffer(buf);
2622         if (msg) {
2623                 msg = ast_strdupa(msg);
2624         }
2625         astman_send_response_full(s, m, "Error", msg, NULL);
2626 }
2627
2628 void astman_send_ack(struct mansession *s, const struct message *m, char *msg)
2629 {
2630         astman_send_response_full(s, m, "Success", msg, NULL);
2631 }
2632
2633 static void astman_start_ack(struct mansession *s, const struct message *m)
2634 {
2635         astman_send_response_full(s, m, "Success", MSG_MOREDATA, NULL);
2636 }
2637
2638 void astman_send_listack(struct mansession *s, const struct message *m, char *msg, char *listflag)
2639 {
2640         astman_send_response_full(s, m, "Success", msg, listflag);
2641 }
2642
2643 /*! \brief Lock the 'mansession' structure. */
2644 static void mansession_lock(struct mansession *s)
2645 {
2646         ast_mutex_lock(&s->lock);
2647 }
2648
2649 /*! \brief Unlock the 'mansession' structure. */
2650 static void mansession_unlock(struct mansession *s)
2651 {
2652         ast_mutex_unlock(&s->lock);
2653 }
2654
2655 /*! \brief
2656    Rather than braindead on,off this now can also accept a specific int mask value
2657    or a ',' delim list of mask strings (the same as manager.conf) -anthm
2658 */
2659 static int set_eventmask(struct mansession *s, const char *eventmask)
2660 {
2661         int maskint = strings_to_mask(eventmask);
2662
2663         ao2_lock(s->session);
2664         if (maskint >= 0) {
2665                 s->session->send_events = maskint;
2666         }
2667         ao2_unlock(s->session);
2668
2669         return maskint;
2670 }
2671
2672 static enum ast_transport mansession_get_transport(const struct mansession *s)
2673 {
2674         return s->tcptls_session->parent->tls_cfg ? AST_TRANSPORT_TLS :
2675                         AST_TRANSPORT_TCP;
2676 }
2677
2678 static void report_invalid_user(const struct mansession *s, const char *username)
2679 {
2680         char session_id[32];
2681         struct ast_security_event_inval_acct_id inval_acct_id = {
2682                 .common.event_type = AST_SECURITY_EVENT_INVAL_ACCT_ID,
2683                 .common.version    = AST_SECURITY_EVENT_INVAL_ACCT_ID_VERSION,
2684                 .common.service    = "AMI",
2685                 .common.account_id = username,
2686                 .common.session_tv = &s->session->sessionstart_tv,
2687                 .common.local_addr = {
2688                         .addr      = &s->tcptls_session->parent->local_address,
2689                         .transport = mansession_get_transport(s),
2690                 },
2691                 .common.remote_addr = {
2692                         .addr      = &s->session->addr,
2693                         .transport = mansession_get_transport(s),
2694                 },
2695                 .common.session_id = session_id,
2696         };
2697
2698         snprintf(session_id, sizeof(session_id), "%p", s);
2699
2700         ast_security_event_report(AST_SEC_EVT(&inval_acct_id));
2701 }
2702
2703 static void report_failed_acl(const struct mansession *s, const char *username)
2704 {
2705         char session_id[32];
2706         struct ast_security_event_failed_acl failed_acl_event = {
2707                 .common.event_type = AST_SECURITY_EVENT_FAILED_ACL,
2708                 .common.version    = AST_SECURITY_EVENT_FAILED_ACL_VERSION,
2709                 .common.service    = "AMI",
2710                 .common.account_id = username,
2711                 .common.session_tv = &s->session->sessionstart_tv,
2712                 .common.local_addr = {
2713                         .addr      = &s->tcptls_session->parent->local_address,
2714                         .transport = mansession_get_transport(s),
2715                 },
2716                 .common.remote_addr = {
2717                         .addr      = &s->session->addr,
2718                         .transport = mansession_get_transport(s),
2719                 },
2720                 .common.session_id = session_id,
2721         };
2722
2723         snprintf(session_id, sizeof(session_id), "%p", s->session);
2724
2725         ast_security_event_report(AST_SEC_EVT(&failed_acl_event));
2726 }
2727
2728 static void report_inval_password(const struct mansession *s, const char *username)
2729 {
2730         char session_id[32];
2731         struct ast_security_event_inval_password inval_password = {
2732                 .common.event_type = AST_SECURITY_EVENT_INVAL_PASSWORD,
2733                 .common.version    = AST_SECURITY_EVENT_INVAL_PASSWORD_VERSION,
2734                 .common.service    = "AMI",
2735                 .common.account_id = username,
2736                 .common.session_tv = &s->session->sessionstart_tv,
2737                 .common.local_addr = {
2738                         .addr      = &s->tcptls_session->parent->local_address,
2739                         .transport = mansession_get_transport(s),
2740                 },
2741                 .common.remote_addr = {
2742                         .addr      = &s->session->addr,
2743                         .transport = mansession_get_transport(s),
2744                 },
2745                 .common.session_id = session_id,
2746         };
2747
2748         snprintf(session_id, sizeof(session_id), "%p", s->session);
2749
2750         ast_security_event_report(AST_SEC_EVT(&inval_password));
2751 }
2752
2753 static void report_auth_success(const struct mansession *s)
2754 {
2755         char session_id[32];
2756         struct ast_security_event_successful_auth successful_auth = {
2757                 .common.event_type = AST_SECURITY_EVENT_SUCCESSFUL_AUTH,
2758                 .common.version    = AST_SECURITY_EVENT_SUCCESSFUL_AUTH_VERSION,
2759                 .common.service    = "AMI",
2760                 .common.account_id = s->session->username,
2761                 .common.session_tv = &s->session->sessionstart_tv,
2762                 .common.local_addr = {
2763                         .addr      = &s->tcptls_session->parent->local_address,
2764                         .transport = mansession_get_transport(s),
2765                 },
2766                 .common.remote_addr = {
2767                         .addr      = &s->session->addr,
2768                         .transport = mansession_get_transport(s),
2769                 },
2770                 .common.session_id = session_id,
2771         };
2772
2773         snprintf(session_id, sizeof(session_id), "%p", s->session);
2774
2775         ast_security_event_report(AST_SEC_EVT(&successful_auth));
2776 }
2777
2778 static void report_req_not_allowed(const struct mansession *s, const char *action)
2779 {
2780         char session_id[32];
2781         char request_type[64];
2782         struct ast_security_event_req_not_allowed req_not_allowed = {
2783                 .common.event_type = AST_SECURITY_EVENT_REQ_NOT_ALLOWED,
2784                 .common.version    = AST_SECURITY_EVENT_REQ_NOT_ALLOWED_VERSION,
2785                 .common.service    = "AMI",
2786                 .common.account_id = s->session->username,
2787                 .common.session_tv = &s->session->sessionstart_tv,
2788                 .common.local_addr = {
2789                         .addr      = &s->tcptls_session->parent->local_address,
2790                         .transport = mansession_get_transport(s),
2791                 },
2792                 .common.remote_addr = {
2793                         .addr      = &s->session->addr,
2794                         .transport = mansession_get_transport(s),
2795                 },
2796                 .common.session_id = session_id,
2797
2798                 .request_type      = request_type,
2799         };
2800
2801         snprintf(session_id, sizeof(session_id), "%p", s->session);
2802         snprintf(request_type, sizeof(request_type), "Action: %s", action);
2803
2804         ast_security_event_report(AST_SEC_EVT(&req_not_allowed));
2805 }
2806
2807 static void report_req_bad_format(const struct mansession *s, const char *action)
2808 {
2809         char session_id[32];
2810         char request_type[64];
2811         struct ast_security_event_req_bad_format req_bad_format = {
2812                 .common.event_type = AST_SECURITY_EVENT_REQ_BAD_FORMAT,
2813                 .common.version    = AST_SECURITY_EVENT_REQ_BAD_FORMAT_VERSION,
2814                 .common.service    = "AMI",
2815                 .common.account_id = s->session->username,
2816                 .common.session_tv = &s->session->sessionstart_tv,
2817                 .common.local_addr = {
2818                         .addr      = &s->tcptls_session->parent->local_address,
2819                         .transport = mansession_get_transport(s),
2820                 },
2821                 .common.remote_addr = {
2822                         .addr      = &s->session->addr,
2823                         .transport = mansession_get_transport(s),
2824                 },
2825                 .common.session_id = session_id,
2826
2827                 .request_type      = request_type,
2828         };
2829
2830         snprintf(session_id, sizeof(session_id), "%p", s->session);
2831         snprintf(request_type, sizeof(request_type), "Action: %s", action);
2832
2833         ast_security_event_report(AST_SEC_EVT(&req_bad_format));
2834 }
2835
2836 static void report_failed_challenge_response(const struct mansession *s,
2837                 const char *response, const char *expected_response)
2838 {
2839         char session_id[32];
2840         struct ast_security_event_chal_resp_failed chal_resp_failed = {
2841                 .common.event_type = AST_SECURITY_EVENT_CHAL_RESP_FAILED,
2842                 .common.version    = AST_SECURITY_EVENT_CHAL_RESP_FAILED_VERSION,
2843                 .common.service    = "AMI",
2844                 .common.account_id = s->session->username,
2845                 .common.session_tv = &s->session->sessionstart_tv,
2846                 .common.local_addr = {
2847                         .addr      = &s->tcptls_session->parent->local_address,
2848                         .transport = mansession_get_transport(s),
2849                 },
2850                 .common.remote_addr = {
2851                         .addr      = &s->session->addr,
2852                         .transport = mansession_get_transport(s),
2853                 },
2854                 .common.session_id = session_id,
2855
2856                 .challenge         = s->session->challenge,
2857                 .response          = response,
2858                 .expected_response = expected_response,
2859         };
2860
2861         snprintf(session_id, sizeof(session_id), "%p", s->session);
2862
2863         ast_security_event_report(AST_SEC_EVT(&chal_resp_failed));
2864 }
2865
2866 static void report_session_limit(const struct mansession *s)
2867 {
2868         char session_id[32];
2869         struct ast_security_event_session_limit session_limit = {
2870                 .common.event_type = AST_SECURITY_EVENT_SESSION_LIMIT,
2871                 .common.version    = AST_SECURITY_EVENT_SESSION_LIMIT_VERSION,
2872                 .common.service    = "AMI",
2873                 .common.account_id = s->session->username,
2874                 .common.session_tv = &s->session->sessionstart_tv,
2875                 .common.local_addr = {
2876                         .addr      = &s->tcptls_session->parent->local_address,
2877                         .transport = mansession_get_transport(s),
2878                 },
2879                 .common.remote_addr = {
2880                         .addr      = &s->session->addr,
2881                         .transport = mansession_get_transport(s),
2882                 },
2883                 .common.session_id = session_id,
2884         };
2885
2886         snprintf(session_id, sizeof(session_id), "%p", s->session);
2887
2888         ast_security_event_report(AST_SEC_EVT(&session_limit));
2889 }
2890
2891 /*
2892  * Here we start with action_ handlers for AMI actions,
2893  * and the internal functions used by them.
2894  * Generally, the handlers are called action_foo()
2895  */
2896
2897 /* helper function for action_login() */
2898 static int authenticate(struct mansession *s, const struct message *m)
2899 {
2900         const char *username = astman_get_header(m, "Username");
2901         const char *password = astman_get_header(m, "Secret");
2902         int error = -1;
2903         struct ast_manager_user *user = NULL;
2904         regex_t *regex_filter;
2905         struct ao2_iterator filter_iter;
2906
2907         if (ast_strlen_zero(username)) {        /* missing username */
2908                 return -1;
2909         }
2910
2911         /* locate user in locked state */
2912         AST_RWLIST_WRLOCK(&users);
2913
2914         if (!(user = get_manager_by_name_locked(username))) {
2915                 report_invalid_user(s, username);
2916                 ast_log(LOG_NOTICE, "%s tried to authenticate with nonexistent user '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2917         } else if (user->acl && (ast_apply_acl(user->acl, &s->session->addr, "Manager User ACL: ") == AST_SENSE_DENY)) {
2918                 report_failed_acl(s, username);
2919                 ast_log(LOG_NOTICE, "%s failed to pass IP ACL as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2920         } else if (!strcasecmp(astman_get_header(m, "AuthType"), "MD5")) {
2921                 const char *key = astman_get_header(m, "Key");
2922                 if (!ast_strlen_zero(key) && !ast_strlen_zero(s->session->challenge) && user->secret) {
2923                         int x;
2924                         int len = 0;
2925                         char md5key[256] = "";
2926                         struct MD5Context md5;
2927                         unsigned char digest[16];
2928
2929                         MD5Init(&md5);
2930                         MD5Update(&md5, (unsigned char *) s->session->challenge, strlen(s->session->challenge));
2931                         MD5Update(&md5, (unsigned char *) user->secret, strlen(user->secret));
2932                         MD5Final(digest, &md5);
2933                         for (x = 0; x < 16; x++)
2934                                 len += sprintf(md5key + len, "%2.2x", (unsigned)digest[x]);
2935                         if (!strcmp(md5key, key)) {
2936                                 error = 0;
2937                         } else {
2938                                 report_failed_challenge_response(s, key, md5key);
2939                         }
2940                 } else {
2941                         ast_debug(1, "MD5 authentication is not possible.  challenge: '%s'\n",
2942                                 S_OR(s->session->challenge, ""));
2943                 }
2944         } else if (user->secret) {
2945                 if (!strcmp(password, user->secret)) {
2946                         error = 0;
2947                 } else {
2948                         report_inval_password(s, username);
2949                 }
2950         }
2951
2952         if (error) {
2953                 ast_log(LOG_NOTICE, "%s failed to authenticate as '%s'\n", ast_sockaddr_stringify_addr(&s->session->addr), username);
2954                 AST_RWLIST_UNLOCK(&users);
2955                 return -1;
2956         }
2957
2958         /* auth complete */
2959
2960         /* All of the user parameters are copied to the session so that in the event
2961         * of a reload and a configuration change, the session parameters are not
2962         * changed. */
2963         ast_copy_string(s->session->username, username, sizeof(s->session->username));
2964         s->session->readperm = user->readperm;
2965         s->session->writeperm = user->writeperm;
2966         s->session->writetimeout = user->writetimeout;
2967         if (user->chanvars) {
2968                 s->session->chanvars = ast_variables_dup(user->chanvars);
2969         }
2970
2971         filter_iter = ao2_iterator_init(user->whitefilters, 0);
2972         while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2973                 ao2_t_link(s->session->whitefilters, regex_filter, "add white user filter to session");
2974                 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2975         }
2976         ao2_iterator_destroy(&filter_iter);
2977
2978         filter_iter = ao2_iterator_init(user->blackfilters, 0);
2979         while ((regex_filter = ao2_iterator_next(&filter_iter))) {
2980                 ao2_t_link(s->session->blackfilters, regex_filter, "add black user filter to session");
2981                 ao2_t_ref(regex_filter, -1, "remove iterator ref");
2982         }
2983         ao2_iterator_destroy(&filter_iter);
2984
2985         s->session->sessionstart = time(NULL);
2986         s->session->sessionstart_tv = ast_tvnow();
2987         set_eventmask(s, astman_get_header(m, "Events"));
2988
2989         report_auth_success(s);
2990
2991         AST_RWLIST_UNLOCK(&users);
2992         return 0;
2993 }
2994
2995 static int action_ping(struct mansession *s, const struct message *m)
2996 {
2997         const char *actionid = astman_get_header(m, "ActionID");
2998         struct timeval now = ast_tvnow();
2999
3000         astman_append(s, "Response: Success\r\n");
3001         if (!ast_strlen_zero(actionid)){
3002                 astman_append(s, "ActionID: %s\r\n", actionid);
3003         }
3004         astman_append(
3005                 s,
3006                 "Ping: Pong\r\n"
3007                 "Timestamp: %ld.%06lu\r\n"
3008                 "\r\n",
3009                 (long) now.tv_sec, (unsigned long) now.tv_usec);
3010         return 0;
3011 }
3012
3013 static int action_getconfig(struct mansession *s, const struct message *m)
3014 {
3015         struct ast_config *cfg;
3016         const char *fn = astman_get_header(m, "Filename");
3017         const char *category = astman_get_header(m, "Category");
3018         int catcount = 0;
3019         int lineno = 0;
3020         char *cur_category = NULL;
3021         struct ast_variable *v;
3022         struct ast_flags config_flags = { CONFIG_FLAG_WITHCOMMENTS | CONFIG_FLAG_NOCACHE };
3023
3024         if (ast_strlen_zero(fn)) {
3025                 astman_send_error(s, m, "Filename not specified");
3026                 return 0;
3027         }
3028         cfg = ast_config_load2(fn, "manager", config_flags);
3029         if (cfg == CONFIG_STATUS_FILEMISSING) {