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