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