100c52c1c2321f2305c26a1075228e7a870e9774
[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  * \todo Asterisk should send a non-100 provisional response every minute to keep proxies
42  *  from cancelling the transaction (RFC 3261 13.3.1.1). See bug #11157.
43  * 
44  * ******** Wishlist: Improvements
45  * - Support of SIP domains for devices, so that we match on username@domain in the From: header
46  * - Connect registrations with a specific device on the incoming call. It's not done
47  *   automatically in Asterisk
48  *
49  * \ingroup channel_drivers
50  *
51  * \par Overview of the handling of SIP sessions
52  * The SIP channel handles several types of SIP sessions, or dialogs,
53  * not all of them being "telephone calls".
54  * - Incoming calls that will be sent to the PBX core
55  * - Outgoing calls, generated by the PBX
56  * - SIP subscriptions and notifications of states and voicemail messages
57  * - SIP registrations, both inbound and outbound
58  * - SIP peer management (peerpoke, OPTIONS)
59  * - SIP text messages
60  *
61  * In the SIP channel, there's a list of active SIP dialogs, which includes
62  * all of these when they are active. "sip show channels" in the CLI will
63  * show most of these, excluding subscriptions which are shown by
64  * "sip show subscriptions"
65  *
66  * \par incoming packets
67  * Incoming packets are received in the monitoring thread, then handled by
68  * sipsock_read() for udp only. In tcp, packets are read by the tcp_helper thread.
69  * sipsock_read() function parses the packet and matches an existing
70  * dialog or starts a new SIP dialog.
71  * 
72  * sipsock_read sends the packet to handle_incoming(), that parses a bit more.
73  * If it is a response to an outbound request, the packet is sent to handle_response().
74  * If it is a request, handle_incoming() sends it to one of a list of functions
75  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
76  * sipsock_read locks the ast_channel if it exists (an active call) and
77  * unlocks it after we have processed the SIP message.
78  *
79  * A new INVITE is sent to handle_request_invite(), that will end up
80  * starting a new channel in the PBX, the new channel after that executing
81  * in a separate channel thread. This is an incoming "call".
82  * When the call is answered, either by a bridged channel or the PBX itself
83  * the sip_answer() function is called.
84  *
85  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
86  * in rtp.c 
87  * 
88  * \par Outbound calls
89  * Outbound calls are set up by the PBX through the sip_request_call()
90  * function. After that, they are activated by sip_call().
91  * 
92  * \par Hanging up
93  * The PBX issues a hangup on both incoming and outgoing calls through
94  * the sip_hangup() function
95  */
96
97 /*!  
98  * \page sip_tcp_tls SIP TCP and TLS support
99  * 
100  * \par tcpfixes TCP implementation changes needed
101  * \todo Fix TCP/TLS handling in dialplan, SRV records, transfers and much more
102  * \todo Save TCP/TLS sessions in registry
103  *      If someone registers a SIPS uri, this forces us to set up a TLS connection back.
104  * \todo Add TCP/TLS information to function SIPPEER and SIPCHANINFO
105  * \todo If tcpenable=yes, we must open a TCP socket on the same address as the IP for UDP.
106  *       The tcpbindaddr config option should only be used to open ADDITIONAL ports
107  *       So we should propably go back to
108  *              bindaddr= the default address to bind to. If tcpenable=yes, then bind this to both udp and TCP
109  *                              if tlsenable=yes, open TLS port (provided we also have cert)
110  *              tcpbindaddr = extra address for additional TCP connections
111  *              tlsbindaddr = extra address for additional TCP/TLS connections
112  *              udpbindaddr = extra address for additional UDP connections
113  *                      These three options should take multiple IP/port pairs
114  *      Note: Since opening additional listen sockets is a *new* feature we do not have today
115  *              the XXXbindaddr options needs to be disabled until we have support for it
116  *              
117  * \todo re-evaluate the transport= setting in sip.conf. This is right now not well
118  *      thought of. If a device in sip.conf contacts us via TCP, we should not switch transport,
119  *      even if udp is the configured first transport.
120  *      
121  * \todo Be prepared for one outbound and another incoming socket per pvt. This applies
122  *       specially to communication with other peers (proxies).
123  * \todo We need to test TCP sessions with SIP proxies and in regards
124  *       to the SIP outbound specs.
125  * \todo ;transport=tls was deprecated in RFC3261 and should not be used at all. See section 26.2.2.
126  *
127  * \todo If the message is smaller than the given Content-length, the request should get a 400 Bad request
128  *       message. If it's a response, it should be dropped. (RFC 3261, Section 18.3)
129  * \todo Since we have had multidomain support in Asterisk for quite a while, we need to support
130  *       multiple domains in our TLS implementation, meaning one socket and one cert per domain
131  * \todo Selection of transport for a request needs to be done after we've parsed all route headers,
132  *       also considering outbound proxy options.
133  *              First request: Outboundproxy, routes, (reg contact or URI. If URI doesn't have port:  DNS naptr, srv, AAA)
134  *              Intermediate requests: Outboundproxy(only when forced), routes, contact/uri
135  *      DNS naptr support is crucial. A SIP uri might lead to a TLS connection.
136  *      Also note that due to outbound proxy settings, a SIPS uri might have to be sent on UDP (not to recommend though)
137  * \todo Default transports are set to UDP, which cause the wrong behaviour when contacting remote
138  *      devices directly from the dialplan. UDP is only a fallback if no other method works,
139  *      in order to be compatible with RFC2543 (SIP/1.0) devices. For transactions that exceed the
140  *      MTU (like INIVTE with video, audio and RTT)  TCP should be preferred.
141  *
142  *      When dialling unconfigured peers (with no port number)  or devices in external domains
143  *      NAPTR records MUST be consulted to find configured transport. If they are not found,
144  *      SRV records for both TCP and UDP should be checked. If there's a record for TCP, use that.
145  *      If there's no record for TCP, then use UDP as a last resort. If there's no SRV records,
146  *      \note this only applies if there's no outbound proxy configured for the session. If an outbound
147  *      proxy is configured, these procedures might apply for locating the proxy and determining
148  *      the transport to use for communication with the proxy.
149  * \par Other bugs to fix ----
150  * __set_address_from_contact(const char *fullcontact, struct sockaddr_in *sin, int tcp)
151  *      - sets TLS port as default for all TCP connections, unless other port is given in contact.
152  * parse_register_contact(struct sip_pvt *pvt, struct sip_peer *peer, struct sip_request *req)
153  *      - assumes that the contact the UA registers is using the same transport as the REGISTER request, which is 
154  *        a bad guess.
155  *      - Does not save any information about TCP/TLS connected devices, which is a severe BUG, as discussed on the mailing list.
156  * get_destination(struct sip_pvt *p, struct sip_request *oreq)
157  *      - Doesn't store the information that we got an incoming SIPS request in the channel, so that
158  *        we can require a secure signalling path OUT of Asterisk (on SIP or IAX2). Possibly, the call should
159  *        fail on in-secure signalling paths if there's no override in our configuration. At least, provide a
160  *        channel variable in the dialplan.
161  * get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req)
162  *      - As above, if we have a SIPS: uri in the refer-to header
163  *      - Does not check transport in refer_to uri.
164  */
165
166 /*** MODULEINFO
167         <depend>chan_local</depend>
168  ***/
169
170 /*!  \page sip_session_timers SIP Session Timers in Asterisk Chan_sip
171
172         The SIP Session-Timers is an extension of the SIP protocol that allows end-points and proxies to
173         refresh a session periodically. The sessions are kept alive by sending a RE-INVITE or UPDATE
174         request at a negotiated interval. If a session refresh fails then all the entities that support Session-
175         Timers clear their internal session state. In addition, UAs generate a BYE request in order to clear
176         the state in the proxies and the remote UA (this is done for the benefit of SIP entities in the path
177         that do not support Session-Timers).
178
179         The Session-Timers can be configured on a system-wide, per-user, or per-peer basis. The peruser/
180         per-peer settings override the global settings. The following new parameters have been
181         added to the sip.conf file.
182                 session-timers=["accept", "originate", "refuse"]
183                 session-expires=[integer]
184                 session-minse=[integer]
185                 session-refresher=["uas", "uac"]
186
187         The session-timers parameter in sip.conf defines the mode of operation of SIP session-timers feature in
188         Asterisk. The Asterisk can be configured in one of the following three modes:
189
190         1. Accept :: In the "accept" mode, the Asterisk server honors session-timers requests
191                 made by remote end-points. A remote end-point can request Asterisk to engage
192                 session-timers by either sending it an INVITE request with a "Supported: timer"
193                 header in it or by responding to Asterisk's INVITE with a 200 OK that contains
194                 Session-Expires: header in it. In this mode, the Asterisk server does not 
195                 request session-timers from remote end-points. This is the default mode.
196         2. Originate :: In the "originate" mode, the Asterisk server requests the remote 
197                 end-points to activate session-timers in addition to honoring such requests
198                 made by the remote end-pints. In order to get as much protection as possible
199                 against hanging SIP channels due to network or end-point failures, Asterisk
200                 resends periodic re-INVITEs even if a remote end-point does not support
201                 the session-timers feature.
202         3. Refuse :: In the "refuse" mode, Asterisk acts as if it does not support session-
203                 timers for inbound or outbound requests. If a remote end-point requests
204                 session-timers in a dialog, then Asterisk ignores that request unless it's
205                 noted as a requirement (Require: header), in which case the INVITE is 
206                 rejected with a 420 Bad Extension response.
207
208 */
209
210 #include "asterisk.h"
211
212 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
213
214 #include <ctype.h>
215 #include <sys/ioctl.h>
216 #include <fcntl.h>
217 #include <signal.h>
218 #include <sys/signal.h>
219 #include <regex.h>
220 #include <time.h>
221
222 #include "asterisk/network.h"
223 #include "asterisk/paths.h"     /* need ast_config_AST_SYSTEM_NAME */
224
225 #include "asterisk/lock.h"
226 #include "asterisk/channel.h"
227 #include "asterisk/config.h"
228 #include "asterisk/module.h"
229 #include "asterisk/pbx.h"
230 #include "asterisk/sched.h"
231 #include "asterisk/io.h"
232 #include "asterisk/rtp_engine.h"
233 #include "asterisk/udptl.h"
234 #include "asterisk/acl.h"
235 #include "asterisk/manager.h"
236 #include "asterisk/callerid.h"
237 #include "asterisk/cli.h"
238 #include "asterisk/app.h"
239 #include "asterisk/musiconhold.h"
240 #include "asterisk/dsp.h"
241 #include "asterisk/features.h"
242 #include "asterisk/srv.h"
243 #include "asterisk/astdb.h"
244 #include "asterisk/causes.h"
245 #include "asterisk/utils.h"
246 #include "asterisk/file.h"
247 #include "asterisk/astobj.h"
248 /* 
249    Uncomment the define below,  if you are having refcount related memory leaks.
250    With this uncommented, this module will generate a file, /tmp/refs, which contains
251    a history of the ao2_ref() calls. To be useful, all calls to ao2_* functions should
252    be modified to ao2_t_* calls, and include a tag describing what is happening with 
253    enough detail, to make pairing up a reference count increment with its corresponding decrement.
254    The refcounter program in utils/ can be invaluable in highlighting objects that are not
255    balanced, along with the complete history for that object.
256    In normal operation, the macros defined will throw away the tags, so they do not 
257    affect the speed of the program at all. They can be considered to be documentation.
258 */
259 /* #define  REF_DEBUG 1 */
260 #include "asterisk/astobj2.h"
261 #include "asterisk/dnsmgr.h"
262 #include "asterisk/devicestate.h"
263 #include "asterisk/linkedlists.h"
264 #include "asterisk/stringfields.h"
265 #include "asterisk/monitor.h"
266 #include "asterisk/netsock.h"
267 #include "asterisk/localtime.h"
268 #include "asterisk/abstract_jb.h"
269 #include "asterisk/threadstorage.h"
270 #include "asterisk/translate.h"
271 #include "asterisk/ast_version.h"
272 #include "asterisk/event.h"
273 #include "asterisk/tcptls.h"
274 #include "asterisk/stun.h"
275
276 /*** DOCUMENTATION
277         <application name="SIPDtmfMode" language="en_US">
278                 <synopsis>
279                         Change the dtmfmode for a SIP call.
280                 </synopsis>
281                 <syntax>
282                         <parameter name="mode" required="true">
283                                 <enumlist>
284                                         <enum name="inband" />
285                                         <enum name="info" />
286                                         <enum name="rfc2833" />
287                                 </enumlist>
288                         </parameter>
289                 </syntax>
290                 <description>
291                         <para>Changes the dtmfmode for a SIP call.</para>
292                 </description>
293         </application>
294         <application name="SIPAddHeader" language="en_US">
295                 <synopsis>
296                         Add a SIP header to the outbound call.
297                 </synopsis>
298                 <syntax argsep=":">
299                         <parameter name="Header" required="true" />
300                         <parameter name="Content" required="true" />
301                 </syntax>
302                 <description>
303                         <para>Adds a header to a SIP call placed with DIAL.</para>
304                         <para>Remember to use the X-header if you are adding non-standard SIP
305                         headers, like <literal>X-Asterisk-Accountcode:</literal>. Use this with care.
306                         Adding the wrong headers may jeopardize the SIP dialog.</para>
307                         <para>Always returns <literal>0</literal>.</para>
308                 </description>
309         </application>
310         <application name="SIPRemoveHeader" language="en_US">
311                 <synopsis>
312                         Remove SIP headers previously added with SIPAddHeader
313                 </synopsis>
314                 <syntax>
315                         <parameter name="Header" required="false" />
316                 </syntax>
317                 <description>
318                         <para>SIPRemoveHeader() allows you to remove headers which were previously 
319                         added with SIPAddHeader(). If no parameter is supplied, all previously added 
320                         headers will be removed. If a parameter is supplied, only the matching headers 
321                         will be removed.</para>
322                         <para>For example you have added these 2 headers:</para>
323                         <para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
324                         <para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
325                         <para></para>
326                         <para>// remove all headers</para>
327                         <para>SIPRemoveHeader();</para>
328                         <para>// remove all P- headers</para>
329                         <para>SIPRemoveHeader(P-);</para>
330                         <para>// remove only the PAI header (note the : at the end)</para>
331                         <para>SIPRemoveHeader(P-Asserted-Identity:);</para>
332                         <para></para>
333                         <para>Always returns <literal>0</literal>.</para>
334                 </description>
335         </application>
336         <function name="SIP_HEADER" language="en_US">
337                 <synopsis>
338                         Gets the specified SIP header.
339                 </synopsis>
340                 <syntax>
341                         <parameter name="name" required="true" />
342                         <parameter name="number">
343                                 <para>If not specified, defaults to <literal>1</literal>.</para>
344                         </parameter>
345                 </syntax>
346                 <description>
347                         <para>Since there are several headers (such as Via) which can occur multiple
348                         times, SIP_HEADER takes an optional second argument to specify which header with
349                         that name to retrieve. Headers start at offset <literal>1</literal>.</para>
350                 </description>
351         </function>
352         <function name="SIPPEER" language="en_US">
353                 <synopsis>
354                         Gets SIP peer information.
355                 </synopsis>
356                 <syntax>
357                         <parameter name="peername" required="true" />
358                         <parameter name="item">
359                                 <enumlist>
360                                         <enum name="ip">
361                                                 <para>(default) The ip address.</para>
362                                         </enum>
363                                         <enum name="port">
364                                                 <para>The port number.</para>
365                                         </enum>
366                                         <enum name="mailbox">
367                                                 <para>The configured mailbox.</para>
368                                         </enum>
369                                         <enum name="context">
370                                                 <para>The configured context.</para>
371                                         </enum>
372                                         <enum name="expire">
373                                                 <para>The epoch time of the next expire.</para>
374                                         </enum>
375                                         <enum name="dynamic">
376                                                 <para>Is it dynamic? (yes/no).</para>
377                                         </enum>
378                                         <enum name="callerid_name">
379                                                 <para>The configured Caller ID name.</para>
380                                         </enum>
381                                         <enum name="callerid_num">
382                                                 <para>The configured Caller ID number.</para>
383                                         </enum>
384                                         <enum name="callgroup">
385                                                 <para>The configured Callgroup.</para>
386                                         </enum>
387                                         <enum name="pickupgroup">
388                                                 <para>The configured Pickupgroup.</para>
389                                         </enum>
390                                         <enum name="codecs">
391                                                 <para>The configured codecs.</para>
392                                         </enum>
393                                         <enum name="status">
394                                                 <para>Status (if qualify=yes).</para>
395                                         </enum>
396                                         <enum name="regexten">
397                                                 <para>Registration extension.</para>
398                                         </enum>
399                                         <enum name="limit">
400                                                 <para>Call limit (call-limit).</para>
401                                         </enum>
402                                         <enum name="busylevel">
403                                                 <para>Configured call level for signalling busy.</para>
404                                         </enum>
405                                         <enum name="curcalls">
406                                                 <para>Current amount of calls. Only available if call-limit is set.</para>
407                                         </enum>
408                                         <enum name="language">
409                                                 <para>Default language for peer.</para>
410                                         </enum>
411                                         <enum name="accountcode">
412                                                 <para>Account code for this peer.</para>
413                                         </enum>
414                                         <enum name="useragent">
415                                                 <para>Current user agent id for peer.</para>
416                                         </enum>
417                                         <enum name="chanvar[name]">
418                                                 <para>A channel variable configured with setvar for this peer.</para>
419                                         </enum>
420                                         <enum name="codec[x]">
421                                                 <para>Preferred codec index number <replaceable>x</replaceable> (beginning with zero).</para>
422                                         </enum>
423                                 </enumlist>
424                         </parameter>
425                 </syntax>
426                 <description />
427         </function>
428         <function name="SIPCHANINFO" language="en_US">
429                 <synopsis>
430                         Gets the specified SIP parameter from the current channel.
431                 </synopsis>
432                 <syntax>
433                         <parameter name="item" required="true">
434                                 <enumlist>
435                                         <enum name="peerip">
436                                                 <para>The IP address of the peer.</para>
437                                         </enum>
438                                         <enum name="recvip">
439                                                 <para>The source IP address of the peer.</para>
440                                         </enum>
441                                         <enum name="from">
442                                                 <para>The URI from the <literal>From:</literal> header.</para>
443                                         </enum>
444                                         <enum name="uri">
445                                                 <para>The URI from the <literal>Contact:</literal> header.</para>
446                                         </enum>
447                                         <enum name="useragent">
448                                                 <para>The useragent.</para>
449                                         </enum>
450                                         <enum name="peername">
451                                                 <para>The name of the peer.</para>
452                                         </enum>
453                                         <enum name="t38passthrough">
454                                                 <para><literal>1</literal> if T38 is offered or enabled in this channel,
455                                                 otherwise <literal>0</literal>.</para>
456                                         </enum>
457                                 </enumlist>
458                         </parameter>
459                 </syntax>
460                 <description />
461         </function>
462         <function name="CHECKSIPDOMAIN" language="en_US">
463                 <synopsis>
464                         Checks if domain is a local domain.
465                 </synopsis>
466                 <syntax>
467                         <parameter name="domain" required="true" />
468                 </syntax>
469                 <description>
470                         <para>This function checks if the <replaceable>domain</replaceable> in the argument is configured
471                         as a local SIP domain that this Asterisk server is configured to handle.
472                         Returns the domain name if it is locally handled, otherwise an empty string.
473                         Check the <literal>domain=</literal> configuration in <filename>sip.conf</filename>.</para>
474                 </description>
475         </function>
476         <manager name="SIPpeers" language="en_US">
477                 <synopsis>
478                         List SIP peers (text format).
479                 </synopsis>
480                 <syntax>
481                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
482                 </syntax>
483                 <description>
484                         <para>Lists SIP peers in text format with details on current status.
485                         Peerlist will follow as separate events, followed by a final event called
486                         PeerlistComplete.</para>
487                 </description>
488         </manager>
489         <manager name="SIPshowpeer" language="en_US">
490                 <synopsis>
491                         show SIP peer (text format).
492                 </synopsis>
493                 <syntax>
494                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
495                         <parameter name="Peer" required="true">
496                                 <para>The peer name you want to check.</para>
497                         </parameter>
498                 </syntax>
499                 <description>
500                         <para>Show one SIP peer with details on current status.</para>
501                 </description>
502         </manager>
503         <manager name="SIPqualifypeer" language="en_US">
504                 <synopsis>
505                         Qualify SIP peers.
506                 </synopsis>
507                 <syntax>
508                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
509                         <parameter name="Peer" required="true">
510                                 <para>The peer name you want to qualify.</para>
511                         </parameter>
512                 </syntax>
513                 <description>
514                         <para>Qualify a SIP peer.</para>
515                 </description>
516         </manager>
517         <manager name="SIPshowregistry" language="en_US">
518                 <synopsis>
519                         Show SIP registrations (text format).
520                 </synopsis>
521                 <syntax>
522                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
523                 </syntax>
524                 <description>
525                         <para>Lists all registration requests and status. Registrations will follow as separate
526                         events. followed by a final event called RegistrationsComplete.</para>
527                 </description>
528         </manager>
529         <manager name="SIPnotify" language="en_US">
530                 <synopsis>
531                         Send a SIP notify.
532                 </synopsis>
533                 <syntax>
534                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
535                         <parameter name="Channel" required="true">
536                                 <para>Peer to receive the notify.</para>
537                         </parameter>
538                         <parameter name="Variable" required="true">
539                                 <para>At least one variable pair must be specified.
540                                 <replaceable>name</replaceable>=<replaceable>value</replaceable></para>
541                         </parameter>
542                 </syntax>
543                 <description>
544                         <para>Sends a SIP Notify event.</para>
545                         <para>All parameters for this event must be specified in the body of this request
546                         via multiple Variable: name=value sequences.</para>
547                 </description>
548         </manager>
549  ***/
550
551 #ifndef FALSE
552 #define FALSE    0
553 #endif
554
555 #ifndef TRUE
556 #define TRUE     1
557 #endif
558
559 #ifndef MAX
560 #define MAX(a,b) ((a) > (b) ? (a) : (b))
561 #endif
562
563 /* Arguments for find_peer */
564 #define FINDUSERS (1 << 0)
565 #define FINDPEERS (1 << 1)
566 #define FINDALLDEVICES (FINDUSERS | FINDPEERS)
567
568 #define SIPBUFSIZE              512             /*!< Buffer size for many operations */
569
570 #define XMIT_ERROR              -2
571
572 #define SIP_RESERVED ";/?:@&=+$,# "             /*!< Reserved characters in the username part of the URI */
573
574 /* #define VOCAL_DATA_HACK */
575
576 #define DEFAULT_DEFAULT_EXPIRY  120
577 #define DEFAULT_MIN_EXPIRY      60
578 #define DEFAULT_MAX_EXPIRY      3600
579 #define DEFAULT_MWI_EXPIRY      3600
580 #define DEFAULT_REGISTRATION_TIMEOUT 20
581 #define DEFAULT_MAX_FORWARDS    "70"
582
583 /* guard limit must be larger than guard secs */
584 /* guard min must be < 1000, and should be >= 250 */
585 #define EXPIRY_GUARD_SECS       15                /*!< How long before expiry do we reregister */
586 #define EXPIRY_GUARD_LIMIT      30                /*!< Below here, we use EXPIRY_GUARD_PCT instead of 
587                                                          EXPIRY_GUARD_SECS */
588 #define EXPIRY_GUARD_MIN        500                /*!< This is the minimum guard time applied. If 
589                                                    GUARD_PCT turns out to be lower than this, it 
590                                                    will use this time instead.
591                                                    This is in milliseconds. */
592 #define EXPIRY_GUARD_PCT        0.20                /*!< Percentage of expires timeout to use when 
593                                                     below EXPIRY_GUARD_LIMIT */
594 #define DEFAULT_EXPIRY 900                          /*!< Expire slowly */
595
596 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
597 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
598 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
599 static int mwi_expiry = DEFAULT_MWI_EXPIRY;
600
601 #define DEFAULT_QUALIFY_GAP   100
602 #define DEFAULT_QUALIFY_PEERS 1
603
604
605 #define CALLERID_UNKNOWN        "Unknown"
606
607 #define DEFAULT_MAXMS                2000             /*!< Qualification: Must be faster than 2 seconds by default */
608 #define DEFAULT_QUALIFYFREQ          60 * 1000        /*!< Qualification: How often to check for the host to be up */
609 #define DEFAULT_FREQ_NOTOK           10 * 1000        /*!< Qualification: How often to check, if the host is down... */
610
611 #define DEFAULT_RETRANS              1000             /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
612 #define MAX_RETRANS                  6                /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
613 #define DEFAULT_TIMER_T1                 500              /*!< SIP timer T1 (according to RFC 3261) */
614 #define SIP_TRANS_TIMEOUT            64 * DEFAULT_TIMER_T1 /*!< SIP request timeout (rfc 3261) 64*T1 
615                                                       \todo Use known T1 for timeout (peerpoke)
616                                                       */
617 #define DEFAULT_TRANS_TIMEOUT        -1               /*!< Use default SIP transaction timeout */
618 #define MAX_AUTHTRIES                3                /*!< Try authentication three times, then fail */
619
620 #define SIP_MAX_HEADERS              64               /*!< Max amount of SIP headers to read */
621 #define SIP_MAX_LINES                64               /*!< Max amount of lines in SIP attachment (like SDP) */
622 #define SIP_MIN_PACKET               4096             /*!< Initialize size of memory to allocate for packets */
623 #define MAX_HISTORY_ENTRIES          50               /*!< Max entires in the history list for a sip_pvt */
624
625 #define INITIAL_CSEQ                 101              /*!< Our initial sip sequence number */
626
627 #define DEFAULT_MAX_SE               1800             /*!< Session-Timer Default Session-Expires period (RFC 4028) */
628 #define DEFAULT_MIN_SE               90               /*!< Session-Timer Default Min-SE period (RFC 4028) */
629
630 #define SDP_MAX_RTPMAP_CODECS        32               /*!< Maximum number of codecs allowed in received SDP */
631
632 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
633 static struct ast_jb_conf default_jbconf =
634 {
635         .flags = 0,
636         .max_size = -1,
637         .resync_threshold = -1,
638         .impl = ""
639 };
640 static struct ast_jb_conf global_jbconf;                /*!< Global jitterbuffer configuration */
641
642 static const char config[] = "sip.conf";                /*!< Main configuration file */
643 static const char notify_config[] = "sip_notify.conf";  /*!< Configuration file for sending Notify with CLI commands to reconfigure or reboot phones */
644
645 #define RTP     1
646 #define NO_RTP  0
647
648 /*! \brief Authorization scheme for call transfers 
649
650 \note Not a bitfield flag, since there are plans for other modes,
651         like "only allow transfers for authenticated devices" */
652 enum transfermodes {
653         TRANSFER_OPENFORALL,            /*!< Allow all SIP transfers */
654         TRANSFER_CLOSED,                /*!< Allow no SIP transfers */
655 };
656
657
658 /*! \brief The result of a lot of functions */
659 enum sip_result {
660         AST_SUCCESS = 0,                /*!< FALSE means success, funny enough */
661         AST_FAILURE = -1,               /*!< Failure code */
662 };
663
664 /*! \brief States for the INVITE transaction, not the dialog 
665         \note this is for the INVITE that sets up the dialog
666 */
667 enum invitestates {
668         INV_NONE = 0,           /*!< No state at all, maybe not an INVITE dialog */
669         INV_CALLING = 1,        /*!< Invite sent, no answer */
670         INV_PROCEEDING = 2,     /*!< We got/sent 1xx message */
671         INV_EARLY_MEDIA = 3,    /*!< We got 18x message with to-tag back */
672         INV_COMPLETED = 4,      /*!< Got final response with error. Wait for ACK, then CONFIRMED */
673         INV_CONFIRMED = 5,      /*!< Confirmed response - we've got an ack (Incoming calls only) */
674         INV_TERMINATED = 6,     /*!< Transaction done - either successful (AST_STATE_UP) or failed, but done 
675                                      The only way out of this is a BYE from one side */
676         INV_CANCELLED = 7,      /*!< Transaction cancelled by client or server in non-terminated state */
677 };
678
679 /*! \brief Readable descriptions of device states.
680        \note Should be aligned to above table as index */
681 static const struct invstate2stringtable {
682         const enum invitestates state;
683         const char *desc;
684 } invitestate2string[] = {
685         {INV_NONE,              "None"  },
686         {INV_CALLING,           "Calling (Trying)"},
687         {INV_PROCEEDING,        "Proceeding "},
688         {INV_EARLY_MEDIA,       "Early media"},
689         {INV_COMPLETED,         "Completed (done)"},
690         {INV_CONFIRMED,         "Confirmed (up)"},
691         {INV_TERMINATED,        "Done"},
692         {INV_CANCELLED,         "Cancelled"}
693 };
694
695 /*! \brief When sending a SIP message, we can send with a few options, depending on
696         type of SIP request. UNRELIABLE is moslty used for responses to repeated requests,
697         where the original response would be sent RELIABLE in an INVITE transaction */
698 enum xmittype {
699         XMIT_CRITICAL = 2,              /*!< Transmit critical SIP message reliably, with re-transmits.
700                                               If it fails, it's critical and will cause a teardown of the session */
701         XMIT_RELIABLE = 1,              /*!< Transmit SIP message reliably, with re-transmits */
702         XMIT_UNRELIABLE = 0,            /*!< Transmit SIP message without bothering with re-transmits */
703 };
704
705 /*! \brief Results from the parse_register() function */
706 enum parse_register_result {
707         PARSE_REGISTER_FAILED,
708         PARSE_REGISTER_UPDATE,
709         PARSE_REGISTER_QUERY,
710 };
711
712 /*! \brief Type of subscription, based on the packages we do support, see \ref subscription_types */
713 enum subscriptiontype { 
714         NONE = 0,
715         XPIDF_XML,
716         DIALOG_INFO_XML,
717         CPIM_PIDF_XML,
718         PIDF_XML,
719         MWI_NOTIFICATION
720 };
721
722 /*! \brief Subscription types that we support. We support
723    - dialoginfo updates (really device status, not dialog info as was the original intent of the standard)
724    - SIMPLE presence used for device status
725    - Voicemail notification subscriptions
726 */
727 static const struct cfsubscription_types {
728         enum subscriptiontype type;
729         const char * const event;
730         const char * const mediatype;
731         const char * const text;
732 } subscription_types[] = {
733         { NONE,            "-",        "unknown",                    "unknown" },
734         /* RFC 4235: SIP Dialog event package */
735         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
736         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
737         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
738         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
739         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
740 };
741
742
743 /*! \brief Authentication types - proxy or www authentication 
744         \note Endpoints, like Asterisk, should always use WWW authentication to
745         allow multiple authentications in the same call - to the proxy and
746         to the end point.
747 */
748 enum sip_auth_type {
749         PROXY_AUTH = 407,
750         WWW_AUTH = 401,
751 };
752
753 /*! \brief Authentication result from check_auth* functions */
754 enum check_auth_result {
755         AUTH_DONT_KNOW = -100,  /*!< no result, need to check further */
756                 /* XXX maybe this is the same as AUTH_NOT_FOUND */
757
758         AUTH_SUCCESSFUL = 0,
759         AUTH_CHALLENGE_SENT = 1,
760         AUTH_SECRET_FAILED = -1,
761         AUTH_USERNAME_MISMATCH = -2,
762         AUTH_NOT_FOUND = -3,    /*!< returned by register_verify */
763         AUTH_FAKE_AUTH = -4,
764         AUTH_UNKNOWN_DOMAIN = -5,
765         AUTH_PEER_NOT_DYNAMIC = -6,
766         AUTH_ACL_FAILED = -7,
767         AUTH_BAD_TRANSPORT = -8,
768         AUTH_RTP_FAILED = 9,
769 };
770
771 /*! \brief States for outbound registrations (with register= lines in sip.conf */
772 enum sipregistrystate {
773         REG_STATE_UNREGISTERED = 0,     /*!< We are not registered 
774                  *  \note Initial state. We should have a timeout scheduled for the initial
775                  * (or next) registration transmission, calling sip_reregister
776                  */
777
778         REG_STATE_REGSENT,      /*!< Registration request sent 
779                  * \note sent initial request, waiting for an ack or a timeout to
780                  * retransmit the initial request.
781                 */
782
783         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate 
784                  * \note entered after transmit_register with auth info,
785                  * waiting for an ack.
786                  */
787
788         REG_STATE_REGISTERED,   /*!< Registered and done */
789
790         REG_STATE_REJECTED,     /*!< Registration rejected *
791                  * \note only used when the remote party has an expire larger than
792                  * our max-expire. This is a final state from which we do not
793                  * recover (not sure how correctly).
794                  */
795
796         REG_STATE_TIMEOUT,      /*!< Registration timed out *
797                 * \note XXX unused */
798
799         REG_STATE_NOAUTH,       /*!< We have no accepted credentials
800                  * \note fatal - no chance to proceed */
801
802         REG_STATE_FAILED,       /*!< Registration failed after several tries
803                  * \note fatal - no chance to proceed */
804 };
805
806 /*! \brief Modes in which Asterisk can be configured to run SIP Session-Timers */
807 enum st_mode {
808         SESSION_TIMER_MODE_INVALID = 0, /*!< Invalid value */ 
809         SESSION_TIMER_MODE_ACCEPT,      /*!< Honor inbound Session-Timer requests */
810         SESSION_TIMER_MODE_ORIGINATE,   /*!< Originate outbound and honor inbound requests */
811         SESSION_TIMER_MODE_REFUSE       /*!< Ignore inbound Session-Timers requests */
812 };
813
814 /*! \brief The entity playing the refresher role for Session-Timers */
815 enum st_refresher {
816         SESSION_TIMER_REFRESHER_AUTO,    /*!< Negotiated                      */
817         SESSION_TIMER_REFRESHER_UAC,     /*!< Session is refreshed by the UAC */
818         SESSION_TIMER_REFRESHER_UAS      /*!< Session is refreshed by the UAS */
819 };
820
821 /*! \brief Define some implemented SIP transports 
822         \note Asterisk does not support SCTP or UDP/DTLS 
823 */
824 enum sip_transport {
825         SIP_TRANSPORT_UDP = 1,          /*!< Unreliable transport for SIP, needs retransmissions */
826         SIP_TRANSPORT_TCP = 1 << 1,     /*!< Reliable, but unsecure */
827         SIP_TRANSPORT_TLS = 1 << 2,     /*!< TCP/TLS - reliable and secure transport for signalling */
828 };
829
830 /*! \brief definition of a sip proxy server
831  *
832  * For outbound proxies, a sip_peer will contain a reference to a 
833  * dynamically allocated instance of a sip_proxy. A sip_pvt may also
834  * contain a reference to a peer's outboundproxy, or it may contain
835  * a reference to the sip_cfg.outboundproxy.
836  */
837 struct sip_proxy {
838         char name[MAXHOSTNAMELEN];      /*!< DNS name of domain/host or IP */
839         struct sockaddr_in ip;          /*!< Currently used IP address and port */
840         time_t last_dnsupdate;          /*!< When this was resolved */
841         enum sip_transport transport;   
842         int force;                      /*!< If it's an outbound proxy, Force use of this outbound proxy for all outbound requests */
843         /* Room for a SRV record chain based on the name */
844 };
845
846 /*! \brief argument for the 'show channels|subscriptions' callback. */
847 struct __show_chan_arg { 
848         int fd;
849         int subscriptions;
850         int numchans;   /* return value */
851 };
852
853
854 /*! \brief States whether a SIP message can create a dialog in Asterisk. */
855 enum can_create_dialog {
856         CAN_NOT_CREATE_DIALOG,
857         CAN_CREATE_DIALOG,
858         CAN_CREATE_DIALOG_UNSUPPORTED_METHOD,
859 };
860
861 /*! \brief SIP Request methods known by Asterisk 
862
863    \note Do _NOT_ make any changes to this enum, or the array following it;
864    if you think you are doing the right thing, you are probably
865    not doing the right thing. If you think there are changes
866    needed, get someone else to review them first _before_
867    submitting a patch. If these two lists do not match properly
868    bad things will happen.
869 */
870
871 enum sipmethod {
872         SIP_UNKNOWN,            /*!< Unknown response */
873         SIP_RESPONSE,           /*!< Not request, response to outbound request */
874         SIP_REGISTER,           /*!< Registration to the mothership, tell us where you are located */
875         SIP_OPTIONS,            /*!< Check capabilities of a device, used for "ping" too */
876         SIP_NOTIFY,             /*!< Status update, Part of the event package standard, result of a SUBSCRIBE or a REFER */
877         SIP_INVITE,             /*!< Set up a session */
878         SIP_ACK,                /*!< End of a three-way handshake started with INVITE. */
879         SIP_PRACK,              /*!< Reliable pre-call signalling. Not supported in Asterisk. */
880         SIP_BYE,                /*!< End of a session */
881         SIP_REFER,              /*!< Refer to another URI (transfer) */
882         SIP_SUBSCRIBE,          /*!< Subscribe for updates (voicemail, session status, device status, presence) */
883         SIP_MESSAGE,            /*!< Text messaging */
884         SIP_UPDATE,             /*!< Update a dialog. We can send UPDATE; but not accept it */
885         SIP_INFO,               /*!< Information updates during a session */
886         SIP_CANCEL,             /*!< Cancel an INVITE */
887         SIP_PUBLISH,            /*!< Not supported in Asterisk */
888         SIP_PING,               /*!< Not supported at all, no standard but still implemented out there */
889 };
890
891 /*! \brief Settings for the 'notifycid' option, see sip.conf.sample for details. */
892 enum notifycid_setting {
893         DISABLED       = 0,
894         ENABLED        = 1,
895         IGNORE_CONTEXT = 2,
896 };
897
898 /*! \brief The core structure to setup dialogs. We parse incoming messages by using
899         structure and then route the messages according to the type.
900
901       \note Note that sip_methods[i].id == i must hold or the code breaks */
902 static const struct  cfsip_methods { 
903         enum sipmethod id;
904         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
905         char * const text;
906         enum can_create_dialog can_create;
907 } sip_methods[] = {
908         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",   CAN_CREATE_DIALOG },
909         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",     CAN_NOT_CREATE_DIALOG },
910         { SIP_REGISTER,  NO_RTP, "REGISTER",    CAN_CREATE_DIALOG },
911         { SIP_OPTIONS,   NO_RTP, "OPTIONS",     CAN_CREATE_DIALOG },
912         { SIP_NOTIFY,    NO_RTP, "NOTIFY",      CAN_CREATE_DIALOG },
913         { SIP_INVITE,    RTP,    "INVITE",      CAN_CREATE_DIALOG },
914         { SIP_ACK,       NO_RTP, "ACK",         CAN_NOT_CREATE_DIALOG },
915         { SIP_PRACK,     NO_RTP, "PRACK",       CAN_NOT_CREATE_DIALOG },
916         { SIP_BYE,       NO_RTP, "BYE",         CAN_NOT_CREATE_DIALOG },
917         { SIP_REFER,     NO_RTP, "REFER",       CAN_CREATE_DIALOG },
918         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",   CAN_CREATE_DIALOG },
919         { SIP_MESSAGE,   NO_RTP, "MESSAGE",     CAN_CREATE_DIALOG },
920         { SIP_UPDATE,    NO_RTP, "UPDATE",      CAN_NOT_CREATE_DIALOG },
921         { SIP_INFO,      NO_RTP, "INFO",        CAN_NOT_CREATE_DIALOG },
922         { SIP_CANCEL,    NO_RTP, "CANCEL",      CAN_NOT_CREATE_DIALOG },
923         { SIP_PUBLISH,   NO_RTP, "PUBLISH",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD },
924         { SIP_PING,      NO_RTP, "PING",        CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
925 };
926
927 /*!  Define SIP option tags, used in Require: and Supported: headers 
928         We need to be aware of these properties in the phones to use 
929         the replace: header. We should not do that without knowing
930         that the other end supports it... 
931         This is nothing we can configure, we learn by the dialog
932         Supported: header on the REGISTER (peer) or the INVITE
933         (other devices)
934         We are not using many of these today, but will in the future.
935         This is documented in RFC 3261
936 */
937 #define SUPPORTED               1
938 #define NOT_SUPPORTED           0
939
940 /* SIP options */
941 #define SIP_OPT_REPLACES        (1 << 0)
942 #define SIP_OPT_100REL          (1 << 1)
943 #define SIP_OPT_TIMER           (1 << 2)
944 #define SIP_OPT_EARLY_SESSION   (1 << 3)
945 #define SIP_OPT_JOIN            (1 << 4)
946 #define SIP_OPT_PATH            (1 << 5)
947 #define SIP_OPT_PREF            (1 << 6)
948 #define SIP_OPT_PRECONDITION    (1 << 7)
949 #define SIP_OPT_PRIVACY         (1 << 8)
950 #define SIP_OPT_SDP_ANAT        (1 << 9)
951 #define SIP_OPT_SEC_AGREE       (1 << 10)
952 #define SIP_OPT_EVENTLIST       (1 << 11)
953 #define SIP_OPT_GRUU            (1 << 12)
954 #define SIP_OPT_TARGET_DIALOG   (1 << 13)
955 #define SIP_OPT_NOREFERSUB      (1 << 14)
956 #define SIP_OPT_HISTINFO        (1 << 15)
957 #define SIP_OPT_RESPRIORITY     (1 << 16)
958 #define SIP_OPT_FROMCHANGE      (1 << 17)
959 #define SIP_OPT_RECLISTINV      (1 << 18)
960 #define SIP_OPT_RECLISTSUB      (1 << 19)
961 #define SIP_OPT_OUTBOUND        (1 << 20)
962 #define SIP_OPT_UNKNOWN         (1 << 21)
963
964
965 /*! \brief List of well-known SIP options. If we get this in a require,
966    we should check the list and answer accordingly. */
967 static const struct cfsip_options {
968         int id;                 /*!< Bitmap ID */
969         int supported;          /*!< Supported by Asterisk ? */
970         char * const text;      /*!< Text id, as in standard */
971 } sip_options[] = {     /* XXX used in 3 places */
972         /* RFC3262: PRACK 100% reliability */
973         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },     
974         /* RFC3959: SIP Early session support */
975         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
976         /* SIMPLE events:  RFC4662 */
977         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
978         /* RFC 4916- Connected line ID updates */
979         { SIP_OPT_FROMCHANGE,   NOT_SUPPORTED,  "from-change" },
980         /* GRUU: Globally Routable User Agent URI's */
981         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
982         /* RFC4244 History info */
983         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
984         /* RFC3911: SIP Join header support */
985         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
986         /* Disable the REFER subscription, RFC 4488 */
987         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
988         /* SIP outbound - the final NAT battle - draft-sip-outbound */
989         { SIP_OPT_OUTBOUND,     NOT_SUPPORTED,  "outbound" },
990         /* RFC3327: Path support */
991         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
992         /* RFC3840: Callee preferences */
993         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
994         /* RFC3312: Precondition support */
995         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
996         /* RFC3323: Privacy with proxies*/
997         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
998         /* RFC-ietf-sip-uri-list-conferencing-02.txt conference invite lists */
999         { SIP_OPT_RECLISTINV,   NOT_SUPPORTED,  "recipient-list-invite" },
1000         /* RFC-ietf-sip-uri-list-subscribe-02.txt - subscription lists */
1001         { SIP_OPT_RECLISTSUB,   NOT_SUPPORTED,  "recipient-list-subscribe" },
1002         /* RFC3891: Replaces: header for transfer */
1003         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },   
1004         /* One version of Polycom firmware has the wrong label */
1005         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },    
1006         /* RFC4412 Resource priorities */
1007         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
1008         /* RFC3329: Security agreement mechanism */
1009         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
1010         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
1011         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
1012         /* RFC4028: SIP Session-Timers */
1013         { SIP_OPT_TIMER,        SUPPORTED,      "timer" },
1014         /* RFC4538: Target-dialog */
1015         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
1016 };
1017
1018 /*! \brief Diversion header reasons
1019  *
1020  * The core defines a bunch of constants used to define
1021  * redirecting reasons. This provides a translation table
1022  * between those and the strings which may be present in
1023  * a SIP Diversion header
1024  */
1025 static const struct sip_reasons {
1026         enum AST_REDIRECTING_REASON code;
1027         char * const text;
1028 } sip_reason_table[] = {
1029         { AST_REDIRECTING_REASON_UNKNOWN, "unknown" },
1030         { AST_REDIRECTING_REASON_USER_BUSY, "user-busy" },
1031         { AST_REDIRECTING_REASON_NO_ANSWER, "no-answer" },
1032         { AST_REDIRECTING_REASON_UNAVAILABLE, "unavailable" },
1033         { AST_REDIRECTING_REASON_UNCONDITIONAL, "unconditional" },
1034         { AST_REDIRECTING_REASON_TIME_OF_DAY, "time-of-day" },
1035         { AST_REDIRECTING_REASON_DO_NOT_DISTURB, "do-not-disturb" },
1036         { AST_REDIRECTING_REASON_DEFLECTION, "deflection" },
1037         { AST_REDIRECTING_REASON_FOLLOW_ME, "follow-me" },
1038         { AST_REDIRECTING_REASON_OUT_OF_ORDER, "out-of-service" },
1039         { AST_REDIRECTING_REASON_AWAY, "away" },
1040         { AST_REDIRECTING_REASON_CALL_FWD_DTE, "unknown"}
1041 };
1042
1043 static enum AST_REDIRECTING_REASON sip_reason_str_to_code(const char *text)
1044 {
1045         enum AST_REDIRECTING_REASON ast = AST_REDIRECTING_REASON_UNKNOWN;
1046         int i;
1047
1048         for (i = 0; i < ARRAY_LEN(sip_reason_table); ++i) {
1049                 if (!strcasecmp(text, sip_reason_table[i].text)) {
1050                         ast = sip_reason_table[i].code;
1051                         break;
1052                 }
1053         }
1054
1055         return ast;
1056 }
1057
1058 static const char *sip_reason_code_to_str(enum AST_REDIRECTING_REASON code)
1059 {
1060         if (code >= 0 && code < ARRAY_LEN(sip_reason_table)) {
1061                 return sip_reason_table[code].text;
1062         }
1063
1064         return "unknown";
1065 }
1066
1067 /*! \brief SIP Methods we support 
1068         \todo This string should be set dynamically. We only support REFER and SUBSCRIBE if we have
1069         allowsubscribe and allowrefer on in sip.conf.
1070 */
1071 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY, INFO"
1072
1073 /*! \brief SIP Extensions we support 
1074         \note This should be generated based on the previous array
1075                 in combination with settings.
1076         \todo We should not have "timer" if it's disabled in the configuration file.
1077 */
1078 #define SUPPORTED_EXTENSIONS "replaces, timer" 
1079
1080 /*! \brief Standard SIP unsecure port for UDP and TCP from RFC 3261. DO NOT CHANGE THIS */
1081 #define STANDARD_SIP_PORT       5060
1082 /*! \brief Standard SIP TLS port from RFC 3261. DO NOT CHANGE THIS */
1083 #define STANDARD_TLS_PORT       5061
1084
1085 /*! \note in many SIP headers, absence of a port number implies port 5060,
1086  * and this is why we cannot change the above constant.
1087  * There is a limited number of places in asterisk where we could,
1088  * in principle, use a different "default" port number, but
1089  * we do not support this feature at the moment.
1090  * You can run Asterisk with SIP on a different port with a configuration
1091  * option. If you change this value, the signalling will be incorrect.
1092  */
1093
1094 /*! \name DefaultValues Default values, set and reset in reload_config before reading configuration 
1095
1096    These are default values in the source. There are other recommended values in the
1097    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
1098    yet encouraging new behaviour on new installations 
1099  */
1100 /*@{*/ 
1101 #define DEFAULT_CONTEXT         "default"       /*!< The default context for [general] section as well as devices */
1102 #define DEFAULT_MOHINTERPRET    "default"       /*!< The default music class */
1103 #define DEFAULT_MOHSUGGEST      ""
1104 #define DEFAULT_VMEXTEN         "asterisk"      /*!< Default voicemail extension */
1105 #define DEFAULT_CALLERID        "asterisk"      /*!< Default caller ID */
1106 #define DEFAULT_MWI_FROM ""
1107 #define DEFAULT_NOTIFYMIME      "application/simple-message-summary"
1108 #define DEFAULT_ALLOWGUEST      TRUE
1109 #define DEFAULT_RTPKEEPALIVE    0               /*!< Default RTPkeepalive setting */
1110 #define DEFAULT_CALLCOUNTER     FALSE
1111 #define DEFAULT_SRVLOOKUP       TRUE            /*!< Recommended setting is ON */
1112 #define DEFAULT_COMPACTHEADERS  FALSE           /*!< Send compact (one-character) SIP headers. Default off */
1113 #define DEFAULT_TOS_SIP         0               /*!< Call signalling packets should be marked as DSCP CS3, but the default is 0 to be compatible with previous versions. */
1114 #define DEFAULT_TOS_AUDIO       0               /*!< Audio packets should be marked as DSCP EF (Expedited Forwarding), but the default is 0 to be compatible with previous versions. */
1115 #define DEFAULT_TOS_VIDEO       0               /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
1116 #define DEFAULT_TOS_TEXT        0               /*!< Text packets should be marked as XXXX XXXX, but the default is 0 to be compatible with previous versions. */
1117 #define DEFAULT_COS_SIP         4               /*!< Level 2 class of service for SIP signalling */
1118 #define DEFAULT_COS_AUDIO       5               /*!< Level 2 class of service for audio media  */
1119 #define DEFAULT_COS_VIDEO       6               /*!< Level 2 class of service for video media */
1120 #define DEFAULT_COS_TEXT        5               /*!< Level 2 class of service for text media (T.140) */
1121 #define DEFAULT_ALLOW_EXT_DOM   TRUE            /*!< Allow external domains */
1122 #define DEFAULT_REALM           "asterisk"      /*!< Realm for HTTP digest authentication */
1123 #define DEFAULT_NOTIFYRINGING   TRUE            /*!< Notify devicestate system on ringing state */
1124 #define DEFAULT_NOTIFYCID               DISABLED        /*!< Include CID with ringing notifications */
1125 #define DEFAULT_PEDANTIC        FALSE           /*!< Avoid following SIP standards for dialog matching */
1126 #define DEFAULT_AUTOCREATEPEER  FALSE           /*!< Don't create peers automagically */
1127 #define DEFAULT_MATCHEXTERNIPLOCALLY FALSE      /*!< Match extern IP locally default setting */
1128 #define DEFAULT_QUALIFY         FALSE           /*!< Don't monitor devices */
1129 #define DEFAULT_CALLEVENTS      FALSE           /*!< Extra manager SIP call events */
1130 #define DEFAULT_ALWAYSAUTHREJECT        FALSE   /*!< Don't reject authentication requests always */
1131 #define DEFAULT_REGEXTENONQUALIFY FALSE
1132 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
1133 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
1134 #ifndef DEFAULT_USERAGENT
1135 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
1136 #define DEFAULT_SDPSESSION "Asterisk PBX"       /*!< Default SDP session name, (s=) header unless re-defined in sip.conf */
1137 #define DEFAULT_SDPOWNER "root"                 /*!< Default SDP username field in (o=) header unless re-defined in sip.conf */
1138 #define DEFAULT_ENGINE "asterisk"               /*!< Default RTP engine to use for sessions */
1139 #endif
1140 /*@}*/ 
1141
1142 /*! \name DefaultSettings
1143         Default setttings are used as a channel setting and as a default when
1144         configuring devices 
1145 */
1146 /*@{*/ 
1147 static char default_language[MAX_LANGUAGE];
1148 static char default_callerid[AST_MAX_EXTENSION];
1149 static char default_mwi_from[80];
1150 static char default_fromdomain[AST_MAX_EXTENSION];
1151 static char default_notifymime[AST_MAX_EXTENSION];
1152 static int default_qualify;             /*!< Default Qualify= setting */
1153 static char default_vmexten[AST_MAX_EXTENSION];
1154 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
1155 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting 
1156                                                     *   a bridged channel on hold */
1157 static char default_parkinglot[AST_MAX_CONTEXT]; /*!< Parkinglot */
1158 static char default_engine[256];        /*!< Default RTP engine */
1159 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
1160 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
1161 static unsigned int default_transports;                 /*!< Default Transports (enum sip_transport) that are acceptable */
1162 static unsigned int default_primary_transport;          /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
1163
1164 /*@}*/ 
1165
1166 /*! \name GlobalSettings
1167         Global settings apply to the channel (often settings you can change in the general section
1168         of sip.conf
1169 */
1170 /*@{*/ 
1171 /*! \brief a place to store all global settings for the sip channel driver 
1172         These are settings that will be possibly to apply on a group level later on.
1173         \note Do not add settings that only apply to the channel itself and can't
1174               be applied to devices (trunks, services, phones)
1175 */
1176 struct sip_settings {
1177         int peer_rtupdate;              /*!< G: Update database with registration data for peer? */
1178         int rtsave_sysname;             /*!< G: Save system name at registration? */
1179         int ignore_regexpire;           /*!< G: Ignore expiration of peer  */
1180         int rtautoclear;                /*!< Realtime ?? */
1181         int directrtpsetup;             /*!< Enable support for Direct RTP setup (no re-invites) */
1182         int pedanticsipchecking;        /*!< Extra checking ?  Default off */
1183         int autocreatepeer;             /*!< Auto creation of peers at registration? Default off. */
1184         int srvlookup;                  /*!< SRV Lookup on or off. Default is on */
1185         int allowguest;                 /*!< allow unauthenticated peers to connect? */
1186         int alwaysauthreject;           /*!< Send 401 Unauthorized for all failing requests */
1187         int compactheaders;             /*!< send compact sip headers */
1188         int allow_external_domains;     /*!< Accept calls to external SIP domains? */
1189         int callevents;                 /*!< Whether we send manager events or not */
1190         int regextenonqualify;          /*!< Whether to add/remove regexten when qualifying peers */
1191         int matchexterniplocally;       /*!< Match externip/externhost setting against localnet setting */
1192         int notifyringing;              /*!< Send notifications on ringing */
1193         int notifyhold;                 /*!< Send notifications on hold */
1194         enum notifycid_setting notifycid; /*!< Send CID with ringing notifications */
1195         enum transfermodes allowtransfer;       /*!< SIP Refer restriction scheme */
1196         int allowsubscribe;             /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE 
1197                                             the global setting is in globals_flags[1] */
1198         char realm[MAXHOSTNAMELEN];             /*!< Default realm */
1199         struct sip_proxy outboundproxy; /*!< Outbound proxy */
1200         char default_context[AST_MAX_CONTEXT];
1201         char default_subscribecontext[AST_MAX_CONTEXT];
1202 };
1203
1204 static struct sip_settings sip_cfg;
1205
1206 static int global_match_auth_username;          /*!< Match auth username if available instead of From: Default off. */
1207
1208 static int global_relaxdtmf;            /*!< Relax DTMF */
1209 static int global_rtptimeout;           /*!< Time out call if no RTP */
1210 static int global_rtpholdtimeout;       /*!< Time out call if no RTP during hold */
1211 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
1212 static int global_reg_timeout;  
1213 static int global_regattempts_max;      /*!< Registration attempts before giving up */
1214 static int global_callcounter;          /*!< Enable call counters for all devices. This is currently enabled by setting the peer
1215                                                 call-limit to 999. When we remove the call-limit from the code, we can make it
1216                                                 with just a boolean flag in the device structure */
1217 static unsigned int global_tos_sip;             /*!< IP type of service for SIP packets */
1218 static unsigned int global_tos_audio;           /*!< IP type of service for audio RTP packets */
1219 static unsigned int global_tos_video;           /*!< IP type of service for video RTP packets */
1220 static unsigned int global_tos_text;            /*!< IP type of service for text RTP packets */
1221 static unsigned int global_cos_sip;             /*!< 802.1p class of service for SIP packets */
1222 static unsigned int global_cos_audio;           /*!< 802.1p class of service for audio RTP packets */
1223 static unsigned int global_cos_video;           /*!< 802.1p class of service for video RTP packets */
1224 static unsigned int global_cos_text;            /*!< 802.1p class of service for text RTP packets */
1225 static unsigned int recordhistory;              /*!< Record SIP history. Off by default */
1226 static unsigned int dumphistory;                /*!< Dump history to verbose before destroying SIP dialog */
1227 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
1228 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
1229 static char global_sdpsession[AST_MAX_EXTENSION];       /*!< SDP session name for the SIP channel */
1230 static char global_sdpowner[AST_MAX_EXTENSION]; /*!< SDP owner name for the SIP channel */
1231 static int global_authfailureevents;            /*!< Whether we send authentication failure manager events or not. Default no. */
1232 static int global_t1;                   /*!< T1 time */
1233 static int global_t1min;                /*!< T1 roundtrip time minimum */
1234 static int global_timer_b;                      /*!< Timer B - RFC 3261 Section 17.1.1.2 */
1235 static unsigned int global_autoframing;         /*!< Turn autoframing on or off. */
1236 static int global_qualifyfreq;                  /*!< Qualify frequency */
1237 static int global_qualify_gap;              /*!< Time between our group of peer pokes */
1238 static int global_qualify_peers;          /*!< Number of peers to poke at a given time */
1239
1240
1241 /*! \brief Codecs that we support by default: */
1242 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
1243
1244 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
1245 static enum st_refresher global_st_refresher; /*!< Session-Timer refresher                        */
1246 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
1247 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
1248
1249 /*@}*/ 
1250
1251 /*! \brief Global list of addresses dynamic peers are not allowed to use */
1252 static struct ast_ha *global_contact_ha = NULL;
1253 static int global_dynamic_exclude_static = 0;
1254
1255 /*! \name Object counters @{
1256  * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
1257  * should be used to modify these values. */
1258 static int speerobjs = 0;                /*!< Static peers */
1259 static int rpeerobjs = 0;                /*!< Realtime peers */
1260 static int apeerobjs = 0;                /*!< Autocreated peer objects */
1261 static int regobjs = 0;                  /*!< Registry objects */
1262 /* }@ */
1263
1264 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
1265 static char used_context[AST_MAX_CONTEXT];              /*!< name of automatically created context for unloading */
1266
1267
1268 AST_MUTEX_DEFINE_STATIC(netlock);
1269
1270 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
1271    when it's doing something critical. */
1272 AST_MUTEX_DEFINE_STATIC(monlock);
1273
1274 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
1275
1276 /*! \brief This is the thread for the monitor which checks for input on the channels
1277    which are not currently in use.  */
1278 static pthread_t monitor_thread = AST_PTHREADT_NULL;
1279
1280 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
1281 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
1282
1283 static struct sched_context *sched;     /*!< The scheduling context */
1284 static struct io_context *io;           /*!< The IO context */
1285 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
1286
1287 #define DEC_CALL_LIMIT  0
1288 #define INC_CALL_LIMIT  1
1289 #define DEC_CALL_RINGING 2
1290 #define INC_CALL_RINGING 3
1291
1292 /*! \brief The SIP socket definition */
1293 struct sip_socket {
1294         enum sip_transport type;        /*!< UDP, TCP or TLS */
1295         int fd;                         /*!< Filed descriptor, the actual socket */
1296         uint16_t port;
1297         struct ast_tcptls_session_instance *tcptls_session;     /* If tcp or tls, a socket manager */
1298 };
1299
1300 /*! \brief sip_request: The data grabbed from the UDP socket
1301  *
1302  * \verbatim
1303  * Incoming messages: we first store the data from the socket in data[],
1304  * adding a trailing \0 to make string parsing routines happy.
1305  * Then call parse_request() and req.method = find_sip_method();
1306  * to initialize the other fields. The \r\n at the end of each line is   
1307  * replaced by \0, so that data[] is not a conforming SIP message anymore.
1308  * After this processing, rlPart1 is set to non-NULL to remember
1309  * that we can run get_header() on this kind of packet.
1310  *
1311  * parse_request() splits the first line as follows:
1312  * Requests have in the first line      method uri SIP/2.0
1313  *      rlPart1 = method; rlPart2 = uri;
1314  * Responses have in the first line     SIP/2.0 NNN description
1315  *      rlPart1 = SIP/2.0; rlPart2 = NNN + description;
1316  *
1317  * For outgoing packets, we initialize the fields with init_req() or init_resp()
1318  * (which fills the first line to "METHOD uri SIP/2.0" or "SIP/2.0 code text"),
1319  * and then fill the rest with add_header() and add_line().
1320  * The \r\n at the end of the line are still there, so the get_header()
1321  * and similar functions don't work on these packets. 
1322  * \endverbatim
1323  */
1324 struct sip_request {
1325         ptrdiff_t rlPart1;              /*!< Offset of the SIP Method Name or "SIP/2.0" protocol version */
1326         ptrdiff_t rlPart2;              /*!< Offset of the Request URI or Response Status */
1327         int len;                /*!< bytes used in data[], excluding trailing null terminator. Rarely used. */
1328         int headers;            /*!< # of SIP Headers */
1329         int method;             /*!< Method of this request */
1330         int lines;              /*!< Body Content */
1331         unsigned int sdp_start; /*!< the line number where the SDP begins */
1332         unsigned int sdp_end;   /*!< the line number where the SDP ends */
1333         char debug;             /*!< print extra debugging if non zero */
1334         char has_to_tag;        /*!< non-zero if packet has To: tag */
1335         char ignore;            /*!< if non-zero This is a re-transmit, ignore it */
1336         /* Array of offsets into the request string of each SIP header*/
1337         ptrdiff_t header[SIP_MAX_HEADERS];
1338         /* Array of offsets into the request string of each SDP line*/
1339         ptrdiff_t line[SIP_MAX_LINES];
1340         struct ast_str *data;   
1341         /* XXX Do we need to unref socket.ser when the request goes away? */
1342         struct sip_socket socket;       /*!< The socket used for this request */
1343         AST_LIST_ENTRY(sip_request) next;
1344 };
1345
1346 /* \brief given a sip_request and an offset, return the char * that resides there
1347  *
1348  * It used to be that rlPart1, rlPart2, and the header and line arrays were character
1349  * pointers. They are now offsets into the ast_str portion of the sip_request structure.
1350  * To avoid adding a bunch of redundant pointer arithmetic to the code, this macro is
1351  * provided to retrieve the string at a particular offset within the request's buffer
1352  */
1353 #define REQ_OFFSET_TO_STR(req,offset) (ast_str_buffer((req)->data) + ((req)->offset))
1354
1355 /*! \brief structure used in transfers */
1356 struct sip_dual {
1357         struct ast_channel *chan1;      /*!< First channel involved */
1358         struct ast_channel *chan2;      /*!< Second channel involved */
1359         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
1360         int seqno;                      /*!< Sequence number */
1361 };
1362
1363 struct sip_pkt;
1364
1365 /*! \brief Parameters to the transmit_invite function */
1366 struct sip_invite_param {
1367         int addsipheaders;              /*!< Add extra SIP headers */
1368         const char *uri_options;        /*!< URI options to add to the URI */
1369         const char *vxml_url;           /*!< VXML url for Cisco phones */
1370         char *auth;                     /*!< Authentication */
1371         char *authheader;               /*!< Auth header */
1372         enum sip_auth_type auth_type;   /*!< Authentication type */
1373         const char *replaces;           /*!< Replaces header for call transfers */
1374         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
1375 };
1376
1377 /*! \brief Structure to save routing information for a SIP session */
1378 struct sip_route {
1379         struct sip_route *next;
1380         char hop[0];
1381 };
1382
1383 /*! \brief Modes for SIP domain handling in the PBX */
1384 enum domain_mode {
1385         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
1386         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
1387 };
1388
1389 /*! \brief Domain data structure. 
1390         \note In the future, we will connect this to a configuration tree specific
1391         for this domain
1392 */
1393 struct domain {
1394         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
1395         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
1396         enum domain_mode mode;                  /*!< How did we find this domain? */
1397         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
1398 };
1399
1400 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
1401
1402
1403 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
1404 struct sip_history {
1405         AST_LIST_ENTRY(sip_history) list;
1406         char event[0];  /* actually more, depending on needs */
1407 };
1408
1409 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
1410
1411 /*! \brief sip_auth: Credentials for authentication to other SIP services */
1412 struct sip_auth {
1413         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
1414         char username[256];             /*!< Username */
1415         char secret[256];               /*!< Secret */
1416         char md5secret[256];            /*!< MD5Secret */
1417         struct sip_auth *next;          /*!< Next auth structure in list */
1418 };
1419
1420 /*! \name SIPflags
1421         Various flags for the flags field in the pvt structure 
1422         Trying to sort these up (one or more of the following):
1423         D: Dialog
1424         P: Peer/user
1425         G: Global flag
1426         When flags are used by multiple structures, it is important that
1427         they have a common layout so it is easy to copy them.
1428 */
1429 /*@{*/ 
1430 #define SIP_OUTGOING            (1 << 0)        /*!< D: Direction of the last transaction in this dialog */
1431 #define SIP_RINGING             (1 << 2)        /*!< D: Have sent 180 ringing */
1432 #define SIP_PROGRESS_SENT       (1 << 3)        /*!< D: Have sent 183 message progress */
1433 #define SIP_NEEDREINVITE        (1 << 4)        /*!< D: Do we need to send another reinvite? */
1434 #define SIP_PENDINGBYE          (1 << 5)        /*!< D: Need to send bye after we ack? */
1435 #define SIP_GOTREFER            (1 << 6)        /*!< D: Got a refer? */
1436 #define SIP_CALL_LIMIT          (1 << 7)        /*!< D: Call limit enforced for this call */
1437 #define SIP_INC_COUNT           (1 << 8)        /*!< D: Did this dialog increment the counter of in-use calls? */
1438 #define SIP_INC_RINGING         (1 << 9)        /*!< D: Did this connection increment the counter of in-use calls? */
1439 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 10)       /*!< D: Do not hangup at first ast_hangup */
1440
1441 #define SIP_PROMISCREDIR        (1 << 11)       /*!< DP: Promiscuous redirection */
1442 #define SIP_TRUSTRPID           (1 << 12)       /*!< DP: Trust RPID headers? */
1443 #define SIP_USEREQPHONE         (1 << 13)       /*!< DP: Add user=phone to numeric URI. Default off */
1444 #define SIP_USECLIENTCODE       (1 << 14)       /*!< DP: Trust X-ClientCode info message */
1445
1446 /* DTMF flags - see str2dtmfmode() and dtmfmode2str() */
1447 #define SIP_DTMF                (7 << 15)       /*!< DP: DTMF Support: five settings, uses three bits */
1448 #define SIP_DTMF_RFC2833        (0 << 15)       /*!< DP: DTMF Support: RTP DTMF - "rfc2833" */
1449 #define SIP_DTMF_INBAND         (1 << 15)       /*!< DP: DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
1450 #define SIP_DTMF_INFO           (2 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" */
1451 #define SIP_DTMF_AUTO           (3 << 15)       /*!< DP: DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
1452 #define SIP_DTMF_SHORTINFO      (4 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" - short variant */
1453
1454 /* NAT settings - see nat2str() */
1455 #define SIP_NAT                 (3 << 18)       /*!< DP: four settings, uses two bits */
1456 #define SIP_NAT_NEVER           (0 << 18)       /*!< DP: No nat support */
1457 #define SIP_NAT_RFC3581         (1 << 18)       /*!< DP: NAT RFC3581 */
1458 #define SIP_NAT_ROUTE           (2 << 18)       /*!< DP: NAT Only ROUTE */
1459 #define SIP_NAT_ALWAYS          (3 << 18)       /*!< DP: NAT Both ROUTE and RFC3581 */
1460
1461 /* re-INVITE related settings */
1462 #define SIP_REINVITE            (7 << 20)       /*!< DP: four settings, uses three bits */
1463 #define SIP_REINVITE_NONE       (0 << 20)       /*!< DP: no reinvite allowed */
1464 #define SIP_CAN_REINVITE        (1 << 20)       /*!< DP: allow peers to be reinvited to send media directly p2p */
1465 #define SIP_CAN_REINVITE_NAT    (2 << 20)       /*!< DP: allow media reinvite when new peer is behind NAT */
1466 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< DP: use UPDATE (RFC3311) when reinviting this peer */
1467
1468 /* "insecure" settings - see insecure2str() */
1469 #define SIP_INSECURE            (3 << 23)       /*!< DP: three settings, uses two bits */
1470 #define SIP_INSECURE_NONE       (0 << 23)       /*!< DP: secure mode */
1471 #define SIP_INSECURE_PORT       (1 << 23)       /*!< DP: don't require matching port for incoming requests */
1472 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< DP: don't require authentication for incoming INVITEs */
1473
1474 /* Sending PROGRESS in-band settings */
1475 #define SIP_PROG_INBAND         (3 << 25)       /*!< DP: three settings, uses two bits */
1476 #define SIP_PROG_INBAND_NEVER   (0 << 25)
1477 #define SIP_PROG_INBAND_NO      (1 << 25)
1478 #define SIP_PROG_INBAND_YES     (2 << 25)
1479
1480 #define SIP_SENDRPID            (3 << 29)       /*!< DP: Remote Party-ID Support */
1481 #define SIP_SENDRPID_NO     (0 << 29)
1482 #define SIP_SENDRPID_PAI    (1 << 29)   /*!< Use "P-Asserted-Identity" for rpid */
1483 #define SIP_SENDRPID_RPID   (2 << 29)   /*!< Use "Remote-Party-ID" for rpid */
1484 #define SIP_G726_NONSTANDARD    (1 << 31)       /*!< DP: Use non-standard packing for G726-32 data */
1485
1486 /*! \brief Flags to copy from peer/user to dialog */
1487 #define SIP_FLAGS_TO_COPY \
1488         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
1489          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT | SIP_G726_NONSTANDARD | \
1490          SIP_USEREQPHONE | SIP_INSECURE)
1491 /*@}*/ 
1492
1493 /*! \name SIPflags2
1494         a second page of flags (for flags[1] */
1495 /*@{*/ 
1496 /* realtime flags */
1497 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)        /*!< GP: Should we keep RT objects in memory for extended time? */
1498 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)        /*!< GP: Should we clean memory from peers after expiry? */
1499 #define SIP_PAGE2_RPID_UPDATE           (1 << 3)
1500 /* Space for addition of other realtime flags in the future */
1501 #define SIP_PAGE2_STATECHANGEQUEUE      (1 << 9)        /*!< D: Unsent state pending change exists */
1502
1503 #define SIP_PAGE2_CONNECTLINEUPDATE_PEND                (1 << 10)
1504 #define SIP_PAGE2_RPID_IMMEDIATE                        (1 << 11)
1505 #define SIP_PAGE2_RPORT_PRESENT         (1 << 12)       /*!< Was rport received in the Via header? */
1506 #define SIP_PAGE2_PREFERRED_CODEC       (1 << 13)       /*!< GDP: Only respond with single most preferred joint codec */
1507 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 14)       /*!< DP: Video supported if offered? */
1508 #define SIP_PAGE2_TEXTSUPPORT           (1 << 15)       /*!< GDP: Global text enable */
1509 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< GP: Allow subscriptions from this peer? */
1510 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< DP: Allow overlap dialing ? */
1511 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< GP: Only issue MWI notification if subscribed to */
1512 #define SIP_PAGE2_IGNORESDPVERSION      (1 << 19)       /*!< GDP: Ignore the SDP session version number we receive and treat all sessions as new */
1513
1514 #define SIP_PAGE2_T38SUPPORT            (7 << 20)       /*!< GDP: T38 Fax Passthrough Support */
1515 #define SIP_PAGE2_T38SUPPORT_UDPTL      (1 << 20)       /*!< GDP: T38 Fax Passthrough Support */
1516 #define SIP_PAGE2_T38SUPPORT_RTP        (2 << 20)       /*!< GDP: T38 Fax Passthrough Support (not implemented) */
1517 #define SIP_PAGE2_T38SUPPORT_TCP        (4 << 20)       /*!< GDP: T38 Fax Passthrough Support (not implemented) */
1518
1519 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< D: Call hold states: */
1520 #define SIP_PAGE2_CALL_ONHOLD_ACTIVE    (1 << 23)       /*!< D: Active hold */
1521 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (2 << 23)       /*!< D: One directional hold */
1522 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (3 << 23)       /*!< D: Inactive hold */
1523
1524 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 25)       /*!< DP: Compensate for buggy RFC2833 implementations */
1525 #define SIP_PAGE2_BUGGY_MWI             (1 << 26)       /*!< DP: Buggy CISCO MWI fix */
1526 #define SIP_PAGE2_DIALOG_ESTABLISHED    (1 << 27)       /*!< 29: Has a dialog been established? */
1527 #define SIP_PAGE2_FAX_DETECT            (1 << 28)               /*!< DP: Fax Detection support */
1528 #define SIP_PAGE2_REGISTERTRYING        (1 << 29)       /*!< DP: Send 100 Trying on REGISTER attempts */
1529 #define SIP_PAGE2_UDPTL_DESTINATION     (1 << 30)       /*!< DP: Use source IP of RTP as destination if NAT is enabled */
1530 #define SIP_PAGE2_VIDEOSUPPORT_ALWAYS   (1 << 31)       /*!< DP: Always set up video, even if endpoints don't support it */
1531
1532 #define SIP_PAGE2_FLAGS_TO_COPY \
1533         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_IGNORESDPVERSION | \
1534         SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE | \
1535         SIP_PAGE2_BUGGY_MWI | SIP_PAGE2_TEXTSUPPORT | SIP_PAGE2_FAX_DETECT | \
1536         SIP_PAGE2_UDPTL_DESTINATION | SIP_PAGE2_VIDEOSUPPORT_ALWAYS | SIP_PAGE2_PREFERRED_CODEC | \
1537         SIP_PAGE2_RPID_IMMEDIATE | SIP_PAGE2_RPID_UPDATE)
1538
1539 /*@}*/ 
1540
1541 /*! \name SIPflagsT38
1542         T.38 set of flags */
1543
1544 /*@{*/ 
1545 #define T38FAX_FILL_BIT_REMOVAL                 (1 << 0)        /*!< Default: 0 (unset)*/
1546 #define T38FAX_TRANSCODING_MMR                  (1 << 1)        /*!< Default: 0 (unset)*/
1547 #define T38FAX_TRANSCODING_JBIG                 (1 << 2)        /*!< Default: 0 (unset)*/
1548 /* Rate management */
1549 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF   (0 << 3)
1550 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF        (1 << 3)        /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
1551 /* UDP Error correction */
1552 #define T38FAX_UDP_EC_NONE                      (0 << 4)        /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
1553 #define T38FAX_UDP_EC_FEC                       (1 << 4)        /*!< Set for t38UDPFEC */
1554 #define T38FAX_UDP_EC_REDUNDANCY                (2 << 4)        /*!< Set for t38UDPRedundancy */
1555 /* T38 Spec version */
1556 #define T38FAX_VERSION                          (3 << 6)        /*!< two bits, 2 values so far, up to 4 values max */
1557 #define T38FAX_VERSION_0                        (0 << 6)        /*!< Version 0 */
1558 #define T38FAX_VERSION_1                        (1 << 6)        /*!< Version 1 */
1559 /* Maximum Fax Rate */
1560 #define T38FAX_RATE_2400                        (1 << 8)        /*!< 2400 bps t38FaxRate */
1561 #define T38FAX_RATE_4800                        (1 << 9)        /*!< 4800 bps t38FaxRate */
1562 #define T38FAX_RATE_7200                        (1 << 10)       /*!< 7200 bps t38FaxRate */
1563 #define T38FAX_RATE_9600                        (1 << 11)       /*!< 9600 bps t38FaxRate */
1564 #define T38FAX_RATE_12000                       (1 << 12)       /*!< 12000 bps t38FaxRate */
1565 #define T38FAX_RATE_14400                       (1 << 13)       /*!< 14400 bps t38FaxRate */
1566
1567 /*!< This is default: NO MMR and JBIG transcoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
1568 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
1569 /*@}*/ 
1570
1571 /*! \brief debugging state
1572  * We store separately the debugging requests from the config file
1573  * and requests from the CLI. Debugging is enabled if either is set
1574  * (which means that if sipdebug is set in the config file, we can
1575  * only turn it off by reloading the config).
1576  */
1577 enum sip_debug_e {
1578         sip_debug_none = 0,
1579         sip_debug_config = 1,
1580         sip_debug_console = 2,
1581 };
1582
1583 static enum sip_debug_e sipdebug;
1584
1585 /*! \brief extra debugging for 'text' related events.
1586  * At the moment this is set together with sip_debug_console.
1587  * \note It should either go away or be implemented properly.
1588  */
1589 static int sipdebug_text;
1590
1591 /*! \brief T38 States for a call */
1592 enum t38state {
1593         T38_DISABLED = 0,                /*!< Not enabled */
1594         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
1595         T38_PEER_DIRECT,                 /*!< Offered from peer */
1596         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
1597         T38_ENABLED                      /*!< Negotiated (enabled) */
1598 };
1599
1600 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
1601 struct t38properties {
1602         struct ast_flags t38support;    /*!< Flag for udptl, rtp or tcp support for this session */
1603         int capability;                 /*!< Our T38 capability */
1604         int peercapability;             /*!< Peers T38 capability */
1605         int jointcapability;            /*!< Supported T38 capability at both ends */
1606         enum t38state state;            /*!< T.38 state */
1607         unsigned int direct:1;          /*!< Whether the T38 came from the initial invite or not */
1608 };
1609
1610 /*! \brief Parameters to know status of transfer */
1611 enum referstatus {
1612         REFER_IDLE,                    /*!< No REFER is in progress */
1613         REFER_SENT,                    /*!< Sent REFER to transferee */
1614         REFER_RECEIVED,                /*!< Received REFER from transferrer */
1615         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING (unused) */
1616         REFER_ACCEPTED,                /*!< Accepted by transferee */
1617         REFER_RINGING,                 /*!< Target Ringing */
1618         REFER_200OK,                   /*!< Answered by transfer target */
1619         REFER_FAILED,                  /*!< REFER declined - go on */
1620         REFER_NOAUTH                   /*!< We had no auth for REFER */
1621 };
1622
1623 /*! \brief generic struct to map between strings and integers.
1624  * Fill it with x-s pairs, terminate with an entry with s = NULL;
1625  * Then you can call map_x_s(...) to map an integer to a string,
1626  * and map_s_x() for the string -> integer mapping.
1627  */
1628 struct _map_x_s {
1629         int x;
1630         const char *s;
1631 };              
1632
1633 static const struct _map_x_s referstatusstrings[] = {
1634         { REFER_IDLE,           "<none>" },
1635         { REFER_SENT,           "Request sent" },
1636         { REFER_RECEIVED,       "Request received" },
1637         { REFER_CONFIRMED,      "Confirmed" },
1638         { REFER_ACCEPTED,       "Accepted" },
1639         { REFER_RINGING,        "Target ringing" },
1640         { REFER_200OK,          "Done" },
1641         { REFER_FAILED,         "Failed" },
1642         { REFER_NOAUTH,         "Failed - auth failure" },
1643         { -1,                   NULL} /* terminator */
1644 };
1645
1646 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed
1647         \note OEJ: Should be moved to string fields */
1648 struct sip_refer {
1649         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
1650         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
1651         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
1652         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
1653         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
1654         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
1655         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
1656         char replaces_callid[SIPBUFSIZE];                       /*!< Replace info: callid */
1657         char replaces_callid_totag[SIPBUFSIZE/2];               /*!< Replace info: to-tag */
1658         char replaces_callid_fromtag[SIPBUFSIZE/2];             /*!< Replace info: from-tag */
1659         struct sip_pvt *refer_call;                     /*!< Call we are referring. This is just a reference to a
1660                                                          * dialog owned by someone else, so we should not destroy
1661                                                          * it when the sip_refer object goes.
1662                                                          */
1663         int attendedtransfer;                           /*!< Attended or blind transfer? */
1664         int localtransfer;                              /*!< Transfer to local domain? */
1665         enum referstatus status;                        /*!< REFER status */
1666 };
1667
1668
1669 /*! \brief Structure that encapsulates all attributes related to running 
1670  *   SIP Session-Timers feature on a per dialog basis.
1671  */
1672 struct sip_st_dlg {
1673         int st_active;                          /*!< Session-Timers on/off */ 
1674         int st_interval;                        /*!< Session-Timers negotiated session refresh interval */
1675         int st_schedid;                         /*!< Session-Timers ast_sched scheduler id */
1676         enum st_refresher st_ref;               /*!< Session-Timers session refresher */
1677         int st_expirys;                         /*!< Session-Timers number of expirys */
1678         int st_active_peer_ua;                  /*!< Session-Timers on/off in peer UA */
1679         int st_cached_min_se;                   /*!< Session-Timers cached Min-SE */
1680         int st_cached_max_se;                   /*!< Session-Timers cached Session-Expires */
1681         enum st_mode st_cached_mode;            /*!< Session-Timers cached M.O. */
1682         enum st_refresher st_cached_ref;        /*!< Session-Timers cached refresher */
1683 };
1684
1685
1686 /*! \brief Structure that encapsulates all attributes related to configuration 
1687  *   of SIP Session-Timers feature on a per user/peer basis.
1688  */
1689 struct sip_st_cfg {
1690         enum st_mode st_mode_oper;      /*!< Mode of operation for Session-Timers           */
1691         enum st_refresher st_ref;       /*!< Session-Timer refresher                        */
1692         int st_min_se;                  /*!< Lowest threshold for session refresh interval  */
1693         int st_max_se;                  /*!< Highest threshold for session refresh interval */
1694 };
1695
1696
1697
1698
1699 /*! \brief Structure used for each SIP dialog, ie. a call, a registration, a subscribe.
1700  * Created and initialized by sip_alloc(), the descriptor goes into the list of
1701  * descriptors (dialoglist).
1702  */
1703 struct sip_pvt {
1704         struct sip_pvt *next;                   /*!< Next dialog in chain */
1705         enum invitestates invitestate;          /*!< Track state of SIP_INVITEs */
1706         int method;                             /*!< SIP method that opened this dialog */
1707         AST_DECLARE_STRING_FIELDS(
1708                 AST_STRING_FIELD(callid);       /*!< Global CallID */
1709                 AST_STRING_FIELD(randdata);     /*!< Random data */
1710                 AST_STRING_FIELD(accountcode);  /*!< Account code */
1711                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1712                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1713                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1714                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1715                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1716                 AST_STRING_FIELD(from);         /*!< The From: header */
1717                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
1718                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
1719                 AST_STRING_FIELD(context);      /*!< Context for this call */
1720                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
1721                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
1722                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
1723                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
1724                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
1725                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
1726                 AST_STRING_FIELD(todnid);       /*!< DNID of this call (overrides host) */
1727                 AST_STRING_FIELD(language);     /*!< Default language for this call */
1728                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
1729                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
1730                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
1731                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
1732                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
1733                 AST_STRING_FIELD(username);     /*!< [user] name */
1734                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
1735                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
1736                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
1737                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
1738                 AST_STRING_FIELD(peersecret);   /*!< Password */
1739                 AST_STRING_FIELD(peermd5secret);
1740                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
1741                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
1742                 AST_STRING_FIELD(mwi_from); /*!< Name to place in the From header in outgoing NOTIFY requests */
1743                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
1744                         /* we only store the part in <brackets> in this field. */
1745                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
1746                 AST_STRING_FIELD(url);          /*!< URL to be sent with next message to peer */
1747                 AST_STRING_FIELD(parkinglot);           /*!< Parkinglot */
1748                 AST_STRING_FIELD(engine);       /*!< RTP engine to use */
1749         );
1750         char via[128];                          /*!< Via: header */
1751         struct sip_socket socket;               /*!< The socket used for this dialog */
1752         unsigned int ocseq;                     /*!< Current outgoing seqno */
1753         unsigned int icseq;                     /*!< Current incoming seqno */
1754         ast_group_t callgroup;                  /*!< Call group */
1755         ast_group_t pickupgroup;                /*!< Pickup group */
1756         int lastinvite;                         /*!< Last Cseq of invite */
1757         int lastnoninvite;                      /*!< Last Cseq of non-invite */
1758         struct ast_flags flags[2];              /*!< SIP_ flags */
1759
1760         /* boolean flags that don't belong in flags */
1761         unsigned short do_history:1;            /*!< Set if we want to record history */
1762         unsigned short alreadygone:1;           /*!< already destroyed by our peer */
1763         unsigned short needdestroy:1;           /*!< need to be destroyed by the monitor thread */
1764         unsigned short outgoing_call:1;         /*!< this is an outgoing call */
1765         unsigned short answered_elsewhere:1;    /*!< This call is cancelled due to answer on another channel */
1766         unsigned short novideo:1;               /*!< Didn't get video in invite, don't offer */
1767         unsigned short notext:1;                /*!< Text not supported  (?) */
1768         unsigned short session_modify:1;        /*!< Session modification request true/false  */
1769         unsigned short route_persistent:1;      /*!< Is this the "real" route? */
1770         unsigned short autoframing:1;           /*!< Whether to use our local configuration for frame sizes (off)
1771                                                  *   or respect the other endpoint's request for frame sizes (on)
1772                                                  *   for incoming calls
1773                                                  */
1774         char tag[11];                           /*!< Our tag for this session */
1775         int timer_t1;                           /*!< SIP timer T1, ms rtt */
1776         int timer_b;                            /*!< SIP timer B, ms */
1777         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
1778         unsigned int reqsipoptions;             /*!< Required SIP options on the other end */
1779         struct ast_codec_pref prefs;            /*!< codec prefs */
1780         int capability;                         /*!< Special capability (codec) */
1781         int jointcapability;                    /*!< Supported capability at both ends (codecs) */
1782         int peercapability;                     /*!< Supported peer capability */
1783         int prefcodec;                          /*!< Preferred codec (outbound only) */
1784         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
1785         int jointnoncodeccapability;            /*!< Joint Non codec capability */
1786         int redircodecs;                        /*!< Redirect codecs */
1787         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */    
1788         int request_queue_sched_id;             /*!< Scheduler ID of any scheduled action to process queued requests */
1789         int authtries;                          /*!< Times we've tried to authenticate */
1790         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this dialog. Use ref_proxy to set this instead of setting it directly*/
1791         struct t38properties t38;               /*!< T38 settings */
1792         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
1793         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
1794         int callingpres;                        /*!< Calling presentation */
1795         int expiry;                             /*!< How long we take to expire */
1796         int sessionversion;                     /*!< SDP Session Version */
1797         int sessionid;                          /*!< SDP Session ID */
1798         long branch;                            /*!< The branch identifier of this session */
1799         long invite_branch;                     /*!< The branch used when we sent the initial INVITE */
1800         uint64_t sessionversion_remote;         /*!< Remote UA's SDP Session Version */
1801         struct sockaddr_in sa;                  /*!< Our peer */
1802         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
1803         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
1804         struct sockaddr_in tredirip;            /*!< Where our Text RTP should be going if not to us */
1805         time_t lastrtprx;                       /*!< Last RTP received */
1806         time_t lastrtptx;                       /*!< Last RTP sent */
1807         int rtptimeout;                         /*!< RTP timeout time */
1808         struct sockaddr_in recv;                /*!< Received as */
1809         struct sockaddr_in ourip;               /*!< Our IP (as seen from the outside) */
1810         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
1811         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
1812         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
1813         struct ast_variable *notify_headers;    /*!< Custom notify type */
1814         struct sip_auth *peerauth;              /*!< Realm authentication */
1815         int noncecount;                         /*!< Nonce-count */
1816         char lastmsg[256];                      /*!< Last Message sent/received */
1817         int amaflags;                           /*!< AMA Flags */
1818         int pendinginvite;                      /*!< Any pending INVITE or state NOTIFY (in subscribe pvt's) ? (seqno of this) */
1819         int glareinvite;                        /*!< A invite received while a pending invite is already present is stored here.  Its seqno is the
1820                                                 value. Since this glare invite's seqno is not the same as the pending invite's, it must be 
1821                                                 held in order to properly process acknowledgements for our 491 response. */
1822         struct sip_request initreq;             /*!< Latest request that opened a new transaction
1823                                                         within this dialog.
1824                                                         NOT the request that opened the dialog */
1825
1826         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
1827         int waitid;                             /*!< Wait ID for scheduler after 491 or other delays */
1828         int autokillid;                         /*!< Auto-kill ID (scheduler) */
1829         int t38id;                              /*!< T.38 Response ID */
1830         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
1831         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
1832         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
1833         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
1834         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
1835
1836         struct ast_dsp *vad;                    /*!< Inband DTMF Detection dsp */
1837
1838         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one 
1839                                                         Used in peerpoke, mwi subscriptions */
1840         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
1841         struct ast_rtp_instance *rtp;                   /*!< RTP Session */
1842         struct ast_rtp_instance *vrtp;                  /*!< Video RTP session */
1843         struct ast_rtp_instance *trtp;                  /*!< Text RTP session */
1844         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
1845         struct sip_history_head *history;       /*!< History of this SIP dialog */
1846         size_t history_entries;                 /*!< Number of entires in the history */
1847         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
1848         AST_LIST_HEAD_NOLOCK(request_queue, sip_request) request_queue; /*!< Requests that arrived but could not be processed immediately */
1849         struct sip_invite_param *options;       /*!< Options for INVITE */
1850         struct sip_st_dlg *stimer;              /*!< SIP Session-Timers */              
1851   
1852         int red;                                /*!< T.140 RTP Redundancy */
1853         int hangupcause;                        /*!< Storage of hangupcause copied from our owner before we disconnect from the AST channel (only used at hangup) */
1854
1855         struct sip_subscription_mwi *mwi;       /*!< If this is a subscription MWI dialog, to which subscription */
1856         /*! The SIP methods allowed on this dialog. We get this information from the Allow header present in 
1857          * the peer's REGISTER. If peer does not register with us, then we will use the first transaction we
1858          * have with this peer to determine its allowed methods.
1859          */
1860         unsigned int allowed_methods;
1861 }; 
1862
1863
1864 /*! \brief
1865  * Here we implement the container for dialogs (sip_pvt), defining
1866  * generic wrapper functions to ease the transition from the current
1867  * implementation (a single linked list) to a different container.
1868  * In addition to a reference to the container, we need functions to lock/unlock
1869  * the container and individual items, and functions to add/remove
1870  * references to the individual items.
1871  */
1872 static struct ao2_container *dialogs;
1873
1874 #define sip_pvt_lock(x) ao2_lock(x)
1875 #define sip_pvt_trylock(x) ao2_trylock(x)
1876 #define sip_pvt_unlock(x) ao2_unlock(x)
1877
1878 /*! \brief
1879  * when we create or delete references, make sure to use these
1880  * functions so we keep track of the refcounts.
1881  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1882  */
1883 #ifdef REF_DEBUG
1884 #define dialog_ref(arg1,arg2) dialog_ref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1885 #define dialog_unref(arg1,arg2) dialog_unref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1886
1887 static struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1888 {
1889         if (p)
1890                 _ao2_ref_debug(p, 1, tag, file, line, func);
1891         else
1892                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1893         return p;
1894 }
1895
1896 static struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1897 {
1898         if (p)
1899                 _ao2_ref_debug(p, -1, tag, file, line, func);
1900         return NULL;
1901 }
1902 #else
1903 static struct sip_pvt *dialog_ref(struct sip_pvt *p, char *tag)
1904 {
1905         if (p)
1906                 ao2_ref(p, 1);
1907         else
1908                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1909         return p;
1910 }
1911
1912 static struct sip_pvt *dialog_unref(struct sip_pvt *p, char *tag)
1913 {
1914         if (p)
1915                 ao2_ref(p, -1);
1916         return NULL;
1917 }
1918 #endif
1919
1920 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission
1921  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1922  * Each packet holds a reference to the parent struct sip_pvt.
1923  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1924  * require retransmissions.
1925  */
1926 struct sip_pkt {
1927         struct sip_pkt *next;                   /*!< Next packet in linked list */
1928         int retrans;                            /*!< Retransmission number */
1929         int method;                             /*!< SIP method for this packet */
1930         int seqno;                              /*!< Sequence number */
1931         char is_resp;                           /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1932         char is_fatal;                          /*!< non-zero if there is a fatal error */
1933         struct sip_pvt *owner;                  /*!< Owner AST call */
1934         int retransid;                          /*!< Retransmission ID */
1935         int timer_a;                            /*!< SIP timer A, retransmission timer */
1936         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1937         int packetlen;                          /*!< Length of packet */
1938         struct ast_str *data;
1939 };      
1940
1941 /*!
1942  * \brief A peer's mailbox
1943  *
1944  * We could use STRINGFIELDS here, but for only two strings, it seems like
1945  * too much effort ...
1946  */
1947 struct sip_mailbox {
1948         char *mailbox;
1949         char *context;
1950         /*! Associated MWI subscription */
1951         struct ast_event_sub *event_sub;
1952         AST_LIST_ENTRY(sip_mailbox) entry;
1953 };
1954
1955 enum sip_peer_type {
1956         SIP_TYPE_PEER = (1 << 0),
1957         SIP_TYPE_USER = (1 << 1),
1958 };
1959
1960 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) 
1961 */
1962 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail, as will astobj2 hashing of the structure */
1963 struct sip_peer {
1964         char name[80];                                  /*!< the unique name of this object */
1965         AST_DECLARE_STRING_FIELDS(
1966                 AST_STRING_FIELD(secret);               /*!< Password for inbound auth */
1967                 AST_STRING_FIELD(md5secret);            /*!< Password in MD5 */
1968                 AST_STRING_FIELD(remotesecret);         /*!< Remote secret (trunks, remote devices) */
1969                 AST_STRING_FIELD(context);              /*!< Default context for incoming calls */
1970                 AST_STRING_FIELD(subscribecontext);     /*!< Default context for subscriptions */
1971                 AST_STRING_FIELD(username);             /*!< Temporary username until registration */ 
1972                 AST_STRING_FIELD(accountcode);          /*!< Account code */
1973                 AST_STRING_FIELD(tohost);               /*!< If not dynamic, IP address */
1974                 AST_STRING_FIELD(regexten);             /*!< Extension to register (if regcontext is used) */
1975                 AST_STRING_FIELD(fromuser);             /*!< From: user when calling this peer */
1976                 AST_STRING_FIELD(fromdomain);           /*!< From: domain when calling this peer */
1977                 AST_STRING_FIELD(fullcontact);          /*!< Contact registered with us (not in sip.conf) */
1978                 AST_STRING_FIELD(cid_num);              /*!< Caller ID num */
1979                 AST_STRING_FIELD(cid_name);             /*!< Caller ID name */
1980                 AST_STRING_FIELD(vmexten);              /*!< Dialplan extension for MWI notify message*/
1981                 AST_STRING_FIELD(language);             /*!<  Default language for prompts */
1982                 AST_STRING_FIELD(mohinterpret);         /*!<  Music on Hold class */
1983                 AST_STRING_FIELD(mohsuggest);           /*!<  Music on Hold class */
1984                 AST_STRING_FIELD(parkinglot);           /*!<  Parkinglot */
1985                 AST_STRING_FIELD(useragent);            /*!<  User agent in SIP request (saved from registration) */
1986                 AST_STRING_FIELD(mwi_from);         /*!< Name to place in From header for outgoing NOTIFY requests */
1987                 AST_STRING_FIELD(engine);               /*!<  RTP Engine to use */
1988                 );
1989         struct sip_socket socket;       /*!< Socket used for this peer */
1990         enum sip_transport default_outbound_transport;    /*!< Peer Registration may change the default outbound transport.
1991                                                             If register expires, default should be reset. to this value */
1992         /* things that don't belong in flags */
1993         unsigned short transports:3;    /*!< Transports (enum sip_transport) that are acceptable for this peer */
1994         unsigned short is_realtime:1;   /*!< this is a 'realtime' peer */
1995         unsigned short rt_fromcontact:1;/*!< copy fromcontact from realtime */
1996         unsigned short host_dynamic:1;  /*!< Dynamic Peers register with Asterisk */
1997         unsigned short selfdestruct:1;  /*!< Automatic peers need to destruct themselves */
1998         unsigned short the_mark:1;      /*!< moved out of ASTOBJ into struct proper; That which bears the_mark should be deleted! */
1999         unsigned short autoframing:1;   /*!< Whether to use our local configuration for frame sizes (off)
2000                                          *   or respect the other endpoint's request for frame sizes (on)
2001                                          *   for incoming calls
2002                                          */
2003         struct sip_auth *auth;          /*!< Realm authentication list */
2004         int amaflags;                   /*!< AMA Flags (for billing) */
2005         int callingpres;                /*!< Calling id presentation */
2006         int inUse;                      /*!< Number of calls in use */
2007         int inRinging;                  /*!< Number of calls ringing */
2008         int onHold;                     /*!< Peer has someone on hold */
2009         int call_limit;                 /*!< Limit of concurrent calls */
2010         int busy_level;                 /*!< Level of active channels where we signal busy */
2011         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
2012         struct ast_codec_pref prefs;    /*!<  codec prefs */
2013         int lastmsgssent;
2014         unsigned int sipoptions;        /*!<  Supported SIP options */
2015         struct ast_flags flags[2];      /*!<  SIP_ flags */
2016
2017         /*! Mailboxes that this peer cares about */
2018         AST_LIST_HEAD_NOLOCK(, sip_mailbox) mailboxes;
2019
2020         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
2021         int expire;                     /*!<  When to expire this peer registration */
2022         int capability;                 /*!<  Codec capability */
2023         int rtptimeout;                 /*!<  RTP timeout */
2024         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
2025         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
2026         ast_group_t callgroup;          /*!<  Call group */
2027         ast_group_t pickupgroup;        /*!<  Pickup group */
2028         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
2029         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
2030         struct sockaddr_in addr;        /*!<  IP address of peer */
2031         /* Qualification */
2032         struct sip_pvt *call;           /*!<  Call pointer */
2033         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
2034         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
2035         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
2036         int qualifyfreq;                /*!<  Qualification: How often to check for the host to be up */
2037         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
2038         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
2039         struct ast_ha *ha;              /*!<  Access control list */
2040         struct ast_ha *contactha;       /*!<  Restrict what IPs are allowed in the Contact header (for registration) */
2041         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
2042         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
2043         struct sip_st_cfg stimer;       /*!<  SIP Session-Timers */
2044         int timer_t1;                   /*!<  The maximum T1 value for the peer */
2045         int timer_b;                    /*!<  The maximum timer B (transaction timeouts) */
2046         int deprecated_username; /*!< If it's a realtime peer, are they using the deprecated "username" instead of "defaultuser" */
2047         
2048         /*XXX Seems like we suddenly have two flags with the same content. Why? To be continued... */
2049         enum sip_peer_type type; /*!< Distinguish between "user" and "peer" types. This is used solely for CLI and manager commands */
2050         unsigned int allowed_methods;
2051 };
2052
2053
2054 /*! 
2055  * \brief Registrations with other SIP proxies
2056  *
2057  * Created by sip_register(), the entry is linked in the 'regl' list,
2058  * and never deleted (other than at 'sip reload' or module unload times).
2059  * The entry always has a pending timeout, either waiting for an ACK to
2060  * the REGISTER message (in which case we have to retransmit the request),
2061  * or waiting for the next REGISTER message to be sent (either the initial one,
2062  * or once the previously completed registration one expires).
2063  * The registration can be in one of many states, though at the moment
2064  * the handling is a bit mixed.
2065  *
2066  * XXX \todo Reference count handling for this object has some problems with
2067  * respect to scheduler entries.  The ref count is handled in some places,
2068  * but not all of them.  There are some places where references get leaked
2069  * when this scheduler entry gets cancelled.  At worst, this would cause
2070  * memory leaks on reloads if registrations get removed from configuration.
2071  */
2072 struct sip_registry {
2073         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
2074         AST_DECLARE_STRING_FIELDS(
2075                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
2076                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
2077                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
2078                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
2079                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
2080                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
2081                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
2082                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
2083                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
2084                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
2085                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
2086                 AST_STRING_FIELD(callback);     /*!< Contact extension */
2087                 AST_STRING_FIELD(random);
2088         );
2089         enum sip_transport transport;   /*!< Transport for this registration UDP, TCP or TLS */
2090         int portno;                     /*!<  Optional port override */
2091         int expire;                     /*!< Sched ID of expiration */
2092         int expiry;                     /*!< Value to use for the Expires header */
2093         int regattempts;                /*!< Number of attempts (since the last success) */
2094         int timeout;                    /*!< sched id of sip_reg_timeout */
2095         int refresh;                    /*!< How often to refresh */
2096         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
2097         enum sipregistrystate regstate; /*!< Registration state (see above) */
2098         struct timeval regtime;         /*!< Last successful registration time */
2099         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
2100         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
2101         struct ast_dnsmgr_entry *dnsmgr;        /*!<  DNS refresh manager for register */
2102         struct sockaddr_in us;          /*!< Who the server thinks we are */
2103         int noncecount;                 /*!< Nonce-count */
2104         char lastmsg[256];              /*!< Last Message sent/received */
2105 };
2106
2107 /*! \brief Definition of a thread that handles a socket */
2108 struct sip_threadinfo {
2109         int stop;
2110         pthread_t threadid;
2111         struct ast_tcptls_session_instance *tcptls_session;
2112         enum sip_transport type;        /*!< We keep a copy of the type here so we can display it in the connection list */
2113         AST_LIST_ENTRY(sip_threadinfo) list;
2114 };
2115
2116 /*! \brief Definition of an MWI subscription to another server */
2117 struct sip_subscription_mwi {
2118         ASTOBJ_COMPONENTS_FULL(struct sip_subscription_mwi,1,1);
2119         AST_DECLARE_STRING_FIELDS(
2120                 AST_STRING_FIELD(username);     /*!< Who we are sending the subscription as */
2121                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
2122                 AST_STRING_FIELD(hostname);     /*!< Domain or host we subscribe to */
2123                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
2124                 AST_STRING_FIELD(mailbox);      /*!< Mailbox store to put MWI into */
2125                 );
2126         enum sip_transport transport;    /*!< Transport to use */
2127         int portno;                      /*!< Optional port override */
2128         int resub;                       /*!< Sched ID of resubscription */
2129         unsigned int subscribed:1;       /*!< Whether we are currently subscribed or not */
2130         struct sip_pvt *call;            /*!< Outbound subscription dialog */
2131         struct ast_dnsmgr_entry *dnsmgr; /*!< DNS refresh manager for subscription */
2132         struct sockaddr_in us;           /*!< Who the server thinks we are */
2133 };
2134
2135 /* --- Hash tables of various objects --------*/
2136
2137 #ifdef LOW_MEMORY
2138 static int hash_peer_size = 17;
2139 static int hash_dialog_size = 17;
2140 static int hash_user_size = 17;
2141 #else
2142 static int hash_peer_size = 563;        /*!< Size of peer hash table, prime number preferred! */
2143 static int hash_dialog_size = 563;
2144 static int hash_user_size = 563;
2145 #endif
2146
2147 /*! \brief  The thread list of TCP threads */
2148 static AST_LIST_HEAD_STATIC(threadl, sip_threadinfo);
2149
2150 /*! \brief  The peer list: Users, Peers and Friends */
2151 static struct ao2_container *peers;
2152 static struct ao2_container *peers_by_ip;
2153
2154 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
2155 static struct ast_register_list {
2156         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
2157         int recheck;
2158 } regl;
2159
2160 /*! \brief  The MWI subscription list */
2161 static struct ast_subscription_mwi_list {
2162         ASTOBJ_CONTAINER_COMPONENTS(struct sip_subscription_mwi);
2163 } submwil;
2164
2165 /*! \brief
2166  * \note The only member of the peer used here is the name field
2167  */
2168 static int peer_hash_cb(const void *obj, const int flags)
2169 {
2170         const struct sip_peer *peer = obj;
2171
2172         return ast_str_case_hash(peer->name);
2173 }
2174
2175 /*!
2176  * \note The only member of the peer used here is the name field
2177  */
2178 static int peer_cmp_cb(void *obj, void *arg, int flags)
2179 {
2180         struct sip_peer *peer = obj, *peer2 = arg;
2181
2182         return !strcasecmp(peer->name, peer2->name) ? CMP_MATCH | CMP_STOP : 0;
2183 }
2184
2185 /*!
2186  * \note the peer's addr struct provides to fields combined to make a key: the sin_addr.s_addr and sin_port fields.
2187  */
2188 static int peer_iphash_cb(const void *obj, const int flags)
2189 {
2190         const struct sip_peer *peer = obj;
2191         int ret1 = peer->addr.sin_addr.s_addr;
2192         if (ret1 < 0)
2193                 ret1 = -ret1;
2194         
2195         if (ast_test_flag(&peer->flags[0], SIP_INSECURE_PORT)) {
2196                 return ret1;
2197         } else {
2198                 return ret1 + peer->addr.sin_port;
2199         }
2200 }
2201
2202 /*!
2203  * \note the peer's addr struct provides to fields combined to make a key: the sin_addr.s_addr and sin_port fields.
2204  */
2205 static int peer_ipcmp_cb(void *obj, void *arg, int flags)
2206 {
2207         struct sip_peer *peer = obj, *peer2 = arg;
2208
2209         if (peer->addr.sin_addr.s_addr != peer2->addr.sin_addr.s_addr)
2210                 return 0;
2211         
2212         if (!ast_test_flag(&peer->flags[0], SIP_INSECURE_PORT) && !ast_test_flag(&peer2->flags[0], SIP_INSECURE_PORT)) {
2213                 if (peer->addr.sin_port == peer2->addr.sin_port)
2214                         return CMP_MATCH | CMP_STOP;
2215                 else
2216                         return 0;
2217         }
2218         return CMP_MATCH | CMP_STOP;
2219 }
2220
2221 /*!
2222  * \note The only member of the dialog used here callid string
2223  */
2224 static int dialog_hash_cb(const void *obj, const int flags)
2225 {
2226         const struct sip_pvt *pvt = obj;
2227
2228         return ast_str_case_hash(pvt->callid);
2229 }
2230
2231 /*!
2232  * \note The only member of the dialog used here callid string
2233  */
2234 static int dialog_cmp_cb(void *obj, void *arg, int flags)
2235 {
2236         struct sip_pvt *pvt = obj, *pvt2 = arg;
2237         
2238         return !strcasecmp(pvt->callid, pvt2->callid) ? CMP_MATCH | CMP_STOP : 0;
2239 }
2240
2241 static int temp_pvt_init(void *);
2242 static void temp_pvt_cleanup(void *);
2243
2244 /*! \brief A per-thread temporary pvt structure */
2245 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
2246
2247 #ifdef LOW_MEMORY
2248 static void ts_ast_rtp_destroy(void *);
2249
2250 AST_THREADSTORAGE_CUSTOM(ts_audio_rtp, NULL, ts_ast_rtp_destroy);
2251 AST_THREADSTORAGE_CUSTOM(ts_video_rtp, NULL, ts_ast_rtp_destroy);
2252 AST_THREADSTORAGE_CUSTOM(ts_text_rtp, NULL, ts_ast_rtp_destroy);
2253 #endif
2254
2255 /*! \brief Authentication list for realm authentication 
2256  * \todo Move the sip_auth list to AST_LIST */
2257 static struct sip_auth *authl = NULL;
2258
2259
2260 /* --- Sockets and networking --------------*/
2261
2262 /*! \brief Main socket for UDP SIP communication.
2263  *
2264  * sipsock is shared between the SIP manager thread (which handles reload
2265  * requests), the udp io handler (sipsock_read()) and the user routines that
2266  * issue udp writes (using __sip_xmit()).
2267  * The socket is -1 only when opening fails (this is a permanent condition),
2268  * or when we are handling a reload() that changes its address (this is
2269  * a transient situation during which we might have a harmless race, see
2270  * below). Because the conditions for the race to be possible are extremely
2271  * rare, we don't want to pay the cost of locking on every I/O.
2272  * Rather, we remember that when the race may occur, communication is
2273  * bound to fail anyways, so we just live with this event and let
2274  * the protocol handle this above us.
2275  */
2276 static int sipsock  = -1;
2277
2278 static struct sockaddr_in bindaddr;     /*!< UDP: The address we bind to */
2279
2280 /*! \brief our (internal) default address/port to put in SIP/SDP messages
2281  *  internip is initialized picking a suitable address from one of the
2282  * interfaces, and the same port number we bind to. It is used as the
2283  * default address/port in SIP messages, and as the default address
2284  * (but not port) in SDP messages.
2285  */
2286 static struct sockaddr_in internip;
2287
2288 /*! \brief our external IP address/port for SIP sessions.
2289  * externip.sin_addr is only set when we know we might be behind
2290  * a NAT, and this is done using a variety of (mutually exclusive)
2291  * ways from the config file:
2292  *
2293  * + with "externip = host[:port]" we specify the address/port explicitly.
2294  *   The address is looked up only once when (re)loading the config file;
2295  * 
2296  * + with "externhost = host[:port]" we do a similar thing, but the
2297  *   hostname is stored in externhost, and the hostname->IP mapping
2298  *   is refreshed every 'externrefresh' seconds;
2299  * 
2300  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
2301  *   to the specified server, and store the result in externip.
2302  *
2303  * Other variables (externhost, externexpire, externrefresh) are used
2304  * to support the above functions.
2305  */
2306 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
2307
2308 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
2309 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
2310 static int externrefresh = 10;
2311 static struct sockaddr_in stunaddr;             /*!< stun server address */
2312
2313 /*! \brief  List of local networks
2314  * We store "localnet" addresses from the config file into an access list,
2315  * marked as 'DENY', so the call to ast_apply_ha() will return
2316  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
2317  * (i.e. presumably public) addresses.
2318  */
2319 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
2320
2321 static int ourport_tcp;                         /*!< The port used for TCP connections */
2322 static int ourport_tls;                         /*!< The port used for TCP/TLS connections */
2323 static struct sockaddr_in debugaddr;
2324
2325 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
2326
2327 /*! some list management macros. */
2328  
2329 #define UNLINK(element, head, prev) do {        \
2330         if (prev)                               \
2331                 (prev)->next = (element)->next; \
2332         else                                    \
2333                 (head) = (element)->next;       \
2334         } while (0)
2335
2336 enum t38_action_flag {
2337         SDP_T38_NONE = 0, /*!< Do not modify T38 information at all */
2338         SDP_T38_INITIATE, /*!< Remote side has requested T38 with us */
2339         SDP_T38_ACCEPT,   /*!< Remote side accepted our T38 request */
2340 };
2341
2342 /*---------------------------- Forward declarations of functions in chan_sip.c */
2343 /* Note: This is added to help splitting up chan_sip.c into several files
2344         in coming releases. */
2345
2346 /*--- PBX interface functions */
2347 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
2348 static int sip_devicestate(void *data);
2349 static int sip_sendtext(struct ast_channel *ast, const char *text);
2350 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
2351 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
2352 static int sip_hangup(struct ast_channel *ast);
2353 static int sip_answer(struct ast_channel *ast);
2354 static struct ast_frame *sip_read(struct ast_channel *ast);
2355 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
2356 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
2357 static int sip_transfer(struct ast_channel *ast, const char *dest);
2358 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
2359 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
2360 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
2361 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
2362 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
2363 static const char *sip_get_callid(struct ast_channel *chan);
2364
2365 static int handle_request_do(struct sip_request *req, struct sockaddr_in *sin);
2366 static int sip_standard_port(enum sip_transport type, int port);
2367 static int sip_prepare_socket(struct sip_pvt *p);
2368 static int sip_parse_host(char *line, int lineno, char **hostname, int *portnum, enum sip_transport *transport);
2369
2370 /*--- Transmitting responses and requests */
2371 static int sipsock_read(int *id, int fd, short events, void *ignore);
2372 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len);
2373 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod);
2374 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
2375 static int retrans_pkt(const void *data);
2376 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);
2377 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2378 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2379 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2380 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);
2381 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
2382 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);
2383 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
2384 static void transmit_fake_auth_response(struct sip_pvt *p, int sipmethod, struct sip_request *req, enum xmittype reliable);
2385 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
2386 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
2387 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
2388 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
2389 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
2390 static int transmit_info_with_vidupdate(struct sip_pvt *p);
2391 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
2392 static int transmit_refer(struct sip_pvt *p, const char *dest);
2393 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
2394 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
2395 static int transmit_notify_custom(struct sip_pvt *p, struct ast_variable *vars);
2396 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
2397 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
2398 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
2399 static void copy_request(struct sip_request *dst, const struct sip_request *src);
2400 static void receive_message(struct sip_pvt *p, struct sip_request *req);
2401 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
2402 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
2403
2404 /*--- Dialog management */
2405 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
2406                                  int useglobal_nat, const int intended_method);
2407 static int __sip_autodestruct(const void *data);
2408 static void sip_scheddestroy(struct sip_pvt *p, int ms);
2409 static int sip_cancel_destroy(struct sip_pvt *p);
2410 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
2411 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist);
2412 static void *registry_unref(struct sip_registry *reg, char *tag);
2413 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
2414 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
2415 static void __sip_pretend_ack(struct sip_pvt *p);
2416 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
2417 static int auto_congest(const void *arg);
2418 static int update_call_counter(struct sip_pvt *fup, int event);
2419 static int hangup_sip2cause(int cause);
2420 static const char *hangup_cause2sip(int cause);
2421 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
2422 static void free_old_route(struct sip_route *route);
2423 static void list_route(struct sip_route *route);
2424 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
2425 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
2426                                               struct sip_request *req, const char *uri);
2427 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
2428 static void check_pendings(struct sip_pvt *p);
2429 static void *sip_park_thread(void *stuff);
2430 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
2431 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
2432
2433 /*--- Codec handling / SDP */
2434 static void try_suggested_sip_codec(struct sip_pvt *p);
2435 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
2436 static const char *get_sdp(struct sip_request *req, const char *name);
2437 static int find_sdp(struct sip_request *req);
2438 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
2439 static void add_codec_to_sdp(const struct sip_pvt *p, int codec,
2440                              struct ast_str **m_buf, struct ast_str **a_buf,
2441                              int debug, int *min_packet_size);
2442 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
2443                                 struct ast_str **m_buf, struct ast_str **a_buf,
2444                                 int debug);
2445 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
2446 static void do_setnat(struct sip_pvt *p, int natflags);
2447 static void stop_media_flows(struct sip_pvt *p);
2448
2449 /*--- Authentication stuff */
2450 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
2451 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
2452 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
2453                                          const char *secret, const char *md5secret, int sipmethod,
2454                                          const char *uri, enum xmittype reliable, int ignore);
2455 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
2456                                               int sipmethod, const char *uri, enum xmittype reliable,
2457                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
2458 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct sockaddr_in *sin);
2459
2460 /*--- Domain handling */
2461 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
2462 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
2463 static void clear_sip_domains(void);
2464
2465 /*--- SIP realm authentication */
2466 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
2467 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
2468 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
2469
2470 /*--- Misc functions */
2471 static void check_rtp_timeout(struct sip_pvt *dialog, time_t t);
2472 static int sip_do_reload(enum channelreloadreason reason);
2473 static int reload_config(enum channelreloadreason reason);
2474 static int expire_register(const void *data);
2475 static void *do_monitor(void *data);
2476 static int restart_monitor(void);
2477 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
2478 static struct ast_variable *copy_vars(struct ast_variable *src);
2479 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
2480 static int sip_refer_allocate(struct sip_pvt *p);
2481 static void ast_quiet_chan(struct ast_channel *chan);
2482 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
2483 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
2484
2485 /*!
2486  * \brief generic function for determining if a correct transport is being 
2487  * used to contact a peer
2488  *
2489  * this is done as a macro so that the "tmpl" var can be passed either a 
2490  * sip_request or a sip_peer 
2491  */
2492 #define check_request_transport(peer, tmpl) ({ \
2493         int ret = 0; \
2494         if (peer->socket.type == tmpl->socket.type) \
2495                 ; \
2496         else if (!(peer->transports & tmpl->socket.type)) {\
2497                 ast_log(LOG_ERROR, \
2498                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
2499                         get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
2500                         ); \
2501                 ret = 1; \
2502         } else if (peer->socket.type & SIP_TRANSPORT_TLS) { \
2503                 ast_log(LOG_WARNING, \
2504                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
2505                         peer->name, get_transport(tmpl->socket.type) \
2506                 ); \
2507         } else { \
2508                 ast_debug(1, \
2509                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
2510                         peer->name, get_transport(tmpl->socket.type), get_transport(peer->socket.type) \
2511                 ); \
2512         }\
2513         (ret); \
2514 })
2515
2516
2517 /*--- Device monitoring and Device/extension state/event handling */
2518 static int cb_extensionstate(char *context, char* exten, int state, void *data);
2519 static int sip_devicestate(void *data);
2520 static int sip_poke_noanswer(const void *data);
2521 static int sip_poke_peer(struct sip_peer *peer, int force);
2522 static void sip_poke_all_peers(void);
2523 static void sip_peer_hold(struct sip_pvt *p, int hold);
2524 static void mwi_event_cb(const struct ast_event *, void *);
2525
2526 /*--- Applications, functions, CLI and manager command helpers */
2527 static const char *sip_nat_mode(const struct sip_pvt *p);
2528 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2529 static char *transfermode2str(enum transfermodes mode) attribute_const;
2530 static const char *nat2str(int nat) attribute_const;
2531 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
2532 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2533 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2534 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2535 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2536 static void  print_group(int fd, ast_group_t group, int crlf);
2537 static const char *dtmfmode2str(int mode) attribute_const;
2538 static int str2dtmfmode(const char *str) attribute_unused;
2539 static const char *insecure2str(int mode) attribute_const;
2540 static void cleanup_stale_contexts(char *new, char *old);
2541 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
2542 static const char *domain_mode_to_text(const enum domain_mode mode);
2543 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2544 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2545 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2546 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2547 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2548 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2549 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2550 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2551 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2552 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
2553 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
2554 static char *complete_sip_peer(const char *word, int state, int flags2);
2555 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
2556 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
2557 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
2558 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
2559 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
2560 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2561 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2562 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2563 static char *sip_do_debug_ip(int fd, const char *arg);
2564 static char *sip_do_debug_peer(int fd, const char *arg);
2565 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2566 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2567 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2568 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
2569 static int sip_addheader(struct ast_channel *chan, const char *data);
2570 static int sip_do_reload(enum channelreloadreason reason);
2571 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2572 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
2573
2574 /*--- Debugging 
2575         Functions for enabling debug per IP or fully, or enabling history logging for
2576         a SIP dialog
2577 */
2578 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
2579 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
2580 static inline int sip_debug_test_pvt(struct sip_pvt *p);
2581
2582
2583 /*! \brief Append to SIP dialog history 
2584         \return Always returns 0 */
2585 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
2586 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
2587 static void sip_dump_history(struct sip_pvt *dialog);
2588
2589 /*--- Device object handling */
2590 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
2591 static int update_call_counter(struct sip_pvt *fup, int event);
2592 static void sip_destroy_peer(struct sip_peer *peer);
2593 static void sip_destroy_peer_fn(void *peer);
2594 static void set_peer_defaults(struct sip_peer *peer);
2595 static struct sip_peer *temp_peer(const char *name);
2596 static void register_peer_exten(struct sip_peer *peer, int onoff);
2597 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime, int forcenamematch, int devstate_only);
2598 static int sip_poke_peer_s(const void *data);
2599 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
2600 static void reg_source_db(struct sip_peer *peer);
2601 static void destroy_association(struct sip_peer *peer);
2602 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
2603 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
2604
2605 /* Realtime device support */
2606 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, const char *useragent, int expirey, int deprecated_username, int lastms);
2607 static void update_peer(struct sip_peer *p, int expire);
2608 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
2609 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
2610 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin, int devstate_only);
2611 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2612
2613 /*--- Internal UA client handling (outbound registrations) */
2614 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us);
2615 static void sip_registry_destroy(struct sip_registry *reg);
2616 static int sip_register(const char *value, int lineno);
2617 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
2618 static int sip_reregister(const void *data);
2619 static int __sip_do_register(struct sip_registry *r);
2620 static int sip_reg_timeout(const void *data);
2621 static void sip_send_all_registers(void);
2622 static int sip_reinvite_retry(const void *data);
2623
2624 /*--- Parsing SIP requests and responses */
2625 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
2626 static int determine_firstline_parts(struct sip_request *req);
2627 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
2628 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
2629 static int find_sip_method(const char *msg);
2630 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
2631 static unsigned int parse_allowed_methods(struct sip_request *req);
2632 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
2633 static int parse_request(struct sip_request *req);
2634 static const char *get_header(const struct sip_request *req, const char *name);
2635 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
2636 static int method_match(enum sipmethod id, const char *name);
2637 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
2638 static char *get_in_brackets(char *tmp);
2639 static const char *find_alias(const char *name, const char *_default);
2640 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
2641 static int lws2sws(char *msgbuf, int len);
2642 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
2643 static char *remove_uri_parameters(char *uri);
2644 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
2645 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
2646 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
2647 static int set_address_from_contact(struct sip_pvt *pvt);
2648 static void check_via(struct sip_pvt *p, struct sip_request *req);
2649 static char *get_calleridname(const char *input, char *output, size_t outputsize);
2650 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
2651 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason);
2652 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
2653 static int get_msg_text(char *buf, int len, struct sip_request *req, int addnewline);
2654 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
2655 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
2656 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
2657 static void change_redirecting_information(struct sip_pvt *p, struct sip_request *req, struct ast_party_redirecting *redirecting, int set_call_forward);
2658
2659 /*-- TCP connection handling ---*/
2660 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session);
2661 static void *sip_tcp_worker_fn(void *);
2662
2663 /*--- Constructing requests and responses */
2664 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
2665 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
2666 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
2667 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
2668 static int init_resp(struct sip_request *resp, const char *msg);
2669 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
2670 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
2671 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
2672 static void build_via(struct sip_pvt *p);
2673 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
2674 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct sockaddr_in *sin, int newdialog);
2675 static char *generate_random_string(char *buf, size_t size);
2676 static void build_callid_pvt(struct sip_pvt *pvt);
2677 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
2678 static void make_our_tag(char *tagbuf, size_t len);
2679 static int add_header(struct sip_request *req, const char *var, const char *value);
2680 static int add_header_contentLength(struct sip_request *req, int len);
2681 static int add_line(struct sip_request *req, const char *line);
2682 static int add_text(struct sip_request *req, const char *text);
2683 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
2684 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
2685 static int add_vidupdate(struct sip_request *req);
2686 static void add_route(struct sip_request *req, struct sip_route *route);
2687 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
2688 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
2689 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
2690 static void set_destination(struct sip_pvt *p, char *uri);
2691 static void append_date(struct sip_request *req);
2692 static void build_contact(struct sip_pvt *p);
2693
2694 /*------Request handling functions */
2695 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
2696 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
2697 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);
2698 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
2699 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
2700 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, const char *e);
2701 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
2702 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
2703 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
2704 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
2705 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
2706 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin);
2707 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
2708 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
2709
2710 /*------Response handling functions */
2711 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2712 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2713 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2714 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2715 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2716 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2717
2718 /*------ T38 Support --------- */
2719 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
2720 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
2721 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
2722 static void change_t38_state(struct sip_pvt *p, int state);
2723
2724 /*------ Session-Timers functions --------- */
2725 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
2726 static int  proc_session_timer(const void *vp);
2727 static void stop_session_timer(struct sip_pvt *p);
2728 static void start_session_timer(struct sip_pvt *p);
2729 static void restart_session_timer(struct sip_pvt *p);
2730 static const char *strefresher2str(enum st_refresher r);
2731 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
2732 static int parse_minse(const char *p_hdrval, int *const p_interval);
2733 static int st_get_se(struct sip_pvt *, int max);
2734 static enum st_refresher st_get_refresher(struct sip_pvt *);
2735 static enum st_mode st_get_mode(struct sip_pvt *);
2736 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
2737
2738 /*------- RTP Glue functions -------- */
2739 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, int codecs, int nat_active);
2740
2741 /*!--- SIP MWI Subscription support */
2742 static int sip_subscribe_mwi(const char *value, int lineno);
2743 static void sip_subscribe_mwi_destroy(struct sip_subscription_mwi *mwi);
2744 static void sip_send_all_mwi_subscriptions(void);
2745 static int sip_subscribe_mwi_do(const void *data);
2746 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
2747
2748 /*! \brief Definition of this channel for PBX channel registration */
2749 static const struct ast_channel_tech sip_tech = {
2750         .type = "SIP",
2751         .description = "Session Initiation Protocol (SIP)",
2752         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
2753         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
2754         .requester = sip_request_call,                  /* called with chan unlocked */
2755         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
2756         .call = sip_call,                       /* called with chan locked */
2757         .send_html = sip_sendhtml,
2758         .hangup = sip_hangup,                   /* called with chan locked */
2759         .answer = sip_answer,                   /* called with chan locked */
2760         .read = sip_read,                       /* called with chan locked */
2761         .write = sip_write,                     /* called with chan locked */
2762         .write_video = sip_write,               /* called with chan locked */
2763         .write_text = sip_write,
2764         .indicate = sip_indicate,               /* called with chan locked */
2765         .transfer = sip_transfer,               /* called with chan locked */
2766         .fixup = sip_fixup,                     /* called with chan locked */
2767         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
2768         .send_digit_end = sip_senddigit_end,
2769         .bridge = ast_rtp_instance_bridge,                      /* XXX chan unlocked ? */
2770         .early_bridge = ast_rtp_instance_early_bridge,
2771         .send_text = sip_sendtext,              /* called with chan locked */
2772         .func_channel_read = acf_channel_read,
2773         .setoption = sip_setoption,
2774         .queryoption = sip_queryoption,
2775         .get_pvt_uniqueid = sip_get_callid,
2776 };
2777
2778 /*! \brief This version of the sip channel tech has no send_digit_begin
2779  * callback so that the core knows that the channel does not want
2780  * DTMF BEGIN frames.
2781  * The struct is initialized just before registering the channel driver,
2782  * and is for use with channels using SIP INFO DTMF.
2783  */
2784 static struct ast_channel_tech sip_tech_info;
2785
2786
2787 /*! \brief Working TLS connection configuration */
2788 static struct ast_tls_config sip_tls_cfg;
2789
2790 /*! \brief Default TLS connection configuration */
2791 static struct ast_tls_config default_tls_cfg;
2792
2793 /*! \brief The TCP server definition */
2794 static struct ast_tcptls_session_args sip_tcp_desc = {
2795         .accept_fd = -1,
2796         .master = AST_PTHREADT_NULL,
2797         .tls_cfg = NULL,
2798         .poll_timeout = -1,
2799         .name = "SIP TCP server",
2800         .accept_fn = ast_tcptls_server_root,
2801         .worker_fn = sip_tcp_worker_fn,
2802 };
2803
2804 /*! \brief The TCP/TLS server definition */
2805 static struct ast_tcptls_session_args sip_tls_desc = {
2806         .accept_fd = -1,
2807         .master = AST_PTHREADT_NULL,
2808         .tls_cfg = &sip_tls_cfg,
2809         .poll_timeout = -1,
2810         .name = "SIP TLS server",
2811         .accept_fn = ast_tcptls_server_root,
2812         .worker_fn = sip_tcp_worker_fn,
2813 };
2814
2815 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
2816 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
2817
2818 /*! \brief map from an integer value to a string.
2819  * If no match is found, return errorstring
2820  */
2821 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2822 {
2823         const struct _map_x_s *cur;
2824
2825         for (cur = table; cur->s; cur++)
2826                 if (cur->x == x)
2827                         return cur->s;
2828         return errorstring;
2829 }
2830
2831 /*! \brief map from a string to an integer value, case insensitive.
2832  * If no match is found, return errorvalue.
2833  */
2834 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2835 {
2836         const struct _map_x_s *cur;
2837
2838         for (cur = table; cur->s; cur++)
2839                 if (!strcasecmp(cur->s, s))
2840                         return cur->x;
2841         return errorvalue;
2842 }
2843
2844 /*!
2845  * duplicate a list of channel variables, \return the copy.
2846  */
2847 static struct ast_variable *copy_vars(struct ast_variable *src)
2848 {
2849         struct ast_variable *res = NULL, *tmp, *v = NULL;
2850
2851         for (v = src ; v ; v = v->next) {
2852                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
2853                         tmp->next = res;
2854                         res = tmp;
2855                 }
2856         }
2857         return res;
2858 }
2859
2860 /*! \brief SIP TCP connection handler */
2861 static void *sip_tcp_worker_fn(void *data)
2862 {
2863         struct ast_tcptls_session_instance *tcptls_session = data;
2864
2865         return _sip_tcp_helper_thread(NULL, tcptls_session);
2866 }
2867
2868 /*! \brief SIP TCP thread management function 
2869         This function reads from the socket, parses the packet into a request
2870 */
2871 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session) 
2872 {
2873         int res, cl;
2874         struct sip_request req = { 0, } , reqcpy = { 0, };
2875         struct sip_threadinfo *me;
2876         char buf[1024] = "";
2877
2878         me = ast_calloc(1, sizeof(*me));
2879
2880         if (!me)
2881                 goto cleanup2;
2882
2883         me->threadid = pthread_self();
2884         me->tcptls_session = tcptls_session;
2885         if (tcptls_session->ssl)
2886                 me->type = SIP_TRANSPORT_TLS;
2887         else
2888                 me->type = SIP_TRANSPORT_TCP;
2889
2890         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2891
2892         AST_LIST_LOCK(&threadl);
2893         AST_LIST_INSERT_TAIL(&threadl, me, list);
2894         AST_LIST_UNLOCK(&threadl);
2895
2896         if (!(req.data = ast_str_create(SIP_MIN_PACKET)))
2897                 goto cleanup;
2898         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET)))
2899                 goto cleanup;
2900
2901         for (;;) {
2902                 struct ast_str *str_save;
2903
2904                 str_save = req.data;
2905                 memset(&req, 0, sizeof(req));
2906                 req.data = str_save;
2907                 ast_str_reset(req.data);
2908
2909                 str_save = reqcpy.data;
2910                 memset(&reqcpy, 0, sizeof(reqcpy));
2911                 reqcpy.data = str_save;
2912                 ast_str_reset(reqcpy.data);
2913
2914                 req.socket.fd = tcptls_session->fd;
2915                 if (tcptls_session->ssl) {
2916                         req.socket.type = SIP_TRANSPORT_TLS;
2917                         req.socket.port = htons(ourport_tls);
2918                 } else {
2919                         req.socket.type = SIP_TRANSPORT_TCP;
2920                         req.socket.port = htons(ourport_tcp);
2921                 }
2922                 res = ast_wait_for_input(tcptls_session->fd, -1);
2923                 if (res < 0) {
2924                         ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", tcptls_session->ssl ? "SSL": "TCP", res);
2925                         goto cleanup;
2926                 }
2927
2928                 /* Read in headers one line at a time */
2929                 while (req.len < 4 || strncmp(REQ_OFFSET_TO_STR(&req, len - 4), "\r\n\r\n", 4)) {
2930                         ast_mutex_lock(&tcptls_session->lock);
2931                         if (!fgets(buf, sizeof(buf), tcptls_session->f)) {
2932                                 ast_mutex_unlock(&tcptls_session->lock);
2933                                 goto cleanup;
2934                         }
2935                         ast_mutex_unlock(&tcptls_session->lock);
2936                         if (me->stop) 
2937                                  goto cleanup;
2938                         ast_str_append(&req.data, 0, "%s", buf);
2939                         req.len = req.data->used;
2940                 }
2941                 copy_request(&reqcpy, &req);
2942                 parse_request(&reqcpy);
2943                 /* In order to know how much to read, we need the content-length header */
2944                 if (sscanf(get_header(&reqcpy, "Content-Length"), "%d", &cl)) {
2945                         while (cl > 0) {
2946                                 ast_mutex_lock(&tcptls_session->lock);
2947                                 if (!fread(buf, (cl < sizeof(buf)) ? cl : sizeof(buf), 1, tcptls_session->f)) {
2948                                         ast_mutex_unlock(&tcptls_session->lock);
2949                                         goto cleanup;
2950                                 }
2951                                 ast_mutex_unlock(&tcptls_session->lock);
2952                                 if (me->stop)
2953                                         goto cleanup;
2954                                 cl -= strlen(buf);
2955                                 ast_str_append(&req.data, 0, "%s", buf);
2956                                 req.len = req.data->used;
2957                         }
2958                 }
2959                 /*! \todo XXX If there's no Content-Length or if the content-length and what
2960                                 we receive is not the same - we should generate an error */
2961
2962                 req.socket.tcptls_session = tcptls_session;
2963                 handle_request_do(&req, &tcptls_session->remote_address);
2964         }
2965
2966 cleanup:
2967         AST_LIST_LOCK(&threadl);
2968         AST_LIST_REMOVE(&threadl, me, list);
2969         AST_LIST_UNLOCK(&threadl);
2970         ast_free(me);
2971 cleanup2:
2972         fclose(tcptls_session->f);
2973         tcptls_session->f = NULL;
2974         tcptls_session->fd = -1;
2975         if (reqcpy.data) {
2976                 ast_free(reqcpy.data);
2977         }
2978
2979         if (req.data) {
2980                 ast_free(req.data);
2981                 req.data = NULL;
2982         }
2983
2984         ast_debug(2, "Shutting down thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2985         
2986
2987         ao2_ref(tcptls_session, -1);
2988         tcptls_session = NULL;
2989
2990         return NULL;
2991 }
2992
2993
2994 /*!
2995  * helper functions to unreference various types of objects.
2996  * By handling them this way, we don't have to declare the
2997  * destructor on each call, which removes the chance of errors.
2998  */
2999 static void *unref_peer(struct sip_peer *peer, char *tag)
3000 {
3001         ao2_t_ref(peer, -1, tag);
3002         return NULL;
3003 }
3004
3005 static struct sip_peer *ref_peer(struct sip_peer *peer, char *tag)
3006 {
3007         ao2_t_ref(peer, 1, tag);
3008         return peer;
3009 }
3010
3011 /*! \brief maintain proper refcounts for a sip_pvt's outboundproxy
3012  *
3013  * This function sets pvt's outboundproxy pointer to the one referenced
3014  * by the proxy parameter. Because proxy may be a refcounted object, and
3015  * because pvt's old outboundproxy may also be a refcounted object, we need
3016  * to maintain the proper refcounts.
3017  *
3018  * \param pvt The sip_pvt for which we wish to set the outboundproxy
3019  * \param proxy The sip_proxy which we will point pvt towards.
3020  * \return Returns void
3021  */
3022 static void ref_proxy(struct sip_pvt *pvt, struct sip_proxy *proxy)
3023 {
3024         struct sip_proxy *old_obproxy = pvt->outboundproxy;
3025         /* The sip_cfg.outboundproxy is statically allocated, and so
3026          * we don't ever need to adjust refcounts for it
3027          */
3028         if (proxy && proxy != &sip_cfg.outboundproxy) {
3029                 ao2_ref(proxy, +1);
3030         }
3031         pvt->outboundproxy = proxy;
3032         if (old_obproxy && old_obproxy != &sip_cfg.outboundproxy) {
3033                 ao2_ref(old_obproxy, -1);
3034         }
3035 }
3036
3037 /*!
3038  * \brief Unlink a dialog from the dialogs container, as well as any other places
3039  * that it may be currently stored.
3040  *
3041  * \note A reference to the dialog must be held before calling this function, and this
3042  * function does not release that reference.
3043  */
3044 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist)
3045 {
3046         struct sip_pkt *cp;
3047
3048         dialog_ref(dialog, "Let's bump the count in the unlink so it doesn't accidentally become dead before we are done");
3049
3050         ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
3051
3052         /* Unlink us from the owner (channel) if we have one */
3053         if (dialog->owner) {
3054                 if (lockowner)
3055                         ast_channel_lock(dialog->owner);
3056                 ast_debug(1, "Detaching from channel %s\n", dialog->owner->name);
3057                 dialog->owner->tech_pvt = dialog_unref(dialog->owner->tech_pvt, "resetting channel dialog ptr in unlink_all");
3058                 if (lockowner)
3059                         ast_channel_unlock(dialog->owner);
3060         }
3061         if (dialog->registry) {
3062                 if (dialog->registry->call == dialog)
3063                         dialog->registry->call = dialog_unref(dialog->registry->call, "nulling out the registry's call dialog field in unlink_all");
3064                 dialog->registry = registry_unref(dialog->registry, "delete dialog->registry");
3065         }
3066         if (dialog->stateid > -1) {
3067                 ast_extension_state_del(dialog->stateid, NULL);
3068                 dialog_unref(dialog, "removing extension_state, should unref the associated dialog ptr that was stored there.");
3069                 dialog->stateid = -1; /* shouldn't we 'zero' this out? */
3070         }
3071         /* Remove link from peer to subscription of MWI */
3072         if (dialog->relatedpeer && dialog->relatedpeer->mwipvt == dialog)
3073                 dialog->relatedpeer->mwipvt = dialog_unref(dialog->relatedpeer->mwipvt, "delete ->relatedpeer->mwipvt");
3074         if (dialog->relatedpeer && dialog->relatedpeer->call == dialog)
3075                 dialog->relatedpeer->call = dialog_unref(dialog->relatedpeer->call, "unset the relatedpeer->call field in tandem with relatedpeer field itself");
3076
3077         /* remove all current packets in this dialog */
3078         while((cp = dialog->packets)) {
3079                 dialog->packets = dialog->packets->next;
3080                 AST_SCHED_DEL(sched, cp->retransid);
3081                 dialog_unref(cp->owner, "remove all current packets in this dialog, and the pointer to the dialog too as part of __sip_destroy");
3082                 if (cp->data) {
3083                         ast_free(cp->data);
3084                 }
3085                 ast_free(cp);
3086         }
3087
3088         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"));
3089
3090         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"));
3091         
3092         if (dialog->autokillid > -1)
3093                 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"));
3094
3095         if (dialog->request_queue_sched_id > -1) {
3096                 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"));
3097         }
3098
3099         if (dialog->t38id > -1) {
3100                 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"));
3101         }
3102
3103         dialog_unref(dialog, "Let's unbump the count in the unlink so the poor pvt can disappear if it is time");
3104         return NULL;
3105 }
3106
3107 static void *registry_unref(struct sip_registry *reg, char *tag)
3108 {
3109         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
3110         ASTOBJ_UNREF(reg, sip_registry_destroy);
3111         return NULL;
3112 }
3113
3114 /*! \brief Add object reference to SIP registry */
3115 static struct sip_registry *registry_addref(struct sip_registry *reg, char *tag)
3116 {
3117         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
3118         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
3119 }
3120
3121 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
3122 static struct ast_udptl_protocol sip_udptl = {
3123         type: "SIP",
3124         get_udptl_info: sip_get_udptl_peer,
3125         set_udptl_peer: sip_set_udptl_peer,
3126 };
3127
3128 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
3129         __attribute__((format(printf, 2, 3)));
3130
3131
3132 /*! \brief Convert transfer status to string */
3133 static const char *referstatus2str(enum referstatus rstatus)
3134 {
3135         return map_x_s(referstatusstrings, rstatus, "");
3136 }
3137
3138 static inline void pvt_set_needdestroy(struct sip_pvt *pvt, const char *reason)
3139 {
3140         append_history(pvt, "NeedDestroy", "Setting needdestroy because %s", reason);
3141         pvt->needdestroy = 1;
3142 }
3143
3144 /*! \brief Initialize the initital request packet in the pvt structure.
3145         This packet is used for creating replies and future requests in
3146         a dialog */
3147 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
3148 {
3149         if (p->initreq.headers)
3150                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
3151         else
3152                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
3153         /* Use this as the basis */
3154         copy_request(&p->initreq, req);
3155         parse_request(&p->initreq);
3156         if (req->debug)
3157                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
3158 }
3159
3160 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
3161 static void sip_alreadygone(struct sip_pvt *dialog)
3162 {
3163         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
3164         dialog->alreadygone = 1;
3165 }
3166
3167 /*! Resolve DNS srv name or host name in a sip_proxy structure */
3168 static int proxy_update(struct sip_proxy *proxy)
3169 {
3170         /* if it's actually an IP address and not a name,
3171            there's no need for a managed lookup */
3172         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
3173                 /* Ok, not an IP address, then let's check if it's a domain or host */
3174                 /* XXX Todo - if we have proxy port, don't do SRV */
3175                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, sip_cfg.srvlookup ? "_sip._udp" : NULL) < 0) {
3176                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
3177                         return FALSE;
3178                 }
3179         }
3180         proxy->last_dnsupdate = time(NULL);
3181         return TRUE;
3182 }
3183
3184 /*! \brief Allocate and initialize sip proxy */
3185 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
3186 {
3187         struct sip_proxy *proxy;
3188
3189         if (ast_strlen_zero(name)) {
3190                 return NULL;
3191         }
3192
3193         proxy = ao2_alloc(sizeof(*proxy), NULL);
3194         if (!proxy)
3195                 return NULL;
3196         proxy->force = force;
3197         ast_copy_string(proxy->name, name, sizeof(proxy->name));
3198         proxy->ip.sin_port = htons((!ast_strlen_zero(port) ? atoi(port) : STANDARD_SIP_PORT));
3199         proxy_update(proxy);
3200         return proxy;
3201 }
3202
3203 /*! \brief Get default outbound proxy or global proxy */
3204 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
3205 {
3206         if (peer && peer->outboundproxy) {
3207                 if (sipdebug)
3208                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
3209                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
3210                 return peer->outboundproxy;
3211         }
3212         if (sip_cfg.outboundproxy.name[0]) {
3213                 if (sipdebug)
3214                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
3215                 append_history(dialog, "OBproxy", "Using global obproxy %s", sip_cfg.outboundproxy.name);
3216                 return &sip_cfg.outboundproxy;
3217         }
3218         if (sipdebug)
3219                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
3220         return NULL;
3221 }
3222
3223 /*! \brief returns true if 'name' (with optional trailing whitespace)
3224  * matches the sip method 'id'.
3225  * Strictly speaking, SIP methods are case SENSITIVE, but we do
3226  * a case-insensitive comparison to be more tolerant.
3227  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
3228  */
3229 static int method_match(enum sipmethod id, const char *name)
3230 {
3231         int len = strlen(sip_methods[id].text);
3232         int l_name = name ? strlen(name) : 0;
3233         /* true if the string is long enough, and ends with whitespace, and matches */
3234         return (l_name >= len && name[len] < 33 &&
3235                 !strncasecmp(sip_methods[id].text, name, len));
3236 }
3237
3238 /*! \brief  find_sip_method: Find SIP method from header */
3239 static int find_sip_method(const char *msg)
3240 {
3241         int i, res = 0;
3242         
3243         if (ast_strlen_zero(msg))
3244                 return 0;
3245         for (i = 1; i < ARRAY_LEN(sip_methods) && !res; i++) {
3246                 if (method_match(i, msg))
3247                         res = sip_methods[i].id;
3248         }
3249         return res;
3250 }
3251
3252 /*! \brief Parse supported header in incoming packet */
3253 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
3254 {
3255         char *next, *sep;
3256         char *temp;
3257         unsigned int profile = 0;
3258         int i, found;
3259
3260         if (ast_strlen_zero(supported) )
3261                 return 0;
3262         temp = ast_strdupa(supported);
3263
3264         if (sipdebug)
3265                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
3266
3267         for (next = temp; next; next = sep) {
3268                 found = FALSE;
3269                 if ( (sep = strchr(next, ',')) != NULL)
3270                         *sep++ = '\0';
3271                 next = ast_skip_blanks(next);
3272                 if (sipdebug)
3273                         ast_debug(3, "Found SIP option: -%s-\n", next);
3274                 for (i = 0; i < ARRAY_LEN(sip_options); i++) {
3275                         if (!strcasecmp(next, sip_options[i].text)) {
3276                                 profile |= sip_options[i].id;
3277                                 found = TRUE;
3278                                 if (sipdebug)
3279                                         ast_debug(3, "Matched SIP option: %s\n", next);
3280                                 break;
3281                         }
3282                 }
3283
3284                 /* This function is used to parse both Suported: and Require: headers.
3285                 Let the caller of this function know that an unknown option tag was 
3286                 encountered, so that if the UAC requires it then the request can be 
3287                 rejected with a 420 response. */
3288                 if (!found)
3289                         profile |= SIP_OPT_UNKNOWN;
3290
3291                 if (!found && sipdebug) {
3292                         if (!strncasecmp(next, "x-", 2))
3293                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
3294                         else
3295                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
3296                 }
3297         }
3298
3299         if (pvt)
3300                 pvt->sipoptions = profile;
3301         return profile;
3302 }
3303
3304 /*! \brief See if we pass debug IP filter */
3305 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
3306 {
3307         if (!sipdebug)
3308                 return 0;
3309         if (debugaddr.sin_addr.s_addr) {
3310                 if (((ntohs(debugaddr.sin_port) != 0)
3311                         && (debugaddr.sin_port != addr->sin_port))
3312                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
3313                         return 0;
3314         }
3315         return 1;
3316 }
3317
3318 /*! \brief The real destination address for a write */
3319 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
3320 {
3321         if (p->outboundproxy)
3322                 return &p->outboundproxy->ip;
3323
3324         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
3325 }
3326
3327 /*! \brief Display SIP nat mode */
3328 static const char *sip_nat_mode(const struct sip_pvt *p)
3329 {
3330         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
3331 }
3332
3333 /*! \brief Test PVT for debugging output */
3334 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
3335 {
3336         if (!sipdebug)
3337                 return 0;
3338         return sip_debug_test_addr(sip_real_dst(p));
3339 }
3340
3341 /*! \brief Return int representing a bit field of transport types found in const char *transport */
3342 static int get_transport_str2enum(const char *transport)
3343 {
3344         int res = 0;
3345
3346         if (ast_strlen_zero(transport)) {
3347                 return res;
3348         }
3349
3350         if (!strcasecmp(transport, "udp")) {
3351                 res |= SIP_TRANSPORT_UDP;
3352         }
3353         if (!strcasecmp(transport, "tcp")) {
3354                 res |= SIP_TRANSPORT_TCP;
3355         }
3356         if (!strcasecmp(transport, "tls")) {
3357                 res |= SIP_TRANSPORT_TLS;
3358         }
3359
3360         return res;
3361 }
3362
3363 /*! \brief Return configuration of transports for a device */
3364 static inline const char *get_transport_list(unsigned int transports) {
3365         switch (transports) {
3366                 case SIP_TRANSPORT_UDP:
3367                         return "UDP";
3368                 case SIP_TRANSPORT_TCP:
3369                         return "TCP";
3370                 case SIP_TRANSPORT_TLS:
3371                         return "TLS";
3372                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TCP:
3373                         return "TCP,UDP";
3374                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TLS:
3375                         return "TLS,UDP";
3376                 case SIP_TRANSPORT_TCP | SIP_TRANSPORT_TLS:
3377                         return "TLS,TCP";
3378                 default:
3379                         return transports ? 
3380                                 "TLS,TCP,UDP" : "UNKNOWN";      
3381         }
3382 }
3383
3384 /*! \brief Return transport as string */
3385 static inline const char *get_transport(enum sip_transport t)