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