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