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