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