-----Changes -----
[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 #include "asterisk/lock.h"
221 #include "asterisk/config.h"
222 #include "asterisk/module.h"
223 #include "asterisk/pbx.h"
224 #include "asterisk/sched.h"
225 #include "asterisk/io.h"
226 #include "asterisk/rtp_engine.h"
227 #include "asterisk/udptl.h"
228 #include "asterisk/acl.h"
229 #include "asterisk/manager.h"
230 #include "asterisk/callerid.h"
231 #include "asterisk/cli.h"
232 #include "asterisk/musiconhold.h"
233 #include "asterisk/dsp.h"
234 #include "asterisk/features.h"
235 #include "asterisk/srv.h"
236 #include "asterisk/astdb.h"
237 #include "asterisk/causes.h"
238 #include "asterisk/utils.h"
239 #include "asterisk/file.h"
240 /*
241    Uncomment the define below,  if you are having refcount related memory leaks.
242    With this uncommented, this module will generate a file, /tmp/refs, which contains
243    a history of the ao2_ref() calls. To be useful, all calls to ao2_* functions should
244    be modified to ao2_t_* calls, and include a tag describing what is happening with
245    enough detail, to make pairing up a reference count increment with its corresponding decrement.
246    The refcounter program in utils/ can be invaluable in highlighting objects that are not
247    balanced, along with the complete history for that object.
248    In normal operation, the macros defined will throw away the tags, so they do not
249    affect the speed of the program at all. They can be considered to be documentation.
250 */
251 /* #define  REF_DEBUG 1 */
252 #include "asterisk/astobj2.h"
253 #include "asterisk/dnsmgr.h"
254 #include "asterisk/devicestate.h"
255 #include "asterisk/monitor.h"
256 #include "asterisk/netsock.h"
257 #include "asterisk/localtime.h"
258 #include "asterisk/abstract_jb.h"
259 #include "asterisk/threadstorage.h"
260 #include "asterisk/translate.h"
261 #include "asterisk/ast_version.h"
262 #include "asterisk/event.h"
263 #include "asterisk/stun.h"
264 #include "asterisk/cel.h"
265 #include "sip/include/sip.h"
266 #include "sip/include/config_parser.h"
267 #include "sip/include/reqresp_parser.h"
268 #include "sip/include/sip_utils.h"
269
270 /*** DOCUMENTATION
271         <application name="SIPDtmfMode" language="en_US">
272                 <synopsis>
273                         Change the dtmfmode for a SIP call.
274                 </synopsis>
275                 <syntax>
276                         <parameter name="mode" required="true">
277                                 <enumlist>
278                                         <enum name="inband" />
279                                         <enum name="info" />
280                                         <enum name="rfc2833" />
281                                 </enumlist>
282                         </parameter>
283                 </syntax>
284                 <description>
285                         <para>Changes the dtmfmode for a SIP call.</para>
286                 </description>
287         </application>
288         <application name="SIPAddHeader" language="en_US">
289                 <synopsis>
290                         Add a SIP header to the outbound call.
291                 </synopsis>
292                 <syntax argsep=":">
293                         <parameter name="Header" required="true" />
294                         <parameter name="Content" required="true" />
295                 </syntax>
296                 <description>
297                         <para>Adds a header to a SIP call placed with DIAL.</para>
298                         <para>Remember to use the X-header if you are adding non-standard SIP
299                         headers, like <literal>X-Asterisk-Accountcode:</literal>. Use this with care.
300                         Adding the wrong headers may jeopardize the SIP dialog.</para>
301                         <para>Always returns <literal>0</literal>.</para>
302                 </description>
303         </application>
304         <application name="SIPRemoveHeader" language="en_US">
305                 <synopsis>
306                         Remove SIP headers previously added with SIPAddHeader
307                 </synopsis>
308                 <syntax>
309                         <parameter name="Header" required="false" />
310                 </syntax>
311                 <description>
312                         <para>SIPRemoveHeader() allows you to remove headers which were previously
313                         added with SIPAddHeader(). If no parameter is supplied, all previously added
314                         headers will be removed. If a parameter is supplied, only the matching headers
315                         will be removed.</para>
316                         <para>For example you have added these 2 headers:</para>
317                         <para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
318                         <para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
319                         <para></para>
320                         <para>// remove all headers</para>
321                         <para>SIPRemoveHeader();</para>
322                         <para>// remove all P- headers</para>
323                         <para>SIPRemoveHeader(P-);</para>
324                         <para>// remove only the PAI header (note the : at the end)</para>
325                         <para>SIPRemoveHeader(P-Asserted-Identity:);</para>
326                         <para></para>
327                         <para>Always returns <literal>0</literal>.</para>
328                 </description>
329         </application>
330         <function name="SIP_HEADER" language="en_US">
331                 <synopsis>
332                         Gets the specified SIP header.
333                 </synopsis>
334                 <syntax>
335                         <parameter name="name" required="true" />
336                         <parameter name="number">
337                                 <para>If not specified, defaults to <literal>1</literal>.</para>
338                         </parameter>
339                 </syntax>
340                 <description>
341                         <para>Since there are several headers (such as Via) which can occur multiple
342                         times, SIP_HEADER takes an optional second argument to specify which header with
343                         that name to retrieve. Headers start at offset <literal>1</literal>.</para>
344                 </description>
345         </function>
346         <function name="SIPPEER" language="en_US">
347                 <synopsis>
348                         Gets SIP peer information.
349                 </synopsis>
350                 <syntax>
351                         <parameter name="peername" required="true" />
352                         <parameter name="item">
353                                 <enumlist>
354                                         <enum name="ip">
355                                                 <para>(default) The ip address.</para>
356                                         </enum>
357                                         <enum name="port">
358                                                 <para>The port number.</para>
359                                         </enum>
360                                         <enum name="mailbox">
361                                                 <para>The configured mailbox.</para>
362                                         </enum>
363                                         <enum name="context">
364                                                 <para>The configured context.</para>
365                                         </enum>
366                                         <enum name="expire">
367                                                 <para>The epoch time of the next expire.</para>
368                                         </enum>
369                                         <enum name="dynamic">
370                                                 <para>Is it dynamic? (yes/no).</para>
371                                         </enum>
372                                         <enum name="callerid_name">
373                                                 <para>The configured Caller ID name.</para>
374                                         </enum>
375                                         <enum name="callerid_num">
376                                                 <para>The configured Caller ID number.</para>
377                                         </enum>
378                                         <enum name="callgroup">
379                                                 <para>The configured Callgroup.</para>
380                                         </enum>
381                                         <enum name="pickupgroup">
382                                                 <para>The configured Pickupgroup.</para>
383                                         </enum>
384                                         <enum name="codecs">
385                                                 <para>The configured codecs.</para>
386                                         </enum>
387                                         <enum name="status">
388                                                 <para>Status (if qualify=yes).</para>
389                                         </enum>
390                                         <enum name="regexten">
391                                                 <para>Registration extension.</para>
392                                         </enum>
393                                         <enum name="limit">
394                                                 <para>Call limit (call-limit).</para>
395                                         </enum>
396                                         <enum name="busylevel">
397                                                 <para>Configured call level for signalling busy.</para>
398                                         </enum>
399                                         <enum name="curcalls">
400                                                 <para>Current amount of calls. Only available if call-limit is set.</para>
401                                         </enum>
402                                         <enum name="language">
403                                                 <para>Default language for peer.</para>
404                                         </enum>
405                                         <enum name="accountcode">
406                                                 <para>Account code for this peer.</para>
407                                         </enum>
408                                         <enum name="useragent">
409                                                 <para>Current user agent id for peer.</para>
410                                         </enum>
411                                         <enum name="chanvar[name]">
412                                                 <para>A channel variable configured with setvar for this peer.</para>
413                                         </enum>
414                                         <enum name="codec[x]">
415                                                 <para>Preferred codec index number <replaceable>x</replaceable> (beginning with zero).</para>
416                                         </enum>
417                                 </enumlist>
418                         </parameter>
419                 </syntax>
420                 <description />
421         </function>
422         <function name="SIPCHANINFO" language="en_US">
423                 <synopsis>
424                         Gets the specified SIP parameter from the current channel.
425                 </synopsis>
426                 <syntax>
427                         <parameter name="item" required="true">
428                                 <enumlist>
429                                         <enum name="peerip">
430                                                 <para>The IP address of the peer.</para>
431                                         </enum>
432                                         <enum name="recvip">
433                                                 <para>The source IP address of the peer.</para>
434                                         </enum>
435                                         <enum name="from">
436                                                 <para>The URI from the <literal>From:</literal> header.</para>
437                                         </enum>
438                                         <enum name="uri">
439                                                 <para>The URI from the <literal>Contact:</literal> header.</para>
440                                         </enum>
441                                         <enum name="useragent">
442                                                 <para>The useragent.</para>
443                                         </enum>
444                                         <enum name="peername">
445                                                 <para>The name of the peer.</para>
446                                         </enum>
447                                         <enum name="t38passthrough">
448                                                 <para><literal>1</literal> if T38 is offered or enabled in this channel,
449                                                 otherwise <literal>0</literal>.</para>
450                                         </enum>
451                                 </enumlist>
452                         </parameter>
453                 </syntax>
454                 <description />
455         </function>
456         <function name="CHECKSIPDOMAIN" language="en_US">
457                 <synopsis>
458                         Checks if domain is a local domain.
459                 </synopsis>
460                 <syntax>
461                         <parameter name="domain" required="true" />
462                 </syntax>
463                 <description>
464                         <para>This function checks if the <replaceable>domain</replaceable> in the argument is configured
465                         as a local SIP domain that this Asterisk server is configured to handle.
466                         Returns the domain name if it is locally handled, otherwise an empty string.
467                         Check the <literal>domain=</literal> configuration in <filename>sip.conf</filename>.</para>
468                 </description>
469         </function>
470         <manager name="SIPpeers" language="en_US">
471                 <synopsis>
472                         List SIP peers (text format).
473                 </synopsis>
474                 <syntax>
475                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
476                 </syntax>
477                 <description>
478                         <para>Lists SIP peers in text format with details on current status.
479                         Peerlist will follow as separate events, followed by a final event called
480                         PeerlistComplete.</para>
481                 </description>
482         </manager>
483         <manager name="SIPshowpeer" language="en_US">
484                 <synopsis>
485                         show SIP peer (text format).
486                 </synopsis>
487                 <syntax>
488                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
489                         <parameter name="Peer" required="true">
490                                 <para>The peer name you want to check.</para>
491                         </parameter>
492                 </syntax>
493                 <description>
494                         <para>Show one SIP peer with details on current status.</para>
495                 </description>
496         </manager>
497         <manager name="SIPqualifypeer" language="en_US">
498                 <synopsis>
499                         Qualify SIP peers.
500                 </synopsis>
501                 <syntax>
502                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
503                         <parameter name="Peer" required="true">
504                                 <para>The peer name you want to qualify.</para>
505                         </parameter>
506                 </syntax>
507                 <description>
508                         <para>Qualify a SIP peer.</para>
509                 </description>
510         </manager>
511         <manager name="SIPshowregistry" language="en_US">
512                 <synopsis>
513                         Show SIP registrations (text format).
514                 </synopsis>
515                 <syntax>
516                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
517                 </syntax>
518                 <description>
519                         <para>Lists all registration requests and status. Registrations will follow as separate
520                         events. followed by a final event called RegistrationsComplete.</para>
521                 </description>
522         </manager>
523         <manager name="SIPnotify" language="en_US">
524                 <synopsis>
525                         Send a SIP notify.
526                 </synopsis>
527                 <syntax>
528                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
529                         <parameter name="Channel" required="true">
530                                 <para>Peer to receive the notify.</para>
531                         </parameter>
532                         <parameter name="Variable" required="true">
533                                 <para>At least one variable pair must be specified.
534                                 <replaceable>name</replaceable>=<replaceable>value</replaceable></para>
535                         </parameter>
536                 </syntax>
537                 <description>
538                         <para>Sends a SIP Notify event.</para>
539                         <para>All parameters for this event must be specified in the body of this request
540                         via multiple Variable: name=value sequences.</para>
541                 </description>
542         </manager>
543  ***/
544
545 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
546 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
547 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
548 static int mwi_expiry = DEFAULT_MWI_EXPIRY;
549
550 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
551 static struct ast_jb_conf default_jbconf =
552 {
553         .flags = 0,
554         .max_size = -1,
555         .resync_threshold = -1,
556         .impl = ""
557 };
558 static struct ast_jb_conf global_jbconf;                /*!< Global jitterbuffer configuration */
559
560 static const char config[] = "sip.conf";                /*!< Main configuration file */
561 static const char notify_config[] = "sip_notify.conf";  /*!< Configuration file for sending Notify with CLI commands to reconfigure or reboot phones */
562
563 /*! \brief Readable descriptions of device states.
564  *  \note Should be aligned to above table as index */
565 static const struct invstate2stringtable {
566         const enum invitestates state;
567         const char *desc;
568 } invitestate2string[] = {
569         {INV_NONE,              "None"  },
570         {INV_CALLING,           "Calling (Trying)"},
571         {INV_PROCEEDING,        "Proceeding "},
572         {INV_EARLY_MEDIA,       "Early media"},
573         {INV_COMPLETED,         "Completed (done)"},
574         {INV_CONFIRMED,         "Confirmed (up)"},
575         {INV_TERMINATED,        "Done"},
576         {INV_CANCELLED,         "Cancelled"}
577 };
578
579 /*! \brief Subscription types that we support. We support
580  * - dialoginfo updates (really device status, not dialog info as was the original intent of the standard)
581  * - SIMPLE presence used for device status
582  * - Voicemail notification subscriptions
583  */
584 static const struct cfsubscription_types {
585         enum subscriptiontype type;
586         const char * const event;
587         const char * const mediatype;
588         const char * const text;
589 } subscription_types[] = {
590         { NONE,            "-",        "unknown",                    "unknown" },
591         /* RFC 4235: SIP Dialog event package */
592         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
593         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
594         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
595         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
596         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
597 };
598
599 /*! \brief The core structure to setup dialogs. We parse incoming messages by using
600  *  structure and then route the messages according to the type.
601  *
602  *  \note Note that sip_methods[i].id == i must hold or the code breaks
603  */
604 static const struct  cfsip_methods {
605         enum sipmethod id;
606         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
607         char * const text;
608         enum can_create_dialog can_create;
609 } sip_methods[] = {
610         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",CAN_CREATE_DIALOG },
611         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",  CAN_NOT_CREATE_DIALOG },
612         { SIP_REGISTER,  NO_RTP, "REGISTER", CAN_CREATE_DIALOG },
613         { SIP_OPTIONS,   NO_RTP, "OPTIONS",  CAN_CREATE_DIALOG },
614         { SIP_NOTIFY,    NO_RTP, "NOTIFY",   CAN_CREATE_DIALOG },
615         { SIP_INVITE,    RTP,    "INVITE",   CAN_CREATE_DIALOG },
616         { SIP_ACK,       NO_RTP, "ACK",      CAN_NOT_CREATE_DIALOG },
617         { SIP_PRACK,     NO_RTP, "PRACK",    CAN_NOT_CREATE_DIALOG },
618         { SIP_BYE,       NO_RTP, "BYE",      CAN_NOT_CREATE_DIALOG },
619         { SIP_REFER,     NO_RTP, "REFER",    CAN_CREATE_DIALOG },
620         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",CAN_CREATE_DIALOG },
621         { SIP_MESSAGE,   NO_RTP, "MESSAGE",  CAN_CREATE_DIALOG },
622         { SIP_UPDATE,    NO_RTP, "UPDATE",   CAN_NOT_CREATE_DIALOG },
623         { SIP_INFO,      NO_RTP, "INFO",     CAN_NOT_CREATE_DIALOG },
624         { SIP_CANCEL,    NO_RTP, "CANCEL",   CAN_NOT_CREATE_DIALOG },
625         { SIP_PUBLISH,   NO_RTP, "PUBLISH",  CAN_CREATE_DIALOG_UNSUPPORTED_METHOD },
626         { SIP_PING,      NO_RTP, "PING",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
627 };
628
629 /*! \brief List of well-known SIP options. If we get this in a require,
630    we should check the list and answer accordingly. */
631 static const struct cfsip_options {
632         int id;             /*!< Bitmap ID */
633         int supported;      /*!< Supported by Asterisk ? */
634         char * const text;  /*!< Text id, as in standard */
635 } sip_options[] = {     /* XXX used in 3 places */
636         /* RFC3262: PRACK 100% reliability */
637         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },
638         /* RFC3959: SIP Early session support */
639         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
640         /* SIMPLE events:  RFC4662 */
641         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
642         /* RFC 4916- Connected line ID updates */
643         { SIP_OPT_FROMCHANGE,   NOT_SUPPORTED,  "from-change" },
644         /* GRUU: Globally Routable User Agent URI's */
645         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
646         /* RFC4244 History info */
647         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
648         /* RFC3911: SIP Join header support */
649         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
650         /* Disable the REFER subscription, RFC 4488 */
651         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
652         /* SIP outbound - the final NAT battle - draft-sip-outbound */
653         { SIP_OPT_OUTBOUND,     NOT_SUPPORTED,  "outbound" },
654         /* RFC3327: Path support */
655         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
656         /* RFC3840: Callee preferences */
657         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
658         /* RFC3312: Precondition support */
659         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
660         /* RFC3323: Privacy with proxies*/
661         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
662         /* RFC-ietf-sip-uri-list-conferencing-02.txt conference invite lists */
663         { SIP_OPT_RECLISTINV,   NOT_SUPPORTED,  "recipient-list-invite" },
664         /* RFC-ietf-sip-uri-list-subscribe-02.txt - subscription lists */
665         { SIP_OPT_RECLISTSUB,   NOT_SUPPORTED,  "recipient-list-subscribe" },
666         /* RFC3891: Replaces: header for transfer */
667         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },
668         /* One version of Polycom firmware has the wrong label */
669         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },
670         /* RFC4412 Resource priorities */
671         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
672         /* RFC3329: Security agreement mechanism */
673         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
674         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
675         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
676         /* RFC4028: SIP Session-Timers */
677         { SIP_OPT_TIMER,        SUPPORTED,      "timer" },
678         /* RFC4538: Target-dialog */
679         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
680 };
681
682 /*! \brief Diversion header reasons
683  *
684  * The core defines a bunch of constants used to define
685  * redirecting reasons. This provides a translation table
686  * between those and the strings which may be present in
687  * a SIP Diversion header
688  */
689 static const struct sip_reasons {
690         enum AST_REDIRECTING_REASON code;
691         char * const text;
692 } sip_reason_table[] = {
693         { AST_REDIRECTING_REASON_UNKNOWN, "unknown" },
694         { AST_REDIRECTING_REASON_USER_BUSY, "user-busy" },
695         { AST_REDIRECTING_REASON_NO_ANSWER, "no-answer" },
696         { AST_REDIRECTING_REASON_UNAVAILABLE, "unavailable" },
697         { AST_REDIRECTING_REASON_UNCONDITIONAL, "unconditional" },
698         { AST_REDIRECTING_REASON_TIME_OF_DAY, "time-of-day" },
699         { AST_REDIRECTING_REASON_DO_NOT_DISTURB, "do-not-disturb" },
700         { AST_REDIRECTING_REASON_DEFLECTION, "deflection" },
701         { AST_REDIRECTING_REASON_FOLLOW_ME, "follow-me" },
702         { AST_REDIRECTING_REASON_OUT_OF_ORDER, "out-of-service" },
703         { AST_REDIRECTING_REASON_AWAY, "away" },
704         { AST_REDIRECTING_REASON_CALL_FWD_DTE, "unknown"}
705 };
706
707
708 /*! \name DefaultSettings
709         Default setttings are used as a channel setting and as a default when
710         configuring devices
711 */
712 /*@{*/
713 static char default_language[MAX_LANGUAGE];      /*!< Default language setting for new channels */
714 static char default_callerid[AST_MAX_EXTENSION]; /*!< Default caller ID for sip messages */
715 static char default_mwi_from[80];                /*!< Default caller ID for MWI updates */
716 static char default_fromdomain[AST_MAX_EXTENSION]; /*!< Default domain on outound messages */
717 static char default_notifymime[AST_MAX_EXTENSION]; /*!< Default MIME media type for MWI notify messages */
718 static char default_vmexten[AST_MAX_EXTENSION];    /*!< Default From Username on MWI updates */
719 static int default_qualify;                        /*!< Default Qualify= setting */
720 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
721 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting
722                                                     *   a bridged channel on hold */
723 static char default_parkinglot[AST_MAX_CONTEXT];   /*!< Parkinglot */
724 static char default_engine[256];                   /*!< Default RTP engine */
725 static int default_maxcallbitrate;                 /*!< Maximum bitrate for call */
726 static struct ast_codec_pref default_prefs;        /*!< Default codec prefs */
727 static unsigned int default_transports;            /*!< Default Transports (enum sip_transport) that are acceptable */
728 static unsigned int default_primary_transport;     /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
729 /*@}*/
730
731 static struct sip_settings sip_cfg;             /*!< SIP configuration data.
732                                         \note in the future we could have multiple of these (per domain, per device group etc) */
733
734 /*!< use this macro when ast_uri_decode is dependent on pedantic checking to be on. */
735 #define SIP_PEDANTIC_DECODE(str)        \
736         if (sip_cfg.pedanticsipchecking && !ast_strlen_zero(str)) {     \
737                 ast_uri_decode(str);    \
738         }       \
739
740 static unsigned int chan_idx;       /*!< used in naming sip channel */
741 static int global_match_auth_username;    /*!< Match auth username if available instead of From: Default off. */
742
743 static int global_relaxdtmf;        /*!< Relax DTMF */
744 static int global_prematuremediafilter;   /*!< Enable/disable premature frames in a call (causing 183 early media) */
745 static int global_rtptimeout;       /*!< Time out call if no RTP */
746 static int global_rtpholdtimeout;   /*!< Time out call if no RTP during hold */
747 static int global_rtpkeepalive;     /*!< Send RTP keepalives */
748 static int global_reg_timeout;      /*!< Global time between attempts for outbound registrations */
749 static int global_regattempts_max;  /*!< Registration attempts before giving up */
750 static int global_shrinkcallerid;   /*!< enable or disable shrinking of caller id  */
751 static int global_callcounter;      /*!< Enable call counters for all devices. This is currently enabled by setting the peer
752                                      *   call-limit to INT_MAX. When we remove the call-limit from the code, we can make it
753                                      *   with just a boolean flag in the device structure */
754 static unsigned int global_tos_sip;      /*!< IP type of service for SIP packets */
755 static unsigned int global_tos_audio;    /*!< IP type of service for audio RTP packets */
756 static unsigned int global_tos_video;    /*!< IP type of service for video RTP packets */
757 static unsigned int global_tos_text;     /*!< IP type of service for text RTP packets */
758 static unsigned int global_cos_sip;      /*!< 802.1p class of service for SIP packets */
759 static unsigned int global_cos_audio;    /*!< 802.1p class of service for audio RTP packets */
760 static unsigned int global_cos_video;    /*!< 802.1p class of service for video RTP packets */
761 static unsigned int global_cos_text;     /*!< 802.1p class of service for text RTP packets */
762 static unsigned int recordhistory;       /*!< Record SIP history. Off by default */
763 static unsigned int dumphistory;         /*!< Dump history to verbose before destroying SIP dialog */
764 static char global_useragent[AST_MAX_EXTENSION];    /*!< Useragent for the SIP channel */
765 static char global_sdpsession[AST_MAX_EXTENSION];   /*!< SDP session name for the SIP channel */
766 static char global_sdpowner[AST_MAX_EXTENSION];     /*!< SDP owner name for the SIP channel */
767 static int global_authfailureevents;     /*!< Whether we send authentication failure manager events or not. Default no. */
768 static int global_t1;           /*!< T1 time */
769 static int global_t1min;        /*!< T1 roundtrip time minimum */
770 static int global_timer_b;      /*!< Timer B - RFC 3261 Section 17.1.1.2 */
771 static unsigned int global_autoframing; /*!< Turn autoframing on or off. */
772 static int global_qualifyfreq;          /*!< Qualify frequency */
773 static int global_qualify_gap;          /*!< Time between our group of peer pokes */
774 static int global_qualify_peers;        /*!< Number of peers to poke at a given time */
775
776 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
777 static enum st_refresher global_st_refresher; /*!< Session-Timer refresher                        */
778 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
779 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
780
781 static int global_dynamic_exclude_static = 0; /*!< Exclude static peers from contact registrations */
782 /*@}*/
783
784 /*! \name Object counters @{
785  *  \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
786  *  should be used to modify these values. */
787 static int speerobjs = 0;     /*!< Static peers */
788 static int rpeerobjs = 0;     /*!< Realtime peers */
789 static int apeerobjs = 0;     /*!< Autocreated peer objects */
790 static int regobjs = 0;       /*!< Registry objects */
791 /* }@ */
792
793 static struct ast_flags global_flags[2] = {{0}};  /*!< global SIP_ flags */
794 static int global_t38_maxdatagram;                /*!< global T.38 FaxMaxDatagram override */
795
796 static char used_context[AST_MAX_CONTEXT];        /*!< name of automatically created context for unloading */
797
798 AST_MUTEX_DEFINE_STATIC(netlock);
799
800 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
801    when it's doing something critical. */
802 AST_MUTEX_DEFINE_STATIC(monlock);
803
804 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
805
806 /*! \brief This is the thread for the monitor which checks for input on the channels
807    which are not currently in use.  */
808 static pthread_t monitor_thread = AST_PTHREADT_NULL;
809
810 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
811 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
812
813 static struct sched_context *sched;     /*!< The scheduling context */
814 static struct io_context *io;           /*!< The IO context */
815 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
816 struct sip_pkt;
817 static AST_LIST_HEAD_STATIC(domain_list, domain);    /*!< The SIP domain list */
818
819 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
820
821 static enum sip_debug_e sipdebug;
822
823 /*! \brief extra debugging for 'text' related events.
824  *  At the moment this is set together with sip_debug_console.
825  *  \note It should either go away or be implemented properly.
826  */
827 static int sipdebug_text;
828
829 static const struct _map_x_s referstatusstrings[] = {
830         { REFER_IDLE,      "<none>" },
831         { REFER_SENT,      "Request sent" },
832         { REFER_RECEIVED,  "Request received" },
833         { REFER_CONFIRMED, "Confirmed" },
834         { REFER_ACCEPTED,  "Accepted" },
835         { REFER_RINGING,   "Target ringing" },
836         { REFER_200OK,     "Done" },
837         { REFER_FAILED,    "Failed" },
838         { REFER_NOAUTH,    "Failed - auth failure" },
839         { -1,               NULL} /* terminator */
840 };
841
842 /* --- Hash tables of various objects --------*/
843 #ifdef LOW_MEMORY
844 static int hash_peer_size = 17;
845 static int hash_dialog_size = 17;
846 static int hash_user_size = 17;
847 #else
848 static int hash_peer_size = 563;        /*!< Size of peer hash table, prime number preferred! */
849 static int hash_dialog_size = 563;
850 static int hash_user_size = 563;
851 #endif
852
853 /*! \brief
854  * Here we implement the container for dialogs (sip_pvt), defining
855  * generic wrapper functions to ease the transition from the current
856  * implementation (a single linked list) to a different container.
857  * In addition to a reference to the container, we need functions to lock/unlock
858  * the container and individual items, and functions to add/remove
859  * references to the individual items.
860  */
861 static struct ao2_container *dialogs;
862 #define sip_pvt_lock(x) ao2_lock(x)
863 #define sip_pvt_trylock(x) ao2_trylock(x)
864 #define sip_pvt_unlock(x) ao2_unlock(x)
865
866 /*! \brief  The table of TCP threads */
867 static struct ao2_container *threadt;
868
869 /*! \brief  The peer list: Users, Peers and Friends */
870 static struct ao2_container *peers;
871 static struct ao2_container *peers_by_ip;
872
873 /*! \brief  The register list: Other SIP proxies we register with and receive calls from */
874 static struct ast_register_list {
875         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
876         int recheck;
877 } regl;
878
879 /*! \brief  The MWI subscription list */
880 static struct ast_subscription_mwi_list {
881         ASTOBJ_CONTAINER_COMPONENTS(struct sip_subscription_mwi);
882 } submwil;
883 static int temp_pvt_init(void *);
884 static void temp_pvt_cleanup(void *);
885
886 /*! \brief A per-thread temporary pvt structure */
887 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
888
889 /*! \brief Authentication list for realm authentication
890  * \todo Move the sip_auth list to AST_LIST */
891 static struct sip_auth *authl = NULL;
892
893 /* --- Sockets and networking --------------*/
894
895 /*! \brief Main socket for UDP SIP communication.
896  *
897  * sipsock is shared between the SIP manager thread (which handles reload
898  * requests), the udp io handler (sipsock_read()) and the user routines that
899  * issue udp writes (using __sip_xmit()).
900  * The socket is -1 only when opening fails (this is a permanent condition),
901  * or when we are handling a reload() that changes its address (this is
902  * a transient situation during which we might have a harmless race, see
903  * below). Because the conditions for the race to be possible are extremely
904  * rare, we don't want to pay the cost of locking on every I/O.
905  * Rather, we remember that when the race may occur, communication is
906  * bound to fail anyways, so we just live with this event and let
907  * the protocol handle this above us.
908  */
909 static int sipsock  = -1;
910
911 static struct sockaddr_in bindaddr;     /*!< UDP: The address we bind to */
912
913 /*! \brief our (internal) default address/port to put in SIP/SDP messages
914  *  internip is initialized picking a suitable address from one of the
915  * interfaces, and the same port number we bind to. It is used as the
916  * default address/port in SIP messages, and as the default address
917  * (but not port) in SDP messages.
918  */
919 static struct sockaddr_in internip;
920
921 /*! \brief our external IP address/port for SIP sessions.
922  * externip.sin_addr is only set when we know we might be behind
923  * a NAT, and this is done using a variety of (mutually exclusive)
924  * ways from the config file:
925  *
926  * + with "externip = host[:port]" we specify the address/port explicitly.
927  *   The address is looked up only once when (re)loading the config file;
928  *
929  * + with "externhost = host[:port]" we do a similar thing, but the
930  *   hostname is stored in externhost, and the hostname->IP mapping
931  *   is refreshed every 'externrefresh' seconds;
932  *
933  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
934  *   to the specified server, and store the result in externip.
935  *
936  * Other variables (externhost, externexpire, externrefresh) are used
937  * to support the above functions.
938  */
939 static struct sockaddr_in externip;       /*!< External IP address if we are behind NAT */
940 static struct sockaddr_in media_address;  /*!< External RTP IP address if we are behind NAT */
941
942 static char externhost[MAXHOSTNAMELEN];   /*!< External host name */
943 static time_t externexpire;             /*!< Expiration counter for re-resolving external host name in dynamic DNS */
944 static int externrefresh = 10;          /*!< Refresh timer for DNS-based external address (dyndns) */
945 static struct sockaddr_in stunaddr;     /*!< stun server address */
946 static uint16_t externtcpport;          /*!< external tcp port */ 
947 static uint16_t externtlsport;          /*!< external tls port */
948
949 /*! \brief  List of local networks
950  * We store "localnet" addresses from the config file into an access list,
951  * marked as 'DENY', so the call to ast_apply_ha() will return
952  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
953  * (i.e. presumably public) addresses.
954  */
955 static struct ast_ha *localaddr;    /*!< List of local networks, on the same side of NAT as this Asterisk */
956
957 static int ourport_tcp;             /*!< The port used for TCP connections */
958 static int ourport_tls;             /*!< The port used for TCP/TLS connections */
959 static struct sockaddr_in debugaddr;
960
961 static struct ast_config *notify_types = NULL;    /*!< The list of manual NOTIFY types we know how to send */
962
963 /*! some list management macros. */
964
965 #define UNLINK(element, head, prev) do {        \
966         if (prev)                               \
967                 (prev)->next = (element)->next; \
968         else                                    \
969                 (head) = (element)->next;       \
970         } while (0)
971
972 /*---------------------------- Forward declarations of functions in chan_sip.c */
973 /* Note: This is added to help splitting up chan_sip.c into several files
974         in coming releases. */
975
976 /*--- PBX interface functions */
977 static struct ast_channel *sip_request_call(const char *type, format_t format, const struct ast_channel *requestor, void *data, int *cause);
978 static int sip_devicestate(void *data);
979 static int sip_sendtext(struct ast_channel *ast, const char *text);
980 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
981 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
982 static int sip_hangup(struct ast_channel *ast);
983 static int sip_answer(struct ast_channel *ast);
984 static struct ast_frame *sip_read(struct ast_channel *ast);
985 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
986 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
987 static int sip_transfer(struct ast_channel *ast, const char *dest);
988 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
989 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
990 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
991 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
992 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
993 static const char *sip_get_callid(struct ast_channel *chan);
994
995 static int handle_request_do(struct sip_request *req, struct sockaddr_in *sin);
996 static int sip_standard_port(enum sip_transport type, int port);
997 static int sip_prepare_socket(struct sip_pvt *p);
998
999 /*--- Transmitting responses and requests */
1000 static int sipsock_read(int *id, int fd, short events, void *ignore);
1001 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len);
1002 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod);
1003 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1004 static int retrans_pkt(const void *data);
1005 static int transmit_response_using_temp(ast_string_field callid, struct sockaddr_in *sin, int useglobal_nat, const int intended_method, const struct sip_request *req, const char *msg);
1006 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1007 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1008 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1009 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);
1010 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1011 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);
1012 static int transmit_provisional_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, int with_sdp);
1013 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1014 static void transmit_fake_auth_response(struct sip_pvt *p, int sipmethod, struct sip_request *req, enum xmittype reliable);
1015 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1016 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1017 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1018 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
1019 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1020 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1021 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1022 static int transmit_refer(struct sip_pvt *p, const char *dest);
1023 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
1024 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1025 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1026 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1027 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1028 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1029 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1030 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
1031 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1032
1033 /*--- Dialog management */
1034 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1035                                  int useglobal_nat, const int intended_method, struct sip_request *req);
1036 static int __sip_autodestruct(const void *data);
1037 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1038 static int sip_cancel_destroy(struct sip_pvt *p);
1039 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
1040 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist);
1041 static void *registry_unref(struct sip_registry *reg, char *tag);
1042 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1043 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1044 static void __sip_pretend_ack(struct sip_pvt *p);
1045 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1046 static int auto_congest(const void *arg);
1047 static int update_call_counter(struct sip_pvt *fup, int event);
1048 static int hangup_sip2cause(int cause);
1049 static const char *hangup_cause2sip(int cause);
1050 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1051 static void free_old_route(struct sip_route *route);
1052 static void list_route(struct sip_route *route);
1053 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1054 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1055                                               struct sip_request *req, const char *uri);
1056 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1057 static void check_pendings(struct sip_pvt *p);
1058 static void *sip_park_thread(void *stuff);
1059 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1060 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1061 static int is_method_allowed(unsigned int *allowed_methods, enum sipmethod method);
1062
1063 /*--- Codec handling / SDP */
1064 static void try_suggested_sip_codec(struct sip_pvt *p);
1065 static const char *get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1066 static char get_sdp_line(int *start, int stop, struct sip_request *req, const char **value);
1067 static int find_sdp(struct sip_request *req);
1068 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
1069 static int process_sdp_o(const char *o, struct sip_pvt *p);
1070 static int process_sdp_c(const char *c, struct ast_hostent *hp);
1071 static int process_sdp_a_sendonly(const char *a, int *sendonly);
1072 static int process_sdp_a_audio(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newaudiortp, int *last_rtpmap_codec);
1073 static int process_sdp_a_video(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newvideortp, int *last_rtpmap_codec);
1074 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);
1075 static int process_sdp_a_image(const char *a, struct sip_pvt *p);
1076 static void add_codec_to_sdp(const struct sip_pvt *p, format_t codec,
1077                              struct ast_str **m_buf, struct ast_str **a_buf,
1078                              int debug, int *min_packet_size);
1079 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
1080                                 struct ast_str **m_buf, struct ast_str **a_buf,
1081                                 int debug);
1082 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
1083 static void do_setnat(struct sip_pvt *p);
1084 static void stop_media_flows(struct sip_pvt *p);
1085
1086 /*--- Authentication stuff */
1087 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1088 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1089 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1090                                          const char *secret, const char *md5secret, int sipmethod,
1091                                          const char *uri, enum xmittype reliable, int ignore);
1092 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1093                                               int sipmethod, const char *uri, enum xmittype reliable,
1094                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1095 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1096
1097 /*--- Domain handling */
1098 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1099 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1100 static void clear_sip_domains(void);
1101
1102 /*--- SIP realm authentication */
1103 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
1104 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1105 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1106
1107 /*--- Misc functions */
1108 static void check_rtp_timeout(struct sip_pvt *dialog, time_t t);
1109 static int sip_do_reload(enum channelreloadreason reason);
1110 static int reload_config(enum channelreloadreason reason);
1111 static int expire_register(const void *data);
1112 static void *do_monitor(void *data);
1113 static int restart_monitor(void);
1114 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
1115 static struct ast_variable *copy_vars(struct ast_variable *src);
1116 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
1117 static int sip_refer_allocate(struct sip_pvt *p);
1118 static int sip_notify_allocate(struct sip_pvt *p);
1119 static void ast_quiet_chan(struct ast_channel *chan);
1120 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1121 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
1122
1123 /*--- Device monitoring and Device/extension state/event handling */
1124 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1125 static int sip_devicestate(void *data);
1126 static int sip_poke_noanswer(const void *data);
1127 static int sip_poke_peer(struct sip_peer *peer, int force);
1128 static void sip_poke_all_peers(void);
1129 static void sip_peer_hold(struct sip_pvt *p, int hold);
1130 static void mwi_event_cb(const struct ast_event *, void *);
1131
1132 /*--- Applications, functions, CLI and manager command helpers */
1133 static const char *sip_nat_mode(const struct sip_pvt *p);
1134 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1135 static char *transfermode2str(enum transfermodes mode) attribute_const;
1136 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1137 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1138 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1139 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1140 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1141 static void  print_group(int fd, ast_group_t group, int crlf);
1142 static const char *dtmfmode2str(int mode) attribute_const;
1143 static int str2dtmfmode(const char *str) attribute_unused;
1144 static const char *insecure2str(int mode) attribute_const;
1145 static void cleanup_stale_contexts(char *new, char *old);
1146 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1147 static const char *domain_mode_to_text(const enum domain_mode mode);
1148 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1149 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1150 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1151 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1152 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1153 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1154 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1155 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1156 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1157 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1158 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1159 static char *complete_sip_peer(const char *word, int state, int flags2);
1160 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1161 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1162 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1163 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1164 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1165 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1166 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1167 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1168 static char *sip_do_debug_ip(int fd, const char *arg);
1169 static char *sip_do_debug_peer(int fd, const char *arg);
1170 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1171 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1172 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1173 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
1174 static int sip_addheader(struct ast_channel *chan, const char *data);
1175 static int sip_do_reload(enum channelreloadreason reason);
1176 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1177 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1178
1179 /*--- Debugging
1180         Functions for enabling debug per IP or fully, or enabling history logging for
1181         a SIP dialog
1182 */
1183 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1184 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1185 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1186 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1187 static void sip_dump_history(struct sip_pvt *dialog);
1188
1189 /*--- Device object handling */
1190 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime, int devstate_only);
1191 static int update_call_counter(struct sip_pvt *fup, int event);
1192 static void sip_destroy_peer(struct sip_peer *peer);
1193 static void sip_destroy_peer_fn(void *peer);
1194 static void set_peer_defaults(struct sip_peer *peer);
1195 static struct sip_peer *temp_peer(const char *name);
1196 static void register_peer_exten(struct sip_peer *peer, int onoff);
1197 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime, int forcenamematch, int devstate_only, int transport);
1198 static int sip_poke_peer_s(const void *data);
1199 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1200 static void reg_source_db(struct sip_peer *peer);
1201 static void destroy_association(struct sip_peer *peer);
1202 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1203 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1204 static void set_socket_transport(struct sip_socket *socket, int transport);
1205
1206 /* Realtime device support */
1207 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, const char *useragent, int expirey, unsigned short deprecated_username, int lastms);
1208 static void update_peer(struct sip_peer *p, int expire);
1209 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1210 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
1211 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin, int devstate_only);
1212 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1213
1214 /*--- Internal UA client handling (outbound registrations) */
1215 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us, struct sip_pvt *p);
1216 static void sip_registry_destroy(struct sip_registry *reg);
1217 static int sip_register(const char *value, int lineno);
1218 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1219 static int sip_reregister(const void *data);
1220 static int __sip_do_register(struct sip_registry *r);
1221 static int sip_reg_timeout(const void *data);
1222 static void sip_send_all_registers(void);
1223 static int sip_reinvite_retry(const void *data);
1224
1225 /*--- Parsing SIP requests and responses */
1226 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1227 static int determine_firstline_parts(struct sip_request *req);
1228 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1229 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1230 static int find_sip_method(const char *msg);
1231 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1232 static unsigned int parse_allowed_methods(struct sip_request *req);
1233 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
1234 static int parse_request(struct sip_request *req);
1235 static const char *get_header(const struct sip_request *req, const char *name);
1236 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1237 static int method_match(enum sipmethod id, const char *name);
1238 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1239 static char *get_in_brackets(char *tmp);
1240 static const char *find_alias(const char *name, const char *_default);
1241 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1242 static int lws2sws(char *msgbuf, int len);
1243 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1244 static char *remove_uri_parameters(char *uri);
1245 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1246 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1247 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1248 static int set_address_from_contact(struct sip_pvt *pvt);
1249 static void check_via(struct sip_pvt *p, struct sip_request *req);
1250 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
1251 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason);
1252 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1253 static int get_msg_text(char *buf, int len, struct sip_request *req, int addnewline);
1254 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1255 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
1256 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
1257 static void change_redirecting_information(struct sip_pvt *p, struct sip_request *req, struct ast_party_redirecting *redirecting, int set_call_forward);
1258 static int get_domain(const char *str, char *domain, int len);
1259 static void get_realm(struct sip_pvt *p, const struct sip_request *req);
1260
1261 /*-- TCP connection handling ---*/
1262 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session);
1263 static void *sip_tcp_worker_fn(void *);
1264
1265 /*--- Constructing requests and responses */
1266 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1267 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1268 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1269 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1270 static int init_resp(struct sip_request *resp, const char *msg);
1271 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
1272 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1273 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1274 static void build_via(struct sip_pvt *p);
1275 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1276 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct sockaddr_in *sin, int newdialog);
1277 static char *generate_random_string(char *buf, size_t size);
1278 static void build_callid_pvt(struct sip_pvt *pvt);
1279 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1280 static void make_our_tag(char *tagbuf, size_t len);
1281 static int add_header(struct sip_request *req, const char *var, const char *value);
1282 static int add_header_contentLength(struct sip_request *req, int len);
1283 static int add_line(struct sip_request *req, const char *line);
1284 static int add_text(struct sip_request *req, const char *text);
1285 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1286 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
1287 static int add_vidupdate(struct sip_request *req);
1288 static void add_route(struct sip_request *req, struct sip_route *route);
1289 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1290 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1291 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1292 static void set_destination(struct sip_pvt *p, char *uri);
1293 static void append_date(struct sip_request *req);
1294 static void build_contact(struct sip_pvt *p);
1295
1296 /*------Request handling functions */
1297 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1298 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
1299 static int handle_request_invite(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *recount, const char *e, int *nounlock);
1300 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1301 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1302 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, const char *e);
1303 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1304 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1305 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
1306 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1307 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1308 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *nounlock);
1309 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
1310 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno, int *nounlock);
1311
1312 /*------Response handling functions */
1313 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1314 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1315 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1316 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1317 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1318 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1319
1320 /*------ T38 Support --------- */
1321 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1322 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1323 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1324 static void change_t38_state(struct sip_pvt *p, int state);
1325
1326 /*------ Session-Timers functions --------- */
1327 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
1328 static int  proc_session_timer(const void *vp);
1329 static void stop_session_timer(struct sip_pvt *p);
1330 static void start_session_timer(struct sip_pvt *p);
1331 static void restart_session_timer(struct sip_pvt *p);
1332 static const char *strefresher2str(enum st_refresher r);
1333 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
1334 static int parse_minse(const char *p_hdrval, int *const p_interval);
1335 static int st_get_se(struct sip_pvt *, int max);
1336 static enum st_refresher st_get_refresher(struct sip_pvt *);
1337 static enum st_mode st_get_mode(struct sip_pvt *);
1338 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
1339
1340 /*------- RTP Glue functions -------- */
1341 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);
1342
1343 /*!--- SIP MWI Subscription support */
1344 static int sip_subscribe_mwi(const char *value, int lineno);
1345 static void sip_subscribe_mwi_destroy(struct sip_subscription_mwi *mwi);
1346 static void sip_send_all_mwi_subscriptions(void);
1347 static int sip_subscribe_mwi_do(const void *data);
1348 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
1349
1350 /*! \brief Definition of this channel for PBX channel registration */
1351 static const struct ast_channel_tech sip_tech = {
1352         .type = "SIP",
1353         .description = "Session Initiation Protocol (SIP)",
1354         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
1355         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1356         .requester = sip_request_call,                  /* called with chan unlocked */
1357         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1358         .call = sip_call,                       /* called with chan locked */
1359         .send_html = sip_sendhtml,
1360         .hangup = sip_hangup,                   /* called with chan locked */
1361         .answer = sip_answer,                   /* called with chan locked */
1362         .read = sip_read,                       /* called with chan locked */
1363         .write = sip_write,                     /* called with chan locked */
1364         .write_video = sip_write,               /* called with chan locked */
1365         .write_text = sip_write,
1366         .indicate = sip_indicate,               /* called with chan locked */
1367         .transfer = sip_transfer,               /* called with chan locked */
1368         .fixup = sip_fixup,                     /* called with chan locked */
1369         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1370         .send_digit_end = sip_senddigit_end,
1371         .bridge = ast_rtp_instance_bridge,                      /* XXX chan unlocked ? */
1372         .early_bridge = ast_rtp_instance_early_bridge,
1373         .send_text = sip_sendtext,              /* called with chan locked */
1374         .func_channel_read = acf_channel_read,
1375         .setoption = sip_setoption,
1376         .queryoption = sip_queryoption,
1377         .get_pvt_uniqueid = sip_get_callid,
1378 };
1379
1380 /*! \brief This version of the sip channel tech has no send_digit_begin
1381  * callback so that the core knows that the channel does not want
1382  * DTMF BEGIN frames.
1383  * The struct is initialized just before registering the channel driver,
1384  * and is for use with channels using SIP INFO DTMF.
1385  */
1386 static struct ast_channel_tech sip_tech_info;
1387
1388 /*! \brief Working TLS connection configuration */
1389 static struct ast_tls_config sip_tls_cfg;
1390
1391 /*! \brief Default TLS connection configuration */
1392 static struct ast_tls_config default_tls_cfg;
1393
1394 /*! \brief The TCP server definition */
1395 static struct ast_tcptls_session_args sip_tcp_desc = {
1396         .accept_fd = -1,
1397         .master = AST_PTHREADT_NULL,
1398         .tls_cfg = NULL,
1399         .poll_timeout = -1,
1400         .name = "SIP TCP server",
1401         .accept_fn = ast_tcptls_server_root,
1402         .worker_fn = sip_tcp_worker_fn,
1403 };
1404
1405 /*! \brief The TCP/TLS server definition */
1406 static struct ast_tcptls_session_args sip_tls_desc = {
1407         .accept_fd = -1,
1408         .master = AST_PTHREADT_NULL,
1409         .tls_cfg = &sip_tls_cfg,
1410         .poll_timeout = -1,
1411         .name = "SIP TLS server",
1412         .accept_fn = ast_tcptls_server_root,
1413         .worker_fn = sip_tcp_worker_fn,
1414 };
1415
1416 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
1417 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
1418
1419 /*! \brief Append to SIP dialog history
1420         \return Always returns 0 */
1421 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1422
1423 /*! \brief
1424  * when we create or delete references, make sure to use these
1425  * functions so we keep track of the refcounts.
1426  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1427  */
1428 #ifdef REF_DEBUG
1429 #define dialog_ref(arg1,arg2) dialog_ref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1430 #define dialog_unref(arg1,arg2) dialog_unref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1431
1432 static struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1433 {
1434         if (p)
1435                 __ao2_ref_debug(p, 1, tag, file, line, func);
1436         else
1437                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1438         return p;
1439 }
1440
1441 static struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1442 {
1443         if (p)
1444                 __ao2_ref_debug(p, -1, tag, file, line, func);
1445         return NULL;
1446 }
1447 #else
1448 static struct sip_pvt *dialog_ref(struct sip_pvt *p, char *tag)
1449 {
1450         if (p)
1451                 ao2_ref(p, 1);
1452         else
1453                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1454         return p;
1455 }
1456
1457 static struct sip_pvt *dialog_unref(struct sip_pvt *p, char *tag)
1458 {
1459         if (p)
1460                 ao2_ref(p, -1);
1461         return NULL;
1462 }
1463 #endif
1464
1465 /*! \brief map from an integer value to a string.
1466  * If no match is found, return errorstring
1467  */
1468 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
1469 {
1470         const struct _map_x_s *cur;
1471
1472         for (cur = table; cur->s; cur++)
1473                 if (cur->x == x)
1474                         return cur->s;
1475         return errorstring;
1476 }
1477
1478 /*! \brief map from a string to an integer value, case insensitive.
1479  * If no match is found, return errorvalue.
1480  */
1481 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
1482 {
1483         const struct _map_x_s *cur;
1484
1485         for (cur = table; cur->s; cur++)
1486                 if (!strcasecmp(cur->s, s))
1487                         return cur->x;
1488         return errorvalue;
1489 }
1490
1491 static enum AST_REDIRECTING_REASON sip_reason_str_to_code(const char *text)
1492 {
1493         enum AST_REDIRECTING_REASON ast = AST_REDIRECTING_REASON_UNKNOWN;
1494         int i;
1495
1496         for (i = 0; i < ARRAY_LEN(sip_reason_table); ++i) {
1497                 if (!strcasecmp(text, sip_reason_table[i].text)) {
1498                         ast = sip_reason_table[i].code;
1499                         break;
1500                 }
1501         }
1502
1503         return ast;
1504 }
1505
1506 static const char *sip_reason_code_to_str(enum AST_REDIRECTING_REASON code)
1507 {
1508         if (code >= 0 && code < ARRAY_LEN(sip_reason_table)) {
1509                 return sip_reason_table[code].text;
1510         }
1511
1512         return "unknown";
1513 }
1514
1515 /*!
1516  * \brief generic function for determining if a correct transport is being
1517  * used to contact a peer
1518  *
1519  * this is done as a macro so that the "tmpl" var can be passed either a
1520  * sip_request or a sip_peer
1521  */
1522 #define check_request_transport(peer, tmpl) ({ \
1523         int ret = 0; \
1524         if (peer->socket.type == tmpl->socket.type) \
1525                 ; \
1526         else if (!(peer->transports & tmpl->socket.type)) {\
1527                 ast_log(LOG_ERROR, \
1528                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
1529                         get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
1530                         ); \
1531                 ret = 1; \
1532         } else if (peer->socket.type & SIP_TRANSPORT_TLS) { \
1533                 ast_log(LOG_WARNING, \
1534                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
1535                         peer->name, get_transport(tmpl->socket.type) \
1536                 ); \
1537         } else { \
1538                 ast_debug(1, \
1539                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
1540                         peer->name, get_transport(tmpl->socket.type), get_transport(peer->socket.type) \
1541                 ); \
1542         }\
1543         (ret); \
1544 })
1545
1546 /*! \brief
1547  * duplicate a list of channel variables, \return the copy.
1548  */
1549 static struct ast_variable *copy_vars(struct ast_variable *src)
1550 {
1551         struct ast_variable *res = NULL, *tmp, *v = NULL;
1552
1553         for (v = src ; v ; v = v->next) {
1554                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
1555                         tmp->next = res;
1556                         res = tmp;
1557                 }
1558         }
1559         return res;
1560 }
1561
1562 static void tcptls_packet_destructor(void *obj)
1563 {
1564         struct tcptls_packet *packet = obj;
1565
1566         ast_free(packet->data);
1567 }
1568
1569 static void sip_tcptls_client_args_destructor(void *obj)
1570 {
1571         struct ast_tcptls_session_args *args = obj;
1572         if (args->tls_cfg) {
1573                 ast_free(args->tls_cfg->certfile);
1574                 ast_free(args->tls_cfg->pvtfile);
1575                 ast_free(args->tls_cfg->cipher);
1576                 ast_free(args->tls_cfg->cafile);
1577                 ast_free(args->tls_cfg->capath);
1578         }
1579         ast_free(args->tls_cfg);
1580         ast_free((char *) args->name);
1581 }
1582
1583 static void sip_threadinfo_destructor(void *obj)
1584 {
1585         struct sip_threadinfo *th = obj;
1586         struct tcptls_packet *packet;
1587         if (th->alert_pipe[1] > -1) {
1588                 close(th->alert_pipe[0]);
1589         }
1590         if (th->alert_pipe[1] > -1) {
1591                 close(th->alert_pipe[1]);
1592         }
1593         th->alert_pipe[0] = th->alert_pipe[1] = -1;
1594
1595         while ((packet = AST_LIST_REMOVE_HEAD(&th->packet_q, entry))) {
1596                 ao2_t_ref(packet, -1, "thread destruction, removing packet from frame queue");
1597         }
1598
1599         if (th->tcptls_session) {
1600                 ao2_t_ref(th->tcptls_session, -1, "remove tcptls_session for sip_threadinfo object");
1601         }
1602 }
1603
1604 /*! \brief creates a sip_threadinfo object and links it into the threadt table. */
1605 static struct sip_threadinfo *sip_threadinfo_create(struct ast_tcptls_session_instance *tcptls_session, int transport)
1606 {
1607         struct sip_threadinfo *th;
1608
1609         if (!tcptls_session || !(th = ao2_alloc(sizeof(*th), sip_threadinfo_destructor))) {
1610                 return NULL;
1611         }
1612
1613         th->alert_pipe[0] = th->alert_pipe[1] = -1;
1614
1615         if (pipe(th->alert_pipe) == -1) {
1616                 ao2_t_ref(th, -1, "Failed to open alert pipe on sip_threadinfo");
1617                 ast_log(LOG_ERROR, "Could not create sip alert pipe in tcptls thread, error %s\n", strerror(errno));
1618                 return NULL;
1619         }
1620         ao2_t_ref(tcptls_session, +1, "tcptls_session ref for sip_threadinfo object");
1621         th->tcptls_session = tcptls_session;
1622         th->type = transport ? transport : (tcptls_session->ssl ? SIP_TRANSPORT_TLS: SIP_TRANSPORT_TCP);
1623         ao2_t_link(threadt, th, "Adding new tcptls helper thread");
1624         ao2_t_ref(th, -1, "Decrementing threadinfo ref from alloc, only table ref remains");
1625         return th;
1626 }
1627
1628 /*! \brief used to indicate to a tcptls thread that data is ready to be written */
1629 static int sip_tcptls_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t len)
1630 {
1631         int res = len;
1632         struct sip_threadinfo *th = NULL;
1633         struct tcptls_packet *packet = NULL;
1634         struct sip_threadinfo tmp = {
1635                 .tcptls_session = tcptls_session,
1636         };
1637         enum sip_tcptls_alert alert = TCPTLS_ALERT_DATA;
1638
1639         if (!tcptls_session) {
1640                 return XMIT_ERROR;
1641         }
1642
1643         ast_mutex_lock(&tcptls_session->lock);
1644
1645         if ((tcptls_session->fd == -1) ||
1646                 !(th = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread")) ||
1647                 !(packet = ao2_alloc(sizeof(*packet), tcptls_packet_destructor)) ||
1648                 !(packet->data = ast_str_create(len))) {
1649                 goto tcptls_write_setup_error;
1650         }
1651
1652         /* goto tcptls_write_error should _NOT_ be used beyond this point */
1653         ast_str_set(&packet->data, 0, "%s", (char *) buf);
1654         packet->len = len;
1655
1656         /* alert tcptls thread handler that there is a packet to be sent.
1657          * must lock the thread info object to guarantee control of the
1658          * packet queue */
1659         ao2_lock(th);
1660         if (write(th->alert_pipe[1], &alert, sizeof(alert)) == -1) {
1661                 ast_log(LOG_ERROR, "write() to alert pipe failed: %s\n", strerror(errno));
1662                 ao2_t_ref(packet, -1, "could not write to alert pipe, remove packet");
1663                 packet = NULL;
1664                 res = XMIT_ERROR;
1665         } else { /* it is safe to queue the frame after issuing the alert when we hold the threadinfo lock */
1666                 AST_LIST_INSERT_TAIL(&th->packet_q, packet, entry);
1667         }
1668         ao2_unlock(th);
1669
1670         ast_mutex_unlock(&tcptls_session->lock);
1671         ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo object after finding it");
1672         return res;
1673
1674 tcptls_write_setup_error:
1675         if (th) {
1676                 ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo obj, could not create packet");
1677         }
1678         if (packet) {
1679                 ao2_t_ref(packet, -1, "could not allocate packet's data");
1680         }
1681         ast_mutex_unlock(&tcptls_session->lock);
1682
1683         return XMIT_ERROR;
1684 }
1685
1686 /*! \brief SIP TCP connection handler */
1687 static void *sip_tcp_worker_fn(void *data)
1688 {
1689         struct ast_tcptls_session_instance *tcptls_session = data;
1690
1691         return _sip_tcp_helper_thread(NULL, tcptls_session);
1692 }
1693
1694 /*! \brief SIP TCP thread management function
1695         This function reads from the socket, parses the packet into a request
1696 */
1697 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session)
1698 {
1699         int res, cl;
1700         struct sip_request req = { 0, } , reqcpy = { 0, };
1701         struct sip_threadinfo *me = NULL;
1702         char buf[1024] = "";
1703         struct pollfd fds[2] = { { 0 }, { 0 }, };
1704         struct ast_tcptls_session_args *ca = NULL;
1705
1706         /* If this is a server session, then the connection has already been setup,
1707          * simply create the threadinfo object so we can access this thread for writing.
1708          * 
1709          * if this is a client connection more work must be done.
1710          * 1. We own the parent session args for a client connection.  This pointer needs
1711          *    to be held on to so we can decrement it's ref count on thread destruction.
1712          * 2. The threadinfo object was created before this thread was launched, however
1713          *    it must be found within the threadt table.
1714          * 3. Last, the tcptls_session must be started.
1715          */
1716         if (!tcptls_session->client) {
1717                 if (!(me = sip_threadinfo_create(tcptls_session, tcptls_session->ssl ? SIP_TRANSPORT_TLS : SIP_TRANSPORT_TCP))) {
1718                         goto cleanup;
1719                 }
1720                 ao2_t_ref(me, +1, "Adding threadinfo ref for tcp_helper_thread");
1721         } else {
1722                 struct sip_threadinfo tmp = {
1723                         .tcptls_session = tcptls_session,
1724                 };
1725
1726                 if ((!(ca = tcptls_session->parent)) ||
1727                         (!(me = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread"))) ||
1728                         (!(tcptls_session = ast_tcptls_client_start(tcptls_session)))) {
1729                         goto cleanup;
1730                 }
1731         }
1732
1733         me->threadid = pthread_self();
1734         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
1735
1736         /* set up pollfd to watch for reads on both the socket and the alert_pipe */
1737         fds[0].fd = tcptls_session->fd;
1738         fds[1].fd = me->alert_pipe[0];
1739         fds[0].events = fds[1].events = POLLIN | POLLPRI;
1740
1741         if (!(req.data = ast_str_create(SIP_MIN_PACKET)))
1742                 goto cleanup;
1743         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET)))
1744                 goto cleanup;
1745
1746         for (;;) {
1747                 struct ast_str *str_save;
1748
1749                 res = ast_poll(fds, 2, -1); /* polls for both socket and alert_pipe */
1750                 if (res < 0) {
1751                         ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", tcptls_session->ssl ? "SSL": "TCP", res);
1752                         goto cleanup;
1753                 }
1754
1755                 /* handle the socket event, check for both reads from the socket fd,
1756                  * and writes from alert_pipe fd */
1757                 if (fds[0].revents) { /* there is data on the socket to be read */
1758
1759                         fds[0].revents = 0;
1760
1761                         /* clear request structure */
1762                         str_save = req.data;
1763                         memset(&req, 0, sizeof(req));
1764                         req.data = str_save;
1765                         ast_str_reset(req.data);
1766
1767                         str_save = reqcpy.data;
1768                         memset(&reqcpy, 0, sizeof(reqcpy));
1769                         reqcpy.data = str_save;
1770                         ast_str_reset(reqcpy.data);
1771
1772                         memset(buf, 0, sizeof(buf));
1773
1774                         if (tcptls_session->ssl) {
1775                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TLS);
1776                                 req.socket.port = htons(ourport_tls);
1777                         } else {
1778                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TCP);
1779                                 req.socket.port = htons(ourport_tcp);
1780                         }
1781                         req.socket.fd = tcptls_session->fd;
1782
1783                         /* Read in headers one line at a time */
1784                         while (req.len < 4 || strncmp(REQ_OFFSET_TO_STR(&req, len - 4), "\r\n\r\n", 4)) {
1785                                 ast_mutex_lock(&tcptls_session->lock);
1786                                 if (!fgets(buf, sizeof(buf), tcptls_session->f)) {
1787                                         ast_mutex_unlock(&tcptls_session->lock);
1788                                         goto cleanup;
1789                                 }
1790                                 ast_mutex_unlock(&tcptls_session->lock);
1791                                 if (me->stop)
1792                                          goto cleanup;
1793                                 ast_str_append(&req.data, 0, "%s", buf);
1794                                 req.len = req.data->used;
1795                         }
1796                         copy_request(&reqcpy, &req);
1797                         parse_request(&reqcpy);
1798                         /* In order to know how much to read, we need the content-length header */
1799                         if (sscanf(get_header(&reqcpy, "Content-Length"), "%30d", &cl)) {
1800                                 while (cl > 0) {
1801                                         size_t bytes_read;
1802                                         ast_mutex_lock(&tcptls_session->lock);
1803                                         if (!(bytes_read = fread(buf, 1, MIN(sizeof(buf) - 1, cl), tcptls_session->f))) {
1804                                                 ast_mutex_unlock(&tcptls_session->lock);
1805                                                 goto cleanup;
1806                                         }
1807                                         buf[bytes_read] = '\0';
1808                                         ast_mutex_unlock(&tcptls_session->lock);
1809                                         if (me->stop)
1810                                                 goto cleanup;
1811                                         cl -= strlen(buf);
1812                                         ast_str_append(&req.data, 0, "%s", buf);
1813                                         req.len = req.data->used;
1814                                 }
1815                         }
1816                         /*! \todo XXX If there's no Content-Length or if the content-length and what
1817                                         we receive is not the same - we should generate an error */
1818
1819                         req.socket.tcptls_session = tcptls_session;
1820                         handle_request_do(&req, &tcptls_session->remote_address);
1821                 }
1822
1823                 if (fds[1].revents) { /* alert_pipe indicates there is data in the send queue to be sent */
1824                         enum sip_tcptls_alert alert;
1825                         struct tcptls_packet *packet;
1826
1827                         fds[1].revents = 0;
1828
1829                         if (read(me->alert_pipe[0], &alert, sizeof(alert)) == -1) {
1830                                 ast_log(LOG_ERROR, "read() failed: %s\n", strerror(errno));
1831                                 continue;
1832                         }
1833
1834                         switch (alert) {
1835                         case TCPTLS_ALERT_STOP:
1836                                 goto cleanup;
1837                         case TCPTLS_ALERT_DATA:
1838                                 ao2_lock(me);
1839                                 if (!(packet = AST_LIST_REMOVE_HEAD(&me->packet_q, entry))) {
1840                                         ast_log(LOG_WARNING, "TCPTLS thread alert_pipe indicated packet should be sent, but frame_q is empty");
1841                                 } else if (ast_tcptls_server_write(tcptls_session, ast_str_buffer(packet->data), packet->len) == -1) {
1842                                         ast_log(LOG_WARNING, "Failure to write to tcp/tls socket\n");
1843                                 }
1844
1845                                 if (packet) {
1846                                         ao2_t_ref(packet, -1, "tcptls packet sent, this is no longer needed");
1847                                 }
1848                                 ao2_unlock(me);
1849                                 break;
1850                         default:
1851                                 ast_log(LOG_ERROR, "Unknown tcptls thread alert '%d'\n", alert);
1852                         }
1853                 }
1854         }
1855
1856         ast_debug(2, "Shutting down thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
1857
1858 cleanup:
1859         if (me) {
1860                 ao2_t_unlink(threadt, me, "Removing tcptls helper thread, thread is closing");
1861                 ao2_t_ref(me, -1, "Removing tcp_helper_threads threadinfo ref");
1862         }
1863         if (reqcpy.data) {
1864                 ast_free(reqcpy.data);
1865         }
1866
1867         if (req.data) {
1868                 ast_free(req.data);
1869                 req.data = NULL;
1870         }
1871
1872         /* if client, we own the parent session arguments and must decrement ref */
1873         if (ca) {
1874                 ao2_t_ref(ca, -1, "closing tcptls thread, getting rid of client tcptls_session arguments");
1875         }
1876
1877         if (tcptls_session) {
1878                 ast_mutex_lock(&tcptls_session->lock);
1879                 if (tcptls_session->f) {
1880                         fclose(tcptls_session->f);
1881                         tcptls_session->f = NULL;
1882                 }
1883                 if (tcptls_session->fd != -1) {
1884                         close(tcptls_session->fd);
1885                         tcptls_session->fd = -1;
1886                 }
1887                 tcptls_session->parent = NULL;
1888                 ast_mutex_unlock(&tcptls_session->lock);
1889
1890                 ao2_ref(tcptls_session, -1);
1891                 tcptls_session = NULL;
1892         }
1893         return NULL;
1894 }
1895
1896
1897 /*!
1898  * helper functions to unreference various types of objects.
1899  * By handling them this way, we don't have to declare the
1900  * destructor on each call, which removes the chance of errors.
1901  */
1902 static void *unref_peer(struct sip_peer *peer, char *tag)
1903 {
1904         ao2_t_ref(peer, -1, tag);
1905         return NULL;
1906 }
1907
1908 static struct sip_peer *ref_peer(struct sip_peer *peer, char *tag)
1909 {
1910         ao2_t_ref(peer, 1, tag);
1911         return peer;
1912 }
1913
1914 /*! \brief maintain proper refcounts for a sip_pvt's outboundproxy
1915  *
1916  * This function sets pvt's outboundproxy pointer to the one referenced
1917  * by the proxy parameter. Because proxy may be a refcounted object, and
1918  * because pvt's old outboundproxy may also be a refcounted object, we need
1919  * to maintain the proper refcounts.
1920  *
1921  * \param pvt The sip_pvt for which we wish to set the outboundproxy
1922  * \param proxy The sip_proxy which we will point pvt towards.
1923  * \return Returns void
1924  */
1925 static void ref_proxy(struct sip_pvt *pvt, struct sip_proxy *proxy)
1926 {
1927         struct sip_proxy *old_obproxy = pvt->outboundproxy;
1928         /* The sip_cfg.outboundproxy is statically allocated, and so
1929          * we don't ever need to adjust refcounts for it
1930          */
1931         if (proxy && proxy != &sip_cfg.outboundproxy) {
1932                 ao2_ref(proxy, +1);
1933         }
1934         pvt->outboundproxy = proxy;
1935         if (old_obproxy && old_obproxy != &sip_cfg.outboundproxy) {
1936                 ao2_ref(old_obproxy, -1);
1937         }
1938 }
1939
1940 /*!
1941  * \brief Unlink a dialog from the dialogs container, as well as any other places
1942  * that it may be currently stored.
1943  *
1944  * \note A reference to the dialog must be held before calling this function, and this
1945  * function does not release that reference.
1946  */
1947 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist)
1948 {
1949         struct sip_pkt *cp;
1950
1951         dialog_ref(dialog, "Let's bump the count in the unlink so it doesn't accidentally become dead before we are done");
1952
1953         ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
1954
1955         /* Unlink us from the owner (channel) if we have one */
1956         if (dialog->owner) {
1957                 if (lockowner)
1958                         ast_channel_lock(dialog->owner);
1959                 ast_debug(1, "Detaching from channel %s\n", dialog->owner->name);
1960                 dialog->owner->tech_pvt = dialog_unref(dialog->owner->tech_pvt, "resetting channel dialog ptr in unlink_all");
1961                 if (lockowner)
1962                         ast_channel_unlock(dialog->owner);
1963         }
1964         if (dialog->registry) {
1965                 if (dialog->registry->call == dialog)
1966                         dialog->registry->call = dialog_unref(dialog->registry->call, "nulling out the registry's call dialog field in unlink_all");
1967                 dialog->registry = registry_unref(dialog->registry, "delete dialog->registry");
1968         }
1969         if (dialog->stateid > -1) {
1970                 ast_extension_state_del(dialog->stateid, NULL);
1971                 dialog_unref(dialog, "removing extension_state, should unref the associated dialog ptr that was stored there.");
1972                 dialog->stateid = -1; /* shouldn't we 'zero' this out? */
1973         }
1974         /* Remove link from peer to subscription of MWI */
1975         if (dialog->relatedpeer && dialog->relatedpeer->mwipvt == dialog)
1976                 dialog->relatedpeer->mwipvt = dialog_unref(dialog->relatedpeer->mwipvt, "delete ->relatedpeer->mwipvt");
1977         if (dialog->relatedpeer && dialog->relatedpeer->call == dialog)
1978                 dialog->relatedpeer->call = dialog_unref(dialog->relatedpeer->call, "unset the relatedpeer->call field in tandem with relatedpeer field itself");
1979
1980         /* remove all current packets in this dialog */
1981         while((cp = dialog->packets)) {
1982                 dialog->packets = dialog->packets->next;
1983                 AST_SCHED_DEL(sched, cp->retransid);
1984                 dialog_unref(cp->owner, "remove all current packets in this dialog, and the pointer to the dialog too as part of __sip_destroy");
1985                 if (cp->data) {
1986                         ast_free(cp->data);
1987                 }
1988                 ast_free(cp);
1989         }
1990
1991         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"));
1992
1993         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"));
1994         
1995         if (dialog->autokillid > -1)
1996                 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"));
1997
1998         if (dialog->request_queue_sched_id > -1) {
1999                 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"));
2000         }
2001
2002         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"));
2003
2004         if (dialog->t38id > -1) {
2005                 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"));
2006         }
2007
2008         dialog_unref(dialog, "Let's unbump the count in the unlink so the poor pvt can disappear if it is time");
2009         return NULL;
2010 }
2011
2012 static void *registry_unref(struct sip_registry *reg, char *tag)
2013 {
2014         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
2015         ASTOBJ_UNREF(reg, sip_registry_destroy);
2016         return NULL;
2017 }
2018
2019 /*! \brief Add object reference to SIP registry */
2020 static struct sip_registry *registry_addref(struct sip_registry *reg, char *tag)
2021 {
2022         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
2023         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
2024 }
2025
2026 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
2027 static struct ast_udptl_protocol sip_udptl = {
2028         type: "SIP",
2029         get_udptl_info: sip_get_udptl_peer,
2030         set_udptl_peer: sip_set_udptl_peer,
2031 };
2032
2033 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2034         __attribute__((format(printf, 2, 3)));
2035
2036
2037 /*! \brief Convert transfer status to string */
2038 static const char *referstatus2str(enum referstatus rstatus)
2039 {
2040         return map_x_s(referstatusstrings, rstatus, "");
2041 }
2042
2043 static inline void pvt_set_needdestroy(struct sip_pvt *pvt, const char *reason)
2044 {
2045         append_history(pvt, "NeedDestroy", "Setting needdestroy because %s", reason);
2046         pvt->needdestroy = 1;
2047 }
2048
2049 /*! \brief Initialize the initital request packet in the pvt structure.
2050         This packet is used for creating replies and future requests in
2051         a dialog */
2052 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
2053 {
2054         if (p->initreq.headers)
2055                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
2056         else
2057                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
2058         /* Use this as the basis */
2059         copy_request(&p->initreq, req);
2060         parse_request(&p->initreq);
2061         if (req->debug)
2062                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
2063 }
2064
2065 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
2066 static void sip_alreadygone(struct sip_pvt *dialog)
2067 {
2068         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
2069         dialog->alreadygone = 1;
2070 }
2071
2072 /*! Resolve DNS srv name or host name in a sip_proxy structure */
2073 static int proxy_update(struct sip_proxy *proxy)
2074 {
2075         /* if it's actually an IP address and not a name,
2076            there's no need for a managed lookup */
2077         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
2078                 /* Ok, not an IP address, then let's check if it's a domain or host */
2079                 /* XXX Todo - if we have proxy port, don't do SRV */
2080                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, sip_cfg.srvlookup ? "_sip._udp" : NULL) < 0) {
2081                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
2082                         return FALSE;
2083                 }
2084         }
2085         proxy->last_dnsupdate = time(NULL);
2086         return TRUE;
2087 }
2088
2089 /*! \brief converts ascii port to int representation. If no
2090  *  pt buffer is provided or the pt has errors when being converted
2091  *  to an int value, the port provided as the standard is used.
2092  */
2093 unsigned int port_str2int(const char *pt, unsigned int standard)
2094 {
2095         int port = standard;
2096         if (ast_strlen_zero(pt) || (sscanf(pt, "%30d", &port) != 1) || (port < 1) || (port > 65535)) {
2097                 port = standard;
2098         }
2099
2100         return port;
2101 }
2102
2103 /*! \brief Allocate and initialize sip proxy */
2104 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
2105 {
2106         struct sip_proxy *proxy;
2107
2108         if (ast_strlen_zero(name)) {
2109                 return NULL;
2110         }
2111
2112         proxy = ao2_alloc(sizeof(*proxy), NULL);
2113         if (!proxy)
2114                 return NULL;
2115         proxy->force = force;
2116         ast_copy_string(proxy->name, name, sizeof(proxy->name));
2117         proxy->ip.sin_port = htons(port_str2int(port, STANDARD_SIP_PORT));
2118         proxy_update(proxy);
2119         return proxy;
2120 }
2121
2122 /*! \brief Get default outbound proxy or global proxy */
2123 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
2124 {
2125         if (peer && peer->outboundproxy) {
2126                 if (sipdebug)
2127                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
2128                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
2129                 return peer->outboundproxy;
2130         }
2131         if (sip_cfg.outboundproxy.name[0]) {
2132                 if (sipdebug)
2133                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
2134                 append_history(dialog, "OBproxy", "Using global obproxy %s", sip_cfg.outboundproxy.name);
2135                 return &sip_cfg.outboundproxy;
2136         }
2137         if (sipdebug)
2138                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
2139         return NULL;
2140 }
2141
2142 /*! \brief returns true if 'name' (with optional trailing whitespace)
2143  * matches the sip method 'id'.
2144  * Strictly speaking, SIP methods are case SENSITIVE, but we do
2145  * a case-insensitive comparison to be more tolerant.
2146  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
2147  */
2148 static int method_match(enum sipmethod id, const char *name)
2149 {
2150         int len = strlen(sip_methods[id].text);
2151         int l_name = name ? strlen(name) : 0;
2152         /* true if the string is long enough, and ends with whitespace, and matches */
2153         return (l_name >= len && name[len] < 33 &&
2154                 !strncasecmp(sip_methods[id].text, name, len));
2155 }
2156
2157 /*! \brief  find_sip_method: Find SIP method from header */
2158 static int find_sip_method(const char *msg)
2159 {
2160         int i, res = 0;
2161         
2162         if (ast_strlen_zero(msg))
2163                 return 0;
2164         for (i = 1; i < ARRAY_LEN(sip_methods) && !res; i++) {
2165                 if (method_match(i, msg))
2166                         res = sip_methods[i].id;
2167         }
2168         return res;
2169 }
2170
2171 /*! \brief Parse supported header in incoming packet */
2172 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
2173 {
2174         char *next, *sep;
2175         char *temp;
2176         unsigned int profile = 0;
2177         int i, found;
2178
2179         if (ast_strlen_zero(supported) )
2180                 return 0;
2181         temp = ast_strdupa(supported);
2182
2183         if (sipdebug)
2184                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
2185
2186         for (next = temp; next; next = sep) {
2187                 found = FALSE;
2188                 if ( (sep = strchr(next, ',')) != NULL)
2189                         *sep++ = '\0';
2190                 next = ast_skip_blanks(next);
2191                 if (sipdebug)
2192                         ast_debug(3, "Found SIP option: -%s-\n", next);
2193                 for (i = 0; i < ARRAY_LEN(sip_options); i++) {
2194                         if (!strcasecmp(next, sip_options[i].text)) {
2195                                 profile |= sip_options[i].id;
2196                                 found = TRUE;
2197                                 if (sipdebug)
2198                                         ast_debug(3, "Matched SIP option: %s\n", next);
2199                                 break;
2200                         }
2201                 }
2202
2203                 /* This function is used to parse both Suported: and Require: headers.
2204                 Let the caller of this function know that an unknown option tag was
2205                 encountered, so that if the UAC requires it then the request can be
2206                 rejected with a 420 response. */
2207                 if (!found)
2208                         profile |= SIP_OPT_UNKNOWN;
2209
2210                 if (!found && sipdebug) {
2211                         if (!strncasecmp(next, "x-", 2))
2212                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
2213                         else
2214                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
2215                 }
2216         }
2217
2218         if (pvt)
2219                 pvt->sipoptions = profile;
2220         return profile;
2221 }
2222
2223 /*! \brief See if we pass debug IP filter */
2224 static inline int sip_debug_test_addr(const struct sockaddr_in *addr)
2225 {
2226         if (!sipdebug)
2227                 return 0;
2228         if (debugaddr.sin_addr.s_addr) {
2229                 if (((ntohs(debugaddr.sin_port) != 0)
2230                         && (debugaddr.sin_port != addr->sin_port))
2231                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
2232                         return 0;
2233         }
2234         return 1;
2235 }
2236
2237 /*! \brief The real destination address for a write */
2238 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
2239 {
2240         if (p->outboundproxy)
2241                 return &p->outboundproxy->ip;
2242
2243         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;
2244 }
2245
2246 /*! \brief Display SIP nat mode */
2247 static const char *sip_nat_mode(const struct sip_pvt *p)
2248 {
2249         return ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) ? "NAT" : "no NAT";
2250 }
2251
2252 /*! \brief Test PVT for debugging output */
2253 static inline int sip_debug_test_pvt(struct sip_pvt *p)
2254 {
2255         if (!sipdebug)
2256                 return 0;
2257         return sip_debug_test_addr(sip_real_dst(p));
2258 }
2259
2260 /*! \brief Return int representing a bit field of transport types found in const char *transport */
2261 static int get_transport_str2enum(const char *transport)
2262 {
2263         int res = 0;
2264
2265         if (ast_strlen_zero(transport)) {
2266                 return res;
2267         }
2268
2269         if (!strcasecmp(transport, "udp")) {
2270                 res |= SIP_TRANSPORT_UDP;
2271         }
2272         if (!strcasecmp(transport, "tcp")) {
2273                 res |= SIP_TRANSPORT_TCP;
2274         }
2275         if (!strcasecmp(transport, "tls")) {
2276                 res |= SIP_TRANSPORT_TLS;
2277         }
2278
2279         return res;
2280 }
2281
2282 /*! \brief Return configuration of transports for a device */
2283 static inline const char *get_transport_list(unsigned int transports) {
2284         switch (transports) {
2285                 case SIP_TRANSPORT_UDP:
2286                         return "UDP";
2287                 case SIP_TRANSPORT_TCP:
2288                         return "TCP";
2289                 case SIP_TRANSPORT_TLS:
2290                         return "TLS";
2291                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TCP:
2292                         return "TCP,UDP";
2293                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TLS:
2294                         return "TLS,UDP";
2295                 case SIP_TRANSPORT_TCP | SIP_TRANSPORT_TLS:
2296                         return "TLS,TCP";
2297                 default:
2298                         return transports ?
2299                                 "TLS,TCP,UDP" : "UNKNOWN";      
2300         }
2301 }
2302
2303 /*! \brief Return transport as string */
2304 static inline const char *get_transport(enum sip_transport t)
2305 {
2306         switch (t) {
2307         case SIP_TRANSPORT_UDP:
2308                 return "UDP";
2309         case SIP_TRANSPORT_TCP:
2310                 return "TCP";
2311         case SIP_TRANSPORT_TLS:
2312                 return "TLS";
2313         }
2314
2315         return "UNKNOWN";
2316 }
2317
2318 /*! \brief Return transport of dialog.
2319         \note this is based on a false assumption. We don't always use the
2320         outbound proxy for all requests in a dialog. It depends on the
2321         "force" parameter. The FIRST request is always sent to the ob proxy.
2322         \todo Fix this function to work correctly
2323 */
2324 static inline const char *get_transport_pvt(struct sip_pvt *p)
2325 {
2326         if (p->outboundproxy && p->outboundproxy->transport) {
2327                 set_socket_transport(&p->socket, p->outboundproxy->transport);
2328         }
2329
2330         return get_transport(p->socket.type);
2331 }
2332
2333 /*! \brief Transmit SIP message
2334         Sends a SIP request or response on a given socket (in the pvt)
2335         Called by retrans_pkt, send_request, send_response and
2336         __sip_reliable_xmit
2337         \return length of transmitted message, XMIT_ERROR on known network failures -1 on other failures.
2338 */
2339 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len)
2340 {
2341         int res = 0;
2342         const struct sockaddr_in *dst = sip_real_dst(p);
2343
2344         ast_debug(2, "Trying to put '%.11s' onto %s socket destined for %s:%d\n", data->str, get_transport_pvt(p), ast_inet_ntoa(dst->sin_addr), htons(dst->sin_port));
2345
2346         if (sip_prepare_socket(p) < 0)
2347                 return XMIT_ERROR;
2348
2349         if (p->socket.type == SIP_TRANSPORT_UDP) {
2350                 res = sendto(p->socket.fd, data->str, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
2351         } else if (p->socket.tcptls_session) {
2352                 res = sip_tcptls_write(p->socket.tcptls_session, data->str, len);
2353         } else {
2354                 ast_debug(2, "Socket type is TCP but no tcptls_session is present to write to\n");
2355                 return XMIT_ERROR;
2356         }
2357
2358         if (res == -1) {
2359                 switch (errno) {
2360                 case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
2361                 case EHOSTUNREACH:      /* Host can't be reached */
2362                 case ENETDOWN:          /* Interface down */
2363                 case ENETUNREACH:       /* Network failure */
2364                 case ECONNREFUSED:      /* ICMP port unreachable */
2365                         res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
2366                 }
2367         }
2368         if (res != len)
2369                 ast_log(LOG_WARNING, "sip_xmit of %p (len %d) to %s:%d returned %d: %s\n", data, len, ast_inet_ntoa(dst->sin_addr), ntohs(dst->sin_port), res, strerror(errno));
2370
2371         return res;
2372 }
2373
2374 /*! \brief Build a Via header for a request */
2375 static void build_via(struct sip_pvt *p)
2376 {
2377         /* Work around buggy UNIDEN UIP200 firmware */
2378         const char *rport = (ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) || ast_test_flag(&p->flags[0], SIP_NAT_RPORT_PRESENT)) ? ";rport" : "";
2379
2380         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
2381         snprintf(p->via, sizeof(p->via), "SIP/2.0/%s %s:%d;branch=z9hG4bK%08x%s",
2382                  get_transport_pvt(p),
2383                  ast_inet_ntoa(p->ourip.sin_addr),
2384                  ntohs(p->ourip.sin_port), (int) p->branch, rport);
2385 }
2386
2387 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
2388  *
2389  * Using the localaddr structure built up with localnet statements in sip.conf
2390  * apply it to their address to see if we need to substitute our
2391  * externip or can get away with our internal bindaddr
2392  * 'us' is always overwritten.
2393  */
2394 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us, struct sip_pvt *p)
2395 {
2396         struct sockaddr_in theirs;
2397         /* Set want_remap to non-zero if we want to remap 'us' to an externally
2398          * reachable IP address and port. This is done if:
2399          * 1. we have a localaddr list (containing 'internal' addresses marked
2400          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
2401          *    and AST_SENSE_ALLOW on 'external' ones);
2402          * 2. either stunaddr or externip is set, so we know what to use as the
2403          *    externally visible address;
2404          * 3. the remote address, 'them', is external;
2405          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
2406          *    when passed to ast_apply_ha() so it does need to be remapped.
2407          *    This fourth condition is checked later.
2408          */
2409         int want_remap;
2410
2411         *us = internip;         /* starting guess for the internal address */
2412         /* now ask the system what would it use to talk to 'them' */
2413         ast_ouraddrfor(them, &us->sin_addr);
2414         theirs.sin_addr = *them;
2415
2416         want_remap = localaddr &&
2417                 (externip.sin_addr.s_addr || stunaddr.sin_addr.s_addr) &&
2418                 ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
2419
2420         if (want_remap &&
2421             (!sip_cfg.matchexterniplocally || !ast_apply_ha(localaddr, us)) ) {
2422                 /* if we used externhost or stun, see if it is time to refresh the info */
2423                 if (externexpire && time(NULL) >= externexpire) {
2424                         if (stunaddr.sin_addr.s_addr) {
2425                                 ast_stun_request(sipsock, &stunaddr, NULL, &externip);
2426                         } else {
2427                                 if (ast_parse_arg(externhost, PARSE_INADDR, &externip))
2428                                         ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
2429                         }
2430                         externexpire = time(NULL) + externrefresh;
2431                 }
2432                 if (externip.sin_addr.s_addr) {
2433                         *us = externip;
2434                         switch (p->socket.type) {
2435                         case SIP_TRANSPORT_TCP:
2436                                 us->sin_port = htons(externtcpport);
2437                                 break;
2438                         case SIP_TRANSPORT_TLS:
2439                                 us->sin_port = htons(externtlsport);
2440                                 break;
2441                         case SIP_TRANSPORT_UDP:
2442                                 break; /* fall through */
2443                         default:
2444                                 us->sin_port = htons(STANDARD_SIP_PORT); /* we should never get here */
2445                         }
2446                 }
2447                 else
2448                         ast_log(LOG_WARNING, "stun failed\n");
2449                 ast_debug(1, "Target address %s is not local, substituting externip\n",
2450                         ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
2451         } else if (p) {
2452                 /* no remapping, but we bind to a specific address, so use it. */
2453                 switch (p->socket.type) {
2454                 case SIP_TRANSPORT_TCP:
2455                         if (sip_tcp_desc.local_address.sin_addr.s_addr) {
2456                                 *us = sip_tcp_desc.local_address;
2457                         } else {
2458                                 us->sin_port = sip_tcp_desc.local_address.sin_port;
2459                         }
2460                         break;
2461                 case SIP_TRANSPORT_TLS:
2462                         if (sip_tls_desc.local_address.sin_addr.s_addr) {
2463                                 *us = sip_tls_desc.local_address;
2464                         } else {
2465                                 us->sin_port = sip_tls_desc.local_address.sin_port;
2466                         }
2467                                 break;
2468                 case SIP_TRANSPORT_UDP:
2469                         /* fall through on purpose */
2470                 default:
2471                         if (bindaddr.sin_addr.s_addr) {
2472                                 *us = bindaddr;
2473                         }
2474                 }
2475         } else if (bindaddr.sin_addr.s_addr) {
2476                 *us = bindaddr;
2477         }
2478         ast_debug(3, "Setting SIP_TRANSPORT_%s with address %s:%d\n", get_transport(p->socket.type), ast_inet_ntoa(us->sin_addr), ntohs(us->sin_port));
2479 }
2480
2481 /*! \brief Append to SIP dialog history with arg list  */
2482 static __attribute__((format(printf, 2, 0))) void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
2483 {
2484         char buf[80], *c = buf; /* max history length */
2485         struct sip_history *hist;
2486         int l;
2487
2488         vsnprintf(buf, sizeof(buf), fmt, ap);
2489         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
2490         l = strlen(buf) + 1;
2491         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
2492                 return;
2493         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
2494                 ast_free(hist);
2495                 return;
2496         }
2497         memcpy(hist->event, buf, l);
2498         if (p->history_entries == MAX_HISTORY_ENTRIES) {
2499                 struct sip_history *oldest;
2500                 oldest = AST_LIST_REMOVE_HEAD(p->history, list);
2501                 p->history_entries--;
2502                 ast_free(oldest);
2503         }
2504         AST_LIST_INSERT_TAIL(p->history, hist, list);
2505         p->history_entries++;
2506 }
2507
2508 /*! \brief Append to SIP dialog history with arg list  */
2509 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2510 {
2511         va_list ap;
2512
2513         if (!p)
2514                 return;
2515
2516         if (!p->do_history && !recordhistory && !dumphistory)
2517                 return;
2518
2519         va_start(ap, fmt);
2520         append_history_va(p, fmt, ap);
2521         va_end(ap);
2522
2523         return;
2524 }
2525
2526 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
2527 static int retrans_pkt(const void *data)
2528 {
2529         struct sip_pkt *pkt = (struct sip_pkt *)data, *prev, *cur = NULL;
2530         int reschedule = DEFAULT_RETRANS;
2531         int xmitres = 0;
2532         
2533         /* Lock channel PVT */
2534         sip_pvt_lock(pkt->owner);
2535
2536         if (pkt->retrans < MAX_RETRANS) {
2537                 pkt->retrans++;
2538                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
2539                         if (sipdebug)
2540                                 ast_debug(4, "SIP TIMER: Not rescheduling id #%d:%s (Method %d) (No timer T1)\n", pkt->retransid, sip_methods[pkt->method].text, pkt->method);
2541                 } else {
2542                         int siptimer_a;
2543
2544                         if (sipdebug)
2545                                 ast_debug(4, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
2546                         if (!pkt->timer_a)
2547                                 pkt->timer_a = 2 ;
2548                         else
2549                                 pkt->timer_a = 2 * pkt->timer_a;
2550
2551                         /* For non-invites, a maximum of 4 secs */
2552                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
2553                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
2554                                 siptimer_a = 4000;
2555                 
2556                         /* Reschedule re-transmit */
2557                         reschedule = siptimer_a;
2558                         ast_debug(4, "** SIP timers: Rescheduling retransmission %d to %d ms (t1 %d ms (Retrans id #%d)) \n", pkt->retrans +1, siptimer_a, pkt->timer_t1, pkt->retransid);
2559                 }
2560
2561                 if (sip_debug_test_pvt(pkt->owner)) {
2562                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
2563                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
2564                                 pkt->retrans, sip_nat_mode(pkt->owner),
2565                                 ast_inet_ntoa(dst->sin_addr),
2566                                 ntohs(dst->sin_port), pkt->data->str);
2567                 }
2568
2569                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data->str);
2570                 xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
2571                 sip_pvt_unlock(pkt->owner);
2572                 if (xmitres == XMIT_ERROR)
2573                         ast_log(LOG_WARNING, "Network error on retransmit in dialog %s\n", pkt->owner->callid);
2574                 else
2575                         return  reschedule;
2576         }
2577         /* Too many retries */
2578         if (pkt->owner && pkt->method != SIP_OPTIONS && xmitres == 0) {
2579                 if (pkt->is_fatal || sipdebug)  /* Tell us if it's critical or if we're debugging */
2580                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s) -- See doc/sip-retransmit.txt.\n",
2581                                 pkt->owner->callid, pkt->seqno,
2582                                 pkt->is_fatal ? "Critical" : "Non-critical", pkt->is_resp ? "Response" : "Request");
2583         } else if (pkt->method == SIP_OPTIONS && sipdebug) {
2584                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s)  -- See doc/sip-retransmit.txt.\n", pkt->owner->callid);
2585
2586         }
2587         if (xmitres == XMIT_ERROR) {
2588                 ast_log(LOG_WARNING, "Transmit error :: Cancelling transmission on Call ID %s\n", pkt->owner->callid);
2589                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2590         } else
2591                 append_history(pkt->owner, "MaxRetries", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2592                 
2593         pkt->retransid = -1;
2594
2595         if (pkt->is_fatal) {
2596                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
2597                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
2598                         usleep(1);
2599                         sip_pvt_lock(pkt->owner);
2600                 }
2601
2602                 if (pkt->owner->owner && !pkt->owner->owner->hangupcause)
2603                         pkt->owner->owner->hangupcause = AST_CAUSE_NO_USER_RESPONSE;
2604                 
2605                 if (pkt->owner->owner) {
2606                         sip_alreadygone(pkt->owner);
2607                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet (see doc/sip-retransmit.txt).\n", pkt->owner->callid);
2608                         ast_queue_hangup_with_cause(pkt->owner->owner, AST_CAUSE_PROTOCOL_ERROR);
2609                         ast_channel_unlock(pkt->owner->owner);
2610                 } else {
2611                         /* If no channel owner, destroy now */
2612
2613                         /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
2614                         if (pkt->method != SIP_OPTIONS && pkt->method != SIP_REGISTER) {
2615                                 pvt_set_needdestroy(pkt->owner, "no response to critical packet");
2616                                 sip_alreadygone(pkt->owner);
2617                                 append_history(pkt->owner, "DialogKill", "Killing this failed dialog immediately");
2618                         }
2619                 }
2620         }
2621
2622         if (pkt->method == SIP_BYE) {
2623                 /* We're not getting answers on SIP BYE's.  Tear down the call anyway. */
2624                 if (pkt->owner->owner)
2625                         ast_channel_unlock(pkt->owner->owner);
2626                 append_history(pkt->owner, "ByeFailure", "Remote peer doesn't respond to bye. Destroying call anyway.");
2627                 pvt_set_needdestroy(pkt->owner, "no response to BYE");
2628         }
2629
2630         /* Remove the packet */
2631         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
2632                 if (cur == pkt) {
2633                         UNLINK(cur, pkt->owner->packets, prev);
2634                         sip_pvt_unlock(pkt->owner);
2635                         if (pkt->owner)
2636                                 pkt->owner = dialog_unref(pkt->owner,"pkt is being freed, its dialog ref is dead now");
2637                         if (pkt->data)
2638                                 ast_free(pkt->data);
2639                         pkt->data = NULL;
2640                         ast_free(pkt);
2641                         return 0;
2642                 }
2643         }
2644         /* error case */
2645         ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
2646         sip_pvt_unlock(pkt->owner);
2647         return 0;
2648 }
2649
2650 /*! \brief Transmit packet with retransmits
2651         \return 0 on success, -1 on failure to allocate packet
2652 */
2653 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)
2654 {
2655         struct sip_pkt *pkt = NULL;
2656         int siptimer_a = DEFAULT_RETRANS;
2657         int xmitres = 0;
2658         int respid;
2659
2660         if (sipmethod == SIP_INVITE) {
2661                 /* Note this is a pending invite */
2662                 p->pendinginvite = seqno;
2663         }
2664
2665         /* If the transport is something reliable (TCP or TLS) then don't really send this reliably */
2666         /* I removed the code from retrans_pkt that does the same thing so it doesn't get loaded into the scheduler */
2667         /*! \todo According to the RFC some packets need to be retransmitted even if its TCP, so this needs to get revisited */
2668         if (!(p->socket.type & SIP_TRANSPORT_UDP)) {
2669                 xmitres = __sip_xmit(p, data, len);     /* Send packet */
2670                 if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2671                         append_history(p, "XmitErr", "%s", fatal ? "(Critical)" : "(Non-critical)");
2672                         return AST_FAILURE;
2673                 } else {
2674                         return AST_SUCCESS;
2675                 }
2676         }
2677
2678         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
2679                 return AST_FAILURE;
2680         /* copy data, add a terminator and save length */
2681         if (!(pkt->data = ast_str_create(len))) {
2682                 ast_free(pkt);
2683                 return AST_FAILURE;
2684         }
2685         ast_str_set(&pkt->data, 0, "%s%s", data->str, "\0");
2686         pkt->packetlen = len;
2687         /* copy other parameters from the caller */
2688         pkt->method = sipmethod;
2689         pkt->seqno = seqno;
2690         pkt->is_resp = resp;
2691         pkt->is_fatal = fatal;
2692         pkt->owner = dialog_ref(p, "__sip_reliable_xmit: setting pkt->owner");
2693         pkt->next = p->packets;
2694         p->packets = pkt;       /* Add it to the queue */
2695         if (resp) {
2696                 /* Parse out the response code */
2697                 if (sscanf(ast_str_buffer(pkt->data), "SIP/2.0 %30u", &respid) == 1) {
2698                         pkt->response_code = respid;
2699                 }
2700         }
2701         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
2702         pkt->retransid = -1;
2703         if (pkt->timer_t1)
2704                 siptimer_a = pkt->timer_t1 * 2;
2705
2706         /* Schedule retransmission */
2707         AST_SCHED_REPLACE_VARIABLE(pkt->retransid, sched, siptimer_a, retrans_pkt, pkt, 1);
2708         if (sipdebug)
2709                 ast_debug(4, "*** SIP TIMER: Initializing retransmit timer on packet: Id  #%d\n", pkt->retransid);
2710
2711         xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);    /* Send packet */
2712
2713         if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2714                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2715                 ast_log(LOG_ERROR, "Serious Network Trouble; __sip_xmit returns error for pkt data\n");
2716                 AST_SCHED_DEL(sched, pkt->retransid);
2717                 p->packets = pkt->next;
2718                 pkt->owner = dialog_unref(pkt->owner,"pkt is being freed, its dialog ref is dead now");
2719                 ast_free(pkt->data);
2720                 ast_free(pkt);
2721                 return AST_FAILURE;
2722         } else {
2723                 return AST_SUCCESS;
2724         }
2725 }
2726
2727 /*! \brief Kill a SIP dialog (called only by the scheduler)
2728  * The scheduler has a reference to this dialog when p->autokillid != -1,
2729  * and we are called using that reference. So if the event is not
2730  * rescheduled, we need to call dialog_unref().
2731  */
2732 static int __sip_autodestruct(const void *data)
2733 {
2734         struct sip_pvt *p = (struct sip_pvt *)data;
2735
2736         /* If this is a subscription, tell the phone that we got a timeout */
2737         if (p->subscribed) {
2738                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE);   /* Send last notification */
2739                 p->subscribed = NONE;
2740                 append_history(p, "Subscribestatus", "timeout");
2741                 ast_debug(3, "Re-scheduled destruction of SIP subscription %s\n", p->callid ? p->callid : "<unknown>");
2742                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
2743         }
2744
2745         /* If there are packets still waiting for delivery, delay the destruction */
2746         if (p->packets) {
2747                 if (!p->needdestroy) {
2748                         char method_str[31];
2749                         ast_debug(3, "Re-scheduled destruction of SIP call %s\n", p->callid ? p->callid : "<unknown>");
2750                         append_history(p, "ReliableXmit", "timeout");
2751                         if (sscanf(p->lastmsg, "Tx: %30s", method_str) == 1 || sscanf(p->lastmsg, "Rx: %30s", method_str) == 1) {
2752                                 if (method_match(SIP_CANCEL, method_str) || method_match(SIP_BYE, method_str)) {
2753                                         pvt_set_needdestroy(p, "autodestruct");
2754                                 }
2755                         }
2756                         return 10000;
2757                 } else {
2758                         /* They've had their chance to respond. Time to bail */
2759                         __sip_pretend_ack(p);
2760                 }
2761         }
2762
2763         if (p->subscribed == MWI_NOTIFICATION) {
2764                 if (p->relatedpeer) {
2765                         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) */
2766                 }
2767         }
2768
2769         /* Reset schedule ID */
2770         p->autokillid = -1;
2771
2772         if (p->owner) {
2773                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2774                 ast_queue_hangup_with_cause(p->owner, AST_CAUSE_PROTOCOL_ERROR);
2775         } else if (p->refer && !p->alreadygone) {
2776                 ast_debug(3, "Finally hanging up channel after transfer: %s\n", p->callid);
2777                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2778                 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2779                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2780         } else {
2781                 append_history(p, "AutoDestroy", "%s", p->callid);
2782                 ast_debug(3, "Auto destroying SIP dialog '%s'\n", p->callid);
2783                 dialog_unlink_all(p, TRUE, TRUE); /* once it's unlinked and unrefd everywhere, it'll be freed automagically */
2784                 /* dialog_unref(p, "unref dialog-- no other matching conditions"); -- unlink all now should finish off the dialog's references and free it. */
2785                 /* sip_destroy(p); */           /* Go ahead and destroy dialog. All attempts to recover is done */
2786                 /* sip_destroy also absorbs the reference */
2787         }
2788         dialog_unref(p, "The ref to a dialog passed to this sched callback is going out of scope; unref it.");
2789         return 0;
2790 }
2791
2792 /*! \brief Schedule destruction of SIP dialog */
2793 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2794 {
2795         if (ms < 0) {
2796                 if (p->timer_t1 == 0) {
2797                         p->timer_t1 = global_t1;        /* Set timer T1 if not set (RFC 3261) */
2798                         p->timer_b = global_timer_b;  /* Set timer B if not set (RFC 3261) */
2799                 }
2800                 ms = p->timer_t1 * 64;
2801         }
2802         if (sip_debug_test_pvt(p))
2803                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2804         if (sip_cancel_destroy(p))
2805                 ast_log(LOG_WARNING, "Unable to cancel SIP destruction.  Expect bad things.\n");
2806
2807         if (p->do_history)
2808                 append_history(p, "SchedDestroy", "%d ms", ms);
2809         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, dialog_ref(p, "setting ref as passing into ast_sched_add for __sip_autodestruct"));
2810
2811         if (p->stimer && p->stimer->st_active == TRUE && p->stimer->st_schedid > 0)
2812                 stop_session_timer(p);
2813 }
2814
2815 /*! \brief Cancel destruction of SIP dialog.
2816  * Be careful as this also absorbs the reference - if you call it
2817  * from within the scheduler, this might be the last reference.
2818  */
2819 static int sip_cancel_destroy(struct sip_pvt *p)
2820 {
2821         int res = 0;
2822         if (p->autokillid > -1) {
2823                 int res3;
2824
2825                 if (!(res3 = ast_sched_del(sched, p->autokillid))) {
2826                         append_history(p, "CancelDestroy", "");
2827                         p->autokillid = -1;
2828                         dialog_unref(p, "dialog unrefd because autokillid is de-sched'd");
2829                 }
2830         }
2831         return res;
2832 }
2833
2834 /*! \brief Acknowledges receipt of a packet and stops retransmission
2835  * called with p locked*/
2836 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2837 {
2838         struct sip_pkt *cur, *prev = NULL;
2839         const char *msg = "Not Found";  /* used only for debugging */
2840         int res = FALSE;
2841
2842         /* If we have an outbound proxy for this dialog, then delete it now since
2843           the rest of the requests in this dialog needs to follow the routing.
2844           If obforcing is set, we will keep the outbound proxy during the whole
2845           dialog, regardless of what the SIP rfc says
2846         */
2847         if (p->outboundproxy && !p->outboundproxy->force){
2848                 ref_proxy(p, NULL);
2849         }
2850
2851         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2852                 if (cur->seqno != seqno || cur->is_resp != resp)
2853                         continue;
2854                 if (cur->is_resp || cur->method == sipmethod) {
2855                         res = TRUE;
2856                         msg = "Found";
2857                         if (!resp && (seqno == p->pendinginvite)) {
2858                                 ast_debug(1, "Acked pending invite %d\n", p->pendinginvite);
2859                                 p->pendinginvite = 0;
2860                         }
2861                         if (cur->retransid > -1) {
2862                                 if (sipdebug)
2863                                         ast_debug(4, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2864                         }
2865                         /* This odd section is designed to thwart a
2866                          * race condition in the packet scheduler. There are
2867                          * two conditions under which deleting the packet from the
2868                          * scheduler can fail.
2869                          *
2870                          * 1. The packet has been removed from the scheduler because retransmission
2871                          * is being attempted. The problem is that if the packet is currently attempting
2872                          * retransmission and we are at this point in the code, then that MUST mean
2873                          * that retrans_pkt is waiting on p's lock. Therefore we will relinquish the
2874                          * lock temporarily to allow retransmission.
2875                          *
2876                          * 2. The packet has reached its maximum number of retransmissions and has
2877                          * been permanently removed from the packet scheduler. If this is the case, then
2878                          * the packet's retransid will be set to -1. The atomicity of the setting and checking
2879                          * of the retransid to -1 is ensured since in both cases p's lock is held.
2880                          */
2881                         while (cur->retransid > -1 && ast_sched_del(sched, cur->retransid)) {
2882                                 sip_pvt_unlock(p);
2883                                 usleep(1);
2884                                 sip_pvt_lock(p);
2885                         }
2886                         UNLINK(cur, p->packets, prev);
2887                         dialog_unref(cur->owner, "unref pkt cur->owner dialog from sip ack before freeing pkt");
2888                         if (cur->data)
2889                                 ast_free(cur->data);
2890                         ast_free(cur);
2891                         break;
2892                 }
2893         }
2894         ast_debug(1, "Stopping retransmission on '%s' of %s %d: Match %s\n",
2895                 p->callid, resp ? "Response" : "Request", seqno, msg);
2896         return res;
2897 }
2898
2899 /*! \brief Pretend to ack all packets
2900  * called with p locked */
2901 static void __sip_pretend_ack(struct sip_pvt *p)
2902 {
2903         struct sip_pkt *cur = NULL;
2904
2905         while (p->packets) {
2906                 int method;
2907                 if (cur == p->packets) {
2908                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2909                         return;
2910                 }
2911                 cur = p->packets;
2912                 method = (cur->method) ? cur->method : find_sip_method(cur->data->str);
2913                 __sip_ack(p, cur->seqno, cur->is_resp, method);
2914         }
2915 }
2916
2917 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2918 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2919 {
2920         struct sip_pkt *cur;
2921         int res = FALSE;
2922
2923         for (cur = p->packets; cur; cur = cur->next) {
2924                 if (cur->seqno == seqno && cur->is_resp == resp &&
2925                         (cur->is_resp || method_match(sipmethod, cur->data->str))) {
2926                         /* this is our baby */
2927                         if (cur->retransid > -1) {
2928                                 if (sipdebug)
2929                                         ast_debug(4, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2930                         }
2931                         AST_SCHED_DEL(sched, cur->retransid);
2932                         res = TRUE;
2933                         break;
2934                 }
2935         }
2936         ast_debug(1, "(Provisional) Stopping retransmission (but retaining packet) on '%s' %s %d: %s\n", p->callid, resp ? "Response" : "Request", seqno, res == -1 ? "Not Found" : "Found");
2937         return res;
2938 }
2939
2940
2941 /*! \brief Copy SIP request, parse it */
2942 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2943 {
2944         copy_request(dst, src);
2945         parse_request(dst);
2946 }
2947
2948 /*! \brief add a blank line if no body */
2949 static void add_blank(struct sip_request *req)
2950 {
2951         if (!req->lines) {
2952                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2953                 ast_str_append(&req->data, 0, "\r\n");
2954                 req->len = ast_str_strlen(req->data);
2955         }
2956 }
2957
2958 static int send_provisional_keepalive_full(struct sip_pvt *pvt, int with_sdp)
2959 {
2960         const char *msg = NULL;
2961
2962         if (!pvt->last_provisional || !strncasecmp(pvt->last_provisional, "100", 3)) {
2963                 msg = "183 Session Progress";
2964         }
2965
2966         if (pvt->invitestate < INV_COMPLETED) {
2967                 if (with_sdp) {
2968                         transmit_response_with_sdp(pvt, S_OR(msg, pvt->last_provisional), &pvt->initreq, XMIT_UNRELIABLE, FALSE, FALSE);
2969                 } else {
2970                         transmit_response(pvt, S_OR(msg, pvt->last_provisional), &pvt->initreq);
2971                 }
2972                 return PROVIS_KEEPALIVE_TIMEOUT;
2973         }
2974
2975         return 0;
2976 }
2977
2978 static int send_provisional_keepalive(const void *data) {
2979         struct sip_pvt *pvt = (struct sip_pvt *) data;
2980
2981         return send_provisional_keepalive_full(pvt, 0);
2982 }
2983
2984 static int send_provisional_keepalive_with_sdp(const void *data) {
2985         struct sip_pvt *pvt = (void *)data;
2986
2987         return send_provisional_keepalive_full(pvt, 1);
2988 }
2989
2990 static void update_provisional_keepalive(struct sip_pvt *pvt, int with_sdp)
2991 {
2992         AST_SCHED_DEL_UNREF(sched, pvt->provisional_keepalive_sched_id, dialog_unref(pvt, "when you delete the provisional_keepalive_sched_id, you should dec the refcount for the stored dialog ptr"));
2993
2994         pvt->provisional_keepalive_sched_id = ast_sched_add(sched, PROVIS_KEEPALIVE_TIMEOUT,
2995                 with_sdp ? send_provisional_keepalive_with_sdp : send_provisional_keepalive, dialog_ref(pvt, "Increment refcount to pass dialog pointer to sched callback"));
2996 }
2997
2998 /*! \brief Transmit response on SIP request*/
2999 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
3000 {
3001         int res;
3002
3003         add_blank(req);
3004         if (sip_debug_test_pvt(p)) {
3005                 const struct sockaddr_in *dst = sip_real_dst(p);
3006
3007                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
3008                         reliable ? "Reliably " : "", sip_nat_mode(p),
3009                         ast_inet_ntoa(dst->sin_addr),
3010                         ntohs(dst->sin_port), req->data->str);
3011         }
3012         if (p->do_history) {
3013                 struct sip_request tmp = { .rlPart1 = 0, };
3014                 parse_copy(&tmp, req);
3015                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data->str, get_header(&tmp, "CSeq"),
3016                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? REQ_OFFSET_TO_STR(&tmp, rlPart2) : sip_methods[tmp.method].text);
3017                 ast_free(tmp.data);
3018         }