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