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