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