Doxygen Cleanup
[asterisk/asterisk.git] / channels / chan_sip.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2012, 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 /*!
20  * \file
21  * \brief Implementation of Session Initiation Protocol
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * See Also:
26  * \arg \ref AstCREDITS
27  *
28  * Implementation of RFC 3261 - without S/MIME, and experimental TCP and TLS support
29  * Configuration file \link Config_sip sip.conf \endlink
30  *
31  * ********** IMPORTANT *
32  * \note TCP/TLS support is EXPERIMENTAL and WILL CHANGE. This applies to configuration
33  *      settings, dialplan commands and dialplans apps/functions
34  * See \ref sip_tcp_tls
35  *
36  *
37  * ******** General TODO:s
38  * \todo Better support of forking
39  * \todo VIA branch tag transaction checking
40  * \todo Transaction support
41  *
42  * ******** Wishlist: Improvements
43  * - Support of SIP domains for devices, so that we match on username\@domain in the From: header
44  * - Connect registrations with a specific device on the incoming call. It's not done
45  *   automatically in Asterisk
46  *
47  * \ingroup channel_drivers
48  *
49  * \par Overview of the handling of SIP sessions
50  * The SIP channel handles several types of SIP sessions, or dialogs,
51  * not all of them being "telephone calls".
52  * - Incoming calls that will be sent to the PBX core
53  * - Outgoing calls, generated by the PBX
54  * - SIP subscriptions and notifications of states and voicemail messages
55  * - SIP registrations, both inbound and outbound
56  * - SIP peer management (peerpoke, OPTIONS)
57  * - SIP text messages
58  *
59  * In the SIP channel, there's a list of active SIP dialogs, which includes
60  * all of these when they are active. "sip show channels" in the CLI will
61  * show most of these, excluding subscriptions which are shown by
62  * "sip show subscriptions"
63  *
64  * \par incoming packets
65  * Incoming packets are received in the monitoring thread, then handled by
66  * sipsock_read() for udp only. In tcp, packets are read by the tcp_helper thread.
67  * sipsock_read() function parses the packet and matches an existing
68  * dialog or starts a new SIP dialog.
69  *
70  * sipsock_read sends the packet to handle_incoming(), that parses a bit more.
71  * If it is a response to an outbound request, the packet is sent to handle_response().
72  * If it is a request, handle_incoming() sends it to one of a list of functions
73  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
74  * sipsock_read locks the ast_channel if it exists (an active call) and
75  * unlocks it after we have processed the SIP message.
76  *
77  * A new INVITE is sent to handle_request_invite(), that will end up
78  * starting a new channel in the PBX, the new channel after that executing
79  * in a separate channel thread. This is an incoming "call".
80  * When the call is answered, either by a bridged channel or the PBX itself
81  * the sip_answer() function is called.
82  *
83  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
84  * in rtp.c
85  *
86  * \par Outbound calls
87  * Outbound calls are set up by the PBX through the sip_request_call()
88  * function. After that, they are activated by sip_call().
89  *
90  * \par Hanging up
91  * The PBX issues a hangup on both incoming and outgoing calls through
92  * the sip_hangup() function
93  */
94
95 /*! 
96  * \li The channel chan_sip uses configuration files \ref sip.conf and \ref sip_notify.conf
97  * \addtogroup configuration_file
98  */
99
100 /*! \page sip.conf sip.conf
101  * \verbinclude sip.conf.sample
102  */
103
104 /*! \page sip_notify.conf sip_notify.conf
105  * \verbinclude sip_notify.conf.sample
106  */
107
108 /*!
109  * \page sip_tcp_tls SIP TCP and TLS support
110  *
111  * \par tcpfixes TCP implementation changes needed
112  * \todo Fix TCP/TLS handling in dialplan, SRV records, transfers and much more
113  * \todo Save TCP/TLS sessions in registry
114  *      If someone registers a SIPS uri, this forces us to set up a TLS connection back.
115  * \todo Add TCP/TLS information to function SIPPEER and SIPCHANINFO
116  * \todo If tcpenable=yes, we must open a TCP socket on the same address as the IP for UDP.
117  *      The tcpbindaddr config option should only be used to open ADDITIONAL ports
118  *      So we should propably go back to
119  *              bindaddr= the default address to bind to. If tcpenable=yes, then bind this to both udp and TCP
120  *                              if tlsenable=yes, open TLS port (provided we also have cert)
121  *              tcpbindaddr = extra address for additional TCP connections
122  *              tlsbindaddr = extra address for additional TCP/TLS connections
123  *              udpbindaddr = extra address for additional UDP connections
124  *                      These three options should take multiple IP/port pairs
125  *      Note: Since opening additional listen sockets is a *new* feature we do not have today
126  *              the XXXbindaddr options needs to be disabled until we have support for it
127  *
128  * \todo re-evaluate the transport= setting in sip.conf. This is right now not well
129  *      thought of. If a device in sip.conf contacts us via TCP, we should not switch transport,
130  *      even if udp is the configured first transport.
131  *
132  * \todo Be prepared for one outbound and another incoming socket per pvt. This applies
133  *       specially to communication with other peers (proxies).
134  * \todo We need to test TCP sessions with SIP proxies and in regards
135  *       to the SIP outbound specs.
136  * \todo ;transport=tls was deprecated in RFC3261 and should not be used at all. See section 26.2.2.
137  *
138  * \todo If the message is smaller than the given Content-length, the request should get a 400 Bad request
139  *       message. If it's a response, it should be dropped. (RFC 3261, Section 18.3)
140  * \todo Since we have had multidomain support in Asterisk for quite a while, we need to support
141  *       multiple domains in our TLS implementation, meaning one socket and one cert per domain
142  * \todo Selection of transport for a request needs to be done after we've parsed all route headers,
143  *       also considering outbound proxy options.
144  *              First request: Outboundproxy, routes, (reg contact or URI. If URI doesn't have port:  DNS naptr, srv, AAA)
145  *              Intermediate requests: Outboundproxy(only when forced), routes, contact/uri
146  *      DNS naptr support is crucial. A SIP uri might lead to a TLS connection.
147  *      Also note that due to outbound proxy settings, a SIPS uri might have to be sent on UDP (not to recommend though)
148  * \todo Default transports are set to UDP, which cause the wrong behaviour when contacting remote
149  *      devices directly from the dialplan. UDP is only a fallback if no other method works,
150  *      in order to be compatible with RFC2543 (SIP/1.0) devices. For transactions that exceed the
151  *      MTU (like INIVTE with video, audio and RTT)  TCP should be preferred.
152  *
153  *      When dialling unconfigured peers (with no port number)  or devices in external domains
154  *      NAPTR records MUST be consulted to find configured transport. If they are not found,
155  *      SRV records for both TCP and UDP should be checked. If there's a record for TCP, use that.
156  *      If there's no record for TCP, then use UDP as a last resort. If there's no SRV records,
157  *      \note this only applies if there's no outbound proxy configured for the session. If an outbound
158  *      proxy is configured, these procedures might apply for locating the proxy and determining
159  *      the transport to use for communication with the proxy.
160  * \par Other bugs to fix ----
161  * __set_address_from_contact(const char *fullcontact, struct sockaddr_in *sin, int tcp)
162  *      - sets TLS port as default for all TCP connections, unless other port is given in contact.
163  * parse_register_contact(struct sip_pvt *pvt, struct sip_peer *peer, struct sip_request *req)
164  *      - assumes that the contact the UA registers is using the same transport as the REGISTER request, which is
165  *        a bad guess.
166  *      - Does not save any information about TCP/TLS connected devices, which is a severe BUG, as discussed on the mailing list.
167  * get_destination(struct sip_pvt *p, struct sip_request *oreq)
168  *      - Doesn't store the information that we got an incoming SIPS request in the channel, so that
169  *        we can require a secure signalling path OUT of Asterisk (on SIP or IAX2). Possibly, the call should
170  *        fail on in-secure signalling paths if there's no override in our configuration. At least, provide a
171  *        channel variable in the dialplan.
172  * get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req)
173  *      - As above, if we have a SIPS: uri in the refer-to header
174  *      - Does not check transport in refer_to uri.
175  */
176
177 /*** MODULEINFO
178         <use type="module">res_crypto</use>
179         <use type="module">res_http_websocket</use>
180         <depend>chan_local</depend>
181         <support_level>core</support_level>
182  ***/
183
184 /*!  \page sip_session_timers SIP Session Timers in Asterisk Chan_sip
185
186         The SIP Session-Timers is an extension of the SIP protocol that allows end-points and proxies to
187         refresh a session periodically. The sessions are kept alive by sending a RE-INVITE or UPDATE
188         request at a negotiated interval. If a session refresh fails then all the entities that support Session-
189         Timers clear their internal session state. In addition, UAs generate a BYE request in order to clear
190         the state in the proxies and the remote UA (this is done for the benefit of SIP entities in the path
191         that do not support Session-Timers).
192
193         The Session-Timers can be configured on a system-wide, per-user, or per-peer basis. The peruser/
194         per-peer settings override the global settings. The following new parameters have been
195         added to the sip.conf file.
196                 session-timers=["accept", "originate", "refuse"]
197                 session-expires=[integer]
198                 session-minse=[integer]
199                 session-refresher=["uas", "uac"]
200
201         The session-timers parameter in sip.conf defines the mode of operation of SIP session-timers feature in
202         Asterisk. The Asterisk can be configured in one of the following three modes:
203
204         1. Accept :: In the "accept" mode, the Asterisk server honors session-timers requests
205                 made by remote end-points. A remote end-point can request Asterisk to engage
206                 session-timers by either sending it an INVITE request with a "Supported: timer"
207                 header in it or by responding to Asterisk's INVITE with a 200 OK that contains
208                 Session-Expires: header in it. In this mode, the Asterisk server does not
209                 request session-timers from remote end-points. This is the default mode.
210         2. Originate :: In the "originate" mode, the Asterisk server requests the remote
211                 end-points to activate session-timers in addition to honoring such requests
212                 made by the remote end-pints. In order to get as much protection as possible
213                 against hanging SIP channels due to network or end-point failures, Asterisk
214                 resends periodic re-INVITEs even if a remote end-point does not support
215                 the session-timers feature.
216         3. Refuse :: In the "refuse" mode, Asterisk acts as if it does not support session-
217                 timers for inbound or outbound requests. If a remote end-point requests
218                 session-timers in a dialog, then Asterisk ignores that request unless it's
219                 noted as a requirement (Require: header), in which case the INVITE is
220                 rejected with a 420 Bad Extension response.
221
222 */
223
224 #include "asterisk.h"
225
226 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
227
228 #include <signal.h>
229 #include <sys/signal.h>
230 #include <regex.h>
231 #include <inttypes.h>
232
233 #include "asterisk/network.h"
234 #include "asterisk/paths.h"     /* need ast_config_AST_SYSTEM_NAME */
235 /*
236    Uncomment the define below,  if you are having refcount related memory leaks.
237    With this uncommented, this module will generate a file, /tmp/refs, which contains
238    a history of the ao2_ref() calls. To be useful, all calls to ao2_* functions should
239    be modified to ao2_t_* calls, and include a tag describing what is happening with
240    enough detail, to make pairing up a reference count increment with its corresponding decrement.
241    The refcounter program in utils/ can be invaluable in highlighting objects that are not
242    balanced, along with the complete history for that object.
243    In normal operation, the macros defined will throw away the tags, so they do not
244    affect the speed of the program at all. They can be considered to be documentation.
245 */
246 /* #define  REF_DEBUG 1 */
247
248 #include "asterisk/lock.h"
249 #include "asterisk/config.h"
250 #include "asterisk/module.h"
251 #include "asterisk/pbx.h"
252 #include "asterisk/sched.h"
253 #include "asterisk/io.h"
254 #include "asterisk/rtp_engine.h"
255 #include "asterisk/udptl.h"
256 #include "asterisk/acl.h"
257 #include "asterisk/manager.h"
258 #include "asterisk/callerid.h"
259 #include "asterisk/cli.h"
260 #include "asterisk/musiconhold.h"
261 #include "asterisk/dsp.h"
262 #include "asterisk/features.h"
263 #include "asterisk/srv.h"
264 #include "asterisk/astdb.h"
265 #include "asterisk/causes.h"
266 #include "asterisk/utils.h"
267 #include "asterisk/file.h"
268 #include "asterisk/astobj2.h"
269 #include "asterisk/dnsmgr.h"
270 #include "asterisk/devicestate.h"
271 #include "asterisk/monitor.h"
272 #include "asterisk/netsock2.h"
273 #include "asterisk/localtime.h"
274 #include "asterisk/abstract_jb.h"
275 #include "asterisk/threadstorage.h"
276 #include "asterisk/translate.h"
277 #include "asterisk/ast_version.h"
278 #include "asterisk/event.h"
279 #include "asterisk/cel.h"
280 #include "asterisk/data.h"
281 #include "asterisk/aoc.h"
282 #include "asterisk/message.h"
283 #include "sip/include/sip.h"
284 #include "sip/include/globals.h"
285 #include "sip/include/config_parser.h"
286 #include "sip/include/reqresp_parser.h"
287 #include "sip/include/sip_utils.h"
288 #include "sip/include/srtp.h"
289 #include "sip/include/sdp_crypto.h"
290 #include "asterisk/ccss.h"
291 #include "asterisk/xml.h"
292 #include "sip/include/dialog.h"
293 #include "sip/include/dialplan_functions.h"
294 #include "sip/include/security_events.h"
295 #include "asterisk/sip_api.h"
296
297 /*** DOCUMENTATION
298         <application name="SIPDtmfMode" language="en_US">
299                 <synopsis>
300                         Change the dtmfmode for a SIP call.
301                 </synopsis>
302                 <syntax>
303                         <parameter name="mode" required="true">
304                                 <enumlist>
305                                         <enum name="inband" />
306                                         <enum name="info" />
307                                         <enum name="rfc2833" />
308                                 </enumlist>
309                         </parameter>
310                 </syntax>
311                 <description>
312                         <para>Changes the dtmfmode for a SIP call.</para>
313                 </description>
314         </application>
315         <application name="SIPAddHeader" language="en_US">
316                 <synopsis>
317                         Add a SIP header to the outbound call.
318                 </synopsis>
319                 <syntax argsep=":">
320                         <parameter name="Header" required="true" />
321                         <parameter name="Content" required="true" />
322                 </syntax>
323                 <description>
324                         <para>Adds a header to a SIP call placed with DIAL.</para>
325                         <para>Remember to use the X-header if you are adding non-standard SIP
326                         headers, like <literal>X-Asterisk-Accountcode:</literal>. Use this with care.
327                         Adding the wrong headers may jeopardize the SIP dialog.</para>
328                         <para>Always returns <literal>0</literal>.</para>
329                 </description>
330         </application>
331         <application name="SIPRemoveHeader" language="en_US">
332                 <synopsis>
333                         Remove SIP headers previously added with SIPAddHeader
334                 </synopsis>
335                 <syntax>
336                         <parameter name="Header" required="false" />
337                 </syntax>
338                 <description>
339                         <para>SIPRemoveHeader() allows you to remove headers which were previously
340                         added with SIPAddHeader(). If no parameter is supplied, all previously added
341                         headers will be removed. If a parameter is supplied, only the matching headers
342                         will be removed.</para>
343                         <para>For example you have added these 2 headers:</para>
344                         <para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
345                         <para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
346                         <para></para>
347                         <para>// remove all headers</para>
348                         <para>SIPRemoveHeader();</para>
349                         <para>// remove all P- headers</para>
350                         <para>SIPRemoveHeader(P-);</para>
351                         <para>// remove only the PAI header (note the : at the end)</para>
352                         <para>SIPRemoveHeader(P-Asserted-Identity:);</para>
353                         <para></para>
354                         <para>Always returns <literal>0</literal>.</para>
355                 </description>
356         </application>
357         <application name="SIPSendCustomINFO" language="en_US">
358                 <synopsis>
359                         Send a custom INFO frame on specified channels.
360                 </synopsis>
361                 <syntax>
362                         <parameter name="Data" required="true" />
363                         <parameter name="UserAgent" required="false" />
364                 </syntax>
365                 <description>
366                         <para>SIPSendCustomINFO() allows you to send a custom INFO message on all
367                         active SIP channels or on channels with the specified User Agent. This
368                         application is only available if TEST_FRAMEWORK is defined.</para>
369                 </description>
370         </application>
371         <function name="SIP_HEADER" language="en_US">
372                 <synopsis>
373                         Gets the specified SIP header from an incoming INVITE message.
374                 </synopsis>
375                 <syntax>
376                         <parameter name="name" required="true" />
377                         <parameter name="number">
378                                 <para>If not specified, defaults to <literal>1</literal>.</para>
379                         </parameter>
380                 </syntax>
381                 <description>
382                         <para>Since there are several headers (such as Via) which can occur multiple
383                         times, SIP_HEADER takes an optional second argument to specify which header with
384                         that name to retrieve. Headers start at offset <literal>1</literal>.</para>
385                         <para>Please observe that contents of the SDP (an attachment to the 
386                         SIP request) can't be accessed with this function.</para>
387                 </description>
388         </function>
389         <function name="SIPPEER" language="en_US">
390                 <synopsis>
391                         Gets SIP peer information.
392                 </synopsis>
393                 <syntax>
394                         <parameter name="peername" required="true" />
395                         <parameter name="item">
396                                 <enumlist>
397                                         <enum name="ip">
398                                                 <para>(default) The IP address.</para>
399                                         </enum>
400                                         <enum name="port">
401                                                 <para>The port number.</para>
402                                         </enum>
403                                         <enum name="mailbox">
404                                                 <para>The configured mailbox.</para>
405                                         </enum>
406                                         <enum name="context">
407                                                 <para>The configured context.</para>
408                                         </enum>
409                                         <enum name="expire">
410                                                 <para>The epoch time of the next expire.</para>
411                                         </enum>
412                                         <enum name="dynamic">
413                                                 <para>Is it dynamic? (yes/no).</para>
414                                         </enum>
415                                         <enum name="callerid_name">
416                                                 <para>The configured Caller ID name.</para>
417                                         </enum>
418                                         <enum name="callerid_num">
419                                                 <para>The configured Caller ID number.</para>
420                                         </enum>
421                                         <enum name="callgroup">
422                                                 <para>The configured Callgroup.</para>
423                                         </enum>
424                                         <enum name="pickupgroup">
425                                                 <para>The configured Pickupgroup.</para>
426                                         </enum>
427                                         <enum name="namedcallgroup">
428                                                 <para>The configured Named Callgroup.</para>
429                                         </enum>
430                                         <enum name="namedpickupgroup">
431                                                 <para>The configured Named Pickupgroup.</para>
432                                         </enum>
433                                         <enum name="codecs">
434                                                 <para>The configured codecs.</para>
435                                         </enum>
436                                         <enum name="status">
437                                                 <para>Status (if qualify=yes).</para>
438                                         </enum>
439                                         <enum name="regexten">
440                                                 <para>Extension activated at registration.</para>
441                                         </enum>
442                                         <enum name="limit">
443                                                 <para>Call limit (call-limit).</para>
444                                         </enum>
445                                         <enum name="busylevel">
446                                                 <para>Configured call level for signalling busy.</para>
447                                         </enum>
448                                         <enum name="curcalls">
449                                                 <para>Current amount of calls. Only available if call-limit is set.</para>
450                                         </enum>
451                                         <enum name="language">
452                                                 <para>Default language for peer.</para>
453                                         </enum>
454                                         <enum name="accountcode">
455                                                 <para>Account code for this peer.</para>
456                                         </enum>
457                                         <enum name="useragent">
458                                                 <para>Current user agent header used by peer.</para>
459                                         </enum>
460                                         <enum name="maxforwards">
461                                                 <para>The value used for SIP loop prevention in outbound requests</para>
462                                         </enum>
463                                         <enum name="chanvar[name]">
464                                                 <para>A channel variable configured with setvar for this peer.</para>
465                                         </enum>
466                                         <enum name="codec[x]">
467                                                 <para>Preferred codec index number <replaceable>x</replaceable> (beginning with zero).</para>
468                                         </enum>
469                                 </enumlist>
470                         </parameter>
471                 </syntax>
472                 <description></description>
473         </function>
474         <function name="SIPCHANINFO" language="en_US">
475                 <synopsis>
476                         Gets the specified SIP parameter from the current channel.
477                 </synopsis>
478                 <syntax>
479                         <parameter name="item" required="true">
480                                 <enumlist>
481                                         <enum name="peerip">
482                                                 <para>The IP address of the peer.</para>
483                                         </enum>
484                                         <enum name="recvip">
485                                                 <para>The source IP address of the peer.</para>
486                                         </enum>
487                                         <enum name="from">
488                                                 <para>The SIP URI from the <literal>From:</literal> header.</para>
489                                         </enum>
490                                         <enum name="uri">
491                                                 <para>The SIP URI from the <literal>Contact:</literal> header.</para>
492                                         </enum>
493                                         <enum name="useragent">
494                                                 <para>The Useragent header used by the peer.</para>
495                                         </enum>
496                                         <enum name="peername">
497                                                 <para>The name of the peer.</para>
498                                         </enum>
499                                         <enum name="t38passthrough">
500                                                 <para><literal>1</literal> if T38 is offered or enabled in this channel,
501                                                 otherwise <literal>0</literal>.</para>
502                                         </enum>
503                                 </enumlist>
504                         </parameter>
505                 </syntax>
506                 <description></description>
507         </function>
508         <function name="CHECKSIPDOMAIN" language="en_US">
509                 <synopsis>
510                         Checks if domain is a local domain.
511                 </synopsis>
512                 <syntax>
513                         <parameter name="domain" required="true" />
514                 </syntax>
515                 <description>
516                         <para>This function checks if the <replaceable>domain</replaceable> in the argument is configured
517                         as a local SIP domain that this Asterisk server is configured to handle.
518                         Returns the domain name if it is locally handled, otherwise an empty string.
519                         Check the <literal>domain=</literal> configuration in <filename>sip.conf</filename>.</para>
520                 </description>
521         </function>
522         <manager name="SIPpeers" language="en_US">
523                 <synopsis>
524                         List SIP peers (text format).
525                 </synopsis>
526                 <syntax>
527                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
528                 </syntax>
529                 <description>
530                         <para>Lists SIP peers in text format with details on current status.
531                         <literal>Peerlist</literal> will follow as separate events, followed by a final event called
532                         <literal>PeerlistComplete</literal>.</para>
533                 </description>
534         </manager>
535         <manager name="SIPshowpeer" language="en_US">
536                 <synopsis>
537                         show SIP peer (text format).
538                 </synopsis>
539                 <syntax>
540                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
541                         <parameter name="Peer" required="true">
542                                 <para>The peer name you want to check.</para>
543                         </parameter>
544                 </syntax>
545                 <description>
546                         <para>Show one SIP peer with details on current status.</para>
547                 </description>
548         </manager>
549         <manager name="SIPqualifypeer" language="en_US">
550                 <synopsis>
551                         Qualify SIP peers.
552                 </synopsis>
553                 <syntax>
554                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
555                         <parameter name="Peer" required="true">
556                                 <para>The peer name you want to qualify.</para>
557                         </parameter>
558                 </syntax>
559                 <description>
560                         <para>Qualify a SIP peer.</para>
561                 </description>
562                 <see-also>
563                         <ref type="managerEvent">SIPqualifypeerdone</ref>
564                 </see-also>
565         </manager>
566         <manager name="SIPshowregistry" language="en_US">
567                 <synopsis>
568                         Show SIP registrations (text format).
569                 </synopsis>
570                 <syntax>
571                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
572                 </syntax>
573                 <description>
574                         <para>Lists all registration requests and status. Registrations will follow as separate
575                         events followed by a final event called <literal>RegistrationsComplete</literal>.</para>
576                 </description>
577         </manager>
578         <manager name="SIPnotify" language="en_US">
579                 <synopsis>
580                         Send a SIP notify.
581                 </synopsis>
582                 <syntax>
583                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
584                         <parameter name="Channel" required="true">
585                                 <para>Peer to receive the notify.</para>
586                         </parameter>
587                         <parameter name="Variable" required="true">
588                                 <para>At least one variable pair must be specified.
589                                 <replaceable>name</replaceable>=<replaceable>value</replaceable></para>
590                         </parameter>
591                 </syntax>
592                 <description>
593                         <para>Sends a SIP Notify event.</para>
594                         <para>All parameters for this event must be specified in the body of this request
595                         via multiple <literal>Variable: name=value</literal> sequences.</para>
596                 </description>
597         </manager>
598         <manager name="SIPpeerstatus" language="en_US">
599                 <synopsis>
600                         Show the status of one or all of the sip peers.
601                 </synopsis>
602                 <syntax>
603                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
604                         <parameter name="Peer" required="false">
605                                 <para>The peer name you want to check.</para>
606                         </parameter>
607                 </syntax>
608                 <description>
609                         <para>Retrieves the status of one or all of the sip peers.  If no peer name is specified, status
610                         for all of the sip peers will be retrieved.</para>
611                 </description>
612         </manager>
613         <info name="SIPMessageFromInfo" language="en_US" tech="SIP">
614                 <para>The <literal>from</literal> parameter can be a configured peer name
615                 or in the form of "display-name" &lt;URI&gt;.</para>
616         </info>
617         <info name="SIPMessageToInfo" language="en_US" tech="SIP">
618                 <para>Specifying a prefix of <literal>sip:</literal> will send the
619                 message as a SIP MESSAGE request.</para>
620         </info>
621  ***/
622
623 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
624 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
625 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
626 static int min_subexpiry = DEFAULT_MIN_EXPIRY;     /*!< Minimum accepted subscription time */
627 static int max_subexpiry = DEFAULT_MAX_EXPIRY;     /*!< Maximum accepted subscription time */
628 static int mwi_expiry = DEFAULT_MWI_EXPIRY;
629
630 static int unauth_sessions = 0;
631 static int authlimit = DEFAULT_AUTHLIMIT;
632 static int authtimeout = DEFAULT_AUTHTIMEOUT;
633
634 /*! \brief Global jitterbuffer configuration - by default, jb is disabled
635  *  \note Values shown here match the defaults shown in sip.conf.sample */
636 static struct ast_jb_conf default_jbconf =
637 {
638         .flags = 0,
639         .max_size = 200,
640         .resync_threshold = 1000,
641         .impl = "fixed",
642         .target_extra = 40,
643 };
644 static struct ast_jb_conf global_jbconf;                /*!< Global jitterbuffer configuration */
645
646 static const char config[] = "sip.conf";                /*!< Main configuration file */
647 static const char notify_config[] = "sip_notify.conf";  /*!< Configuration file for sending Notify with CLI commands to reconfigure or reboot phones */
648
649 /*! \brief Readable descriptions of device states.
650  *  \note Should be aligned to above table as index */
651 static const struct invstate2stringtable {
652         const enum invitestates state;
653         const char *desc;
654 } invitestate2string[] = {
655         {INV_NONE,              "None"  },
656         {INV_CALLING,           "Calling (Trying)"},
657         {INV_PROCEEDING,        "Proceeding "},
658         {INV_EARLY_MEDIA,       "Early media"},
659         {INV_COMPLETED,         "Completed (done)"},
660         {INV_CONFIRMED,         "Confirmed (up)"},
661         {INV_TERMINATED,        "Done"},
662         {INV_CANCELLED,         "Cancelled"}
663 };
664
665 /*! \brief Subscription types that we support. We support
666  * - dialoginfo updates (really device status, not dialog info as was the original intent of the standard)
667  * - SIMPLE presence used for device status
668  * - Voicemail notification subscriptions
669  */
670 static const struct cfsubscription_types {
671         enum subscriptiontype type;
672         const char * const event;
673         const char * const mediatype;
674         const char * const text;
675 } subscription_types[] = {
676         { NONE,            "-",        "unknown",                    "unknown" },
677         /* RFC 4235: SIP Dialog event package */
678         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
679         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
680         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
681         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
682         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
683 };
684
685 /*! \brief The core structure to setup dialogs. We parse incoming messages by using
686  *  structure and then route the messages according to the type.
687  *
688  *  \note Note that sip_methods[i].id == i must hold or the code breaks
689  */
690 static const struct  cfsip_methods {
691         enum sipmethod id;
692         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
693         char * const text;
694         enum can_create_dialog can_create;
695 } sip_methods[] = {
696         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",CAN_CREATE_DIALOG },
697         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",  CAN_NOT_CREATE_DIALOG },
698         { SIP_REGISTER,  NO_RTP, "REGISTER", CAN_CREATE_DIALOG },
699         { SIP_OPTIONS,   NO_RTP, "OPTIONS",  CAN_CREATE_DIALOG },
700         { SIP_NOTIFY,    NO_RTP, "NOTIFY",   CAN_CREATE_DIALOG },
701         { SIP_INVITE,    RTP,    "INVITE",   CAN_CREATE_DIALOG },
702         { SIP_ACK,       NO_RTP, "ACK",      CAN_NOT_CREATE_DIALOG },
703         { SIP_PRACK,     NO_RTP, "PRACK",    CAN_NOT_CREATE_DIALOG },
704         { SIP_BYE,       NO_RTP, "BYE",      CAN_NOT_CREATE_DIALOG },
705         { SIP_REFER,     NO_RTP, "REFER",    CAN_CREATE_DIALOG },
706         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",CAN_CREATE_DIALOG },
707         { SIP_MESSAGE,   NO_RTP, "MESSAGE",  CAN_CREATE_DIALOG },
708         { SIP_UPDATE,    NO_RTP, "UPDATE",   CAN_NOT_CREATE_DIALOG },
709         { SIP_INFO,      NO_RTP, "INFO",     CAN_NOT_CREATE_DIALOG },
710         { SIP_CANCEL,    NO_RTP, "CANCEL",   CAN_NOT_CREATE_DIALOG },
711         { SIP_PUBLISH,   NO_RTP, "PUBLISH",  CAN_CREATE_DIALOG },
712         { SIP_PING,      NO_RTP, "PING",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
713 };
714
715 /*! \brief Diversion header reasons
716  *
717  * The core defines a bunch of constants used to define
718  * redirecting reasons. This provides a translation table
719  * between those and the strings which may be present in
720  * a SIP Diversion header
721  */
722 static const struct sip_reasons {
723         enum AST_REDIRECTING_REASON code;
724         char * const text;
725 } sip_reason_table[] = {
726         { AST_REDIRECTING_REASON_UNKNOWN, "unknown" },
727         { AST_REDIRECTING_REASON_USER_BUSY, "user-busy" },
728         { AST_REDIRECTING_REASON_NO_ANSWER, "no-answer" },
729         { AST_REDIRECTING_REASON_UNAVAILABLE, "unavailable" },
730         { AST_REDIRECTING_REASON_UNCONDITIONAL, "unconditional" },
731         { AST_REDIRECTING_REASON_TIME_OF_DAY, "time-of-day" },
732         { AST_REDIRECTING_REASON_DO_NOT_DISTURB, "do-not-disturb" },
733         { AST_REDIRECTING_REASON_DEFLECTION, "deflection" },
734         { AST_REDIRECTING_REASON_FOLLOW_ME, "follow-me" },
735         { AST_REDIRECTING_REASON_OUT_OF_ORDER, "out-of-service" },
736         { AST_REDIRECTING_REASON_AWAY, "away" },
737         { AST_REDIRECTING_REASON_CALL_FWD_DTE, "unknown"},
738         { AST_REDIRECTING_REASON_SEND_TO_VM, "send_to_vm"},
739 };
740
741
742 /*! \name DefaultSettings
743         Default setttings are used as a channel setting and as a default when
744         configuring devices
745 */
746 static char default_language[MAX_LANGUAGE];      /*!< Default language setting for new channels */
747 static char default_callerid[AST_MAX_EXTENSION]; /*!< Default caller ID for sip messages */
748 static char default_mwi_from[80];                /*!< Default caller ID for MWI updates */
749 static char default_fromdomain[AST_MAX_EXTENSION]; /*!< Default domain on outound messages */
750 static int default_fromdomainport;                 /*!< Default domain port on outbound messages */
751 static char default_notifymime[AST_MAX_EXTENSION]; /*!< Default MIME media type for MWI notify messages */
752 static char default_vmexten[AST_MAX_EXTENSION];    /*!< Default From Username on MWI updates */
753 static int default_qualify;                        /*!< Default Qualify= setting */
754 static int default_keepalive;                      /*!< Default keepalive= setting */
755 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
756 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting
757                                                     *   a bridged channel on hold */
758 static char default_parkinglot[AST_MAX_CONTEXT];   /*!< Parkinglot */
759 static char default_engine[256];                   /*!< Default RTP engine */
760 static int default_maxcallbitrate;                 /*!< Maximum bitrate for call */
761 static struct ast_codec_pref default_prefs;        /*!< Default codec prefs */
762 static char default_zone[MAX_TONEZONE_COUNTRY];        /*!< Default tone zone for channels created from the SIP driver */
763 static unsigned int default_transports;            /*!< Default Transports (enum sip_transport) that are acceptable */
764 static unsigned int default_primary_transport;     /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
765
766 static struct sip_settings sip_cfg;             /*!< SIP configuration data.
767                                         \note in the future we could have multiple of these (per domain, per device group etc) */
768
769 /*!< use this macro when ast_uri_decode is dependent on pedantic checking to be on. */
770 #define SIP_PEDANTIC_DECODE(str)        \
771         if (sip_cfg.pedanticsipchecking && !ast_strlen_zero(str)) {     \
772                 ast_uri_decode(str, ast_uri_sip_user);  \
773         }       \
774
775 static unsigned int chan_idx;       /*!< used in naming sip channel */
776 static int global_match_auth_username;    /*!< Match auth username if available instead of From: Default off. */
777
778 static int global_relaxdtmf;        /*!< Relax DTMF */
779 static int global_prematuremediafilter;   /*!< Enable/disable premature frames in a call (causing 183 early media) */
780 static int global_rtptimeout;       /*!< Time out call if no RTP */
781 static int global_rtpholdtimeout;   /*!< Time out call if no RTP during hold */
782 static int global_rtpkeepalive;     /*!< Send RTP keepalives */
783 static int global_reg_timeout;      /*!< Global time between attempts for outbound registrations */
784 static int global_regattempts_max;  /*!< Registration attempts before giving up */
785 static int global_shrinkcallerid;   /*!< enable or disable shrinking of caller id  */
786 static int global_callcounter;      /*!< Enable call counters for all devices. This is currently enabled by setting the peer
787                                      *   call-limit to INT_MAX. When we remove the call-limit from the code, we can make it
788                                      *   with just a boolean flag in the device structure */
789 static unsigned int global_tos_sip;      /*!< IP type of service for SIP packets */
790 static unsigned int global_tos_audio;    /*!< IP type of service for audio RTP packets */
791 static unsigned int global_tos_video;    /*!< IP type of service for video RTP packets */
792 static unsigned int global_tos_text;     /*!< IP type of service for text RTP packets */
793 static unsigned int global_cos_sip;      /*!< 802.1p class of service for SIP packets */
794 static unsigned int global_cos_audio;    /*!< 802.1p class of service for audio RTP packets */
795 static unsigned int global_cos_video;    /*!< 802.1p class of service for video RTP packets */
796 static unsigned int global_cos_text;     /*!< 802.1p class of service for text RTP packets */
797 static unsigned int recordhistory;       /*!< Record SIP history. Off by default */
798 static unsigned int dumphistory;         /*!< Dump history to verbose before destroying SIP dialog */
799 static char global_useragent[AST_MAX_EXTENSION];    /*!< Useragent for the SIP channel */
800 static char global_sdpsession[AST_MAX_EXTENSION];   /*!< SDP session name for the SIP channel */
801 static char global_sdpowner[AST_MAX_EXTENSION];     /*!< SDP owner name for the SIP channel */
802 static int global_authfailureevents;     /*!< Whether we send authentication failure manager events or not. Default no. */
803 static int global_t1;           /*!< T1 time */
804 static int global_t1min;        /*!< T1 roundtrip time minimum */
805 static int global_timer_b;      /*!< Timer B - RFC 3261 Section 17.1.1.2 */
806 static unsigned int global_autoframing; /*!< Turn autoframing on or off. */
807 static int global_qualifyfreq;          /*!< Qualify frequency */
808 static int global_qualify_gap;          /*!< Time between our group of peer pokes */
809 static int global_qualify_peers;        /*!< Number of peers to poke at a given time */
810
811 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
812 static enum st_refresher_param global_st_refresher; /*!< Session-Timer refresher                        */
813 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
814 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
815
816 static int global_store_sip_cause;    /*!< Whether the MASTER_CHANNEL(HASH(SIP_CAUSE,[chan_name])) var should be set */
817
818 static int global_dynamic_exclude_static = 0; /*!< Exclude static peers from contact registrations */
819 static unsigned char global_refer_addheaders; /*!< Add extra headers to outgoing REFER */
820 /*@}*/
821
822 /*!
823  * We use libxml2 in order to parse XML that may appear in the body of a SIP message. Currently,
824  * the only usage is for parsing PIDF bodies of incoming PUBLISH requests in the call-completion
825  * event package. This variable is set at module load time and may be checked at runtime to determine
826  * if XML parsing support was found.
827  */
828 static int can_parse_xml;
829
830 /*! \name Object counters @{
831  *
832  * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
833  * should be used to modify these values.
834  */
835 static int speerobjs = 0;     /*!< Static peers */
836 static int rpeerobjs = 0;     /*!< Realtime peers */
837 static int apeerobjs = 0;     /*!< Autocreated peer objects */
838 static int regobjs = 0;       /*!< Registry objects */
839 /*! @} */
840
841 static struct ast_flags global_flags[3] = {{0}};  /*!< global SIP_ flags */
842 static int global_t38_maxdatagram;                /*!< global T.38 FaxMaxDatagram override */
843
844 static struct ast_event_sub *network_change_event_subscription; /*!< subscription id for network change events */
845 static struct ast_event_sub *acl_change_event_subscription; /*!< subscription id for named ACL system change events */
846 static int network_change_event_sched_id = -1;
847
848 static char used_context[AST_MAX_CONTEXT];        /*!< name of automatically created context for unloading */
849
850 AST_MUTEX_DEFINE_STATIC(netlock);
851
852 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
853    when it's doing something critical. */
854 AST_MUTEX_DEFINE_STATIC(monlock);
855
856 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
857
858 /*! \brief This is the thread for the monitor which checks for input on the channels
859    which are not currently in use.  */
860 static pthread_t monitor_thread = AST_PTHREADT_NULL;
861
862 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
863 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
864
865 struct ast_sched_context *sched;     /*!< The scheduling context */
866 static struct io_context *io;           /*!< The IO context */
867 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
868 struct sip_pkt;
869 static AST_LIST_HEAD_STATIC(domain_list, domain);    /*!< The SIP domain list */
870
871 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
872
873 static enum sip_debug_e sipdebug;
874
875 /*! \brief extra debugging for 'text' related events.
876  *  At the moment this is set together with sip_debug_console.
877  *  \note It should either go away or be implemented properly.
878  */
879 static int sipdebug_text;
880
881 static const struct _map_x_s referstatusstrings[] = {
882         { REFER_IDLE,      "<none>" },
883         { REFER_SENT,      "Request sent" },
884         { REFER_RECEIVED,  "Request received" },
885         { REFER_CONFIRMED, "Confirmed" },
886         { REFER_ACCEPTED,  "Accepted" },
887         { REFER_RINGING,   "Target ringing" },
888         { REFER_200OK,     "Done" },
889         { REFER_FAILED,    "Failed" },
890         { REFER_NOAUTH,    "Failed - auth failure" },
891         { -1,               NULL} /* terminator */
892 };
893
894 /* --- Hash tables of various objects --------*/
895 #ifdef LOW_MEMORY
896 static const int HASH_PEER_SIZE = 17;
897 static const int HASH_DIALOG_SIZE = 17;
898 #else
899 static const int HASH_PEER_SIZE = 563;  /*!< Size of peer hash table, prime number preferred! */
900 static const int HASH_DIALOG_SIZE = 563;
901 #endif
902
903 static const struct {
904         enum ast_cc_service_type service;
905         const char *service_string;
906 } sip_cc_service_map [] = {
907         [AST_CC_NONE] = { AST_CC_NONE, "" },
908         [AST_CC_CCBS] = { AST_CC_CCBS, "BS" },
909         [AST_CC_CCNR] = { AST_CC_CCNR, "NR" },
910         [AST_CC_CCNL] = { AST_CC_CCNL, "NL" },
911 };
912
913 static enum ast_cc_service_type service_string_to_service_type(const char * const service_string)
914 {
915         enum ast_cc_service_type service;
916         for (service = AST_CC_CCBS; service <= AST_CC_CCNL; ++service) {
917                 if (!strcasecmp(service_string, sip_cc_service_map[service].service_string)) {
918                         return service;
919                 }
920         }
921         return AST_CC_NONE;
922 }
923
924 static const struct {
925         enum sip_cc_notify_state state;
926         const char *state_string;
927 } sip_cc_notify_state_map [] = {
928         [CC_QUEUED] = {CC_QUEUED, "cc-state: queued"},
929         [CC_READY] = {CC_READY, "cc-state: ready"},
930 };
931
932 AST_LIST_HEAD_STATIC(epa_static_data_list, epa_backend);
933
934 static int sip_epa_register(const struct epa_static_data *static_data)
935 {
936         struct epa_backend *backend = ast_calloc(1, sizeof(*backend));
937
938         if (!backend) {
939                 return -1;
940         }
941
942         backend->static_data = static_data;
943
944         AST_LIST_LOCK(&epa_static_data_list);
945         AST_LIST_INSERT_TAIL(&epa_static_data_list, backend, next);
946         AST_LIST_UNLOCK(&epa_static_data_list);
947         return 0;
948 }
949
950 static void sip_epa_unregister_all(void)
951 {
952         struct epa_backend *backend;
953
954         AST_LIST_LOCK(&epa_static_data_list);
955         while ((backend = AST_LIST_REMOVE_HEAD(&epa_static_data_list, next))) {
956                 ast_free(backend);
957         }
958         AST_LIST_UNLOCK(&epa_static_data_list);
959 }
960
961 static void cc_handle_publish_error(struct sip_pvt *pvt, const int resp, struct sip_request *req, struct sip_epa_entry *epa_entry);
962
963 static void cc_epa_destructor(void *data)
964 {
965         struct sip_epa_entry *epa_entry = data;
966         struct cc_epa_entry *cc_entry = epa_entry->instance_data;
967         ast_free(cc_entry);
968 }
969
970 static const struct epa_static_data cc_epa_static_data  = {
971         .event = CALL_COMPLETION,
972         .name = "call-completion",
973         .handle_error = cc_handle_publish_error,
974         .destructor = cc_epa_destructor,
975 };
976
977 static const struct epa_static_data *find_static_data(const char * const event_package)
978 {
979         const struct epa_backend *backend = NULL;
980
981         AST_LIST_LOCK(&epa_static_data_list);
982         AST_LIST_TRAVERSE(&epa_static_data_list, backend, next) {
983                 if (!strcmp(backend->static_data->name, event_package)) {
984                         break;
985                 }
986         }
987         AST_LIST_UNLOCK(&epa_static_data_list);
988         return backend ? backend->static_data : NULL;
989 }
990
991 static struct sip_epa_entry *create_epa_entry (const char * const event_package, const char * const destination)
992 {
993         struct sip_epa_entry *epa_entry;
994         const struct epa_static_data *static_data;
995
996         if (!(static_data = find_static_data(event_package))) {
997                 return NULL;
998         }
999
1000         if (!(epa_entry = ao2_t_alloc(sizeof(*epa_entry), static_data->destructor, "Allocate new EPA entry"))) {
1001                 return NULL;
1002         }
1003
1004         epa_entry->static_data = static_data;
1005         ast_copy_string(epa_entry->destination, destination, sizeof(epa_entry->destination));
1006         return epa_entry;
1007 }
1008
1009 /*!
1010  * Used to create new entity IDs by ESCs.
1011  */
1012 static int esc_etag_counter;
1013 static const int DEFAULT_PUBLISH_EXPIRES = 3600;
1014
1015 #ifdef HAVE_LIBXML2
1016 static int cc_esc_publish_handler(struct sip_pvt *pvt, struct sip_request *req, struct event_state_compositor *esc, struct sip_esc_entry *esc_entry);
1017
1018 static const struct sip_esc_publish_callbacks cc_esc_publish_callbacks = {
1019         .initial_handler = cc_esc_publish_handler,
1020         .modify_handler = cc_esc_publish_handler,
1021 };
1022 #endif
1023
1024 /*!
1025  * \brief The Event State Compositors
1026  *
1027  * An Event State Compositor is an entity which
1028  * accepts PUBLISH requests and acts appropriately
1029  * based on these requests.
1030  *
1031  * The actual event_state_compositor structure is simply
1032  * an ao2_container of sip_esc_entrys. When an incoming
1033  * PUBLISH is received, we can match the appropriate sip_esc_entry
1034  * using the entity ID of the incoming PUBLISH.
1035  */
1036 static struct event_state_compositor {
1037         enum subscriptiontype event;
1038         const char * name;
1039         const struct sip_esc_publish_callbacks *callbacks;
1040         struct ao2_container *compositor;
1041 } event_state_compositors [] = {
1042 #ifdef HAVE_LIBXML2
1043         {CALL_COMPLETION, "call-completion", &cc_esc_publish_callbacks},
1044 #endif
1045 };
1046
1047 static const int ESC_MAX_BUCKETS = 37;
1048
1049 static void esc_entry_destructor(void *obj)
1050 {
1051         struct sip_esc_entry *esc_entry = obj;
1052         if (esc_entry->sched_id > -1) {
1053                 AST_SCHED_DEL(sched, esc_entry->sched_id);
1054         }
1055 }
1056
1057 static int esc_hash_fn(const void *obj, const int flags)
1058 {
1059         const struct sip_esc_entry *entry = obj;
1060         return ast_str_hash(entry->entity_tag);
1061 }
1062
1063 static int esc_cmp_fn(void *obj, void *arg, int flags)
1064 {
1065         struct sip_esc_entry *entry1 = obj;
1066         struct sip_esc_entry *entry2 = arg;
1067
1068         return (!strcmp(entry1->entity_tag, entry2->entity_tag)) ? (CMP_MATCH | CMP_STOP) : 0;
1069 }
1070
1071 static struct event_state_compositor *get_esc(const char * const event_package) {
1072         int i;
1073         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1074                 if (!strcasecmp(event_package, event_state_compositors[i].name)) {
1075                         return &event_state_compositors[i];
1076                 }
1077         }
1078         return NULL;
1079 }
1080
1081 static struct sip_esc_entry *get_esc_entry(const char * entity_tag, struct event_state_compositor *esc) {
1082         struct sip_esc_entry *entry;
1083         struct sip_esc_entry finder;
1084
1085         ast_copy_string(finder.entity_tag, entity_tag, sizeof(finder.entity_tag));
1086
1087         entry = ao2_find(esc->compositor, &finder, OBJ_POINTER);
1088
1089         return entry;
1090 }
1091
1092 static int publish_expire(const void *data)
1093 {
1094         struct sip_esc_entry *esc_entry = (struct sip_esc_entry *) data;
1095         struct event_state_compositor *esc = get_esc(esc_entry->event);
1096
1097         ast_assert(esc != NULL);
1098
1099         ao2_unlink(esc->compositor, esc_entry);
1100         ao2_ref(esc_entry, -1);
1101         return 0;
1102 }
1103
1104 static void create_new_sip_etag(struct sip_esc_entry *esc_entry, int is_linked)
1105 {
1106         int new_etag = ast_atomic_fetchadd_int(&esc_etag_counter, +1);
1107         struct event_state_compositor *esc = get_esc(esc_entry->event);
1108
1109         ast_assert(esc != NULL);
1110         if (is_linked) {
1111                 ao2_unlink(esc->compositor, esc_entry);
1112         }
1113         snprintf(esc_entry->entity_tag, sizeof(esc_entry->entity_tag), "%d", new_etag);
1114         ao2_link(esc->compositor, esc_entry);
1115 }
1116
1117 static struct sip_esc_entry *create_esc_entry(struct event_state_compositor *esc, struct sip_request *req, const int expires)
1118 {
1119         struct sip_esc_entry *esc_entry;
1120         int expires_ms;
1121
1122         if (!(esc_entry = ao2_alloc(sizeof(*esc_entry), esc_entry_destructor))) {
1123                 return NULL;
1124         }
1125
1126         esc_entry->event = esc->name;
1127
1128         expires_ms = expires * 1000;
1129         /* Bump refcount for scheduler */
1130         ao2_ref(esc_entry, +1);
1131         esc_entry->sched_id = ast_sched_add(sched, expires_ms, publish_expire, esc_entry);
1132
1133         /* Note: This links the esc_entry into the ESC properly */
1134         create_new_sip_etag(esc_entry, 0);
1135
1136         return esc_entry;
1137 }
1138
1139 static int initialize_escs(void)
1140 {
1141         int i, res = 0;
1142         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1143                 if (!((event_state_compositors[i].compositor) =
1144                                         ao2_container_alloc(ESC_MAX_BUCKETS, esc_hash_fn, esc_cmp_fn))) {
1145                         res = -1;
1146                 }
1147         }
1148         return res;
1149 }
1150
1151 static void destroy_escs(void)
1152 {
1153         int i;
1154         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1155                 ao2_ref(event_state_compositors[i].compositor, -1);
1156         }
1157 }
1158
1159 struct state_notify_data {
1160         int state;
1161         struct ao2_container *device_state_info;
1162         int presence_state;
1163         const char *presence_subtype;
1164         const char *presence_message;
1165 };
1166
1167 /*!
1168  * \details
1169  * Here we implement the container for dialogs which are in the
1170  * dialog_needdestroy state to iterate only through the dialogs
1171  * unlink them instead of iterate through all dialogs
1172  */
1173 struct ao2_container *dialogs_needdestroy;
1174
1175 /*!
1176  * \details
1177  * Here we implement the container for dialogs which have rtp
1178  * traffic and rtptimeout, rtpholdtimeout or rtpkeepalive
1179  * set. We use this container instead the whole dialog list.
1180  */
1181 struct ao2_container *dialogs_rtpcheck;
1182
1183 /*!
1184  * \details
1185  * Here we implement the container for dialogs (sip_pvt), defining
1186  * generic wrapper functions to ease the transition from the current
1187  * implementation (a single linked list) to a different container.
1188  * In addition to a reference to the container, we need functions to lock/unlock
1189  * the container and individual items, and functions to add/remove
1190  * references to the individual items.
1191  */
1192 static struct ao2_container *dialogs;
1193 #define sip_pvt_lock(x) ao2_lock(x)
1194 #define sip_pvt_trylock(x) ao2_trylock(x)
1195 #define sip_pvt_unlock(x) ao2_unlock(x)
1196
1197 /*! \brief  The table of TCP threads */
1198 static struct ao2_container *threadt;
1199
1200 /*! \brief  The peer list: Users, Peers and Friends */
1201 static struct ao2_container *peers;
1202 static struct ao2_container *peers_by_ip;
1203
1204 /*! \brief  The register list: Other SIP proxies we register with and receive calls from */
1205 static struct ast_register_list {
1206         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1207         int recheck;
1208 } regl;
1209
1210 /*! \brief  The MWI subscription list */
1211 static struct ast_subscription_mwi_list {
1212         ASTOBJ_CONTAINER_COMPONENTS(struct sip_subscription_mwi);
1213 } submwil;
1214 static int temp_pvt_init(void *);
1215 static void temp_pvt_cleanup(void *);
1216
1217 /*! \brief A per-thread temporary pvt structure */
1218 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1219
1220 /*! \brief A per-thread buffer for transport to string conversion */
1221 AST_THREADSTORAGE(sip_transport_str_buf);
1222
1223 /*! \brief Size of the SIP transport buffer */
1224 #define SIP_TRANSPORT_STR_BUFSIZE 128
1225
1226 /*! \brief Authentication container for realm authentication */
1227 static struct sip_auth_container *authl = NULL;
1228 /*! \brief Global authentication container protection while adjusting the references. */
1229 AST_MUTEX_DEFINE_STATIC(authl_lock);
1230
1231 /* --- Sockets and networking --------------*/
1232
1233 /*! \brief Main socket for UDP SIP communication.
1234  *
1235  * sipsock is shared between the SIP manager thread (which handles reload
1236  * requests), the udp io handler (sipsock_read()) and the user routines that
1237  * issue udp writes (using __sip_xmit()).
1238  * The socket is -1 only when opening fails (this is a permanent condition),
1239  * or when we are handling a reload() that changes its address (this is
1240  * a transient situation during which we might have a harmless race, see
1241  * below). Because the conditions for the race to be possible are extremely
1242  * rare, we don't want to pay the cost of locking on every I/O.
1243  * Rather, we remember that when the race may occur, communication is
1244  * bound to fail anyways, so we just live with this event and let
1245  * the protocol handle this above us.
1246  */
1247 static int sipsock  = -1;
1248
1249 struct ast_sockaddr bindaddr;   /*!< UDP: The address we bind to */
1250
1251 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1252  *  internip is initialized picking a suitable address from one of the
1253  * interfaces, and the same port number we bind to. It is used as the
1254  * default address/port in SIP messages, and as the default address
1255  * (but not port) in SDP messages.
1256  */
1257 static struct ast_sockaddr internip;
1258
1259 /*! \brief our external IP address/port for SIP sessions.
1260  * externaddr.sin_addr is only set when we know we might be behind
1261  * a NAT, and this is done using a variety of (mutually exclusive)
1262  * ways from the config file:
1263  *
1264  * + with "externaddr = host[:port]" we specify the address/port explicitly.
1265  *   The address is looked up only once when (re)loading the config file;
1266  *
1267  * + with "externhost = host[:port]" we do a similar thing, but the
1268  *   hostname is stored in externhost, and the hostname->IP mapping
1269  *   is refreshed every 'externrefresh' seconds;
1270  *
1271  * Other variables (externhost, externexpire, externrefresh) are used
1272  * to support the above functions.
1273  */
1274 static struct ast_sockaddr externaddr;      /*!< External IP address if we are behind NAT */
1275 static struct ast_sockaddr media_address; /*!< External RTP IP address if we are behind NAT */
1276
1277 static char externhost[MAXHOSTNAMELEN];   /*!< External host name */
1278 static time_t externexpire;             /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1279 static int externrefresh = 10;          /*!< Refresh timer for DNS-based external address (dyndns) */
1280 static uint16_t externtcpport;          /*!< external tcp port */
1281 static uint16_t externtlsport;          /*!< external tls port */
1282
1283 /*! \brief  List of local networks
1284  * We store "localnet" addresses from the config file into an access list,
1285  * marked as 'DENY', so the call to ast_apply_ha() will return
1286  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1287  * (i.e. presumably public) addresses.
1288  */
1289 static struct ast_ha *localaddr;    /*!< List of local networks, on the same side of NAT as this Asterisk */
1290
1291 static int ourport_tcp;             /*!< The port used for TCP connections */
1292 static int ourport_tls;             /*!< The port used for TCP/TLS connections */
1293 static struct ast_sockaddr debugaddr;
1294
1295 static struct ast_config *notify_types = NULL;    /*!< The list of manual NOTIFY types we know how to send */
1296
1297 /*! some list management macros. */
1298
1299 #define UNLINK(element, head, prev) do {        \
1300         if (prev)                               \
1301                 (prev)->next = (element)->next; \
1302         else                                    \
1303                 (head) = (element)->next;       \
1304         } while (0)
1305
1306 /*---------------------------- Forward declarations of functions in chan_sip.c */
1307 /* Note: This is added to help splitting up chan_sip.c into several files
1308         in coming releases. */
1309
1310 /*--- PBX interface functions */
1311 static struct ast_channel *sip_request_call(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *dest, int *cause);
1312 static int sip_devicestate(const char *data);
1313 static int sip_sendtext(struct ast_channel *ast, const char *text);
1314 static int sip_call(struct ast_channel *ast, const char *dest, int timeout);
1315 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1316 static int sip_hangup(struct ast_channel *ast);
1317 static int sip_answer(struct ast_channel *ast);
1318 static struct ast_frame *sip_read(struct ast_channel *ast);
1319 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1320 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1321 static int sip_transfer(struct ast_channel *ast, const char *dest);
1322 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1323 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1324 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1325 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
1326 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
1327 static const char *sip_get_callid(struct ast_channel *chan);
1328
1329 static int handle_request_do(struct sip_request *req, struct ast_sockaddr *addr);
1330 static int sip_standard_port(enum sip_transport type, int port);
1331 static int sip_prepare_socket(struct sip_pvt *p);
1332 static int get_address_family_filter(unsigned int transport);
1333
1334 /*--- Transmitting responses and requests */
1335 static int sipsock_read(int *id, int fd, short events, void *ignore);
1336 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data);
1337 static int __sip_reliable_xmit(struct sip_pvt *p, uint32_t seqno, int resp, struct ast_str *data, int fatal, int sipmethod);
1338 static void add_cc_call_info_to_response(struct sip_pvt *p, struct sip_request *resp);
1339 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1340 static int retrans_pkt(const void *data);
1341 static int transmit_response_using_temp(ast_string_field callid, struct ast_sockaddr *addr, int useglobal_nat, const int intended_method, const struct sip_request *req, const char *msg);
1342 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1343 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1344 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1345 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable, int oldsdp, int rpid);
1346 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1347 static int transmit_response_with_auth(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *rand, enum xmittype reliable, const char *header, int stale);
1348 static int transmit_provisional_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, int with_sdp);
1349 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1350 static void transmit_fake_auth_response(struct sip_pvt *p, int sipmethod, struct sip_request *req, enum xmittype reliable);
1351 static int transmit_request(struct sip_pvt *p, int sipmethod, uint32_t seqno, enum xmittype reliable, int newbranch);
1352 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, uint32_t seqno, enum xmittype reliable, int newbranch);
1353 static int transmit_publish(struct sip_epa_entry *epa_entry, enum sip_publish_type publish_type, const char * const explicit_uri);
1354 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init, const char * const explicit_uri);
1355 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
1356 static int transmit_info_with_aoc(struct sip_pvt *p, struct ast_aoc_decoded *decoded);
1357 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1358 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1359 static int transmit_message(struct sip_pvt *p, int init, int auth);
1360 static int transmit_refer(struct sip_pvt *p, const char *dest);
1361 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
1362 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1363 static int transmit_cc_notify(struct ast_cc_agent *agent, struct sip_pvt *subscription, enum sip_cc_notify_state state);
1364 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1365 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, uint32_t seqno);
1366 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, uint32_t seqno);
1367 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1368 static void receive_message(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1369 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
1370 static int sip_send_mwi_to_peer(struct sip_peer *peer, int cache_only);
1371
1372 /* Misc dialog routines */
1373 static int __sip_autodestruct(const void *data);
1374 static void *registry_unref(struct sip_registry *reg, char *tag);
1375 static int update_call_counter(struct sip_pvt *fup, int event);
1376 static int auto_congest(const void *arg);
1377 static struct sip_pvt *find_call(struct sip_request *req, struct ast_sockaddr *addr, const int intended_method);
1378 static void free_old_route(struct sip_route *route);
1379 static void list_route(struct sip_route *route);
1380 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards, int resp);
1381 static enum check_auth_result register_verify(struct sip_pvt *p, struct ast_sockaddr *addr,
1382                                               struct sip_request *req, const char *uri);
1383 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1384 static void check_pendings(struct sip_pvt *p);
1385 static void *sip_park_thread(void *stuff);
1386 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, uint32_t seqno, const char *park_exten, const char *park_context);
1387
1388 static void *sip_pickup_thread(void *stuff);
1389 static int sip_pickup(struct ast_channel *chan);
1390
1391 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1392 static int is_method_allowed(unsigned int *allowed_methods, enum sipmethod method);
1393
1394 /*--- Codec handling / SDP */
1395 static void try_suggested_sip_codec(struct sip_pvt *p);
1396 static const char *get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1397 static char get_sdp_line(int *start, int stop, struct sip_request *req, const char **value);
1398 static int find_sdp(struct sip_request *req);
1399 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
1400 static int process_sdp_o(const char *o, struct sip_pvt *p);
1401 static int process_sdp_c(const char *c, struct ast_sockaddr *addr);
1402 static int process_sdp_a_sendonly(const char *a, int *sendonly);
1403 static int process_sdp_a_ice(const char *a, struct sip_pvt *p, struct ast_rtp_instance *instance);
1404 static int process_sdp_a_dtls(const char *a, struct sip_pvt *p, struct ast_rtp_instance *instance);
1405 static int process_sdp_a_audio(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newaudiortp, int *last_rtpmap_codec);
1406 static int process_sdp_a_video(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newvideortp, int *last_rtpmap_codec);
1407 static int process_sdp_a_text(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newtextrtp, char *red_fmtp, int *red_num_gen, int *red_data_pt, int *last_rtpmap_codec);
1408 static int process_sdp_a_image(const char *a, struct sip_pvt *p);
1409 static void add_ice_to_sdp(struct ast_rtp_instance *instance, struct ast_str **a_buf);
1410 static void add_dtls_to_sdp(struct ast_rtp_instance *instance, struct ast_str **a_buf);
1411 static void start_ice(struct ast_rtp_instance *instance);
1412 static void add_codec_to_sdp(const struct sip_pvt *p, struct ast_format *codec,
1413                              struct ast_str **m_buf, struct ast_str **a_buf,
1414                              int debug, int *min_packet_size);
1415 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
1416                                 struct ast_str **m_buf, struct ast_str **a_buf,
1417                                 int debug);
1418 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
1419 static void do_setnat(struct sip_pvt *p);
1420 static void stop_media_flows(struct sip_pvt *p);
1421
1422 /*--- Authentication stuff */
1423 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1424 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1425 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1426                                          const char *secret, const char *md5secret, int sipmethod,
1427                                          const char *uri, enum xmittype reliable);
1428 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1429                                               int sipmethod, const char *uri, enum xmittype reliable,
1430                                               struct ast_sockaddr *addr, struct sip_peer **authpeer);
1431 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct ast_sockaddr *addr);
1432
1433 /*--- Domain handling */
1434 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1435 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1436 static void clear_sip_domains(void);
1437
1438 /*--- SIP realm authentication */
1439 static void add_realm_authentication(struct sip_auth_container **credentials, const char *configuration, int lineno);
1440 static struct sip_auth *find_realm_authentication(struct sip_auth_container *credentials, const char *realm);
1441
1442 /*--- Misc functions */
1443 static int check_rtp_timeout(struct sip_pvt *dialog, time_t t);
1444 static int reload_config(enum channelreloadreason reason);
1445 static void add_diversion(struct sip_request *req, struct sip_pvt *pvt);
1446 static int expire_register(const void *data);
1447 static void *do_monitor(void *data);
1448 static int restart_monitor(void);
1449 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
1450 static struct ast_variable *copy_vars(struct ast_variable *src);
1451 static int dialog_find_multiple(void *obj, void *arg, int flags);
1452 static struct ast_channel *sip_pvt_lock_full(struct sip_pvt *pvt);
1453 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
1454 static int sip_refer_alloc(struct sip_pvt *p);
1455 static int sip_notify_alloc(struct sip_pvt *p);
1456 static void ast_quiet_chan(struct ast_channel *chan);
1457 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1458 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
1459
1460 /*--- Device monitoring and Device/extension state/event handling */
1461 static int extensionstate_update(const char *context, const char *exten, struct state_notify_data *data, struct sip_pvt *p, int force);
1462 static int cb_extensionstate(char *context, char *exten, struct ast_state_cb_info *info, void *data);
1463 static int sip_poke_noanswer(const void *data);
1464 static int sip_poke_peer(struct sip_peer *peer, int force);
1465 static void sip_poke_all_peers(void);
1466 static void sip_peer_hold(struct sip_pvt *p, int hold);
1467 static void mwi_event_cb(const struct ast_event *, void *);
1468 static void network_change_event_cb(const struct ast_event *, void *);
1469 static void acl_change_event_cb(const struct ast_event *event, void *userdata);
1470 static void sip_keepalive_all_peers(void);
1471
1472 /*--- Applications, functions, CLI and manager command helpers */
1473 static const char *sip_nat_mode(const struct sip_pvt *p);
1474 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1475 static char *transfermode2str(enum transfermodes mode) attribute_const;
1476 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1477 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1478 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1479 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1480 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1481 static void  print_group(int fd, ast_group_t group, int crlf);
1482 static void  print_named_groups(int fd, struct ast_namedgroups *groups, int crlf);
1483 static const char *dtmfmode2str(int mode) attribute_const;
1484 static int str2dtmfmode(const char *str) attribute_unused;
1485 static const char *insecure2str(int mode) attribute_const;
1486 static const char *allowoverlap2str(int mode) attribute_const;
1487 static void cleanup_stale_contexts(char *new, char *old);
1488 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1489 static const char *domain_mode_to_text(const enum domain_mode mode);
1490 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1491 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1492 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1493 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1494 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1495 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1496 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1497 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1498 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1499 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1500 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1501 static char *complete_sip_peer(const char *word, int state, int flags2);
1502 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1503 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1504 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1505 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1506 static char *complete_sip_notify(const char *line, const char *word, int pos, int state);
1507 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1508 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1509 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1510 static char *sip_do_debug_ip(int fd, const char *arg);
1511 static char *sip_do_debug_peer(int fd, const char *arg);
1512 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1513 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1514 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1515 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
1516 static int sip_addheader(struct ast_channel *chan, const char *data);
1517 static int sip_do_reload(enum channelreloadreason reason);
1518 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1519 static int ast_sockaddr_resolve_first_af(struct ast_sockaddr *addr,
1520                                       const char *name, int flag, int family);
1521 static int ast_sockaddr_resolve_first(struct ast_sockaddr *addr,
1522                                       const char *name, int flag);
1523 static int ast_sockaddr_resolve_first_transport(struct ast_sockaddr *addr,
1524                                                 const char *name, int flag, unsigned int transport);
1525
1526 /*--- Debugging
1527         Functions for enabling debug per IP or fully, or enabling history logging for
1528         a SIP dialog
1529 */
1530 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1531 static inline int sip_debug_test_addr(const struct ast_sockaddr *addr);
1532 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1533 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1534 static void sip_dump_history(struct sip_pvt *dialog);
1535
1536 /*--- Device object handling */
1537 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime, int devstate_only);
1538 static int update_call_counter(struct sip_pvt *fup, int event);
1539 static void sip_destroy_peer(struct sip_peer *peer);
1540 static void sip_destroy_peer_fn(void *peer);
1541 static void set_peer_defaults(struct sip_peer *peer);
1542 static struct sip_peer *temp_peer(const char *name);
1543 static void register_peer_exten(struct sip_peer *peer, int onoff);
1544 static int sip_poke_peer_s(const void *data);
1545 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1546 static void reg_source_db(struct sip_peer *peer);
1547 static void destroy_association(struct sip_peer *peer);
1548 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1549 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1550 static void set_socket_transport(struct sip_socket *socket, int transport);
1551 static int peer_ipcmp_cb_full(void *obj, void *arg, void *data, int flags);
1552
1553 /* Realtime device support */
1554 static void realtime_update_peer(const char *peername, struct ast_sockaddr *addr, const char *username, const char *fullcontact, const char *useragent, int expirey, unsigned short deprecated_username, int lastms);
1555 static void update_peer(struct sip_peer *p, int expire);
1556 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1557 static const char *get_name_from_variable(const struct ast_variable *var);
1558 static struct sip_peer *realtime_peer(const char *peername, struct ast_sockaddr *sin, char *callbackexten, int devstate_only, int which_objects);
1559 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1560
1561 /*--- Internal UA client handling (outbound registrations) */
1562 static void ast_sip_ouraddrfor(const struct ast_sockaddr *them, struct ast_sockaddr *us, struct sip_pvt *p);
1563 static void sip_registry_destroy(struct sip_registry *reg);
1564 static int sip_register(const char *value, int lineno);
1565 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1566 static int sip_reregister(const void *data);
1567 static int __sip_do_register(struct sip_registry *r);
1568 static int sip_reg_timeout(const void *data);
1569 static void sip_send_all_registers(void);
1570 static int sip_reinvite_retry(const void *data);
1571
1572 /*--- Parsing SIP requests and responses */
1573 static int determine_firstline_parts(struct sip_request *req);
1574 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1575 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1576 static int find_sip_method(const char *msg);
1577 static unsigned int parse_allowed_methods(struct sip_request *req);
1578 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
1579 static int parse_request(struct sip_request *req);
1580 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1581 static int method_match(enum sipmethod id, const char *name);
1582 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1583 static void parse_oli(struct sip_request *req, struct ast_channel *chan);
1584 static const char *find_alias(const char *name, const char *_default);
1585 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1586 static void lws2sws(struct ast_str *msgbuf);
1587 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1588 static char *remove_uri_parameters(char *uri);
1589 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1590 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1591 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1592 static int set_address_from_contact(struct sip_pvt *pvt);
1593 static void check_via(struct sip_pvt *p, struct sip_request *req);
1594 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
1595 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason, char **reason_str);
1596 static enum sip_get_dest_result get_destination(struct sip_pvt *p, struct sip_request *oreq, int *cc_recall_core_id);
1597 static int transmit_state_notify(struct sip_pvt *p, struct state_notify_data *data, int full, int timeout);
1598 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
1599 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
1600 static int get_domain(const char *str, char *domain, int len);
1601 static void get_realm(struct sip_pvt *p, const struct sip_request *req);
1602 static char *get_content(struct sip_request *req);
1603
1604 /*-- TCP connection handling ---*/
1605 static void *_sip_tcp_helper_thread(struct ast_tcptls_session_instance *tcptls_session);
1606 static void *sip_tcp_worker_fn(void *);
1607
1608 /*--- Constructing requests and responses */
1609 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1610 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1611 static void deinit_req(struct sip_request *req);
1612 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, uint32_t seqno, int newbranch);
1613 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, const char * const explicit_uri);
1614 static int init_resp(struct sip_request *resp, const char *msg);
1615 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
1616 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1617 static const struct ast_sockaddr *sip_real_dst(const struct sip_pvt *p);
1618 static void build_via(struct sip_pvt *p);
1619 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1620 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct ast_sockaddr *addr, int newdialog);
1621 static char *generate_random_string(char *buf, size_t size);
1622 static void build_callid_pvt(struct sip_pvt *pvt);
1623 static void change_callid_pvt(struct sip_pvt *pvt, const char *callid);
1624 static void build_callid_registry(struct sip_registry *reg, const struct ast_sockaddr *ourip, const char *fromdomain);
1625 static void make_our_tag(struct sip_pvt *pvt);
1626 static int add_header(struct sip_request *req, const char *var, const char *value);
1627 static int add_max_forwards(struct sip_pvt *dialog, struct sip_request *req);
1628 static int add_content(struct sip_request *req, const char *line);
1629 static int finalize_content(struct sip_request *req);
1630 static void destroy_msg_headers(struct sip_pvt *pvt);
1631 static int add_text(struct sip_request *req, struct sip_pvt *p);
1632 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1633 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
1634 static int add_vidupdate(struct sip_request *req);
1635 static void add_route(struct sip_request *req, struct sip_route *route);
1636 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1637 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1638 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1639 static void set_destination(struct sip_pvt *p, char *uri);
1640 static void add_date(struct sip_request *req);
1641 static void add_expires(struct sip_request *req, int expires);
1642 static void build_contact(struct sip_pvt *p);
1643
1644 /*------Request handling functions */
1645 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, int *recount, int *nounlock);
1646 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
1647 static int handle_request_invite(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, int *recount, const char *e, int *nounlock);
1648 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, uint32_t seqno, int *nounlock);
1649 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1650 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *sin, const char *e);
1651 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1652 static int handle_request_message(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1653 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, const char *e);
1654 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1655 static int handle_request_options(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1656 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, int *nounlock);
1657 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, const char *e);
1658 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, uint32_t seqno, int *nounlock);
1659
1660 /*------Response handling functions */
1661 static void handle_response_publish(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1662 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1663 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1664 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1665 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1666 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1667 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1668
1669 /*------ SRTP Support -------- */
1670 static int setup_srtp(struct sip_srtp **srtp);
1671 static int process_crypto(struct sip_pvt *p, struct ast_rtp_instance *rtp, struct sip_srtp **srtp, const char *a);
1672
1673 /*------ T38 Support --------- */
1674 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1675 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1676 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1677 static void change_t38_state(struct sip_pvt *p, int state);
1678
1679 /*------ Session-Timers functions --------- */
1680 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
1681 static int  proc_session_timer(const void *vp);
1682 static void stop_session_timer(struct sip_pvt *p);
1683 static void start_session_timer(struct sip_pvt *p);
1684 static void restart_session_timer(struct sip_pvt *p);
1685 static const char *strefresherparam2str(enum st_refresher r);
1686 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher_param *const p_ref);
1687 static int parse_minse(const char *p_hdrval, int *const p_interval);
1688 static int st_get_se(struct sip_pvt *, int max);
1689 static enum st_refresher st_get_refresher(struct sip_pvt *);
1690 static enum st_mode st_get_mode(struct sip_pvt *, int no_cached);
1691 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
1692
1693 /*------- RTP Glue functions -------- */
1694 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_rtp_instance *vinstance, struct ast_rtp_instance *tinstance, const struct ast_format_cap *cap, int nat_active);
1695
1696 /*!--- SIP MWI Subscription support */
1697 static int sip_subscribe_mwi(const char *value, int lineno);
1698 static void sip_subscribe_mwi_destroy(struct sip_subscription_mwi *mwi);
1699 static void sip_send_all_mwi_subscriptions(void);
1700 static int sip_subscribe_mwi_do(const void *data);
1701 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
1702
1703 /*! \brief Definition of this channel for PBX channel registration */
1704 struct ast_channel_tech sip_tech = {
1705         .type = "SIP",
1706         .description = "Session Initiation Protocol (SIP)",
1707         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1708         .requester = sip_request_call,                  /* called with chan unlocked */
1709         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1710         .call = sip_call,                       /* called with chan locked */
1711         .send_html = sip_sendhtml,
1712         .hangup = sip_hangup,                   /* called with chan locked */
1713         .answer = sip_answer,                   /* called with chan locked */
1714         .read = sip_read,                       /* called with chan locked */
1715         .write = sip_write,                     /* called with chan locked */
1716         .write_video = sip_write,               /* called with chan locked */
1717         .write_text = sip_write,
1718         .indicate = sip_indicate,               /* called with chan locked */
1719         .transfer = sip_transfer,               /* called with chan locked */
1720         .fixup = sip_fixup,                     /* called with chan locked */
1721         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1722         .send_digit_end = sip_senddigit_end,
1723         .bridge = ast_rtp_instance_bridge,                      /* XXX chan unlocked ? */
1724         .early_bridge = ast_rtp_instance_early_bridge,
1725         .send_text = sip_sendtext,              /* called with chan locked */
1726         .func_channel_read = sip_acf_channel_read,
1727         .setoption = sip_setoption,
1728         .queryoption = sip_queryoption,
1729         .get_pvt_uniqueid = sip_get_callid,
1730 };
1731
1732 /*! \brief This version of the sip channel tech has no send_digit_begin
1733  * callback so that the core knows that the channel does not want
1734  * DTMF BEGIN frames.
1735  * The struct is initialized just before registering the channel driver,
1736  * and is for use with channels using SIP INFO DTMF.
1737  */
1738 struct ast_channel_tech sip_tech_info;
1739
1740 /*------- CC Support -------- */
1741 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan);
1742 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
1743 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
1744 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
1745 static int sip_cc_agent_status_request(struct ast_cc_agent *agent);
1746 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent);
1747 static int sip_cc_agent_recall(struct ast_cc_agent *agent);
1748 static void sip_cc_agent_destructor(struct ast_cc_agent *agent);
1749
1750 static struct ast_cc_agent_callbacks sip_cc_agent_callbacks = {
1751         .type = "SIP",
1752         .init = sip_cc_agent_init,
1753         .start_offer_timer = sip_cc_agent_start_offer_timer,
1754         .stop_offer_timer = sip_cc_agent_stop_offer_timer,
1755         .respond = sip_cc_agent_respond,
1756         .status_request = sip_cc_agent_status_request,
1757         .start_monitoring = sip_cc_agent_start_monitoring,
1758         .callee_available = sip_cc_agent_recall,
1759         .destructor = sip_cc_agent_destructor,
1760 };
1761
1762 static int find_by_notify_uri_helper(void *obj, void *arg, int flags)
1763 {
1764         struct ast_cc_agent *agent = obj;
1765         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1766         const char *uri = arg;
1767
1768         return !sip_uri_cmp(agent_pvt->notify_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1769 }
1770
1771 static struct ast_cc_agent *find_sip_cc_agent_by_notify_uri(const char * const uri)
1772 {
1773         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_notify_uri_helper, (char *)uri, "SIP");
1774         return agent;
1775 }
1776
1777 static int find_by_subscribe_uri_helper(void *obj, void *arg, int flags)
1778 {
1779         struct ast_cc_agent *agent = obj;
1780         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1781         const char *uri = arg;
1782
1783         return !sip_uri_cmp(agent_pvt->subscribe_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1784 }
1785
1786 static struct ast_cc_agent *find_sip_cc_agent_by_subscribe_uri(const char * const uri)
1787 {
1788         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_subscribe_uri_helper, (char *)uri, "SIP");
1789         return agent;
1790 }
1791
1792 static int find_by_callid_helper(void *obj, void *arg, int flags)
1793 {
1794         struct ast_cc_agent *agent = obj;
1795         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1796         struct sip_pvt *call_pvt = arg;
1797
1798         return !strcmp(agent_pvt->original_callid, call_pvt->callid) ? CMP_MATCH | CMP_STOP : 0;
1799 }
1800
1801 static struct ast_cc_agent *find_sip_cc_agent_by_original_callid(struct sip_pvt *pvt)
1802 {
1803         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_callid_helper, pvt, "SIP");
1804         return agent;
1805 }
1806
1807 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan)
1808 {
1809         struct sip_cc_agent_pvt *agent_pvt = ast_calloc(1, sizeof(*agent_pvt));
1810         struct sip_pvt *call_pvt = ast_channel_tech_pvt(chan);
1811
1812         if (!agent_pvt) {
1813                 return -1;
1814         }
1815
1816         ast_assert(!strcmp(ast_channel_tech(chan)->type, "SIP"));
1817
1818         ast_copy_string(agent_pvt->original_callid, call_pvt->callid, sizeof(agent_pvt->original_callid));
1819         ast_copy_string(agent_pvt->original_exten, call_pvt->exten, sizeof(agent_pvt->original_exten));
1820         agent_pvt->offer_timer_id = -1;
1821         agent->private_data = agent_pvt;
1822         sip_pvt_lock(call_pvt);
1823         ast_set_flag(&call_pvt->flags[0], SIP_OFFER_CC);
1824         sip_pvt_unlock(call_pvt);
1825         return 0;
1826 }
1827
1828 static int sip_offer_timer_expire(const void *data)
1829 {
1830         struct ast_cc_agent *agent = (struct ast_cc_agent *) data;
1831         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1832
1833         agent_pvt->offer_timer_id = -1;
1834
1835         return ast_cc_failed(agent->core_id, "SIP agent %s's offer timer expired", agent->device_name);
1836 }
1837
1838 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent)
1839 {
1840         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1841         int when;
1842
1843         when = ast_get_cc_offer_timer(agent->cc_params) * 1000;
1844         agent_pvt->offer_timer_id = ast_sched_add(sched, when, sip_offer_timer_expire, agent);
1845         return 0;
1846 }
1847
1848 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent)
1849 {
1850         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1851
1852         AST_SCHED_DEL(sched, agent_pvt->offer_timer_id);
1853         return 0;
1854 }
1855
1856 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
1857 {
1858         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1859
1860         sip_pvt_lock(agent_pvt->subscribe_pvt);
1861         ast_set_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED);
1862         if (reason == AST_CC_AGENT_RESPONSE_SUCCESS || !ast_strlen_zero(agent_pvt->notify_uri)) {
1863                 /* The second half of this if statement may be a bit hard to grasp,
1864                  * so here's an explanation. When a subscription comes into
1865                  * chan_sip, as long as it is not malformed, it will be passed
1866                  * to the CC core. If the core senses an out-of-order state transition,
1867                  * then the core will call this callback with the "reason" set to a
1868                  * failure condition.
1869                  * However, an out-of-order state transition will occur during a resubscription
1870                  * for CC. In such a case, we can see that we have already generated a notify_uri
1871                  * and so we can detect that this isn't a *real* failure. Rather, it is just
1872                  * something the core doesn't recognize as a legitimate SIP state transition.
1873                  * Thus we respond with happiness and flowers.
1874                  */
1875                 transmit_response(agent_pvt->subscribe_pvt, "200 OK", &agent_pvt->subscribe_pvt->initreq);
1876                 transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_QUEUED);
1877         } else {
1878                 transmit_response(agent_pvt->subscribe_pvt, "500 Internal Error", &agent_pvt->subscribe_pvt->initreq);
1879         }
1880         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1881         agent_pvt->is_available = TRUE;
1882 }
1883
1884 static int sip_cc_agent_status_request(struct ast_cc_agent *agent)
1885 {
1886         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1887         enum ast_device_state state = agent_pvt->is_available ? AST_DEVICE_NOT_INUSE : AST_DEVICE_INUSE;
1888         return ast_cc_agent_status_response(agent->core_id, state);
1889 }
1890
1891 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent)
1892 {
1893         /* To start monitoring just means to wait for an incoming PUBLISH
1894          * to tell us that the caller has become available again. No special
1895          * action is needed
1896          */
1897         return 0;
1898 }
1899
1900 static int sip_cc_agent_recall(struct ast_cc_agent *agent)
1901 {
1902         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1903         /* If we have received a PUBLISH beforehand stating that the caller in question
1904          * is not available, we can save ourself a bit of effort here and just report
1905          * the caller as busy
1906          */
1907         if (!agent_pvt->is_available) {
1908                 return ast_cc_agent_caller_busy(agent->core_id, "Caller %s is busy, reporting to the core",
1909                                 agent->device_name);
1910         }
1911         /* Otherwise, we transmit a NOTIFY to the caller and await either
1912          * a PUBLISH or an INVITE
1913          */
1914         sip_pvt_lock(agent_pvt->subscribe_pvt);
1915         transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_READY);
1916         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1917         return 0;
1918 }
1919
1920 static void sip_cc_agent_destructor(struct ast_cc_agent *agent)
1921 {
1922         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1923
1924         if (!agent_pvt) {
1925                 /* The agent constructor probably failed. */
1926                 return;
1927         }
1928
1929         sip_cc_agent_stop_offer_timer(agent);
1930         if (agent_pvt->subscribe_pvt) {
1931                 sip_pvt_lock(agent_pvt->subscribe_pvt);
1932                 if (!ast_test_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED)) {
1933                         /* If we haven't sent a 200 OK for the SUBSCRIBE dialog yet, then we need to send a response letting
1934                          * the subscriber know something went wrong
1935                          */
1936                         transmit_response(agent_pvt->subscribe_pvt, "500 Internal Server Error", &agent_pvt->subscribe_pvt->initreq);
1937                 }
1938                 sip_pvt_unlock(agent_pvt->subscribe_pvt);
1939                 agent_pvt->subscribe_pvt = dialog_unref(agent_pvt->subscribe_pvt, "SIP CC agent destructor: Remove ref to subscription");
1940         }
1941         ast_free(agent_pvt);
1942 }
1943
1944 struct ao2_container *sip_monitor_instances;
1945
1946 static int sip_monitor_instance_hash_fn(const void *obj, const int flags)
1947 {
1948         const struct sip_monitor_instance *monitor_instance = obj;
1949         return monitor_instance->core_id;
1950 }
1951
1952 static int sip_monitor_instance_cmp_fn(void *obj, void *arg, int flags)
1953 {
1954         struct sip_monitor_instance *monitor_instance1 = obj;
1955         struct sip_monitor_instance *monitor_instance2 = arg;
1956
1957         return monitor_instance1->core_id == monitor_instance2->core_id ? CMP_MATCH | CMP_STOP : 0;
1958 }
1959
1960 static void sip_monitor_instance_destructor(void *data)
1961 {
1962         struct sip_monitor_instance *monitor_instance = data;
1963         if (monitor_instance->subscription_pvt) {
1964                 sip_pvt_lock(monitor_instance->subscription_pvt);
1965                 monitor_instance->subscription_pvt->expiry = 0;
1966                 transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 0, monitor_instance->subscribe_uri);
1967                 sip_pvt_unlock(monitor_instance->subscription_pvt);
1968                 dialog_unref(monitor_instance->subscription_pvt, "Unref monitor instance ref of subscription pvt");
1969         }
1970         if (monitor_instance->suspension_entry) {
1971                 monitor_instance->suspension_entry->body[0] = '\0';
1972                 transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_REMOVE ,monitor_instance->notify_uri);
1973                 ao2_t_ref(monitor_instance->suspension_entry, -1, "Decrementing suspension entry refcount in sip_monitor_instance_destructor");
1974         }
1975         ast_string_field_free_memory(monitor_instance);
1976 }
1977
1978 static struct sip_monitor_instance *sip_monitor_instance_init(int core_id, const char * const subscribe_uri, const char * const peername, const char * const device_name)
1979 {
1980         struct sip_monitor_instance *monitor_instance = ao2_alloc(sizeof(*monitor_instance), sip_monitor_instance_destructor);
1981
1982         if (!monitor_instance) {
1983                 return NULL;
1984         }
1985
1986         if (ast_string_field_init(monitor_instance, 256)) {
1987                 ao2_ref(monitor_instance, -1);
1988                 return NULL;
1989         }
1990
1991         ast_string_field_set(monitor_instance, subscribe_uri, subscribe_uri);
1992         ast_string_field_set(monitor_instance, peername, peername);
1993         ast_string_field_set(monitor_instance, device_name, device_name);
1994         monitor_instance->core_id = core_id;
1995         ao2_link(sip_monitor_instances, monitor_instance);
1996         return monitor_instance;
1997 }
1998
1999 static int find_sip_monitor_instance_by_subscription_pvt(void *obj, void *arg, int flags)
2000 {
2001         struct sip_monitor_instance *monitor_instance = obj;
2002         return monitor_instance->subscription_pvt == arg ? CMP_MATCH | CMP_STOP : 0;
2003 }
2004
2005 static int find_sip_monitor_instance_by_suspension_entry(void *obj, void *arg, int flags)
2006 {
2007         struct sip_monitor_instance *monitor_instance = obj;
2008         return monitor_instance->suspension_entry == arg ? CMP_MATCH | CMP_STOP : 0;
2009 }
2010
2011 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
2012 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor);
2013 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
2014 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
2015 static void sip_cc_monitor_destructor(void *private_data);
2016
2017 static struct ast_cc_monitor_callbacks sip_cc_monitor_callbacks = {
2018         .type = "SIP",
2019         .request_cc = sip_cc_monitor_request_cc,
2020         .suspend = sip_cc_monitor_suspend,
2021         .unsuspend = sip_cc_monitor_unsuspend,
2022         .cancel_available_timer = sip_cc_monitor_cancel_available_timer,
2023         .destructor = sip_cc_monitor_destructor,
2024 };
2025
2026 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id)
2027 {
2028         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2029         enum ast_cc_service_type service = monitor->service_offered;
2030         int when;
2031
2032         if (!monitor_instance) {
2033                 return -1;
2034         }
2035
2036         if (!(monitor_instance->subscription_pvt = sip_alloc(NULL, NULL, 0, SIP_SUBSCRIBE, NULL, NULL))) {
2037                 return -1;
2038         }
2039
2040         when = service == AST_CC_CCBS ? ast_get_ccbs_available_timer(monitor->interface->config_params) :
2041                 ast_get_ccnr_available_timer(monitor->interface->config_params);
2042
2043         sip_pvt_lock(monitor_instance->subscription_pvt);
2044         ast_set_flag(&monitor_instance->subscription_pvt->flags[0], SIP_OUTGOING);
2045         create_addr(monitor_instance->subscription_pvt, monitor_instance->peername, 0, 1);
2046         ast_sip_ouraddrfor(&monitor_instance->subscription_pvt->sa, &monitor_instance->subscription_pvt->ourip, monitor_instance->subscription_pvt);
2047         monitor_instance->subscription_pvt->subscribed = CALL_COMPLETION;
2048         monitor_instance->subscription_pvt->expiry = when;
2049
2050         transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 2, monitor_instance->subscribe_uri);
2051         sip_pvt_unlock(monitor_instance->subscription_pvt);
2052
2053         ao2_t_ref(monitor, +1, "Adding a ref to the monitor for the scheduler");
2054         *available_timer_id = ast_sched_add(sched, when * 1000, ast_cc_available_timer_expire, monitor);
2055         return 0;
2056 }
2057
2058 static int construct_pidf_body(enum sip_cc_publish_state state, char *pidf_body, size_t size, const char *presentity)
2059 {
2060         struct ast_str *body = ast_str_alloca(size);
2061         char tuple_id[32];
2062
2063         generate_random_string(tuple_id, sizeof(tuple_id));
2064
2065         /* We'll make this a bare-bones pidf body. In state_notify_build_xml, the PIDF
2066          * body gets a lot more extra junk that isn't necessary, so we'll leave it out here.
2067          */
2068         ast_str_append(&body, 0, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
2069         /* XXX The entity attribute is currently set to the peer name associated with the
2070          * dialog. This is because we currently only call this function for call-completion
2071          * PUBLISH bodies. In such cases, the entity is completely disregarded. For other
2072          * event packages, it may be crucial to have a proper URI as the presentity so this
2073          * should be revisited as support is expanded.
2074          */
2075         ast_str_append(&body, 0, "<presence xmlns=\"urn:ietf:params:xml:ns:pidf\" entity=\"%s\">\n", presentity);
2076         ast_str_append(&body, 0, "<tuple id=\"%s\">\n", tuple_id);
2077         ast_str_append(&body, 0, "<status><basic>%s</basic></status>\n", state == CC_OPEN ? "open" : "closed");
2078         ast_str_append(&body, 0, "</tuple>\n");
2079         ast_str_append(&body, 0, "</presence>\n");
2080         ast_copy_string(pidf_body, ast_str_buffer(body), size);
2081         return 0;
2082 }
2083
2084 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor)
2085 {
2086         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2087         enum sip_publish_type publish_type;
2088         struct cc_epa_entry *cc_entry;
2089
2090         if (!monitor_instance) {
2091                 return -1;
2092         }
2093
2094         if (!monitor_instance->suspension_entry) {
2095                 /* We haven't yet allocated the suspension entry, so let's give it a shot */
2096                 if (!(monitor_instance->suspension_entry = create_epa_entry("call-completion", monitor_instance->peername))) {
2097                         ast_log(LOG_WARNING, "Unable to allocate sip EPA entry for call-completion\n");
2098                         ao2_ref(monitor_instance, -1);
2099                         return -1;
2100                 }
2101                 if (!(cc_entry = ast_calloc(1, sizeof(*cc_entry)))) {
2102                         ast_log(LOG_WARNING, "Unable to allocate space for instance data of EPA entry for call-completion\n");
2103                         ao2_ref(monitor_instance, -1);
2104                         return -1;
2105                 }
2106                 cc_entry->core_id = monitor->core_id;
2107                 monitor_instance->suspension_entry->instance_data = cc_entry;
2108                 publish_type = SIP_PUBLISH_INITIAL;
2109         } else {
2110                 publish_type = SIP_PUBLISH_MODIFY;
2111                 cc_entry = monitor_instance->suspension_entry->instance_data;
2112         }
2113
2114         cc_entry->current_state = CC_CLOSED;
2115
2116         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2117                 /* If we have no set notify_uri, then what this means is that we have
2118                  * not received a NOTIFY from this destination stating that he is
2119                  * currently available.
2120                  *
2121                  * This situation can arise when the core calls the suspend callbacks
2122                  * of multiple destinations. If one of the other destinations aside
2123                  * from this one notified Asterisk that he is available, then there
2124                  * is no reason to take any suspension action on this device. Rather,
2125                  * we should return now and if we receive a NOTIFY while monitoring
2126                  * is still "suspended" then we can immediately respond with the
2127                  * proper PUBLISH to let this endpoint know what is going on.
2128                  */
2129                 return 0;
2130         }
2131         construct_pidf_body(CC_CLOSED, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2132         return transmit_publish(monitor_instance->suspension_entry, publish_type, monitor_instance->notify_uri);
2133 }
2134
2135 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor)
2136 {
2137         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2138         struct cc_epa_entry *cc_entry;
2139
2140         if (!monitor_instance) {
2141                 return -1;
2142         }
2143
2144         ast_assert(monitor_instance->suspension_entry != NULL);
2145
2146         cc_entry = monitor_instance->suspension_entry->instance_data;
2147         cc_entry->current_state = CC_OPEN;
2148         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2149                 /* This means we are being asked to unsuspend a call leg we never
2150                  * sent a PUBLISH on. As such, there is no reason to send another
2151                  * PUBLISH at this point either. We can just return instead.
2152                  */
2153                 return 0;
2154         }
2155         construct_pidf_body(CC_OPEN, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2156         return transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_MODIFY, monitor_instance->notify_uri);
2157 }
2158
2159 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id)
2160 {
2161         if (*sched_id != -1) {
2162                 AST_SCHED_DEL(sched, *sched_id);
2163                 ao2_t_ref(monitor, -1, "Removing scheduler's reference to the monitor");
2164         }
2165         return 0;
2166 }
2167
2168 static void sip_cc_monitor_destructor(void *private_data)
2169 {
2170         struct sip_monitor_instance *monitor_instance = private_data;
2171         ao2_unlink(sip_monitor_instances, monitor_instance);
2172         ast_module_unref(ast_module_info->self);
2173 }
2174
2175 static int sip_get_cc_information(struct sip_request *req, char *subscribe_uri, size_t size, enum ast_cc_service_type *service)
2176 {
2177         char *call_info = ast_strdupa(sip_get_header(req, "Call-Info"));
2178         char *uri;
2179         char *purpose;
2180         char *service_str;
2181         static const char cc_purpose[] = "purpose=call-completion";
2182         static const int cc_purpose_len = sizeof(cc_purpose) - 1;
2183
2184         if (ast_strlen_zero(call_info)) {
2185                 /* No Call-Info present. Definitely no CC offer */
2186                 return -1;
2187         }
2188
2189         uri = strsep(&call_info, ";");
2190
2191         while ((purpose = strsep(&call_info, ";"))) {
2192                 if (!strncmp(purpose, cc_purpose, cc_purpose_len)) {
2193                         break;
2194                 }
2195         }
2196         if (!purpose) {
2197                 /* We didn't find the appropriate purpose= parameter. Oh well */
2198                 return -1;
2199         }
2200
2201         /* Okay, call-completion has been offered. Let's figure out what type of service this is */
2202         while ((service_str = strsep(&call_info, ";"))) {
2203                 if (!strncmp(service_str, "m=", 2)) {
2204                         break;
2205                 }
2206         }
2207         if (!service_str) {
2208                 /* So they didn't offer a particular service, We'll just go with CCBS since it really
2209                  * doesn't matter anyway
2210                  */
2211                 service_str = "BS";
2212         } else {
2213                 /* We already determined that there is an "m=" so no need to check
2214                  * the result of this strsep
2215                  */
2216                 strsep(&service_str, "=");
2217         }
2218
2219         if ((*service = service_string_to_service_type(service_str)) == AST_CC_NONE) {
2220                 /* Invalid service offered */
2221                 return -1;
2222         }
2223
2224         ast_copy_string(subscribe_uri, get_in_brackets(uri), size);
2225
2226         return 0;
2227 }
2228
2229 /*
2230  * \brief Determine what, if any, CC has been offered and queue a CC frame if possible
2231  *
2232  * After taking care of some formalities to be sure that this call is eligible for CC,
2233  * we first try to see if we can make use of native CC. We grab the information from
2234  * the passed-in sip_request (which is always a response to an INVITE). If we can
2235  * use native CC monitoring for the call, then so be it.
2236  *
2237  * If native cc monitoring is not possible or not supported, then we will instead attempt
2238  * to use generic monitoring. Falling back to generic from a failed attempt at using native
2239  * monitoring will only work if the monitor policy of the endpoint is "always"
2240  *
2241  * \param pvt The current dialog. Contains CC parameters for the endpoint
2242  * \param req The response to the INVITE we want to inspect
2243  * \param service The service to use if generic monitoring is to be used. For native
2244  * monitoring, we get the service from the SIP response itself
2245  */
2246 static void sip_handle_cc(struct sip_pvt *pvt, struct sip_request *req, enum ast_cc_service_type service)
2247 {
2248         enum ast_cc_monitor_policies monitor_policy = ast_get_cc_monitor_policy(pvt->cc_params);
2249         int core_id;
2250         char interface_name[AST_CHANNEL_NAME];
2251
2252         if (monitor_policy == AST_CC_MONITOR_NEVER) {
2253                 /* Don't bother, just return */
2254                 return;
2255         }
2256
2257         if ((core_id = ast_cc_get_current_core_id(pvt->owner)) == -1) {
2258                 /* For some reason, CC is invalid, so don't try it! */
2259                 return;
2260         }
2261
2262         ast_channel_get_device_name(pvt->owner, interface_name, sizeof(interface_name));
2263
2264         if (monitor_policy == AST_CC_MONITOR_ALWAYS || monitor_policy == AST_CC_MONITOR_NATIVE) {
2265                 char subscribe_uri[SIPBUFSIZE];
2266                 char device_name[AST_CHANNEL_NAME];
2267                 enum ast_cc_service_type offered_service;
2268                 struct sip_monitor_instance *monitor_instance;
2269                 if (sip_get_cc_information(req, subscribe_uri, sizeof(subscribe_uri), &offered_service)) {
2270                         /* If CC isn't being offered to us, or for some reason the CC offer is
2271                          * not formatted correctly, then it may still be possible to use generic
2272                          * call completion since the monitor policy may be "always"
2273                          */
2274                         goto generic;
2275                 }
2276                 ast_channel_get_device_name(pvt->owner, device_name, sizeof(device_name));
2277                 if (!(monitor_instance = sip_monitor_instance_init(core_id, subscribe_uri, pvt->peername, device_name))) {
2278                         /* Same deal. We can try using generic still */
2279                         goto generic;
2280                 }
2281                 /* We bump the refcount of chan_sip because once we queue this frame, the CC core
2282                  * will have a reference to callbacks in this module. We decrement the module
2283                  * refcount once the monitor destructor is called
2284                  */
2285                 ast_module_ref(ast_module_info->self);
2286                 ast_queue_cc_frame(pvt->owner, "SIP", pvt->dialstring, offered_service, monitor_instance);
2287                 ao2_ref(monitor_instance, -1);
2288                 return;
2289         }
2290
2291 generic:
2292         if (monitor_policy == AST_CC_MONITOR_GENERIC || monitor_policy == AST_CC_MONITOR_ALWAYS) {
2293                 ast_queue_cc_frame(pvt->owner, AST_CC_GENERIC_MONITOR_TYPE, interface_name, service, NULL);
2294         }
2295 }
2296
2297 /*! \brief Working TLS connection configuration */
2298 static struct ast_tls_config sip_tls_cfg;
2299
2300 /*! \brief Default TLS connection configuration */
2301 static struct ast_tls_config default_tls_cfg;
2302
2303 /*! \brief The TCP server definition */
2304 static struct ast_tcptls_session_args sip_tcp_desc = {
2305         .accept_fd = -1,
2306         .master = AST_PTHREADT_NULL,
2307         .tls_cfg = NULL,
2308         .poll_timeout = -1,
2309         .name = "SIP TCP server",
2310         .accept_fn = ast_tcptls_server_root,
2311         .worker_fn = sip_tcp_worker_fn,
2312 };
2313
2314 /*! \brief The TCP/TLS server definition */
2315 static struct ast_tcptls_session_args sip_tls_desc = {
2316         .accept_fd = -1,
2317         .master = AST_PTHREADT_NULL,
2318         .tls_cfg = &sip_tls_cfg,
2319         .poll_timeout = -1,
2320         .name = "SIP TLS server",
2321         .accept_fn = ast_tcptls_server_root,
2322         .worker_fn = sip_tcp_worker_fn,
2323 };
2324
2325 /*! \brief Append to SIP dialog history
2326         \return Always returns 0 */
2327 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
2328
2329 struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, const char *tag, char *file, int line, const char *func)
2330 {
2331         if (p)
2332 #ifdef REF_DEBUG
2333                 __ao2_ref_debug(p, 1, tag, file, line, func);
2334 #else
2335                 ao2_ref(p, 1);
2336 #endif
2337         else
2338                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
2339         return p;
2340 }
2341
2342 struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, const char *tag, char *file, int line, const char *func)
2343 {
2344         if (p)
2345 #ifdef REF_DEBUG
2346                 __ao2_ref_debug(p, -1, tag, file, line, func);
2347 #else
2348                 ao2_ref(p, -1);
2349 #endif
2350         return NULL;
2351 }
2352
2353 /*! \brief map from an integer value to a string.
2354  * If no match is found, return errorstring
2355  */
2356 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2357 {
2358         const struct _map_x_s *cur;
2359
2360         for (cur = table; cur->s; cur++) {
2361                 if (cur->x == x) {
2362                         return cur->s;
2363                 }
2364         }
2365         return errorstring;
2366 }
2367
2368 /*! \brief map from a string to an integer value, case insensitive.
2369  * If no match is found, return errorvalue.
2370  */
2371 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2372 {
2373         const struct _map_x_s *cur;
2374
2375         for (cur = table; cur->s; cur++) {
2376                 if (!strcasecmp(cur->s, s)) {
2377                         return cur->x;
2378                 }
2379         }
2380         return errorvalue;
2381 }
2382
2383 static enum AST_REDIRECTING_REASON sip_reason_str_to_code(const char *text)
2384 {
2385         enum AST_REDIRECTING_REASON ast = AST_REDIRECTING_REASON_UNKNOWN;
2386         int i;
2387
2388         for (i = 0; i < ARRAY_LEN(sip_reason_table); ++i) {
2389                 if (!strcasecmp(text, sip_reason_table[i].text)) {
2390                         ast = sip_reason_table[i].code;
2391                         break;
2392                 }
2393         }
2394
2395         return ast;
2396 }
2397
2398 static const char *sip_reason_code_to_str(struct ast_party_redirecting_reason *reason, int *table_lookup)
2399 {
2400         int code = reason->code;
2401
2402         /* If there's a specific string set, then we just
2403          * use it.
2404          */
2405         if (!ast_strlen_zero(reason->str)) {
2406                 /* If we care about whether this can be found in
2407                  * the table, then we need to check about that.
2408                  */
2409                 if (table_lookup) {
2410                         /* If the string is literally "unknown" then don't bother with the lookup
2411                          * because it can lead to a false negative.
2412                          */
2413                         if (!strcasecmp(reason->str, "unknown") ||
2414                                         sip_reason_str_to_code(reason->str) != AST_REDIRECTING_REASON_UNKNOWN) {
2415                                 *table_lookup = TRUE;
2416                         } else {
2417                                 *table_lookup = FALSE;
2418                         }
2419                 }
2420                 return reason->str;
2421         }
2422
2423         if (table_lookup) {
2424                 *table_lookup = TRUE;
2425         }
2426
2427         if (code >= 0 && code < ARRAY_LEN(sip_reason_table)) {
2428                 return sip_reason_table[code].text;
2429         }
2430
2431         return "unknown";
2432 }
2433
2434 /*!
2435  * \brief generic function for determining if a correct transport is being
2436  * used to contact a peer
2437  *
2438  * this is done as a macro so that the "tmpl" var can be passed either a
2439  * sip_request or a sip_peer
2440  */
2441 #define check_request_transport(peer, tmpl) ({ \
2442         int ret = 0; \
2443         if (peer->socket.type == tmpl->socket.type) \
2444                 ; \
2445         else if (!(peer->transports & tmpl->socket.type)) {\
2446                 ast_log(LOG_ERROR, \
2447                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
2448                         sip_get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
2449                         ); \
2450                 ret = 1; \
2451         } else if (peer->socket.type & SIP_TRANSPORT_TLS) { \
2452                 ast_log(LOG_WARNING, \
2453                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
2454                         peer->name, sip_get_transport(tmpl->socket.type) \
2455                 ); \
2456         } else { \
2457                 ast_debug(1, \
2458                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
2459                         peer->name, sip_get_transport(tmpl->socket.type), sip_get_transport(peer->socket.type) \
2460                 ); \
2461         }\
2462         (ret); \
2463 })
2464
2465 /*! \brief
2466  * duplicate a list of channel variables, \return the copy.
2467  */
2468 static struct ast_variable *copy_vars(struct ast_variable *src)
2469 {
2470         struct ast_variable *res = NULL, *tmp, *v = NULL;
2471
2472         for (v = src ; v ; v = v->next) {
2473                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
2474                         tmp->next = res;
2475                         res = tmp;
2476                 }
2477         }
2478         return res;
2479 }
2480
2481 static void tcptls_packet_destructor(void *obj)
2482 {
2483         struct tcptls_packet *packet = obj;
2484
2485         ast_free(packet->data);
2486 }
2487
2488 static void sip_tcptls_client_args_destructor(void *obj)
2489 {
2490         struct ast_tcptls_session_args *args = obj;
2491         if (args->tls_cfg) {
2492                 ast_free(args->tls_cfg->certfile);
2493                 ast_free(args->tls_cfg->pvtfile);
2494                 ast_free(args->tls_cfg->cipher);
2495                 ast_free(args->tls_cfg->cafile);
2496                 ast_free(args->tls_cfg->capath);
2497
2498                 ast_ssl_teardown(args->tls_cfg);
2499         }
2500         ast_free(args->tls_cfg);
2501         ast_free((char *) args->name);
2502 }
2503
2504 static void sip_threadinfo_destructor(void *obj)
2505 {
2506         struct sip_threadinfo *th = obj;
2507         struct tcptls_packet *packet;
2508
2509         if (th->alert_pipe[1] > -1) {
2510                 close(th->alert_pipe[0]);
2511         }
2512         if (th->alert_pipe[1] > -1) {
2513                 close(th->alert_pipe[1]);
2514         }
2515         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2516
2517         while ((packet = AST_LIST_REMOVE_HEAD(&th->packet_q, entry))) {
2518                 ao2_t_ref(packet, -1, "thread destruction, removing packet from frame queue");
2519         }
2520
2521         if (th->tcptls_session) {
2522                 ao2_t_ref(th->tcptls_session, -1, "remove tcptls_session for sip_threadinfo object");
2523         }
2524 }
2525
2526 /*! \brief creates a sip_threadinfo object and links it into the threadt table. */
2527 static struct sip_threadinfo *sip_threadinfo_create(struct ast_tcptls_session_instance *tcptls_session, int transport)
2528 {
2529         struct sip_threadinfo *th;
2530
2531         if (!tcptls_session || !(th = ao2_alloc(sizeof(*th), sip_threadinfo_destructor))) {
2532                 return NULL;
2533         }
2534
2535         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2536
2537         if (pipe(th->alert_pipe) == -1) {
2538                 ao2_t_ref(th, -1, "Failed to open alert pipe on sip_threadinfo");
2539                 ast_log(LOG_ERROR, "Could not create sip alert pipe in tcptls thread, error %s\n", strerror(errno));
2540                 return NULL;
2541         }
2542         ao2_t_ref(tcptls_session, +1, "tcptls_session ref for sip_threadinfo object");
2543         th->tcptls_session = tcptls_session;
2544         th->type = transport ? transport : (tcptls_session->ssl ? SIP_TRANSPORT_TLS: SIP_TRANSPORT_TCP);
2545         ao2_t_link(threadt, th, "Adding new tcptls helper thread");
2546         ao2_t_ref(th, -1, "Decrementing threadinfo ref from alloc, only table ref remains");
2547         return th;
2548 }
2549
2550 /*! \brief used to indicate to a tcptls thread that data is ready to be written */
2551 static int sip_tcptls_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t len)
2552 {
2553         int res = len;
2554         struct sip_threadinfo *th = NULL;
2555         struct tcptls_packet *packet = NULL;
2556         struct sip_threadinfo tmp = {
2557                 .tcptls_session = tcptls_session,
2558         };
2559         enum sip_tcptls_alert alert = TCPTLS_ALERT_DATA;
2560
2561         if (!tcptls_session) {
2562                 return XMIT_ERROR;
2563         }
2564
2565         ao2_lock(tcptls_session);
2566
2567         if ((tcptls_session->fd == -1) ||
2568                 !(th = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread")) ||
2569                 !(packet = ao2_alloc(sizeof(*packet), tcptls_packet_destructor)) ||
2570                 !(packet->data = ast_str_create(len))) {
2571                 goto tcptls_write_setup_error;
2572         }
2573
2574         /* goto tcptls_write_error should _NOT_ be used beyond this point */
2575         ast_str_set(&packet->data, 0, "%s", (char *) buf);
2576         packet->len = len;
2577
2578         /* alert tcptls thread handler that there is a packet to be sent.
2579          * must lock the thread info object to guarantee control of the
2580          * packet queue */
2581         ao2_lock(th);
2582         if (write(th->alert_pipe[1], &alert, sizeof(alert)) == -1) {
2583                 ast_log(LOG_ERROR, "write() to alert pipe failed: %s\n", strerror(errno));
2584                 ao2_t_ref(packet, -1, "could not write to alert pipe, remove packet");
2585                 packet = NULL;
2586                 res = XMIT_ERROR;
2587         } else { /* it is safe to queue the frame after issuing the alert when we hold the threadinfo lock */
2588                 AST_LIST_INSERT_TAIL(&th->packet_q, packet, entry);
2589         }
2590         ao2_unlock(th);
2591
2592         ao2_unlock(tcptls_session);
2593         ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo object after finding it");
2594         return res;
2595
2596 tcptls_write_setup_error:
2597         if (th) {
2598                 ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo obj, could not create packet");
2599         }
2600         if (packet) {
2601                 ao2_t_ref(packet, -1, "could not allocate packet's data");
2602         }
2603         ao2_unlock(tcptls_session);
2604
2605         return XMIT_ERROR;
2606 }
2607
2608 /*! \brief SIP TCP connection handler */
2609 static void *sip_tcp_worker_fn(void *data)
2610 {
2611         struct ast_tcptls_session_instance *tcptls_session = data;
2612
2613         return _sip_tcp_helper_thread(tcptls_session);
2614 }
2615
2616 /*! \brief SIP WebSocket connection handler */
2617 static void sip_websocket_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers)
2618 {
2619         int res;
2620
2621         if (ast_websocket_set_nonblock(session)) {
2622                 goto end;
2623         }
2624
2625         while ((res = ast_wait_for_input(ast_websocket_fd(session), -1)) > 0) {
2626                 char *payload;
2627                 uint64_t payload_len;
2628                 enum ast_websocket_opcode opcode;
2629                 int fragmented;
2630
2631                 if (ast_websocket_read(session, &payload, &payload_len, &opcode, &fragmented)) {
2632                         /* We err on the side of caution and terminate the session if any error occurs */
2633                         break;
2634                 }
2635
2636                 if (opcode == AST_WEBSOCKET_OPCODE_TEXT || opcode == AST_WEBSOCKET_OPCODE_BINARY) {
2637                         struct sip_request req = { 0, };
2638
2639                         if (!(req.data = ast_str_create(payload_len))) {
2640                                 goto end;
2641                         }
2642
2643                         if (ast_str_set(&req.data, -1, "%s", payload) == AST_DYNSTR_BUILD_FAILED) {
2644                                 deinit_req(&req);
2645                                 goto end;
2646                         }
2647
2648                         req.socket.fd = ast_websocket_fd(session);
2649                         set_socket_transport(&req.socket, ast_websocket_is_secure(session) ? SIP_TRANSPORT_WSS : SIP_TRANSPORT_WS);
2650                         req.socket.ws_session = session;
2651
2652                         handle_request_do(&req, ast_websocket_remote_address(session));
2653                         deinit_req(&req);
2654
2655                 } else if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
2656                         break;
2657                 }
2658         }
2659
2660 end:
2661         ast_websocket_unref(session);
2662 }
2663
2664 /*! \brief Check if the authtimeout has expired.
2665  * \param start the time when the session started
2666  *
2667  * \retval 0 the timeout has expired
2668  * \retval -1 error
2669  * \return the number of milliseconds until the timeout will expire
2670  */
2671 static int sip_check_authtimeout(time_t start)
2672 {
2673         int timeout;
2674         time_t now;
2675         if(time(&now) == -1) {
2676                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
2677                 return -1;
2678         }
2679
2680         timeout = (authtimeout - (now - start)) * 1000;
2681         if (timeout < 0) {
2682                 /* we have timed out */
2683                 return 0;
2684         }
2685
2686         return timeout;
2687 }
2688
2689 /*! \brief SIP TCP thread management function
2690         This function reads from the socket, parses the packet into a request
2691 */
2692 static void *_sip_tcp_helper_thread(struct ast_tcptls_session_instance *tcptls_session)
2693 {
2694         int res, cl, timeout = -1, authenticated = 0, flags, after_poll = 0, need_poll = 1;
2695         time_t start;
2696         struct sip_request req = { 0, } , reqcpy = { 0, };
2697         struct sip_threadinfo *me = NULL;
2698         char buf[1024] = "";
2699         struct pollfd fds[2] = { { 0 }, { 0 }, };
2700         struct ast_tcptls_session_args *ca = NULL;
2701
2702         /* If this is a server session, then the connection has already been
2703          * setup. Check if the authlimit has been reached and if not create the
2704          * threadinfo object so we can access this thread for writing.
2705          *
2706          * if this is a client connection more work must be done.
2707          * 1. We own the parent session args for a client connection.  This pointer needs
2708          *    to be held on to so we can decrement it's ref count on thread destruction.
2709          * 2. The threadinfo object was created before this thread was launched, however
2710          *    it must be found within the threadt table.
2711          * 3. Last, the tcptls_session must be started.
2712          */
2713         if (!tcptls_session->client) {
2714                 if (ast_atomic_fetchadd_int(&unauth_sessions, +1) >= authlimit) {
2715                         /* unauth_sessions is decremented in the cleanup code */
2716                         goto cleanup;
2717                 }
2718
2719                 if ((flags = fcntl(tcptls_session->fd, F_GETFL)) == -1) {
2720                         ast_log(LOG_ERROR, "error setting socket to non blocking mode, fcntl() failed: %s\n", strerror(errno));
2721                         goto cleanup;
2722                 }
2723
2724                 flags |= O_NONBLOCK;
2725                 if (fcntl(tcptls_session->fd, F_SETFL, flags) == -1) {
2726                         ast_log(LOG_ERROR, "error setting socket to non blocking mode, fcntl() failed: %s\n", strerror(errno));
2727                         goto cleanup;
2728                 }
2729
2730                 if (!(me = sip_threadinfo_create(tcptls_session, tcptls_session->ssl ? SIP_TRANSPORT_TLS : SIP_TRANSPORT_TCP))) {
2731                         goto cleanup;
2732                 }
2733                 ao2_t_ref(me, +1, "Adding threadinfo ref for tcp_helper_thread");
2734         } else {
2735                 struct sip_threadinfo tmp = {
2736                         .tcptls_session = tcptls_session,
2737                 };
2738
2739                 if ((!(ca = tcptls_session->parent)) ||
2740                         (!(me = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread"))) ||
2741                         (!(tcptls_session = ast_tcptls_client_start(tcptls_session)))) {
2742                         goto cleanup;
2743                 }
2744         }
2745
2746         flags = 1;
2747         if (setsockopt(tcptls_session->fd, SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
2748                 ast_log(LOG_ERROR, "error enabling TCP keep-alives on sip socket: %s\n", strerror(errno));
2749                 goto cleanup;
2750         }
2751
2752         me->threadid = pthread_self();
2753         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2754
2755         /* set up pollfd to watch for reads on both the socket and the alert_pipe */
2756         fds[0].fd = tcptls_session->fd;
2757         fds[1].fd = me->alert_pipe[0];
2758         fds[0].events = fds[1].events = POLLIN | POLLPRI;
2759
2760         if (!(req.data = ast_str_create(SIP_MIN_PACKET))) {
2761                 goto cleanup;
2762         }
2763         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET))) {
2764                 goto cleanup;
2765         }
2766
2767         if(time(&start) == -1) {
2768                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
2769                 goto cleanup;
2770         }
2771
2772         for (;;) {
2773                 struct ast_str *str_save;
2774
2775                 if (!tcptls_session->client && req.authenticated && !authenticated) {
2776                         authenticated = 1;
2777                         ast_atomic_fetchadd_int(&unauth_sessions, -1);
2778                 }
2779
2780                 /* calculate the timeout for unauthenticated server sessions */
2781                 if (!tcptls_session->client && !authenticated ) {
2782                         if ((timeout = sip_check_authtimeout(start)) < 0) {
2783                                 goto cleanup;
2784                         }
2785
2786                         if (timeout == 0) {
2787                                 ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2788                                 goto cleanup;
2789                         }
2790                 } else {
2791                         timeout = -1;
2792                 }
2793
2794                 res = ast_poll(fds, 2, timeout); /* polls for both socket and alert_pipe */
2795                 if (res < 0) {
2796                         ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", tcptls_session->ssl ? "SSL": "TCP", res);
2797                         goto cleanup;
2798                 } else if (res == 0) {
2799                         /* timeout */
2800                         ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2801                         goto cleanup;
2802                 }
2803
2804                 /* handle the socket event, check for both reads from the socket fd,
2805                  * and writes from alert_pipe fd */
2806                 if (fds[0].revents) { /* there is data on the socket to be read */
2807                         after_poll = 1;
2808
2809                         fds[0].revents = 0;
2810
2811                         /* clear request structure */
2812                         str_save = req.data;
2813                         memset(&req, 0, sizeof(req));
2814                         req.data = str_save;
2815                         ast_str_reset(req.data);
2816
2817                         str_save = reqcpy.data;
2818                         memset(&reqcpy, 0, sizeof(reqcpy));
2819                         reqcpy.data = str_save;
2820                         ast_str_reset(reqcpy.data);
2821
2822                         memset(buf, 0, sizeof(buf));
2823
2824                         if (tcptls_session->ssl) {
2825                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TLS);
2826                                 req.socket.port = htons(ourport_tls);
2827                         } else {
2828                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TCP);
2829                                 req.socket.port = htons(ourport_tcp);
2830                         }
2831                         req.socket.fd = tcptls_session->fd;
2832
2833                         /* Read in headers one line at a time */
2834                         while (ast_str_strlen(req.data) < 4 || strncmp(REQ_OFFSET_TO_STR(&req, data->used - 4), "\r\n\r\n", 4)) {
2835                                 if (!tcptls_session->client && !authenticated ) {
2836                                         if ((timeout = sip_check_authtimeout(start)) < 0) {
2837                                                 goto cleanup;
2838                                         }
2839
2840                                         if (timeout == 0) {
2841                                                 ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2842                                                 goto cleanup;
2843                                         }
2844                                 } else {
2845                                         timeout = -1;
2846                                 }
2847
2848                                 /* special polling behavior is required for TLS
2849                                  * sockets because of the buffering done in the
2850                                  * TLS layer */
2851                                 if (!tcptls_session->ssl || need_poll) {
2852                                         need_poll = 0;
2853                                         after_poll = 1;
2854                                         res = ast_wait_for_input(tcptls_session->fd, timeout);
2855                                         if (res < 0) {
2856                                                 ast_debug(2, "SIP TCP server :: ast_wait_for_input returned %d\n", res);
2857                                                 goto cleanup;
2858                                         } else if (res == 0) {
2859                                                 /* timeout */
2860                                                 ast_debug(2, "SIP TCP server timed out\n");
2861                                                 goto cleanup;
2862                                         }
2863                                 }
2864
2865                                 ao2_lock(tcptls_session);
2866                                 if (!fgets(buf, sizeof(buf), tcptls_session->f)) {
2867                                         ao2_unlock(tcptls_session);
2868                                         if (after_poll) {
2869                                                 goto cleanup;
2870                                         } else {
2871                                                 need_poll = 1;
2872                                                 continue;
2873                                         }
2874                                 }
2875                                 ao2_unlock(tcptls_session);
2876                                 after_poll = 0;
2877                                 if (me->stop) {
2878                                          goto cleanup;
2879                                 }
2880                                 ast_str_append(&req.data, 0, "%s", buf);
2881                         }
2882                         copy_request(&reqcpy, &req);
2883                         parse_request(&reqcpy);
2884                         /* In order to know how much to read, we need the content-length header */
2885                         if (sscanf(sip_get_header(&reqcpy, "Content-Length"), "%30d", &cl)) {
2886                                 while (cl > 0) {
2887                                         size_t bytes_read;
2888                                         if (!tcptls_session->client && !authenticated ) {
2889                                                 if ((timeout = sip_check_authtimeout(start)) < 0) {
2890                                                         goto cleanup;
2891                                                 }
2892
2893                                                 if (timeout == 0) {
2894                                                         ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2895                                                         goto cleanup;
2896                                                 }
2897                                         } else {
2898                                                 timeout = -1;
2899                                         }
2900
2901                                         if (!tcptls_session->ssl || need_poll) {
2902                                                 need_poll = 0;
2903                                                 after_poll = 1;
2904                                                 res = ast_wait_for_input(tcptls_session->fd, timeout);
2905                                                 if (res < 0) {
2906                                                         ast_debug(2, "SIP TCP server :: ast_wait_for_input returned %d\n", res);
2907                                                         goto cleanup;
2908                                                 } else if (res == 0) {
2909                                                         /* timeout */
2910                                                         ast_debug(2, "SIP TCP server timed out\n");
2911                                                         goto cleanup;
2912                                                 }
2913                                         }
2914
2915                                         ao2_lock(tcptls_session);
2916                                         if (!(bytes_read = fread(buf, 1, MIN(sizeof(buf) - 1, cl), tcptls_session->f))) {
2917                                                 ao2_unlock(tcptls_session);
2918                                                 if (after_poll) {
2919                                                         goto cleanup;
2920                                                 } else {
2921                                                         need_poll = 1;
2922                                                         continue;
2923                                                 }
2924                                         }
2925                                         buf[bytes_read] = '\0';
2926                                         ao2_unlock(tcptls_session);
2927                                         after_poll = 0;
2928                                         if (me->stop) {
2929                                                 goto cleanup;
2930                                         }
2931                                         cl -= strlen(buf);
2932                                         ast_str_append(&req.data, 0, "%s", buf);
2933                                 }
2934                         }
2935                         /*! \todo XXX If there's no Content-Length or if the content-length and what
2936                                         we receive is not the same - we should generate an error */
2937
2938                         req.socket.tcptls_session = tcptls_session;
2939                         req.socket.ws_session = NULL;
2940                         handle_request_do(&req, &tcptls_session->remote_address);
2941                 }
2942
2943                 if (fds[1].revents) { /* alert_pipe indicates there is data in the send queue to be sent */
2944                         enum sip_tcptls_alert alert;
2945                         struct tcptls_packet *packet;
2946
2947                         fds[1].revents = 0;
2948
2949                         if (read(me->alert_pipe[0], &alert, sizeof(alert)) == -1) {
2950                                 ast_log(LOG_ERROR, "read() failed: %s\n", strerror(errno));
2951                                 continue;
2952                         }
2953
2954                         switch (alert) {
2955                         case TCPTLS_ALERT_STOP:
2956                                 goto cleanup;
2957                         case TCPTLS_ALERT_DATA:
2958                                 ao2_lock(me);
2959                                 if (!(packet = AST_LIST_REMOVE_HEAD(&me->packet_q, entry))) {
2960                                         ast_log(LOG_WARNING, "TCPTLS thread alert_pipe indicated packet should be sent, but frame_q is empty\n");
2961                                 }
2962                                 ao2_unlock(me);
2963
2964                                 if (packet) {
2965                                         if (ast_tcptls_server_write(tcptls_session, ast_str_buffer(packet->data), packet->len) == -1) {
2966                                                 ast_log(LOG_WARNING, "Failure to write to tcp/tls socket\n");
2967                                         }
2968                                         ao2_t_ref(packet, -1, "tcptls packet sent, this is no longer needed");
2969                                 }
2970                                 break;
2971                         default:
2972                                 ast_log(LOG_ERROR, "Unknown tcptls thread alert '%d'\n", alert);
2973                         }
2974                 }
2975         }
2976
2977         ast_debug(2, "Shutting down thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2978
2979 cleanup:
2980         if (tcptls_session && !tcptls_session->client && !authenticated) {
2981                 ast_atomic_fetchadd_int(&unauth_sessions, -1);
2982         }
2983
2984         if (me) {
2985                 ao2_t_unlink(threadt, me, "Removing tcptls helper thread, thread is closing");
2986                 ao2_t_ref(me, -1, "Removing tcp_helper_threads threadinfo ref");
2987         }
2988         deinit_req(&reqcpy);
2989         deinit_req(&req);
2990
2991         /* if client, we own the parent session arguments and must decrement ref */
2992         if (ca) {
2993                 ao2_t_ref(ca, -1, "closing tcptls thread, getting rid of client tcptls_session arguments");
2994         }
2995
2996         if (tcptls_session) {
2997                 ao2_lock(tcptls_session);
2998                 ast_tcptls_close_session_file(tcptls_session);
2999                 tcptls_session->parent = NULL;
3000                 ao2_unlock(tcptls_session);
3001
3002                 ao2_ref(tcptls_session, -1);
3003                 tcptls_session = NULL;
3004         }
3005         return NULL;
3006 }
3007
3008 #ifdef REF_DEBUG
3009 #define sip_ref_peer(arg1,arg2) _ref_peer((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
3010 #define sip_unref_peer(arg1,arg2) _unref_peer((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
3011 static struct sip_peer *_ref_peer(struct sip_peer *peer, char *tag, char *file, int line, const char *func)
3012 {
3013         if (peer)
3014                 __ao2_ref_debug(peer, 1, tag, file, line, func);
3015         else
3016                 ast_log(LOG_ERROR, "Attempt to Ref a null peer pointer\n");
3017         return peer;
3018 }
3019
3020 static struct sip_peer *_unref_peer(struct sip_peer *peer, char *tag, char *file, int line, const char *func)
3021 {
3022         if (peer)
3023                 __ao2_ref_debug(peer, -1, tag, file, line, func);
3024         return NULL;
3025 }
3026 #else
3027 /*!
3028  * helper functions to unreference various types of objects.
3029  * By handling them this way, we don't have to declare the
3030  * destructor on each call, which removes the chance of errors.
3031  */
3032 void *sip_unref_peer(struct sip_peer *peer, char *tag)
3033 {
3034         ao2_t_ref(peer, -1, tag);
3035         return NULL;
3036 }
3037
3038 struct sip_peer *sip_ref_peer(struct sip_peer *peer, char *tag)
3039 {
3040         ao2_t_ref(peer, 1, tag);
3041         return peer;
3042 }
3043 #endif /* REF_DEBUG */
3044
3045 static void peer_sched_cleanup(struct sip_peer *peer)
3046 {
3047         if (peer->pokeexpire != -1) {
3048                 AST_SCHED_DEL_UNREF(sched, peer->pokeexpire,
3049                                 sip_unref_peer(peer, "removing poke peer ref"));
3050         }
3051         if (peer->expire != -1) {
3052                 AST_SCHED_DEL_UNREF(sched, peer->expire,
3053                                 sip_unref_peer(peer, "remove register expire ref"));
3054         }
3055         if (peer->keepalivesend != -1) {
3056                 AST_SCHED_DEL_UNREF(sched, peer->keepalivesend,
3057                                     sip_unref_peer(peer, "remove keepalive peer ref"));
3058         }
3059 }
3060
3061 typedef enum {
3062         SIP_PEERS_MARKED,