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