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