fcfed9c69af0bd263fa74a3a1a25e84964c5416f
[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/config.h"
222 #include "asterisk/module.h"
223 #include "asterisk/pbx.h"
224 #include "asterisk/sched.h"
225 #include "asterisk/io.h"
226 #include "asterisk/rtp_engine.h"
227 #include "asterisk/udptl.h"
228 #include "asterisk/acl.h"
229 #include "asterisk/manager.h"
230 #include "asterisk/callerid.h"
231 #include "asterisk/cli.h"
232 #include "asterisk/musiconhold.h"
233 #include "asterisk/dsp.h"
234 #include "asterisk/features.h"
235 #include "asterisk/srv.h"
236 #include "asterisk/astdb.h"
237 #include "asterisk/causes.h"
238 #include "asterisk/utils.h"
239 #include "asterisk/file.h"
240 /*
241    Uncomment the define below,  if you are having refcount related memory leaks.
242    With this uncommented, this module will generate a file, /tmp/refs, which contains
243    a history of the ao2_ref() calls. To be useful, all calls to ao2_* functions should
244    be modified to ao2_t_* calls, and include a tag describing what is happening with
245    enough detail, to make pairing up a reference count increment with its corresponding decrement.
246    The refcounter program in utils/ can be invaluable in highlighting objects that are not
247    balanced, along with the complete history for that object.
248    In normal operation, the macros defined will throw away the tags, so they do not
249    affect the speed of the program at all. They can be considered to be documentation.
250 */
251 /* #define  REF_DEBUG 1 */
252 #include "asterisk/astobj2.h"
253 #include "asterisk/dnsmgr.h"
254 #include "asterisk/devicestate.h"
255 #include "asterisk/monitor.h"
256 #include "asterisk/netsock.h"
257 #include "asterisk/localtime.h"
258 #include "asterisk/abstract_jb.h"
259 #include "asterisk/threadstorage.h"
260 #include "asterisk/translate.h"
261 #include "asterisk/ast_version.h"
262 #include "asterisk/event.h"
263 #include "asterisk/stun.h"
264 #include "asterisk/cel.h"
265 #include "sip/include/sip.h"
266 #include "sip/include/config_parser.h"
267 #include "sip/include/reqresp_parser.h"
268 #include "sip/include/sip_utils.h"
269
270 /*** DOCUMENTATION
271         <application name="SIPDtmfMode" language="en_US">
272                 <synopsis>
273                         Change the dtmfmode for a SIP call.
274                 </synopsis>
275                 <syntax>
276                         <parameter name="mode" required="true">
277                                 <enumlist>
278                                         <enum name="inband" />
279                                         <enum name="info" />
280                                         <enum name="rfc2833" />
281                                 </enumlist>
282                         </parameter>
283                 </syntax>
284                 <description>
285                         <para>Changes the dtmfmode for a SIP call.</para>
286                 </description>
287         </application>
288         <application name="SIPAddHeader" language="en_US">
289                 <synopsis>
290                         Add a SIP header to the outbound call.
291                 </synopsis>
292                 <syntax argsep=":">
293                         <parameter name="Header" required="true" />
294                         <parameter name="Content" required="true" />
295                 </syntax>
296                 <description>
297                         <para>Adds a header to a SIP call placed with DIAL.</para>
298                         <para>Remember to use the X-header if you are adding non-standard SIP
299                         headers, like <literal>X-Asterisk-Accountcode:</literal>. Use this with care.
300                         Adding the wrong headers may jeopardize the SIP dialog.</para>
301                         <para>Always returns <literal>0</literal>.</para>
302                 </description>
303         </application>
304         <application name="SIPRemoveHeader" language="en_US">
305                 <synopsis>
306                         Remove SIP headers previously added with SIPAddHeader
307                 </synopsis>
308                 <syntax>
309                         <parameter name="Header" required="false" />
310                 </syntax>
311                 <description>
312                         <para>SIPRemoveHeader() allows you to remove headers which were previously
313                         added with SIPAddHeader(). If no parameter is supplied, all previously added
314                         headers will be removed. If a parameter is supplied, only the matching headers
315                         will be removed.</para>
316                         <para>For example you have added these 2 headers:</para>
317                         <para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
318                         <para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
319                         <para></para>
320                         <para>// remove all headers</para>
321                         <para>SIPRemoveHeader();</para>
322                         <para>// remove all P- headers</para>
323                         <para>SIPRemoveHeader(P-);</para>
324                         <para>// remove only the PAI header (note the : at the end)</para>
325                         <para>SIPRemoveHeader(P-Asserted-Identity:);</para>
326                         <para></para>
327                         <para>Always returns <literal>0</literal>.</para>
328                 </description>
329         </application>
330         <function name="SIP_HEADER" language="en_US">
331                 <synopsis>
332                         Gets the specified SIP header.
333                 </synopsis>
334                 <syntax>
335                         <parameter name="name" required="true" />
336                         <parameter name="number">
337                                 <para>If not specified, defaults to <literal>1</literal>.</para>
338                         </parameter>
339                 </syntax>
340                 <description>
341                         <para>Since there are several headers (such as Via) which can occur multiple
342                         times, SIP_HEADER takes an optional second argument to specify which header with
343                         that name to retrieve. Headers start at offset <literal>1</literal>.</para>
344                 </description>
345         </function>
346         <function name="SIPPEER" language="en_US">
347                 <synopsis>
348                         Gets SIP peer information.
349                 </synopsis>
350                 <syntax>
351                         <parameter name="peername" required="true" />
352                         <parameter name="item">
353                                 <enumlist>
354                                         <enum name="ip">
355                                                 <para>(default) The ip address.</para>
356                                         </enum>
357                                         <enum name="port">
358                                                 <para>The port number.</para>
359                                         </enum>
360                                         <enum name="mailbox">
361                                                 <para>The configured mailbox.</para>
362                                         </enum>
363                                         <enum name="context">
364                                                 <para>The configured context.</para>
365                                         </enum>
366                                         <enum name="expire">
367                                                 <para>The epoch time of the next expire.</para>
368                                         </enum>
369                                         <enum name="dynamic">
370                                                 <para>Is it dynamic? (yes/no).</para>
371                                         </enum>
372                                         <enum name="callerid_name">
373                                                 <para>The configured Caller ID name.</para>
374                                         </enum>
375                                         <enum name="callerid_num">
376                                                 <para>The configured Caller ID number.</para>
377                                         </enum>
378                                         <enum name="callgroup">
379                                                 <para>The configured Callgroup.</para>
380                                         </enum>
381                                         <enum name="pickupgroup">
382                                                 <para>The configured Pickupgroup.</para>
383                                         </enum>
384                                         <enum name="codecs">
385                                                 <para>The configured codecs.</para>
386                                         </enum>
387                                         <enum name="status">
388                                                 <para>Status (if qualify=yes).</para>
389                                         </enum>
390                                         <enum name="regexten">
391                                                 <para>Registration extension.</para>
392                                         </enum>
393                                         <enum name="limit">
394                                                 <para>Call limit (call-limit).</para>
395                                         </enum>
396                                         <enum name="busylevel">
397                                                 <para>Configured call level for signalling busy.</para>
398                                         </enum>
399                                         <enum name="curcalls">
400                                                 <para>Current amount of calls. Only available if call-limit is set.</para>
401                                         </enum>
402                                         <enum name="language">
403                                                 <para>Default language for peer.</para>
404                                         </enum>
405                                         <enum name="accountcode">
406                                                 <para>Account code for this peer.</para>
407                                         </enum>
408                                         <enum name="useragent">
409                                                 <para>Current user agent id for peer.</para>
410                                         </enum>
411                                         <enum name="chanvar[name]">
412                                                 <para>A channel variable configured with setvar for this peer.</para>
413                                         </enum>
414                                         <enum name="codec[x]">
415                                                 <para>Preferred codec index number <replaceable>x</replaceable> (beginning with zero).</para>
416                                         </enum>
417                                 </enumlist>
418                         </parameter>
419                 </syntax>
420                 <description />
421         </function>
422         <function name="SIPCHANINFO" language="en_US">
423                 <synopsis>
424                         Gets the specified SIP parameter from the current channel.
425                 </synopsis>
426                 <syntax>
427                         <parameter name="item" required="true">
428                                 <enumlist>
429                                         <enum name="peerip">
430                                                 <para>The IP address of the peer.</para>
431                                         </enum>
432                                         <enum name="recvip">
433                                                 <para>The source IP address of the peer.</para>
434                                         </enum>
435                                         <enum name="from">
436                                                 <para>The URI from the <literal>From:</literal> header.</para>
437                                         </enum>
438                                         <enum name="uri">
439                                                 <para>The URI from the <literal>Contact:</literal> header.</para>
440                                         </enum>
441                                         <enum name="useragent">
442                                                 <para>The useragent.</para>
443                                         </enum>
444                                         <enum name="peername">
445                                                 <para>The name of the peer.</para>
446                                         </enum>
447                                         <enum name="t38passthrough">
448                                                 <para><literal>1</literal> if T38 is offered or enabled in this channel,
449                                                 otherwise <literal>0</literal>.</para>
450                                         </enum>
451                                 </enumlist>
452                         </parameter>
453                 </syntax>
454                 <description />
455         </function>
456         <function name="CHECKSIPDOMAIN" language="en_US">
457                 <synopsis>
458                         Checks if domain is a local domain.
459                 </synopsis>
460                 <syntax>
461                         <parameter name="domain" required="true" />
462                 </syntax>
463                 <description>
464                         <para>This function checks if the <replaceable>domain</replaceable> in the argument is configured
465                         as a local SIP domain that this Asterisk server is configured to handle.
466                         Returns the domain name if it is locally handled, otherwise an empty string.
467                         Check the <literal>domain=</literal> configuration in <filename>sip.conf</filename>.</para>
468                 </description>
469         </function>
470         <manager name="SIPpeers" language="en_US">
471                 <synopsis>
472                         List SIP peers (text format).
473                 </synopsis>
474                 <syntax>
475                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
476                 </syntax>
477                 <description>
478                         <para>Lists SIP peers in text format with details on current status.
479                         Peerlist will follow as separate events, followed by a final event called
480                         PeerlistComplete.</para>
481                 </description>
482         </manager>
483         <manager name="SIPshowpeer" language="en_US">
484                 <synopsis>
485                         show SIP peer (text format).
486                 </synopsis>
487                 <syntax>
488                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
489                         <parameter name="Peer" required="true">
490                                 <para>The peer name you want to check.</para>
491                         </parameter>
492                 </syntax>
493                 <description>
494                         <para>Show one SIP peer with details on current status.</para>
495                 </description>
496         </manager>
497         <manager name="SIPqualifypeer" language="en_US">
498                 <synopsis>
499                         Qualify SIP peers.
500                 </synopsis>
501                 <syntax>
502                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
503                         <parameter name="Peer" required="true">
504                                 <para>The peer name you want to qualify.</para>
505                         </parameter>
506                 </syntax>
507                 <description>
508                         <para>Qualify a SIP peer.</para>
509                 </description>
510         </manager>
511         <manager name="SIPshowregistry" language="en_US">
512                 <synopsis>
513                         Show SIP registrations (text format).
514                 </synopsis>
515                 <syntax>
516                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
517                 </syntax>
518                 <description>
519                         <para>Lists all registration requests and status. Registrations will follow as separate
520                         events. followed by a final event called RegistrationsComplete.</para>
521                 </description>
522         </manager>
523         <manager name="SIPnotify" language="en_US">
524                 <synopsis>
525                         Send a SIP notify.
526                 </synopsis>
527                 <syntax>
528                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
529                         <parameter name="Channel" required="true">
530                                 <para>Peer to receive the notify.</para>
531                         </parameter>
532                         <parameter name="Variable" required="true">
533                                 <para>At least one variable pair must be specified.
534                                 <replaceable>name</replaceable>=<replaceable>value</replaceable></para>
535                         </parameter>
536                 </syntax>
537                 <description>
538                         <para>Sends a SIP Notify event.</para>
539                         <para>All parameters for this event must be specified in the body of this request
540                         via multiple Variable: name=value sequences.</para>
541                 </description>
542         </manager>
543  ***/
544
545 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
546 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
547 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
548 static int mwi_expiry = DEFAULT_MWI_EXPIRY;
549
550 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
551 static struct ast_jb_conf default_jbconf =
552 {
553         .flags = 0,
554         .max_size = -1,
555         .resync_threshold = -1,
556         .impl = ""
557 };
558 static struct ast_jb_conf global_jbconf;                /*!< Global jitterbuffer configuration */
559
560 static const char config[] = "sip.conf";                /*!< Main configuration file */
561 static const char notify_config[] = "sip_notify.conf";  /*!< Configuration file for sending Notify with CLI commands to reconfigure or reboot phones */
562
563 /*! \brief Readable descriptions of device states.
564  *  \note Should be aligned to above table as index */
565 static const struct invstate2stringtable {
566         const enum invitestates state;
567         const char *desc;
568 } invitestate2string[] = {
569         {INV_NONE,              "None"  },
570         {INV_CALLING,           "Calling (Trying)"},
571         {INV_PROCEEDING,        "Proceeding "},
572         {INV_EARLY_MEDIA,       "Early media"},
573         {INV_COMPLETED,         "Completed (done)"},
574         {INV_CONFIRMED,         "Confirmed (up)"},
575         {INV_TERMINATED,        "Done"},
576         {INV_CANCELLED,         "Cancelled"}
577 };
578
579 /*! \brief Subscription types that we support. We support
580  * - dialoginfo updates (really device status, not dialog info as was the original intent of the standard)
581  * - SIMPLE presence used for device status
582  * - Voicemail notification subscriptions
583  */
584 static const struct cfsubscription_types {
585         enum subscriptiontype type;
586         const char * const event;
587         const char * const mediatype;
588         const char * const text;
589 } subscription_types[] = {
590         { NONE,            "-",        "unknown",                    "unknown" },
591         /* RFC 4235: SIP Dialog event package */
592         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
593         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
594         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
595         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
596         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
597 };
598
599 /*! \brief The core structure to setup dialogs. We parse incoming messages by using
600  *  structure and then route the messages according to the type.
601  *
602  *  \note Note that sip_methods[i].id == i must hold or the code breaks
603  */
604 static const struct  cfsip_methods {
605         enum sipmethod id;
606         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
607         char * const text;
608         enum can_create_dialog can_create;
609 } sip_methods[] = {
610         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",CAN_CREATE_DIALOG },
611         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",  CAN_NOT_CREATE_DIALOG },
612         { SIP_REGISTER,  NO_RTP, "REGISTER", CAN_CREATE_DIALOG },
613         { SIP_OPTIONS,   NO_RTP, "OPTIONS",  CAN_CREATE_DIALOG },
614         { SIP_NOTIFY,    NO_RTP, "NOTIFY",   CAN_CREATE_DIALOG },
615         { SIP_INVITE,    RTP,    "INVITE",   CAN_CREATE_DIALOG },
616         { SIP_ACK,       NO_RTP, "ACK",      CAN_NOT_CREATE_DIALOG },
617         { SIP_PRACK,     NO_RTP, "PRACK",    CAN_NOT_CREATE_DIALOG },
618         { SIP_BYE,       NO_RTP, "BYE",      CAN_NOT_CREATE_DIALOG },
619         { SIP_REFER,     NO_RTP, "REFER",    CAN_CREATE_DIALOG },
620         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",CAN_CREATE_DIALOG },
621         { SIP_MESSAGE,   NO_RTP, "MESSAGE",  CAN_CREATE_DIALOG },
622         { SIP_UPDATE,    NO_RTP, "UPDATE",   CAN_NOT_CREATE_DIALOG },
623         { SIP_INFO,      NO_RTP, "INFO",     CAN_NOT_CREATE_DIALOG },
624         { SIP_CANCEL,    NO_RTP, "CANCEL",   CAN_NOT_CREATE_DIALOG },
625         { SIP_PUBLISH,   NO_RTP, "PUBLISH",  CAN_CREATE_DIALOG_UNSUPPORTED_METHOD },
626         { SIP_PING,      NO_RTP, "PING",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
627 };
628
629 /*! \brief List of well-known SIP options. If we get this in a require,
630    we should check the list and answer accordingly. */
631 static const struct cfsip_options {
632         int id;             /*!< Bitmap ID */
633         int supported;      /*!< Supported by Asterisk ? */
634         char * const text;  /*!< Text id, as in standard */
635 } sip_options[] = {     /* XXX used in 3 places */
636         /* RFC3262: PRACK 100% reliability */
637         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },
638         /* RFC3959: SIP Early session support */
639         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
640         /* SIMPLE events:  RFC4662 */
641         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
642         /* RFC 4916- Connected line ID updates */
643         { SIP_OPT_FROMCHANGE,   NOT_SUPPORTED,  "from-change" },
644         /* GRUU: Globally Routable User Agent URI's */
645         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
646         /* RFC4244 History info */
647         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
648         /* RFC3911: SIP Join header support */
649         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
650         /* Disable the REFER subscription, RFC 4488 */
651         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
652         /* SIP outbound - the final NAT battle - draft-sip-outbound */
653         { SIP_OPT_OUTBOUND,     NOT_SUPPORTED,  "outbound" },
654         /* RFC3327: Path support */
655         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
656         /* RFC3840: Callee preferences */
657         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
658         /* RFC3312: Precondition support */
659         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
660         /* RFC3323: Privacy with proxies*/
661         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
662         /* RFC-ietf-sip-uri-list-conferencing-02.txt conference invite lists */
663         { SIP_OPT_RECLISTINV,   NOT_SUPPORTED,  "recipient-list-invite" },
664         /* RFC-ietf-sip-uri-list-subscribe-02.txt - subscription lists */
665         { SIP_OPT_RECLISTSUB,   NOT_SUPPORTED,  "recipient-list-subscribe" },
666         /* RFC3891: Replaces: header for transfer */
667         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },
668         /* One version of Polycom firmware has the wrong label */
669         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },
670         /* RFC4412 Resource priorities */
671         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
672         /* RFC3329: Security agreement mechanism */
673         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
674         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
675         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
676         /* RFC4028: SIP Session-Timers */
677         { SIP_OPT_TIMER,        SUPPORTED,      "timer" },
678         /* RFC4538: Target-dialog */
679         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
680 };
681
682 /*! \brief Diversion header reasons
683  *
684  * The core defines a bunch of constants used to define
685  * redirecting reasons. This provides a translation table
686  * between those and the strings which may be present in
687  * a SIP Diversion header
688  */
689 static const struct sip_reasons {
690         enum AST_REDIRECTING_REASON code;
691         char * const text;
692 } sip_reason_table[] = {
693         { AST_REDIRECTING_REASON_UNKNOWN, "unknown" },
694         { AST_REDIRECTING_REASON_USER_BUSY, "user-busy" },
695         { AST_REDIRECTING_REASON_NO_ANSWER, "no-answer" },
696         { AST_REDIRECTING_REASON_UNAVAILABLE, "unavailable" },
697         { AST_REDIRECTING_REASON_UNCONDITIONAL, "unconditional" },
698         { AST_REDIRECTING_REASON_TIME_OF_DAY, "time-of-day" },
699         { AST_REDIRECTING_REASON_DO_NOT_DISTURB, "do-not-disturb" },
700         { AST_REDIRECTING_REASON_DEFLECTION, "deflection" },
701         { AST_REDIRECTING_REASON_FOLLOW_ME, "follow-me" },
702         { AST_REDIRECTING_REASON_OUT_OF_ORDER, "out-of-service" },
703         { AST_REDIRECTING_REASON_AWAY, "away" },
704         { AST_REDIRECTING_REASON_CALL_FWD_DTE, "unknown"}
705 };
706
707
708 /*! \name DefaultSettings
709         Default setttings are used as a channel setting and as a default when
710         configuring devices
711 */
712 /*@{*/
713 static char default_language[MAX_LANGUAGE];      /*!< Default language setting for new channels */
714 static char default_callerid[AST_MAX_EXTENSION]; /*!< Default caller ID for sip messages */
715 static char default_mwi_from[80];                /*!< Default caller ID for MWI updates */
716 static char default_fromdomain[AST_MAX_EXTENSION]; /*!< Default domain on outound messages */
717 static char default_notifymime[AST_MAX_EXTENSION]; /*!< Default MIME media type for MWI notify messages */
718 static char default_vmexten[AST_MAX_EXTENSION];    /*!< Default From Username on MWI updates */
719 static int default_qualify;                        /*!< Default Qualify= setting */
720 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
721 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting
722                                                     *   a bridged channel on hold */
723 static char default_parkinglot[AST_MAX_CONTEXT];   /*!< Parkinglot */
724 static char default_engine[256];                   /*!< Default RTP engine */
725 static int default_maxcallbitrate;                 /*!< Maximum bitrate for call */
726 static struct ast_codec_pref default_prefs;        /*!< Default codec prefs */
727 static unsigned int default_transports;            /*!< Default Transports (enum sip_transport) that are acceptable */
728 static unsigned int default_primary_transport;     /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
729 /*@}*/
730
731 static struct sip_settings sip_cfg;             /*!< SIP configuration data.
732                                         \note in the future we could have multiple of these (per domain, per device group etc) */
733
734 /*!< use this macro when ast_uri_decode is dependent on pedantic checking to be on. */
735 #define SIP_PEDANTIC_DECODE(str)        \
736         if (sip_cfg.pedanticsipchecking && !ast_strlen_zero(str)) {     \
737                 ast_uri_decode(str);    \
738         }       \
739
740 static unsigned int chan_idx;       /*!< used in naming sip channel */
741 static int global_match_auth_username;    /*!< Match auth username if available instead of From: Default off. */
742
743 static int global_relaxdtmf;        /*!< Relax DTMF */
744 static int global_prematuremediafilter;   /*!< Enable/disable premature frames in a call (causing 183 early media) */
745 static int global_rtptimeout;       /*!< Time out call if no RTP */
746 static int global_rtpholdtimeout;   /*!< Time out call if no RTP during hold */
747 static int global_rtpkeepalive;     /*!< Send RTP keepalives */
748 static int global_reg_timeout;      /*!< Global time between attempts for outbound registrations */
749 static int global_regattempts_max;  /*!< Registration attempts before giving up */
750 static int global_shrinkcallerid;   /*!< enable or disable shrinking of caller id  */
751 static int global_callcounter;      /*!< Enable call counters for all devices. This is currently enabled by setting the peer
752                                      *   call-limit to INT_MAX. When we remove the call-limit from the code, we can make it
753                                      *   with just a boolean flag in the device structure */
754 static unsigned int global_tos_sip;      /*!< IP type of service for SIP packets */
755 static unsigned int global_tos_audio;    /*!< IP type of service for audio RTP packets */
756 static unsigned int global_tos_video;    /*!< IP type of service for video RTP packets */
757 static unsigned int global_tos_text;     /*!< IP type of service for text RTP packets */
758 static unsigned int global_cos_sip;      /*!< 802.1p class of service for SIP packets */
759 static unsigned int global_cos_audio;    /*!< 802.1p class of service for audio RTP packets */
760 static unsigned int global_cos_video;    /*!< 802.1p class of service for video RTP packets */
761 static unsigned int global_cos_text;     /*!< 802.1p class of service for text RTP packets */
762 static unsigned int recordhistory;       /*!< Record SIP history. Off by default */
763 static unsigned int dumphistory;         /*!< Dump history to verbose before destroying SIP dialog */
764 static char global_useragent[AST_MAX_EXTENSION];    /*!< Useragent for the SIP channel */
765 static char global_sdpsession[AST_MAX_EXTENSION];   /*!< SDP session name for the SIP channel */
766 static char global_sdpowner[AST_MAX_EXTENSION];     /*!< SDP owner name for the SIP channel */
767 static int global_authfailureevents;     /*!< Whether we send authentication failure manager events or not. Default no. */
768 static int global_t1;           /*!< T1 time */
769 static int global_t1min;        /*!< T1 roundtrip time minimum */
770 static int global_timer_b;      /*!< Timer B - RFC 3261 Section 17.1.1.2 */
771 static unsigned int global_autoframing; /*!< Turn autoframing on or off. */
772 static int global_qualifyfreq;          /*!< Qualify frequency */
773 static int global_qualify_gap;          /*!< Time between our group of peer pokes */
774 static int global_qualify_peers;        /*!< Number of peers to poke at a given time */
775
776 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
777 static enum st_refresher global_st_refresher; /*!< Session-Timer refresher                        */
778 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
779 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
780
781 static int global_dynamic_exclude_static = 0; /*!< Exclude static peers from contact registrations */
782 /*@}*/
783
784 /*! \name Object counters @{
785  *  \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
786  *  should be used to modify these values. */
787 static int speerobjs = 0;     /*!< Static peers */
788 static int rpeerobjs = 0;     /*!< Realtime peers */
789 static int apeerobjs = 0;     /*!< Autocreated peer objects */
790 static int regobjs = 0;       /*!< Registry objects */
791 /* }@ */
792
793 static struct ast_flags global_flags[2] = {{0}};  /*!< global SIP_ flags */
794 static int global_t38_maxdatagram;                /*!< global T.38 FaxMaxDatagram override */
795
796 static char used_context[AST_MAX_CONTEXT];        /*!< name of automatically created context for unloading */
797
798 AST_MUTEX_DEFINE_STATIC(netlock);
799
800 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
801    when it's doing something critical. */
802 AST_MUTEX_DEFINE_STATIC(monlock);
803
804 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
805
806 /*! \brief This is the thread for the monitor which checks for input on the channels
807    which are not currently in use.  */
808 static pthread_t monitor_thread = AST_PTHREADT_NULL;
809
810 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
811 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
812
813 static struct sched_context *sched;     /*!< The scheduling context */
814 static struct io_context *io;           /*!< The IO context */
815 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
816 struct sip_pkt;
817 static AST_LIST_HEAD_STATIC(domain_list, domain);    /*!< The SIP domain list */
818
819 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
820
821 static enum sip_debug_e sipdebug;
822
823 /*! \brief extra debugging for 'text' related events.
824  *  At the moment this is set together with sip_debug_console.
825  *  \note It should either go away or be implemented properly.
826  */
827 static int sipdebug_text;
828
829 static const struct _map_x_s referstatusstrings[] = {
830         { REFER_IDLE,      "<none>" },
831         { REFER_SENT,      "Request sent" },
832         { REFER_RECEIVED,  "Request received" },
833         { REFER_CONFIRMED, "Confirmed" },
834         { REFER_ACCEPTED,  "Accepted" },
835         { REFER_RINGING,   "Target ringing" },
836         { REFER_200OK,     "Done" },
837         { REFER_FAILED,    "Failed" },
838         { REFER_NOAUTH,    "Failed - auth failure" },
839         { -1,               NULL} /* terminator */
840 };
841
842 /* --- Hash tables of various objects --------*/
843 #ifdef LOW_MEMORY
844 static const int HASH_PEER_SIZE = 17;
845 static const int HASH_DIALOG_SIZE = 17;
846 #else
847 static const int HASH_PEER_SIZE = 563;  /*!< Size of peer hash table, prime number preferred! */
848 static const int HASH_DIALOG_SIZE = 563;
849 #endif
850
851 /*! \brief
852  * Here we implement the container for dialogs (sip_pvt), defining
853  * generic wrapper functions to ease the transition from the current
854  * implementation (a single linked list) to a different container.
855  * In addition to a reference to the container, we need functions to lock/unlock
856  * the container and individual items, and functions to add/remove
857  * references to the individual items.
858  */
859 static struct ao2_container *dialogs;
860 #define sip_pvt_lock(x) ao2_lock(x)
861 #define sip_pvt_trylock(x) ao2_trylock(x)
862 #define sip_pvt_unlock(x) ao2_unlock(x)
863
864 /*! \brief  The table of TCP threads */
865 static struct ao2_container *threadt;
866
867 /*! \brief  The peer list: Users, Peers and Friends */
868 static struct ao2_container *peers;
869 static struct ao2_container *peers_by_ip;
870
871 /*! \brief  The register list: Other SIP proxies we register with and receive calls from */
872 static struct ast_register_list {
873         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
874         int recheck;
875 } regl;
876
877 /*! \brief  The MWI subscription list */
878 static struct ast_subscription_mwi_list {
879         ASTOBJ_CONTAINER_COMPONENTS(struct sip_subscription_mwi);
880 } submwil;
881 static int temp_pvt_init(void *);
882 static void temp_pvt_cleanup(void *);
883
884 /*! \brief A per-thread temporary pvt structure */
885 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
886
887 /*! \brief Authentication list for realm authentication
888  * \todo Move the sip_auth list to AST_LIST */
889 static struct sip_auth *authl = NULL;
890
891 /* --- Sockets and networking --------------*/
892
893 /*! \brief Main socket for UDP SIP communication.
894  *
895  * sipsock is shared between the SIP manager thread (which handles reload
896  * requests), the udp io handler (sipsock_read()) and the user routines that
897  * issue udp writes (using __sip_xmit()).
898  * The socket is -1 only when opening fails (this is a permanent condition),
899  * or when we are handling a reload() that changes its address (this is
900  * a transient situation during which we might have a harmless race, see
901  * below). Because the conditions for the race to be possible are extremely
902  * rare, we don't want to pay the cost of locking on every I/O.
903  * Rather, we remember that when the race may occur, communication is
904  * bound to fail anyways, so we just live with this event and let
905  * the protocol handle this above us.
906  */
907 static int sipsock  = -1;
908
909 static struct sockaddr_in bindaddr;     /*!< UDP: The address we bind to */
910
911 /*! \brief our (internal) default address/port to put in SIP/SDP messages
912  *  internip is initialized picking a suitable address from one of the
913  * interfaces, and the same port number we bind to. It is used as the
914  * default address/port in SIP messages, and as the default address
915  * (but not port) in SDP messages.
916  */
917 static struct sockaddr_in internip;
918
919 /*! \brief our external IP address/port for SIP sessions.
920  * externip.sin_addr is only set when we know we might be behind
921  * a NAT, and this is done using a variety of (mutually exclusive)
922  * ways from the config file:
923  *
924  * + with "externip = host[:port]" we specify the address/port explicitly.
925  *   The address is looked up only once when (re)loading the config file;
926  *
927  * + with "externhost = host[:port]" we do a similar thing, but the
928  *   hostname is stored in externhost, and the hostname->IP mapping
929  *   is refreshed every 'externrefresh' seconds;
930  *
931  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
932  *   to the specified server, and store the result in externip.
933  *
934  * Other variables (externhost, externexpire, externrefresh) are used
935  * to support the above functions.
936  */
937 static struct sockaddr_in externip;       /*!< External IP address if we are behind NAT */
938 static struct sockaddr_in media_address;  /*!< External RTP IP address if we are behind NAT */
939
940 static char externhost[MAXHOSTNAMELEN];   /*!< External host name */
941 static time_t externexpire;             /*!< Expiration counter for re-resolving external host name in dynamic DNS */
942 static int externrefresh = 10;          /*!< Refresh timer for DNS-based external address (dyndns) */
943 static struct sockaddr_in stunaddr;     /*!< stun server address */
944 static uint16_t externtcpport;          /*!< external tcp port */ 
945 static uint16_t externtlsport;          /*!< external tls port */
946
947 /*! \brief  List of local networks
948  * We store "localnet" addresses from the config file into an access list,
949  * marked as 'DENY', so the call to ast_apply_ha() will return
950  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
951  * (i.e. presumably public) addresses.
952  */
953 static struct ast_ha *localaddr;    /*!< List of local networks, on the same side of NAT as this Asterisk */
954
955 static int ourport_tcp;             /*!< The port used for TCP connections */
956 static int ourport_tls;             /*!< The port used for TCP/TLS connections */
957 static struct sockaddr_in debugaddr;
958
959 static struct ast_config *notify_types = NULL;    /*!< The list of manual NOTIFY types we know how to send */
960
961 /*! some list management macros. */
962
963 #define UNLINK(element, head, prev) do {        \
964         if (prev)                               \
965                 (prev)->next = (element)->next; \
966         else                                    \
967                 (head) = (element)->next;       \
968         } while (0)
969
970 /*---------------------------- Forward declarations of functions in chan_sip.c */
971 /* Note: This is added to help splitting up chan_sip.c into several files
972         in coming releases. */
973
974 /*--- PBX interface functions */
975 static struct ast_channel *sip_request_call(const char *type, format_t format, const struct ast_channel *requestor, void *data, int *cause);
976 static int sip_devicestate(void *data);
977 static int sip_sendtext(struct ast_channel *ast, const char *text);
978 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
979 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
980 static int sip_hangup(struct ast_channel *ast);
981 static int sip_answer(struct ast_channel *ast);
982 static struct ast_frame *sip_read(struct ast_channel *ast);
983 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
984 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
985 static int sip_transfer(struct ast_channel *ast, const char *dest);
986 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
987 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
988 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
989 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
990 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
991 static const char *sip_get_callid(struct ast_channel *chan);
992
993 static int handle_request_do(struct sip_request *req, struct sockaddr_in *sin);
994 static int sip_standard_port(enum sip_transport type, int port);
995 static int sip_prepare_socket(struct sip_pvt *p);
996
997 /*--- Transmitting responses and requests */
998 static int sipsock_read(int *id, int fd, short events, void *ignore);
999 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len);
1000 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod);
1001 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1002 static int retrans_pkt(const void *data);
1003 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);
1004 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1005 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1006 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1007 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);
1008 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1009 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);
1010 static int transmit_provisional_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, int with_sdp);
1011 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1012 static void transmit_fake_auth_response(struct sip_pvt *p, int sipmethod, struct sip_request *req, enum xmittype reliable);
1013 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1014 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1015 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1016 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
1017 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1018 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1019 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1020 static int transmit_refer(struct sip_pvt *p, const char *dest);
1021 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
1022 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1023 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1024 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1025 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1026 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1027 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1028 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
1029 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1030
1031 /*--- Dialog management */
1032 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1033                                  int useglobal_nat, const int intended_method, struct sip_request *req);
1034 static int __sip_autodestruct(const void *data);
1035 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1036 static int sip_cancel_destroy(struct sip_pvt *p);
1037 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
1038 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist);
1039 static void *registry_unref(struct sip_registry *reg, char *tag);
1040 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1041 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1042 static void __sip_pretend_ack(struct sip_pvt *p);
1043 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1044 static int auto_congest(const void *arg);
1045 static int update_call_counter(struct sip_pvt *fup, int event);
1046 static int hangup_sip2cause(int cause);
1047 static const char *hangup_cause2sip(int cause);
1048 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1049 static void free_old_route(struct sip_route *route);
1050 static void list_route(struct sip_route *route);
1051 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1052 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1053                                               struct sip_request *req, const char *uri);
1054 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1055 static void check_pendings(struct sip_pvt *p);
1056 static void *sip_park_thread(void *stuff);
1057 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1058 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1059 static int is_method_allowed(unsigned int *allowed_methods, enum sipmethod method);
1060
1061 /*--- Codec handling / SDP */
1062 static void try_suggested_sip_codec(struct sip_pvt *p);
1063 static const char *get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1064 static char get_sdp_line(int *start, int stop, struct sip_request *req, const char **value);
1065 static int find_sdp(struct sip_request *req);
1066 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
1067 static int process_sdp_o(const char *o, struct sip_pvt *p);
1068 static int process_sdp_c(const char *c, struct ast_hostent *hp);
1069 static int process_sdp_a_sendonly(const char *a, int *sendonly);
1070 static int process_sdp_a_audio(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newaudiortp, int *last_rtpmap_codec);
1071 static int process_sdp_a_video(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newvideortp, int *last_rtpmap_codec);
1072 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);
1073 static int process_sdp_a_image(const char *a, struct sip_pvt *p);
1074 static void add_codec_to_sdp(const struct sip_pvt *p, format_t codec,
1075                              struct ast_str **m_buf, struct ast_str **a_buf,
1076                              int debug, int *min_packet_size);
1077 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
1078                                 struct ast_str **m_buf, struct ast_str **a_buf,
1079                                 int debug);
1080 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
1081 static void do_setnat(struct sip_pvt *p);
1082 static void stop_media_flows(struct sip_pvt *p);
1083
1084 /*--- Authentication stuff */
1085 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1086 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1087 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1088                                          const char *secret, const char *md5secret, int sipmethod,
1089                                          const char *uri, enum xmittype reliable, int ignore);
1090 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1091                                               int sipmethod, const char *uri, enum xmittype reliable,
1092                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1093 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1094
1095 /*--- Domain handling */
1096 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1097 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1098 static void clear_sip_domains(void);
1099
1100 /*--- SIP realm authentication */
1101 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
1102 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1103 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1104
1105 /*--- Misc functions */
1106 static void check_rtp_timeout(struct sip_pvt *dialog, time_t t);
1107 static int sip_do_reload(enum channelreloadreason reason);
1108 static int reload_config(enum channelreloadreason reason);
1109 static int expire_register(const void *data);
1110 static void *do_monitor(void *data);
1111 static int restart_monitor(void);
1112 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
1113 static struct ast_variable *copy_vars(struct ast_variable *src);
1114 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
1115 static int sip_refer_allocate(struct sip_pvt *p);
1116 static int sip_notify_allocate(struct sip_pvt *p);
1117 static void ast_quiet_chan(struct ast_channel *chan);
1118 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1119 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
1120
1121 /*--- Device monitoring and Device/extension state/event handling */
1122 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1123 static int sip_devicestate(void *data);
1124 static int sip_poke_noanswer(const void *data);
1125 static int sip_poke_peer(struct sip_peer *peer, int force);
1126 static void sip_poke_all_peers(void);
1127 static void sip_peer_hold(struct sip_pvt *p, int hold);
1128 static void mwi_event_cb(const struct ast_event *, void *);
1129
1130 /*--- Applications, functions, CLI and manager command helpers */
1131 static const char *sip_nat_mode(const struct sip_pvt *p);
1132 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1133 static char *transfermode2str(enum transfermodes mode) attribute_const;
1134 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1135 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1136 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1137 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1138 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1139 static void  print_group(int fd, ast_group_t group, int crlf);
1140 static const char *dtmfmode2str(int mode) attribute_const;
1141 static int str2dtmfmode(const char *str) attribute_unused;
1142 static const char *insecure2str(int mode) attribute_const;
1143 static void cleanup_stale_contexts(char *new, char *old);
1144 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1145 static const char *domain_mode_to_text(const enum domain_mode mode);
1146 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1147 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1148 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1149 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1150 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1151 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1152 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1153 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1154 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1155 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1156 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1157 static char *complete_sip_peer(const char *word, int state, int flags2);
1158 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1159 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1160 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1161 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1162 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1163 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1164 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1165 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1166 static char *sip_do_debug_ip(int fd, const char *arg);
1167 static char *sip_do_debug_peer(int fd, const char *arg);
1168 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1169 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1170 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1171 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
1172 static int sip_addheader(struct ast_channel *chan, const char *data);
1173 static int sip_do_reload(enum channelreloadreason reason);
1174 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1175 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1176
1177 /*--- Debugging
1178         Functions for enabling debug per IP or fully, or enabling history logging for
1179         a SIP dialog
1180 */
1181 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1182 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1183 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1184 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1185 static void sip_dump_history(struct sip_pvt *dialog);
1186
1187 /*--- Device object handling */
1188 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime, int devstate_only);
1189 static int update_call_counter(struct sip_pvt *fup, int event);
1190 static void sip_destroy_peer(struct sip_peer *peer);
1191 static void sip_destroy_peer_fn(void *peer);
1192 static void set_peer_defaults(struct sip_peer *peer);
1193 static struct sip_peer *temp_peer(const char *name);
1194 static void register_peer_exten(struct sip_peer *peer, int onoff);
1195 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime, int forcenamematch, int devstate_only, int transport);
1196 static int sip_poke_peer_s(const void *data);
1197 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1198 static void reg_source_db(struct sip_peer *peer);
1199 static void destroy_association(struct sip_peer *peer);
1200 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1201 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1202 static void set_socket_transport(struct sip_socket *socket, int transport);
1203
1204 /* Realtime device support */
1205 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);
1206 static void update_peer(struct sip_peer *p, int expire);
1207 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1208 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
1209 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin, int devstate_only);
1210 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1211
1212 /*--- Internal UA client handling (outbound registrations) */
1213 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us, struct sip_pvt *p);
1214 static void sip_registry_destroy(struct sip_registry *reg);
1215 static int sip_register(const char *value, int lineno);
1216 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1217 static int sip_reregister(const void *data);
1218 static int __sip_do_register(struct sip_registry *r);
1219 static int sip_reg_timeout(const void *data);
1220 static void sip_send_all_registers(void);
1221 static int sip_reinvite_retry(const void *data);
1222
1223 /*--- Parsing SIP requests and responses */
1224 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1225 static int determine_firstline_parts(struct sip_request *req);
1226 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1227 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1228 static int find_sip_method(const char *msg);
1229 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1230 static unsigned int parse_allowed_methods(struct sip_request *req);
1231 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
1232 static int parse_request(struct sip_request *req);
1233 static const char *get_header(const struct sip_request *req, const char *name);
1234 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1235 static int method_match(enum sipmethod id, const char *name);
1236 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1237 static const char *find_alias(const char *name, const char *_default);
1238 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1239 static int lws2sws(char *msgbuf, int len);
1240 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1241 static char *remove_uri_parameters(char *uri);
1242 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1243 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1244 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1245 static int set_address_from_contact(struct sip_pvt *pvt);
1246 static void check_via(struct sip_pvt *p, struct sip_request *req);
1247 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
1248 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason);
1249 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1250 static int get_msg_text(char *buf, int len, struct sip_request *req, int addnewline);
1251 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1252 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
1253 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
1254 static void change_redirecting_information(struct sip_pvt *p, struct sip_request *req, struct ast_party_redirecting *redirecting, int set_call_forward);
1255 static int get_domain(const char *str, char *domain, int len);
1256 static void get_realm(struct sip_pvt *p, const struct sip_request *req);
1257
1258 /*-- TCP connection handling ---*/
1259 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session);
1260 static void *sip_tcp_worker_fn(void *);
1261
1262 /*--- Constructing requests and responses */
1263 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1264 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1265 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1266 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1267 static int init_resp(struct sip_request *resp, const char *msg);
1268 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
1269 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1270 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1271 static void build_via(struct sip_pvt *p);
1272 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1273 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct sockaddr_in *sin, int newdialog);
1274 static char *generate_random_string(char *buf, size_t size);
1275 static void build_callid_pvt(struct sip_pvt *pvt);
1276 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1277 static void make_our_tag(char *tagbuf, size_t len);
1278 static int add_header(struct sip_request *req, const char *var, const char *value);
1279 static int add_header_contentLength(struct sip_request *req, int len);
1280 static int add_line(struct sip_request *req, const char *line);
1281 static int add_text(struct sip_request *req, const char *text);
1282 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1283 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
1284 static int add_vidupdate(struct sip_request *req);
1285 static void add_route(struct sip_request *req, struct sip_route *route);
1286 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1287 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1288 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1289 static void set_destination(struct sip_pvt *p, char *uri);
1290 static void append_date(struct sip_request *req);
1291 static void build_contact(struct sip_pvt *p);
1292
1293 /*------Request handling functions */
1294 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1295 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
1296 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);
1297 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1298 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1299 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, const char *e);
1300 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1301 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1302 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
1303 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1304 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1305 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *nounlock);
1306 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
1307 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno, int *nounlock);
1308
1309 /*------Response handling functions */
1310 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1311 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1312 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1313 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1314 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1315 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
1316
1317 /*------ T38 Support --------- */
1318 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1319 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1320 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1321 static void change_t38_state(struct sip_pvt *p, int state);
1322
1323 /*------ Session-Timers functions --------- */
1324 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
1325 static int  proc_session_timer(const void *vp);
1326 static void stop_session_timer(struct sip_pvt *p);
1327 static void start_session_timer(struct sip_pvt *p);
1328 static void restart_session_timer(struct sip_pvt *p);
1329 static const char *strefresher2str(enum st_refresher r);
1330 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
1331 static int parse_minse(const char *p_hdrval, int *const p_interval);
1332 static int st_get_se(struct sip_pvt *, int max);
1333 static enum st_refresher st_get_refresher(struct sip_pvt *);
1334 static enum st_mode st_get_mode(struct sip_pvt *);
1335 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
1336
1337 /*------- RTP Glue functions -------- */
1338 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);
1339
1340 /*!--- SIP MWI Subscription support */
1341 static int sip_subscribe_mwi(const char *value, int lineno);
1342 static void sip_subscribe_mwi_destroy(struct sip_subscription_mwi *mwi);
1343 static void sip_send_all_mwi_subscriptions(void);
1344 static int sip_subscribe_mwi_do(const void *data);
1345 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
1346
1347 /*! \brief Definition of this channel for PBX channel registration */
1348 static const struct ast_channel_tech sip_tech = {
1349         .type = "SIP",
1350         .description = "Session Initiation Protocol (SIP)",
1351         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
1352         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1353         .requester = sip_request_call,                  /* called with chan unlocked */
1354         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1355         .call = sip_call,                       /* called with chan locked */
1356         .send_html = sip_sendhtml,
1357         .hangup = sip_hangup,                   /* called with chan locked */
1358         .answer = sip_answer,                   /* called with chan locked */
1359         .read = sip_read,                       /* called with chan locked */
1360         .write = sip_write,                     /* called with chan locked */
1361         .write_video = sip_write,               /* called with chan locked */
1362         .write_text = sip_write,
1363         .indicate = sip_indicate,               /* called with chan locked */
1364         .transfer = sip_transfer,               /* called with chan locked */
1365         .fixup = sip_fixup,                     /* called with chan locked */
1366         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1367         .send_digit_end = sip_senddigit_end,
1368         .bridge = ast_rtp_instance_bridge,                      /* XXX chan unlocked ? */
1369         .early_bridge = ast_rtp_instance_early_bridge,
1370         .send_text = sip_sendtext,              /* called with chan locked */
1371         .func_channel_read = acf_channel_read,
1372         .setoption = sip_setoption,
1373         .queryoption = sip_queryoption,
1374         .get_pvt_uniqueid = sip_get_callid,
1375 };
1376
1377 /*! \brief This version of the sip channel tech has no send_digit_begin
1378  * callback so that the core knows that the channel does not want
1379  * DTMF BEGIN frames.
1380  * The struct is initialized just before registering the channel driver,
1381  * and is for use with channels using SIP INFO DTMF.
1382  */
1383 static struct ast_channel_tech sip_tech_info;
1384
1385 /*! \brief Working TLS connection configuration */
1386 static struct ast_tls_config sip_tls_cfg;
1387
1388 /*! \brief Default TLS connection configuration */
1389 static struct ast_tls_config default_tls_cfg;
1390
1391 /*! \brief The TCP server definition */
1392 static struct ast_tcptls_session_args sip_tcp_desc = {
1393         .accept_fd = -1,
1394         .master = AST_PTHREADT_NULL,
1395         .tls_cfg = NULL,
1396         .poll_timeout = -1,
1397         .name = "SIP TCP server",
1398         .accept_fn = ast_tcptls_server_root,
1399         .worker_fn = sip_tcp_worker_fn,
1400 };
1401
1402 /*! \brief The TCP/TLS server definition */
1403 static struct ast_tcptls_session_args sip_tls_desc = {
1404         .accept_fd = -1,
1405         .master = AST_PTHREADT_NULL,
1406         .tls_cfg = &sip_tls_cfg,
1407         .poll_timeout = -1,
1408         .name = "SIP TLS server",
1409         .accept_fn = ast_tcptls_server_root,
1410         .worker_fn = sip_tcp_worker_fn,
1411 };
1412
1413 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
1414 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
1415
1416 /*! \brief Append to SIP dialog history
1417         \return Always returns 0 */
1418 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1419
1420 /*! \brief
1421  * when we create or delete references, make sure to use these
1422  * functions so we keep track of the refcounts.
1423  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1424  */
1425 #ifdef REF_DEBUG
1426 #define dialog_ref(arg1,arg2) dialog_ref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1427 #define dialog_unref(arg1,arg2) dialog_unref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1428
1429 static struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1430 {
1431         if (p)
1432                 __ao2_ref_debug(p, 1, tag, file, line, func);
1433         else
1434                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1435         return p;
1436 }
1437
1438 static struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1439 {
1440         if (p)
1441                 __ao2_ref_debug(p, -1, tag, file, line, func);
1442         return NULL;
1443 }
1444 #else
1445 static struct sip_pvt *dialog_ref(struct sip_pvt *p, char *tag)
1446 {
1447         if (p)
1448                 ao2_ref(p, 1);
1449         else
1450                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1451         return p;
1452 }
1453
1454 static struct sip_pvt *dialog_unref(struct sip_pvt *p, char *tag)
1455 {
1456         if (p)
1457                 ao2_ref(p, -1);
1458         return NULL;
1459 }
1460 #endif
1461
1462 /*! \brief map from an integer value to a string.
1463  * If no match is found, return errorstring
1464  */
1465 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
1466 {
1467         const struct _map_x_s *cur;
1468
1469         for (cur = table; cur->s; cur++)
1470                 if (cur->x == x)
1471                         return cur->s;
1472         return errorstring;
1473 }
1474
1475 /*! \brief map from a string to an integer value, case insensitive.
1476  * If no match is found, return errorvalue.
1477  */
1478 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
1479 {
1480         const struct _map_x_s *cur;
1481
1482         for (cur = table; cur->s; cur++)
1483                 if (!strcasecmp(cur->s, s))
1484                         return cur->x;
1485         return errorvalue;
1486 }
1487
1488 static enum AST_REDIRECTING_REASON sip_reason_str_to_code(const char *text)
1489 {
1490         enum AST_REDIRECTING_REASON ast = AST_REDIRECTING_REASON_UNKNOWN;
1491         int i;
1492
1493         for (i = 0; i < ARRAY_LEN(sip_reason_table); ++i) {
1494                 if (!strcasecmp(text, sip_reason_table[i].text)) {
1495                         ast = sip_reason_table[i].code;
1496                         break;
1497                 }
1498         }
1499
1500         return ast;
1501 }
1502
1503 static const char *sip_reason_code_to_str(enum AST_REDIRECTING_REASON code)
1504 {
1505         if (code >= 0 && code < ARRAY_LEN(sip_reason_table)) {
1506                 return sip_reason_table[code].text;
1507         }
1508
1509         return "unknown";
1510 }
1511
1512 /*!
1513  * \brief generic function for determining if a correct transport is being
1514  * used to contact a peer
1515  *
1516  * this is done as a macro so that the "tmpl" var can be passed either a
1517  * sip_request or a sip_peer
1518  */
1519 #define check_request_transport(peer, tmpl) ({ \
1520         int ret = 0; \
1521         if (peer->socket.type == tmpl->socket.type) \
1522                 ; \
1523         else if (!(peer->transports & tmpl->socket.type)) {\
1524                 ast_log(LOG_ERROR, \
1525                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
1526                         get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
1527                         ); \
1528                 ret = 1; \
1529         } else if (peer->socket.type & SIP_TRANSPORT_TLS) { \
1530                 ast_log(LOG_WARNING, \
1531                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
1532                         peer->name, get_transport(tmpl->socket.type) \
1533                 ); \
1534         } else { \
1535                 ast_debug(1, \
1536                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
1537                         peer->name, get_transport(tmpl->socket.type), get_transport(peer->socket.type) \
1538                 ); \
1539         }\
1540         (ret); \
1541 })
1542
1543 /*! \brief
1544  * duplicate a list of channel variables, \return the copy.
1545  */
1546 static struct ast_variable *copy_vars(struct ast_variable *src)
1547 {
1548         struct ast_variable *res = NULL, *tmp, *v = NULL;
1549
1550         for (v = src ; v ; v = v->next) {
1551                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
1552                         tmp->next = res;
1553                         res = tmp;
1554                 }
1555         }
1556         return res;
1557 }
1558
1559 static void tcptls_packet_destructor(void *obj)
1560 {
1561         struct tcptls_packet *packet = obj;
1562
1563         ast_free(packet->data);
1564 }
1565
1566 static void sip_tcptls_client_args_destructor(void *obj)
1567 {
1568         struct ast_tcptls_session_args *args = obj;
1569         if (args->tls_cfg) {
1570                 ast_free(args->tls_cfg->certfile);
1571                 ast_free(args->tls_cfg->pvtfile);
1572                 ast_free(args->tls_cfg->cipher);
1573                 ast_free(args->tls_cfg->cafile);
1574                 ast_free(args->tls_cfg->capath);
1575         }
1576         ast_free(args->tls_cfg);
1577         ast_free((char *) args->name);
1578 }
1579
1580 static void sip_threadinfo_destructor(void *obj)
1581 {
1582         struct sip_threadinfo *th = obj;
1583         struct tcptls_packet *packet;
1584         if (th->alert_pipe[1] > -1) {
1585                 close(th->alert_pipe[0]);
1586         }
1587         if (th->alert_pipe[1] > -1) {
1588                 close(th->alert_pipe[1]);
1589         }
1590         th->alert_pipe[0] = th->alert_pipe[1] = -1;
1591
1592         while ((packet = AST_LIST_REMOVE_HEAD(&th->packet_q, entry))) {
1593                 ao2_t_ref(packet, -1, "thread destruction, removing packet from frame queue");
1594         }
1595
1596         if (th->tcptls_session) {
1597                 ao2_t_ref(th->tcptls_session, -1, "remove tcptls_session for sip_threadinfo object");
1598         }
1599 }
1600
1601 /*! \brief creates a sip_threadinfo object and links it into the threadt table. */
1602 static struct sip_threadinfo *sip_threadinfo_create(struct ast_tcptls_session_instance *tcptls_session, int transport)
1603 {
1604         struct sip_threadinfo *th;
1605
1606         if (!tcptls_session || !(th = ao2_alloc(sizeof(*th), sip_threadinfo_destructor))) {
1607                 return NULL;
1608         }
1609
1610         th->alert_pipe[0] = th->alert_pipe[1] = -1;
1611
1612         if (pipe(th->alert_pipe) == -1) {
1613                 ao2_t_ref(th, -1, "Failed to open alert pipe on sip_threadinfo");
1614                 ast_log(LOG_ERROR, "Could not create sip alert pipe in tcptls thread, error %s\n", strerror(errno));
1615                 return NULL;
1616         }
1617         ao2_t_ref(tcptls_session, +1, "tcptls_session ref for sip_threadinfo object");
1618         th->tcptls_session = tcptls_session;
1619         th->type = transport ? transport : (tcptls_session->ssl ? SIP_TRANSPORT_TLS: SIP_TRANSPORT_TCP);
1620         ao2_t_link(threadt, th, "Adding new tcptls helper thread");
1621         ao2_t_ref(th, -1, "Decrementing threadinfo ref from alloc, only table ref remains");
1622         return th;
1623 }
1624
1625 /*! \brief used to indicate to a tcptls thread that data is ready to be written */
1626 static int sip_tcptls_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t len)
1627 {
1628         int res = len;
1629         struct sip_threadinfo *th = NULL;
1630         struct tcptls_packet *packet = NULL;
1631         struct sip_threadinfo tmp = {
1632                 .tcptls_session = tcptls_session,
1633         };
1634         enum sip_tcptls_alert alert = TCPTLS_ALERT_DATA;
1635
1636         if (!tcptls_session) {
1637                 return XMIT_ERROR;
1638         }
1639
1640         ast_mutex_lock(&tcptls_session->lock);
1641
1642         if ((tcptls_session->fd == -1) ||
1643                 !(th = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread")) ||
1644                 !(packet = ao2_alloc(sizeof(*packet), tcptls_packet_destructor)) ||
1645                 !(packet->data = ast_str_create(len))) {
1646                 goto tcptls_write_setup_error;
1647         }
1648
1649         /* goto tcptls_write_error should _NOT_ be used beyond this point */
1650         ast_str_set(&packet->data, 0, "%s", (char *) buf);
1651         packet->len = len;
1652
1653         /* alert tcptls thread handler that there is a packet to be sent.
1654          * must lock the thread info object to guarantee control of the
1655          * packet queue */
1656         ao2_lock(th);
1657         if (write(th->alert_pipe[1], &alert, sizeof(alert)) == -1) {
1658                 ast_log(LOG_ERROR, "write() to alert pipe failed: %s\n", strerror(errno));
1659                 ao2_t_ref(packet, -1, "could not write to alert pipe, remove packet");
1660                 packet = NULL;
1661                 res = XMIT_ERROR;
1662         } else { /* it is safe to queue the frame after issuing the alert when we hold the threadinfo lock */
1663                 AST_LIST_INSERT_TAIL(&th->packet_q, packet, entry);
1664         }
1665         ao2_unlock(th);
1666
1667         ast_mutex_unlock(&tcptls_session->lock);
1668         ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo object after finding it");
1669         return res;
1670
1671 tcptls_write_setup_error:
1672         if (th) {
1673                 ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo obj, could not create packet");
1674         }
1675         if (packet) {
1676                 ao2_t_ref(packet, -1, "could not allocate packet's data");
1677         }
1678         ast_mutex_unlock(&tcptls_session->lock);
1679
1680         return XMIT_ERROR;
1681 }
1682
1683 /*! \brief SIP TCP connection handler */
1684 static void *sip_tcp_worker_fn(void *data)
1685 {
1686         struct ast_tcptls_session_instance *tcptls_session = data;
1687
1688         return _sip_tcp_helper_thread(NULL, tcptls_session);
1689 }
1690
1691 /*! \brief SIP TCP thread management function
1692         This function reads from the socket, parses the packet into a request
1693 */
1694 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session)
1695 {
1696         int res, cl;
1697         struct sip_request req = { 0, } , reqcpy = { 0, };
1698         struct sip_threadinfo *me = NULL;
1699         char buf[1024] = "";
1700         struct pollfd fds[2] = { { 0 }, { 0 }, };
1701         struct ast_tcptls_session_args *ca = NULL;
1702
1703         /* If this is a server session, then the connection has already been setup,
1704          * simply create the threadinfo object so we can access this thread for writing.
1705          * 
1706          * if this is a client connection more work must be done.
1707          * 1. We own the parent session args for a client connection.  This pointer needs
1708          *    to be held on to so we can decrement it's ref count on thread destruction.
1709          * 2. The threadinfo object was created before this thread was launched, however
1710          *    it must be found within the threadt table.
1711          * 3. Last, the tcptls_session must be started.
1712          */
1713         if (!tcptls_session->client) {
1714                 if (!(me = sip_threadinfo_create(tcptls_session, tcptls_session->ssl ? SIP_TRANSPORT_TLS : SIP_TRANSPORT_TCP))) {
1715                         goto cleanup;
1716                 }
1717                 ao2_t_ref(me, +1, "Adding threadinfo ref for tcp_helper_thread");
1718         } else {
1719                 struct sip_threadinfo tmp = {
1720                         .tcptls_session = tcptls_session,
1721                 };
1722
1723                 if ((!(ca = tcptls_session->parent)) ||
1724                         (!(me = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread"))) ||
1725                         (!(tcptls_session = ast_tcptls_client_start(tcptls_session)))) {
1726                         goto cleanup;
1727                 }
1728         }
1729
1730         me->threadid = pthread_self();
1731         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
1732
1733         /* set up pollfd to watch for reads on both the socket and the alert_pipe */
1734         fds[0].fd = tcptls_session->fd;
1735         fds[1].fd = me->alert_pipe[0];
1736         fds[0].events = fds[1].events = POLLIN | POLLPRI;
1737
1738         if (!(req.data = ast_str_create(SIP_MIN_PACKET)))
1739                 goto cleanup;
1740         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET)))
1741                 goto cleanup;
1742
1743         for (;;) {
1744                 struct ast_str *str_save;
1745
1746                 res = ast_poll(fds, 2, -1); /* polls for both socket and alert_pipe */
1747                 if (res < 0) {
1748                         ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", tcptls_session->ssl ? "SSL": "TCP", res);
1749                         goto cleanup;
1750                 }
1751
1752                 /* handle the socket event, check for both reads from the socket fd,
1753                  * and writes from alert_pipe fd */
1754                 if (fds[0].revents) { /* there is data on the socket to be read */
1755
1756                         fds[0].revents = 0;
1757
1758                         /* clear request structure */
1759                         str_save = req.data;
1760                         memset(&req, 0, sizeof(req));
1761                         req.data = str_save;
1762                         ast_str_reset(req.data);
1763
1764                         str_save = reqcpy.data;
1765                         memset(&reqcpy, 0, sizeof(reqcpy));
1766                         reqcpy.data = str_save;
1767                         ast_str_reset(reqcpy.data);
1768
1769                         memset(buf, 0, sizeof(buf));
1770
1771                         if (tcptls_session->ssl) {
1772                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TLS);
1773                                 req.socket.port = htons(ourport_tls);
1774                         } else {
1775                                 set_socket_transport(&req.socket, SIP_TRANSPORT_TCP);
1776                                 req.socket.port = htons(ourport_tcp);
1777                         }
1778                         req.socket.fd = tcptls_session->fd;
1779
1780                         /* Read in headers one line at a time */
1781                         while (req.len < 4 || strncmp(REQ_OFFSET_TO_STR(&req, len - 4), "\r\n\r\n", 4)) {
1782                                 ast_mutex_lock(&tcptls_session->lock);
1783                                 if (!fgets(buf, sizeof(buf), tcptls_session->f)) {
1784                                         ast_mutex_unlock(&tcptls_session->lock);
1785                                         goto cleanup;
1786                                 }
1787                                 ast_mutex_unlock(&tcptls_session->lock);
1788                                 if (me->stop)
1789                                          goto cleanup;
1790                                 ast_str_append(&req.data, 0, "%s", buf);
1791                                 req.len = req.data->used;
1792                         }
1793                         copy_request(&reqcpy, &req);
1794                         parse_request(&reqcpy);
1795                         /* In order to know how much to read, we need the content-length header */
1796                         if (sscanf(get_header(&reqcpy, "Content-Length"), "%30d", &cl)) {
1797                                 while (cl > 0) {
1798                                         size_t bytes_read;
1799                                         ast_mutex_lock(&tcptls_session->lock);
1800                                         if (!(bytes_read = fread(buf, 1, MIN(sizeof(buf) - 1, cl), tcptls_session->f))) {
1801                                                 ast_mutex_unlock(&tcptls_session->lock);
1802                                                 goto cleanup;
1803                                         }
1804                                         buf[bytes_read] = '\0';
1805                                         ast_mutex_unlock(&tcptls_session->lock);
1806                                         if (me->stop)
1807                                                 goto cleanup;
1808                                         cl -= strlen(buf);
1809                                         ast_str_append(&req.data, 0, "%s", buf);
1810                                         req.len = req.data->used;
1811                                 }
1812                         }
1813                         /*! \todo XXX If there's no Content-Length or if the content-length and what
1814                                         we receive is not the same - we should generate an error */
1815
1816                         req.socket.tcptls_session = tcptls_session;
1817                         handle_request_do(&req, &tcptls_session->remote_address);
1818                 }
1819
1820                 if (fds[1].revents) { /* alert_pipe indicates there is data in the send queue to be sent */
1821                         enum sip_tcptls_alert alert;
1822                         struct tcptls_packet *packet;
1823
1824                         fds[1].revents = 0;
1825
1826                         if (read(me->alert_pipe[0], &alert, sizeof(alert)) == -1) {
1827                                 ast_log(LOG_ERROR, "read() failed: %s\n", strerror(errno));
1828                                 continue;
1829                         }
1830
1831                         switch (alert) {
1832                         case TCPTLS_ALERT_STOP:
1833                                 goto cleanup;
1834                         case TCPTLS_ALERT_DATA:
1835                                 ao2_lock(me);
1836                                 if (!(packet = AST_LIST_REMOVE_HEAD(&me->packet_q, entry))) {
1837                                         ast_log(LOG_WARNING, "TCPTLS thread alert_pipe indicated packet should be sent, but frame_q is empty");
1838                                 } else if (ast_tcptls_server_write(tcptls_session, ast_str_buffer(packet->data), packet->len) == -1) {
1839                                         ast_log(LOG_WARNING, "Failure to write to tcp/tls socket\n");
1840                                 }
1841
1842                                 if (packet) {
1843                                         ao2_t_ref(packet, -1, "tcptls packet sent, this is no longer needed");
1844                                 }
1845                                 ao2_unlock(me);
1846                                 break;
1847                         default:
1848                                 ast_log(LOG_ERROR, "Unknown tcptls thread alert '%d'\n", alert);
1849                         }
1850                 }
1851         }
1852
1853         ast_debug(2, "Shutting down thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
1854
1855 cleanup:
1856         if (me) {
1857                 ao2_t_unlink(threadt, me, "Removing tcptls helper thread, thread is closing");
1858                 ao2_t_ref(me, -1, "Removing tcp_helper_threads threadinfo ref");
1859         }
1860         if (reqcpy.data) {
1861                 ast_free(reqcpy.data);
1862         }
1863
1864         if (req.data) {
1865                 ast_free(req.data);
1866                 req.data = NULL;
1867         }
1868
1869         /* if client, we own the parent session arguments and must decrement ref */
1870         if (ca) {
1871                 ao2_t_ref(ca, -1, "closing tcptls thread, getting rid of client tcptls_session arguments");
1872         }
1873
1874         if (tcptls_session) {
1875                 ast_mutex_lock(&tcptls_session->lock);
1876                 if (tcptls_session->f) {
1877                         fclose(tcptls_session->f);
1878                         tcptls_session->f = NULL;
1879                 }
1880                 if (tcptls_session->fd != -1) {
1881                         close(tcptls_session->fd);
1882                         tcptls_session->fd = -1;
1883                 }
1884                 tcptls_session->parent = NULL;
1885                 ast_mutex_unlock(&tcptls_session->lock);
1886
1887                 ao2_ref(tcptls_session, -1);
1888                 tcptls_session = NULL;
1889         }
1890         return NULL;
1891 }
1892
1893
1894 /*!
1895  * helper functions to unreference various types of objects.
1896  * By handling them this way, we don't have to declare the
1897  * destructor on each call, which removes the chance of errors.
1898  */
1899 static void *unref_peer(struct sip_peer *peer, char *tag)
1900 {
1901         ao2_t_ref(peer, -1, tag);
1902         return NULL;
1903 }
1904
1905 static struct sip_peer *ref_peer(struct sip_peer *peer, char *tag)
1906 {
1907         ao2_t_ref(peer, 1, tag);
1908         return peer;
1909 }
1910
1911 /*! \brief maintain proper refcounts for a sip_pvt's outboundproxy
1912  *
1913  * This function sets pvt's outboundproxy pointer to the one referenced
1914  * by the proxy parameter. Because proxy may be a refcounted object, and
1915  * because pvt's old outboundproxy may also be a refcounted object, we need
1916  * to maintain the proper refcounts.
1917  *
1918  * \param pvt The sip_pvt for which we wish to set the outboundproxy
1919  * \param proxy The sip_proxy which we will point pvt towards.
1920  * \return Returns void
1921  */
1922 static void ref_proxy(struct sip_pvt *pvt, struct sip_proxy *proxy)
1923 {
1924         struct sip_proxy *old_obproxy = pvt->outboundproxy;
1925         /* The sip_cfg.outboundproxy is statically allocated, and so
1926          * we don't ever need to adjust refcounts for it
1927          */
1928         if (proxy && proxy != &sip_cfg.outboundproxy) {
1929                 ao2_ref(proxy, +1);
1930         }
1931         pvt->outboundproxy = proxy;
1932         if (old_obproxy && old_obproxy != &sip_cfg.outboundproxy) {
1933                 ao2_ref(old_obproxy, -1);
1934         }
1935 }
1936
1937 /*!
1938  * \brief Unlink a dialog from the dialogs container, as well as any other places
1939  * that it may be currently stored.
1940  *
1941  * \note A reference to the dialog must be held before calling this function, and this
1942  * function does not release that reference.
1943  */
1944 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist)
1945 {
1946         struct sip_pkt *cp;
1947
1948         dialog_ref(dialog, "Let's bump the count in the unlink so it doesn't accidentally become dead before we are done");
1949
1950         ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
1951
1952         /* Unlink us from the owner (channel) if we have one */
1953         if (dialog->owner) {
1954                 if (lockowner)
1955                         ast_channel_lock(dialog->owner);
1956                 ast_debug(1, "Detaching from channel %s\n", dialog->owner->name);
1957                 dialog->owner->tech_pvt = dialog_unref(dialog->owner->tech_pvt, "resetting channel dialog ptr in unlink_all");
1958                 if (lockowner)
1959                         ast_channel_unlock(dialog->owner);
1960         }
1961         if (dialog->registry) {
1962                 if (dialog->registry->call == dialog)
1963                         dialog->registry->call = dialog_unref(dialog->registry->call, "nulling out the registry's call dialog field in unlink_all");
1964                 dialog->registry = registry_unref(dialog->registry, "delete dialog->registry");
1965         }
1966         if (dialog->stateid > -1) {
1967                 ast_extension_state_del(dialog->stateid, NULL);
1968                 dialog_unref(dialog, "removing extension_state, should unref the associated dialog ptr that was stored there.");
1969                 dialog->stateid = -1; /* shouldn't we 'zero' this out? */
1970         }
1971         /* Remove link from peer to subscription of MWI */
1972         if (dialog->relatedpeer && dialog->relatedpeer->mwipvt == dialog)
1973                 dialog->relatedpeer->mwipvt = dialog_unref(dialog->relatedpeer->mwipvt, "delete ->relatedpeer->mwipvt");
1974         if (dialog->relatedpeer && dialog->relatedpeer->call == dialog)
1975                 dialog->relatedpeer->call = dialog_unref(dialog->relatedpeer->call, "unset the relatedpeer->call field in tandem with relatedpeer field itself");
1976
1977         /* remove all current packets in this dialog */
1978         while((cp = dialog->packets)) {
1979                 dialog->packets = dialog->packets->next;
1980                 AST_SCHED_DEL(sched, cp->retransid);
1981                 dialog_unref(cp->owner, "remove all current packets in this dialog, and the pointer to the dialog too as part of __sip_destroy");
1982                 if (cp->data) {
1983                         ast_free(cp->data);
1984                 }
1985                 ast_free(cp);
1986         }
1987
1988         AST_SCHED_DEL_UNREF(sched, dialog->waitid, dialog_unref(dialog, "when you delete the waitid sched, you should dec the refcount for the stored dialog ptr"));
1989
1990         AST_SCHED_DEL_UNREF(sched, dialog->initid, dialog_unref(dialog, "when you delete the initid sched, you should dec the refcount for the stored dialog ptr"));
1991         
1992         if (dialog->autokillid > -1)
1993                 AST_SCHED_DEL_UNREF(sched, dialog->autokillid, dialog_unref(dialog, "when you delete the autokillid sched, you should dec the refcount for the stored dialog ptr"));
1994
1995         if (dialog->request_queue_sched_id > -1) {
1996                 AST_SCHED_DEL_UNREF(sched, dialog->request_queue_sched_id, dialog_unref(dialog, "when you delete the request_queue_sched_id sched, you should dec the refcount for the stored dialog ptr"));
1997         }
1998
1999         AST_SCHED_DEL_UNREF(sched, dialog->provisional_keepalive_sched_id, dialog_unref(dialog, "when you delete the provisional_keepalive_sched_id, you should dec the refcount for the stored dialog ptr"));
2000
2001         if (dialog->t38id > -1) {
2002                 AST_SCHED_DEL_UNREF(sched, dialog->t38id, dialog_unref(dialog, "when you delete the t38id sched, you should dec the refcount for the stored dialog ptr"));
2003         }
2004
2005         dialog_unref(dialog, "Let's unbump the count in the unlink so the poor pvt can disappear if it is time");
2006         return NULL;
2007 }
2008
2009 static void *registry_unref(struct sip_registry *reg, char *tag)
2010 {
2011         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
2012         ASTOBJ_UNREF(reg, sip_registry_destroy);
2013         return NULL;
2014 }
2015
2016 /*! \brief Add object reference to SIP registry */
2017 static struct sip_registry *registry_addref(struct sip_registry *reg, char *tag)
2018 {
2019         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
2020         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
2021 }
2022
2023 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
2024 static struct ast_udptl_protocol sip_udptl = {
2025         type: "SIP",
2026         get_udptl_info: sip_get_udptl_peer,
2027         set_udptl_peer: sip_set_udptl_peer,
2028 };
2029
2030 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2031         __attribute__((format(printf, 2, 3)));
2032
2033
2034 /*! \brief Convert transfer status to string */
2035 static const char *referstatus2str(enum referstatus rstatus)
2036 {
2037         return map_x_s(referstatusstrings, rstatus, "");
2038 }
2039
2040 static inline void pvt_set_needdestroy(struct sip_pvt *pvt, const char *reason)
2041 {
2042         append_history(pvt, "NeedDestroy", "Setting needdestroy because %s", reason);
2043         pvt->needdestroy = 1;
2044 }
2045
2046 /*! \brief Initialize the initital request packet in the pvt structure.
2047         This packet is used for creating replies and future requests in
2048         a dialog */
2049 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
2050 {
2051         if (p->initreq.headers)
2052                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
2053         else
2054                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
2055         /* Use this as the basis */
2056         copy_request(&p->initreq, req);
2057         parse_request(&p->initreq);
2058         if (req->debug)
2059                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
2060 }
2061
2062 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
2063 static void sip_alreadygone(struct sip_pvt *dialog)
2064 {
2065         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
2066         dialog->alreadygone = 1;
2067 }
2068
2069 /*! Resolve DNS srv name or host name in a sip_proxy structure */
2070 static int proxy_update(struct sip_proxy *proxy)
2071 {
2072         /* if it's actually an IP address and not a name,
2073            there's no need for a managed lookup */
2074         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
2075                 /* Ok, not an IP address, then let's check if it's a domain or host */
2076                 /* XXX Todo - if we have proxy port, don't do SRV */
2077                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, sip_cfg.srvlookup ? "_sip._udp" : NULL) < 0) {
2078                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
2079                         return FALSE;
2080                 }
2081         }
2082         proxy->last_dnsupdate = time(NULL);
2083         return TRUE;
2084 }
2085
2086 /*! \brief converts ascii port to int representation. If no
2087  *  pt buffer is provided or the pt has errors when being converted
2088  *  to an int value, the port provided as the standard is used.
2089  */
2090 unsigned int port_str2int(const char *pt, unsigned int standard)
2091 {
2092         int port = standard;
2093         if (ast_strlen_zero(pt) || (sscanf(pt, "%30d", &port) != 1) || (port < 1) || (port > 65535)) {
2094                 port = standard;
2095         }
2096
2097         return port;
2098 }
2099
2100 /*! \brief Allocate and initialize sip proxy */
2101 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
2102 {
2103         struct sip_proxy *proxy;
2104
2105         if (ast_strlen_zero(name)) {
2106                 return NULL;
2107         }
2108
2109         proxy = ao2_alloc(sizeof(*proxy), NULL);
2110         if (!proxy)
2111                 return NULL;
2112         proxy->force = force;
2113         ast_copy_string(proxy->name, name, sizeof(proxy->name));
2114         proxy->ip.sin_port = htons(port_str2int(port, STANDARD_SIP_PORT));
2115         proxy_update(proxy);
2116         return proxy;
2117 }
2118
2119 /*! \brief Get default outbound proxy or global proxy */
2120 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
2121 {
2122         if (peer && peer->outboundproxy) {
2123                 if (sipdebug)
2124                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
2125                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
2126                 return peer->outboundproxy;
2127         }
2128         if (sip_cfg.outboundproxy.name[0]) {
2129                 if (sipdebug)
2130                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
2131                 append_history(dialog, "OBproxy", "Using global obproxy %s", sip_cfg.outboundproxy.name);
2132                 return &sip_cfg.outboundproxy;
2133         }
2134         if (sipdebug)
2135                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
2136         return NULL;
2137 }
2138
2139 /*! \brief returns true if 'name' (with optional trailing whitespace)
2140  * matches the sip method 'id'.
2141  * Strictly speaking, SIP methods are case SENSITIVE, but we do
2142  * a case-insensitive comparison to be more tolerant.
2143  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
2144  */
2145 static int method_match(enum sipmethod id, const char *name)
2146 {
2147         int len = strlen(sip_methods[id].text);
2148         int l_name = name ? strlen(name) : 0;
2149         /* true if the string is long enough, and ends with whitespace, and matches */
2150         return (l_name >= len && name[len] < 33 &&
2151                 !strncasecmp(sip_methods[id].text, name, len));
2152 }
2153
2154 /*! \brief  find_sip_method: Find SIP method from header */
2155 static int find_sip_method(const char *msg)
2156 {
2157         int i, res = 0;
2158         
2159         if (ast_strlen_zero(msg))
2160                 return 0;
2161         for (i = 1; i < ARRAY_LEN(sip_methods) && !res; i++) {
2162                 if (method_match(i, msg))
2163                         res = sip_methods[i].id;
2164         }
2165         return res;
2166 }
2167
2168 /*! \brief Parse supported header in incoming packet */
2169 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
2170 {
2171         char *next, *sep;
2172         char *temp;
2173         unsigned int profile = 0;
2174         int i, found;
2175
2176         if (ast_strlen_zero(supported) )
2177                 return 0;
2178         temp = ast_strdupa(supported);
2179
2180         if (sipdebug)
2181                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
2182
2183         for (next = temp; next; next = sep) {
2184                 found = FALSE;
2185                 if ( (sep = strchr(next, ',')) != NULL)
2186                         *sep++ = '\0';
2187                 next = ast_skip_blanks(next);
2188                 if (sipdebug)
2189                         ast_debug(3, "Found SIP option: -%s-\n", next);
2190                 for (i = 0; i < ARRAY_LEN(sip_options); i++) {
2191                         if (!strcasecmp(next, sip_options[i].text)) {
2192                                 profile |= sip_options[i].id;
2193                                 found = TRUE;
2194                                 if (sipdebug)
2195                                         ast_debug(3, "Matched SIP option: %s\n", next);
2196                                 break;
2197                         }
2198                 }
2199
2200                 /* This function is used to parse both Suported: and Require: headers.
2201                 Let the caller of this function know that an unknown option tag was
2202                 encountered, so that if the UAC requires it then the request can be
2203                 rejected with a 420 response. */
2204                 if (!found)
2205                         profile |= SIP_OPT_UNKNOWN;
2206
2207                 if (!found && sipdebug) {
2208                         if (!strncasecmp(next, "x-", 2))
2209                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
2210                         else
2211                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
2212                 }
2213         }
2214
2215         if (pvt)
2216                 pvt->sipoptions = profile;
2217         return profile;
2218 }
2219
2220 /*! \brief See if we pass debug IP filter */
2221 static inline int sip_debug_test_addr(const struct sockaddr_in *addr)
2222 {
2223         if (!sipdebug)
2224                 return 0;
2225         if (debugaddr.sin_addr.s_addr) {
2226                 if (((ntohs(debugaddr.sin_port) != 0)
2227                         && (debugaddr.sin_port != addr->sin_port))
2228                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
2229                         return 0;
2230         }
2231         return 1;
2232 }
2233
2234 /*! \brief The real destination address for a write */
2235 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
2236 {
2237         if (p->outboundproxy)
2238                 return &p->outboundproxy->ip;
2239
2240         return ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) || ast_test_flag(&p->flags[0], SIP_NAT_RPORT_PRESENT) ? &p->recv : &p->sa;
2241 }
2242
2243 /*! \brief Display SIP nat mode */
2244 static const char *sip_nat_mode(const struct sip_pvt *p)
2245 {
2246         return ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) ? "NAT" : "no NAT";
2247 }
2248
2249 /*! \brief Test PVT for debugging output */
2250 static inline int sip_debug_test_pvt(struct sip_pvt *p)
2251 {
2252         if (!sipdebug)
2253                 return 0;
2254         return sip_debug_test_addr(sip_real_dst(p));
2255 }
2256
2257 /*! \brief Return int representing a bit field of transport types found in const char *transport */
2258 static int get_transport_str2enum(const char *transport)
2259 {
2260         int res = 0;
2261
2262         if (ast_strlen_zero(transport)) {
2263                 return res;
2264         }
2265
2266         if (!strcasecmp(transport, "udp")) {
2267                 res |= SIP_TRANSPORT_UDP;
2268         }
2269         if (!strcasecmp(transport, "tcp")) {
2270                 res |= SIP_TRANSPORT_TCP;
2271         }
2272         if (!strcasecmp(transport, "tls")) {
2273                 res |= SIP_TRANSPORT_TLS;
2274         }
2275
2276         return res;
2277 }
2278
2279 /*! \brief Return configuration of transports for a device */
2280 static inline const char *get_transport_list(unsigned int transports) {
2281         switch (transports) {
2282                 case SIP_TRANSPORT_UDP:
2283                         return "UDP";
2284                 case SIP_TRANSPORT_TCP:
2285                         return "TCP";
2286                 case SIP_TRANSPORT_TLS:
2287                         return "TLS";
2288                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TCP:
2289                         return "TCP,UDP";
2290                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TLS:
2291                         return "TLS,UDP";
2292                 case SIP_TRANSPORT_TCP | SIP_TRANSPORT_TLS:
2293                         return "TLS,TCP";
2294                 default:
2295                         return transports ?
2296                                 "TLS,TCP,UDP" : "UNKNOWN";      
2297         }
2298 }
2299
2300 /*! \brief Return transport as string */
2301 static inline const char *get_transport(enum sip_transport t)
2302 {
2303         switch (t) {
2304         case SIP_TRANSPORT_UDP:
2305                 return "UDP";
2306         case SIP_TRANSPORT_TCP:
2307                 return "TCP";
2308         case SIP_TRANSPORT_TLS:
2309                 return "TLS";
2310         }
2311
2312         return "UNKNOWN";
2313 }
2314
2315 /*! \brief Return transport of dialog.
2316         \note this is based on a false assumption. We don't always use the
2317         outbound proxy for all requests in a dialog. It depends on the
2318         "force" parameter. The FIRST request is always sent to the ob proxy.
2319         \todo Fix this function to work correctly
2320 */
2321 static inline const char *get_transport_pvt(struct sip_pvt *p)
2322 {
2323         if (p->outboundproxy && p->outboundproxy->transport) {
2324                 set_socket_transport(&p->socket, p->outboundproxy->transport);
2325         }
2326
2327         return get_transport(p->socket.type);
2328 }
2329
2330 /*! \brief Transmit SIP message
2331         Sends a SIP request or response on a given socket (in the pvt)
2332         Called by retrans_pkt, send_request, send_response and
2333         __sip_reliable_xmit
2334         \return length of transmitted message, XMIT_ERROR on known network failures -1 on other failures.
2335 */
2336 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len)
2337 {
2338         int res = 0;
2339         const struct sockaddr_in *dst = sip_real_dst(p);
2340
2341         ast_debug(2, "Trying to put '%.11s' onto %s socket destined for %s:%d\n", data->str, get_transport_pvt(p), ast_inet_ntoa(dst->sin_addr), htons(dst->sin_port));
2342
2343         if (sip_prepare_socket(p) < 0)
2344                 return XMIT_ERROR;
2345
2346         if (p->socket.type == SIP_TRANSPORT_UDP) {
2347                 res = sendto(p->socket.fd, data->str, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
2348         } else if (p->socket.tcptls_session) {
2349                 res = sip_tcptls_write(p->socket.tcptls_session, data->str, len);
2350         } else {
2351                 ast_debug(2, "Socket type is TCP but no tcptls_session is present to write to\n");
2352                 return XMIT_ERROR;
2353         }
2354
2355         if (res == -1) {
2356                 switch (errno) {
2357                 case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
2358                 case EHOSTUNREACH:      /* Host can't be reached */
2359                 case ENETDOWN:          /* Interface down */
2360                 case ENETUNREACH:       /* Network failure */
2361                 case ECONNREFUSED:      /* ICMP port unreachable */
2362                         res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
2363                 }
2364         }
2365         if (res != len)
2366                 ast_log(LOG_WARNING, "sip_xmit of %p (len %d) to %s:%d returned %d: %s\n", data, len, ast_inet_ntoa(dst->sin_addr), ntohs(dst->sin_port), res, strerror(errno));
2367
2368         return res;
2369 }
2370
2371 /*! \brief Build a Via header for a request */
2372 static void build_via(struct sip_pvt *p)
2373 {
2374         /* Work around buggy UNIDEN UIP200 firmware */
2375         const char *rport = (ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) || ast_test_flag(&p->flags[0], SIP_NAT_RPORT_PRESENT)) ? ";rport" : "";
2376
2377         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
2378         snprintf(p->via, sizeof(p->via), "SIP/2.0/%s %s:%d;branch=z9hG4bK%08x%s",
2379                  get_transport_pvt(p),
2380                  ast_inet_ntoa(p->ourip.sin_addr),
2381                  ntohs(p->ourip.sin_port), (int) p->branch, rport);
2382 }
2383
2384 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
2385  *
2386  * Using the localaddr structure built up with localnet statements in sip.conf
2387  * apply it to their address to see if we need to substitute our
2388  * externip or can get away with our internal bindaddr
2389  * 'us' is always overwritten.
2390  */
2391 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us, struct sip_pvt *p)
2392 {
2393         struct sockaddr_in theirs;
2394         /* Set want_remap to non-zero if we want to remap 'us' to an externally
2395          * reachable IP address and port. This is done if:
2396          * 1. we have a localaddr list (containing 'internal' addresses marked
2397          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
2398          *    and AST_SENSE_ALLOW on 'external' ones);
2399          * 2. either stunaddr or externip is set, so we know what to use as the
2400          *    externally visible address;
2401          * 3. the remote address, 'them', is external;
2402          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
2403          *    when passed to ast_apply_ha() so it does need to be remapped.
2404          *    This fourth condition is checked later.
2405          */
2406         int want_remap;
2407
2408         *us = internip;         /* starting guess for the internal address */
2409         /* now ask the system what would it use to talk to 'them' */
2410         ast_ouraddrfor(them, &us->sin_addr);
2411         theirs.sin_addr = *them;
2412
2413         want_remap = localaddr &&
2414                 (externip.sin_addr.s_addr || stunaddr.sin_addr.s_addr) &&
2415                 ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
2416
2417         if (want_remap &&
2418             (!sip_cfg.matchexterniplocally || !ast_apply_ha(localaddr, us)) ) {
2419                 /* if we used externhost or stun, see if it is time to refresh the info */
2420                 if (externexpire && time(NULL) >= externexpire) {
2421                         if (stunaddr.sin_addr.s_addr) {
2422                                 ast_stun_request(sipsock, &stunaddr, NULL, &externip);
2423                         } else {
2424                                 if (ast_parse_arg(externhost, PARSE_INADDR, &externip))
2425                                         ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
2426                         }
2427                         externexpire = time(NULL) + externrefresh;
2428                 }
2429                 if (externip.sin_addr.s_addr) {
2430                         *us = externip;
2431                         switch (p->socket.type) {
2432                         case SIP_TRANSPORT_TCP:
2433                                 us->sin_port = htons(externtcpport);
2434                                 break;
2435                         case SIP_TRANSPORT_TLS:
2436                                 us->sin_port = htons(externtlsport);
2437                                 break;
2438                         case SIP_TRANSPORT_UDP:
2439                                 break; /* fall through */
2440                         default:
2441                                 us->sin_port = htons(STANDARD_SIP_PORT); /* we should never get here */
2442                         }
2443                 }
2444                 else
2445                         ast_log(LOG_WARNING, "stun failed\n");
2446                 ast_debug(1, "Target address %s is not local, substituting externip\n",
2447                         ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
2448         } else if (p) {
2449                 /* no remapping, but we bind to a specific address, so use it. */
2450                 switch (p->socket.type) {
2451                 case SIP_TRANSPORT_TCP:
2452                         if (sip_tcp_desc.local_address.sin_addr.s_addr) {
2453                                 *us = sip_tcp_desc.local_address;
2454                         } else {
2455                                 us->sin_port = sip_tcp_desc.local_address.sin_port;
2456                         }
2457                         break;
2458                 case SIP_TRANSPORT_TLS:
2459                         if (sip_tls_desc.local_address.sin_addr.s_addr) {
2460                                 *us = sip_tls_desc.local_address;
2461                         } else {
2462                                 us->sin_port = sip_tls_desc.local_address.sin_port;
2463                         }
2464                                 break;
2465                 case SIP_TRANSPORT_UDP:
2466                         /* fall through on purpose */
2467                 default:
2468                         if (bindaddr.sin_addr.s_addr) {
2469                                 *us = bindaddr;
2470                         }
2471                 }
2472         } else if (bindaddr.sin_addr.s_addr) {
2473                 *us = bindaddr;
2474         }
2475         ast_debug(3, "Setting SIP_TRANSPORT_%s with address %s:%d\n", get_transport(p->socket.type), ast_inet_ntoa(us->sin_addr), ntohs(us->sin_port));
2476 }
2477
2478 /*! \brief Append to SIP dialog history with arg list  */
2479 static __attribute__((format(printf, 2, 0))) void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
2480 {
2481         char buf[80], *c = buf; /* max history length */
2482         struct sip_history *hist;
2483         int l;
2484
2485         vsnprintf(buf, sizeof(buf), fmt, ap);
2486         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
2487         l = strlen(buf) + 1;
2488         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
2489                 return;
2490         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
2491                 ast_free(hist);
2492                 return;
2493         }
2494         memcpy(hist->event, buf, l);
2495         if (p->history_entries == MAX_HISTORY_ENTRIES) {
2496                 struct sip_history *oldest;
2497                 oldest = AST_LIST_REMOVE_HEAD(p->history, list);
2498                 p->history_entries--;
2499                 ast_free(oldest);
2500         }
2501         AST_LIST_INSERT_TAIL(p->history, hist, list);
2502         p->history_entries++;
2503 }
2504
2505 /*! \brief Append to SIP dialog history with arg list  */
2506 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2507 {
2508         va_list ap;
2509
2510         if (!p)
2511                 return;
2512
2513         if (!p->do_history && !recordhistory && !dumphistory)
2514                 return;
2515
2516         va_start(ap, fmt);
2517         append_history_va(p, fmt, ap);
2518         va_end(ap);
2519
2520         return;
2521 }
2522
2523 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
2524 static int retrans_pkt(const void *data)
2525 {
2526         struct sip_pkt *pkt = (struct sip_pkt *)data, *prev, *cur = NULL;
2527         int reschedule = DEFAULT_RETRANS;
2528         int xmitres = 0;
2529         
2530         /* Lock channel PVT */
2531         sip_pvt_lock(pkt->owner);
2532
2533         if (pkt->retrans < MAX_RETRANS) {
2534                 pkt->retrans++;
2535                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
2536                         if (sipdebug)
2537                                 ast_debug(4, "SIP TIMER: Not rescheduling id #%d:%s (Method %d) (No timer T1)\n", pkt->retransid, sip_methods[pkt->method].text, pkt->method);
2538                 } else {
2539                         int siptimer_a;
2540
2541                         if (sipdebug)
2542                                 ast_debug(4, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
2543                         if (!pkt->timer_a)
2544                                 pkt->timer_a = 2 ;
2545                         else
2546                                 pkt->timer_a = 2 * pkt->timer_a;
2547
2548                         /* For non-invites, a maximum of 4 secs */
2549                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
2550                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
2551                                 siptimer_a = 4000;
2552                 
2553                         /* Reschedule re-transmit */
2554                         reschedule = siptimer_a;
2555                         ast_debug(4, "** SIP timers: Rescheduling retransmission %d to %d ms (t1 %d ms (Retrans id #%d)) \n", pkt->retrans +1, siptimer_a, pkt->timer_t1, pkt->retransid);
2556                 }
2557
2558                 if (sip_debug_test_pvt(pkt->owner)) {
2559                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
2560                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
2561                                 pkt->retrans, sip_nat_mode(pkt->owner),
2562                                 ast_inet_ntoa(dst->sin_addr),
2563                                 ntohs(dst->sin_port), pkt->data->str);
2564                 }
2565
2566                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data->str);
2567                 xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
2568                 sip_pvt_unlock(pkt->owner);
2569                 if (xmitres == XMIT_ERROR)
2570                         ast_log(LOG_WARNING, "Network error on retransmit in dialog %s\n", pkt->owner->callid);
2571                 else
2572                         return  reschedule;
2573         }
2574         /* Too many retries */
2575         if (pkt->owner && pkt->method != SIP_OPTIONS && xmitres == 0) {
2576                 if (pkt->is_fatal || sipdebug)  /* Tell us if it's critical or if we're debugging */
2577                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s) -- See doc/sip-retransmit.txt.\n",
2578                                 pkt->owner->callid, pkt->seqno,
2579                                 pkt->is_fatal ? "Critical" : "Non-critical", pkt->is_resp ? "Response" : "Request");
2580         } else if (pkt->method == SIP_OPTIONS && sipdebug) {
2581                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s)  -- See doc/sip-retransmit.txt.\n", pkt->owner->callid);
2582
2583         }
2584         if (xmitres == XMIT_ERROR) {
2585                 ast_log(LOG_WARNING, "Transmit error :: Cancelling transmission on Call ID %s\n", pkt->owner->callid);
2586                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2587         } else
2588                 append_history(pkt->owner, "MaxRetries", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2589                 
2590         pkt->retransid = -1;
2591
2592         if (pkt->is_fatal) {
2593                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
2594                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
2595                         usleep(1);
2596                         sip_pvt_lock(pkt->owner);
2597                 }
2598
2599                 if (pkt->owner->owner && !pkt->owner->owner->hangupcause)
2600                         pkt->owner->owner->hangupcause = AST_CAUSE_NO_USER_RESPONSE;
2601                 
2602                 if (pkt->owner->owner) {
2603                         sip_alreadygone(pkt->owner);
2604                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet (see doc/sip-retransmit.txt).\n", pkt->owner->callid);
2605                         ast_queue_hangup_with_cause(pkt->owner->owner, AST_CAUSE_PROTOCOL_ERROR);
2606                         ast_channel_unlock(pkt->owner->owner);
2607                 } else {
2608                         /* If no channel owner, destroy now */
2609
2610                         /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
2611                         if (pkt->method != SIP_OPTIONS && pkt->method != SIP_REGISTER) {
2612                                 pvt_set_needdestroy(pkt->owner, "no response to critical packet");
2613                                 sip_alreadygone(pkt->owner);
2614                                 append_history(pkt->owner, "DialogKill", "Killing this failed dialog immediately");
2615                         }
2616                 }
2617         }
2618
2619         if (pkt->method == SIP_BYE) {
2620                 /* We're not getting answers on SIP BYE's.  Tear down the call anyway. */
2621                 if (pkt->owner->owner)
2622                         ast_channel_unlock(pkt->owner->owner);
2623                 append_history(pkt->owner, "ByeFailure", "Remote peer doesn't respond to bye. Destroying call anyway.");
2624                 pvt_set_needdestroy(pkt->owner, "no response to BYE");
2625         }
2626
2627         /* Remove the packet */
2628         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
2629                 if (cur == pkt) {
2630                         UNLINK(cur, pkt->owner->packets, prev);
2631                         sip_pvt_unlock(pkt->owner);
2632                         if (pkt->owner)
2633                                 pkt->owner = dialog_unref(pkt->owner,"pkt is being freed, its dialog ref is dead now");
2634                         if (pkt->data)
2635                                 ast_free(pkt->data);
2636                         pkt->data = NULL;
2637                         ast_free(pkt);
2638                         return 0;
2639                 }
2640         }
2641         /* error case */
2642         ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
2643         sip_pvt_unlock(pkt->owner);
2644         return 0;
2645 }
2646
2647 /*! \brief Transmit packet with retransmits
2648         \return 0 on success, -1 on failure to allocate packet
2649 */
2650 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod)
2651 {
2652         struct sip_pkt *pkt = NULL;
2653         int siptimer_a = DEFAULT_RETRANS;
2654         int xmitres = 0;
2655         int respid;
2656
2657         if (sipmethod == SIP_INVITE) {
2658                 /* Note this is a pending invite */
2659                 p->pendinginvite = seqno;
2660         }
2661
2662         /* If the transport is something reliable (TCP or TLS) then don't really send this reliably */
2663         /* I removed the code from retrans_pkt that does the same thing so it doesn't get loaded into the scheduler */
2664         /*! \todo According to the RFC some packets need to be retransmitted even if its TCP, so this needs to get revisited */
2665         if (!(p->socket.type & SIP_TRANSPORT_UDP)) {
2666                 xmitres = __sip_xmit(p, data, len);     /* Send packet */
2667                 if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2668                         append_history(p, "XmitErr", "%s", fatal ? "(Critical)" : "(Non-critical)");
2669                         return AST_FAILURE;
2670                 } else {
2671                         return AST_SUCCESS;
2672                 }
2673         }
2674
2675         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
2676                 return AST_FAILURE;
2677         /* copy data, add a terminator and save length */
2678         if (!(pkt->data = ast_str_create(len))) {
2679                 ast_free(pkt);
2680                 return AST_FAILURE;
2681         }
2682         ast_str_set(&pkt->data, 0, "%s%s", data->str, "\0");
2683         pkt->packetlen = len;
2684         /* copy other parameters from the caller */
2685         pkt->method = sipmethod;
2686         pkt->seqno = seqno;
2687         pkt->is_resp = resp;
2688         pkt->is_fatal = fatal;
2689         pkt->owner = dialog_ref(p, "__sip_reliable_xmit: setting pkt->owner");
2690         pkt->next = p->packets;
2691         p->packets = pkt;       /* Add it to the queue */
2692         if (resp) {
2693                 /* Parse out the response code */
2694                 if (sscanf(ast_str_buffer(pkt->data), "SIP/2.0 %30u", &respid) == 1) {
2695                         pkt->response_code = respid;
2696                 }
2697         }
2698         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
2699         pkt->retransid = -1;
2700         if (pkt->timer_t1)
2701                 siptimer_a = pkt->timer_t1 * 2;
2702
2703         /* Schedule retransmission */
2704         AST_SCHED_REPLACE_VARIABLE(pkt->retransid, sched, siptimer_a, retrans_pkt, pkt, 1);
2705         if (sipdebug)
2706                 ast_debug(4, "*** SIP TIMER: Initializing retransmit timer on packet: Id  #%d\n", pkt->retransid);
2707
2708         xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);    /* Send packet */
2709
2710         if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2711                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2712                 ast_log(LOG_ERROR, "Serious Network Trouble; __sip_xmit returns error for pkt data\n");
2713                 AST_SCHED_DEL(sched, pkt->retransid);
2714                 p->packets = pkt->next;
2715                 pkt->owner = dialog_unref(pkt->owner,"pkt is being freed, its dialog ref is dead now");
2716                 ast_free(pkt->data);
2717                 ast_free(pkt);
2718                 return AST_FAILURE;
2719         } else {
2720                 return AST_SUCCESS;
2721         }
2722 }
2723
2724 /*! \brief Kill a SIP dialog (called only by the scheduler)
2725  * The scheduler has a reference to this dialog when p->autokillid != -1,
2726  * and we are called using that reference. So if the event is not
2727  * rescheduled, we need to call dialog_unref().
2728  */
2729 static int __sip_autodestruct(const void *data)
2730 {
2731         struct sip_pvt *p = (struct sip_pvt *)data;
2732
2733         /* If this is a subscription, tell the phone that we got a timeout */
2734         if (p->subscribed) {
2735                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE);   /* Send last notification */
2736                 p->subscribed = NONE;
2737                 append_history(p, "Subscribestatus", "timeout");
2738                 ast_debug(3, "Re-scheduled destruction of SIP subscription %s\n", p->callid ? p->callid : "<unknown>");
2739                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
2740         }
2741
2742         /* If there are packets still waiting for delivery, delay the destruction */
2743         if (p->packets) {
2744                 if (!p->needdestroy) {
2745                         char method_str[31];
2746                         ast_debug(3, "Re-scheduled destruction of SIP call %s\n", p->callid ? p->callid : "<unknown>");
2747                         append_history(p, "ReliableXmit", "timeout");
2748                         if (sscanf(p->lastmsg, "Tx: %30s", method_str) == 1 || sscanf(p->lastmsg, "Rx: %30s", method_str) == 1) {
2749                                 if (method_match(SIP_CANCEL, method_str) || method_match(SIP_BYE, method_str)) {
2750                                         pvt_set_needdestroy(p, "autodestruct");
2751                                 }
2752                         }
2753                         return 10000;
2754                 } else {
2755                         /* They've had their chance to respond. Time to bail */
2756                         __sip_pretend_ack(p);
2757                 }
2758         }
2759
2760         if (p->subscribed == MWI_NOTIFICATION) {
2761                 if (p->relatedpeer) {
2762                         p->relatedpeer = unref_peer(p->relatedpeer, "__sip_autodestruct: unref peer p->relatedpeer");   /* Remove link to peer. If it's realtime, make sure it's gone from memory) */
2763                 }
2764         }
2765
2766         /* Reset schedule ID */
2767         p->autokillid = -1;
2768
2769         if (p->owner) {
2770                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2771                 ast_queue_hangup_with_cause(p->owner, AST_CAUSE_PROTOCOL_ERROR);
2772         } else if (p->refer && !p->alreadygone) {
2773                 ast_debug(3, "Finally hanging up channel after transfer: %s\n", p->callid);
2774                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2775                 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2776                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2777         } else {
2778                 append_history(p, "AutoDestroy", "%s", p->callid);
2779                 ast_debug(3, "Auto destroying SIP dialog '%s'\n", p->callid);
2780                 dialog_unlink_all(p, TRUE, TRUE); /* once it's unlinked and unrefd everywhere, it'll be freed automagically */
2781                 /* dialog_unref(p, "unref dialog-- no other matching conditions"); -- unlink all now should finish off the dialog's references and free it. */
2782                 /* sip_destroy(p); */           /* Go ahead and destroy dialog. All attempts to recover is done */
2783                 /* sip_destroy also absorbs the reference */
2784         }
2785         dialog_unref(p, "The ref to a dialog passed to this sched callback is going out of scope; unref it.");
2786         return 0;
2787 }
2788
2789 /*! \brief Schedule destruction of SIP dialog */
2790 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2791 {
2792         if (ms < 0) {
2793                 if (p->timer_t1 == 0) {
2794                         p->timer_t1 = global_t1;        /* Set timer T1 if not set (RFC 3261) */
2795                 }
2796                 if (p->timer_b == 0) {
2797                         p->timer_b = global_timer_b;  /* Set timer B if not set (RFC 3261) */
2798                 }
2799                 ms = p->timer_t1 * 64;
2800         }
2801         if (sip_debug_test_pvt(p))
2802                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2803         if (sip_cancel_destroy(p))
2804                 ast_log(LOG_WARNING, "Unable to cancel SIP destruction.  Expect bad things.\n");
2805
2806         if (p->do_history)
2807                 append_history(p, "SchedDestroy", "%d ms", ms);
2808         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, dialog_ref(p, "setting ref as passing into ast_sched_add for __sip_autodestruct"));
2809
2810         if (p->stimer && p->stimer->st_active == TRUE && p->stimer->st_schedid > 0)
2811                 stop_session_timer(p);
2812 }
2813
2814 /*! \brief Cancel destruction of SIP dialog.
2815  * Be careful as this also absorbs the reference - if you call it
2816  * from within the scheduler, this might be the last reference.
2817  */
2818 static int sip_cancel_destroy(struct sip_pvt *p)
2819 {
2820         int res = 0;
2821         if (p->autokillid > -1) {
2822                 int res3;
2823
2824                 if (!(res3 = ast_sched_del(sched, p->autokillid))) {
2825                         append_history(p, "CancelDestroy", "");
2826                         p->autokillid = -1;
2827                         dialog_unref(p, "dialog unrefd because autokillid is de-sched'd");
2828                 }
2829         }
2830         return res;
2831 }
2832
2833 /*! \brief Acknowledges receipt of a packet and stops retransmission
2834  * called with p locked*/
2835 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2836 {
2837         struct sip_pkt *cur, *prev = NULL;
2838         const char *msg = "Not Found";  /* used only for debugging */
2839         int res = FALSE;
2840
2841         /* If we have an outbound proxy for this dialog, then delete it now since
2842           the rest of the requests in this dialog needs to follow the routing.
2843           If obforcing is set, we will keep the outbound proxy during the whole
2844           dialog, regardless of what the SIP rfc says
2845         */
2846         if (p->outboundproxy && !p->outboundproxy->force){
2847                 ref_proxy(p, NULL);
2848         }
2849
2850         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2851                 if (cur->seqno != seqno || cur->is_resp != resp)
2852                         continue;
2853                 if (cur->is_resp || cur->method == sipmethod) {
2854                         res = TRUE;
2855                         msg = "Found";
2856                         if (!resp && (seqno == p->pendinginvite)) {
2857                                 ast_debug(1, "Acked pending invite %d\n", p->pendinginvite);
2858                                 p->pendinginvite = 0;
2859                         }
2860                         if (cur->retransid > -1) {
2861                                 if (sipdebug)
2862                                         ast_debug(4, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2863                         }
2864                         /* This odd section is designed to thwart a
2865                          * race condition in the packet scheduler. There are
2866                          * two conditions under which deleting the packet from the
2867                          * scheduler can fail.
2868                          *
2869                          * 1. The packet has been removed from the scheduler because retransmission
2870                          * is being attempted. The problem is that if the packet is currently attempting
2871                          * retransmission and we are at this point in the code, then that MUST mean
2872                          * that retrans_pkt is waiting on p's lock. Therefore we will relinquish the
2873                          * lock temporarily to allow retransmission.
2874                          *
2875                          * 2. The packet has reached its maximum number of retransmissions and has
2876                          * been permanently removed from the packet scheduler. If this is the case, then
2877                          * the packet's retransid will be set to -1. The atomicity of the setting and checking
2878                          * of the retransid to -1 is ensured since in both cases p's lock is held.
2879                          */
2880                         while (cur->retransid > -1 && ast_sched_del(sched, cur->retransid)) {
2881                                 sip_pvt_unlock(p);
2882                                 usleep(1);
2883                                 sip_pvt_lock(p);
2884                         }
2885                         UNLINK(cur, p->packets, prev);
2886                         dialog_unref(cur->owner, "unref pkt cur->owner dialog from sip ack before freeing pkt");
2887                         if (cur->data)
2888                                 ast_free(cur->data);
2889                         ast_free(cur);
2890                         break;
2891                 }
2892         }
2893         ast_debug(1, "Stopping retransmission on '%s' of %s %d: Match %s\n",
2894                 p->callid, resp ? "Response" : "Request", seqno, msg);
2895         return res;
2896 }
2897
2898 /*! \brief Pretend to ack all packets
2899  * called with p locked */
2900 static void __sip_pretend_ack(struct sip_pvt *p)
2901 {
2902         struct sip_pkt *cur = NULL;
2903
2904         while (p->packets) {
2905                 int method;
2906                 if (cur == p->packets) {
2907                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2908                         return;
2909                 }
2910                 cur = p->packets;
2911                 method = (cur->method) ? cur->method : find_sip_method(cur->data->str);
2912                 __sip_ack(p, cur->seqno, cur->is_resp, method);
2913         }
2914 }
2915
2916 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2917 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2918 {
2919         struct sip_pkt *cur;
2920         int res = FALSE;
2921
2922         for (cur = p->packets; cur; cur = cur->next) {
2923                 if (cur->seqno == seqno && cur->is_resp == resp &&
2924                         (cur->is_resp || method_match(sipmethod, cur->data->str))) {
2925                         /* this is our baby */
2926                         if (cur->retransid > -1) {
2927                                 if (sipdebug)
2928                                         ast_debug(4, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2929                         }
2930                         AST_SCHED_DEL(sched, cur->retransid);
2931                         res = TRUE;
2932                         break;
2933                 }
2934         }
2935         ast_debug(1, "(Provisional) Stopping retransmission (but retaining packet) on '%s' %s %d: %s\n", p->callid, resp ? "Response" : "Request", seqno, res == -1 ? "Not Found" : "Found");
2936         return res;
2937 }
2938
2939
2940 /*! \brief Copy SIP request, parse it */
2941 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2942 {
2943         copy_request(dst, src);
2944         parse_request(dst);
2945 }
2946
2947 /*! \brief add a blank line if no body */
2948 static void add_blank(struct sip_request *req)
2949 {
2950         if (!req->lines) {
2951                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2952                 ast_str_append(&req->data, 0, "\r\n");
2953                 req->len = ast_str_strlen(req->data);
2954         }
2955 }
2956
2957 static int send_provisional_keepalive_full(struct sip_pvt *pvt, int with_sdp)
2958 {
2959         const char *msg = NULL;
2960
2961         if (!pvt->last_provisional || !strncasecmp(pvt->last_provisional, "100", 3)) {
2962                 msg = "183 Session Progress";
2963         }
2964
2965         if (pvt->invitestate < INV_COMPLETED) {
2966                 if (with_sdp) {
2967                         transmit_response_with_sdp(pvt, S_OR(msg, pvt->last_provisional), &pvt->initreq, XMIT_UNRELIABLE, FALSE, FALSE);
2968                 } else {
2969                         transmit_response(pvt, S_OR(msg, pvt->last_provisional), &pvt->initreq);
2970                 }
2971                 return PROVIS_KEEPALIVE_TIMEOUT;
2972         }
2973
2974         return 0;
2975 }
2976
2977 static int send_provisional_keepalive(const void *data) {
2978         struct sip_pvt *pvt = (struct sip_pvt *) data;
2979
2980         return send_provisional_keepalive_full(pvt, 0);
2981 }
2982
2983 static int send_provisional_keepalive_with_sdp(const void *data) {
2984         struct sip_pvt *pvt = (void *)data;
2985
2986         return send_provisional_keepalive_full(pvt, 1);
2987 }
2988
2989 static void update_provisional_keepalive(struct sip_pvt *pvt, int with_sdp)
2990 {
2991         AST_SCHED_DEL_UNREF(sched, pvt->provisional_keepalive_sched_id, dialog_unref(pvt, "when you delete the provisional_keepalive_sched_id, you should dec the refcount for the stored dialog ptr"));
2992
2993         pvt->provisional_keepalive_sched_id = ast_sched_add(sched, PROVIS_KEEPALIVE_TIMEOUT,
2994                 with_sdp ? send_provisional_keepalive_with_sdp : send_provisional_keepalive, dialog_ref(pvt, "Increment refcount to pass dialog pointer to sched callback"));
2995 }
2996
2997 /*! \brief Transmit response on SIP request*/
2998 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2999 {
3000         int res;
3001
3002         add_blank(req);
3003         if (sip_debug_test_pvt(p)) {
3004                 const struct sockaddr_in *dst = sip_real_dst(p);
3005
3006                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
3007                         reliable ? "Reliably " : "", sip_nat_mode(p),
3008                         ast_inet_ntoa(dst->sin_addr),
3009                         ntohs(dst->sin_port), req->data->str);
3010         }
3011         if (p->do_history) {
3012                 struct sip_request tmp = { .rlPart1 = 0, };
3013                 parse_copy(&tmp, req);
3014                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data->str, get_header(&tmp, "CSeq"),
3015                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? REQ_OFFSET_TO_STR(&tmp, rlPart2) : sip_methods[tmp.method].text);
3016                 ast_free(tmp.data);
3017         }
3018
3019         /* If we are sending a final response to an INVITE, stop retransmitting provisional responses */
3020         if (p->initreq.method == SIP_INVITE && reliable == XMIT_CRITICAL) {
3021                 AST_SCHED_DEL_UNREF(sched, p->provisional_keepalive_sched_id, dialog_unref(p, "when you delete the provisional_keepalive_sched_id, you should dec the refcount for the stored dialog ptr"));
3022         }
3023
3024         res = (reliable) ?
3025                  __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
3026                 __sip_xmit(p, req->data, req->len);
3027         ast_free(req->data);
3028         req->data = NULL;
3029         if (res > 0)
3030                 return 0;
3031         return res;
3032 }
3033
3034 /*! \brief Send SIP Request to the other part of the dialogue 
3035         \return see \ref __sip_xmit
3036 */
3037 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
3038 {
3039         int res;
3040
3041         /* If we have an outbound proxy, reset peer address
3042                 Only do this once.
3043         */
3044         if (p->outboundproxy) {
3045                 p->sa = p->outboundproxy->ip;
3046         }
3047
3048         add_blank(req);
3049         if (sip_debug_test_pvt(p)) {
3050                 if (ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT))
3051                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->recv.sin_addr), ntohs(p->recv.sin_port), req->data->str);
3052                 else
3053                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->sa.sin_addr), ntohs(p->sa.sin_port), req->data->str);
3054         }
3055         if (p->do_history) {
3056                 struct sip_request tmp = { .rlPart1 = 0, };
3057                 parse_copy(&tmp, req);
3058                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data->str, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
3059                 ast_free(tmp.data);
3060         }
3061         res = (reliable) ?
3062                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
3063                 __sip_xmit(p, req->data, req->len);
3064         if (req->data) {
3065                 ast_free(req->data);
3066                 req->data = NULL;
3067         }
3068         return res;
3069 }
3070
3071 static void enable_dsp_detect(struct sip_pvt *p)
3072 {
3073         int features = 0;
3074
3075         if (p->dsp) {
3076                 return;
3077         }
3078
3079         if ((ast_test_flag(&p->flags[0], SIP_DTMF) == SIP_DTMF_INBAND) ||
3080             (ast_test_flag(&p->flags[0], SIP_DTMF) == SIP_DTMF_AUTO)) {
3081                 if (!p->rtp || ast_rtp_instance_dtmf_mode_set(p->rtp, AST_RTP_DTMF_MODE_INBAND)) {
3082                         features |= DSP_FEATURE_DIGIT_DETECT;
3083                 }
3084         }
3085
3086         if (ast_test_flag(&p->flags[1], SIP_PAGE2_FAX_DETECT)) {
3087                 features |= DSP_FEATURE_FAX_DETECT;
3088         }
3089
3090         if (!features) {
3091                 return;
3092         }
3093
3094         if (!(p->dsp = ast_dsp_new())) {
3095                 return;
3096         }
3097
3098         ast_dsp_set_features(p->dsp, features);
3099         if (global_relaxdtmf) {
3100                 ast_dsp_set_digitmode(p->dsp, DSP_DIGITMODE_DTMF | DSP_DIGITMODE_RELAXDTMF);
3101         }
3102 }
3103
3104 static void disable_dsp_detect(struct sip_pvt *p)
3105 {
3106         if (p->dsp) {
3107                 ast_dsp_free(p->dsp);
3108                 p->dsp = NULL;
3109         }
3110 }
3111
3112 /*! \brief Set an option on a SIP dialog */
3113 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen)
3114 {
3115         int res = -1;
3116         struct sip_pvt *p = chan->tech_pvt;
3117
3118         switch (option) {
3119         case AST_OPTION_FORMAT_READ:
3120                 res = ast_rtp_instance_set_read_format(p->rtp, *(int *) data);
3121                 break;
3122         case AST_OPTION_FORMAT_WRITE:
3123                 res = ast_rtp_instance_set_write_format(p->rtp, *(int *) data);
3124                 break;
3125         case AST_OPTION_MAKE_COMPATIBLE:
3126                 res = ast_rtp_instance_make_compatible(chan, p->rtp, (struct ast_channel *) data);
3127                 break;
3128         case AST_OPTION_DIGIT_DETECT:
3129                 if ((ast_test_flag(&p->flags[0], SIP_DTMF) == SIP_DTMF_INBAND) ||
3130                     (ast_test_flag(&p->flags[0], SIP_DTMF) == SIP_DTMF_AUTO)) {
3131                         char *cp = (char *) data;
3132
3133                         ast_debug(1, "%sabling digit detection on %s\n", *cp ? "En" : "Dis", chan->name);
3134                         if (*cp) {
3135                                 enable_dsp_detect(p);
3136                         } else {
3137                                 disable_dsp_detect(p);
3138                         }
3139                         res = 0;
3140                 }
3141                 break;
3142         default:
3143                 break;
3144         }
3145
3146         return res;
3147 }
3148
3149 /*! \brief Query an option on a SIP dialog */
3150 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen)
3151 {
3152         int res = -1;
3153         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
3154         struct sip_pvt *p = (struct sip_pvt *) chan->tech_pvt;
3155         char *cp;
3156
3157         switch (option) {
3158         case AST_OPTION_T38_STATE:
3159                 /* Make sure we got an ast_t38_state enum passed in */
3160                 if (*datalen != sizeof(enum ast_t38_state)) {
3161                         ast_log(LOG_ERROR, "Invalid datalen for AST_OPTION_T38_STATE option. Expected %d, got %d\n", (int)sizeof(enum ast_t38_state), *datalen);
3162                         return -1;
3163                 }
3164
3165                 sip_pvt_lock(p);
3166
3167                 /* Now if T38 support is enabled we need to look and see what the current state is to get what we want to report back */
3168                 if (ast_test_flag(&p->flags[1], SIP_PAGE2_T38SUPPORT)) {
3169                         switch (p->t38.state) {
3170                         case T38_LOCAL_REINVITE:
3171                         case T38_PEER_REINVITE:
3172                                 state = T38_STATE_NEGOTIATING;
3173                                 break;
3174                         case T38_ENABLED:
3175                                 state = T38_STATE_NEGOTIATED;
3176                                 break;
3177                         default:
3178                                 state = T38_STATE_UNKNOWN;
3179                         }
3180                 }
3181
3182                 sip_pvt_unlock(p);
3183
3184                 *((enum ast_t38_state *) data) = state;
3185                 res = 0;
3186
3187                 break;
3188         case AST_OPTION_DIGIT_DETECT:
3189                 cp = (char *) data;
3190                 *cp = p->dsp ? 1 : 0;
3191                 ast_debug(1, "Reporting digit detection %sabled on %s\n", *cp ? "en" : "dis", chan->name);
3192                 break;
3193         default:
3194                 break;
3195         }
3196
3197         return res;
3198 }
3199
3200 /*! \brief Locate closing quote in a string, skipping escaped quotes.
3201  * optionally with a limit on the search.
3202  * start must be past the first quote.
3203  */
3204 const char *find_closing_quote(const char *start, const char *lim)
3205 {
3206         char last_char = '\0';
3207         const char *s;
3208         for (s = start; *s && s != lim; last_char = *s++) {
3209                 if (*s == '"' && last_char != '\\')
3210                         break;
3211         }
3212         return s;
3213 }
3214
3215 /*! \brief Send message with Access-URL header, if this is an HTML URL only! */
3216 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen)
3217 {
3218         struct sip_pvt *p = chan->tech_pvt;
3219
3220         if (subclass != AST_HTML_URL)
3221                 return -1;
3222
3223         ast_string_field_build(p, url, "<%s>;mode=active", data);
3224
3225         if (sip_debug_test_pvt(p))
3226                 ast_debug(1, "Send URL %s, state = %d!\n", data, chan->_state);
3227
3228         switch (chan->_state) {
3229         case AST_STATE_RING:
3230                 transmit_response(p, "100 Trying", &p->initreq);
3231                 break;
3232         case AST_STATE_RINGING:
3233                 transmit_response(p, "180 Ringing", &p->initreq);
3234                 break;
3235         case AST_STATE_UP:
3236                 if (!p->pendinginvite) {                /* We are up, and have no outstanding invite */
3237                         transmit_reinvite_with_sdp(p, FALSE, FALSE);
3238                 } else if (!ast_test_flag(&p->flags[0], SIP_PENDINGBYE)) {
3239                         ast_set_flag(&p->flags[0], SIP_NEEDREINVITE);   
3240                 }       
3241                 break;
3242         default:
3243                 ast_log(LOG_WARNING, "Don't know how to send URI when state is %d!\n", chan->_state);
3244         }
3245
3246         return 0;
3247 }
3248
3249 /*! \brief Deliver SIP call ID for the call */
3250 static const char *sip_get_callid(struct ast_channel *chan)
3251 {
3252         return chan->tech_pvt ? ((struct sip_pvt *) chan->tech_pvt)->callid : "";
3253 }
3254
3255 /*! \brief Send SIP MESSAGE text within a call
3256         Called from PBX core sendtext() application */
3257 static int sip_sendtext(struct ast_channel *ast, const char *text)
3258 {
3259         struct sip_pvt *dialog = ast->tech_pvt;
3260         int debug = sip_debug_test_pvt(dialog);
3261
3262         if (!dialog)
3263                 return -1;
3264         /* NOT ast_strlen_zero, because a zero-length message is specifically
3265          * allowed by RFC 3428 (See section 10, Examples) */
3266         if (!text)
3267                 return 0;
3268         if(!is_method_allowed(&dialog->allowed_methods, SIP_MESSAGE)) {
3269                 ast_debug(2, "Trying to send MESSAGE to device that does not support it.\n");
3270                 return(0);
3271         }
3272         if (debug)
3273                 ast_verbose("Sending text %s on %s\n", text, ast->name);
3274         transmit_message_with_text(dialog, text);
3275         return 0;       
3276 }
3277
3278 /*! \brief Update peer object in realtime storage
3279         If the Asterisk system name is set in asterisk.conf, we will use
3280         that name and store that in the "regserver" field in the sippeers
3281         table to facilitate multi-server setups.
3282 */
3283 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *defaultuser, const char *fullcontact, const char *useragent, int expirey, unsigned short deprecated_username, int lastms)
3284 {
3285         char port[10];
3286         char ipaddr[INET_ADDRSTRLEN];
3287         char regseconds[20];
3288         char *tablename = NULL;
3289         char str_lastms[20];
3290
3291         const char *sysname = ast_config_AST_SYSTEM_NAME;
3292         char *syslabel = NULL;
3293
3294         time_t nowtime = time(NULL) + expirey;
3295         const char *fc = fullcontact ? "fullcontact" : NULL;
3296
3297         int realtimeregs = ast_check_realtime("sipregs");
3298
3299         tablename = realtimeregs ? "sipregs" : "sippeers";
3300         
3301
3302         snprintf(str_lastms, sizeof(str_lastms), "%d", lastms);
3303         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
3304         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
3305         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
3306         
3307         if (ast_strlen_zero(sysname))   /* No system name, disable this */
3308                 sysname = NULL;
3309         else if (sip_cfg.rtsave_sysname)
3310                 syslabel = "regserver";
3311
3312         if (fc) {
3313                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
3314                         "port", port, "regseconds", regseconds,
3315                         deprecated_username ? "username" : "defaultuser", defaultuser,
3316                         "useragent", useragent, "lastms", str_lastms,
3317                         fc, fullcontact, syslabel, sysname, SENTINEL); /* note fc and syslabel _can_ be NULL */
3318         } else {
3319                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
3320                         "port", port, "regseconds", regseconds,
3321                         "useragent", useragent, "lastms", str_lastms,
3322                         deprecated_username ? "username" : "defaultuser", defaultuser,
3323                         syslabel, sysname, SENTINEL); /* note syslabel _can_ be NULL */
3324         }
3325 }
3326
3327 /*! \brief Automatically add peer extension to dial plan */
3328 static void register_peer_exten(struct sip_peer *peer, int onoff)
3329 {
3330         char multi[256];
3331         char *stringp, *ext, *context;
3332         struct pbx_find_info q = { .stacklen = 0 };
3333
3334         /* XXX note that sip_cfg.regcontext is both a global 'enable' flag and
3335          * the name of the global regexten context, if not specified
3336          * individually.
3337          */
3338         if (ast_strlen_zero(sip_cfg.regcontext))
3339                 return;
3340
3341         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
3342         stringp = multi;
3343         while ((ext = strsep(&stringp, "&"))) {
3344                 if ((context = strchr(ext, '@'))) {
3345                         *context++ = '\0';      /* split ext@context */
3346                         if (!ast_context_find(context)) {
3347                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
3348                                 continue;
3349                         }
3350                 } else {
3351                         context = sip_cfg.regcontext;
3352                 }
3353                 if (onoff) {
3354                         if (!ast_exists_extension(NULL, context, ext, 1, NULL)) {
3355                                 ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
3356                                          ast_strdup(peer->name), ast_free_ptr, "SIP");
3357                         }
3358                 } else if (pbx_find_extension(NULL, NULL, &q, context, ext, 1, NULL, "", E_MATCH)) {
3359                         ast_context_remove_extension(context, ext, 1, NULL);
3360                 }
3361         }
3362 }
3363
3364 /*! Destroy mailbox subscriptions */
3365 static void destroy_mailbox(struct sip_mailbox *mailbox)
3366 {
3367         if (mailbox->mailbox)
3368                 ast_free(mailbox->mailbox);
3369         if (mailbox->context)
3370                 ast_free(mailbox->context);
3371         if (mailbox->event_sub)
3372                 ast_event_unsubscribe(mailbox->event_sub);
3373         ast_free(mailbox);
3374 }
3375
3376 /*! Destroy all peer-related mailbox subscriptions */
3377 static void clear_peer_mailboxes(struct sip_peer *peer)
3378 {
3379         struct sip_mailbox *mailbox;
3380
3381         while ((mailbox = AST_LIST_REMOVE_HEAD(&peer->mailboxes, entry)))
3382                 destroy_mailbox(mailbox);
3383 }
3384
3385 static void sip_destroy_peer_fn(void *peer)
3386 {
3387         sip_destroy_peer(peer);
3388 }
3389
3390 /*! \brief Destroy peer object from memory */
3391 static void sip_destroy_peer(struct sip_peer *peer)
3392 {
3393         ast_debug(3, "Destroying SIP peer %s\n", peer->name);
3394         if (peer->outboundproxy)
3395                 ao2_ref(peer->outboundproxy, -1);
3396         peer->outboundproxy = NULL;
3397
3398         /* Delete it, it needs to disappear */
3399         if (peer->call) {
3400                 dialog_unlink_all(peer->call, TRUE, TRUE);
3401                 peer->call = dialog_unref(peer->call, "peer->call is being unset");
3402         }
3403         
3404
3405         if (peer->mwipvt) {     /* We have an active subscription, delete it */
3406                 dialog_unlink_all(peer->mwipvt, TRUE, TRUE);
3407                 peer->mwipvt = dialog_unref(peer->mwipvt, "unreffing peer->mwipvt");
3408         }
3409         
3410         if (peer->chanvars) {
3411                 ast_variables_destroy(peer->chanvars);
3412                 peer->chanvars = NULL;
3413         }
3414         
3415         register_peer_exten(peer, FALSE);
3416         ast_free_ha(peer->ha);
3417         if (peer->selfdestruct)
3418                 ast_atomic_fetchadd_int(&apeerobjs, -1);
3419         else if (peer->is_realtime) {
3420                 ast_atomic_fetchadd_int(&rpeerobjs, -1);
3421                 ast_debug(3, "-REALTIME- peer Destroyed. Name: %s. Realtime Peer objects: %d\n", peer->name, rpeerobjs);
3422         } else
3423                 ast_atomic_fetchadd_int(&speerobjs, -1);
3424         clear_realm_authentication(peer->auth);
3425         peer->auth = NULL;
3426         if (peer->dnsmgr)
3427                 ast_dnsmgr_release(peer->dnsmgr);
3428         clear_peer_mailboxes(peer);
3429
3430         if (peer->socket.tcptls_session) {
3431                 ao2_ref(peer->socket.tcptls_session, -1);
3432                 peer->socket.tcptls_session = NULL;
3433         }
3434
3435         ast_string_field_free_memory(peer);
3436 }
3437
3438 /*! \brief Update peer data in database (if used) */
3439 static void update_peer(struct sip_peer *p, int expire)
3440 {
3441         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
3442         if (sip_cfg.peer_rtupdate &&
3443             (p->is_realtime || rtcachefriends)) {
3444                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, p->useragent, expire, p->deprecated_username, p->lastms);
3445         }
3446 }
3447
3448 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *cfg)
3449 {
3450         struct ast_variable *var = NULL;
3451         struct ast_flags flags = {0};
3452         char *cat = NULL;
3453         const char *insecure;
3454         while ((cat = ast_category_browse(cfg, cat))) {
3455                 insecure = ast_variable_retrieve(cfg, cat, "insecure");
3456                 set_insecure_flags(&flags, insecure, -1);
3457                 if (ast_test_flag(&flags, SIP_INSECURE_PORT)) {
3458                         var = ast_category_root(cfg, cat);
3459                         break;
3460                 }
3461         }
3462         return var;
3463 }
3464
3465 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername)
3466 {
3467         struct ast_variable *tmp;
3468         for (tmp = var; tmp; tmp = tmp->next) {
3469                 if (!newpeername && !strcasecmp(tmp->name, "name"))
3470                         newpeername = tmp->value;
3471         }
3472         return newpeername;
3473 }
3474
3475 /*! \brief  realtime_peer: Get peer from realtime storage
3476  * Checks the "sippeers" realtime family from extconfig.conf
3477  * Checks the "sipregs" realtime family from extconfig.conf if it's configured.
3478  * This returns a pointer to a peer and because we use build_peer, we can rest
3479  * assured that the refcount is bumped.
3480 */
3481 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin, int devstate_only)
3482 {
3483         struct sip_peer *peer;
3484         struct ast_variable *var = NULL;
3485         struct ast_variable *varregs = NULL;
3486         struct ast_variable *tmp;
3487         struct ast_config *peerlist = NULL;
3488         char ipaddr[INET_ADDRSTRLEN];
3489         char portstring[6]; /*up to 5 digits plus null terminator*/
3490         char *cat = NULL;
3491         unsigned short portnum;
3492         int realtimeregs = ast_check_realtime("sipregs");
3493
3494         /* First check on peer name */
3495         if (newpeername) {
3496                 if (realtimeregs)