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