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