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