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