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