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