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