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