chan_sip: Support auth username for callbackextension feature
[asterisk/asterisk.git] / channels / chan_sip.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2012, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief Implementation of Session Initiation Protocol
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * See Also:
26  * \arg \ref AstCREDITS
27  *
28  * Implementation of RFC 3261 - without S/MIME, and experimental TCP and TLS support
29  * Configuration file \link Config_sip sip.conf \endlink
30  *
31  * ********** IMPORTANT *
32  * \note TCP/TLS support is EXPERIMENTAL and WILL CHANGE. This applies to configuration
33  *      settings, dialplan commands and dialplans apps/functions
34  * See \ref sip_tcp_tls
35  *
36  *
37  * ******** General TODO:s
38  * \todo Better support of forking
39  * \todo VIA branch tag transaction checking
40  * \todo Transaction support
41  *
42  * ******** Wishlist: Improvements
43  * - Support of SIP domains for devices, so that we match on username\@domain in the From: header
44  * - Connect registrations with a specific device on the incoming call. It's not done
45  *   automatically in Asterisk
46  *
47  * \ingroup channel_drivers
48  *
49  * \par Overview of the handling of SIP sessions
50  * The SIP channel handles several types of SIP sessions, or dialogs,
51  * not all of them being "telephone calls".
52  * - Incoming calls that will be sent to the PBX core
53  * - Outgoing calls, generated by the PBX
54  * - SIP subscriptions and notifications of states and voicemail messages
55  * - SIP registrations, both inbound and outbound
56  * - SIP peer management (peerpoke, OPTIONS)
57  * - SIP text messages
58  *
59  * In the SIP channel, there's a list of active SIP dialogs, which includes
60  * all of these when they are active. "sip show channels" in the CLI will
61  * show most of these, excluding subscriptions which are shown by
62  * "sip show subscriptions"
63  *
64  * \par incoming packets
65  * Incoming packets are received in the monitoring thread, then handled by
66  * sipsock_read() for udp only. In tcp, packets are read by the tcp_helper thread.
67  * sipsock_read() function parses the packet and matches an existing
68  * dialog or starts a new SIP dialog.
69  *
70  * sipsock_read sends the packet to handle_incoming(), that parses a bit more.
71  * If it is a response to an outbound request, the packet is sent to handle_response().
72  * If it is a request, handle_incoming() sends it to one of a list of functions
73  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
74  * sipsock_read locks the ast_channel if it exists (an active call) and
75  * unlocks it after we have processed the SIP message.
76  *
77  * A new INVITE is sent to handle_request_invite(), that will end up
78  * starting a new channel in the PBX, the new channel after that executing
79  * in a separate channel thread. This is an incoming "call".
80  * When the call is answered, either by a bridged channel or the PBX itself
81  * the sip_answer() function is called.
82  *
83  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
84  * in rtp.c
85  *
86  * \par Outbound calls
87  * Outbound calls are set up by the PBX through the sip_request_call()
88  * function. After that, they are activated by sip_call().
89  *
90  * \par Hanging up
91  * The PBX issues a hangup on both incoming and outgoing calls through
92  * the sip_hangup() function
93  */
94
95 /*! \li \ref chan_sip.c uses configuration files \ref sip.conf and \ref sip_notify.conf
96  * \addtogroup configuration_file
97  */
98
99 /*! \page sip.conf sip.conf
100  * \verbinclude sip.conf.sample
101  */
102
103 /*! \page sip_notify.conf sip_notify.conf
104  * \verbinclude sip_notify.conf.sample
105  */
106
107 /*!
108  * \page sip_tcp_tls SIP TCP and TLS support
109  *
110  * \par tcpfixes TCP implementation changes needed
111  * \todo Fix TCP/TLS handling in dialplan, SRV records, transfers and much more
112  * \todo Save TCP/TLS sessions in registry
113  *      If someone registers a SIPS uri, this forces us to set up a TLS connection back.
114  * \todo Add TCP/TLS information to function SIPPEER and CHANNEL function
115  * \todo If tcpenable=yes, we must open a TCP socket on the same address as the IP for UDP.
116  *      The tcpbindaddr config option should only be used to open ADDITIONAL ports
117  *      So we should propably go back to
118  *              bindaddr= the default address to bind to. If tcpenable=yes, then bind this to both udp and TCP
119  *                              if tlsenable=yes, open TLS port (provided we also have cert)
120  *              tcpbindaddr = extra address for additional TCP connections
121  *              tlsbindaddr = extra address for additional TCP/TLS connections
122  *              udpbindaddr = extra address for additional UDP connections
123  *                      These three options should take multiple IP/port pairs
124  *      Note: Since opening additional listen sockets is a *new* feature we do not have today
125  *              the XXXbindaddr options needs to be disabled until we have support for it
126  *
127  * \todo re-evaluate the transport= setting in sip.conf. This is right now not well
128  *      thought of. If a device in sip.conf contacts us via TCP, we should not switch transport,
129  *      even if udp is the configured first transport.
130  *
131  * \todo Be prepared for one outbound and another incoming socket per pvt. This applies
132  *       specially to communication with other peers (proxies).
133  * \todo We need to test TCP sessions with SIP proxies and in regards
134  *       to the SIP outbound specs.
135  * \todo ;transport=tls was deprecated in RFC3261 and should not be used at all. See section 26.2.2.
136  *
137  * \todo If the message is smaller than the given Content-length, the request should get a 400 Bad request
138  *       message. If it's a response, it should be dropped. (RFC 3261, Section 18.3)
139  * \todo Since we have had multidomain support in Asterisk for quite a while, we need to support
140  *       multiple domains in our TLS implementation, meaning one socket and one cert per domain
141  * \todo Selection of transport for a request needs to be done after we've parsed all route headers,
142  *       also considering outbound proxy options.
143  *              First request: Outboundproxy, routes, (reg contact or URI. If URI doesn't have port:  DNS naptr, srv, AAA)
144  *              Intermediate requests: Outboundproxy(only when forced), routes, contact/uri
145  *      DNS naptr support is crucial. A SIP uri might lead to a TLS connection.
146  *      Also note that due to outbound proxy settings, a SIPS uri might have to be sent on UDP (not to recommend though)
147  * \todo Default transports are set to UDP, which cause the wrong behaviour when contacting remote
148  *      devices directly from the dialplan. UDP is only a fallback if no other method works,
149  *      in order to be compatible with RFC2543 (SIP/1.0) devices. For transactions that exceed the
150  *      MTU (like INIVTE with video, audio and RTT)  TCP should be preferred.
151  *
152  *      When dialling unconfigured peers (with no port number)  or devices in external domains
153  *      NAPTR records MUST be consulted to find configured transport. If they are not found,
154  *      SRV records for both TCP and UDP should be checked. If there's a record for TCP, use that.
155  *      If there's no record for TCP, then use UDP as a last resort. If there's no SRV records,
156  *      \note this only applies if there's no outbound proxy configured for the session. If an outbound
157  *      proxy is configured, these procedures might apply for locating the proxy and determining
158  *      the transport to use for communication with the proxy.
159  * \par Other bugs to fix ----
160  * __set_address_from_contact(const char *fullcontact, struct sockaddr_in *sin, int tcp)
161  *      - sets TLS port as default for all TCP connections, unless other port is given in contact.
162  * parse_register_contact(struct sip_pvt *pvt, struct sip_peer *peer, struct sip_request *req)
163  *      - assumes that the contact the UA registers is using the same transport as the REGISTER request, which is
164  *        a bad guess.
165  *      - Does not save any information about TCP/TLS connected devices, which is a severe BUG, as discussed on the mailing list.
166  * get_destination(struct sip_pvt *p, struct sip_request *oreq)
167  *      - Doesn't store the information that we got an incoming SIPS request in the channel, so that
168  *        we can require a secure signalling path OUT of Asterisk (on SIP or IAX2). Possibly, the call should
169  *        fail on in-secure signalling paths if there's no override in our configuration. At least, provide a
170  *        channel variable in the dialplan.
171  * get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req)
172  *      - As above, if we have a SIPS: uri in the refer-to header
173  *      - Does not check transport in refer_to uri.
174  */
175
176 /*** MODULEINFO
177         <use type="module">res_crypto</use>
178         <use type="module">res_http_websocket</use>
179         <support_level>extended</support_level>
180  ***/
181
182 /*!  \page sip_session_timers SIP Session Timers in Asterisk Chan_sip
183
184         The SIP Session-Timers is an extension of the SIP protocol that allows end-points and proxies to
185         refresh a session periodically. The sessions are kept alive by sending a RE-INVITE or UPDATE
186         request at a negotiated interval. If a session refresh fails then all the entities that support Session-
187         Timers clear their internal session state. In addition, UAs generate a BYE request in order to clear
188         the state in the proxies and the remote UA (this is done for the benefit of SIP entities in the path
189         that do not support Session-Timers).
190
191         The Session-Timers can be configured on a system-wide, per-user, or per-peer basis. The peruser/
192         per-peer settings override the global settings. The following new parameters have been
193         added to the sip.conf file.
194                 session-timers=["accept", "originate", "refuse"]
195                 session-expires=[integer]
196                 session-minse=[integer]
197                 session-refresher=["uas", "uac"]
198
199         The session-timers parameter in sip.conf defines the mode of operation of SIP session-timers feature in
200         Asterisk. The Asterisk can be configured in one of the following three modes:
201
202         1. Accept :: In the "accept" mode, the Asterisk server honors session-timers requests
203                 made by remote end-points. A remote end-point can request Asterisk to engage
204                 session-timers by either sending it an INVITE request with a "Supported: timer"
205                 header in it or by responding to Asterisk's INVITE with a 200 OK that contains
206                 Session-Expires: header in it. In this mode, the Asterisk server does not
207                 request session-timers from remote end-points. This is the default mode.
208         2. Originate :: In the "originate" mode, the Asterisk server requests the remote
209                 end-points to activate session-timers in addition to honoring such requests
210                 made by the remote end-pints. In order to get as much protection as possible
211                 against hanging SIP channels due to network or end-point failures, Asterisk
212                 resends periodic re-INVITEs even if a remote end-point does not support
213                 the session-timers feature.
214         3. Refuse :: In the "refuse" mode, Asterisk acts as if it does not support session-
215                 timers for inbound or outbound requests. If a remote end-point requests
216                 session-timers in a dialog, then Asterisk ignores that request unless it's
217                 noted as a requirement (Require: header), in which case the INVITE is
218                 rejected with a 420 Bad Extension response.
219
220 */
221
222 #include "asterisk.h"
223
224 ASTERISK_REGISTER_FILE()
225
226 #include <signal.h>
227 #include <sys/signal.h>
228 #include <regex.h>
229 #include <inttypes.h>
230
231 #include "asterisk/network.h"
232 #include "asterisk/paths.h"     /* need ast_config_AST_SYSTEM_NAME */
233 #include "asterisk/lock.h"
234 #include "asterisk/config.h"
235 #include "asterisk/module.h"
236 #include "asterisk/pbx.h"
237 #include "asterisk/sched.h"
238 #include "asterisk/io.h"
239 #include "asterisk/rtp_engine.h"
240 #include "asterisk/udptl.h"
241 #include "asterisk/acl.h"
242 #include "asterisk/manager.h"
243 #include "asterisk/callerid.h"
244 #include "asterisk/cli.h"
245 #include "asterisk/musiconhold.h"
246 #include "asterisk/dsp.h"
247 #include "asterisk/pickup.h"
248 #include "asterisk/parking.h"
249 #include "asterisk/srv.h"
250 #include "asterisk/astdb.h"
251 #include "asterisk/causes.h"
252 #include "asterisk/utils.h"
253 #include "asterisk/file.h"
254 #include "asterisk/astobj2.h"
255 #include "asterisk/dnsmgr.h"
256 #include "asterisk/devicestate.h"
257 #include "asterisk/netsock2.h"
258 #include "asterisk/localtime.h"
259 #include "asterisk/abstract_jb.h"
260 #include "asterisk/threadstorage.h"
261 #include "asterisk/translate.h"
262 #include "asterisk/ast_version.h"
263 #include "asterisk/data.h"
264 #include "asterisk/aoc.h"
265 #include "asterisk/message.h"
266 #include "sip/include/sip.h"
267 #include "sip/include/globals.h"
268 #include "sip/include/config_parser.h"
269 #include "sip/include/reqresp_parser.h"
270 #include "sip/include/sip_utils.h"
271 #include "asterisk/sdp_srtp.h"
272 #include "asterisk/ccss.h"
273 #include "asterisk/xml.h"
274 #include "sip/include/dialog.h"
275 #include "sip/include/dialplan_functions.h"
276 #include "sip/include/security_events.h"
277 #include "sip/include/route.h"
278 #include "asterisk/sip_api.h"
279 #include "asterisk/app.h"
280 #include "asterisk/bridge.h"
281 #include "asterisk/stasis.h"
282 #include "asterisk/stasis_endpoints.h"
283 #include "asterisk/stasis_system.h"
284 #include "asterisk/stasis_channels.h"
285 #include "asterisk/features_config.h"
286 #include "asterisk/http_websocket.h"
287 #include "asterisk/format_cache.h"
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="SIPMessageFromInfo" 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="SIPMessageToInfo" 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
1282 /*--- Applications, functions, CLI and manager command helpers */
1283 static const char *sip_nat_mode(const struct sip_pvt *p);
1284 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1285 static char *transfermode2str(enum transfermodes mode) attribute_const;
1286 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1287 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1288 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1289 static struct sip_peer *_sip_show_peers_one(int fd, struct mansession *s, struct show_peers_context *cont, struct sip_peer *peer);
1290 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1291 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1292 static void  print_group(int fd, ast_group_t group, int crlf);
1293 static void  print_named_groups(int fd, struct ast_namedgroups *groups, int crlf);
1294 static const char *dtmfmode2str(int mode) attribute_const;
1295 static int str2dtmfmode(const char *str) attribute_unused;
1296 static const char *insecure2str(int mode) attribute_const;
1297 static const char *allowoverlap2str(int mode) attribute_const;
1298 static void cleanup_stale_contexts(char *new, char *old);
1299 static const char *domain_mode_to_text(const enum domain_mode mode);
1300 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1301 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1302 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1303 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1304 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1305 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1306 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1307 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1308 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1309 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1310 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1311 static char *complete_sip_peer(const char *word, int state, int flags2);
1312 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1313 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1314 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1315 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1316 static char *complete_sip_notify(const char *line, const char *word, int pos, int state);
1317 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1318 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1319 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1320 static char *sip_do_debug_ip(int fd, const char *arg);
1321 static char *sip_do_debug_peer(int fd, const char *arg);
1322 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1323 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1324 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1325 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
1326 static int sip_addheader(struct ast_channel *chan, const char *data);
1327 static int sip_do_reload(enum channelreloadreason reason);
1328 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1329 static int ast_sockaddr_resolve_first_af(struct ast_sockaddr *addr,
1330                                       const char *name, int flag, int family);
1331 static int ast_sockaddr_resolve_first(struct ast_sockaddr *addr,
1332                                       const char *name, int flag);
1333 static int ast_sockaddr_resolve_first_transport(struct ast_sockaddr *addr,
1334                                                 const char *name, int flag, unsigned int transport);
1335
1336 /*--- Debugging
1337         Functions for enabling debug per IP or fully, or enabling history logging for
1338         a SIP dialog
1339 */
1340 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1341 static inline int sip_debug_test_addr(const struct ast_sockaddr *addr);
1342 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1343 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1344 static void sip_dump_history(struct sip_pvt *dialog);
1345
1346 /*--- Device object handling */
1347 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime, int devstate_only);
1348 static int update_call_counter(struct sip_pvt *fup, int event);
1349 static void sip_destroy_peer(struct sip_peer *peer);
1350 static void sip_destroy_peer_fn(void *peer);
1351 static void set_peer_defaults(struct sip_peer *peer);
1352 static struct sip_peer *temp_peer(const char *name);
1353 static void register_peer_exten(struct sip_peer *peer, int onoff);
1354 static int sip_poke_peer_s(const void *data);
1355 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1356 static void reg_source_db(struct sip_peer *peer);
1357 static void destroy_association(struct sip_peer *peer);
1358 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1359 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1360 static void set_socket_transport(struct sip_socket *socket, int transport);
1361 static int peer_ipcmp_cb_full(void *obj, void *arg, void *data, int flags);
1362
1363 /* Realtime device support */
1364 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);
1365 static void update_peer(struct sip_peer *p, int expire);
1366 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1367 static const char *get_name_from_variable(const struct ast_variable *var);
1368 static struct sip_peer *realtime_peer(const char *peername, struct ast_sockaddr *sin, char *callbackexten, int devstate_only, int which_objects);
1369 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1370
1371 /*--- Internal UA client handling (outbound registrations) */
1372 static void ast_sip_ouraddrfor(const struct ast_sockaddr *them, struct ast_sockaddr *us, struct sip_pvt *p);
1373 static void sip_registry_destroy(void *reg);
1374 static int sip_register(const char *value, int lineno);
1375 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1376 static int __sip_do_register(struct sip_registry *r);
1377 static int sip_reg_timeout(const void *data);
1378 static void sip_send_all_registers(void);
1379 static int sip_reinvite_retry(const void *data);
1380
1381 /*--- Parsing SIP requests and responses */
1382 static int determine_firstline_parts(struct sip_request *req);
1383 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1384 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1385 static int find_sip_method(const char *msg);
1386 static unsigned int parse_allowed_methods(struct sip_request *req);
1387 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
1388 static int parse_request(struct sip_request *req);
1389 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1390 static int method_match(enum sipmethod id, const char *name);
1391 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1392 static void parse_oli(struct sip_request *req, struct ast_channel *chan);
1393 static const char *find_alias(const char *name, const char *_default);
1394 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1395 static void lws2sws(struct ast_str *msgbuf);
1396 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1397 static char *remove_uri_parameters(char *uri);
1398 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1399 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1400 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1401 static int use_reason_header(struct sip_pvt *pvt, struct sip_request *req);
1402 static int set_address_from_contact(struct sip_pvt *pvt);
1403 static void check_via(struct sip_pvt *p, const struct sip_request *req);
1404 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
1405 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason, char **reason_str);
1406 static enum sip_get_dest_result get_destination(struct sip_pvt *p, struct sip_request *oreq, int *cc_recall_core_id);
1407 static int transmit_state_notify(struct sip_pvt *p, struct state_notify_data *data, int full, int timeout);
1408 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
1409 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
1410 static int get_domain(const char *str, char *domain, int len);
1411 static void get_realm(struct sip_pvt *p, const struct sip_request *req);
1412 static char *get_content(struct sip_request *req);
1413
1414 /*-- TCP connection handling ---*/
1415 static void *_sip_tcp_helper_thread(struct ast_tcptls_session_instance *tcptls_session);
1416 static void *sip_tcp_worker_fn(void *);
1417
1418 /*--- Constructing requests and responses */
1419 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1420 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1421 static void deinit_req(struct sip_request *req);
1422 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, uint32_t seqno, int newbranch);
1423 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, const char * const explicit_uri);
1424 static int init_resp(struct sip_request *resp, const char *msg);
1425 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
1426 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1427 static const struct ast_sockaddr *sip_real_dst(const struct sip_pvt *p);
1428 static void build_via(struct sip_pvt *p);
1429 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1430 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct ast_sockaddr *addr, int newdialog);
1431 static char *generate_random_string(char *buf, size_t size);
1432 static void build_callid_pvt(struct sip_pvt *pvt);
1433 static void change_callid_pvt(struct sip_pvt *pvt, const char *callid);
1434 static void build_callid_registry(struct sip_registry *reg, const struct ast_sockaddr *ourip, const char *fromdomain);
1435 static void build_localtag_registry(struct sip_registry *reg);
1436 static void make_our_tag(struct sip_pvt *pvt);
1437 static int add_header(struct sip_request *req, const char *var, const char *value);
1438 static int add_max_forwards(struct sip_pvt *dialog, struct sip_request *req);
1439 static int add_content(struct sip_request *req, const char *line);
1440 static int finalize_content(struct sip_request *req);
1441 static void destroy_msg_headers(struct sip_pvt *pvt);
1442 static int add_text(struct sip_request *req, struct sip_pvt *p);
1443 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1444 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
1445 static int add_vidupdate(struct sip_request *req);
1446 static void add_route(struct sip_request *req, struct sip_route *route, int skip);
1447 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1448 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1449 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1450 static void set_destination(struct sip_pvt *p, const char *uri);
1451 static void add_date(struct sip_request *req);
1452 static void add_expires(struct sip_request *req, int expires);
1453 static void build_contact(struct sip_pvt *p, struct sip_request *req, int incoming);
1454
1455 /*------Request handling functions */
1456 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, int *recount, int *nounlock);
1457 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
1458 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);
1459 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, uint32_t seqno, int *nounlock);
1460 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1461 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *sin, const char *e);
1462 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1463 static int handle_request_message(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1464 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, const char *e);
1465 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1466 static int handle_request_options(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1467 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req,
1468                 int *nounlock, struct sip_pvt *replaces_pvt, struct ast_channel *replaces_chan);
1469 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, const char *e);
1470 static int local_attended_transfer(struct sip_pvt *transferer, struct ast_channel *transferer_chan, uint32_t seqno, int *nounlock);
1471
1472 /*------Response handling functions */
1473 static void handle_response_publish(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1474 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1475 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1476 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1477 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1478 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1479 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1480
1481 /*------ SRTP Support -------- */
1482 static int process_crypto(struct sip_pvt *p, struct ast_rtp_instance *rtp, struct ast_sdp_srtp **srtp, const char *a);
1483
1484 /*------ T38 Support --------- */
1485 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1486 static void change_t38_state(struct sip_pvt *p, int state);
1487
1488 /*------ Session-Timers functions --------- */
1489 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
1490 static void stop_session_timer(struct sip_pvt *p);
1491 static void start_session_timer(struct sip_pvt *p);
1492 static void restart_session_timer(struct sip_pvt *p);
1493 static const char *strefresherparam2str(enum st_refresher_param r);
1494 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher_param *const p_ref);
1495 static int parse_minse(const char *p_hdrval, int *const p_interval);
1496 static int st_get_se(struct sip_pvt *, int max);
1497 static enum st_refresher st_get_refresher(struct sip_pvt *);
1498 static enum st_mode st_get_mode(struct sip_pvt *, int no_cached);
1499 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
1500
1501 /*------- RTP Glue functions -------- */
1502 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);
1503
1504 /*!--- SIP MWI Subscription support */
1505 static int sip_subscribe_mwi(const char *value, int lineno);
1506 static void sip_send_all_mwi_subscriptions(void);
1507 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
1508
1509 /* Scheduler id start/stop/reschedule functions. */
1510 static void stop_provisional_keepalive(struct sip_pvt *pvt);
1511 static void do_stop_session_timer(struct sip_pvt *pvt);
1512 static void stop_reinvite_retry(struct sip_pvt *pvt);
1513 static void stop_retrans_pkt(struct sip_pkt *pkt);
1514 static void stop_t38_abort_timer(struct sip_pvt *pvt);
1515
1516 /*! \brief Definition of this channel for PBX channel registration */
1517 struct ast_channel_tech sip_tech = {
1518         .type = "SIP",
1519         .description = "Session Initiation Protocol (SIP)",
1520         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1521         .requester = sip_request_call,                  /* called with chan unlocked */
1522         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1523         .call = sip_call,                       /* called with chan locked */
1524         .send_html = sip_sendhtml,
1525         .hangup = sip_hangup,                   /* called with chan locked */
1526         .answer = sip_answer,                   /* called with chan locked */
1527         .read = sip_read,                       /* called with chan locked */
1528         .write = sip_write,                     /* called with chan locked */
1529         .write_video = sip_write,               /* called with chan locked */
1530         .write_text = sip_write,
1531         .indicate = sip_indicate,               /* called with chan locked */
1532         .transfer = sip_transfer,               /* called with chan locked */
1533         .fixup = sip_fixup,                     /* called with chan locked */
1534         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1535         .send_digit_end = sip_senddigit_end,
1536         .early_bridge = ast_rtp_instance_early_bridge,
1537         .send_text = sip_sendtext,              /* called with chan locked */
1538         .func_channel_read = sip_acf_channel_read,
1539         .setoption = sip_setoption,
1540         .queryoption = sip_queryoption,
1541         .get_pvt_uniqueid = sip_get_callid,
1542 };
1543
1544 /*! \brief This version of the sip channel tech has no send_digit_begin
1545  * callback so that the core knows that the channel does not want
1546  * DTMF BEGIN frames.
1547  * The struct is initialized just before registering the channel driver,
1548  * and is for use with channels using SIP INFO DTMF.
1549  */
1550 struct ast_channel_tech sip_tech_info;
1551
1552 /*------- CC Support -------- */
1553 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan);
1554 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
1555 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
1556 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
1557 static int sip_cc_agent_status_request(struct ast_cc_agent *agent);
1558 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent);
1559 static int sip_cc_agent_recall(struct ast_cc_agent *agent);
1560 static void sip_cc_agent_destructor(struct ast_cc_agent *agent);
1561
1562 static struct ast_cc_agent_callbacks sip_cc_agent_callbacks = {
1563         .type = "SIP",
1564         .init = sip_cc_agent_init,
1565         .start_offer_timer = sip_cc_agent_start_offer_timer,
1566         .stop_offer_timer = sip_cc_agent_stop_offer_timer,
1567         .respond = sip_cc_agent_respond,
1568         .status_request = sip_cc_agent_status_request,
1569         .start_monitoring = sip_cc_agent_start_monitoring,
1570         .callee_available = sip_cc_agent_recall,
1571         .destructor = sip_cc_agent_destructor,
1572 };
1573
1574 /* -------- End of declarations of structures, constants and forward declarations of functions
1575    Below starts actual code
1576    ------------------------
1577 */
1578
1579 static int sip_epa_register(const struct epa_static_data *static_data)
1580 {
1581         struct epa_backend *backend = ast_calloc(1, sizeof(*backend));
1582
1583         if (!backend) {
1584                 return -1;
1585         }
1586
1587         backend->static_data = static_data;
1588
1589         AST_LIST_LOCK(&epa_static_data_list);
1590         AST_LIST_INSERT_TAIL(&epa_static_data_list, backend, next);
1591         AST_LIST_UNLOCK(&epa_static_data_list);
1592         return 0;
1593 }
1594
1595 static void sip_epa_unregister_all(void)
1596 {
1597         struct epa_backend *backend;
1598
1599         AST_LIST_LOCK(&epa_static_data_list);
1600         while ((backend = AST_LIST_REMOVE_HEAD(&epa_static_data_list, next))) {
1601                 ast_free(backend);
1602         }
1603         AST_LIST_UNLOCK(&epa_static_data_list);
1604 }
1605
1606 static void cc_handle_publish_error(struct sip_pvt *pvt, const int resp, struct sip_request *req, struct sip_epa_entry *epa_entry);
1607
1608 static void cc_epa_destructor(void *data)
1609 {
1610         struct sip_epa_entry *epa_entry = data;
1611         struct cc_epa_entry *cc_entry = epa_entry->instance_data;
1612         ast_free(cc_entry);
1613 }
1614
1615 static const struct epa_static_data cc_epa_static_data  = {
1616         .event = CALL_COMPLETION,
1617         .name = "call-completion",
1618         .handle_error = cc_handle_publish_error,
1619         .destructor = cc_epa_destructor,
1620 };
1621
1622 static const struct epa_static_data *find_static_data(const char * const event_package)
1623 {
1624         const struct epa_backend *backend = NULL;
1625
1626         AST_LIST_LOCK(&epa_static_data_list);
1627         AST_LIST_TRAVERSE(&epa_static_data_list, backend, next) {
1628                 if (!strcmp(backend->static_data->name, event_package)) {
1629                         break;
1630                 }
1631         }
1632         AST_LIST_UNLOCK(&epa_static_data_list);
1633         return backend ? backend->static_data : NULL;
1634 }
1635
1636 static struct sip_epa_entry *create_epa_entry (const char * const event_package, const char * const destination)
1637 {
1638         struct sip_epa_entry *epa_entry;
1639         const struct epa_static_data *static_data;
1640
1641         if (!(static_data = find_static_data(event_package))) {
1642                 return NULL;
1643         }
1644
1645         if (!(epa_entry = ao2_t_alloc(sizeof(*epa_entry), static_data->destructor, "Allocate new EPA entry"))) {
1646                 return NULL;
1647         }
1648
1649         epa_entry->static_data = static_data;
1650         ast_copy_string(epa_entry->destination, destination, sizeof(epa_entry->destination));
1651         return epa_entry;
1652 }
1653 static enum ast_cc_service_type service_string_to_service_type(const char * const service_string)
1654 {
1655         enum ast_cc_service_type service;
1656         for (service = AST_CC_CCBS; service <= AST_CC_CCNL; ++service) {
1657                 if (!strcasecmp(service_string, sip_cc_service_map[service].service_string)) {
1658                         return service;
1659                 }
1660         }
1661         return AST_CC_NONE;
1662 }
1663
1664 /* Even state compositors code */
1665 static void esc_entry_destructor(void *obj)
1666 {
1667         struct sip_esc_entry *esc_entry = obj;
1668         if (esc_entry->sched_id > -1) {
1669                 AST_SCHED_DEL(sched, esc_entry->sched_id);
1670         }
1671 }
1672
1673 static int esc_hash_fn(const void *obj, const int flags)
1674 {
1675         const struct sip_esc_entry *entry = obj;
1676         return ast_str_hash(entry->entity_tag);
1677 }
1678
1679 static int esc_cmp_fn(void *obj, void *arg, int flags)
1680 {
1681         struct sip_esc_entry *entry1 = obj;
1682         struct sip_esc_entry *entry2 = arg;
1683
1684         return (!strcmp(entry1->entity_tag, entry2->entity_tag)) ? (CMP_MATCH | CMP_STOP) : 0;
1685 }
1686
1687 static struct event_state_compositor *get_esc(const char * const event_package) {
1688         int i;
1689         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1690                 if (!strcasecmp(event_package, event_state_compositors[i].name)) {
1691                         return &event_state_compositors[i];
1692                 }
1693         }
1694         return NULL;
1695 }
1696
1697 static struct sip_esc_entry *get_esc_entry(const char * entity_tag, struct event_state_compositor *esc) {
1698         struct sip_esc_entry *entry;
1699         struct sip_esc_entry finder;
1700
1701         ast_copy_string(finder.entity_tag, entity_tag, sizeof(finder.entity_tag));
1702
1703         entry = ao2_find(esc->compositor, &finder, OBJ_POINTER);
1704
1705         return entry;
1706 }
1707
1708 static int publish_expire(const void *data)
1709 {
1710         struct sip_esc_entry *esc_entry = (struct sip_esc_entry *) data;
1711         struct event_state_compositor *esc = get_esc(esc_entry->event);
1712
1713         ast_assert(esc != NULL);
1714
1715         ao2_unlink(esc->compositor, esc_entry);
1716         esc_entry->sched_id = -1;
1717         ao2_ref(esc_entry, -1);
1718         return 0;
1719 }
1720
1721 static void create_new_sip_etag(struct sip_esc_entry *esc_entry, int is_linked)
1722 {
1723         int new_etag = ast_atomic_fetchadd_int(&esc_etag_counter, +1);
1724         struct event_state_compositor *esc = get_esc(esc_entry->event);
1725
1726         ast_assert(esc != NULL);
1727         if (is_linked) {
1728                 ao2_unlink(esc->compositor, esc_entry);
1729         }
1730         snprintf(esc_entry->entity_tag, sizeof(esc_entry->entity_tag), "%d", new_etag);
1731         ao2_link(esc->compositor, esc_entry);
1732 }
1733
1734 static struct sip_esc_entry *create_esc_entry(struct event_state_compositor *esc, struct sip_request *req, const int expires)
1735 {
1736         struct sip_esc_entry *esc_entry;
1737         int expires_ms;
1738
1739         if (!(esc_entry = ao2_alloc(sizeof(*esc_entry), esc_entry_destructor))) {
1740                 return NULL;
1741         }
1742
1743         esc_entry->event = esc->name;
1744
1745         expires_ms = expires * 1000;
1746         /* Bump refcount for scheduler */
1747         ao2_ref(esc_entry, +1);
1748         esc_entry->sched_id = ast_sched_add(sched, expires_ms, publish_expire, esc_entry);
1749         if (esc_entry->sched_id == -1) {
1750                 ao2_ref(esc_entry, -1);
1751                 ao2_ref(esc_entry, -1);
1752                 return NULL;
1753         }
1754
1755         /* Note: This links the esc_entry into the ESC properly */
1756         create_new_sip_etag(esc_entry, 0);
1757
1758         return esc_entry;
1759 }
1760
1761 static int initialize_escs(void)
1762 {
1763         int i, res = 0;
1764         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1765                 if (!((event_state_compositors[i].compositor) =
1766                                         ao2_container_alloc(ESC_MAX_BUCKETS, esc_hash_fn, esc_cmp_fn))) {
1767                         res = -1;
1768                 }
1769         }
1770         return res;
1771 }
1772
1773 static void destroy_escs(void)
1774 {
1775         int i;
1776         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1777                 ao2_cleanup(event_state_compositors[i].compositor);
1778         }
1779 }
1780
1781
1782 static int find_by_notify_uri_helper(void *obj, void *arg, int flags)
1783 {
1784         struct ast_cc_agent *agent = obj;
1785         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1786         const char *uri = arg;
1787
1788         return !sip_uri_cmp(agent_pvt->notify_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1789 }
1790
1791 static struct ast_cc_agent *find_sip_cc_agent_by_notify_uri(const char * const uri)
1792 {
1793         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_notify_uri_helper, (char *)uri, "SIP");
1794         return agent;
1795 }
1796
1797 static int find_by_subscribe_uri_helper(void *obj, void *arg, int flags)
1798 {
1799         struct ast_cc_agent *agent = obj;
1800         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1801         const char *uri = arg;
1802
1803         return !sip_uri_cmp(agent_pvt->subscribe_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1804 }
1805
1806 static struct ast_cc_agent *find_sip_cc_agent_by_subscribe_uri(const char * const uri)
1807 {
1808         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_subscribe_uri_helper, (char *)uri, "SIP");
1809         return agent;
1810 }
1811
1812 static int find_by_callid_helper(void *obj, void *arg, int flags)
1813 {
1814         struct ast_cc_agent *agent = obj;
1815         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1816         struct sip_pvt *call_pvt = arg;
1817
1818         return !strcmp(agent_pvt->original_callid, call_pvt->callid) ? CMP_MATCH | CMP_STOP : 0;
1819 }
1820
1821 static struct ast_cc_agent *find_sip_cc_agent_by_original_callid(struct sip_pvt *pvt)
1822 {
1823         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_callid_helper, pvt, "SIP");
1824         return agent;
1825 }
1826
1827 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan)
1828 {
1829         struct sip_cc_agent_pvt *agent_pvt = ast_calloc(1, sizeof(*agent_pvt));
1830         struct sip_pvt *call_pvt = ast_channel_tech_pvt(chan);
1831
1832         if (!agent_pvt) {
1833                 return -1;
1834         }
1835
1836         ast_assert(!strcmp(ast_channel_tech(chan)->type, "SIP"));
1837
1838         ast_copy_string(agent_pvt->original_callid, call_pvt->callid, sizeof(agent_pvt->original_callid));
1839         ast_copy_string(agent_pvt->original_exten, call_pvt->exten, sizeof(agent_pvt->original_exten));
1840         agent_pvt->offer_timer_id = -1;
1841         agent->private_data = agent_pvt;
1842         sip_pvt_lock(call_pvt);
1843         ast_set_flag(&call_pvt->flags[0], SIP_OFFER_CC);
1844         sip_pvt_unlock(call_pvt);
1845         return 0;
1846 }
1847
1848 static int sip_offer_timer_expire(const void *data)
1849 {
1850         struct ast_cc_agent *agent = (struct ast_cc_agent *) data;
1851         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1852
1853         agent_pvt->offer_timer_id = -1;
1854
1855         return ast_cc_failed(agent->core_id, "SIP agent %s's offer timer expired", agent->device_name);
1856 }
1857
1858 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent)
1859 {
1860         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1861         int when;
1862
1863         when = ast_get_cc_offer_timer(agent->cc_params) * 1000;
1864         agent_pvt->offer_timer_id = ast_sched_add(sched, when, sip_offer_timer_expire, agent);
1865         return 0;
1866 }
1867
1868 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent)
1869 {
1870         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1871
1872         AST_SCHED_DEL(sched, agent_pvt->offer_timer_id);
1873         return 0;
1874 }
1875
1876 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
1877 {
1878         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1879
1880         sip_pvt_lock(agent_pvt->subscribe_pvt);
1881         ast_set_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED);
1882         if (reason == AST_CC_AGENT_RESPONSE_SUCCESS || !ast_strlen_zero(agent_pvt->notify_uri)) {
1883                 /* The second half of this if statement may be a bit hard to grasp,
1884                  * so here's an explanation. When a subscription comes into
1885                  * chan_sip, as long as it is not malformed, it will be passed
1886                  * to the CC core. If the core senses an out-of-order state transition,
1887                  * then the core will call this callback with the "reason" set to a
1888                  * failure condition.
1889                  * However, an out-of-order state transition will occur during a resubscription
1890                  * for CC. In such a case, we can see that we have already generated a notify_uri
1891                  * and so we can detect that this isn't a *real* failure. Rather, it is just
1892                  * something the core doesn't recognize as a legitimate SIP state transition.
1893                  * Thus we respond with happiness and flowers.
1894                  */
1895                 transmit_response(agent_pvt->subscribe_pvt, "200 OK", &agent_pvt->subscribe_pvt->initreq);
1896                 transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_QUEUED);
1897         } else {
1898                 transmit_response(agent_pvt->subscribe_pvt, "500 Internal Error", &agent_pvt->subscribe_pvt->initreq);
1899         }
1900         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1901         agent_pvt->is_available = TRUE;
1902 }
1903
1904 static int sip_cc_agent_status_request(struct ast_cc_agent *agent)
1905 {
1906         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1907         enum ast_device_state state = agent_pvt->is_available ? AST_DEVICE_NOT_INUSE : AST_DEVICE_INUSE;
1908         return ast_cc_agent_status_response(agent->core_id, state);
1909 }
1910
1911 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent)
1912 {
1913         /* To start monitoring just means to wait for an incoming PUBLISH
1914          * to tell us that the caller has become available again. No special
1915          * action is needed
1916          */
1917         return 0;
1918 }
1919
1920 static int sip_cc_agent_recall(struct ast_cc_agent *agent)
1921 {
1922         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1923         /* If we have received a PUBLISH beforehand stating that the caller in question
1924          * is not available, we can save ourself a bit of effort here and just report
1925          * the caller as busy
1926          */
1927         if (!agent_pvt->is_available) {
1928                 return ast_cc_agent_caller_busy(agent->core_id, "Caller %s is busy, reporting to the core",
1929                                 agent->device_name);
1930         }
1931         /* Otherwise, we transmit a NOTIFY to the caller and await either
1932          * a PUBLISH or an INVITE
1933          */
1934         sip_pvt_lock(agent_pvt->subscribe_pvt);
1935         transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_READY);
1936         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1937         return 0;
1938 }
1939
1940 static void sip_cc_agent_destructor(struct ast_cc_agent *agent)
1941 {
1942         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1943
1944         if (!agent_pvt) {
1945                 /* The agent constructor probably failed. */
1946                 return;
1947         }
1948
1949         sip_cc_agent_stop_offer_timer(agent);
1950         if (agent_pvt->subscribe_pvt) {
1951                 sip_pvt_lock(agent_pvt->subscribe_pvt);
1952                 if (!ast_test_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED)) {
1953                         /* If we haven't sent a 200 OK for the SUBSCRIBE dialog yet, then we need to send a response letting
1954                          * the subscriber know something went wrong
1955                          */
1956                         transmit_response(agent_pvt->subscribe_pvt, "500 Internal Server Error", &agent_pvt->subscribe_pvt->initreq);
1957                 }
1958                 sip_pvt_unlock(agent_pvt->subscribe_pvt);
1959                 agent_pvt->subscribe_pvt = dialog_unref(agent_pvt->subscribe_pvt, "SIP CC agent destructor: Remove ref to subscription");
1960         }
1961         ast_free(agent_pvt);
1962 }
1963
1964
1965 static int sip_monitor_instance_hash_fn(const void *obj, const int flags)
1966 {
1967         const struct sip_monitor_instance *monitor_instance = obj;
1968         return monitor_instance->core_id;
1969 }
1970
1971 static int sip_monitor_instance_cmp_fn(void *obj, void *arg, int flags)
1972 {
1973         struct sip_monitor_instance *monitor_instance1 = obj;
1974         struct sip_monitor_instance *monitor_instance2 = arg;
1975
1976         return monitor_instance1->core_id == monitor_instance2->core_id ? CMP_MATCH | CMP_STOP : 0;
1977 }
1978
1979 static void sip_monitor_instance_destructor(void *data)
1980 {
1981         struct sip_monitor_instance *monitor_instance = data;
1982         if (monitor_instance->subscription_pvt) {
1983                 sip_pvt_lock(monitor_instance->subscription_pvt);
1984                 monitor_instance->subscription_pvt->expiry = 0;
1985                 transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 0, monitor_instance->subscribe_uri);
1986                 sip_pvt_unlock(monitor_instance->subscription_pvt);
1987                 dialog_unref(monitor_instance->subscription_pvt, "Unref monitor instance ref of subscription pvt");
1988         }
1989         if (monitor_instance->suspension_entry) {
1990                 monitor_instance->suspension_entry->body[0] = '\0';
1991                 transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_REMOVE ,monitor_instance->notify_uri);
1992                 ao2_t_ref(monitor_instance->suspension_entry, -1, "Decrementing suspension entry refcount in sip_monitor_instance_destructor");
1993         }
1994         ast_string_field_free_memory(monitor_instance);
1995 }
1996
1997 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)
1998 {
1999         struct sip_monitor_instance *monitor_instance = ao2_alloc(sizeof(*monitor_instance), sip_monitor_instance_destructor);
2000
2001         if (!monitor_instance) {
2002                 return NULL;
2003         }
2004
2005         if (ast_string_field_init(monitor_instance, 256)) {
2006                 ao2_ref(monitor_instance, -1);
2007                 return NULL;
2008         }
2009
2010         ast_string_field_set(monitor_instance, subscribe_uri, subscribe_uri);
2011         ast_string_field_set(monitor_instance, peername, peername);
2012         ast_string_field_set(monitor_instance, device_name, device_name);
2013         monitor_instance->core_id = core_id;
2014         ao2_link(sip_monitor_instances, monitor_instance);
2015         return monitor_instance;
2016 }
2017
2018 static int find_sip_monitor_instance_by_subscription_pvt(void *obj, void *arg, int flags)
2019 {
2020         struct sip_monitor_instance *monitor_instance = obj;
2021         return monitor_instance->subscription_pvt == arg ? CMP_MATCH | CMP_STOP : 0;
2022 }
2023
2024 static int find_sip_monitor_instance_by_suspension_entry(void *obj, void *arg, int flags)
2025 {
2026         struct sip_monitor_instance *monitor_instance = obj;
2027         return monitor_instance->suspension_entry == arg ? CMP_MATCH | CMP_STOP : 0;
2028 }
2029
2030 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
2031 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor);
2032 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
2033 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
2034 static void sip_cc_monitor_destructor(void *private_data);
2035
2036 static struct ast_cc_monitor_callbacks sip_cc_monitor_callbacks = {
2037         .type = "SIP",
2038         .request_cc = sip_cc_monitor_request_cc,
2039         .suspend = sip_cc_monitor_suspend,
2040         .unsuspend = sip_cc_monitor_unsuspend,
2041         .cancel_available_timer = sip_cc_monitor_cancel_available_timer,
2042         .destructor = sip_cc_monitor_destructor,
2043 };
2044
2045 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id)
2046 {
2047         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2048         enum ast_cc_service_type service = monitor->service_offered;
2049         int when;
2050
2051         if (!monitor_instance) {
2052                 return -1;
2053         }
2054
2055         if (!(monitor_instance->subscription_pvt = sip_alloc(NULL, NULL, 0, SIP_SUBSCRIBE, NULL, 0))) {
2056                 return -1;
2057         }
2058
2059         when = service == AST_CC_CCBS ? ast_get_ccbs_available_timer(monitor->interface->config_params) :
2060                 ast_get_ccnr_available_timer(monitor->interface->config_params);
2061
2062         sip_pvt_lock(monitor_instance->subscription_pvt);
2063         ast_set_flag(&monitor_instance->subscription_pvt->flags[0], SIP_OUTGOING);
2064         create_addr(monitor_instance->subscription_pvt, monitor_instance->peername, 0, 1);
2065         ast_sip_ouraddrfor(&monitor_instance->subscription_pvt->sa, &monitor_instance->subscription_pvt->ourip, monitor_instance->subscription_pvt);
2066         monitor_instance->subscription_pvt->subscribed = CALL_COMPLETION;
2067         monitor_instance->subscription_pvt->expiry = when;
2068
2069         transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 2, monitor_instance->subscribe_uri);
2070         sip_pvt_unlock(monitor_instance->subscription_pvt);
2071
2072         ao2_t_ref(monitor, +1, "Adding a ref to the monitor for the scheduler");
2073         *available_timer_id = ast_sched_add(sched, when * 1000, ast_cc_available_timer_expire, monitor);
2074         return 0;
2075 }
2076
2077 static int construct_pidf_body(enum sip_cc_publish_state state, char *pidf_body, size_t size, const char *presentity)
2078 {
2079         struct ast_str *body = ast_str_alloca(size);
2080         char tuple_id[32];
2081
2082         generate_random_string(tuple_id, sizeof(tuple_id));
2083
2084         /* We'll make this a bare-bones pidf body. In state_notify_build_xml, the PIDF
2085          * body gets a lot more extra junk that isn't necessary, so we'll leave it out here.
2086          */
2087         ast_str_append(&body, 0, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
2088         /* XXX The entity attribute is currently set to the peer name associated with the
2089          * dialog. This is because we currently only call this function for call-completion
2090          * PUBLISH bodies. In such cases, the entity is completely disregarded. For other
2091          * event packages, it may be crucial to have a proper URI as the presentity so this
2092          * should be revisited as support is expanded.
2093          */
2094         ast_str_append(&body, 0, "<presence xmlns=\"urn:ietf:params:xml:ns:pidf\" entity=\"%s\">\n", presentity);
2095         ast_str_append(&body, 0, "<tuple id=\"%s\">\n", tuple_id);
2096         ast_str_append(&body, 0, "<status><basic>%s</basic></status>\n", state == CC_OPEN ? "open" : "closed");
2097         ast_str_append(&body, 0, "</tuple>\n");
2098         ast_str_append(&body, 0, "</presence>\n");
2099         ast_copy_string(pidf_body, ast_str_buffer(body), size);
2100         return 0;
2101 }
2102
2103 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor)
2104 {
2105         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2106         enum sip_publish_type publish_type;
2107         struct cc_epa_entry *cc_entry;
2108
2109         if (!monitor_instance) {
2110                 return -1;
2111         }
2112
2113         if (!monitor_instance->suspension_entry) {
2114                 /* We haven't yet allocated the suspension entry, so let's give it a shot */
2115                 if (!(monitor_instance->suspension_entry = create_epa_entry("call-completion", monitor_instance->peername))) {
2116                         ast_log(LOG_WARNING, "Unable to allocate sip EPA entry for call-completion\n");
2117                         ao2_ref(monitor_instance, -1);
2118                         return -1;
2119                 }
2120                 if (!(cc_entry = ast_calloc(1, sizeof(*cc_entry)))) {
2121                         ast_log(LOG_WARNING, "Unable to allocate space for instance data of EPA entry for call-completion\n");
2122                         ao2_ref(monitor_instance, -1);
2123                         return -1;
2124                 }
2125                 cc_entry->core_id = monitor->core_id;
2126                 monitor_instance->suspension_entry->instance_data = cc_entry;
2127                 publish_type = SIP_PUBLISH_INITIAL;
2128         } else {
2129                 publish_type = SIP_PUBLISH_MODIFY;
2130                 cc_entry = monitor_instance->suspension_entry->instance_data;
2131         }
2132
2133         cc_entry->current_state = CC_CLOSED;
2134
2135         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2136                 /* If we have no set notify_uri, then what this means is that we have
2137                  * not received a NOTIFY from this destination stating that he is
2138                  * currently available.
2139                  *
2140                  * This situation can arise when the core calls the suspend callbacks
2141                  * of multiple destinations. If one of the other destinations aside
2142                  * from this one notified Asterisk that he is available, then there
2143                  * is no reason to take any suspension action on this device. Rather,
2144                  * we should return now and if we receive a NOTIFY while monitoring
2145                  * is still "suspended" then we can immediately respond with the
2146                  * proper PUBLISH to let this endpoint know what is going on.
2147                  */
2148                 return 0;
2149         }
2150         construct_pidf_body(CC_CLOSED, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2151         return transmit_publish(monitor_instance->suspension_entry, publish_type, monitor_instance->notify_uri);
2152 }
2153
2154 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor)
2155 {
2156         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2157         struct cc_epa_entry *cc_entry;
2158
2159         if (!monitor_instance) {
2160                 return -1;
2161         }
2162
2163         ast_assert(monitor_instance->suspension_entry != NULL);
2164
2165         cc_entry = monitor_instance->suspension_entry->instance_data;
2166         cc_entry->current_state = CC_OPEN;
2167         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2168                 /* This means we are being asked to unsuspend a call leg we never
2169                  * sent a PUBLISH on. As such, there is no reason to send another
2170                  * PUBLISH at this point either. We can just return instead.
2171                  */
2172                 return 0;
2173         }
2174         construct_pidf_body(CC_OPEN, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2175         return transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_MODIFY, monitor_instance->notify_uri);
2176 }
2177
2178 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id)
2179 {
2180         if (*sched_id != -1) {
2181                 AST_SCHED_DEL(sched, *sched_id);
2182                 ao2_t_ref(monitor, -1, "Removing scheduler's reference to the monitor");
2183         }
2184         return 0;
2185 }
2186
2187 static void sip_cc_monitor_destructor(void *private_data)
2188 {
2189         struct sip_monitor_instance *monitor_instance = private_data;
2190         ao2_unlink(sip_monitor_instances, monitor_instance);
2191         ast_module_unref(ast_module_info->self);
2192 }
2193
2194 static int sip_get_cc_information(struct sip_request *req, char *subscribe_uri, size_t size, enum ast_cc_service_type *service)
2195 {
2196         char *call_info = ast_strdupa(sip_get_header(req, "Call-Info"));
2197         char *uri;
2198         char *purpose;
2199         char *service_str;
2200         static const char cc_purpose[] = "purpose=call-completion";
2201         static const int cc_purpose_len = sizeof(cc_purpose) - 1;
2202
2203         if (ast_strlen_zero(call_info)) {
2204                 /* No Call-Info present. Definitely no CC offer */
2205                 return -1;
2206         }
2207
2208         uri = strsep(&call_info, ";");
2209
2210         while ((purpose = strsep(&call_info, ";"))) {
2211                 if (!strncmp(purpose, cc_purpose, cc_purpose_len)) {
2212                         break;
2213                 }
2214         }
2215         if (!purpose) {
2216                 /* We didn't find the appropriate purpose= parameter. Oh well */
2217                 return -1;
2218         }
2219
2220         /* Okay, call-completion has been offered. Let's figure out what type of service this is */
2221         while ((service_str = strsep(&call_info, ";"))) {
2222                 if (!strncmp(service_str, "m=", 2)) {
2223                         break;
2224                 }
2225         }
2226         if (!service_str) {
2227                 /* So they didn't offer a particular service, We'll just go with CCBS since it really
2228                  * doesn't matter anyway
2229                  */
2230                 service_str = "BS";
2231         } else {
2232                 /* We already determined that there is an "m=" so no need to check
2233                  * the result of this strsep
2234                  */
2235                 strsep(&service_str, "=");
2236         }
2237
2238         if ((*service = service_string_to_service_type(service_str)) == AST_CC_NONE) {
2239                 /* Invalid service offered */
2240                 return -1;
2241         }
2242
2243         ast_copy_string(subscribe_uri, get_in_brackets(uri), size);
2244
2245         return 0;
2246 }
2247
2248 /*
2249  * \brief Determine what, if any, CC has been offered and queue a CC frame if possible
2250  *
2251  * After taking care of some formalities to be sure that this call is eligible for CC,
2252  * we first try to see if we can make use of native CC. We grab the information from
2253  * the passed-in sip_request (which is always a response to an INVITE). If we can
2254  * use native CC monitoring for the call, then so be it.
2255  *
2256  * If native cc monitoring is not possible or not supported, then we will instead attempt
2257  * to use generic monitoring. Falling back to generic from a failed attempt at using native
2258  * monitoring will only work if the monitor policy of the endpoint is "always"
2259  *
2260  * \param pvt The current dialog. Contains CC parameters for the endpoint
2261  * \param req The response to the INVITE we want to inspect
2262  * \param service The service to use if generic monitoring is to be used. For native
2263  * monitoring, we get the service from the SIP response itself
2264  */
2265 static void sip_handle_cc(struct sip_pvt *pvt, struct sip_request *req, enum ast_cc_service_type service)
2266 {
2267         enum ast_cc_monitor_policies monitor_policy = ast_get_cc_monitor_policy(pvt->cc_params);
2268         int core_id;
2269         char interface_name[AST_CHANNEL_NAME];
2270
2271         if (monitor_policy == AST_CC_MONITOR_NEVER) {
2272                 /* Don't bother, just return */
2273                 return;
2274         }
2275
2276         if ((core_id = ast_cc_get_current_core_id(pvt->owner)) == -1) {
2277                 /* For some reason, CC is invalid, so don't try it! */
2278                 return;
2279         }
2280
2281         ast_channel_get_device_name(pvt->owner, interface_name, sizeof(interface_name));
2282
2283         if (monitor_policy == AST_CC_MONITOR_ALWAYS || monitor_policy == AST_CC_MONITOR_NATIVE) {
2284                 char subscribe_uri[SIPBUFSIZE];
2285                 char device_name[AST_CHANNEL_NAME];
2286                 enum ast_cc_service_type offered_service;
2287                 struct sip_monitor_instance *monitor_instance;
2288                 if (sip_get_cc_information(req, subscribe_uri, sizeof(subscribe_uri), &offered_service)) {
2289                         /* If CC isn't being offered to us, or for some reason the CC offer is
2290                          * not formatted correctly, then it may still be possible to use generic
2291                          * call completion since the monitor policy may be "always"
2292                          */
2293                         goto generic;
2294                 }
2295                 ast_channel_get_device_name(pvt->owner, device_name, sizeof(device_name));
2296                 if (!(monitor_instance = sip_monitor_instance_init(core_id, subscribe_uri, pvt->peername, device_name))) {
2297                         /* Same deal. We can try using generic still */
2298                         goto generic;
2299                 }
2300                 /* We bump the refcount of chan_sip because once we queue this frame, the CC core
2301                  * will have a reference to callbacks in this module. We decrement the module
2302                  * refcount once the monitor destructor is called
2303                  */
2304                 ast_module_ref(ast_module_info->self);
2305                 ast_queue_cc_frame(pvt->owner, "SIP", pvt->dialstring, offered_service, monitor_instance);
2306                 ao2_ref(monitor_instance, -1);
2307                 return;
2308         }
2309
2310 generic:
2311         if (monitor_policy == AST_CC_MONITOR_GENERIC || monitor_policy == AST_CC_MONITOR_ALWAYS) {
2312                 ast_queue_cc_frame(pvt->owner, AST_CC_GENERIC_MONITOR_TYPE, interface_name, service, NULL);
2313         }
2314 }
2315
2316 /*! \brief Working TLS connection configuration */
2317 static struct ast_tls_config sip_tls_cfg;
2318
2319 /*! \brief Default TLS connection configuration */
2320 static struct ast_tls_config default_tls_cfg;
2321
2322 /*! \brief Default DTLS connection configuration */
2323 static struct ast_rtp_dtls_cfg default_dtls_cfg;
2324
2325 /*! \brief The TCP server definition */
2326 static struct ast_tcptls_session_args sip_tcp_desc = {
2327         .accept_fd = -1,
2328         .master = AST_PTHREADT_NULL,
2329         .tls_cfg = NULL,
2330         .poll_timeout = -1,
2331         .name = "SIP TCP server",
2332         .accept_fn = ast_tcptls_server_root,
2333         .worker_fn = sip_tcp_worker_fn,
2334 };
2335
2336 /*! \brief The TCP/TLS server definition */
2337 static struct ast_tcptls_session_args sip_tls_desc = {
2338         .accept_fd = -1,
2339         .master = AST_PTHREADT_NULL,
2340         .tls_cfg = &sip_tls_cfg,
2341         .poll_timeout = -1,
2342         .name = "SIP TLS server",
2343         .accept_fn = ast_tcptls_server_root,
2344         .worker_fn = sip_tcp_worker_fn,
2345 };
2346
2347 /*! \brief Append to SIP dialog history
2348         \return Always returns 0 */
2349 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
2350
2351 /*! \brief map from an integer value to a string.
2352  * If no match is found, return errorstring
2353  */
2354 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2355 {
2356         const struct _map_x_s *cur;
2357
2358         for (cur = table; cur->s; cur++) {
2359                 if (cur->x == x) {
2360                         return cur->s;
2361                 }
2362         }
2363         return errorstring;
2364 }
2365
2366 /*! \brief map from a string to an integer value, case insensitive.
2367  * If no match is found, return errorvalue.
2368  */
2369 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2370 {
2371         const struct _map_x_s *cur;
2372
2373         for (cur = table; cur->s; cur++) {
2374                 if (!strcasecmp(cur->s, s)) {
2375                         return cur->x;
2376                 }
2377         }
2378         return errorvalue;
2379 }
2380
2381 /*!
2382  * \internal
2383  * \brief Determine if the given string is a SIP token.
2384  * \since 13.8.0
2385  *
2386  * \param str String to determine if is a SIP token.
2387  *
2388  * \note A token is defined by RFC3261 Section 25.1
2389  *
2390  * \return Non-zero if the string is a SIP token.
2391  */
2392 static int sip_is_token(const char *str)
2393 {
2394         int is_token;
2395
2396         if (ast_strlen_zero(str)) {
2397                 /* An empty string is not a token. */
2398                 return 0;
2399         }
2400
2401         is_token = 1;
2402         do {
2403                 if (!isalnum(*str)
2404                         && !strchr("-.!%*_+`'~", *str)) {
2405                         /* The character is not allowed in a token. */
2406                         is_token = 0;
2407                         break;
2408                 }
2409         } while (*++str);
2410
2411         return is_token;
2412 }
2413
2414 static const char *sip_reason_code_to_str(struct ast_party_redirecting_reason *reason)
2415 {
2416         int idx;
2417         int code;
2418
2419         /* use specific string if given */
2420         if (!ast_strlen_zero(reason->str)) {
2421                 return reason->str;
2422         }
2423
2424         code = reason->code;
2425         for (idx = 0; idx < ARRAY_LEN(sip_reason_table); ++idx) {
2426                 if (code == sip_reason_table[idx].code) {
2427                         return sip_reason_table[idx].text;
2428                 }
2429         }
2430
2431         return "unknown";
2432 }
2433
2434 /*!
2435  * \brief generic function for determining if a correct transport is being
2436  * used to contact a peer
2437  *
2438  * this is done as a macro so that the "tmpl" var can be passed either a
2439  * sip_request or a sip_peer
2440  */
2441 #define check_request_transport(peer, tmpl) ({ \
2442         int ret = 0; \
2443         if (peer->socket.type == tmpl->socket.type) \
2444                 ; \
2445         else if (!(peer->transports & tmpl->socket.type)) {\
2446                 ast_log(LOG_ERROR, \
2447                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
2448                         sip_get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
2449                         ); \
2450                 ret = 1; \
2451         } else if (peer->socket.type & AST_TRANSPORT_TLS) { \
2452                 ast_log(LOG_WARNING, \
2453                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
2454                         peer->name, sip_get_transport(tmpl->socket.type) \
2455                 ); \
2456         } else { \
2457                 ast_debug(1, \
2458                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
2459                         peer->name, sip_get_transport(tmpl->socket.type), sip_get_transport(peer->socket.type) \
2460                 ); \
2461         }\
2462         (ret); \
2463 })
2464
2465 /*! \brief
2466  * duplicate a list of channel variables, \return the copy.
2467  */
2468 static struct ast_variable *copy_vars(struct ast_variable *src)
2469 {
2470         struct ast_variable *res = NULL, *tmp, *v = NULL;
2471
2472         for (v = src ; v ; v = v->next) {
2473                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
2474                         tmp->next = res;
2475                         res = tmp;
2476                 }
2477         }
2478         return res;
2479 }
2480
2481 static void tcptls_packet_destructor(void *obj)
2482 {
2483         struct tcptls_packet *packet = obj;
2484
2485         ast_free(packet->data);
2486 }
2487
2488 static void sip_tcptls_client_args_destructor(void *obj)
2489 {
2490         struct ast_tcptls_session_args *args = obj;
2491         if (args->tls_cfg) {
2492                 ast_free(args->tls_cfg->certfile);
2493                 ast_free(args->tls_cfg->pvtfile);
2494                 ast_free(args->tls_cfg->cipher);
2495                 ast_free(args->tls_cfg->cafile);
2496                 ast_free(args->tls_cfg->capath);
2497
2498                 ast_ssl_teardown(args->tls_cfg);
2499         }
2500         ast_free(args->tls_cfg);
2501         ast_free((char *) args->name);
2502 }
2503
2504 static void sip_threadinfo_destructor(void *obj)
2505 {
2506         struct sip_threadinfo *th = obj;
2507         struct tcptls_packet *packet;
2508
2509         if (th->alert_pipe[1] > -1) {
2510                 close(th->alert_pipe[0]);
2511         }
2512         if (th->alert_pipe[1] > -1) {
2513                 close(th->alert_pipe[1]);
2514         }
2515         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2516
2517         while ((packet = AST_LIST_REMOVE_HEAD(&th->packet_q, entry))) {
2518                 ao2_t_ref(packet, -1, "thread destruction, removing packet from frame queue");
2519         }
2520
2521         if (th->tcptls_session) {
2522                 ao2_t_ref(th->tcptls_session, -1, "remove tcptls_session for sip_threadinfo object");
2523         }
2524 }
2525
2526 /*! \brief creates a sip_threadinfo object and links it into the threadt table. */
2527 static struct sip_threadinfo *sip_threadinfo_create(struct ast_tcptls_session_instance *tcptls_session, int transport)
2528 {
2529         struct sip_threadinfo *th;
2530
2531         if (!tcptls_session || !(th = ao2_alloc(sizeof(*th), sip_threadinfo_destructor))) {
2532                 return NULL;
2533         }
2534
2535         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2536
2537         if (pipe(th->alert_pipe) == -1) {
2538                 ao2_t_ref(th, -1, "Failed to open alert pipe on sip_threadinfo");
2539                 ast_log(LOG_ERROR, "Could not create sip alert pipe in tcptls thread, error %s\n", strerror(errno));
2540                 return NULL;
2541         }
2542         ao2_t_ref(tcptls_session, +1, "tcptls_session ref for sip_threadinfo object");
2543         th->tcptls_session = tcptls_session;
2544         th->type = transport ? transport : (tcptls_session->ssl ? AST_TRANSPORT_TLS: AST_TRANSPORT_TCP);
2545         ao2_t_link(threadt, th, "Adding new tcptls helper thread");
2546         ao2_t_ref(th, -1, "Decrementing threadinfo ref from alloc, only table ref remains");
2547         return th;
2548 }
2549
2550 /*! \brief used to indicate to a tcptls thread that data is ready to be written */
2551 static int sip_tcptls_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t len)
2552 {
2553         int res = len;
2554         struct sip_threadinfo *th = NULL;
2555         struct tcptls_packet *packet = NULL;
2556         struct sip_threadinfo tmp = {
2557                 .tcptls_session = tcptls_session,
2558         };
2559         enum sip_tcptls_alert alert = TCPTLS_ALERT_DATA;
2560
2561         if (!tcptls_session) {
2562                 return XMIT_ERROR;
2563         }
2564
2565         ao2_lock(tcptls_session);
2566
2567         if ((tcptls_session->fd == -1) ||
2568                 !(th = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread")) ||
2569                 !(packet = ao2_alloc(sizeof(*packet), tcptls_packet_destructor)) ||
2570                 !(packet->data = ast_str_create(len))) {
2571                 goto tcptls_write_setup_error;
2572         }
2573
2574         /* goto tcptls_write_error should _NOT_ be used beyond this point */
2575         ast_str_set(&packet->data, 0, "%s", (char *) buf);
2576         packet->len = len;
2577
2578         /* alert tcptls thread handler that there is a packet to be sent.
2579          * must lock the thread info object to guarantee control of the
2580          * packet queue */
2581         ao2_lock(th);
2582         if (write(th->alert_pipe[1], &alert, sizeof(alert)) == -1) {
2583                 ast_log(LOG_ERROR, "write() to alert pipe failed: %s\n", strerror(errno));
2584                 ao2_t_ref(packet, -1, "could not write to alert pipe, remove packet");
2585                 packet = NULL;
2586                 res = XMIT_ERROR;
2587         } else { /* it is safe to queue the frame after issuing the alert when we hold the threadinfo lock */
2588                 AST_LIST_INSERT_TAIL(&th->packet_q, packet, entry);
2589         }
2590         ao2_unlock(th);
2591
2592         ao2_unlock(tcptls_session);
2593         ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo object after finding it");
2594         return res;
2595
2596 tcptls_write_setup_error:
2597         if (th) {
2598                 ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo obj, could not create packet");
2599         }
2600         if (packet) {
2601                 ao2_t_ref(packet, -1, "could not allocate packet's data");
2602         }
2603         ao2_unlock(tcptls_session);
2604
2605         return XMIT_ERROR;
2606 }
2607
2608 /*! \brief SIP TCP connection handler */
2609 static void *sip_tcp_worker_fn(void *data)
2610 {
2611         struct ast_tcptls_session_instance *tcptls_session = data;
2612
2613         return _sip_tcp_helper_thread(tcptls_session);
2614 }
2615
2616 /*! \brief SIP WebSocket connection handler */
2617 static void sip_websocket_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers)
2618 {
2619         int res;
2620
2621         if (ast_websocket_set_nonblock(session)) {
2622                 goto end;
2623         }
2624
2625         if (ast_websocket_set_timeout(session, sip_cfg.websocket_write_timeout)) {
2626                 goto end;
2627         }
2628
2629         while ((res = ast_wait_for_input(ast_websocket_fd(session), -1)) > 0) {
2630                 char *payload;
2631                 uint64_t payload_len;
2632                 enum ast_websocket_opcode opcode;
2633                 int fragmented;
2634
2635                 if (ast_websocket_read(session, &payload, &payload_len, &opcode, &fragmented)) {
2636                         /* We err on the side of caution and terminate the session if any error occurs */
2637                         break;
2638                 }
2639
2640                 if (opcode == AST_WEBSOCKET_OPCODE_TEXT || opcode == AST_WEBSOCKET_OPCODE_BINARY) {
2641                         struct sip_request req = { 0, };
2642                         char data[payload_len + 1];
2643
2644                         if (!(req.data = ast_str_create(payload_len + 1))) {
2645                                 goto end;
2646                         }
2647
2648                         strncpy(data, payload, payload_len);
2649                         data[payload_len] = '\0';
2650
2651                         if (ast_str_set(&req.data, -1, "%s", data) == AST_DYNSTR_BUILD_FAILED) {
2652                                 deinit_req(&req);
2653                                 goto end;
2654                         }
2655
2656                         req.socket.fd = ast_websocket_fd(session);
2657                         set_socket_transport(&req.socket, ast_websocket_is_secure(session) ? AST_TRANSPORT_WSS : AST_TRANSPORT_WS);
2658                         req.socket.ws_session = session;
2659
2660                         handle_request_do(&req, ast_websocket_remote_address(session));
2661                         deinit_req(&req);
2662
2663                 } else if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
2664                         break;
2665                 }
2666         }
2667
2668 end:
2669         ast_websocket_unref(session);
2670 }
2671
2672 /*! \brief Check if the authtimeout has expired.
2673  * \param start the time when the session started
2674  *
2675  * \retval 0 the timeout has expired
2676  * \retval -1 error
2677  * \return the number of milliseconds until the timeout will expire
2678  */
2679 static int sip_check_authtimeout(time_t start)
2680 {
2681         int timeout;
2682         time_t now;
2683         if(time(&now) == -1) {
2684                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
2685                 return -1;
2686         }
2687
2688         timeout = (authtimeout - (now - start)) * 1000;
2689         if (timeout < 0) {
2690                 /* we have timed out */
2691                 return 0;
2692         }
2693
2694         return timeout;
2695 }
2696
2697 /*!
2698  * \brief Indication of a TCP message's integrity
2699  */
2700 enum message_integrity {
2701         /*!
2702          * The message has an error in it with
2703          * regards to its Content-Length header
2704          */
2705         MESSAGE_INVALID,
2706         /*!
2707          * The message is incomplete
2708          */
2709         MESSAGE_FRAGMENT,
2710         /*!
2711          * The data contains a complete message
2712          * plus a fragment of another.
2713          */
2714         MESSAGE_FRAGMENT_COMPLETE,
2715         /*!
2716          * The message is complete
2717          */
2718         MESSAGE_COMPLETE,
2719 };
2720
2721 /*!
2722  * \brief
2723  * Get the content length from an unparsed SIP message
2724  *
2725  * \param message The unparsed SIP message headers
2726  * \return The value of the Content-Length header or -1 if message is invalid
2727  */
2728 static int read_raw_content_length(const char *message)
2729 {
2730         char *content_length_str;
2731         int content_length = -1;
2732
2733         struct ast_str *msg_copy;
2734         char *msg;
2735
2736         /* Using a ast_str because lws2sws takes one of those */
2737         if (!(msg_copy = ast_str_create(strlen(message) + 1))) {
2738                 return -1;
2739         }
2740         ast_str_set(&msg_copy, 0, "%s", message);
2741
2742         if (sip_cfg.pedanticsipchecking) {
2743                 lws2sws(msg_copy);
2744         }
2745
2746         msg = ast_str_buffer(msg_copy);
2747
2748         /* Let's find a Content-Length header */
2749         if ((content_length_str = strcasestr(msg, "\nContent-Length:"))) {
2750                 content_length_str += sizeof("\nContent-Length:") - 1;
2751         } else if ((content_length_str = strcasestr(msg, "\nl:"))) {
2752                 content_length_str += sizeof("\nl:") - 1;
2753         } else {
2754                 /* RFC 3261 18.3
2755                  * "In the case of stream-oriented transports such as TCP, the Content-
2756                  *  Length header field indicates the size of the body.  The Content-
2757                  *  Length header field MUST be used with stream oriented transports."
2758                  */
2759                 goto done;
2760         }
2761
2762         /* Double-check that this is a complete header */
2763         if (!strchr(content_length_str, '\n')) {
2764                 goto done;
2765         }
2766
2767         if (sscanf(content_length_str, "%30d", &content_length) != 1) {
2768                 content_length = -1;
2769         }
2770
2771 done:
2772         ast_free(msg_copy);
2773         return content_length;
2774 }
2775
2776 /*!
2777  * \brief Check that a message received over TCP is a full message
2778  *
2779  * This will take the information read in and then determine if
2780  * 1) The message is a full SIP request
2781  * 2) The message is a partial SIP request
2782  * 3) The message contains a full SIP request along with another partial request
2783  * \param data The unparsed incoming SIP message.
2784  * \param request The resulting request with extra fragments removed.
2785  * \param overflow If the message contains more than a full request, this is the remainder of the message
2786  * \return The resulting integrity of the message
2787  */
2788 static enum message_integrity check_message_integrity(struct ast_str **request, struct ast_str **overflow)
2789 {
2790         char *message = ast_str_buffer(*request);
2791         char *body;
2792         int content_length;
2793         int message_len = ast_str_strlen(*request);
2794         int body_len;
2795
2796         /* Important pieces to search for in a SIP request are \r\n\r\n. This
2797          * marks either
2798          * 1) The division between the headers and body
2799          * 2) The end of the SIP request
2800          */
2801         body = strstr(message, "\r\n\r\n");
2802         if (!body) {
2803                 /* This is clearly a partial message since we haven't reached an end
2804                  * yet.
2805                  */
2806                 return MESSAGE_FRAGMENT;
2807         }
2808         body += sizeof("\r\n\r\n") - 1;
2809         body_len = message_len - (body - message);
2810
2811         body[-1] = '\0';
2812         content_length = read_raw_content_length(message);
2813         body[-1] = '\n';
2814
2815         if (content_length < 0) {
2816                 return MESSAGE_INVALID;
2817         } else if (content_length == 0) {
2818                 /* We've definitely received an entire message. We need
2819                  * to check if there's also a fragment of another message
2820                  * in addition.
2821                  */
2822                 if (body_len == 0) {
2823                         return MESSAGE_COMPLETE;
2824                 } else {
2825                         ast_str_append(overflow, 0, "%s", body);
2826                         ast_str_truncate(*request, message_len - body_len);
2827                         return MESSAGE_FRAGMENT_COMPLETE;
2828                 }
2829         }
2830         /* Positive content length. Let's see what sort of
2831          * message body we're dealing with.
2832          */
2833         if (body_len < content_length) {
2834                 /* We don't have the full message body yet */
2835                 return MESSAGE_FRAGMENT;
2836         } else if (body_len > content_length) {
2837                 /* We have the full message plus a fragment of a further
2838                  * message
2839                  */
2840                 ast_str_append(overflow, 0, "%s", body + content_length);
2841                 ast_str_truncate(*request, message_len - (body_len - content_length));
2842                 return MESSAGE_FRAGMENT_COMPLETE;
2843         } else {
2844                 /* Yay! Full message with no extra content */
2845                 return MESSAGE_COMPLETE;
2846         }
2847 }
2848
2849 /*!
2850  * \brief Read SIP request or response from a TCP/TLS connection
2851  *
2852  * \param req The request structure to be filled in
2853  * \param tcptls_session The TCP/TLS connection from which to read
2854  * \retval -1 Failed to read data
2855  * \retval 0 Successfully read data
2856  */
2857 static int sip_tcptls_read(struct sip_request *req, struct ast_tcptls_session_instance *tcptls_session,
2858                 int authenticated, time_t start)
2859 {
2860         enum message_integrity message_integrity = MESSAGE_FRAGMENT;
2861
2862         while (message_integrity == MESSAGE_FRAGMENT) {
2863                 size_t datalen;
2864
2865                 if (ast_str_strlen(tcptls_session->overflow_buf) == 0) {
2866                         char readbuf[4097];
2867                         int timeout;
2868                         int res;
2869                         if (!tcptls_session->client && !authenticated) {
2870                                 if ((timeout = sip_check_authtimeout(start)) < 0) {
2871                                         return -1;
2872                                 }
2873
2874                                 if (timeout == 0) {
2875                                         ast_debug(2, "SIP TCP/TLS server timed out\n");
2876                                         return -1;
2877                                 }
2878                         } else {
2879                                 timeout = -1;
2880                         }
2881                         res = ast_wait_for_input(tcptls_session->fd, timeout);
2882                         if (res < 0) {
2883                                 ast_debug(2, "SIP TCP/TLS server :: ast_wait_for_input returned %d\n", res);
2884                                 return -1;
2885                         } else if (res == 0) {
2886                                 ast_debug(2, "SIP TCP/TLS server timed out\n");
2887                                 return -1;
2888                         }
2889
2890                         res = ast_tcptls_server_read(tcptls_session, readbuf, sizeof(readbuf) - 1);
2891                         if (res < 0) {
2892                                 if (errno == EAGAIN || errno == EINTR) {
2893                                         continue;
2894                                 }
2895                                 ast_debug(2, "SIP TCP/TLS server error when receiving data\n");
2896                                 return -1;
2897                         } else if (res == 0) {
2898                                 ast_debug(2, "SIP TCP/TLS server has shut down\n");
2899                                 return -1;
2900                         }
2901                         readbuf[res] = '\0';
2902                         ast_str_append(&req->data, 0, "%s", readbuf);
2903                 } else {
2904                         ast_str_append(&req->data, 0, "%s", ast_str_buffer(tcptls_session->overflow_buf));
2905                         ast_str_reset(tcptls_session->overflow_buf);
2906                 }
2907
2908                 datalen = ast_str_strlen(req->data);
2909                 if (datalen > SIP_MAX_PACKET_SIZE) {
2910                         ast_log(LOG_WARNING, "Rejecting TCP/TLS packet from '%s' because way too large: %zu\n",
2911                                 ast_sockaddr_stringify(&tcptls_session->remote_address), datalen);
2912                         return -1;
2913                 }
2914
2915                 message_integrity = check_message_integrity(&req->data, &tcptls_session->overflow_buf);
2916         }
2917
2918         return 0;
2919 }
2920
2921 /*! \brief SIP TCP thread management function
2922         This function reads from the socket, parses the packet into a request
2923 */
2924 static void *_sip_tcp_helper_thread(struct ast_tcptls_session_instance *tcptls_session)
2925 {
2926         int res, timeout = -1, authenticated = 0, flags;
2927         time_t start;
2928         struct sip_request req = { 0, } , reqcpy = { 0, };
2929         struct sip_threadinfo *me = NULL;
2930         char buf[1024] = "";
2931         struct pollfd fds[2] = { { 0 }, { 0 }, };
2932         struct ast_tcptls_session_args *ca = NULL;
2933
2934         /* If this is a server session, then the connection has already been
2935          * setup. Check if the authlimit has been reached and if not create the
2936          * threadinfo object so we can access this thread for writing.
2937          *
2938          * if this is a client connection more work must be done.
2939          * 1. We own the parent session args for a client connection.  This pointer needs
2940          *    to be held on to so we can decrement it's ref count on thread destruction.
2941          * 2. The threadinfo object was created before this thread was launched, however
2942          *    it must be found within the threadt table.
2943          * 3. Last, the tcptls_session must be started.
2944          */
2945         if (!tcptls_session->client) {
2946                 if (ast_atomic_fetchadd_int(&unauth_sessions, +1) >= authlimit) {
2947                         /* unauth_sessions is decremented in the cleanup code */
2948                         goto cleanup;
2949                 }
2950
2951                 if ((flags = fcntl(tcptls_session->fd, F_GETFL)) == -1) {
2952                         ast_log(LOG_ERROR, "error setting socket to non blocking mode, fcntl() failed: %s\n", strerror(errno));
2953                         goto cleanup;
2954                 }
2955
2956                 flags |= O_NONBLOCK;
2957                 if (fcntl(tcptls_session->fd, F_SETFL, flags) == -1) {
2958                         ast_log(LOG_ERROR, "error setting socket to non blocking mode, fcntl() failed: %s\n", strerror(errno));
2959                         goto cleanup;
2960                 }
2961
2962                 if (!(me = sip_threadinfo_create(tcptls_session, tcptls_session->ssl ? AST_TRANSPORT_TLS : AST_TRANSPORT_TCP))) {
2963                         goto cleanup;
2964                 }
2965                 ao2_t_ref(me, +1, "Adding threadinfo ref for tcp_helper_thread");
2966         } else {
2967                 struct sip_threadinfo tmp = {
2968                         .tcptls_session = tcptls_session,
2969                 };
2970
2971                 if ((!(ca = tcptls_session->parent)) ||
2972                         (!(me = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread"))) ||
2973                         (!(tcptls_session = ast_tcptls_client_start(tcptls_session)))) {
2974                         goto cleanup;
2975                 }
2976         }
2977
2978         flags = 1;
2979         if (setsockopt(tcptls_session->fd, SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
2980                 ast_log(LOG_ERROR, "error enabling TCP keep-alives on sip socket: %s\n", strerror(errno));
2981                 goto cleanup;
2982         }
2983
2984         me->threadid = pthread_self();
2985         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "TLS" : "TCP");
2986
2987         /* set up pollfd to watch for reads on both the socket and the alert_pipe */
2988         fds[0].fd = tcptls_session->fd;
2989         fds[1].fd = me->alert_pipe[0];
2990         fds[0].events = fds[1].events = POLLIN | POLLPRI;
2991
2992         if (!(req.data = ast_str_create(SIP_MIN_PACKET))) {
2993                 goto cleanup;
2994         }
2995         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET))) {
2996                 goto cleanup;
2997         }
2998
2999         if(time(&start) == -1) {
3000                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
3001                 goto cleanup;
3002         }
3003
3004         /*
3005          * We cannot let the stream exclusively wait for data to arrive.
3006          * We have to wake up the task to send outgoing messages.
3007          */
3008         ast_tcptls_stream_set_exclusive_input(tcptls_session->stream_cookie, 0);
3009
3010         ast_tcptls_stream_set_timeout_sequence(tcptls_session->stream_cookie, ast_tvnow(),
3011                 tcptls_session->client ? -1 : (authtimeout * 1000));
3012
3013         for (;;) {
3014                 struct ast_str *str_save;
3015
3016                 if (!tcptls_session->client && req.authenticated && !authenticated) {
3017                         authenticated = 1;
3018                         ast_tcptls_stream_set_timeout_disable(tcptls_session->stream_cookie);
3019                         ast_atomic_fetchadd_int(&unauth_sessions, -1);
3020                 }
3021
3022                 /* calculate the timeout for unauthenticated server sessions */
3023                 if (!tcptls_session->client && !authenticated ) {
3024                         if ((timeout = sip_check_authtimeout(start)) < 0) {
3025                                 goto cleanup;
3026                         }
3027
3028                         if (timeout == 0) {
3029                                 ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "TLS": "TCP");
3030                                 goto cleanup;
3031                         }
3032                 } else {
3033                         timeout = -1;
3034                 }
3035
3036                 if (ast_str_strlen(tcptls_session->overflow_buf) == 0) {
3037                         res = ast_poll(fds, 2, timeout); /* polls for both socket and alert_pipe */
3038                         if (res < 0) {
3039                                 ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", tcptls_session->ssl ? "TLS": "TCP", res);
3040                                 goto cleanup;
3041                         } else if (res == 0) {
3042                                 /* timeout */
3043                                 ast_debug(2, "SIP %s server timed out\n", tcptls_session->ssl ? "TLS": "TCP");
3044                                 goto cleanup;
3045                         }
3046                 }
3047
3048                 /*
3049                  * handle the socket event, check for both reads from the socket fd or TCP overflow buffer,
3050                  * and writes from alert_pipe fd.
3051                  */
3052                 if (fds[0].revents || (ast_str_strlen(tcptls_session->overflow_buf) > 0)) { /* there is data on the socket to be read */
3053                         fds[0].revents = 0;
3054
3055                         /* clear request structure */
3056                         str_save = req.data;
3057                         memset(&req, 0, sizeof(req));
3058                         req.data = str_save;
3059                         ast_str_reset(req.data);
3060
3061                         str_save = reqcpy.data;
3062                         memset(&reqcpy, 0, sizeof(reqcpy));
3063                         reqcpy.data = str_save;
3064                         ast_str_reset(reqcpy.data);
3065
3066                         memset(buf, 0, sizeof(buf));
3067
3068                         if (tcptls_session->ssl) {
3069                                 set_socket_transport(&req.socket, AST_TRANSPORT_TLS);
3070                                 req.socket.port = htons(ourport_tls);
3071                         } else {
3072                                 set_socket_transport(&req.socket, AST_TRANSPORT_TCP);
3073                                 req.socket.port = htons(ourport_tcp);
3074                         }
3075                         req.socket.fd = tcptls_session->fd;
3076
3077                         res = sip_tcptls_read(&req, tcptls_session, authenticated, start);
3078                         if (res < 0) {
3079                                 goto cleanup;
3080                         }
3081
3082                         req.socket.tcptls_session = tcptls_session;
3083                         req.socket.ws_session = NULL;
3084                         handle_request_do(&req, &tcptls_session->remote_address);
3085                 }
3086
3087                 if (fds[1].revents) { /* alert_pipe indicates there is data in the send queue to be sent */
3088                         enum sip_tcptls_alert alert;
3089                         struct tcptls_packet *packet;
3090
3091                         fds[1].revents = 0;
3092
3093                         if (read(me->alert_pipe[0], &alert, sizeof(alert)) == -1) {
3094                                 ast_log(LOG_ERROR, "read() failed: %s\n", strerror(errno));
3095                                 continue;
3096                         }
3097
3098                         switch (alert) {
3099                         case TCPTLS_ALERT_STOP:
3100                                 goto cleanup;
3101                         case TCPTLS_ALERT_DATA:
3102                                 ao2_lock(me);
3103                                 if (!(packet = AST_LIST_REMOVE_HEAD(&me->packet_q, entry))) {
3104                                         ast_log(LOG_WARNING, "TCPTLS thread alert_pipe indicated packet should be sent, but frame_q is empty\n");
3105                                 }
3106                                 ao2_unlock(me);
3107
3108                                 if (packet) {
3109                                         if (ast_tcptls_server_write(tcptls_session, ast_str_buffer(packet->data), packet->len) == -1) {
3110                                                 ast_log(LOG_WARNING, "Failure to write to tcp/tls socket\n");
3111                                         }
3112                                         ao2_t_ref(packet, -1, "tcptls packet sent, this is no longer needed");
3113                                 }