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