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