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