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