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