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