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