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