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