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