9e2ddf7ed5e8ed6c08f884fe78fead6a889a8031
[asterisk/asterisk.git] / channels / chan_sip.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief Implementation of Session Initiation Protocol
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * See Also:
26  * \arg \ref AstCREDITS
27  *
28  * Implementation of RFC 3261 - without S/MIME, and experimental TCP and TLS support
29  * Configuration file \link Config_sip sip.conf \endlink
30  *
31  * ********** IMPORTANT *
32  * \note TCP/TLS support is EXPERIMENTAL and WILL CHANGE. This applies to configuration
33  *      settings, dialplan commands and dialplans apps/functions
34  * See \ref sip_tcp_tls
35  *
36  *
37  * ******** General TODO:s
38  * \todo Better support of forking
39  * \todo VIA branch tag transaction checking
40  * \todo Transaction support
41  *
42  * ******** Wishlist: Improvements
43  * - Support of SIP domains for devices, so that we match on username@domain in the From: header
44  * - Connect registrations with a specific device on the incoming call. It's not done
45  *   automatically in Asterisk
46  *
47  * \ingroup channel_drivers
48  *
49  * \par Overview of the handling of SIP sessions
50  * The SIP channel handles several types of SIP sessions, or dialogs,
51  * not all of them being "telephone calls".
52  * - Incoming calls that will be sent to the PBX core
53  * - Outgoing calls, generated by the PBX
54  * - SIP subscriptions and notifications of states and voicemail messages
55  * - SIP registrations, both inbound and outbound
56  * - SIP peer management (peerpoke, OPTIONS)
57  * - SIP text messages
58  *
59  * In the SIP channel, there's a list of active SIP dialogs, which includes
60  * all of these when they are active. "sip show channels" in the CLI will
61  * show most of these, excluding subscriptions which are shown by
62  * "sip show subscriptions"
63  *
64  * \par incoming packets
65  * Incoming packets are received in the monitoring thread, then handled by
66  * sipsock_read() for udp only. In tcp, packets are read by the tcp_helper thread.
67  * sipsock_read() function parses the packet and matches an existing
68  * dialog or starts a new SIP dialog.
69  *
70  * sipsock_read sends the packet to handle_incoming(), that parses a bit more.
71  * If it is a response to an outbound request, the packet is sent to handle_response().
72  * If it is a request, handle_incoming() sends it to one of a list of functions
73  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
74  * sipsock_read locks the ast_channel if it exists (an active call) and
75  * unlocks it after we have processed the SIP message.
76  *
77  * A new INVITE is sent to handle_request_invite(), that will end up
78  * starting a new channel in the PBX, the new channel after that executing
79  * in a separate channel thread. This is an incoming "call".
80  * When the call is answered, either by a bridged channel or the PBX itself
81  * the sip_answer() function is called.
82  *
83  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
84  * in rtp.c
85  *
86  * \par Outbound calls
87  * Outbound calls are set up by the PBX through the sip_request_call()
88  * function. After that, they are activated by sip_call().
89  *
90  * \par Hanging up
91  * The PBX issues a hangup on both incoming and outgoing calls through
92  * the sip_hangup() function
93  */
94
95 /*!
96  * \page sip_tcp_tls SIP TCP and TLS support
97  *
98  * \par tcpfixes TCP implementation changes needed
99  * \todo Fix TCP/TLS handling in dialplan, SRV records, transfers and much more
100  * \todo Save TCP/TLS sessions in registry
101  *      If someone registers a SIPS uri, this forces us to set up a TLS connection back.
102  * \todo Add TCP/TLS information to function SIPPEER and SIPCHANINFO
103  * \todo If tcpenable=yes, we must open a TCP socket on the same address as the IP for UDP.
104  *      The tcpbindaddr config option should only be used to open ADDITIONAL ports
105  *      So we should propably go back to
106  *              bindaddr= the default address to bind to. If tcpenable=yes, then bind this to both udp and TCP
107  *                              if tlsenable=yes, open TLS port (provided we also have cert)
108  *              tcpbindaddr = extra address for additional TCP connections
109  *              tlsbindaddr = extra address for additional TCP/TLS connections
110  *              udpbindaddr = extra address for additional UDP connections
111  *                      These three options should take multiple IP/port pairs
112  *      Note: Since opening additional listen sockets is a *new* feature we do not have today
113  *              the XXXbindaddr options needs to be disabled until we have support for it
114  *
115  * \todo re-evaluate the transport= setting in sip.conf. This is right now not well
116  *      thought of. If a device in sip.conf contacts us via TCP, we should not switch transport,
117  *      even if udp is the configured first transport.
118  *
119  * \todo Be prepared for one outbound and another incoming socket per pvt. This applies
120  *       specially to communication with other peers (proxies).
121  * \todo We need to test TCP sessions with SIP proxies and in regards
122  *       to the SIP outbound specs.
123  * \todo ;transport=tls was deprecated in RFC3261 and should not be used at all. See section 26.2.2.
124  *
125  * \todo If the message is smaller than the given Content-length, the request should get a 400 Bad request
126  *       message. If it's a response, it should be dropped. (RFC 3261, Section 18.3)
127  * \todo Since we have had multidomain support in Asterisk for quite a while, we need to support
128  *       multiple domains in our TLS implementation, meaning one socket and one cert per domain
129  * \todo Selection of transport for a request needs to be done after we've parsed all route headers,
130  *       also considering outbound proxy options.
131  *              First request: Outboundproxy, routes, (reg contact or URI. If URI doesn't have port:  DNS naptr, srv, AAA)
132  *              Intermediate requests: Outboundproxy(only when forced), routes, contact/uri
133  *      DNS naptr support is crucial. A SIP uri might lead to a TLS connection.
134  *      Also note that due to outbound proxy settings, a SIPS uri might have to be sent on UDP (not to recommend though)
135  * \todo Default transports are set to UDP, which cause the wrong behaviour when contacting remote
136  *      devices directly from the dialplan. UDP is only a fallback if no other method works,
137  *      in order to be compatible with RFC2543 (SIP/1.0) devices. For transactions that exceed the
138  *      MTU (like INIVTE with video, audio and RTT)  TCP should be preferred.
139  *
140  *      When dialling unconfigured peers (with no port number)  or devices in external domains
141  *      NAPTR records MUST be consulted to find configured transport. If they are not found,
142  *      SRV records for both TCP and UDP should be checked. If there's a record for TCP, use that.
143  *      If there's no record for TCP, then use UDP as a last resort. If there's no SRV records,
144  *      \note this only applies if there's no outbound proxy configured for the session. If an outbound
145  *      proxy is configured, these procedures might apply for locating the proxy and determining
146  *      the transport to use for communication with the proxy.
147  * \par Other bugs to fix ----
148  * __set_address_from_contact(const char *fullcontact, struct sockaddr_in *sin, int tcp)
149  *      - sets TLS port as default for all TCP connections, unless other port is given in contact.
150  * parse_register_contact(struct sip_pvt *pvt, struct sip_peer *peer, struct sip_request *req)
151  *      - assumes that the contact the UA registers is using the same transport as the REGISTER request, which is
152  *        a bad guess.
153  *      - Does not save any information about TCP/TLS connected devices, which is a severe BUG, as discussed on the mailing list.
154  * get_destination(struct sip_pvt *p, struct sip_request *oreq)
155  *      - Doesn't store the information that we got an incoming SIPS request in the channel, so that
156  *        we can require a secure signalling path OUT of Asterisk (on SIP or IAX2). Possibly, the call should
157  *        fail on in-secure signalling paths if there's no override in our configuration. At least, provide a
158  *        channel variable in the dialplan.
159  * get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req)
160  *      - As above, if we have a SIPS: uri in the refer-to header
161  *      - Does not check transport in refer_to uri.
162  */
163
164 /*** MODULEINFO
165         <use type="module">res_crypto</use>
166         <depend>chan_local</depend>
167  ***/
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 container for realm authentication */
1125 static struct sip_auth_container *authl = NULL;
1126 /*! \brief Global authentication container protection while adjusting the references. */
1127 AST_MUTEX_DEFINE_STATIC(authl_lock);
1128
1129 /* --- Sockets and networking --------------*/
1130
1131 /*! \brief Main socket for UDP SIP communication.
1132  *
1133  * sipsock is shared between the SIP manager thread (which handles reload
1134  * requests), the udp io handler (sipsock_read()) and the user routines that
1135  * issue udp writes (using __sip_xmit()).
1136  * The socket is -1 only when opening fails (this is a permanent condition),
1137  * or when we are handling a reload() that changes its address (this is
1138  * a transient situation during which we might have a harmless race, see
1139  * below). Because the conditions for the race to be possible are extremely
1140  * rare, we don't want to pay the cost of locking on every I/O.
1141  * Rather, we remember that when the race may occur, communication is
1142  * bound to fail anyways, so we just live with this event and let
1143  * the protocol handle this above us.
1144  */
1145 static int sipsock  = -1;
1146
1147 struct ast_sockaddr bindaddr;   /*!< UDP: The address we bind to */
1148
1149 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1150  *  internip is initialized picking a suitable address from one of the
1151  * interfaces, and the same port number we bind to. It is used as the
1152  * default address/port in SIP messages, and as the default address
1153  * (but not port) in SDP messages.
1154  */
1155 static struct ast_sockaddr internip;
1156
1157 /*! \brief our external IP address/port for SIP sessions.
1158  * externaddr.sin_addr is only set when we know we might be behind
1159  * a NAT, and this is done using a variety of (mutually exclusive)
1160  * ways from the config file:
1161  *
1162  * + with "externaddr = host[:port]" we specify the address/port explicitly.
1163  *   The address is looked up only once when (re)loading the config file;
1164  *
1165  * + with "externhost = host[:port]" we do a similar thing, but the
1166  *   hostname is stored in externhost, and the hostname->IP mapping
1167  *   is refreshed every 'externrefresh' seconds;
1168  *
1169  * Other variables (externhost, externexpire, externrefresh) are used
1170  * to support the above functions.
1171  */
1172 static struct ast_sockaddr externaddr;      /*!< External IP address if we are behind NAT */
1173 static struct ast_sockaddr media_address; /*!< External RTP IP address if we are behind NAT */
1174
1175 static char externhost[MAXHOSTNAMELEN];   /*!< External host name */
1176 static time_t externexpire;             /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1177 static int externrefresh = 10;          /*!< Refresh timer for DNS-based external address (dyndns) */
1178 static uint16_t externtcpport;          /*!< external tcp port */ 
1179 static uint16_t externtlsport;          /*!< external tls port */
1180
1181 /*! \brief  List of local networks
1182  * We store "localnet" addresses from the config file into an access list,
1183  * marked as 'DENY', so the call to ast_apply_ha() will return
1184  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1185  * (i.e. presumably public) addresses.
1186  */
1187 static struct ast_ha *localaddr;    /*!< List of local networks, on the same side of NAT as this Asterisk */
1188
1189 static int ourport_tcp;             /*!< The port used for TCP connections */
1190 static int ourport_tls;             /*!< The port used for TCP/TLS connections */
1191 static struct ast_sockaddr debugaddr;
1192
1193 static struct ast_config *notify_types = NULL;    /*!< The list of manual NOTIFY types we know how to send */
1194
1195 /*! some list management macros. */
1196
1197 #define UNLINK(element, head, prev) do {        \
1198         if (prev)                               \
1199                 (prev)->next = (element)->next; \
1200         else                                    \
1201                 (head) = (element)->next;       \
1202         } while (0)
1203
1204 /*---------------------------- Forward declarations of functions in chan_sip.c */
1205 /* Note: This is added to help splitting up chan_sip.c into several files
1206         in coming releases. */
1207
1208 /*--- PBX interface functions */
1209 static struct ast_channel *sip_request_call(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, void *data, int *cause);
1210 static int sip_devicestate(void *data);
1211 static int sip_sendtext(struct ast_channel *ast, const char *text);
1212 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1213 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1214 static int sip_hangup(struct ast_channel *ast);
1215 static int sip_answer(struct ast_channel *ast);
1216 static struct ast_frame *sip_read(struct ast_channel *ast);
1217 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1218 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1219 static int sip_transfer(struct ast_channel *ast, const char *dest);
1220 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1221 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1222 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1223 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
1224 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
1225 static const char *sip_get_callid(struct ast_channel *chan);
1226
1227 static int handle_request_do(struct sip_request *req, struct ast_sockaddr *addr);
1228 static int sip_standard_port(enum sip_transport type, int port);
1229 static int sip_prepare_socket(struct sip_pvt *p);
1230 static int get_address_family_filter(const struct ast_sockaddr *addr);
1231
1232 /*--- Transmitting responses and requests */
1233 static int sipsock_read(int *id, int fd, short events, void *ignore);
1234 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data);
1235 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int fatal, int sipmethod);
1236 static void add_cc_call_info_to_response(struct sip_pvt *p, struct sip_request *resp);
1237 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1238 static int retrans_pkt(const void *data);
1239 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);
1240 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1241 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1242 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1243 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);
1244 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1245 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);
1246 static int transmit_provisional_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, int with_sdp);
1247 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1248 static void transmit_fake_auth_response(struct sip_pvt *p, int sipmethod, struct sip_request *req, enum xmittype reliable);
1249 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1250 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1251 static int transmit_publish(struct sip_epa_entry *epa_entry, enum sip_publish_type publish_type, const char * const explicit_uri);
1252 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init, const char * const explicit_uri);
1253 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
1254 static int transmit_info_with_aoc(struct sip_pvt *p, struct ast_aoc_decoded *decoded);
1255 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1256 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1257 static int transmit_message_with_text(struct sip_pvt *p, const char *text, int init, int auth);
1258 static int transmit_message_with_msg(struct sip_pvt *p, const struct ast_msg *msg);
1259 static int transmit_refer(struct sip_pvt *p, const char *dest);
1260 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
1261 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1262 static int transmit_cc_notify(struct ast_cc_agent *agent, struct sip_pvt *subscription, enum sip_cc_notify_state state);
1263 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1264 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1265 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1266 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1267 static void receive_message(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1268 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
1269 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1270
1271 /* Misc dialog routines */
1272 static int __sip_autodestruct(const void *data);
1273 static void *registry_unref(struct sip_registry *reg, char *tag);
1274 static int update_call_counter(struct sip_pvt *fup, int event);
1275 static int auto_congest(const void *arg);
1276 static struct sip_pvt *find_call(struct sip_request *req, struct ast_sockaddr *addr, const int intended_method);
1277 static void free_old_route(struct sip_route *route);
1278 static void list_route(struct sip_route *route);
1279 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1280 static enum check_auth_result register_verify(struct sip_pvt *p, struct ast_sockaddr *addr,
1281                                               struct sip_request *req, const char *uri);
1282 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1283 static void check_pendings(struct sip_pvt *p);
1284 static void *sip_park_thread(void *stuff);
1285 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno, char *parkexten);
1286
1287 static void *sip_pickup_thread(void *stuff);
1288 static int sip_pickup(struct ast_channel *chan);
1289
1290 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1291 static int is_method_allowed(unsigned int *allowed_methods, enum sipmethod method);
1292
1293 /*--- Codec handling / SDP */
1294 static void try_suggested_sip_codec(struct sip_pvt *p);
1295 static const char *get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1296 static char get_sdp_line(int *start, int stop, struct sip_request *req, const char **value);
1297 static int find_sdp(struct sip_request *req);
1298 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
1299 static int process_sdp_o(const char *o, struct sip_pvt *p);
1300 static int process_sdp_c(const char *c, struct ast_sockaddr *addr);
1301 static int process_sdp_a_sendonly(const char *a, int *sendonly);
1302 static int process_sdp_a_audio(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newaudiortp, int *last_rtpmap_codec);
1303 static int process_sdp_a_video(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newvideortp, int *last_rtpmap_codec);
1304 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);
1305 static int process_sdp_a_image(const char *a, struct sip_pvt *p);
1306 static void add_codec_to_sdp(const struct sip_pvt *p, struct ast_format *codec,
1307                              struct ast_str **m_buf, struct ast_str **a_buf,
1308                              int debug, int *min_packet_size);
1309 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
1310                                 struct ast_str **m_buf, struct ast_str **a_buf,
1311                                 int debug);
1312 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
1313 static void do_setnat(struct sip_pvt *p);
1314 static void stop_media_flows(struct sip_pvt *p);
1315
1316 /*--- Authentication stuff */
1317 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1318 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1319 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1320                                          const char *secret, const char *md5secret, int sipmethod,
1321                                          const char *uri, enum xmittype reliable, int ignore);
1322 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1323                                               int sipmethod, const char *uri, enum xmittype reliable,
1324                                               struct ast_sockaddr *addr, struct sip_peer **authpeer);
1325 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct ast_sockaddr *addr);
1326
1327 /*--- Domain handling */
1328 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1329 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1330 static void clear_sip_domains(void);
1331
1332 /*--- SIP realm authentication */
1333 static void add_realm_authentication(struct sip_auth_container **credentials, const char *configuration, int lineno);
1334 static struct sip_auth *find_realm_authentication(struct sip_auth_container *credentials, const char *realm);
1335
1336 /*--- Misc functions */
1337 static void check_rtp_timeout(struct sip_pvt *dialog, time_t t);
1338 static int reload_config(enum channelreloadreason reason);
1339 static int expire_register(const void *data);
1340 static void *do_monitor(void *data);
1341 static int restart_monitor(void);
1342 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
1343 static struct ast_variable *copy_vars(struct ast_variable *src);
1344 static int dialog_find_multiple(void *obj, void *arg, int flags);
1345 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
1346 static int sip_refer_allocate(struct sip_pvt *p);
1347 static int sip_notify_allocate(struct sip_pvt *p);
1348 static void ast_quiet_chan(struct ast_channel *chan);
1349 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1350 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
1351
1352 /*--- Device monitoring and Device/extension state/event handling */
1353 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1354 static int sip_devicestate(void *data);
1355 static int sip_poke_noanswer(const void *data);
1356 static int sip_poke_peer(struct sip_peer *peer, int force);
1357 static void sip_poke_all_peers(void);
1358 static void sip_peer_hold(struct sip_pvt *p, int hold);
1359 static void mwi_event_cb(const struct ast_event *, void *);
1360 static void network_change_event_cb(const struct ast_event *, void *);
1361
1362 /*--- Applications, functions, CLI and manager command helpers */
1363 static const char *sip_nat_mode(const struct sip_pvt *p);
1364 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1365 static char *transfermode2str(enum transfermodes mode) attribute_const;
1366 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1367 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1368 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1369 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1370 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1371 static void  print_group(int fd, ast_group_t group, int crlf);
1372 static const char *dtmfmode2str(int mode) attribute_const;
1373 static int str2dtmfmode(const char *str) attribute_unused;
1374 static const char *insecure2str(int mode) attribute_const;
1375 static void cleanup_stale_contexts(char *new, char *old);
1376 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1377 static const char *domain_mode_to_text(const enum domain_mode mode);
1378 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1379 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1380 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1381 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1382 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1383 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1384 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1385 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1386 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1387 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1388 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1389 static char *complete_sip_peer(const char *word, int state, int flags2);
1390 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1391 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1392 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1393 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1394 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1395 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1396 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1397 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1398 static char *sip_do_debug_ip(int fd, const char *arg);
1399 static char *sip_do_debug_peer(int fd, const char *arg);
1400 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1401 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1402 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1403 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
1404 static int sip_addheader(struct ast_channel *chan, const char *data);
1405 static int sip_do_reload(enum channelreloadreason reason);
1406 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1407 static int ast_sockaddr_resolve_first_af(struct ast_sockaddr *addr,
1408                                       const char *name, int flag, int family);
1409 static int ast_sockaddr_resolve_first(struct ast_sockaddr *addr,
1410                                       const char *name, int flag);
1411
1412 /*--- Debugging
1413         Functions for enabling debug per IP or fully, or enabling history logging for
1414         a SIP dialog
1415 */
1416 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1417 static inline int sip_debug_test_addr(const struct ast_sockaddr *addr);
1418 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1419 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1420 static void sip_dump_history(struct sip_pvt *dialog);
1421
1422 /*--- Device object handling */
1423 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime, int devstate_only);
1424 static int update_call_counter(struct sip_pvt *fup, int event);
1425 static void sip_destroy_peer(struct sip_peer *peer);
1426 static void sip_destroy_peer_fn(void *peer);
1427 static void set_peer_defaults(struct sip_peer *peer);
1428 static struct sip_peer *temp_peer(const char *name);
1429 static void register_peer_exten(struct sip_peer *peer, int onoff);
1430 static struct sip_peer *find_peer(const char *peer, struct ast_sockaddr *addr, int realtime, int forcenamematch, int devstate_only, int transport);
1431 static int sip_poke_peer_s(const void *data);
1432 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1433 static void reg_source_db(struct sip_peer *peer);
1434 static void destroy_association(struct sip_peer *peer);
1435 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1436 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1437 static void set_socket_transport(struct sip_socket *socket, int transport);
1438
1439 /* Realtime device support */
1440 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);
1441 static void update_peer(struct sip_peer *p, int expire);
1442 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1443 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
1444 static struct sip_peer *realtime_peer(const char *peername, struct ast_sockaddr *sin, int devstate_only, int which_objects);
1445 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1446
1447 /*--- Internal UA client handling (outbound registrations) */
1448 static void ast_sip_ouraddrfor(const struct ast_sockaddr *them, struct ast_sockaddr *us, struct sip_pvt *p);
1449 static void sip_registry_destroy(struct sip_registry *reg);
1450 static int sip_register(const char *value, int lineno);
1451 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1452 static int sip_reregister(const void *data);
1453 static int __sip_do_register(struct sip_registry *r);
1454 static int sip_reg_timeout(const void *data);
1455 static void sip_send_all_registers(void);
1456 static int sip_reinvite_retry(const void *data);
1457
1458 /*--- Parsing SIP requests and responses */
1459 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1460 static int determine_firstline_parts(struct sip_request *req);
1461 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1462 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1463 static int find_sip_method(const char *msg);
1464 static unsigned int parse_allowed_methods(struct sip_request *req);
1465 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
1466 static int parse_request(struct sip_request *req);
1467 static const char *get_header(const struct sip_request *req, const char *name);
1468 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1469 static int method_match(enum sipmethod id, const char *name);
1470 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1471 static const char *find_alias(const char *name, const char *_default);
1472 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1473 static void lws2sws(struct ast_str *msgbuf);
1474 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1475 static char *remove_uri_parameters(char *uri);
1476 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1477 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1478 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1479 static int set_address_from_contact(struct sip_pvt *pvt);
1480 static void check_via(struct sip_pvt *p, struct sip_request *req);
1481 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
1482 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason);
1483 static enum sip_get_dest_result get_destination(struct sip_pvt *p, struct sip_request *oreq, int *cc_recall_core_id);
1484 static int get_msg_text(char *buf, int len, struct sip_request *req, int addnewline);
1485 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1486 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
1487 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
1488 static int get_domain(const char *str, char *domain, int len);
1489 static void get_realm(struct sip_pvt *p, const struct sip_request *req);
1490
1491 /*-- TCP connection handling ---*/
1492 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session);
1493 static void *sip_tcp_worker_fn(void *);
1494
1495 /*--- Constructing requests and responses */
1496 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1497 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1498 static void deinit_req(struct sip_request *req);
1499 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1500 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, const char * const explicit_uri);
1501 static int init_resp(struct sip_request *resp, const char *msg);
1502 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
1503 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1504 static const struct ast_sockaddr *sip_real_dst(const struct sip_pvt *p);
1505 static void build_via(struct sip_pvt *p);
1506 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1507 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct ast_sockaddr *addr, int newdialog, struct ast_sockaddr *remote_address);
1508 static char *generate_random_string(char *buf, size_t size);
1509 static void build_callid_pvt(struct sip_pvt *pvt);
1510 static void build_callid_registry(struct sip_registry *reg, const struct ast_sockaddr *ourip, const char *fromdomain);
1511 static void make_our_tag(char *tagbuf, size_t len);
1512 static int add_header(struct sip_request *req, const char *var, const char *value);
1513 static int add_header_max_forwards(struct sip_pvt *dialog, struct sip_request *req);
1514 static int add_content(struct sip_request *req, const char *line);
1515 static int finalize_content(struct sip_request *req);
1516 static int add_text(struct sip_request *req, const char *text);
1517 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1518 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
1519 static int add_vidupdate(struct sip_request *req);
1520 static void add_route(struct sip_request *req, struct sip_route *route);
1521 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1522 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1523 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1524 static void set_destination(struct sip_pvt *p, char *uri);
1525 static void append_date(struct sip_request *req);
1526 static void build_contact(struct sip_pvt *p);
1527
1528 /*------Request handling functions */
1529 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, int *recount, int *nounlock);
1530 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
1531 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);
1532 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1533 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1534 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *sin, const char *e);
1535 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1536 static int handle_request_message(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1537 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, int seqno, const char *e);
1538 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1539 static int handle_request_options(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1540 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct ast_sockaddr *addr, int *nounlock);
1541 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, int seqno, const char *e);
1542 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno, int *nounlock);
1543
1544 /*------Response handling functions */
1545 static void handle_response_publish(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1546 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1547 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1548 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1549 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1550 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1551 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1552
1553 /*------ SRTP Support -------- */
1554 static int setup_srtp(struct sip_srtp **srtp);
1555 static int process_crypto(struct sip_pvt *p, struct ast_rtp_instance *rtp, struct sip_srtp **srtp, const char *a);
1556
1557 /*------ T38 Support --------- */
1558 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1559 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1560 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1561 static void change_t38_state(struct sip_pvt *p, int state);
1562
1563 /*------ Session-Timers functions --------- */
1564 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
1565 static int  proc_session_timer(const void *vp);
1566 static void stop_session_timer(struct sip_pvt *p);
1567 static void start_session_timer(struct sip_pvt *p);
1568 static void restart_session_timer(struct sip_pvt *p);
1569 static const char *strefresher2str(enum st_refresher r);
1570 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
1571 static int parse_minse(const char *p_hdrval, int *const p_interval);
1572 static int st_get_se(struct sip_pvt *, int max);
1573 static enum st_refresher st_get_refresher(struct sip_pvt *);
1574 static enum st_mode st_get_mode(struct sip_pvt *, int no_cached);
1575 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
1576
1577 /*------- RTP Glue functions -------- */
1578 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);
1579
1580 /*!--- SIP MWI Subscription support */
1581 static int sip_subscribe_mwi(const char *value, int lineno);
1582 static void sip_subscribe_mwi_destroy(struct sip_subscription_mwi *mwi);
1583 static void sip_send_all_mwi_subscriptions(void);
1584 static int sip_subscribe_mwi_do(const void *data);
1585 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
1586
1587 /*! \brief Definition of this channel for PBX channel registration */
1588 struct ast_channel_tech sip_tech = {
1589         .type = "SIP",
1590         .description = "Session Initiation Protocol (SIP)",
1591         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1592         .requester = sip_request_call,                  /* called with chan unlocked */
1593         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1594         .call = sip_call,                       /* called with chan locked */
1595         .send_html = sip_sendhtml,
1596         .hangup = sip_hangup,                   /* called with chan locked */
1597         .answer = sip_answer,                   /* called with chan locked */
1598         .read = sip_read,                       /* called with chan locked */
1599         .write = sip_write,                     /* called with chan locked */
1600         .write_video = sip_write,               /* called with chan locked */
1601         .write_text = sip_write,
1602         .indicate = sip_indicate,               /* called with chan locked */
1603         .transfer = sip_transfer,               /* called with chan locked */
1604         .fixup = sip_fixup,                     /* called with chan locked */
1605         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1606         .send_digit_end = sip_senddigit_end,
1607         .bridge = ast_rtp_instance_bridge,                      /* XXX chan unlocked ? */
1608         .early_bridge = ast_rtp_instance_early_bridge,
1609         .send_text = sip_sendtext,              /* called with chan locked */
1610         .func_channel_read = sip_acf_channel_read,
1611         .setoption = sip_setoption,
1612         .queryoption = sip_queryoption,
1613         .get_pvt_uniqueid = sip_get_callid,
1614 };
1615
1616 /*! \brief This version of the sip channel tech has no send_digit_begin
1617  * callback so that the core knows that the channel does not want
1618  * DTMF BEGIN frames.
1619  * The struct is initialized just before registering the channel driver,
1620  * and is for use with channels using SIP INFO DTMF.
1621  */
1622 struct ast_channel_tech sip_tech_info;
1623
1624 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan);
1625 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
1626 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
1627 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
1628 static int sip_cc_agent_status_request(struct ast_cc_agent *agent);
1629 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent);
1630 static int sip_cc_agent_recall(struct ast_cc_agent *agent);
1631 static void sip_cc_agent_destructor(struct ast_cc_agent *agent);
1632
1633 static struct ast_cc_agent_callbacks sip_cc_agent_callbacks = {
1634         .type = "SIP",
1635         .init = sip_cc_agent_init,
1636         .start_offer_timer = sip_cc_agent_start_offer_timer,
1637         .stop_offer_timer = sip_cc_agent_stop_offer_timer,
1638         .respond = sip_cc_agent_respond,
1639         .status_request = sip_cc_agent_status_request,
1640         .start_monitoring = sip_cc_agent_start_monitoring,
1641         .callee_available = sip_cc_agent_recall,
1642         .destructor = sip_cc_agent_destructor,
1643 };
1644
1645 static int find_by_notify_uri_helper(void *obj, void *arg, int flags)
1646 {
1647         struct ast_cc_agent *agent = obj;
1648         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1649         const char *uri = arg;
1650
1651         return !sip_uri_cmp(agent_pvt->notify_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1652 }
1653
1654 static struct ast_cc_agent *find_sip_cc_agent_by_notify_uri(const char * const uri)
1655 {
1656         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_notify_uri_helper, (char *)uri, "SIP");
1657         return agent;
1658 }
1659
1660 static int find_by_subscribe_uri_helper(void *obj, void *arg, int flags)
1661 {
1662         struct ast_cc_agent *agent = obj;
1663         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1664         const char *uri = arg;
1665
1666         return !sip_uri_cmp(agent_pvt->subscribe_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1667 }
1668
1669 static struct ast_cc_agent *find_sip_cc_agent_by_subscribe_uri(const char * const uri)
1670 {
1671         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_subscribe_uri_helper, (char *)uri, "SIP");
1672         return agent;
1673 }
1674
1675 static int find_by_callid_helper(void *obj, void *arg, int flags)
1676 {
1677         struct ast_cc_agent *agent = obj;
1678         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1679         struct sip_pvt *call_pvt = arg;
1680
1681         return !strcmp(agent_pvt->original_callid, call_pvt->callid) ? CMP_MATCH | CMP_STOP : 0;
1682 }
1683
1684 static struct ast_cc_agent *find_sip_cc_agent_by_original_callid(struct sip_pvt *pvt)
1685 {
1686         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_callid_helper, pvt, "SIP");
1687         return agent;
1688 }
1689
1690 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan)
1691 {
1692         struct sip_cc_agent_pvt *agent_pvt = ast_calloc(1, sizeof(*agent_pvt));
1693         struct sip_pvt *call_pvt = chan->tech_pvt;
1694
1695         if (!agent_pvt) {
1696                 return -1;
1697         }
1698
1699         ast_assert(!strcmp(chan->tech->type, "SIP"));
1700
1701         ast_copy_string(agent_pvt->original_callid, call_pvt->callid, sizeof(agent_pvt->original_callid));
1702         ast_copy_string(agent_pvt->original_exten, call_pvt->exten, sizeof(agent_pvt->original_exten));
1703         agent_pvt->offer_timer_id = -1;
1704         agent->private_data = agent_pvt;
1705         sip_pvt_lock(call_pvt);
1706         ast_set_flag(&call_pvt->flags[0], SIP_OFFER_CC);
1707         sip_pvt_unlock(call_pvt);
1708         return 0;
1709 }
1710
1711 static int sip_offer_timer_expire(const void *data)
1712 {
1713         struct ast_cc_agent *agent = (struct ast_cc_agent *) data;
1714         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1715
1716         agent_pvt->offer_timer_id = -1;
1717
1718         return ast_cc_failed(agent->core_id, "SIP agent %s's offer timer expired", agent->device_name);
1719 }
1720
1721 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent)
1722 {
1723         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1724         int when;
1725
1726         when = ast_get_cc_offer_timer(agent->cc_params) * 1000;
1727         agent_pvt->offer_timer_id = ast_sched_add(sched, when, sip_offer_timer_expire, agent);
1728         return 0;
1729 }
1730
1731 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent)
1732 {
1733         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1734
1735         AST_SCHED_DEL(sched, agent_pvt->offer_timer_id);
1736         return 0;
1737 }
1738
1739 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
1740 {
1741         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1742
1743         sip_pvt_lock(agent_pvt->subscribe_pvt);
1744         ast_set_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED);
1745         if (reason == AST_CC_AGENT_RESPONSE_SUCCESS || !ast_strlen_zero(agent_pvt->notify_uri)) {
1746                 /* The second half of this if statement may be a bit hard to grasp,
1747                  * so here's an explanation. When a subscription comes into
1748                  * chan_sip, as long as it is not malformed, it will be passed
1749                  * to the CC core. If the core senses an out-of-order state transition,
1750                  * then the core will call this callback with the "reason" set to a
1751                  * failure condition.
1752                  * However, an out-of-order state transition will occur during a resubscription
1753                  * for CC. In such a case, we can see that we have already generated a notify_uri
1754                  * and so we can detect that this isn't a *real* failure. Rather, it is just
1755                  * something the core doesn't recognize as a legitimate SIP state transition.
1756                  * Thus we respond with happiness and flowers.
1757                  */
1758                 transmit_response(agent_pvt->subscribe_pvt, "200 OK", &agent_pvt->subscribe_pvt->initreq);
1759                 transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_QUEUED);
1760         } else {
1761                 transmit_response(agent_pvt->subscribe_pvt, "500 Internal Error", &agent_pvt->subscribe_pvt->initreq);
1762         }
1763         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1764         agent_pvt->is_available = TRUE;
1765 }
1766
1767 static int sip_cc_agent_status_request(struct ast_cc_agent *agent)
1768 {
1769         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1770         enum ast_device_state state = agent_pvt->is_available ? AST_DEVICE_NOT_INUSE : AST_DEVICE_INUSE;
1771         return ast_cc_agent_status_response(agent->core_id, state);
1772 }
1773
1774 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent)
1775 {
1776         /* To start monitoring just means to wait for an incoming PUBLISH
1777          * to tell us that the caller has become available again. No special
1778          * action is needed
1779          */
1780         return 0;
1781 }
1782
1783 static int sip_cc_agent_recall(struct ast_cc_agent *agent)
1784 {
1785         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1786         /* If we have received a PUBLISH beforehand stating that the caller in question
1787          * is not available, we can save ourself a bit of effort here and just report
1788          * the caller as busy
1789          */
1790         if (!agent_pvt->is_available) {
1791                 return ast_cc_agent_caller_busy(agent->core_id, "Caller %s is busy, reporting to the core",
1792                                 agent->device_name);
1793         }
1794         /* Otherwise, we transmit a NOTIFY to the caller and await either
1795          * a PUBLISH or an INVITE
1796          */
1797         sip_pvt_lock(agent_pvt->subscribe_pvt);
1798         transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_READY);
1799         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1800         return 0;
1801 }
1802
1803 static void sip_cc_agent_destructor(struct ast_cc_agent *agent)
1804 {
1805         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1806
1807         if (!agent_pvt) {
1808                 /* The agent constructor probably failed. */
1809                 return;
1810         }
1811
1812         sip_cc_agent_stop_offer_timer(agent);
1813         if (agent_pvt->subscribe_pvt) {
1814                 sip_pvt_lock(agent_pvt->subscribe_pvt);
1815                 if (!ast_test_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED)) {
1816                         /* If we haven't sent a 200 OK for the SUBSCRIBE dialog yet, then we need to send a response letting
1817                          * the subscriber know something went wrong
1818                          */
1819                         transmit_response(agent_pvt->subscribe_pvt, "500 Internal Server Error", &agent_pvt->subscribe_pvt->initreq);
1820                 }
1821                 sip_pvt_unlock(agent_pvt->subscribe_pvt);
1822                 agent_pvt->subscribe_pvt = dialog_unref(agent_pvt->subscribe_pvt, "SIP CC agent destructor: Remove ref to subscription");
1823         }
1824         ast_free(agent_pvt);
1825 }
1826
1827 struct ao2_container *sip_monitor_instances;
1828
1829 static int sip_monitor_instance_hash_fn(const void *obj, const int flags)
1830 {
1831         const struct sip_monitor_instance *monitor_instance = obj;
1832         return monitor_instance->core_id;
1833 }
1834
1835 static int sip_monitor_instance_cmp_fn(void *obj, void *arg, int flags)
1836 {
1837         struct sip_monitor_instance *monitor_instance1 = obj;
1838         struct sip_monitor_instance *monitor_instance2 = arg;
1839
1840         return monitor_instance1->core_id == monitor_instance2->core_id ? CMP_MATCH | CMP_STOP : 0;
1841 }
1842
1843 static void sip_monitor_instance_destructor(void *data)
1844 {
1845         struct sip_monitor_instance *monitor_instance = data;
1846         if (monitor_instance->subscription_pvt) {
1847                 sip_pvt_lock(monitor_instance->subscription_pvt);
1848                 monitor_instance->subscription_pvt->expiry = 0;
1849                 transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 0, monitor_instance->subscribe_uri);
1850                 sip_pvt_unlock(monitor_instance->subscription_pvt);
1851                 dialog_unref(monitor_instance->subscription_pvt, "Unref monitor instance ref of subscription pvt");
1852         }
1853         if (monitor_instance->suspension_entry) {
1854                 monitor_instance->suspension_entry->body[0] = '\0';
1855                 transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_REMOVE ,monitor_instance->notify_uri);
1856                 ao2_t_ref(monitor_instance->suspension_entry, -1, "Decrementing suspension entry refcount in sip_monitor_instance_destructor");
1857         }
1858         ast_string_field_free_memory(monitor_instance);
1859 }
1860
1861 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)
1862 {
1863         struct sip_monitor_instance *monitor_instance = ao2_alloc(sizeof(*monitor_instance), sip_monitor_instance_destructor);
1864
1865         if (!monitor_instance) {
1866                 return NULL;
1867         }
1868
1869         if (ast_string_field_init(monitor_instance, 256)) {
1870                 ao2_ref(monitor_instance, -1);
1871                 return NULL;
1872         }
1873
1874         ast_string_field_set(monitor_instance, subscribe_uri, subscribe_uri);
1875         ast_string_field_set(monitor_instance, peername, peername);
1876         ast_string_field_set(monitor_instance, device_name, device_name);
1877         monitor_instance->core_id = core_id;
1878         ao2_link(sip_monitor_instances, monitor_instance);
1879         return monitor_instance;
1880 }
1881
1882 static int find_sip_monitor_instance_by_subscription_pvt(void *obj, void *arg, int flags)
1883 {
1884         struct sip_monitor_instance *monitor_instance = obj;
1885         return monitor_instance->subscription_pvt == arg ? CMP_MATCH | CMP_STOP : 0;
1886 }
1887
1888 static int find_sip_monitor_instance_by_suspension_entry(void *obj, void *arg, int flags)
1889 {
1890         struct sip_monitor_instance *monitor_instance = obj;
1891         return monitor_instance->suspension_entry == arg ? CMP_MATCH | CMP_STOP : 0;
1892 }
1893
1894 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
1895 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor);
1896 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
1897 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
1898 static void sip_cc_monitor_destructor(void *private_data);
1899
1900 static struct ast_cc_monitor_callbacks sip_cc_monitor_callbacks = {
1901         .type = "SIP",
1902         .request_cc = sip_cc_monitor_request_cc,
1903         .suspend = sip_cc_monitor_suspend,
1904         .unsuspend = sip_cc_monitor_unsuspend,
1905         .cancel_available_timer = sip_cc_monitor_cancel_available_timer,
1906         .destructor = sip_cc_monitor_destructor,
1907 };
1908
1909 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id)
1910 {
1911         struct sip_monitor_instance *monitor_instance = monitor->private_data;
1912         enum ast_cc_service_type service = monitor->service_offered;
1913         int when;
1914
1915         if (!monitor_instance) {
1916                 return -1;
1917         }
1918
1919         if (!(monitor_instance->subscription_pvt = sip_alloc(NULL, NULL, 0, SIP_SUBSCRIBE, NULL))) {
1920                 return -1;
1921         }
1922
1923         when = service == AST_CC_CCBS ? ast_get_ccbs_available_timer(monitor->interface->config_params) :
1924                 ast_get_ccnr_available_timer(monitor->interface->config_params);
1925
1926         sip_pvt_lock(monitor_instance->subscription_pvt);
1927         ast_set_flag(&monitor_instance->subscription_pvt->flags[0], SIP_OUTGOING);
1928         create_addr(monitor_instance->subscription_pvt, monitor_instance->peername, 0, 1, NULL);
1929         ast_sip_ouraddrfor(&monitor_instance->subscription_pvt->sa, &monitor_instance->subscription_pvt->ourip, monitor_instance->subscription_pvt);
1930         monitor_instance->subscription_pvt->subscribed = CALL_COMPLETION;
1931         monitor_instance->subscription_pvt->expiry = when;
1932
1933         transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 2, monitor_instance->subscribe_uri);
1934         sip_pvt_unlock(monitor_instance->subscription_pvt);
1935
1936         ao2_t_ref(monitor, +1, "Adding a ref to the monitor for the scheduler");
1937         *available_timer_id = ast_sched_add(sched, when * 1000, ast_cc_available_timer_expire, monitor);
1938         return 0;
1939 }
1940
1941 static int construct_pidf_body(enum sip_cc_publish_state state, char *pidf_body, size_t size, const char *presentity)
1942 {
1943         struct ast_str *body = ast_str_alloca(size);
1944         char tuple_id[32];
1945
1946         generate_random_string(tuple_id, sizeof(tuple_id));
1947
1948         /* We'll make this a bare-bones pidf body. In state_notify_build_xml, the PIDF
1949          * body gets a lot more extra junk that isn't necessary, so we'll leave it out here.
1950          */
1951         ast_str_append(&body, 0, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
1952         /* XXX The entity attribute is currently set to the peer name associated with the
1953          * dialog. This is because we currently only call this function for call-completion
1954          * PUBLISH bodies. In such cases, the entity is completely disregarded. For other
1955          * event packages, it may be crucial to have a proper URI as the presentity so this
1956          * should be revisited as support is expanded.
1957          */
1958         ast_str_append(&body, 0, "<presence xmlns=\"urn:ietf:params:xml:ns:pidf\" entity=\"%s\">\n", presentity);
1959         ast_str_append(&body, 0, "<tuple id=\"%s\">\n", tuple_id);
1960         ast_str_append(&body, 0, "<status><basic>%s</basic></status>\n", state == CC_OPEN ? "open" : "closed");
1961         ast_str_append(&body, 0, "</tuple>\n");
1962         ast_str_append(&body, 0, "</presence>\n");
1963         ast_copy_string(pidf_body, ast_str_buffer(body), size);
1964         return 0;
1965 }
1966
1967 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor)
1968 {
1969         struct sip_monitor_instance *monitor_instance = monitor->private_data;
1970         enum sip_publish_type publish_type;
1971         struct cc_epa_entry *cc_entry;
1972
1973         if (!monitor_instance) {
1974                 return -1;
1975         }
1976
1977         if (!monitor_instance->suspension_entry) {
1978                 /* We haven't yet allocated the suspension entry, so let's give it a shot */
1979                 if (!(monitor_instance->suspension_entry = create_epa_entry("call-completion", monitor_instance->peername))) {
1980                         ast_log(LOG_WARNING, "Unable to allocate sip EPA entry for call-completion\n");
1981                         ao2_ref(monitor_instance, -1);
1982                         return -1;
1983                 }
1984                 if (!(cc_entry = ast_calloc(1, sizeof(*cc_entry)))) {
1985                         ast_log(LOG_WARNING, "Unable to allocate space for instance data of EPA entry for call-completion\n");
1986                         ao2_ref(monitor_instance, -1);
1987                         return -1;
1988                 }
1989                 cc_entry->core_id = monitor->core_id;
1990                 monitor_instance->suspension_entry->instance_data = cc_entry;
1991                 publish_type = SIP_PUBLISH_INITIAL;
1992         } else {
1993                 publish_type = SIP_PUBLISH_MODIFY;
1994                 cc_entry = monitor_instance->suspension_entry->instance_data;
1995         }
1996
1997         cc_entry->current_state = CC_CLOSED;
1998
1999         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2000                 /* If we have no set notify_uri, then what this means is that we have
2001                  * not received a NOTIFY from this destination stating that he is
2002                  * currently available.
2003                  *
2004                  * This situation can arise when the core calls the suspend callbacks
2005                  * of multiple destinations. If one of the other destinations aside
2006                  * from this one notified Asterisk that he is available, then there
2007                  * is no reason to take any suspension action on this device. Rather,
2008                  * we should return now and if we receive a NOTIFY while monitoring
2009                  * is still "suspended" then we can immediately respond with the
2010                  * proper PUBLISH to let this endpoint know what is going on.
2011                  */
2012                 return 0;
2013         }
2014         construct_pidf_body(CC_CLOSED, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2015         return transmit_publish(monitor_instance->suspension_entry, publish_type, monitor_instance->notify_uri);
2016 }
2017
2018 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor)
2019 {
2020         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2021         struct cc_epa_entry *cc_entry;
2022
2023         if (!monitor_instance) {
2024                 return -1;
2025         }
2026
2027         ast_assert(monitor_instance->suspension_entry != NULL);
2028
2029         cc_entry = monitor_instance->suspension_entry->instance_data;
2030         cc_entry->current_state = CC_OPEN;
2031         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2032                 /* This means we are being asked to unsuspend a call leg we never
2033                  * sent a PUBLISH on. As such, there is no reason to send another
2034                  * PUBLISH at this point either. We can just return instead.
2035                  */
2036                 return 0;
2037         }
2038         construct_pidf_body(CC_OPEN, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2039         return transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_MODIFY, monitor_instance->notify_uri);
2040 }
2041
2042 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id)
2043 {
2044         if (*sched_id != -1) {
2045                 AST_SCHED_DEL(sched, *sched_id);
2046                 ao2_t_ref(monitor, -1, "Removing scheduler's reference to the monitor");
2047         }
2048         return 0;
2049 }
2050
2051 static void sip_cc_monitor_destructor(void *private_data)
2052 {
2053         struct sip_monitor_instance *monitor_instance = private_data;
2054         ao2_unlink(sip_monitor_instances, monitor_instance);
2055         ast_module_unref(ast_module_info->self);
2056 }
2057
2058 static int sip_get_cc_information(struct sip_request *req, char *subscribe_uri, size_t size, enum ast_cc_service_type *service)
2059 {
2060         char *call_info = ast_strdupa(get_header(req, "Call-Info"));
2061         char *uri;
2062         char *purpose;
2063         char *service_str;
2064         static const char cc_purpose[] = "purpose=call-completion";
2065         static const int cc_purpose_len = sizeof(cc_purpose) - 1;
2066
2067         if (ast_strlen_zero(call_info)) {
2068                 /* No Call-Info present. Definitely no CC offer */
2069                 return -1;
2070         }
2071
2072         uri = strsep(&call_info, ";");
2073
2074         while ((purpose = strsep(&call_info, ";"))) {
2075                 if (!strncmp(purpose, cc_purpose, cc_purpose_len)) {
2076                         break;
2077                 }
2078         }
2079         if (!purpose) {
2080                 /* We didn't find the appropriate purpose= parameter. Oh well */
2081                 return -1;
2082         }
2083
2084         /* Okay, call-completion has been offered. Let's figure out what type of service this is */
2085         while ((service_str = strsep(&call_info, ";"))) {
2086                 if (!strncmp(service_str, "m=", 2)) {
2087                         break;
2088                 }
2089         }
2090         if (!service_str) {
2091                 /* So they didn't offer a particular service, We'll just go with CCBS since it really
2092                  * doesn't matter anyway
2093                  */
2094                 service_str = "BS";
2095         } else {
2096                 /* We already determined that there is an "m=" so no need to check
2097                  * the result of this strsep
2098                  */
2099                 strsep(&service_str, "=");
2100         }
2101
2102         if ((*service = service_string_to_service_type(service_str)) == AST_CC_NONE) {
2103                 /* Invalid service offered */
2104                 return -1;
2105         }
2106
2107         ast_copy_string(subscribe_uri, get_in_brackets(uri), size);
2108
2109         return 0;
2110 }
2111
2112 /*
2113  * \brief Determine what, if any, CC has been offered and queue a CC frame if possible
2114  *
2115  * After taking care of some formalities to be sure that this call is eligible for CC,
2116  * we first try to see if we can make use of native CC. We grab the information from
2117  * the passed-in sip_request (which is always a response to an INVITE). If we can
2118  * use native CC monitoring for the call, then so be it.
2119  *
2120  * If native cc monitoring is not possible or not supported, then we will instead attempt
2121  * to use generic monitoring. Falling back to generic from a failed attempt at using native
2122  * monitoring will only work if the monitor policy of the endpoint is "always"
2123  *
2124  * \param pvt The current dialog. Contains CC parameters for the endpoint
2125  * \param req The response to the INVITE we want to inspect
2126  * \param service The service to use if generic monitoring is to be used. For native
2127  * monitoring, we get the service from the SIP response itself
2128  */
2129 static void sip_handle_cc(struct sip_pvt *pvt, struct sip_request *req, enum ast_cc_service_type service)
2130 {
2131         enum ast_cc_monitor_policies monitor_policy = ast_get_cc_monitor_policy(pvt->cc_params);
2132         int core_id;
2133         char interface_name[AST_CHANNEL_NAME];
2134
2135         if (monitor_policy == AST_CC_MONITOR_NEVER) {
2136                 /* Don't bother, just return */
2137                 return;
2138         }
2139
2140         if ((core_id = ast_cc_get_current_core_id(pvt->owner)) == -1) {
2141                 /* For some reason, CC is invalid, so don't try it! */
2142                 return;
2143         }
2144
2145         ast_channel_get_device_name(pvt->owner, interface_name, sizeof(interface_name));
2146
2147         if (monitor_policy == AST_CC_MONITOR_ALWAYS || monitor_policy == AST_CC_MONITOR_NATIVE) {
2148                 char subscribe_uri[SIPBUFSIZE];
2149                 char device_name[AST_CHANNEL_NAME];
2150                 enum ast_cc_service_type offered_service;
2151                 struct sip_monitor_instance *monitor_instance;
2152                 if (sip_get_cc_information(req, subscribe_uri, sizeof(subscribe_uri), &offered_service)) {
2153                         /* If CC isn't being offered to us, or for some reason the CC offer is
2154                          * not formatted correctly, then it may still be possible to use generic
2155                          * call completion since the monitor policy may be "always"
2156                          */
2157                         goto generic;
2158                 }
2159                 ast_channel_get_device_name(pvt->owner, device_name, sizeof(device_name));
2160                 if (!(monitor_instance = sip_monitor_instance_init(core_id, subscribe_uri, pvt->peername, device_name))) {
2161                         /* Same deal. We can try using generic still */
2162                         goto generic;
2163                 }
2164                 /* We bump the refcount of chan_sip because once we queue this frame, the CC core
2165                  * will have a reference to callbacks in this module. We decrement the module
2166                  * refcount once the monitor destructor is called
2167                  */
2168                 ast_module_ref(ast_module_info->self);
2169                 ast_queue_cc_frame(pvt->owner, "SIP", pvt->dialstring, offered_service, monitor_instance);
2170                 ao2_ref(monitor_instance, -1);
2171                 return;
2172         }
2173
2174 generic:
2175         if (monitor_policy == AST_CC_MONITOR_GENERIC || monitor_policy == AST_CC_MONITOR_ALWAYS) {
2176                 ast_queue_cc_frame(pvt->owner, AST_CC_GENERIC_MONITOR_TYPE, interface_name, service, NULL);
2177         }
2178 }
2179
2180 /*! \brief Working TLS connection configuration */
2181 static struct ast_tls_config sip_tls_cfg;
2182
2183 /*! \brief Default TLS connection configuration */
2184 static struct ast_tls_config default_tls_cfg;
2185
2186 /*! \brief The TCP server definition */
2187 static struct ast_tcptls_session_args sip_tcp_desc = {
2188         .accept_fd = -1,
2189         .master = AST_PTHREADT_NULL,
2190         .tls_cfg = NULL,
2191         .poll_timeout = -1,
2192         .name = "SIP TCP server",
2193         .accept_fn = ast_tcptls_server_root,
2194         .worker_fn = sip_tcp_worker_fn,
2195 };
2196
2197 /*! \brief The TCP/TLS server definition */
2198 static struct ast_tcptls_session_args sip_tls_desc = {
2199         .accept_fd = -1,
2200         .master = AST_PTHREADT_NULL,
2201         .tls_cfg = &sip_tls_cfg,
2202         .poll_timeout = -1,
2203         .name = "SIP TLS server",
2204         .accept_fn = ast_tcptls_server_root,
2205         .worker_fn = sip_tcp_worker_fn,
2206 };
2207
2208 /*! \brief Append to SIP dialog history
2209         \return Always returns 0 */
2210 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
2211
2212 struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
2213 {
2214         if (p)
2215 #ifdef REF_DEBUG
2216                 __ao2_ref_debug(p, 1, tag, file, line, func);
2217 #else
2218                 ao2_ref(p, 1);
2219 #endif
2220         else
2221                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
2222         return p;
2223 }
2224
2225 struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
2226 {
2227         if (p)
2228 #ifdef REF_DEBUG
2229                 __ao2_ref_debug(p, -1, tag, file, line, func);
2230 #else
2231                 ao2_ref(p, -1);
2232 #endif
2233         return NULL;
2234 }
2235
2236 /*! \brief map from an integer value to a string.
2237  * If no match is found, return errorstring
2238  */
2239 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2240 {
2241         const struct _map_x_s *cur;
2242
2243         for (cur = table; cur->s; cur++) {
2244                 if (cur->x == x) {
2245                         return cur->s;
2246                 }
2247         }
2248         return errorstring;
2249 }
2250
2251 /*! \brief map from a string to an integer value, case insensitive.
2252  * If no match is found, return errorvalue.
2253  */
2254 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2255 {
2256         const struct _map_x_s *cur;
2257
2258         for (cur = table; cur->s; cur++) {
2259                 if (!strcasecmp(cur->s, s)) {
2260                         return cur->x;
2261                 }
2262         }
2263         return errorvalue;
2264 }
2265
2266 static enum AST_REDIRECTING_REASON sip_reason_str_to_code(const char *text)
2267 {
2268         enum AST_REDIRECTING_REASON ast = AST_REDIRECTING_REASON_UNKNOWN;
2269         int i;
2270
2271         for (i = 0; i < ARRAY_LEN(sip_reason_table); ++i) {
2272                 if (!strcasecmp(text, sip_reason_table[i].text)) {
2273                         ast = sip_reason_table[i].code;
2274                         break;
2275                 }
2276         }
2277
2278         return ast;
2279 }
2280
2281 static const char *sip_reason_code_to_str(enum AST_REDIRECTING_REASON code)
2282 {
2283         if (code >= 0 && code < ARRAY_LEN(sip_reason_table)) {
2284                 return sip_reason_table[code].text;
2285         }
2286
2287         return "unknown";
2288 }
2289
2290 /*!
2291  * \brief generic function for determining if a correct transport is being
2292  * used to contact a peer
2293  *
2294  * this is done as a macro so that the "tmpl" var can be passed either a
2295  * sip_request or a sip_peer
2296  */
2297 #define check_request_transport(peer, tmpl) ({ \
2298         int ret = 0; \
2299         if (peer->socket.type == tmpl->socket.type) \
2300                 ; \
2301         else if (!(peer->transports & tmpl->socket.type)) {\
2302                 ast_log(LOG_ERROR, \
2303                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
2304                         get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
2305                         ); \
2306                 ret = 1; \
2307         } else if (peer->socket.type & SIP_TRANSPORT_TLS) { \
2308                 ast_log(LOG_WARNING, \
2309                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
2310                         peer->name, get_transport(tmpl->socket.type) \
2311                 ); \
2312         } else { \
2313                 ast_debug(1, \
2314                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
2315                         peer->name, get_transport(tmpl->socket.type), get_transport(peer->socket.type) \
2316                 ); \
2317         }\
2318         (ret); \
2319 })
2320
2321 /*! \brief
2322  * duplicate a list of channel variables, \return the copy.
2323  */
2324 static struct ast_variable *copy_vars(struct ast_variable *src)
2325 {
2326         struct ast_variable *res = NULL, *tmp, *v = NULL;
2327
2328         for (v = src ; v ; v = v->next) {
2329                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
2330                         tmp->next = res;
2331                         res = tmp;
2332                 }
2333         }
2334         return res;
2335 }
2336
2337 static void tcptls_packet_destructor(void *obj)
2338 {
2339         struct tcptls_packet *packet = obj;
2340
2341         ast_free(packet->data);
2342 }
2343
2344 static void sip_tcptls_client_args_destructor(void *obj)
2345 {
2346         struct ast_tcptls_session_args *args = obj;
2347         if (args->tls_cfg) {
2348                 ast_free(args->tls_cfg->certfile);
2349                 ast_free(args->tls_cfg->pvtfile);
2350                 ast_free(args->tls_cfg->cipher);
2351                 ast_free(args->tls_cfg->cafile);
2352                 ast_free(args->tls_cfg->capath);
2353         }
2354         ast_free(args->tls_cfg);
2355         ast_free((char *) args->name);
2356 }
2357
2358 static void sip_threadinfo_destructor(void *obj)
2359 {
2360         struct sip_threadinfo *th = obj;
2361         struct tcptls_packet *packet;
2362
2363         if (th->alert_pipe[1] > -1) {
2364                 close(th->alert_pipe[0]);
2365         }
2366         if (th->alert_pipe[1] > -1) {
2367                 close(th->alert_pipe[1]);
2368         }
2369         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2370
2371         while ((packet = AST_LIST_REMOVE_HEAD(&th->packet_q, entry))) {
2372                 ao2_t_ref(packet, -1, "thread destruction, removing packet from frame queue");
2373         }
2374
2375         if (th->tcptls_session) {
2376                 ao2_t_ref(th->tcptls_session, -1, "remove tcptls_session for sip_threadinfo object");
2377         }
2378 }
2379
2380 /*! \brief creates a sip_threadinfo object and links it into the threadt table. */
2381 static struct sip_threadinfo *sip_threadinfo_create(struct ast_tcptls_session_instance *tcptls_session, int transport)
2382 {
2383         struct sip_threadinfo *th;
2384
2385         if (!tcptls_session || !(th = ao2_alloc(sizeof(*th), sip_threadinfo_destructor))) {
2386                 return NULL;
2387         }
2388
2389         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2390
2391         if (pipe(th->alert_pipe) == -1) {
2392                 ao2_t_ref(th, -1, "Failed to open alert pipe on sip_threadinfo");
2393                 ast_log(LOG_ERROR, "Could not create sip alert pipe in tcptls thread, error %s\n", strerror(errno));
2394                 return NULL;
2395         }
2396         ao2_t_ref(tcptls_session, +1, "tcptls_session ref for sip_threadinfo object");
2397         th->tcptls_session = tcptls_session;
2398         th->type = transport ? transport : (tcptls_session->ssl ? SIP_TRANSPORT_TLS: SIP_TRANSPORT_TCP);
2399         ao2_t_link(threadt, th, "Adding new tcptls helper thread");
2400         ao2_t_ref(th, -1, "Decrementing threadinfo ref from alloc, only table ref remains");
2401         return th;
2402 }
2403
2404 /*! \brief used to indicate to a tcptls thread that data is ready to be written */
2405 static int sip_tcptls_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t len)
2406 {
2407         int res = len;
2408         struct sip_threadinfo *th = NULL;
2409         struct tcptls_packet *packet = NULL;
2410         struct sip_threadinfo tmp = {
2411                 .tcptls_session = tcptls_session,
2412         };
2413         enum sip_tcptls_alert alert = TCPTLS_ALERT_DATA;
2414
2415         if (!tcptls_session) {
2416                 return XMIT_ERROR;
2417         }
2418
2419         ast_mutex_lock(&tcptls_session->lock);
2420
2421         if ((tcptls_session->fd == -1) ||
2422                 !(th = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread")) ||
2423                 !(packet = ao2_alloc(sizeof(*packet), tcptls_packet_destructor)) ||
2424                 !(packet->data = ast_str_create(len))) {
2425                 goto tcptls_write_setup_error;
2426         }
2427
2428         /* goto tcptls_write_error should _NOT_ be used beyond this point */
2429         ast_str_set(&packet->data, 0, "%s", (char *) buf);
2430         packet->len = len;
2431
2432         /* alert tcptls thread handler that there is a packet to be sent.
2433          * must lock the thread info object to guarantee control of the
2434          * packet queue */
2435         ao2_lock(th);
2436         if (write(th->alert_pipe[1], &alert, sizeof(alert)) == -1) {
2437                 ast_log(LOG_ERROR, "write() to alert pipe failed: %s\n", strerror(errno));
2438                 ao2_t_ref(packet, -1, "could not write to alert pipe, remove packet");
2439                 packet = NULL;
2440                 res = XMIT_ERROR;
2441         } else { /* it is safe to queue the frame after issuing the alert when we hold the threadinfo lock */
2442                 AST_LIST_INSERT_TAIL(&th->packet_q, packet, entry);
2443         }
2444         ao2_unlock(th);
2445
2446         ast_mutex_unlock(&tcptls_session->lock);
2447         ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo object after finding it");
2448         return res;
2449
2450 tcptls_write_setup_error:
2451         if (th) {
2452                 ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo obj, could not create packet");
2453         }
2454         if (packet) {
2455                 ao2_t_ref(packet, -1, "could not allocate packet's data");
2456         }
2457         ast_mutex_unlock(&tcptls_session->lock);
2458
2459         return XMIT_ERROR;
2460 }
2461
2462 /*! \brief SIP TCP connection handler */
2463 static void *sip_tcp_worker_fn(void *data)
2464 {
2465         struct ast_tcptls_session_instance *tcptls_session = data;
2466
2467         return _sip_tcp_helper_thread(NULL, tcptls_session);
2468 }
2469
2470 /*! \brief Check if the authtimeout has expired.
2471  * \param start the time when the session started
2472  *
2473  * \retval 0 the timeout has expired
2474  * \retval -1 error
2475  * \return the number of milliseconds until the timeout will expire
2476  */
2477 static int sip_check_authtimeout(time_t start)
2478 {
2479         int timeout;
2480         time_t now;
2481         if(time(&now) == -1) {
2482                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
2483                 return -1;
2484         }
2485
2486         timeout = (authtimeout - (now - start)) * 1000;
2487         if (timeout < 0) {
2488                 /* we have timed out */
2489                 return 0;
2490         }
2491
2492         return timeout;
2493 }
2494
2495 /*! \brief SIP TCP thread management function
2496         This function reads from the socket, parses the packet into a request
2497 */
2498 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session)
2499 {
2500         int res, cl, timeout = -1, authenticated = 0, flags, after_poll = 0, need_poll = 1;
2501         time_t start;
2502         struct sip_request req = { 0, } , reqcpy = { 0, };
2503         struct sip_threadinfo *me = NULL;
2504         char buf[1024] = "";
2505         struct pollfd fds[2] = { { 0 }, { 0 }, };
2506         struct ast_tcptls_session_args *ca = NULL;
2507
2508         /* If this is a server session, then the connection has already been
2509          * setup. Check if the authlimit has been reached and if not create the
2510          * threadinfo object so we can access this thread for writing.
2511          *
2512          * if this is a client connection more work must be done.
2513          * 1. We own the parent session args for a client connection.  This pointer needs
2514          *    to be held on to so we can decrement it's ref count on thread destruction.
2515          * 2. The threadinfo object was created before this thread was launched, however
2516          *    it must be found within the threadt table.
2517          * 3. Last, the tcptls_session must be started.
2518          */
2519         if (!tcptls_session->client) {
2520                 if (ast_atomic_fetchadd_int(&unauth_sessions, +1) >= authlimit) {
2521                         /* unauth_sessions is decremented in the cleanup code */
2522                         goto cleanup;
2523                 }
2524
2525                 if ((flags = fcntl(tcptls_session->fd, F_GETFL)) == -1) {
2526                         ast_log(LOG_ERROR, "error setting socket to non blocking mode, fcntl() failed: %s\n", strerror(errno));
2527                         goto cleanup;
2528                 }
2529
2530                 flags |= O_NONBLOCK;
2531                 if (fcntl(tcptls_session->fd, F_SETFL, flags) == -1) {
2532                         ast_log(LOG_ERROR, "error setting socket to non blocking mode, fcntl() failed: %s\n", strerror(errno));
2533                         goto cleanup;
2534                 }
2535
2536                 if (!(me = sip_threadinfo_create(tcptls_session, tcptls_session->ssl ? SIP_TRANSPORT_TLS : SIP_TRANSPORT_TCP))) {
2537                         goto cleanup;
2538                 }
2539                 ao2_t_ref(me, +1, "Adding threadinfo ref for tcp_helper_thread");
2540         } else {
2541                 struct sip_threadinfo tmp = {
2542                         .tcptls_session = tcptls_session,
2543                 };
2544
2545                 if ((!(ca = tcptls_session->parent)) ||
2546                         (!(me = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread"))) ||
2547                         (!(tcptls_session = ast_tcptls_client_start(tcptls_session)))) {
2548                         goto cleanup;
2549                 }
2550         }
2551
2552         flags = 1;
2553         if (setsockopt(tcptls_session->fd, SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
2554                 ast_log(LOG_ERROR, "error enabling TCP keep-alives on sip socket: %s\n", strerror(errno));
2555                 goto cleanup;
2556         }
2557
2558         me->threadid = pthread_self();
2559         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2560
2561         /* set up pollfd to watch for reads on both the socket and the alert_pipe */
2562         fds[0].fd = tcptls_session->fd;
2563         fds[1].fd = me->alert_pipe[0];
2564         fds[0].events = fds[1].events = POLLIN | POLLPRI;
2565
2566         if (!(req.data = ast_str_create(SIP_MIN_PACKET))) {
2567                 goto cleanup;
2568         }
2569         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET))) {
2570                 goto cleanup;
2571         }
2572
2573         if(time(&start) == -1) {
2574                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
2575                 goto cleanup;
2576         }
2577
2578         for (;;) {
2579                 struct ast_str *str_save;
2580
2581                 if (!tcptls_session->client && req.authenticated && !authenticated) {
2582                         authenticated = 1;
2583                         ast_atomic_fetchadd_int(&unauth_sessions, -1);
2584                 }
2585
2586                 /* calculate the timeout for unauthenticated server sessions */
2587                 if (!tcptls_session->client && !authenticated ) {
2588                         if ((timeout = sip_check_authtimeout(start)) < 0) {
2589                                 goto cleanup;
2590                         }
2591
2592                         if (timeout == 0) {
2593                                 ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2594                                 goto cleanup;
2595                         }
2596                 } else {
2597                         timeout = -1;
2598                 }
2599
2600                 res = ast_poll(fds, 2, timeout); /* polls for both socket and alert_pipe */
2601                 if (res < 0) {
2602                         ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", tcptls_session->ssl ? "SSL": "TCP", res);
2603                         goto cleanup;
2604                 } else if (res == 0) {
2605                         /* timeout */
2606                         ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2607                         goto cleanup;
2608                 }
2609
2610                 /* handle the socket event, check for both reads from the socket fd,
2611                  * and writes from alert_pipe fd */
2612                 if (fds[0].revents) { /* there is data on the socket to be read */
2613                         after_poll = 1;
2614
2615                         fds[0].revents = 0;
2616
2617                         /* clear request structure */
2618                         str_save = req.data;
2619                         memset(&req, 0, sizeof(req));
2620                         req.data = str_save;
2621                         ast_str_reset(req.data);
2622
2623                         str_save = reqcpy.data;
2624                         memset(&reqcpy, 0, sizeof(reqcpy));
2625                         reqcpy.data = str_save;
2626                         ast_str_reset(reqcpy.data);
2627
2628                         memset(buf, 0, sizeof(buf));
2629
2630                         if (tcptls_session->ssl) {
2631                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TLS);
2632                                 req.socket.port = htons(ourport_tls);
2633                         } else {
2634                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TCP);
2635                                 req.socket.port = htons(ourport_tcp);
2636                         }
2637                         req.socket.fd = tcptls_session->fd;
2638
2639                         /* Read in headers one line at a time */
2640                         while (ast_str_strlen(req.data) < 4 || strncmp(REQ_OFFSET_TO_STR(&req, data->used - 4), "\r\n\r\n", 4)) {
2641                                 if (!tcptls_session->client && !authenticated ) {
2642                                         if ((timeout = sip_check_authtimeout(start)) < 0) {
2643                                                 goto cleanup;
2644                                         }
2645
2646                                         if (timeout == 0) {
2647                                                 ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2648                                                 goto cleanup;
2649                                         }
2650                                 } else {
2651                                         timeout = -1;
2652                                 }
2653
2654                                 /* special polling behavior is required for TLS
2655                                  * sockets because of the buffering done in the
2656                                  * TLS layer */
2657                                 if (!tcptls_session->ssl || need_poll) {
2658                                         need_poll = 0;
2659                                         after_poll = 1;
2660                                         res = ast_wait_for_input(tcptls_session->fd, timeout);
2661                                         if (res < 0) {
2662                                                 ast_debug(2, "SIP TCP server :: ast_wait_for_input returned %d\n", res);
2663                                                 goto cleanup;
2664                                         } else if (res == 0) {
2665                                                 /* timeout */
2666                                                 ast_debug(2, "SIP TCP server timed out\n");
2667                                                 goto cleanup;
2668                                         }
2669                                 }
2670
2671                                 ast_mutex_lock(&tcptls_session->lock);
2672                                 if (!fgets(buf, sizeof(buf), tcptls_session->f)) {
2673                                         ast_mutex_unlock(&tcptls_session->lock);
2674                                         if (after_poll) {
2675                                                 goto cleanup;
2676                                         } else {
2677                                                 need_poll = 1;
2678                                                 continue;
2679                                         }
2680                                 }
2681                                 ast_mutex_unlock(&tcptls_session->lock);
2682                                 after_poll = 0;
2683                                 if (me->stop) {
2684                                          goto cleanup;
2685                                 }
2686                                 ast_str_append(&req.data, 0, "%s", buf);
2687                         }
2688                         copy_request(&reqcpy, &req);
2689                         parse_request(&reqcpy);
2690                         /* In order to know how much to read, we need the content-length header */
2691                         if (sscanf(get_header(&reqcpy, "Content-Length"), "%30d", &cl)) {
2692                                 while (cl > 0) {
2693                                         size_t bytes_read;
2694                                         if (!tcptls_session->client && !authenticated ) {
2695                                                 if ((timeout = sip_check_authtimeout(start)) < 0) {
2696                                                         goto cleanup;
2697                                                 }
2698
2699                                                 if (timeout == 0) {
2700                                                         ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "SSL": "TCP");
2701                                                         goto cleanup;
2702                                                 }
2703                                         } else {
2704                                                 timeout = -1;
2705                                         }
2706
2707                                         if (!tcptls_session->ssl || need_poll) {
2708                                                 need_poll = 0;
2709                                                 after_poll = 1;
2710                                                 res = ast_wait_for_input(tcptls_session->fd, timeout);
2711                                                 if (res < 0) {
2712                                                         ast_debug(2, "SIP TCP server :: ast_wait_for_input returned %d\n", res);
2713                                                         goto cleanup;
2714                                                 } else if (res == 0) {
2715                                                         /* timeout */
2716                                                         ast_debug(2, "SIP TCP server timed out\n");
2717                                                         goto cleanup;
2718                                                 }
2719                                         }
2720
2721                                         ast_mutex_lock(&tcptls_session->lock);
2722                                         if (!(bytes_read = fread(buf, 1, MIN(sizeof(buf) - 1, cl), tcptls_session->f))) {
2723                                                 ast_mutex_unlock(&tcptls_session->lock);
2724                                                 if (after_poll) {
2725                                                         goto cleanup;
2726                                                 } else {
2727                                                         need_poll = 1;
2728                                                         continue;
2729                                                 }
2730                                         }
2731                                         buf[bytes_read] = '\0';
2732                                         ast_mutex_unlock(&tcptls_session->lock);
2733                                         after_poll = 0;
2734                                         if (me->stop) {
2735                                                 goto cleanup;
2736                                         }
2737                                         cl -= strlen(buf);
2738                                         ast_str_append(&req.data, 0, "%s", buf);
2739                                 }
2740                         }
2741                         /*! \todo XXX If there's no Content-Length or if the content-length and what
2742                                         we receive is not the same - we should generate an error */
2743
2744                         req.socket.tcptls_session = tcptls_session;
2745                         handle_request_do(&req, &tcptls_session->remote_address);
2746                 }
2747
2748                 if (fds[1].revents) { /* alert_pipe indicates there is data in the send queue to be sent */
2749                         enum sip_tcptls_alert alert;
2750                         struct tcptls_packet *packet;
2751
2752                         fds[1].revents = 0;
2753
2754                         if (read(me->alert_pipe[0], &alert, sizeof(alert)) == -1) {
2755                                 ast_log(LOG_ERROR, "read() failed: %s\n", strerror(errno));
2756                                 continue;
2757                         }
2758
2759                         switch (alert) {
2760                         case TCPTLS_ALERT_STOP:
2761                                 goto cleanup;
2762                         case TCPTLS_ALERT_DATA:
2763                                 ao2_lock(me);
2764                                 if (!(packet = AST_LIST_REMOVE_HEAD(&me->packet_q, entry))) {
2765                                         ast_log(LOG_WARNING, "TCPTLS thread alert_pipe indicated packet should be sent, but frame_q is empty");
2766                                 }
2767                                 ao2_unlock(me);
2768
2769                                 if (packet) {
2770                                         if (ast_tcptls_server_write(tcptls_session, ast_str_buffer(packet->data), packet->len) == -1) {
2771                                                 ast_log(LOG_WARNING, "Failure to write to tcp/tls socket\n");
2772                                         }
2773                                         ao2_t_ref(packet, -1, "tcptls packet sent, this is no longer needed");
2774                                 }
2775                                 break;
2776                         default:
2777                                 ast_log(LOG_ERROR, "Unknown tcptls thread alert '%d'\n", alert);
2778                         }
2779                 }
2780         }
2781
2782         ast_debug(2, "Shutting down thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2783
2784 cleanup:
2785         if (tcptls_session && !tcptls_session->client && !authenticated) {
2786                 ast_atomic_fetchadd_int(&unauth_sessions, -1);
2787         }
2788
2789         if (me) {
2790                 ao2_t_unlink(threadt, me, "Removing tcptls helper thread, thread is closing");
2791                 ao2_t_ref(me, -1, "Removing tcp_helper_threads threadinfo ref");
2792         }
2793         deinit_req(&reqcpy);
2794         deinit_req(&req);
2795
2796         /* if client, we own the parent session arguments and must decrement ref */
2797         if (ca) {
2798                 ao2_t_ref(ca, -1, "closing tcptls thread, getting rid of client tcptls_session arguments");
2799         }
2800
2801         if (tcptls_session) {
2802                 ast_mutex_lock(&tcptls_session->lock);
2803                 if (tcptls_session->f) {
2804                         fclose(tcptls_session->f);
2805                         tcptls_session->f = NULL;
2806                 }
2807                 if (tcptls_session->fd != -1) {
2808                         close(tcptls_session->fd);
2809                         tcptls_session->fd = -1;
2810                 }
2811                 tcptls_session->parent = NULL;
2812                 ast_mutex_unlock(&tcptls_session->lock);
2813
2814                 ao2_ref(tcptls_session, -1);
2815                 tcptls_session = NULL;
2816         }
2817         return NULL;
2818 }
2819
2820 #ifdef REF_DEBUG
2821 #define ref_peer(arg1,arg2) _ref_peer((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
2822 #define unref_peer(arg1,arg2) _unref_peer((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
2823 static struct sip_peer *_ref_peer(struct sip_peer *peer, char *tag, char *file, int line, const char *func)
2824 {
2825         if (peer)
2826                 __ao2_ref_debug(peer, 1, tag, file, line, func);
2827         else
2828                 ast_log(LOG_ERROR, "Attempt to Ref a null peer pointer\n");
2829         return peer;
2830 }
2831
2832 static struct sip_peer *_unref_peer(struct sip_peer *peer, char *tag, char *file, int line, const char *func)
2833 {
2834         if (peer)
2835                 __ao2_ref_debug(peer, -1, tag, file, line, func);
2836         return NULL;
2837 }
2838 #else
2839 /*!
2840  * helper functions to unreference various types of objects.
2841  * By handling them this way, we don't have to declare the
2842  * destructor on each call, which removes the chance of errors.
2843  */
2844 static void *unref_peer(struct sip_peer *peer, char *tag)
2845 {
2846         ao2_t_ref(peer, -1, tag);
2847         return NULL;
2848 }
2849
2850 static struct sip_peer *ref_peer(struct sip_peer *peer, char *tag)
2851 {
2852         ao2_t_ref(peer, 1, tag);
2853         return peer;
2854 }
2855 #endif /* REF_DEBUG */
2856
2857 static void peer_sched_cleanup(struct sip_peer *peer)
2858 {
2859         if (peer->pokeexpire != -1) {
2860                 AST_SCHED_DEL_UNREF(sched, peer->pokeexpire,
2861                                 unref_peer(peer, "removing poke peer ref"));
2862         }
2863         if (peer->expire != -1) {
2864                 AST_SCHED_DEL_UNREF(sched, peer->expire,
2865                                 unref_peer(peer, "remove register expire ref"));
2866         }
2867 }
2868
2869 typedef enum {
2870         SIP_PEERS_MARKED,
2871         SIP_PEERS_ALL,
2872 } peer_unlink_flag_t;
2873
2874 /* this func is used with ao2_callback to unlink/delete all marked or linked
2875    peers, depending on arg */
2876 static int match_and_cleanup_peer_sched(void *peerobj, void *arg, int flags)
2877 {
2878         struct sip_peer *peer = peerobj;
2879         peer_unlink_flag_t which = *(peer_unlink_flag_t *)arg;
2880
2881         if (which == SIP_PEERS_ALL || peer->the_mark) {
2882                 peer_sched_cleanup(peer);
2883                 return CMP_MATCH;
2884         }
2885         return 0;
2886 }
2887
2888 static void unlink_peers_from_tables(peer_unlink_flag_t flag)
2889 {
2890         ao2_t_callback(peers, OBJ_NODATA | OBJ_UNLINK | OBJ_MULTIPLE,
2891                 match_and_cleanup_peer_sched, &flag, "initiating callback to remove marked peers");
2892         ao2_t_callback(peers_by_ip, OBJ_NODATA | OBJ_UNLINK | OBJ_MULTIPLE,
2893                 match_and_cleanup_peer_sched, &flag, "initiating callback to remove marked peers");
2894 }
2895
2896 /* \brief Unlink all marked peers from ao2 containers */
2897 static void unlink_marked_peers_from_tables(void)
2898 {
2899         unlink_peers_from_tables(SIP_PEERS_MARKED);
2900 }
2901
2902 static void unlink_all_peers_from_tables(void)
2903 {
2904         unlink_peers_from_tables(SIP_PEERS_ALL);
2905 }
2906
2907 /* \brief Unlink single peer from all ao2 containers */
2908 static void unlink_peer_from_tables(struct sip_peer *peer)
2909 {
2910         ao2_t_unlink(peers, peer, "ao2_unlink of peer from peers table");
2911         if (!ast_sockaddr_isnull(&peer->addr)) {
2912                 ao2_t_unlink(peers_by_ip, peer, "ao2_unlink of peer from peers_by_ip table");
2913         }
2914 }
2915
2916 /*! \brief maintain proper refcounts for a sip_pvt's outboundproxy
2917  *
2918  * This function sets pvt's outboundproxy pointer to the one referenced
2919  * by the proxy parameter. Because proxy may be a refcounted object, and
2920  * because pvt's old outboundproxy may also be a refcounted object, we need
2921  * to maintain the proper refcounts.
2922  *
2923  * \param pvt The sip_pvt for which we wish to set the outboundproxy
2924  * \param proxy The sip_proxy which we will point pvt towards.
2925  * \return Returns void
2926  */
2927 static void ref_proxy(struct sip_pvt *pvt, struct sip_proxy *proxy)
2928 {
2929         struct sip_proxy *old_obproxy = pvt->outboundproxy;
2930         /* The sip_cfg.outboundproxy is statically allocated, and so
2931          * we don't ever need to adjust refcounts for it
2932          */
2933         if (proxy && proxy != &sip_cfg.outboundproxy) {
2934                 ao2_ref(proxy, +1);
2935         }
2936         pvt->outboundproxy = proxy;
2937         if (old_obproxy && old_obproxy != &sip_cfg.outboundproxy) {
2938                 ao2_ref(old_obproxy, -1);
2939         }
2940 }
2941
2942  /*!
2943  * \brief Unlink a dialog from the dialogs_checkrtp container
2944  */
2945 static void *dialog_unlink_rtpcheck(struct sip_pvt *dialog)
2946 {
2947         ao2_t_unlink(dialogs_rtpcheck, dialog, "unlinking dialog_rtpcheck via ao2_unlink");
2948         return NULL;
2949 }
2950
2951 /*!
2952  * \brief Unlink a dialog from the dialogs container, as well as any other places
2953  * that it may be currently stored.
2954  *
2955  * \note A reference to the dialog must be held before calling this function, and this
2956  * function does not release that reference.
2957  */
2958 void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist)
2959 {
2960         struct sip_pkt *cp;
2961
2962         dialog_ref(dialog, "Let's bump the count in the unlink so it doesn't accidentally become dead before we are done");
2963
2964         ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
2965         ao2_t_unlink(dialogs_needdestroy, dialog, "unlinking dialog_needdestroy via ao2_unlink");
2966         ao2_t_unlink(dialogs_rtpcheck, dialog, "unlinking dialog_rtpcheck via ao2_unlink");
2967
2968         /* Unlink us from the owner (channel) if we have one */
2969         if (dialog->owner) {
2970                 if (lockowner) {
2971                         ast_channel_lock(dialog->owner);
2972                 }
2973                 ast_debug(1, "Detaching from channel %s\n", dialog->owner->name);
2974                 dialog->owner->tech_pvt = dialog_unref(dialog->owner->tech_pvt, "resetting channel dialog ptr in unlink_all");
2975                 if (lockowner) {
2976                         ast_channel_unlock(dialog->owner);
2977                 }
2978         }
2979         if (dialog->registry) {
2980                 if (dialog->registry->call == dialog) {
2981                         dialog->registry->call = dialog_unref(dialog->registry->call, "nulling out the registry's call dialog field in unlink_all");
2982                 }
2983                 dialog->registry = registry_unref(dialog->registry, "delete dialog->registry");
2984         }
2985         if (dialog->stateid > -1) {
2986                 ast_extension_state_del(dialog->stateid, NULL);
2987                 dialog_unref(dialog, "removing extension_state, should unref the associated dialog ptr that was stored there.");
2988                 dialog->stateid = -1; /* shouldn't we 'zero' this out? */
2989         }
2990         /* Remove link from peer to subscription of MWI */
2991         if (dialog->relatedpeer && dialog->relatedpeer->mwipvt == dialog) {
2992                 dialog->relatedpeer->mwipvt = dialog_unref(dialog->relatedpeer->mwipvt, "delete ->relatedpeer->mwipvt");
2993         }
2994         if (dialog->relatedpeer && dialog->relatedpeer->call == dialog) {
2995                 dialog->relatedpeer->call = dialog_unref(dialog->relatedpeer->call, "unset the relatedpeer->call field in tandem with relatedpeer field itself");
2996         }
2997
2998         /* remove all current packets in this dialog */
2999         while((cp = dialog->packets)) {
3000                 dialog->packets = dialog->packets->next;
3001                 AST_SCHED_DEL(sched, cp->retransid);
3002                 dialog_unref(cp->owner, "remove all current packets in this dialog, and the pointer to the dialog too as part of __sip_destroy");
3003                 if (cp->data) {
3004                         ast_free(cp->data);
3005                 }
3006                 ast_free(cp);
3007         }
3008
3009         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"));
3010
3011         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"));
3012         
3013         if (dialog->autokillid > -1) {
3014                 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"));
3015         }
3016
3017         if (dialog->request_queue_sched_id > -1) {
3018                 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"));
3019         }
3020
3021         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"));
3022
3023         if (dialog->t38id > -1) {
3024                 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"));
3025         }
3026
3027         if (dialog->stimer) {
3028                 stop_session_timer(dialog);
3029         }
3030
3031         dialog_unref(dialog, "Let's unbump the count in the unlink so the poor pvt can disappear if it is time");
3032         return NULL;
3033 }
3034
3035 void *registry_unref(struct sip_registry *reg, char *tag)
3036 {
3037         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
3038         ASTOBJ_UNREF(reg, sip_registry_destroy);
3039         return NULL;
3040 }
3041
3042 /*! \brief Add object reference to SIP registry */
3043 static struct sip_registry *registry_addref(struct sip_registry *reg, char *tag)
3044 {
3045         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
3046         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
3047 }
3048
3049 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
3050 static struct ast_udptl_protocol sip_udptl = {
3051         type: "SIP",
3052         get_udptl_info: sip_get_udptl_peer,
3053         set_udptl_peer: sip_set_udptl_peer,
3054 };
3055
3056 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
3057         __attribute__((format(printf, 2, 3)));
3058
3059
3060 /*! \brief Convert transfer status to string */
3061 static const char *referstatus2str(enum referstatus rstatus)
3062 {
3063         return map_x_s(referstatusstrings, rstatus, "");
3064 }
3065
3066 static inline void pvt_set_needdestroy(struct sip_pvt *pvt, const char *reason)
3067 {
3068         if (pvt->final_destruction_scheduled) {
3069                 return; /* This is already scheduled for final destruction, let the scheduler take care of it. */
3070         }
3071         if(pvt->needdestroy != 1) {
3072                 ao2_t_link(dialogs_needdestroy, pvt, "link pvt into dialogs_needdestroy container");
3073         }
3074         append_history(pvt, "NeedDestroy", "Setting needdestroy because %s", reason);
3075         pvt->needdestroy = 1;
3076 }
3077
3078 /*! \brief Initialize the initital request packet in the pvt structure.
3079         This packet is used for creating replies and future requests in
3080         a dialog */
3081 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
3082 {
3083         if (p->initreq.headers) {
3084                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
3085         } else {
3086                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
3087         }
3088         /* Use this as the basis */
3089         copy_request(&p->initreq, req);
3090         parse_request(&p->initreq);
3091         if (req->debug) {
3092                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
3093         }
3094 }
3095
3096 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
3097 static void sip_alreadygone(struct sip_pvt *dialog)
3098 {
3099         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
3100         dialog->alreadygone = 1;
3101 }
3102
3103 /*! Resolve DNS srv name or host name in a sip_proxy structure */
3104 static int proxy_update(struct sip_proxy *proxy)
3105 {
3106         /* if it's actually an IP address and not a name,
3107            there's no need for a managed lookup */
3108         if (!ast_sockaddr_parse(&proxy->ip, proxy->name, 0)) {
3109                 /* Ok, not an IP address, then let's check if it's a domain or host */
3110                 /* XXX Todo - if we have proxy port, don't do SRV */
3111                 proxy->ip.ss.ss_family = get_address_family_filter(&bindaddr); /* Filter address family */
3112                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, sip_cfg.srvlookup ? "_sip._udp" : NULL) < 0) {
3113                                 ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
3114                                 return FALSE;
3115                 }
3116
3117         }
3118
3119         ast_sockaddr_set_port(&proxy->ip, proxy->port);
3120
3121         proxy->last_dnsupdate = time(NULL);
3122         return TRUE;
3123 }
3124
3125 /*! \brief converts ascii port to int representation. If no
3126  *  pt buffer is provided or the pt has errors when being converted
3127  *  to an int value, the port provided as the standard is used.
3128  */
3129 unsigned int port_str2int(const char *pt, unsigned int standard)
3130 {
3131         int port = standard;
3132         if (ast_strlen_zero(pt) || (sscanf(pt, "%30d", &port) != 1) || (port < 1) || (port > 65535)) {
3133                 port = standard;
3134         }
3135
3136         return port;
3137 }
3138
3139 /*! \brief Get default outbound proxy or global proxy */
3140 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
3141 {
3142         if (peer && peer->outboundproxy) {
3143                 if (sipdebug) {
3144                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
3145                 }
3146                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
3147                 return peer->outboundproxy;
3148         }
3149         if (sip_cfg.outboundproxy.name[0]) {
3150                 if (sipdebug) {
3151                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
3152                 }
3153                 append_history(dialog, "OBproxy", "Using global obproxy %s", sip_cfg.outboundproxy.name);
3154                 return &sip_cfg.outboundproxy;
3155         }
3156         if (sipdebug) {
3157                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
3158         }
3159         return NULL;
3160 }
3161
3162 /*! \brief returns true if 'name' (with optional trailing whitespace)
3163  * matches the sip method 'id'.
3164  * Strictly speaking, SIP methods are case SENSITIVE, but we do
3165  * a case-insensitive comparison to be more tolerant.
3166  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
3167  */
3168 static int method_match(enum sipmethod id, const char *name)
3169 {
3170         int len = strlen(sip_methods[id].text);
3171         int l_name = name ? strlen(name) : 0;
3172         /* true if the string is long enough, and ends with whitespace, and matches */
3173         return (l_name >= len && name[len] < 33 &&
3174                 !strncasecmp(sip_methods[id].text, name, len));
3175 }
3176
3177 /*! \brief  find_sip_method: Find SIP method from header */
3178 static int find_sip_method(const char *msg)
3179 {
3180         int i, res = 0;
3181         
3182         if (ast_strlen_zero(msg)) {
3183                 return 0;
3184         }
3185         for (i = 1; i < ARRAY_LEN(sip_methods) && !res; i++) {
3186                 if (method_match(i, msg)) {
3187                         res = sip_methods[i].id;
3188                 }
3189         }
3190         return res;
3191 }
3192
3193 /*! \brief See if we pass debug IP filter */
3194 static inline int sip_debug_test_addr(const struct ast_sockaddr *addr)
3195 {
3196         /* Can't debug if sipdebug is not enabled */
3197         if (!sipdebug) {
3198                 return 0;
3199         }
3200
3201         /* A null debug_addr means we'll debug any address */
3202         if (ast_sockaddr_isnull(&debugaddr)) {
3203                 return 1;
3204         }
3205
3206         /* If no port was specified for a debug address, just compare the
3207          * addresses, otherwise compare the address and port
3208          */
3209         if (ast_sockaddr_port(&debugaddr)) {
3210                 return !ast_sockaddr_cmp(&debugaddr, addr);
3211         } else {
3212                 return !ast_sockaddr_cmp_addr(&debugaddr, addr);
3213         }
3214 }
3215
3216 /*! \brief The real destination address for a write */
3217 static const struct ast_sockaddr *sip_real_dst(const struct sip_pvt *p)
3218 {
3219         if (p->outboundproxy) {
3220                 return &p->outboundproxy->ip;
3221         }
3222
3223         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;
3224 }
3225
3226 /*! \brief Display SIP nat mode */
3227 static const char *sip_nat_mode(const struct sip_pvt *p)
3228 {
3229         return ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) ? "NAT" : "no NAT";
3230 }
3231
3232 /*! \brief Test PVT for debugging output */
3233 static inline int sip_debug_test_pvt(struct sip_pvt *p)
3234 {
3235         if (!sipdebug) {
3236                 return 0;
3237         }
3238         return sip_debug_test_addr(sip_real_dst(p));
3239 }
3240
3241 /*! \brief Return int representing a bit field of transport types found in const char *transport */
3242 static int get_transport_str2enum(const char *transport)
3243 {
3244         int res = 0;
3245
3246         if (ast_strlen_zero(transport)) {
3247                 return res;
3248         }
3249
3250         if (!strcasecmp(transport, "udp")) {
3251                 res |= SIP_TRANSPORT_UDP;
3252         }
3253         if (!strcasecmp(transport, "tcp")) {
3254                 res |= SIP_TRANSPORT_TCP;
3255         }
3256         if (!strcasecmp(transport, "tls")) {
3257                 res |= SIP_TRANSPORT_TLS;
3258         }
3259
3260         return res;
3261 }
3262
3263 /*! \brief Return configuration of transports for a device */
3264 static inline const char *get_transport_list(unsigned int transports) {
3265         switch (transports) {
3266                 case SIP_TRANSPORT_UDP:
3267                         return "UDP";
3268                 case SIP_TRANSPORT_TCP:
3269                         return "TCP";
3270                 case SIP_TRANSPORT_TLS:
3271                         return "TLS";
3272                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TCP:
3273                         return "TCP,UDP";
3274                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TLS:
3275                         return "TLS,UDP";
3276                 case SIP_TRANSPORT_TCP | SIP_TRANSPORT_TLS:
3277                         return "TLS,TCP";
3278                 default:
3279                         return transports ?
3280                                 "TLS,TCP,UDP" : "UNKNOWN";      
3281         }
3282 }
3283
3284 /*! \brief Return transport as string */
3285 static inline const char *get_transport(enum sip_transport t)
3286 {
3287         switch (t) {
3288         case SIP_TRANSPORT_UDP:
3289                 return "UDP";
3290         case SIP_TRANSPORT_TCP:
3291                 return "TCP";
3292         case SIP_TRANSPORT_TLS:
3293                 return "TLS";
3294         }
3295
3296         return "UNKNOWN";
3297 }
3298
3299 /*! \brief Return protocol string for srv dns query */
3300 static inline const char *get_srv_protocol(enum sip_transport t)
3301 {
3302         switch (t) {
3303         case SIP_TRANSPORT_UDP:
3304                 return "udp";
3305         case SIP_TRANSPORT_TLS:
3306         case SIP_TRANSPORT_TCP:
3307                 return "tcp";
3308         }
3309
3310         return "udp";
3311 }
3312
3313 /*! \brief Return service string for srv dns query */
3314 static inline const char *get_srv_service(enum sip_transport t)
3315 {
3316         switch (t) {
3317         case SIP_TRANSPORT_TCP:
3318         case SIP_TRANSPORT_UDP:
3319                 return "sip";
3320         case SIP_TRANSPORT_TLS:
3321                 return "sips";
3322         }
3323         return "sip";
3324 }
3325
3326 /*! \brief Return transport of dialog.
3327         \note this is based on a false assumption. We don't always use the
3328         outbound proxy for all requests in a dialog. It depends on the
3329         "force" parameter. The FIRST request is always sent to the ob proxy.
3330         \todo Fix this function to work correctly
3331 */
3332 static inline const char *get_transport_pvt(struct sip_pvt *p)
3333 {
3334         if (p->outboundproxy && p->outboundproxy->transport) {
3335                 set_socket_transport(&p->socket, p->outboundproxy->transport);
3336         }
3337
3338         return get_transport(p->socket.type);
3339 }
3340
3341 /*!
3342  * \internal
3343  * \brief Transmit SIP message
3344  *
3345  * \details
3346  * Sends a SIP request or response on a given socket (in the pvt)
3347  * \note
3348  * Called by retrans_pkt, send_request, send_response and __sip_reliable_xmit
3349  *
3350  * \return length of transmitted message, XMIT_ERROR on known network failures -1 on other failures.
3351  */
3352 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data)
3353 {
3354         int res = 0;
3355         const struct ast_sockaddr *dst = sip_real_dst(p);
3356
3357         ast_debug(2, "Trying to put '%.11s' onto %s socket destined for %s\n", data->str, get_transport_pvt(p), ast_sockaddr_stringify(dst));
3358
3359         if (sip_prepare_socket(p) < 0) {
3360                 return XMIT_ERROR;
3361         }
3362
3363         if (p->socket.type == SIP_TRANSPORT_UDP) {
3364                 res = ast_sendto(p->socket.fd, data->str, ast_str_strlen(data), 0, dst);
3365         } else if (p->socket.tcptls_session) {
3366                 res = sip_tcptls_write(p->socket.tcptls_session, data->str, ast_str_strlen(data));
3367         } else {
3368                 ast_debug(2, "Socket type is TCP but no tcptls_session is present to write to\n");
3369                 return XMIT_ERROR;
3370         }
3371
3372         if (res == -1) {
3373                 switch (errno) {
3374                 case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
3375                 case EHOSTUNREACH:      /* Host can't be reached */
3376                 case ENETDOWN:          /* Interface down */
3377                 case ENETUNREACH:       /* Network failure */
3378                 case ECONNREFUSED:      /* ICMP port unreachable */
3379                         res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
3380                 }
3381         }
3382         if (res != ast_str_strlen(data)) {
3383                 ast_log(LOG_WARNING, "sip_xmit of %p (len %zu) to %s returned %d: %s\n", data, ast_str_strlen(data), ast_sockaddr_stringify(dst), res, strerror(errno));
3384         }
3385
3386         return res;
3387 }
3388
3389 /*! \brief Build a Via header for a request */
3390 static void build_via(struct sip_pvt *p)
3391 {
3392         /* Work around buggy UNIDEN UIP200 firmware */
3393         const char *rport = (ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) || ast_test_flag(&p->flags[0], SIP_NAT_RPORT_PRESENT)) ? ";rport" : "";
3394
3395         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
3396         snprintf(p->via, sizeof(p->via), "SIP/2.0/%s %s;branch=z9hG4bK%08x%s",
3397                  get_transport_pvt(p),
3398                  ast_sockaddr_stringify_remote(&p->ourip),
3399                  (int) p->branch, rport);
3400 }
3401
3402 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
3403  *
3404  * Using the localaddr structure built up with localnet statements in sip.conf
3405  * apply it to their address to see if we need to substitute our
3406  * externaddr or can get away with our internal bindaddr
3407  * 'us' is always overwritten.
3408  */
3409 static void ast_sip_ouraddrfor(const struct ast_sockaddr *them, struct ast_sockaddr *us, struct sip_pvt *p)
3410 {
3411         struct ast_sockaddr theirs;
3412
3413         /* Set want_remap to non-zero if we want to remap 'us' to an externally
3414          * reachable IP address and port. This is done if:
3415          * 1. we have a localaddr list (containing 'internal' addresses marked
3416          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
3417          *    and AST_SENSE_ALLOW on 'external' ones);
3418          * 2. externaddr is set, so we know what to use as the
3419          *    externally visible address;
3420          * 3. the remote address, 'them', is external;
3421          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
3422          *    when passed to ast_apply_ha() so it does need to be remapped.
3423          *    This fourth condition is checked later.
3424          */
3425         int want_remap = 0;
3426
3427         ast_sockaddr_copy(us, &internip); /* starting guess for the internal address */
3428         /* now ask the system what would it use to talk to 'them' */
3429         ast_ouraddrfor(them, us);
3430         ast_sockaddr_copy(&theirs, them);
3431
3432         if (ast_sockaddr_is_ipv6(&theirs)) {
3433                 if (localaddr && !ast_sockaddr_isnull(&externaddr)) {
3434                         ast_log(LOG_WARNING, "Address remapping activated in sip.conf "
3435                                 "but we're using IPv6, which doesn't need it. Please "
3436                                 "remove \"localnet\" and/or \"externaddr\" settings.\n");
3437                 }
3438         } else {
3439                 want_remap = localaddr &&
3440                         !ast_sockaddr_isnull(&externaddr) &&
3441                         ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
3442         }
3443
3444         if (want_remap &&
3445             (!sip_cfg.matchexternaddrlocally || !ast_apply_ha(localaddr, us)) ) {
3446                 /* if we used externhost, see if it is time to refresh the info */
3447                 if (externexpire && time(NULL) >= externexpire) {
3448                         if (ast_sockaddr_resolve_first(&externaddr, externhost, 0)) {
3449                                 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
3450                         }
3451                         externexpire = time(NULL) + externrefresh;
3452                 }
3453                 if (!ast_sockaddr_isnull(&externaddr)) {
3454                         ast_sockaddr_copy(us, &externaddr);
3455                         switch (p->socket.type) {
3456                         case SIP_TRANSPORT_TCP:
3457                                 if (!externtcpport && ast_sockaddr_port(&externaddr)) {
3458                                         /* for consistency, default to the externaddr port */
3459                                         externtcpport = ast_sockaddr_port(&externaddr);
3460                                 }
3461                                 ast_sockaddr_set_port(us, externtcpport);
3462                                 break;
3463                         case SIP_TRANSPORT_TLS:
3464                                 ast_sockaddr_set_port(us, externtlsport);
3465                                 break;
3466                         case SIP_TRANSPORT_UDP:
3467                                 if (!ast_sockaddr_port(&externaddr)) {
3468                                         ast_sockaddr_set_port(us, ast_sockaddr_port(&bindaddr));
3469                                 }
3470                                 break;
3471                         default:
3472                                 break;
3473                         }
3474                 }
3475                 ast_debug(1, "Target address %s is not local, substituting externaddr\n",
3476                           ast_sockaddr_stringify(them));
3477         } else if (p) {
3478                 /* no remapping, but we bind to a specific address, so use it. */
3479                 switch (p->socket.type) {
3480                 case SIP_TRANSPORT_TCP:
3481                         if (!ast_sockaddr_is_any(&sip_tcp_desc.local_address)) {
3482                                 ast_sockaddr_copy(us,
3483                                                   &sip_tcp_desc.local_address);
3484                         } else {
3485                                 ast_sockaddr_set_port(us,
3486                                                       ast_sockaddr_port(&sip_tcp_desc.local_address));
3487                         }
3488                         break;
3489                 case SIP_TRANSPORT_TLS:
3490                         if (!ast_sockaddr_is_any(&sip_tls_desc.local_address)) {
3491                                 ast_sockaddr_copy(us,
3492                                                   &sip_tls_desc.local_address);
3493                         } else {
3494                                 ast_sockaddr_set_port(us,
3495                                                       ast_sockaddr_port(&sip_tls_desc.local_address));
3496                         }
3497                         break;
3498                 case SIP_TRANSPORT_UDP:
3499                         /* fall through on purpose */
3500                 default:
3501                         if (!ast_sockaddr_is_any(&bindaddr)) {
3502                                 ast_sockaddr_copy(us, &bindaddr);
3503                         }
3504                         if (!ast_sockaddr_port(us)) {
3505                                 ast_sockaddr_set_port(us, ast_sockaddr_port(&bindaddr));
3506                         }
3507                 }
3508         } else if (!ast_sockaddr_is_any(&bindaddr)) {
3509                 ast_sockaddr_copy(us, &bindaddr);
3510         }
3511         ast_debug(3, "Setting SIP_TRANSPORT_%s with address %s\n", get_transport(p->socket.type), ast_sockaddr_stringify(us));
3512 }
3513
3514 /*! \brief Append to SIP dialog history with arg list  */
3515 static __attribute__((format(printf, 2, 0))) void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
3516 {
3517         char buf[80], *c = buf; /* max history length */
3518         struct sip_history *hist;
3519         int l;
3520
3521         vsnprintf(buf, sizeof(buf), fmt, ap);
3522         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
3523         l = strlen(buf) + 1;
3524         if (!(hist = ast_calloc(1, sizeof(*hist) + l))) {
3525                 return;
3526         }
3527         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
3528                 ast_free(hist);
3529                 return;
3530         }
3531         memcpy(hist->event, buf, l);
3532         if (p->history_entries == MAX_HISTORY_ENTRIES) {
3533                 struct sip_history *oldest;
3534                 oldest = AST_LIST_REMOVE_HEAD(p->history, list);
3535                 p->history_entries--;
3536                 ast_free(oldest);
3537         }
3538         AST_LIST_INSERT_TAIL(p->history, hist, list);
3539         p->history_entries++;
3540 }
3541
3542 /*! \brief Append to SIP dialog history with arg list  */
3543 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
3544 {
3545         va_list ap;
3546
3547         if (!p) {
3548                 return;
3549         }
3550
3551         if (!p->do_history && !recordhistory && !dumphistory) {
3552                 return;
3553         }
3554
3555         va_start(ap, fmt);
3556         append_history_va(p, fmt, ap);
3557         va_end(ap);