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