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