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