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