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