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