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