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