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