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