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