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