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