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