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