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