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