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