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