chan_sip: Add dialplan function SIP_HEADERS
[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                 <see-also>
384                         <ref type="function">SIP_HEADERS</ref>
385                 </see-also>
386         </function>
387         <function name="SIP_HEADERS" language="en_US">
388                 <synopsis>
389                         Gets the list of SIP header names from an incoming INVITE message.
390                 </synopsis>
391                 <syntax>
392                         <parameter name="prefix">
393                                 <para>If specified, only the headers matching the given prefix are returned.</para>
394                         </parameter>
395                 </syntax>
396                 <description>
397                         <para>Returns a comma-separated list of header names (without values) from the
398                         INVITE message that originated the current channel. Multiple headers with the
399                         same name are included in the list only once. The returned list can be iterated
400                         over using the functions POP() and SIP_HEADER().</para>
401                         <para>For example, <literal>${SIP_HEADERS(Co)}</literal> might return
402                         <literal>Contact,Content-Length,Content-Type</literal>. As a practical example,
403                         you may use <literal>${SIP_HEADERS(X-)}</literal> to enumerate optional extended
404                         headers.</para>
405                         <para>This function does not access headers from the incoming SIP REFER message;
406                         see the documentation of the function SIP_HEADER for how to access them.</para>
407                         <para>Please observe that contents of the SDP (an attachment to the
408                         SIP request) can't be accessed with this function.</para>
409                 </description>
410                 <see-also>
411                         <ref type="function">SIP_HEADER</ref>
412                         <ref type="function">POP</ref>
413                 </see-also>
414         </function>
415         <function name="SIPPEER" language="en_US">
416                 <synopsis>
417                         Gets SIP peer information.
418                 </synopsis>
419                 <syntax>
420                         <parameter name="peername" required="true" />
421                         <parameter name="item">
422                                 <enumlist>
423                                         <enum name="ip">
424                                                 <para>(default) The IP address.</para>
425                                         </enum>
426                                         <enum name="port">
427                                                 <para>The port number.</para>
428                                         </enum>
429                                         <enum name="mailbox">
430                                                 <para>The configured mailbox.</para>
431                                         </enum>
432                                         <enum name="context">
433                                                 <para>The configured context.</para>
434                                         </enum>
435                                         <enum name="expire">
436                                                 <para>The epoch time of the next expire.</para>
437                                         </enum>
438                                         <enum name="dynamic">
439                                                 <para>Is it dynamic? (yes/no).</para>
440                                         </enum>
441                                         <enum name="callerid_name">
442                                                 <para>The configured Caller ID name.</para>
443                                         </enum>
444                                         <enum name="callerid_num">
445                                                 <para>The configured Caller ID number.</para>
446                                         </enum>
447                                         <enum name="callgroup">
448                                                 <para>The configured Callgroup.</para>
449                                         </enum>
450                                         <enum name="pickupgroup">
451                                                 <para>The configured Pickupgroup.</para>
452                                         </enum>
453                                         <enum name="namedcallgroup">
454                                                 <para>The configured Named Callgroup.</para>
455                                         </enum>
456                                         <enum name="namedpickupgroup">
457                                                 <para>The configured Named Pickupgroup.</para>
458                                         </enum>
459                                         <enum name="codecs">
460                                                 <para>The configured codecs.</para>
461                                         </enum>
462                                         <enum name="status">
463                                                 <para>Status (if qualify=yes).</para>
464                                         </enum>
465                                         <enum name="regexten">
466                                                 <para>Extension activated at registration.</para>
467                                         </enum>
468                                         <enum name="limit">
469                                                 <para>Call limit (call-limit).</para>
470                                         </enum>
471                                         <enum name="busylevel">
472                                                 <para>Configured call level for signalling busy.</para>
473                                         </enum>
474                                         <enum name="curcalls">
475                                                 <para>Current amount of calls. Only available if call-limit is set.</para>
476                                         </enum>
477                                         <enum name="language">
478                                                 <para>Default language for peer.</para>
479                                         </enum>
480                                         <enum name="accountcode">
481                                                 <para>Account code for this peer.</para>
482                                         </enum>
483                                         <enum name="useragent">
484                                                 <para>Current user agent header used by peer.</para>
485                                         </enum>
486                                         <enum name="maxforwards">
487                                                 <para>The value used for SIP loop prevention in outbound requests</para>
488                                         </enum>
489                                         <enum name="chanvar[name]">
490                                                 <para>A channel variable configured with setvar for this peer.</para>
491                                         </enum>
492                                         <enum name="codec[x]">
493                                                 <para>Preferred codec index number <replaceable>x</replaceable> (beginning with zero).</para>
494                                         </enum>
495                                 </enumlist>
496                         </parameter>
497                 </syntax>
498                 <description></description>
499         </function>
500         <function name="CHECKSIPDOMAIN" language="en_US">
501                 <synopsis>
502                         Checks if domain is a local domain.
503                 </synopsis>
504                 <syntax>
505                         <parameter name="domain" required="true" />
506                 </syntax>
507                 <description>
508                         <para>This function checks if the <replaceable>domain</replaceable> in the argument is configured
509                         as a local SIP domain that this Asterisk server is configured to handle.
510                         Returns the domain name if it is locally handled, otherwise an empty string.
511                         Check the <literal>domain=</literal> configuration in <filename>sip.conf</filename>.</para>
512                 </description>
513         </function>
514         <manager name="SIPpeers" language="en_US">
515                 <synopsis>
516                         List SIP peers (text format).
517                 </synopsis>
518                 <syntax>
519                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
520                 </syntax>
521                 <description>
522                         <para>Lists SIP peers in text format with details on current status.
523                         <literal>Peerlist</literal> will follow as separate events, followed by a final event called
524                         <literal>PeerlistComplete</literal>.</para>
525                 </description>
526         </manager>
527         <manager name="SIPshowpeer" language="en_US">
528                 <synopsis>
529                         show SIP peer (text format).
530                 </synopsis>
531                 <syntax>
532                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
533                         <parameter name="Peer" required="true">
534                                 <para>The peer name you want to check.</para>
535                         </parameter>
536                 </syntax>
537                 <description>
538                         <para>Show one SIP peer with details on current status.</para>
539                 </description>
540         </manager>
541         <manager name="SIPqualifypeer" language="en_US">
542                 <synopsis>
543                         Qualify SIP peers.
544                 </synopsis>
545                 <syntax>
546                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
547                         <parameter name="Peer" required="true">
548                                 <para>The peer name you want to qualify.</para>
549                         </parameter>
550                 </syntax>
551                 <description>
552                         <para>Qualify a SIP peer.</para>
553                 </description>
554                 <see-also>
555                         <ref type="managerEvent">SIPQualifyPeerDone</ref>
556                 </see-also>
557         </manager>
558         <manager name="SIPshowregistry" language="en_US">
559                 <synopsis>
560                         Show SIP registrations (text format).
561                 </synopsis>
562                 <syntax>
563                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
564                 </syntax>
565                 <description>
566                         <para>Lists all registration requests and status. Registrations will follow as separate
567                         events followed by a final event called <literal>RegistrationsComplete</literal>.</para>
568                 </description>
569         </manager>
570         <manager name="SIPnotify" language="en_US">
571                 <synopsis>
572                         Send a SIP notify.
573                 </synopsis>
574                 <syntax>
575                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
576                         <parameter name="Channel" required="true">
577                                 <para>Peer to receive the notify.</para>
578                         </parameter>
579                         <parameter name="Variable" required="true">
580                                 <para>At least one variable pair must be specified.
581                                 <replaceable>name</replaceable>=<replaceable>value</replaceable></para>
582                         </parameter>
583                 </syntax>
584                 <description>
585                         <para>Sends a SIP Notify event.</para>
586                         <para>All parameters for this event must be specified in the body of this request
587                         via multiple <literal>Variable: name=value</literal> sequences.</para>
588                 </description>
589         </manager>
590         <manager name="SIPpeerstatus" language="en_US">
591                 <synopsis>
592                         Show the status of one or all of the sip peers.
593                 </synopsis>
594                 <syntax>
595                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
596                         <parameter name="Peer" required="false">
597                                 <para>The peer name you want to check.</para>
598                         </parameter>
599                 </syntax>
600                 <description>
601                         <para>Retrieves the status of one or all of the sip peers.  If no peer name is specified, status
602                         for all of the sip peers will be retrieved.</para>
603                 </description>
604         </manager>
605         <info name="MessageFromInfo" language="en_US" tech="SIP">
606                 <para>The <literal>from</literal> parameter can be a configured peer name
607                 or in the form of "display-name" &lt;URI&gt;.</para>
608         </info>
609         <info name="MessageToInfo" language="en_US" tech="SIP">
610                 <para>Specifying a prefix of <literal>sip:</literal> will send the
611                 message as a SIP MESSAGE request.</para>
612         </info>
613         <managerEvent language="en_US" name="SIPQualifyPeerDone">
614                 <managerEventInstance class="EVENT_FLAG_CALL">
615                         <synopsis>Raised when SIPQualifyPeer has finished qualifying the specified peer.</synopsis>
616                         <syntax>
617                                 <parameter name="Peer">
618                                         <para>The name of the peer.</para>
619                                 </parameter>
620                                 <parameter name="ActionID">
621                                         <para>This is only included if an ActionID Header was sent with the action request, in which case it will be that ActionID.</para>
622                                 </parameter>
623                         </syntax>
624                         <see-also>
625                                 <ref type="manager">SIPqualifypeer</ref>
626                         </see-also>
627                 </managerEventInstance>
628         </managerEvent>
629         <managerEvent language="en_US" name="SessionTimeout">
630                 <managerEventInstance class="EVENT_FLAG_CALL">
631                         <synopsis>Raised when a SIP session times out.</synopsis>
632                         <syntax>
633                                 <channel_snapshot/>
634                                 <parameter name="Source">
635                                         <para>The source of the session timeout.</para>
636                                         <enumlist>
637                                                 <enum name="RTPTimeout" />
638                                                 <enum name="SIPSessionTimer" />
639                                         </enumlist>
640                                 </parameter>
641                         </syntax>
642                 </managerEventInstance>
643         </managerEvent>
644  ***/
645
646 static int log_level = -1;
647
648 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
649 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
650 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
651 static int min_subexpiry = DEFAULT_MIN_EXPIRY;     /*!< Minimum accepted subscription time */
652 static int max_subexpiry = DEFAULT_MAX_EXPIRY;     /*!< Maximum accepted subscription time */
653 static int mwi_expiry = DEFAULT_MWI_EXPIRY;
654
655 static int unauth_sessions = 0;
656 static int authlimit = DEFAULT_AUTHLIMIT;
657 static int authtimeout = DEFAULT_AUTHTIMEOUT;
658
659 /*! \brief Global jitterbuffer configuration - by default, jb is disabled
660  *  \note Values shown here match the defaults shown in sip.conf.sample */
661 static struct ast_jb_conf default_jbconf =
662 {
663         .flags = 0,
664         .max_size = 200,
665         .resync_threshold = 1000,
666         .impl = "fixed",
667         .target_extra = 40,
668 };
669 static struct ast_jb_conf global_jbconf;                /*!< Global jitterbuffer configuration */
670
671 static const char config[] = "sip.conf";                /*!< Main configuration file */
672 static const char notify_config[] = "sip_notify.conf";  /*!< Configuration file for sending Notify with CLI commands to reconfigure or reboot phones */
673
674 /*! \brief Readable descriptions of device states.
675  *  \note Should be aligned to above table as index */
676 static const struct invstate2stringtable {
677         const enum invitestates state;
678         const char *desc;
679 } invitestate2string[] = {
680         {INV_NONE,              "None"  },
681         {INV_CALLING,           "Calling (Trying)"},
682         {INV_PROCEEDING,        "Proceeding "},
683         {INV_EARLY_MEDIA,       "Early media"},
684         {INV_COMPLETED,         "Completed (done)"},
685         {INV_CONFIRMED,         "Confirmed (up)"},
686         {INV_TERMINATED,        "Done"},
687         {INV_CANCELLED,         "Cancelled"}
688 };
689
690 /*! \brief Subscription types that we support. We support
691  * - dialoginfo updates (really device status, not dialog info as was the original intent of the standard)
692  * - SIMPLE presence used for device status
693  * - Voicemail notification subscriptions
694  */
695 static const struct cfsubscription_types {
696         enum subscriptiontype type;
697         const char * const event;
698         const char * const mediatype;
699         const char * const text;
700 } subscription_types[] = {
701         { NONE,            "-",        "unknown",                    "unknown" },
702         /* RFC 4235: SIP Dialog event package */
703         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
704         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
705         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
706         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
707         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
708 };
709
710 /*! \brief The core structure to setup dialogs. We parse incoming messages by using
711  *  structure and then route the messages according to the type.
712  *
713  *  \note Note that sip_methods[i].id == i must hold or the code breaks
714  */
715 static const struct  cfsip_methods {
716         enum sipmethod id;
717         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
718         char * const text;
719         enum can_create_dialog can_create;
720 } sip_methods[] = {
721         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",CAN_CREATE_DIALOG },
722         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",  CAN_NOT_CREATE_DIALOG },
723         { SIP_REGISTER,  NO_RTP, "REGISTER", CAN_CREATE_DIALOG },
724         { SIP_OPTIONS,   NO_RTP, "OPTIONS",  CAN_CREATE_DIALOG },
725         { SIP_NOTIFY,    NO_RTP, "NOTIFY",   CAN_CREATE_DIALOG },
726         { SIP_INVITE,    RTP,    "INVITE",   CAN_CREATE_DIALOG },
727         { SIP_ACK,       NO_RTP, "ACK",      CAN_NOT_CREATE_DIALOG },
728         { SIP_PRACK,     NO_RTP, "PRACK",    CAN_NOT_CREATE_DIALOG },
729         { SIP_BYE,       NO_RTP, "BYE",      CAN_NOT_CREATE_DIALOG },
730         { SIP_REFER,     NO_RTP, "REFER",    CAN_CREATE_DIALOG },
731         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",CAN_CREATE_DIALOG },
732         { SIP_MESSAGE,   NO_RTP, "MESSAGE",  CAN_CREATE_DIALOG },
733         { SIP_UPDATE,    NO_RTP, "UPDATE",   CAN_NOT_CREATE_DIALOG },
734         { SIP_INFO,      NO_RTP, "INFO",     CAN_NOT_CREATE_DIALOG },
735         { SIP_CANCEL,    NO_RTP, "CANCEL",   CAN_NOT_CREATE_DIALOG },
736         { SIP_PUBLISH,   NO_RTP, "PUBLISH",  CAN_CREATE_DIALOG },
737         { SIP_PING,      NO_RTP, "PING",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
738 };
739
740 /*! \brief Diversion header reasons
741  *
742  * The core defines a bunch of constants used to define
743  * redirecting reasons. This provides a translation table
744  * between those and the strings which may be present in
745  * a SIP Diversion header
746  */
747 static const struct sip_reasons {
748         enum AST_REDIRECTING_REASON code;
749         const char *text;
750 } sip_reason_table[] = {
751         { AST_REDIRECTING_REASON_UNKNOWN, "unknown" },
752         { AST_REDIRECTING_REASON_USER_BUSY, "user-busy" },
753         { AST_REDIRECTING_REASON_NO_ANSWER, "no-answer" },
754         { AST_REDIRECTING_REASON_UNAVAILABLE, "unavailable" },
755         { AST_REDIRECTING_REASON_UNCONDITIONAL, "unconditional" },
756         { AST_REDIRECTING_REASON_TIME_OF_DAY, "time-of-day" },
757         { AST_REDIRECTING_REASON_DO_NOT_DISTURB, "do-not-disturb" },
758         { AST_REDIRECTING_REASON_DEFLECTION, "deflection" },
759         { AST_REDIRECTING_REASON_FOLLOW_ME, "follow-me" },
760         { AST_REDIRECTING_REASON_OUT_OF_ORDER, "out-of-service" },
761         { AST_REDIRECTING_REASON_AWAY, "away" },
762         { AST_REDIRECTING_REASON_CALL_FWD_DTE, "cf_dte" },              /* Non-standard */
763         { AST_REDIRECTING_REASON_SEND_TO_VM, "send_to_vm" },    /* Non-standard */
764 };
765
766
767 /*! \name DefaultSettings
768         Default setttings are used as a channel setting and as a default when
769         configuring devices
770 */
771 static char default_language[MAX_LANGUAGE];      /*!< Default language setting for new channels */
772 static char default_callerid[AST_MAX_EXTENSION]; /*!< Default caller ID for sip messages */
773 static char default_mwi_from[80];                /*!< Default caller ID for MWI updates */
774 static char default_fromdomain[AST_MAX_EXTENSION]; /*!< Default domain on outound messages */
775 static int default_fromdomainport;                 /*!< Default domain port on outbound messages */
776 static char default_notifymime[AST_MAX_EXTENSION]; /*!< Default MIME media type for MWI notify messages */
777 static char default_vmexten[AST_MAX_EXTENSION];    /*!< Default From Username on MWI updates */
778 static int default_qualify;                        /*!< Default Qualify= setting */
779 static int default_keepalive;                      /*!< Default keepalive= setting */
780 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
781 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting
782                                                     *   a bridged channel on hold */
783 static char default_parkinglot[AST_MAX_CONTEXT];   /*!< Parkinglot */
784 static char default_engine[256];                   /*!< Default RTP engine */
785 static int default_maxcallbitrate;                 /*!< Maximum bitrate for call */
786 static char default_zone[MAX_TONEZONE_COUNTRY];        /*!< Default tone zone for channels created from the SIP driver */
787 static unsigned int default_transports;            /*!< Default Transports (enum ast_transport) that are acceptable */
788 static unsigned int default_primary_transport;     /*!< Default primary Transport (enum ast_transport) for outbound connections to devices */
789
790 static struct sip_settings sip_cfg;             /*!< SIP configuration data.
791                                         \note in the future we could have multiple of these (per domain, per device group etc) */
792
793 /*!< use this macro when ast_uri_decode is dependent on pedantic checking to be on. */
794 #define SIP_PEDANTIC_DECODE(str)        \
795         if (sip_cfg.pedanticsipchecking && !ast_strlen_zero(str)) {     \
796                 ast_uri_decode(str, ast_uri_sip_user);  \
797         }       \
798
799 static unsigned int chan_idx;       /*!< used in naming sip channel */
800 static int global_match_auth_username;    /*!< Match auth username if available instead of From: Default off. */
801
802 static int global_relaxdtmf;        /*!< Relax DTMF */
803 static int global_prematuremediafilter;   /*!< Enable/disable premature frames in a call (causing 183 early media) */
804 static int global_rtptimeout;       /*!< Time out call if no RTP */
805 static int global_rtpholdtimeout;   /*!< Time out call if no RTP during hold */
806 static int global_rtpkeepalive;     /*!< Send RTP keepalives */
807 static int global_reg_timeout;      /*!< Global time between attempts for outbound registrations */
808 static int global_regattempts_max;  /*!< Registration attempts before giving up */
809 static int global_reg_retry_403;    /*!< Treat 403 responses to registrations as 401 responses */
810 static int global_shrinkcallerid;   /*!< enable or disable shrinking of caller id  */
811 static int global_callcounter;      /*!< Enable call counters for all devices. This is currently enabled by setting the peer
812                                      *   call-limit to INT_MAX. When we remove the call-limit from the code, we can make it
813                                      *   with just a boolean flag in the device structure */
814 static unsigned int global_tos_sip;      /*!< IP type of service for SIP packets */
815 static unsigned int global_tos_audio;    /*!< IP type of service for audio RTP packets */
816 static unsigned int global_tos_video;    /*!< IP type of service for video RTP packets */
817 static unsigned int global_tos_text;     /*!< IP type of service for text RTP packets */
818 static unsigned int global_cos_sip;      /*!< 802.1p class of service for SIP packets */
819 static unsigned int global_cos_audio;    /*!< 802.1p class of service for audio RTP packets */
820 static unsigned int global_cos_video;    /*!< 802.1p class of service for video RTP packets */
821 static unsigned int global_cos_text;     /*!< 802.1p class of service for text RTP packets */
822 static unsigned int recordhistory;       /*!< Record SIP history. Off by default */
823 static unsigned int dumphistory;         /*!< Dump history to verbose before destroying SIP dialog */
824 static char global_useragent[AST_MAX_EXTENSION];    /*!< Useragent for the SIP channel */
825 static char global_sdpsession[AST_MAX_EXTENSION];   /*!< SDP session name for the SIP channel */
826 static char global_sdpowner[AST_MAX_EXTENSION];     /*!< SDP owner name for the SIP channel */
827 static int global_authfailureevents;     /*!< Whether we send authentication failure manager events or not. Default no. */
828 static int global_t1;           /*!< T1 time */
829 static int global_t1min;        /*!< T1 roundtrip time minimum */
830 static int global_timer_b;      /*!< Timer B - RFC 3261 Section 17.1.1.2 */
831 static unsigned int global_autoframing; /*!< Turn autoframing on or off. */
832 static int global_qualifyfreq;          /*!< Qualify frequency */
833 static int global_qualify_gap;          /*!< Time between our group of peer pokes */
834 static int global_qualify_peers;        /*!< Number of peers to poke at a given time */
835
836 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
837 static enum st_refresher_param global_st_refresher; /*!< Session-Timer refresher                        */
838 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
839 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
840
841 static int global_store_sip_cause;    /*!< Whether the MASTER_CHANNEL(HASH(SIP_CAUSE,[chan_name])) var should be set */
842
843 static int global_dynamic_exclude_static = 0; /*!< Exclude static peers from contact registrations */
844 static unsigned char global_refer_addheaders; /*!< Add extra headers to outgoing REFER */
845 /*@}*/
846
847 /*!
848  * We use libxml2 in order to parse XML that may appear in the body of a SIP message. Currently,
849  * the only usage is for parsing PIDF bodies of incoming PUBLISH requests in the call-completion
850  * event package. This variable is set at module load time and may be checked at runtime to determine
851  * if XML parsing support was found.
852  */
853 static int can_parse_xml;
854
855 /*! \name Object counters @{
856  *
857  * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
858  * should be used to modify these values.
859  */
860 static int speerobjs = 0;     /*!< Static peers */
861 static int rpeerobjs = 0;     /*!< Realtime peers */
862 static int apeerobjs = 0;     /*!< Autocreated peer objects */
863 /*! @} */
864
865 static struct ast_flags global_flags[3] = {{0}};  /*!< global SIP_ flags */
866 static unsigned int global_t38_maxdatagram;                /*!< global T.38 FaxMaxDatagram override */
867
868 static struct stasis_subscription *network_change_sub; /*!< subscription id for network change events */
869 static struct stasis_subscription *acl_change_sub; /*!< subscription id for named ACL system change events */
870 static int network_change_sched_id = -1;
871
872 static char used_context[AST_MAX_CONTEXT];        /*!< name of automatically created context for unloading */
873
874 AST_MUTEX_DEFINE_STATIC(netlock);
875
876 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
877    when it's doing something critical. */
878 AST_MUTEX_DEFINE_STATIC(monlock);
879
880 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
881
882 /*! \brief This is the thread for the monitor which checks for input on the channels
883    which are not currently in use.  */
884 static pthread_t monitor_thread = AST_PTHREADT_NULL;
885
886 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
887 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
888
889 struct ast_sched_context *sched;     /*!< The scheduling context */
890 static struct io_context *io;           /*!< The IO context */
891 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
892 struct sip_pkt;
893 static AST_LIST_HEAD_STATIC(domain_list, domain);    /*!< The SIP domain list */
894
895 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
896
897 static enum sip_debug_e sipdebug;
898
899 /*! \brief extra debugging for 'text' related events.
900  *  At the moment this is set together with sip_debug_console.
901  *  \note It should either go away or be implemented properly.
902  */
903 static int sipdebug_text;
904
905 static const struct _map_x_s referstatusstrings[] = {
906         { REFER_IDLE,      "<none>" },
907         { REFER_SENT,      "Request sent" },
908         { REFER_RECEIVED,  "Request received" },
909         { REFER_CONFIRMED, "Confirmed" },
910         { REFER_ACCEPTED,  "Accepted" },
911         { REFER_RINGING,   "Target ringing" },
912         { REFER_200OK,     "Done" },
913         { REFER_FAILED,    "Failed" },
914         { REFER_NOAUTH,    "Failed - auth failure" },
915         { -1,               NULL} /* terminator */
916 };
917
918 /* --- Hash tables of various objects --------*/
919 #ifdef LOW_MEMORY
920 static const int HASH_PEER_SIZE = 17;
921 static const int HASH_DIALOG_SIZE = 17;
922 static const int HASH_REGISTRY_SIZE = 17;
923 #else
924 static const int HASH_PEER_SIZE = 563;  /*!< Size of peer hash table, prime number preferred! */
925 static const int HASH_DIALOG_SIZE = 563;
926 static const int HASH_REGISTRY_SIZE = 563;
927 #endif
928
929 static const struct {
930         enum ast_cc_service_type service;
931         const char *service_string;
932 } sip_cc_service_map [] = {
933         [AST_CC_NONE] = { AST_CC_NONE, "" },
934         [AST_CC_CCBS] = { AST_CC_CCBS, "BS" },
935         [AST_CC_CCNR] = { AST_CC_CCNR, "NR" },
936         [AST_CC_CCNL] = { AST_CC_CCNL, "NL" },
937 };
938
939 static const struct {
940         enum sip_cc_notify_state state;
941         const char *state_string;
942 } sip_cc_notify_state_map [] = {
943         [CC_QUEUED] = {CC_QUEUED, "cc-state: queued"},
944         [CC_READY] = {CC_READY, "cc-state: ready"},
945 };
946
947 AST_LIST_HEAD_STATIC(epa_static_data_list, epa_backend);
948
949
950 /*!
951  * Used to create new entity IDs by ESCs.
952  */
953 static int esc_etag_counter;
954 static const int DEFAULT_PUBLISH_EXPIRES = 3600;
955
956 #ifdef HAVE_LIBXML2
957 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);
958
959 static const struct sip_esc_publish_callbacks cc_esc_publish_callbacks = {
960         .initial_handler = cc_esc_publish_handler,
961         .modify_handler = cc_esc_publish_handler,
962 };
963 #endif
964
965 /*!
966  * \brief The Event State Compositors
967  *
968  * An Event State Compositor is an entity which
969  * accepts PUBLISH requests and acts appropriately
970  * based on these requests.
971  *
972  * The actual event_state_compositor structure is simply
973  * an ao2_container of sip_esc_entrys. When an incoming
974  * PUBLISH is received, we can match the appropriate sip_esc_entry
975  * using the entity ID of the incoming PUBLISH.
976  */
977 static struct event_state_compositor {
978         enum subscriptiontype event;
979         const char * name;
980         const struct sip_esc_publish_callbacks *callbacks;
981         struct ao2_container *compositor;
982 } event_state_compositors [] = {
983 #ifdef HAVE_LIBXML2
984         {CALL_COMPLETION, "call-completion", &cc_esc_publish_callbacks},
985 #endif
986 };
987
988 struct state_notify_data {
989         int state;
990         struct ao2_container *device_state_info;
991         int presence_state;
992         const char *presence_subtype;
993         const char *presence_message;
994 };
995
996
997 static const int ESC_MAX_BUCKETS = 37;
998
999 /*!
1000  * \details
1001  * Here we implement the container for dialogs which are in the
1002  * dialog_needdestroy state to iterate only through the dialogs
1003  * unlink them instead of iterate through all dialogs
1004  */
1005 struct ao2_container *dialogs_needdestroy;
1006
1007 /*!
1008  * \details
1009  * Here we implement the container for dialogs which have rtp
1010  * traffic and rtptimeout, rtpholdtimeout or rtpkeepalive
1011  * set. We use this container instead the whole dialog list.
1012  */
1013 struct ao2_container *dialogs_rtpcheck;
1014
1015 /*!
1016  * \details
1017  * Here we implement the container for dialogs (sip_pvt), defining
1018  * generic wrapper functions to ease the transition from the current
1019  * implementation (a single linked list) to a different container.
1020  * In addition to a reference to the container, we need functions to lock/unlock
1021  * the container and individual items, and functions to add/remove
1022  * references to the individual items.
1023  */
1024 static struct ao2_container *dialogs;
1025 #define sip_pvt_lock(x) ao2_lock(x)
1026 #define sip_pvt_trylock(x) ao2_trylock(x)
1027 #define sip_pvt_unlock(x) ao2_unlock(x)
1028
1029 /*! \brief  The table of TCP threads */
1030 static struct ao2_container *threadt;
1031
1032 /*! \brief  The peer list: Users, Peers and Friends */
1033 static struct ao2_container *peers;
1034 static struct ao2_container *peers_by_ip;
1035
1036 /*! \brief A bogus peer, to be used when authentication should fail */
1037 static AO2_GLOBAL_OBJ_STATIC(g_bogus_peer);
1038 /*! \brief We can recognize the bogus peer by this invalid MD5 hash */
1039 #define BOGUS_PEER_MD5SECRET "intentionally_invalid_md5_string"
1040
1041 /*! \brief  The register list: Other SIP proxies we register with and receive calls from */
1042 static struct ao2_container *registry_list;
1043
1044 /*! \brief  The MWI subscription list */
1045 static struct ao2_container *subscription_mwi_list;
1046
1047 static int temp_pvt_init(void *);
1048 static void temp_pvt_cleanup(void *);
1049
1050 /*! \brief A per-thread temporary pvt structure */
1051 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1052
1053 /*! \brief A per-thread buffer for transport to string conversion */
1054 AST_THREADSTORAGE(sip_transport_str_buf);
1055
1056 /*! \brief Size of the SIP transport buffer */
1057 #define SIP_TRANSPORT_STR_BUFSIZE 128
1058
1059 /*! \brief Authentication container for realm authentication */
1060 static struct sip_auth_container *authl = NULL;
1061 /*! \brief Global authentication container protection while adjusting the references. */
1062 AST_MUTEX_DEFINE_STATIC(authl_lock);
1063
1064 static struct ast_manager_event_blob *session_timeout_to_ami(struct stasis_message *msg);
1065 STASIS_MESSAGE_TYPE_DEFN_LOCAL(session_timeout_type,
1066         .to_ami = session_timeout_to_ami,
1067         );
1068
1069 /* --- Sockets and networking --------------*/
1070
1071 /*! \brief Main socket for UDP SIP communication.
1072  *
1073  * sipsock is shared between the SIP manager thread (which handles reload
1074  * requests), the udp io handler (sipsock_read()) and the user routines that
1075  * issue udp writes (using __sip_xmit()).
1076  * The socket is -1 only when opening fails (this is a permanent condition),
1077  * or when we are handling a reload() that changes its address (this is
1078  * a transient situation during which we might have a harmless race, see
1079  * below). Because the conditions for the race to be possible are extremely
1080  * rare, we don't want to pay the cost of locking on every I/O.
1081  * Rather, we remember that when the race may occur, communication is
1082  * bound to fail anyways, so we just live with this event and let
1083  * the protocol handle this above us.
1084  */
1085 static int sipsock  = -1;
1086
1087 struct ast_sockaddr bindaddr;   /*!< UDP: The address we bind to */
1088
1089 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1090  *  internip is initialized picking a suitable address from one of the
1091  * interfaces, and the same port number we bind to. It is used as the
1092  * default address/port in SIP messages, and as the default address
1093  * (but not port) in SDP messages.
1094  */
1095 static struct ast_sockaddr internip;
1096
1097 /*! \brief our external IP address/port for SIP sessions.
1098  * externaddr.sin_addr is only set when we know we might be behind
1099  * a NAT, and this is done using a variety of (mutually exclusive)
1100  * ways from the config file:
1101  *
1102  * + with "externaddr = host[:port]" we specify the address/port explicitly.
1103  *   The address is looked up only once when (re)loading the config file;
1104  *
1105  * + with "externhost = host[:port]" we do a similar thing, but the
1106  *   hostname is stored in externhost, and the hostname->IP mapping
1107  *   is refreshed every 'externrefresh' seconds;
1108  *
1109  * Other variables (externhost, externexpire, externrefresh) are used
1110  * to support the above functions.
1111  */
1112 static struct ast_sockaddr externaddr;      /*!< External IP address if we are behind NAT */
1113 static struct ast_sockaddr media_address; /*!< External RTP IP address if we are behind NAT */
1114 static struct ast_sockaddr rtpbindaddr;   /*!< RTP: The address we bind to */
1115
1116 static char externhost[MAXHOSTNAMELEN];   /*!< External host name */
1117 static time_t externexpire;             /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1118 static int externrefresh = 10;          /*!< Refresh timer for DNS-based external address (dyndns) */
1119 static uint16_t externtcpport;          /*!< external tcp port */
1120 static uint16_t externtlsport;          /*!< external tls port */
1121
1122 /*! \brief  List of local networks
1123  * We store "localnet" addresses from the config file into an access list,
1124  * marked as 'DENY', so the call to ast_apply_ha() will return
1125  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1126  * (i.e. presumably public) addresses.
1127  */
1128 static struct ast_ha *localaddr;    /*!< List of local networks, on the same side of NAT as this Asterisk */
1129
1130 static int ourport_tcp;             /*!< The port used for TCP connections */
1131 static int ourport_tls;             /*!< The port used for TCP/TLS connections */
1132 static struct ast_sockaddr debugaddr;
1133
1134 static struct ast_config *notify_types = NULL;    /*!< The list of manual NOTIFY types we know how to send */
1135
1136 /*! some list management macros. */
1137
1138 #define UNLINK(element, head, prev) do {        \
1139         if (prev)                               \
1140                 (prev)->next = (element)->next; \
1141         else                                    \
1142                 (head) = (element)->next;       \
1143         } while (0)
1144
1145 struct ao2_container *sip_monitor_instances;
1146
1147 struct show_peers_context;
1148
1149 /*---------------------------- Forward declarations of functions in chan_sip.c */
1150 /* Note: This is added to help splitting up chan_sip.c into several files
1151         in coming releases. */
1152
1153 /*--- PBX interface functions */
1154 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);
1155 static int sip_devicestate(const char *data);
1156 static int sip_sendtext(struct ast_channel *ast, const char *text);
1157 static int sip_call(struct ast_channel *ast, const char *dest, int timeout);
1158 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1159 static int sip_hangup(struct ast_channel *ast);
1160 static int sip_answer(struct ast_channel *ast);
1161 static struct ast_frame *sip_read(struct ast_channel *ast);
1162 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1163 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1164 static int sip_transfer(struct ast_channel *ast, const char *dest);
1165 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1166 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1167 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1168 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
1169 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
1170 static const char *sip_get_callid(struct ast_channel *chan);
1171
1172 static int handle_request_do(struct sip_request *req, struct ast_sockaddr *addr);
1173 static int sip_standard_port(enum ast_transport type, int port);
1174 static int sip_prepare_socket(struct sip_pvt *p);
1175 static int get_address_family_filter(unsigned int transport);
1176
1177 /*--- Transmitting responses and requests */
1178 static int sipsock_read(int *id, int fd, short events, void *ignore);
1179 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data);
1180 static int __sip_reliable_xmit(struct sip_pvt *p, uint32_t seqno, int resp, struct ast_str *data, int fatal, int sipmethod);
1181 static void add_cc_call_info_to_response(struct sip_pvt *p, struct sip_request *resp);
1182 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1183 static int retrans_pkt(const void *data);
1184 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);
1185 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1186 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1187 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1188 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);
1189 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1190 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);
1191 static int transmit_provisional_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, int with_sdp);
1192 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1193 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable);
1194 static int transmit_request(struct sip_pvt *p, int sipmethod, uint32_t seqno, enum xmittype reliable, int newbranch);
1195 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, uint32_t seqno, enum xmittype reliable, int newbranch);
1196 static int transmit_publish(struct sip_epa_entry *epa_entry, enum sip_publish_type publish_type, const char * const explicit_uri);
1197 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init, const char * const explicit_uri);
1198 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
1199 static int transmit_info_with_aoc(struct sip_pvt *p, struct ast_aoc_decoded *decoded);
1200 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1201 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1202 static int transmit_message(struct sip_pvt *p, int init, int auth);
1203 static int transmit_refer(struct sip_pvt *p, const char *dest);
1204 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
1205 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1206 static int transmit_cc_notify(struct ast_cc_agent *agent, struct sip_pvt *subscription, enum sip_cc_notify_state state);
1207 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1208 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, uint32_t seqno);
1209 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, uint32_t seqno);
1210 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1211 static void receive_message(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1212 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
1213 static int sip_send_mwi_to_peer(struct sip_peer *peer, int cache_only);
1214
1215 /* Misc dialog routines */
1216 static int __sip_autodestruct(const void *data);
1217 static int update_call_counter(struct sip_pvt *fup, int event);
1218 static int auto_congest(const void *arg);
1219 static struct sip_pvt *__find_call(struct sip_request *req, struct ast_sockaddr *addr, const int intended_method,
1220         const char *file, int line, const char *func);
1221 #define find_call(req, addr, intended_method) \
1222         __find_call(req, addr, intended_method, __FILE__, __LINE__, __PRETTY_FUNCTION__)
1223
1224 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards, int resp);
1225 static int build_path(struct sip_pvt *p, struct sip_peer *peer, struct sip_request *req, const char *pathbuf);
1226 static enum check_auth_result register_verify(struct sip_pvt *p, struct ast_sockaddr *addr,
1227                                               struct sip_request *req, const char *uri);
1228 static int get_sip_pvt_from_replaces(const char *callid, const char *totag, const char *fromtag,
1229                 struct sip_pvt **out_pvt, struct ast_channel **out_chan);
1230 static void check_pendings(struct sip_pvt *p);
1231 static void sip_set_owner(struct sip_pvt *p, struct ast_channel *chan);
1232
1233 static void *sip_pickup_thread(void *stuff);
1234 static int sip_pickup(struct ast_channel *chan);
1235
1236 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1237 static int is_method_allowed(unsigned int *allowed_methods, enum sipmethod method);
1238
1239 /*--- Codec handling / SDP */
1240 static void try_suggested_sip_codec(struct sip_pvt *p);
1241 static const char *get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1242 static char get_sdp_line(int *start, int stop, struct sip_request *req, const char **value);
1243 static int find_sdp(struct sip_request *req);
1244 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action, int is_offer);
1245 static int process_sdp_o(const char *o, struct sip_pvt *p);
1246 static int process_sdp_c(const char *c, struct ast_sockaddr *addr);
1247 static int process_sdp_a_sendonly(const char *a, int *sendonly);
1248 static int process_sdp_a_ice(const char *a, struct sip_pvt *p, struct ast_rtp_instance *instance, int rtcp_mux);
1249 static int process_sdp_a_rtcp_mux(const char *a, struct sip_pvt *p, int *requested);
1250 static int process_sdp_a_dtls(const char *a, struct sip_pvt *p, struct ast_rtp_instance *instance);
1251 static int process_sdp_a_audio(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newaudiortp, int *last_rtpmap_codec);
1252 static int process_sdp_a_video(const char *a, struct sip_pvt *p, struct ast_rtp_codecs *newvideortp, int *last_rtpmap_codec);
1253 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);
1254 static int process_sdp_a_image(const char *a, struct sip_pvt *p);
1255 static void add_ice_to_sdp(struct ast_rtp_instance *instance, struct ast_str **a_buf);
1256 static void add_dtls_to_sdp(struct ast_rtp_instance *instance, struct ast_str **a_buf);
1257 static void start_ice(struct ast_rtp_instance *instance, int offer);
1258 static void add_codec_to_sdp(const struct sip_pvt *p, struct ast_format *codec,
1259                              struct ast_str **m_buf, struct ast_str **a_buf,
1260                              int debug, int *min_packet_size, int *max_packet_size);
1261 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
1262                                 struct ast_str **m_buf, struct ast_str **a_buf,
1263                                 int debug);
1264 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
1265 static void do_setnat(struct sip_pvt *p);
1266 static void stop_media_flows(struct sip_pvt *p);
1267
1268 /*--- Authentication stuff */
1269 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1270 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1271 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1272                                          const char *secret, const char *md5secret, int sipmethod,
1273                                          const char *uri, enum xmittype reliable);
1274 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1275                                               int sipmethod, const char *uri, enum xmittype reliable,
1276                                               struct ast_sockaddr *addr, struct sip_peer **authpeer);
1277 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct ast_sockaddr *addr);
1278
1279 /*--- Domain handling */
1280 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1281 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1282 static void clear_sip_domains(void);
1283
1284 /*--- SIP realm authentication */
1285 static void add_realm_authentication(struct sip_auth_container **credentials, const char *configuration, int lineno);
1286 static struct sip_auth *find_realm_authentication(struct sip_auth_container *credentials, const char *realm);
1287
1288 /*--- Misc functions */
1289 static int check_rtp_timeout(struct sip_pvt *dialog, time_t t);
1290 static int reload_config(enum channelreloadreason reason);
1291 static void add_diversion(struct sip_request *req, struct sip_pvt *pvt);
1292 static int expire_register(const void *data);
1293 static void *do_monitor(void *data);
1294 static int restart_monitor(void);
1295 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
1296 static struct ast_variable *copy_vars(struct ast_variable *src);
1297 static int dialog_find_multiple(void *obj, void *arg, int flags);
1298 static struct ast_channel *sip_pvt_lock_full(struct sip_pvt *pvt);
1299 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
1300 static int sip_refer_alloc(struct sip_pvt *p);
1301 static void sip_refer_destroy(struct sip_pvt *p);
1302 static int sip_notify_alloc(struct sip_pvt *p);
1303 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
1304 static void set_peer_nat(const struct sip_pvt *p, struct sip_peer *peer);
1305 static void check_for_nat(const struct ast_sockaddr *them, struct sip_pvt *p);
1306
1307 /*--- Device monitoring and Device/extension state/event handling */
1308 static int extensionstate_update(const char *context, const char *exten, struct state_notify_data *data, struct sip_pvt *p, int force);
1309 static int cb_extensionstate(const char *context, const char *exten, struct ast_state_cb_info *info, void *data);
1310 static int sip_poke_noanswer(const void *data);
1311 static int sip_poke_peer(struct sip_peer *peer, int force);
1312 static void sip_poke_all_peers(void);
1313 static void sip_peer_hold(struct sip_pvt *p, int hold);
1314 static void mwi_event_cb(void *, struct stasis_subscription *, struct stasis_message *);
1315 static void network_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message);
1316 static void acl_change_stasis_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message);
1317 static void sip_keepalive_all_peers(void);
1318 #define peer_in_destruction(peer) (ao2_ref(peer, 0) == 0)
1319
1320 /*--- Applications, functions, CLI and manager command helpers */
1321 static const char *sip_nat_mode(const struct sip_pvt *p);
1322 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1323 static char *transfermode2str(enum transfermodes mode) attribute_const;
1324 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1325 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1326 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1327 static struct sip_peer *_sip_show_peers_one(int fd, struct mansession *s, struct show_peers_context *cont, struct sip_peer *peer);
1328 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1329 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1330 static void  print_group(int fd, ast_group_t group, int crlf);
1331 static void  print_named_groups(int fd, struct ast_namedgroups *groups, int crlf);
1332 static const char *dtmfmode2str(int mode) attribute_const;
1333 static int str2dtmfmode(const char *str) attribute_unused;
1334 static const char *insecure2str(int mode) attribute_const;
1335 static const char *allowoverlap2str(int mode) attribute_const;
1336 static void cleanup_stale_contexts(char *new, char *old);
1337 static const char *domain_mode_to_text(const enum domain_mode mode);
1338 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1339 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1340 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1341 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1342 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1343 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1344 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1345 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1346 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1347 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1348 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1349 static char *complete_sip_peer(const char *word, int state, int flags2);
1350 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1351 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1352 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1353 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1354 static char *complete_sip_notify(const char *line, const char *word, int pos, int state);
1355 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1356 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1357 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1358 static char *sip_do_debug_ip(int fd, const char *arg);
1359 static char *sip_do_debug_peer(int fd, const char *arg);
1360 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1361 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1362 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1363 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
1364 static int sip_addheader(struct ast_channel *chan, const char *data);
1365 static int sip_do_reload(enum channelreloadreason reason);
1366 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1367 static int ast_sockaddr_resolve_first_af(struct ast_sockaddr *addr,
1368                                       const char *name, int flag, int family);
1369 static int ast_sockaddr_resolve_first(struct ast_sockaddr *addr,
1370                                       const char *name, int flag);
1371 static int ast_sockaddr_resolve_first_transport(struct ast_sockaddr *addr,
1372                                                 const char *name, int flag, unsigned int transport);
1373
1374 /*--- Debugging
1375         Functions for enabling debug per IP or fully, or enabling history logging for
1376         a SIP dialog
1377 */
1378 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1379 static inline int sip_debug_test_addr(const struct ast_sockaddr *addr);
1380 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1381 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1382 static void sip_dump_history(struct sip_pvt *dialog);
1383
1384 /*--- Device object handling */
1385 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime, int devstate_only);
1386 static int update_call_counter(struct sip_pvt *fup, int event);
1387 static void sip_destroy_peer(struct sip_peer *peer);
1388 static void sip_destroy_peer_fn(void *peer);
1389 static void set_peer_defaults(struct sip_peer *peer);
1390 static struct sip_peer *temp_peer(const char *name);
1391 static void register_peer_exten(struct sip_peer *peer, int onoff);
1392 static int sip_poke_peer_s(const void *data);
1393 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1394 static void reg_source_db(struct sip_peer *peer);
1395 static void destroy_association(struct sip_peer *peer);
1396 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1397 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1398 static void set_socket_transport(struct sip_socket *socket, int transport);
1399 static int peer_ipcmp_cb_full(void *obj, void *arg, void *data, int flags);
1400
1401 /* Realtime device support */
1402 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);
1403 static void update_peer(struct sip_peer *p, int expire);
1404 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1405 static const char *get_name_from_variable(const struct ast_variable *var);
1406 static struct sip_peer *realtime_peer(const char *peername, struct ast_sockaddr *sin, char *callbackexten, int devstate_only, int which_objects);
1407 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1408
1409 /*--- Internal UA client handling (outbound registrations) */
1410 static void ast_sip_ouraddrfor(const struct ast_sockaddr *them, struct ast_sockaddr *us, struct sip_pvt *p);
1411 static void sip_registry_destroy(void *reg);
1412 static int sip_register(const char *value, int lineno);
1413 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1414 static int __sip_do_register(struct sip_registry *r);
1415 static int sip_reg_timeout(const void *data);
1416 static void sip_send_all_registers(void);
1417 static int sip_reinvite_retry(const void *data);
1418
1419 /*--- Parsing SIP requests and responses */
1420 static int determine_firstline_parts(struct sip_request *req);
1421 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1422 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1423 static int find_sip_method(const char *msg);
1424 static unsigned int parse_allowed_methods(struct sip_request *req);
1425 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
1426 static int parse_request(struct sip_request *req);
1427 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1428 static int method_match(enum sipmethod id, const char *name);
1429 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1430 static void parse_oli(struct sip_request *req, struct ast_channel *chan);
1431 static const char *find_alias(const char *name, const char *_default);
1432 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1433 static void lws2sws(struct ast_str *msgbuf);
1434 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1435 static char *remove_uri_parameters(char *uri);
1436 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1437 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1438 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1439 static int use_reason_header(struct sip_pvt *pvt, struct sip_request *req);
1440 static int set_address_from_contact(struct sip_pvt *pvt);
1441 static void check_via(struct sip_pvt *p, const struct sip_request *req);
1442 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
1443 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason, char **reason_str);
1444 static enum sip_get_dest_result get_destination(struct sip_pvt *p, struct sip_request *oreq, int *cc_recall_core_id);
1445 static int transmit_state_notify(struct sip_pvt *p, struct state_notify_data *data, int full, int timeout);
1446 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
1447 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
1448 static int get_domain(const char *str, char *domain, int len);
1449 static void get_realm(struct sip_pvt *p, const struct sip_request *req);
1450 static char *get_content(struct sip_request *req);
1451
1452 /*-- TCP connection handling ---*/
1453 static void *_sip_tcp_helper_thread(struct ast_tcptls_session_instance *tcptls_session);
1454 static void *sip_tcp_worker_fn(void *);
1455
1456 /*--- Constructing requests and responses */
1457 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1458 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1459 static void deinit_req(struct sip_request *req);
1460 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, uint32_t seqno, int newbranch);
1461 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, const char * const explicit_uri);
1462 static int init_resp(struct sip_request *resp, const char *msg);
1463 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
1464 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1465 static const struct ast_sockaddr *sip_real_dst(const struct sip_pvt *p);
1466 static void build_via(struct sip_pvt *p);
1467 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1468 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct ast_sockaddr *addr, int newdialog);
1469 static char *generate_random_string(char *buf, size_t size);
1470 static void build_callid_pvt(struct sip_pvt *pvt);
1471 static void change_callid_pvt(struct sip_pvt *pvt, const char *callid);
1472 static void build_callid_registry(struct sip_registry *reg, const struct ast_sockaddr *ourip, const char *fromdomain);
1473 static void build_localtag_registry(struct sip_registry *reg);
1474 static void make_our_tag(struct sip_pvt *pvt);
1475 static int add_header(struct sip_request *req, const char *var, const char *value);
1476 static int add_max_forwards(struct sip_pvt *dialog, struct sip_request *req);
1477 static int add_content(struct sip_request *req, const char *line);
1478 static int finalize_content(struct sip_request *req);
1479 static void destroy_msg_headers(struct sip_pvt *pvt);
1480 static int add_text(struct sip_request *req, struct sip_pvt *p);
1481 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1482 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
1483 static int add_vidupdate(struct sip_request *req);
1484 static void add_route(struct sip_request *req, struct sip_route *route, int skip);
1485 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1486 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1487 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1488 static void set_destination(struct sip_pvt *p, const char *uri);
1489 static void add_date(struct sip_request *req);
1490 static void add_expires(struct sip_request *req, int expires);
1491 static void build_contact(struct sip_pvt *p, struct sip_request *req, int incoming);
1492
1493 /*------Request handling functions */
1494 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, int *recount, int *nounlock);
1495 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
1496 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);
1497 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, uint32_t seqno, int *nounlock);
1498 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1499 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *sin, const char *e);
1500 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1501 static int handle_request_message(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1502 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, const char *e);
1503 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1504 static int handle_request_options(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, const char *e);
1505 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req,
1506                 int *nounlock, struct sip_pvt *replaces_pvt, struct ast_channel *replaces_chan);
1507 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct ast_sockaddr *addr, uint32_t seqno, const char *e);
1508 static int local_attended_transfer(struct sip_pvt *transferer, struct ast_channel *transferer_chan, uint32_t seqno, int *nounlock);
1509
1510 /*------Response handling functions */
1511 static void handle_response_publish(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1512 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1513 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1514 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1515 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1516 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1517 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno);
1518
1519 /*------ SRTP Support -------- */
1520 static int process_crypto(struct sip_pvt *p, struct ast_rtp_instance *rtp, struct ast_sdp_srtp **srtp,
1521                 const char *a);
1522
1523 /*------ T38 Support --------- */
1524 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1525 static void change_t38_state(struct sip_pvt *p, int state);
1526
1527 /*------ Session-Timers functions --------- */
1528 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
1529 static void stop_session_timer(struct sip_pvt *p);
1530 static void start_session_timer(struct sip_pvt *p);
1531 static void restart_session_timer(struct sip_pvt *p);
1532 static const char *strefresherparam2str(enum st_refresher_param r);
1533 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher_param *const p_ref);
1534 static int parse_minse(const char *p_hdrval, int *const p_interval);
1535 static int st_get_se(struct sip_pvt *, int max);
1536 static enum st_refresher st_get_refresher(struct sip_pvt *);
1537 static enum st_mode st_get_mode(struct sip_pvt *, int no_cached);
1538 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
1539
1540 /*------- RTP Glue functions -------- */
1541 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);
1542
1543 /*!--- SIP MWI Subscription support */
1544 static int sip_subscribe_mwi(const char *value, int lineno);
1545 static void sip_send_all_mwi_subscriptions(void);
1546 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
1547
1548 /* Scheduler id start/stop/reschedule functions. */
1549 static void stop_provisional_keepalive(struct sip_pvt *pvt);
1550 static void do_stop_session_timer(struct sip_pvt *pvt);
1551 static void stop_reinvite_retry(struct sip_pvt *pvt);
1552 static void stop_retrans_pkt(struct sip_pkt *pkt);
1553 static void stop_t38_abort_timer(struct sip_pvt *pvt);
1554
1555 /*! \brief Definition of this channel for PBX channel registration */
1556 struct ast_channel_tech sip_tech = {
1557         .type = "SIP",
1558         .description = "Session Initiation Protocol (SIP)",
1559         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1560         .requester = sip_request_call,                  /* called with chan unlocked */
1561         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1562         .call = sip_call,                       /* called with chan locked */
1563         .send_html = sip_sendhtml,
1564         .hangup = sip_hangup,                   /* called with chan locked */
1565         .answer = sip_answer,                   /* called with chan locked */
1566         .read = sip_read,                       /* called with chan locked */
1567         .write = sip_write,                     /* called with chan locked */
1568         .write_video = sip_write,               /* called with chan locked */
1569         .write_text = sip_write,
1570         .indicate = sip_indicate,               /* called with chan locked */
1571         .transfer = sip_transfer,               /* called with chan locked */
1572         .fixup = sip_fixup,                     /* called with chan locked */
1573         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1574         .send_digit_end = sip_senddigit_end,
1575         .early_bridge = ast_rtp_instance_early_bridge,
1576         .send_text = sip_sendtext,              /* called with chan locked */
1577         .func_channel_read = sip_acf_channel_read,
1578         .setoption = sip_setoption,
1579         .queryoption = sip_queryoption,
1580         .get_pvt_uniqueid = sip_get_callid,
1581 };
1582
1583 /*! \brief This version of the sip channel tech has no send_digit_begin
1584  * callback so that the core knows that the channel does not want
1585  * DTMF BEGIN frames.
1586  * The struct is initialized just before registering the channel driver,
1587  * and is for use with channels using SIP INFO DTMF.
1588  */
1589 struct ast_channel_tech sip_tech_info;
1590
1591 /*------- CC Support -------- */
1592 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan);
1593 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent);
1594 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent);
1595 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
1596 static int sip_cc_agent_status_request(struct ast_cc_agent *agent);
1597 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent);
1598 static int sip_cc_agent_recall(struct ast_cc_agent *agent);
1599 static void sip_cc_agent_destructor(struct ast_cc_agent *agent);
1600
1601 static struct ast_cc_agent_callbacks sip_cc_agent_callbacks = {
1602         .type = "SIP",
1603         .init = sip_cc_agent_init,
1604         .start_offer_timer = sip_cc_agent_start_offer_timer,
1605         .stop_offer_timer = sip_cc_agent_stop_offer_timer,
1606         .respond = sip_cc_agent_respond,
1607         .status_request = sip_cc_agent_status_request,
1608         .start_monitoring = sip_cc_agent_start_monitoring,
1609         .callee_available = sip_cc_agent_recall,
1610         .destructor = sip_cc_agent_destructor,
1611 };
1612
1613 /* -------- End of declarations of structures, constants and forward declarations of functions
1614    Below starts actual code
1615    ------------------------
1616 */
1617
1618 static int sip_epa_register(const struct epa_static_data *static_data)
1619 {
1620         struct epa_backend *backend = ast_calloc(1, sizeof(*backend));
1621
1622         if (!backend) {
1623                 return -1;
1624         }
1625
1626         backend->static_data = static_data;
1627
1628         AST_LIST_LOCK(&epa_static_data_list);
1629         AST_LIST_INSERT_TAIL(&epa_static_data_list, backend, next);
1630         AST_LIST_UNLOCK(&epa_static_data_list);
1631         return 0;
1632 }
1633
1634 static void sip_epa_unregister_all(void)
1635 {
1636         struct epa_backend *backend;
1637
1638         AST_LIST_LOCK(&epa_static_data_list);
1639         while ((backend = AST_LIST_REMOVE_HEAD(&epa_static_data_list, next))) {
1640                 ast_free(backend);
1641         }
1642         AST_LIST_UNLOCK(&epa_static_data_list);
1643 }
1644
1645 static void cc_handle_publish_error(struct sip_pvt *pvt, const int resp, struct sip_request *req, struct sip_epa_entry *epa_entry);
1646
1647 static void cc_epa_destructor(void *data)
1648 {
1649         struct sip_epa_entry *epa_entry = data;
1650         struct cc_epa_entry *cc_entry = epa_entry->instance_data;
1651         ast_free(cc_entry);
1652 }
1653
1654 static const struct epa_static_data cc_epa_static_data  = {
1655         .event = CALL_COMPLETION,
1656         .name = "call-completion",
1657         .handle_error = cc_handle_publish_error,
1658         .destructor = cc_epa_destructor,
1659 };
1660
1661 static const struct epa_static_data *find_static_data(const char * const event_package)
1662 {
1663         const struct epa_backend *backend = NULL;
1664
1665         AST_LIST_LOCK(&epa_static_data_list);
1666         AST_LIST_TRAVERSE(&epa_static_data_list, backend, next) {
1667                 if (!strcmp(backend->static_data->name, event_package)) {
1668                         break;
1669                 }
1670         }
1671         AST_LIST_UNLOCK(&epa_static_data_list);
1672         return backend ? backend->static_data : NULL;
1673 }
1674
1675 static struct sip_epa_entry *create_epa_entry (const char * const event_package, const char * const destination)
1676 {
1677         struct sip_epa_entry *epa_entry;
1678         const struct epa_static_data *static_data;
1679
1680         if (!(static_data = find_static_data(event_package))) {
1681                 return NULL;
1682         }
1683
1684         if (!(epa_entry = ao2_t_alloc(sizeof(*epa_entry), static_data->destructor, "Allocate new EPA entry"))) {
1685                 return NULL;
1686         }
1687
1688         epa_entry->static_data = static_data;
1689         ast_copy_string(epa_entry->destination, destination, sizeof(epa_entry->destination));
1690         return epa_entry;
1691 }
1692 static enum ast_cc_service_type service_string_to_service_type(const char * const service_string)
1693 {
1694         enum ast_cc_service_type service;
1695         for (service = AST_CC_CCBS; service <= AST_CC_CCNL; ++service) {
1696                 if (!strcasecmp(service_string, sip_cc_service_map[service].service_string)) {
1697                         return service;
1698                 }
1699         }
1700         return AST_CC_NONE;
1701 }
1702
1703 /* Even state compositors code */
1704 static void esc_entry_destructor(void *obj)
1705 {
1706         struct sip_esc_entry *esc_entry = obj;
1707         if (esc_entry->sched_id > -1) {
1708                 AST_SCHED_DEL(sched, esc_entry->sched_id);
1709         }
1710 }
1711
1712 static int esc_hash_fn(const void *obj, const int flags)
1713 {
1714         const struct sip_esc_entry *entry = obj;
1715         return ast_str_hash(entry->entity_tag);
1716 }
1717
1718 static int esc_cmp_fn(void *obj, void *arg, int flags)
1719 {
1720         struct sip_esc_entry *entry1 = obj;
1721         struct sip_esc_entry *entry2 = arg;
1722
1723         return (!strcmp(entry1->entity_tag, entry2->entity_tag)) ? (CMP_MATCH | CMP_STOP) : 0;
1724 }
1725
1726 static struct event_state_compositor *get_esc(const char * const event_package) {
1727         int i;
1728         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1729                 if (!strcasecmp(event_package, event_state_compositors[i].name)) {
1730                         return &event_state_compositors[i];
1731                 }
1732         }
1733         return NULL;
1734 }
1735
1736 static struct sip_esc_entry *get_esc_entry(const char * entity_tag, struct event_state_compositor *esc) {
1737         struct sip_esc_entry *entry;
1738         struct sip_esc_entry finder;
1739
1740         ast_copy_string(finder.entity_tag, entity_tag, sizeof(finder.entity_tag));
1741
1742         entry = ao2_find(esc->compositor, &finder, OBJ_POINTER);
1743
1744         return entry;
1745 }
1746
1747 static int publish_expire(const void *data)
1748 {
1749         struct sip_esc_entry *esc_entry = (struct sip_esc_entry *) data;
1750         struct event_state_compositor *esc = get_esc(esc_entry->event);
1751
1752         ast_assert(esc != NULL);
1753
1754         ao2_unlink(esc->compositor, esc_entry);
1755         esc_entry->sched_id = -1;
1756         ao2_ref(esc_entry, -1);
1757         return 0;
1758 }
1759
1760 static void create_new_sip_etag(struct sip_esc_entry *esc_entry, int is_linked)
1761 {
1762         int new_etag = ast_atomic_fetchadd_int(&esc_etag_counter, +1);
1763         struct event_state_compositor *esc = get_esc(esc_entry->event);
1764
1765         ast_assert(esc != NULL);
1766         if (is_linked) {
1767                 ao2_unlink(esc->compositor, esc_entry);
1768         }
1769         snprintf(esc_entry->entity_tag, sizeof(esc_entry->entity_tag), "%d", new_etag);
1770         ao2_link(esc->compositor, esc_entry);
1771 }
1772
1773 static struct sip_esc_entry *create_esc_entry(struct event_state_compositor *esc, struct sip_request *req, const int expires)
1774 {
1775         struct sip_esc_entry *esc_entry;
1776         int expires_ms;
1777
1778         if (!(esc_entry = ao2_alloc(sizeof(*esc_entry), esc_entry_destructor))) {
1779                 return NULL;
1780         }
1781
1782         esc_entry->event = esc->name;
1783
1784         expires_ms = expires * 1000;
1785         /* Bump refcount for scheduler */
1786         ao2_ref(esc_entry, +1);
1787         esc_entry->sched_id = ast_sched_add(sched, expires_ms, publish_expire, esc_entry);
1788         if (esc_entry->sched_id == -1) {
1789                 ao2_ref(esc_entry, -1);
1790                 ao2_ref(esc_entry, -1);
1791                 return NULL;
1792         }
1793
1794         /* Note: This links the esc_entry into the ESC properly */
1795         create_new_sip_etag(esc_entry, 0);
1796
1797         return esc_entry;
1798 }
1799
1800 static int initialize_escs(void)
1801 {
1802         int i, res = 0;
1803         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1804                 if (!((event_state_compositors[i].compositor) =
1805                                         ao2_container_alloc(ESC_MAX_BUCKETS, esc_hash_fn, esc_cmp_fn))) {
1806                         res = -1;
1807                 }
1808         }
1809         return res;
1810 }
1811
1812 static void destroy_escs(void)
1813 {
1814         int i;
1815         for (i = 0; i < ARRAY_LEN(event_state_compositors); i++) {
1816                 ao2_replace(event_state_compositors[i].compositor, NULL);
1817         }
1818 }
1819
1820
1821 static int find_by_notify_uri_helper(void *obj, void *arg, int flags)
1822 {
1823         struct ast_cc_agent *agent = obj;
1824         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1825         const char *uri = arg;
1826
1827         return !sip_uri_cmp(agent_pvt->notify_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1828 }
1829
1830 static struct ast_cc_agent *find_sip_cc_agent_by_notify_uri(const char * const uri)
1831 {
1832         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_notify_uri_helper, (char *)uri, "SIP");
1833         return agent;
1834 }
1835
1836 static int find_by_subscribe_uri_helper(void *obj, void *arg, int flags)
1837 {
1838         struct ast_cc_agent *agent = obj;
1839         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1840         const char *uri = arg;
1841
1842         return !sip_uri_cmp(agent_pvt->subscribe_uri, uri) ? CMP_MATCH | CMP_STOP : 0;
1843 }
1844
1845 static struct ast_cc_agent *find_sip_cc_agent_by_subscribe_uri(const char * const uri)
1846 {
1847         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_subscribe_uri_helper, (char *)uri, "SIP");
1848         return agent;
1849 }
1850
1851 static int find_by_callid_helper(void *obj, void *arg, int flags)
1852 {
1853         struct ast_cc_agent *agent = obj;
1854         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1855         struct sip_pvt *call_pvt = arg;
1856
1857         return !strcmp(agent_pvt->original_callid, call_pvt->callid) ? CMP_MATCH | CMP_STOP : 0;
1858 }
1859
1860 static struct ast_cc_agent *find_sip_cc_agent_by_original_callid(struct sip_pvt *pvt)
1861 {
1862         struct ast_cc_agent *agent = ast_cc_agent_callback(0, find_by_callid_helper, pvt, "SIP");
1863         return agent;
1864 }
1865
1866 static int sip_cc_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan)
1867 {
1868         struct sip_cc_agent_pvt *agent_pvt = ast_calloc(1, sizeof(*agent_pvt));
1869         struct sip_pvt *call_pvt = ast_channel_tech_pvt(chan);
1870
1871         if (!agent_pvt) {
1872                 return -1;
1873         }
1874
1875         ast_assert(!strcmp(ast_channel_tech(chan)->type, "SIP"));
1876
1877         ast_copy_string(agent_pvt->original_callid, call_pvt->callid, sizeof(agent_pvt->original_callid));
1878         ast_copy_string(agent_pvt->original_exten, call_pvt->exten, sizeof(agent_pvt->original_exten));
1879         agent_pvt->offer_timer_id = -1;
1880         agent->private_data = agent_pvt;
1881         sip_pvt_lock(call_pvt);
1882         ast_set_flag(&call_pvt->flags[0], SIP_OFFER_CC);
1883         sip_pvt_unlock(call_pvt);
1884         return 0;
1885 }
1886
1887 static int sip_offer_timer_expire(const void *data)
1888 {
1889         struct ast_cc_agent *agent = (struct ast_cc_agent *) data;
1890         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1891
1892         agent_pvt->offer_timer_id = -1;
1893
1894         return ast_cc_failed(agent->core_id, "SIP agent %s's offer timer expired", agent->device_name);
1895 }
1896
1897 static int sip_cc_agent_start_offer_timer(struct ast_cc_agent *agent)
1898 {
1899         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1900         int when;
1901
1902         when = ast_get_cc_offer_timer(agent->cc_params) * 1000;
1903         agent_pvt->offer_timer_id = ast_sched_add(sched, when, sip_offer_timer_expire, agent);
1904         return 0;
1905 }
1906
1907 static int sip_cc_agent_stop_offer_timer(struct ast_cc_agent *agent)
1908 {
1909         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1910
1911         AST_SCHED_DEL(sched, agent_pvt->offer_timer_id);
1912         return 0;
1913 }
1914
1915 static void sip_cc_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
1916 {
1917         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1918
1919         sip_pvt_lock(agent_pvt->subscribe_pvt);
1920         ast_set_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED);
1921         if (reason == AST_CC_AGENT_RESPONSE_SUCCESS || !ast_strlen_zero(agent_pvt->notify_uri)) {
1922                 /* The second half of this if statement may be a bit hard to grasp,
1923                  * so here's an explanation. When a subscription comes into
1924                  * chan_sip, as long as it is not malformed, it will be passed
1925                  * to the CC core. If the core senses an out-of-order state transition,
1926                  * then the core will call this callback with the "reason" set to a
1927                  * failure condition.
1928                  * However, an out-of-order state transition will occur during a resubscription
1929                  * for CC. In such a case, we can see that we have already generated a notify_uri
1930                  * and so we can detect that this isn't a *real* failure. Rather, it is just
1931                  * something the core doesn't recognize as a legitimate SIP state transition.
1932                  * Thus we respond with happiness and flowers.
1933                  */
1934                 transmit_response(agent_pvt->subscribe_pvt, "200 OK", &agent_pvt->subscribe_pvt->initreq);
1935                 transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_QUEUED);
1936         } else {
1937                 transmit_response(agent_pvt->subscribe_pvt, "500 Internal Error", &agent_pvt->subscribe_pvt->initreq);
1938         }
1939         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1940         agent_pvt->is_available = TRUE;
1941 }
1942
1943 static int sip_cc_agent_status_request(struct ast_cc_agent *agent)
1944 {
1945         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1946         enum ast_device_state state = agent_pvt->is_available ? AST_DEVICE_NOT_INUSE : AST_DEVICE_INUSE;
1947         return ast_cc_agent_status_response(agent->core_id, state);
1948 }
1949
1950 static int sip_cc_agent_start_monitoring(struct ast_cc_agent *agent)
1951 {
1952         /* To start monitoring just means to wait for an incoming PUBLISH
1953          * to tell us that the caller has become available again. No special
1954          * action is needed
1955          */
1956         return 0;
1957 }
1958
1959 static int sip_cc_agent_recall(struct ast_cc_agent *agent)
1960 {
1961         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1962         /* If we have received a PUBLISH beforehand stating that the caller in question
1963          * is not available, we can save ourself a bit of effort here and just report
1964          * the caller as busy
1965          */
1966         if (!agent_pvt->is_available) {
1967                 return ast_cc_agent_caller_busy(agent->core_id, "Caller %s is busy, reporting to the core",
1968                                 agent->device_name);
1969         }
1970         /* Otherwise, we transmit a NOTIFY to the caller and await either
1971          * a PUBLISH or an INVITE
1972          */
1973         sip_pvt_lock(agent_pvt->subscribe_pvt);
1974         transmit_cc_notify(agent, agent_pvt->subscribe_pvt, CC_READY);
1975         sip_pvt_unlock(agent_pvt->subscribe_pvt);
1976         return 0;
1977 }
1978
1979 static void sip_cc_agent_destructor(struct ast_cc_agent *agent)
1980 {
1981         struct sip_cc_agent_pvt *agent_pvt = agent->private_data;
1982
1983         if (!agent_pvt) {
1984                 /* The agent constructor probably failed. */
1985                 return;
1986         }
1987
1988         sip_cc_agent_stop_offer_timer(agent);
1989         if (agent_pvt->subscribe_pvt) {
1990                 sip_pvt_lock(agent_pvt->subscribe_pvt);
1991                 if (!ast_test_flag(&agent_pvt->subscribe_pvt->flags[1], SIP_PAGE2_DIALOG_ESTABLISHED)) {
1992                         /* If we haven't sent a 200 OK for the SUBSCRIBE dialog yet, then we need to send a response letting
1993                          * the subscriber know something went wrong
1994                          */
1995                         transmit_response(agent_pvt->subscribe_pvt, "500 Internal Server Error", &agent_pvt->subscribe_pvt->initreq);
1996                 }
1997                 sip_pvt_unlock(agent_pvt->subscribe_pvt);
1998                 agent_pvt->subscribe_pvt = dialog_unref(agent_pvt->subscribe_pvt, "SIP CC agent destructor: Remove ref to subscription");
1999         }
2000         ast_free(agent_pvt);
2001 }
2002
2003
2004 static int sip_monitor_instance_hash_fn(const void *obj, const int flags)
2005 {
2006         const struct sip_monitor_instance *monitor_instance = obj;
2007         return monitor_instance->core_id;
2008 }
2009
2010 static int sip_monitor_instance_cmp_fn(void *obj, void *arg, int flags)
2011 {
2012         struct sip_monitor_instance *monitor_instance1 = obj;
2013         struct sip_monitor_instance *monitor_instance2 = arg;
2014
2015         return monitor_instance1->core_id == monitor_instance2->core_id ? CMP_MATCH | CMP_STOP : 0;
2016 }
2017
2018 static void sip_monitor_instance_destructor(void *data)
2019 {
2020         struct sip_monitor_instance *monitor_instance = data;
2021         if (monitor_instance->subscription_pvt) {
2022                 sip_pvt_lock(monitor_instance->subscription_pvt);
2023                 monitor_instance->subscription_pvt->expiry = 0;
2024                 transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 0, monitor_instance->subscribe_uri);
2025                 sip_pvt_unlock(monitor_instance->subscription_pvt);
2026                 dialog_unref(monitor_instance->subscription_pvt, "Unref monitor instance ref of subscription pvt");
2027         }
2028         if (monitor_instance->suspension_entry) {
2029                 monitor_instance->suspension_entry->body[0] = '\0';
2030                 transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_REMOVE ,monitor_instance->notify_uri);
2031                 ao2_t_ref(monitor_instance->suspension_entry, -1, "Decrementing suspension entry refcount in sip_monitor_instance_destructor");
2032         }
2033         ast_string_field_free_memory(monitor_instance);
2034 }
2035
2036 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)
2037 {
2038         struct sip_monitor_instance *monitor_instance = ao2_alloc(sizeof(*monitor_instance), sip_monitor_instance_destructor);
2039
2040         if (!monitor_instance) {
2041                 return NULL;
2042         }
2043
2044         if (ast_string_field_init(monitor_instance, 256)) {
2045                 ao2_ref(monitor_instance, -1);
2046                 return NULL;
2047         }
2048
2049         ast_string_field_set(monitor_instance, subscribe_uri, subscribe_uri);
2050         ast_string_field_set(monitor_instance, peername, peername);
2051         ast_string_field_set(monitor_instance, device_name, device_name);
2052         monitor_instance->core_id = core_id;
2053         ao2_link(sip_monitor_instances, monitor_instance);
2054         return monitor_instance;
2055 }
2056
2057 static int find_sip_monitor_instance_by_subscription_pvt(void *obj, void *arg, int flags)
2058 {
2059         struct sip_monitor_instance *monitor_instance = obj;
2060         return monitor_instance->subscription_pvt == arg ? CMP_MATCH | CMP_STOP : 0;
2061 }
2062
2063 static int find_sip_monitor_instance_by_suspension_entry(void *obj, void *arg, int flags)
2064 {
2065         struct sip_monitor_instance *monitor_instance = obj;
2066         return monitor_instance->suspension_entry == arg ? CMP_MATCH | CMP_STOP : 0;
2067 }
2068
2069 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
2070 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor);
2071 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor);
2072 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
2073 static void sip_cc_monitor_destructor(void *private_data);
2074
2075 static struct ast_cc_monitor_callbacks sip_cc_monitor_callbacks = {
2076         .type = "SIP",
2077         .request_cc = sip_cc_monitor_request_cc,
2078         .suspend = sip_cc_monitor_suspend,
2079         .unsuspend = sip_cc_monitor_unsuspend,
2080         .cancel_available_timer = sip_cc_monitor_cancel_available_timer,
2081         .destructor = sip_cc_monitor_destructor,
2082 };
2083
2084 static int sip_cc_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id)
2085 {
2086         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2087         enum ast_cc_service_type service = monitor->service_offered;
2088         int when;
2089
2090         if (!monitor_instance) {
2091                 return -1;
2092         }
2093
2094         if (!(monitor_instance->subscription_pvt = sip_alloc(NULL, NULL, 0, SIP_SUBSCRIBE, NULL, 0))) {
2095                 return -1;
2096         }
2097
2098         when = service == AST_CC_CCBS ? ast_get_ccbs_available_timer(monitor->interface->config_params) :
2099                 ast_get_ccnr_available_timer(monitor->interface->config_params);
2100
2101         sip_pvt_lock(monitor_instance->subscription_pvt);
2102         ast_set_flag(&monitor_instance->subscription_pvt->flags[0], SIP_OUTGOING);
2103         create_addr(monitor_instance->subscription_pvt, monitor_instance->peername, 0, 1);
2104         ast_sip_ouraddrfor(&monitor_instance->subscription_pvt->sa, &monitor_instance->subscription_pvt->ourip, monitor_instance->subscription_pvt);
2105         monitor_instance->subscription_pvt->subscribed = CALL_COMPLETION;
2106         monitor_instance->subscription_pvt->expiry = when;
2107
2108         transmit_invite(monitor_instance->subscription_pvt, SIP_SUBSCRIBE, FALSE, 2, monitor_instance->subscribe_uri);
2109         sip_pvt_unlock(monitor_instance->subscription_pvt);
2110
2111         ao2_t_ref(monitor, +1, "Adding a ref to the monitor for the scheduler");
2112         *available_timer_id = ast_sched_add(sched, when * 1000, ast_cc_available_timer_expire, monitor);
2113         return 0;
2114 }
2115
2116 static int construct_pidf_body(enum sip_cc_publish_state state, char *pidf_body, size_t size, const char *presentity)
2117 {
2118         struct ast_str *body = ast_str_alloca(size);
2119         char tuple_id[64];
2120
2121         generate_random_string(tuple_id, sizeof(tuple_id));
2122
2123         /* We'll make this a bare-bones pidf body. In state_notify_build_xml, the PIDF
2124          * body gets a lot more extra junk that isn't necessary, so we'll leave it out here.
2125          */
2126         ast_str_append(&body, 0, "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
2127         /* XXX The entity attribute is currently set to the peer name associated with the
2128          * dialog. This is because we currently only call this function for call-completion
2129          * PUBLISH bodies. In such cases, the entity is completely disregarded. For other
2130          * event packages, it may be crucial to have a proper URI as the presentity so this
2131          * should be revisited as support is expanded.
2132          */
2133         ast_str_append(&body, 0, "<presence xmlns=\"urn:ietf:params:xml:ns:pidf\" entity=\"%s\">\n", presentity);
2134         ast_str_append(&body, 0, "<tuple id=\"%s\">\n", tuple_id);
2135         ast_str_append(&body, 0, "<status><basic>%s</basic></status>\n", state == CC_OPEN ? "open" : "closed");
2136         ast_str_append(&body, 0, "</tuple>\n");
2137         ast_str_append(&body, 0, "</presence>\n");
2138         ast_copy_string(pidf_body, ast_str_buffer(body), size);
2139         return 0;
2140 }
2141
2142 static int sip_cc_monitor_suspend(struct ast_cc_monitor *monitor)
2143 {
2144         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2145         enum sip_publish_type publish_type;
2146         struct cc_epa_entry *cc_entry;
2147
2148         if (!monitor_instance) {
2149                 return -1;
2150         }
2151
2152         if (!monitor_instance->suspension_entry) {
2153                 /* We haven't yet allocated the suspension entry, so let's give it a shot */
2154                 if (!(monitor_instance->suspension_entry = create_epa_entry("call-completion", monitor_instance->peername))) {
2155                         ast_log(LOG_WARNING, "Unable to allocate sip EPA entry for call-completion\n");
2156                         ao2_ref(monitor_instance, -1);
2157                         return -1;
2158                 }
2159                 if (!(cc_entry = ast_calloc(1, sizeof(*cc_entry)))) {
2160                         ast_log(LOG_WARNING, "Unable to allocate space for instance data of EPA entry for call-completion\n");
2161                         ao2_ref(monitor_instance, -1);
2162                         return -1;
2163                 }
2164                 cc_entry->core_id = monitor->core_id;
2165                 monitor_instance->suspension_entry->instance_data = cc_entry;
2166                 publish_type = SIP_PUBLISH_INITIAL;
2167         } else {
2168                 publish_type = SIP_PUBLISH_MODIFY;
2169                 cc_entry = monitor_instance->suspension_entry->instance_data;
2170         }
2171
2172         cc_entry->current_state = CC_CLOSED;
2173
2174         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2175                 /* If we have no set notify_uri, then what this means is that we have
2176                  * not received a NOTIFY from this destination stating that he is
2177                  * currently available.
2178                  *
2179                  * This situation can arise when the core calls the suspend callbacks
2180                  * of multiple destinations. If one of the other destinations aside
2181                  * from this one notified Asterisk that he is available, then there
2182                  * is no reason to take any suspension action on this device. Rather,
2183                  * we should return now and if we receive a NOTIFY while monitoring
2184                  * is still "suspended" then we can immediately respond with the
2185                  * proper PUBLISH to let this endpoint know what is going on.
2186                  */
2187                 return 0;
2188         }
2189         construct_pidf_body(CC_CLOSED, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2190         return transmit_publish(monitor_instance->suspension_entry, publish_type, monitor_instance->notify_uri);
2191 }
2192
2193 static int sip_cc_monitor_unsuspend(struct ast_cc_monitor *monitor)
2194 {
2195         struct sip_monitor_instance *monitor_instance = monitor->private_data;
2196         struct cc_epa_entry *cc_entry;
2197
2198         if (!monitor_instance) {
2199                 return -1;
2200         }
2201
2202         ast_assert(monitor_instance->suspension_entry != NULL);
2203
2204         cc_entry = monitor_instance->suspension_entry->instance_data;
2205         cc_entry->current_state = CC_OPEN;
2206         if (ast_strlen_zero(monitor_instance->notify_uri)) {
2207                 /* This means we are being asked to unsuspend a call leg we never
2208                  * sent a PUBLISH on. As such, there is no reason to send another
2209                  * PUBLISH at this point either. We can just return instead.
2210                  */
2211                 return 0;
2212         }
2213         construct_pidf_body(CC_OPEN, monitor_instance->suspension_entry->body, sizeof(monitor_instance->suspension_entry->body), monitor_instance->peername);
2214         return transmit_publish(monitor_instance->suspension_entry, SIP_PUBLISH_MODIFY, monitor_instance->notify_uri);
2215 }
2216
2217 static int sip_cc_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id)
2218 {
2219         if (*sched_id != -1) {
2220                 AST_SCHED_DEL(sched, *sched_id);
2221                 ao2_t_ref(monitor, -1, "Removing scheduler's reference to the monitor");
2222         }
2223         return 0;
2224 }
2225
2226 static void sip_cc_monitor_destructor(void *private_data)
2227 {
2228         struct sip_monitor_instance *monitor_instance = private_data;
2229         ao2_unlink(sip_monitor_instances, monitor_instance);
2230         ast_module_unref(ast_module_info->self);
2231 }
2232
2233 static int sip_get_cc_information(struct sip_request *req, char *subscribe_uri, size_t size, enum ast_cc_service_type *service)
2234 {
2235         char *call_info = ast_strdupa(sip_get_header(req, "Call-Info"));
2236         char *uri;
2237         char *purpose;
2238         char *service_str;
2239         static const char cc_purpose[] = "purpose=call-completion";
2240         static const int cc_purpose_len = sizeof(cc_purpose) - 1;
2241
2242         if (ast_strlen_zero(call_info)) {
2243                 /* No Call-Info present. Definitely no CC offer */
2244                 return -1;
2245         }
2246
2247         uri = strsep(&call_info, ";");
2248
2249         while ((purpose = strsep(&call_info, ";"))) {
2250                 if (!strncmp(purpose, cc_purpose, cc_purpose_len)) {
2251                         break;
2252                 }
2253         }
2254         if (!purpose) {
2255                 /* We didn't find the appropriate purpose= parameter. Oh well */
2256                 return -1;
2257         }
2258
2259         /* Okay, call-completion has been offered. Let's figure out what type of service this is */
2260         while ((service_str = strsep(&call_info, ";"))) {
2261                 if (!strncmp(service_str, "m=", 2)) {
2262                         break;
2263                 }
2264         }
2265         if (!service_str) {
2266                 /* So they didn't offer a particular service, We'll just go with CCBS since it really
2267                  * doesn't matter anyway
2268                  */
2269                 service_str = "BS";
2270         } else {
2271                 /* We already determined that there is an "m=" so no need to check
2272                  * the result of this strsep
2273                  */
2274                 strsep(&service_str, "=");
2275         }
2276
2277         if ((*service = service_string_to_service_type(service_str)) == AST_CC_NONE) {
2278                 /* Invalid service offered */
2279                 return -1;
2280         }
2281
2282         ast_copy_string(subscribe_uri, get_in_brackets(uri), size);
2283
2284         return 0;
2285 }
2286
2287 /*
2288  * \brief Determine what, if any, CC has been offered and queue a CC frame if possible
2289  *
2290  * After taking care of some formalities to be sure that this call is eligible for CC,
2291  * we first try to see if we can make use of native CC. We grab the information from
2292  * the passed-in sip_request (which is always a response to an INVITE). If we can
2293  * use native CC monitoring for the call, then so be it.
2294  *
2295  * If native cc monitoring is not possible or not supported, then we will instead attempt
2296  * to use generic monitoring. Falling back to generic from a failed attempt at using native
2297  * monitoring will only work if the monitor policy of the endpoint is "always"
2298  *
2299  * \param pvt The current dialog. Contains CC parameters for the endpoint
2300  * \param req The response to the INVITE we want to inspect
2301  * \param service The service to use if generic monitoring is to be used. For native
2302  * monitoring, we get the service from the SIP response itself
2303  */
2304 static void sip_handle_cc(struct sip_pvt *pvt, struct sip_request *req, enum ast_cc_service_type service)
2305 {
2306         enum ast_cc_monitor_policies monitor_policy = ast_get_cc_monitor_policy(pvt->cc_params);
2307         int core_id;
2308         char interface_name[AST_CHANNEL_NAME];
2309
2310         if (monitor_policy == AST_CC_MONITOR_NEVER) {
2311                 /* Don't bother, just return */
2312                 return;
2313         }
2314
2315         if ((core_id = ast_cc_get_current_core_id(pvt->owner)) == -1) {
2316                 /* For some reason, CC is invalid, so don't try it! */
2317                 return;
2318         }
2319
2320         ast_channel_get_device_name(pvt->owner, interface_name, sizeof(interface_name));
2321
2322         if (monitor_policy == AST_CC_MONITOR_ALWAYS || monitor_policy == AST_CC_MONITOR_NATIVE) {
2323                 char subscribe_uri[SIPBUFSIZE];
2324                 char device_name[AST_CHANNEL_NAME];
2325                 enum ast_cc_service_type offered_service;
2326                 struct sip_monitor_instance *monitor_instance;
2327                 if (sip_get_cc_information(req, subscribe_uri, sizeof(subscribe_uri), &offered_service)) {
2328                         /* If CC isn't being offered to us, or for some reason the CC offer is
2329                          * not formatted correctly, then it may still be possible to use generic
2330                          * call completion since the monitor policy may be "always"
2331                          */
2332                         goto generic;
2333                 }
2334                 ast_channel_get_device_name(pvt->owner, device_name, sizeof(device_name));
2335                 if (!(monitor_instance = sip_monitor_instance_init(core_id, subscribe_uri, pvt->peername, device_name))) {
2336                         /* Same deal. We can try using generic still */
2337                         goto generic;
2338                 }
2339                 /* We bump the refcount of chan_sip because once we queue this frame, the CC core
2340                  * will have a reference to callbacks in this module. We decrement the module
2341                  * refcount once the monitor destructor is called
2342                  */
2343                 ast_module_ref(ast_module_info->self);
2344                 ast_queue_cc_frame(pvt->owner, "SIP", pvt->dialstring, offered_service, monitor_instance);
2345                 ao2_ref(monitor_instance, -1);
2346                 return;
2347         }
2348
2349 generic:
2350         if (monitor_policy == AST_CC_MONITOR_GENERIC || monitor_policy == AST_CC_MONITOR_ALWAYS) {
2351                 ast_queue_cc_frame(pvt->owner, AST_CC_GENERIC_MONITOR_TYPE, interface_name, service, NULL);
2352         }
2353 }
2354
2355 /*! \brief Working TLS connection configuration */
2356 static struct ast_tls_config sip_tls_cfg;
2357
2358 /*! \brief Default TLS connection configuration */
2359 static struct ast_tls_config default_tls_cfg;
2360
2361 /*! \brief Default DTLS connection configuration */
2362 static struct ast_rtp_dtls_cfg default_dtls_cfg;
2363
2364 /*! \brief The TCP server definition */
2365 static struct ast_tcptls_session_args sip_tcp_desc = {
2366         .accept_fd = -1,
2367         .master = AST_PTHREADT_NULL,
2368         .tls_cfg = NULL,
2369         .poll_timeout = -1,
2370         .name = "SIP TCP server",
2371         .accept_fn = ast_tcptls_server_root,
2372         .worker_fn = sip_tcp_worker_fn,
2373 };
2374
2375 /*! \brief The TCP/TLS server definition */
2376 static struct ast_tcptls_session_args sip_tls_desc = {
2377         .accept_fd = -1,
2378         .master = AST_PTHREADT_NULL,
2379         .tls_cfg = &sip_tls_cfg,
2380         .poll_timeout = -1,
2381         .name = "SIP TLS server",
2382         .accept_fn = ast_tcptls_server_root,
2383         .worker_fn = sip_tcp_worker_fn,
2384 };
2385
2386 /*! \brief Append to SIP dialog history
2387         \return Always returns 0 */
2388 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
2389
2390 /*! \brief map from an integer value to a string.
2391  * If no match is found, return errorstring
2392  */
2393 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2394 {
2395         const struct _map_x_s *cur;
2396
2397         for (cur = table; cur->s; cur++) {
2398                 if (cur->x == x) {
2399                         return cur->s;
2400                 }
2401         }
2402         return errorstring;
2403 }
2404
2405 /*! \brief map from a string to an integer value, case insensitive.
2406  * If no match is found, return errorvalue.
2407  */
2408 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2409 {
2410         const struct _map_x_s *cur;
2411
2412         for (cur = table; cur->s; cur++) {
2413                 if (!strcasecmp(cur->s, s)) {
2414                         return cur->x;
2415                 }
2416         }
2417         return errorvalue;
2418 }
2419
2420 /*!
2421  * \internal
2422  * \brief Determine if the given string is a SIP token.
2423  * \since 13.8.0
2424  *
2425  * \param str String to determine if is a SIP token.
2426  *
2427  * \note A token is defined by RFC3261 Section 25.1
2428  *
2429  * \return Non-zero if the string is a SIP token.
2430  */
2431 static int sip_is_token(const char *str)
2432 {
2433         int is_token;
2434
2435         if (ast_strlen_zero(str)) {
2436                 /* An empty string is not a token. */
2437                 return 0;
2438         }
2439
2440         is_token = 1;
2441         do {
2442                 if (!isalnum(*str)
2443                         && !strchr("-.!%*_+`'~", *str)) {
2444                         /* The character is not allowed in a token. */
2445                         is_token = 0;
2446                         break;
2447                 }
2448         } while (*++str);
2449
2450         return is_token;
2451 }
2452
2453 static const char *sip_reason_code_to_str(struct ast_party_redirecting_reason *reason)
2454 {
2455         int idx;
2456         int code;
2457
2458         /* use specific string if given */
2459         if (!ast_strlen_zero(reason->str)) {
2460                 return reason->str;
2461         }
2462
2463         code = reason->code;
2464         for (idx = 0; idx < ARRAY_LEN(sip_reason_table); ++idx) {
2465                 if (code == sip_reason_table[idx].code) {
2466                         return sip_reason_table[idx].text;
2467                 }
2468         }
2469
2470         return "unknown";
2471 }
2472
2473 /*!
2474  * \brief generic function for determining if a correct transport is being
2475  * used to contact a peer
2476  *
2477  * this is done as a macro so that the "tmpl" var can be passed either a
2478  * sip_request or a sip_peer
2479  */
2480 #define check_request_transport(peer, tmpl) ({ \
2481         int ret = 0; \
2482         if (peer->socket.type == tmpl->socket.type) \
2483                 ; \
2484         else if (!(peer->transports & tmpl->socket.type)) {\
2485                 ast_log(LOG_ERROR, \
2486                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
2487                         sip_get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
2488                         ); \
2489                 ret = 1; \
2490         } else if (peer->socket.type & AST_TRANSPORT_TLS) { \
2491                 ast_log(LOG_WARNING, \
2492                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
2493                         peer->name, sip_get_transport(tmpl->socket.type) \
2494                 ); \
2495         } else { \
2496                 ast_debug(1, \
2497                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
2498                         peer->name, sip_get_transport(tmpl->socket.type), sip_get_transport(peer->socket.type) \
2499                 ); \
2500         }\
2501         (ret); \
2502 })
2503
2504 /*! \brief
2505  * duplicate a list of channel variables, \return the copy.
2506  */
2507 static struct ast_variable *copy_vars(struct ast_variable *src)
2508 {
2509         struct ast_variable *res = NULL, *tmp, *v = NULL;
2510
2511         for (v = src ; v ; v = v->next) {
2512                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
2513                         tmp->next = res;
2514                         res = tmp;
2515                 }
2516         }
2517         return res;
2518 }
2519
2520 static void tcptls_packet_destructor(void *obj)
2521 {
2522         struct tcptls_packet *packet = obj;
2523
2524         ast_free(packet->data);
2525 }
2526
2527 static void sip_tcptls_client_args_destructor(void *obj)
2528 {
2529         struct ast_tcptls_session_args *args = obj;
2530         if (args->tls_cfg) {
2531                 ast_free(args->tls_cfg->certfile);
2532                 ast_free(args->tls_cfg->pvtfile);
2533                 ast_free(args->tls_cfg->cipher);
2534                 ast_free(args->tls_cfg->cafile);
2535                 ast_free(args->tls_cfg->capath);
2536
2537                 ast_ssl_teardown(args->tls_cfg);
2538         }
2539         ast_free(args->tls_cfg);
2540         ast_free((char *) args->name);
2541 }
2542
2543 static void sip_threadinfo_destructor(void *obj)
2544 {
2545         struct sip_threadinfo *th = obj;
2546         struct tcptls_packet *packet;
2547
2548         if (th->alert_pipe[0] > -1) {
2549                 close(th->alert_pipe[0]);
2550         }
2551         if (th->alert_pipe[1] > -1) {
2552                 close(th->alert_pipe[1]);
2553         }
2554         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2555
2556         while ((packet = AST_LIST_REMOVE_HEAD(&th->packet_q, entry))) {
2557                 ao2_t_ref(packet, -1, "thread destruction, removing packet from frame queue");
2558         }
2559
2560         if (th->tcptls_session) {
2561                 ao2_t_ref(th->tcptls_session, -1, "remove tcptls_session for sip_threadinfo object");
2562         }
2563 }
2564
2565 /*! \brief creates a sip_threadinfo object and links it into the threadt table. */
2566 static struct sip_threadinfo *sip_threadinfo_create(struct ast_tcptls_session_instance *tcptls_session, int transport)
2567 {
2568         struct sip_threadinfo *th;
2569
2570         if (!tcptls_session || !(th = ao2_alloc(sizeof(*th), sip_threadinfo_destructor))) {
2571                 return NULL;
2572         }
2573
2574         th->alert_pipe[0] = th->alert_pipe[1] = -1;
2575
2576         if (pipe(th->alert_pipe) == -1) {
2577                 ao2_t_ref(th, -1, "Failed to open alert pipe on sip_threadinfo");
2578                 ast_log(LOG_ERROR, "Could not create sip alert pipe in tcptls thread, error %s\n", strerror(errno));
2579                 return NULL;
2580         }
2581         ao2_t_ref(tcptls_session, +1, "tcptls_session ref for sip_threadinfo object");
2582         th->tcptls_session = tcptls_session;
2583         th->type = transport ? transport : (ast_iostream_get_ssl(tcptls_session->stream) ? AST_TRANSPORT_TLS: AST_TRANSPORT_TCP);
2584         ao2_t_link(threadt, th, "Adding new tcptls helper thread");
2585         ao2_t_ref(th, -1, "Decrementing threadinfo ref from alloc, only table ref remains");
2586         return th;
2587 }
2588
2589 /*! \brief used to indicate to a tcptls thread that data is ready to be written */
2590 static int sip_tcptls_write(struct ast_tcptls_session_instance *tcptls_session, const void *buf, size_t len)
2591 {
2592         int res = len;
2593         struct sip_threadinfo *th = NULL;
2594         struct tcptls_packet *packet = NULL;
2595         struct sip_threadinfo tmp = {
2596                 .tcptls_session = tcptls_session,
2597         };
2598         enum sip_tcptls_alert alert = TCPTLS_ALERT_DATA;
2599
2600         if (!tcptls_session) {
2601                 return XMIT_ERROR;
2602         }
2603
2604         ao2_lock(tcptls_session);
2605
2606         if (!(th = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread")) ||
2607                 !(packet = ao2_alloc(sizeof(*packet), tcptls_packet_destructor)) ||
2608                 !(packet->data = ast_str_create(len))) {
2609                 goto tcptls_write_setup_error;
2610         }
2611
2612         /* goto tcptls_write_error should _NOT_ be used beyond this point */
2613         ast_str_set(&packet->data, 0, "%s", (char *) buf);
2614         packet->len = len;
2615
2616         /* alert tcptls thread handler that there is a packet to be sent.
2617          * must lock the thread info object to guarantee control of the
2618          * packet queue */
2619         ao2_lock(th);
2620         if (write(th->alert_pipe[1], &alert, sizeof(alert)) == -1) {
2621                 ast_log(LOG_ERROR, "write() to alert pipe failed: %s\n", strerror(errno));
2622                 ao2_t_ref(packet, -1, "could not write to alert pipe, remove packet");
2623                 packet = NULL;
2624                 res = XMIT_ERROR;
2625         } else { /* it is safe to queue the frame after issuing the alert when we hold the threadinfo lock */
2626                 AST_LIST_INSERT_TAIL(&th->packet_q, packet, entry);
2627         }
2628         ao2_unlock(th);
2629
2630         ao2_unlock(tcptls_session);
2631         ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo object after finding it");
2632         return res;
2633
2634 tcptls_write_setup_error:
2635         if (th) {
2636                 ao2_t_ref(th, -1, "In sip_tcptls_write, unref threadinfo obj, could not create packet");
2637         }
2638         if (packet) {
2639                 ao2_t_ref(packet, -1, "could not allocate packet's data");
2640         }
2641         ao2_unlock(tcptls_session);
2642
2643         return XMIT_ERROR;
2644 }
2645
2646 /*! \brief SIP TCP connection handler */
2647 static void *sip_tcp_worker_fn(void *data)
2648 {
2649         struct ast_tcptls_session_instance *tcptls_session = data;
2650
2651         return _sip_tcp_helper_thread(tcptls_session);
2652 }
2653
2654 /*! \brief SIP WebSocket connection handler */
2655 static void sip_websocket_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers)
2656 {
2657         int res;
2658
2659         if (ast_websocket_set_nonblock(session)) {
2660                 goto end;
2661         }
2662
2663         if (ast_websocket_set_timeout(session, sip_cfg.websocket_write_timeout)) {
2664                 goto end;
2665         }
2666
2667         while ((res = ast_wait_for_input(ast_websocket_fd(session), -1)) > 0) {
2668                 char *payload;
2669                 uint64_t payload_len;
2670                 enum ast_websocket_opcode opcode;
2671                 int fragmented;
2672
2673                 if (ast_websocket_read(session, &payload, &payload_len, &opcode, &fragmented)) {
2674                         /* We err on the side of caution and terminate the session if any error occurs */
2675                         break;
2676                 }
2677
2678                 if (opcode == AST_WEBSOCKET_OPCODE_TEXT || opcode == AST_WEBSOCKET_OPCODE_BINARY) {
2679                         struct sip_request req = { 0, };
2680                         char data[payload_len + 1];
2681
2682                         if (!(req.data = ast_str_create(payload_len + 1))) {
2683                                 goto end;
2684                         }
2685
2686                         strncpy(data, payload, payload_len);
2687                         data[payload_len] = '\0';
2688
2689                         if (ast_str_set(&req.data, -1, "%s", data) == AST_DYNSTR_BUILD_FAILED) {
2690                                 deinit_req(&req);
2691                                 goto end;
2692                         }
2693
2694                         req.socket.fd = ast_websocket_fd(session);
2695                         set_socket_transport(&req.socket, ast_websocket_is_secure(session) ? AST_TRANSPORT_WSS : AST_TRANSPORT_WS);
2696                         req.socket.ws_session = session;
2697
2698                         handle_request_do(&req, ast_websocket_remote_address(session));
2699                         deinit_req(&req);
2700
2701                 } else if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
2702                         break;
2703                 }
2704         }
2705
2706 end:
2707         ast_websocket_unref(session);
2708 }
2709
2710 /*! \brief Check if the authtimeout has expired.
2711  * \param start the time when the session started
2712  *
2713  * \retval 0 the timeout has expired
2714  * \retval -1 error
2715  * \return the number of milliseconds until the timeout will expire
2716  */
2717 static int sip_check_authtimeout(time_t start)
2718 {
2719         int timeout;
2720         time_t now;
2721         if(time(&now) == -1) {
2722                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
2723                 return -1;
2724         }
2725
2726         timeout = (authtimeout - (now - start)) * 1000;
2727         if (timeout < 0) {
2728                 /* we have timed out */
2729                 return 0;
2730         }
2731
2732         return timeout;
2733 }
2734
2735 /*!
2736  * \brief Indication of a TCP message's integrity
2737  */
2738 enum message_integrity {
2739         /*!
2740          * The message has an error in it with
2741          * regards to its Content-Length header
2742          */
2743         MESSAGE_INVALID,
2744         /*!
2745          * The message is incomplete
2746          */
2747         MESSAGE_FRAGMENT,
2748         /*!
2749          * The data contains a complete message
2750          * plus a fragment of another.
2751          */
2752         MESSAGE_FRAGMENT_COMPLETE,
2753         /*!
2754          * The message is complete
2755          */
2756         MESSAGE_COMPLETE,
2757 };
2758
2759 /*!
2760  * \brief
2761  * Get the content length from an unparsed SIP message
2762  *
2763  * \param message The unparsed SIP message headers
2764  * \return The value of the Content-Length header or -1 if message is invalid
2765  */
2766 static int read_raw_content_length(const char *message)
2767 {
2768         char *content_length_str;
2769         int content_length = -1;
2770
2771         struct ast_str *msg_copy;
2772         char *msg;
2773
2774         /* Using a ast_str because lws2sws takes one of those */
2775         if (!(msg_copy = ast_str_create(strlen(message) + 1))) {
2776                 return -1;
2777         }
2778         ast_str_set(&msg_copy, 0, "%s", message);
2779
2780         if (sip_cfg.pedanticsipchecking) {
2781                 lws2sws(msg_copy);
2782         }
2783
2784         msg = ast_str_buffer(msg_copy);
2785
2786         /* Let's find a Content-Length header */
2787         if ((content_length_str = strcasestr(msg, "\nContent-Length:"))) {
2788                 content_length_str += sizeof("\nContent-Length:") - 1;
2789         } else if ((content_length_str = strcasestr(msg, "\nl:"))) {
2790                 content_length_str += sizeof("\nl:") - 1;
2791         } else {
2792                 /* RFC 3261 18.3
2793                  * "In the case of stream-oriented transports such as TCP, the Content-
2794                  *  Length header field indicates the size of the body.  The Content-
2795                  *  Length header field MUST be used with stream oriented transports."
2796                  */
2797                 goto done;
2798         }
2799
2800         /* Double-check that this is a complete header */
2801         if (!strchr(content_length_str, '\n')) {
2802                 goto done;
2803         }
2804
2805         if (sscanf(content_length_str, "%30d", &content_length) != 1) {
2806                 content_length = -1;
2807         }
2808
2809 done:
2810         ast_free(msg_copy);
2811         return content_length;
2812 }
2813
2814 /*!
2815  * \brief Check that a message received over TCP is a full message
2816  *
2817  * This will take the information read in and then determine if
2818  * 1) The message is a full SIP request
2819  * 2) The message is a partial SIP request
2820  * 3) The message contains a full SIP request along with another partial request
2821  * \param data The unparsed incoming SIP message.
2822  * \param request The resulting request with extra fragments removed.
2823  * \param overflow If the message contains more than a full request, this is the remainder of the message
2824  * \return The resulting integrity of the message
2825  */
2826 static enum message_integrity check_message_integrity(struct ast_str **request, struct ast_str **overflow)
2827 {
2828         char *message = ast_str_buffer(*request);
2829         char *body;
2830         int content_length;
2831         int message_len = ast_str_strlen(*request);
2832         int body_len;
2833
2834         /* Important pieces to search for in a SIP request are \r\n\r\n. This
2835          * marks either
2836          * 1) The division between the headers and body
2837          * 2) The end of the SIP request
2838          */
2839         body = strstr(message, "\r\n\r\n");
2840         if (!body) {
2841                 /* This is clearly a partial message since we haven't reached an end
2842                  * yet.
2843                  */
2844                 return MESSAGE_FRAGMENT;
2845         }
2846         body += sizeof("\r\n\r\n") - 1;
2847         body_len = message_len - (body - message);
2848
2849         body[-1] = '\0';
2850         content_length = read_raw_content_length(message);
2851         body[-1] = '\n';
2852
2853         if (content_length < 0) {
2854                 return MESSAGE_INVALID;
2855         } else if (content_length == 0) {
2856                 /* We've definitely received an entire message. We need
2857                  * to check if there's also a fragment of another message
2858                  * in addition.
2859                  */
2860                 if (body_len == 0) {
2861                         return MESSAGE_COMPLETE;
2862                 } else {
2863                         ast_str_append(overflow, 0, "%s", body);
2864                         ast_str_truncate(*request, message_len - body_len);
2865                         return MESSAGE_FRAGMENT_COMPLETE;
2866                 }
2867         }
2868         /* Positive content length. Let's see what sort of
2869          * message body we're dealing with.
2870          */
2871         if (body_len < content_length) {
2872                 /* We don't have the full message body yet */
2873                 return MESSAGE_FRAGMENT;
2874         } else if (body_len > content_length) {
2875                 /* We have the full message plus a fragment of a further
2876                  * message
2877                  */
2878                 ast_str_append(overflow, 0, "%s", body + content_length);
2879                 ast_str_truncate(*request, message_len - (body_len - content_length));
2880                 return MESSAGE_FRAGMENT_COMPLETE;
2881         } else {
2882                 /* Yay! Full message with no extra content */
2883                 return MESSAGE_COMPLETE;
2884         }
2885 }
2886
2887 /*!
2888  * \brief Read SIP request or response from a TCP/TLS connection
2889  *
2890  * \param req The request structure to be filled in
2891  * \param tcptls_session The TCP/TLS connection from which to read
2892  * \retval -1 Failed to read data
2893  * \retval 0 Successfully read data
2894  */
2895 static int sip_tcptls_read(struct sip_request *req, struct ast_tcptls_session_instance *tcptls_session,
2896                 int authenticated, time_t start)
2897 {
2898         enum message_integrity message_integrity = MESSAGE_FRAGMENT;
2899
2900         while (message_integrity == MESSAGE_FRAGMENT) {
2901                 size_t datalen;
2902
2903                 if (ast_str_strlen(tcptls_session->overflow_buf) == 0) {
2904                         char readbuf[4097];
2905                         int timeout;
2906                         int res;
2907                         if (!tcptls_session->client && !authenticated) {
2908                                 if ((timeout = sip_check_authtimeout(start)) < 0) {
2909                                         return -1;
2910                                 }
2911
2912                                 if (timeout == 0) {
2913                                         ast_debug(2, "SIP TCP/TLS server timed out\n");
2914                                         return -1;
2915                                 }
2916                         } else {
2917                                 timeout = -1;
2918                         }
2919                         res = ast_wait_for_input(ast_iostream_get_fd(tcptls_session->stream), timeout);
2920                         if (res < 0) {
2921                                 ast_debug(2, "SIP TCP/TLS server :: ast_wait_for_input returned %d\n", res);
2922                                 return -1;
2923                         } else if (res == 0) {
2924                                 ast_debug(2, "SIP TCP/TLS server timed out\n");
2925                                 return -1;
2926                         }
2927
2928                         res = ast_iostream_read(tcptls_session->stream, readbuf, sizeof(readbuf) - 1);
2929                         if (res < 0) {
2930                                 if (errno == EAGAIN || errno == EINTR) {
2931                                         continue;
2932                                 }
2933                                 ast_debug(2, "SIP TCP/TLS server error when receiving data\n");
2934                                 return -1;
2935                         } else if (res == 0) {
2936                                 ast_debug(2, "SIP TCP/TLS server has shut down\n");
2937                                 return -1;
2938                         }
2939                         readbuf[res] = '\0';
2940                         ast_str_append(&req->data, 0, "%s", readbuf);
2941                 } else {
2942                         ast_str_append(&req->data, 0, "%s", ast_str_buffer(tcptls_session->overflow_buf));
2943                         ast_str_reset(tcptls_session->overflow_buf);
2944                 }
2945
2946                 datalen = ast_str_strlen(req->data);
2947                 if (datalen > SIP_MAX_PACKET_SIZE) {
2948                         ast_log(LOG_WARNING, "Rejecting TCP/TLS packet from '%s' because way too large: %zu\n",
2949                                 ast_sockaddr_stringify(&tcptls_session->remote_address), datalen);
2950                         return -1;
2951                 }
2952
2953                 message_integrity = check_message_integrity(&req->data, &tcptls_session->overflow_buf);
2954         }
2955
2956         return 0;
2957 }
2958
2959 /*! \brief SIP TCP thread management function
2960         This function reads from the socket, parses the packet into a request
2961 */
2962 static void *_sip_tcp_helper_thread(struct ast_tcptls_session_instance *tcptls_session)
2963 {
2964         int res, timeout = -1, authenticated = 0, flags;
2965         time_t start;
2966         struct sip_request req = { 0, } , reqcpy = { 0, };
2967         struct sip_threadinfo *me = NULL;
2968         char buf[1024] = "";
2969         struct pollfd fds[2] = { { 0 }, { 0 }, };
2970         struct ast_tcptls_session_args *ca = NULL;
2971
2972         /* If this is a server session, then the connection has already been
2973          * setup. Check if the authlimit has been reached and if not create the
2974          * threadinfo object so we can access this thread for writing.
2975          *
2976          * if this is a client connection more work must be done.
2977          * 1. We own the parent session args for a client connection.  This pointer needs
2978          *    to be held on to so we can decrement it's ref count on thread destruction.
2979          * 2. The threadinfo object was created before this thread was launched, however
2980          *    it must be found within the threadt table.
2981          * 3. Last, the tcptls_session must be started.
2982          */
2983         if (!tcptls_session->client) {
2984                 if (ast_atomic_fetchadd_int(&unauth_sessions, +1) >= authlimit) {
2985                         /* unauth_sessions is decremented in the cleanup code */
2986                         goto cleanup;
2987                 }
2988
2989                 ast_iostream_nonblock(tcptls_session->stream);
2990                 if (!(me = sip_threadinfo_create(tcptls_session, ast_iostream_get_ssl(tcptls_session->stream) ? AST_TRANSPORT_TLS : AST_TRANSPORT_TCP))) {
2991                         goto cleanup;
2992                 }
2993                 me->threadid = pthread_self();
2994                 ao2_t_ref(me, +1, "Adding threadinfo ref for tcp_helper_thread");
2995         } else {
2996                 struct sip_threadinfo tmp = {
2997                         .tcptls_session = tcptls_session,
2998                 };
2999
3000                 if ((!(ca = tcptls_session->parent)) ||
3001                         (!(me = ao2_t_find(threadt, &tmp, OBJ_POINTER, "ao2_find, getting sip_threadinfo in tcp helper thread")))) {
3002                         goto cleanup;
3003                 }
3004
3005                 me->threadid = pthread_self();
3006
3007                 if (!(tcptls_session = ast_tcptls_client_start(tcptls_session))) {
3008                         goto cleanup;
3009                 }
3010         }
3011
3012         flags = 1;
3013         if (setsockopt(ast_iostream_get_fd(tcptls_session->stream), SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
3014                 ast_log(LOG_ERROR, "error enabling TCP keep-alives on sip socket: %s\n", strerror(errno));
3015                 goto cleanup;
3016         }
3017
3018         ast_debug(2, "Starting thread for %s server\n", ast_iostream_get_ssl(tcptls_session->stream) ? "TLS" : "TCP");
3019
3020         /* set up pollfd to watch for reads on both the socket and the alert_pipe */
3021         fds[0].fd = ast_iostream_get_fd(tcptls_session->stream);
3022         fds[1].fd = me->alert_pipe[0];
3023         fds[0].events = fds[1].events = POLLIN | POLLPRI;
3024
3025         if (!(req.data = ast_str_create(SIP_MIN_PACKET))) {
3026                 goto cleanup;
3027         }
3028         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET))) {
3029                 goto cleanup;
3030         }
3031
3032         if(time(&start) == -1) {
3033                 ast_log(LOG_ERROR, "error executing time(): %s\n", strerror(errno));
3034                 goto cleanup;
3035         }
3036
3037         /*
3038          * We cannot let the stream exclusively wait for data to arrive.
3039          * We have to wake up the task to send outgoing messages.
3040          */
3041         ast_iostream_set_exclusive_input(tcptls_session->stream, 0);
3042
3043         ast_iostream_set_timeout_sequence(tcptls_session->stream, ast_tvnow(),
3044                 tcptls_session->client ? -1 : (authtimeout * 1000));
3045
3046         for (;;) {
3047                 struct ast_str *str_save;
3048
3049                 if (!tcptls_session->client && req.authenticated && !authenticated) {
3050                         authenticated = 1;
3051                         ast_iostream_set_timeout_disable(tcptls_session->stream);
3052                         ast_atomic_fetchadd_int(&unauth_sessions, -1);
3053                 }
3054
3055                 /* calculate the timeout for unauthenticated server sessions */
3056                 if (!tcptls_session->client && !authenticated ) {
3057                         if ((timeout = sip_check_authtimeout(start)) < 0) {
3058                                 goto cleanup;
3059                         }
3060
3061                         if (timeout == 0) {
3062                                 ast_debug(2, "SIP %s server timed out\n", ast_iostream_get_ssl(tcptls_session->stream) ? "TLS": "TCP");
3063                                 goto cleanup;
3064                         }
3065                 } else {
3066                         timeout = -1;
3067                 }
3068
3069                 if (ast_str_strlen(tcptls_session->overflow_buf) == 0) {
3070                         res = ast_poll(fds, 2, timeout); /* polls for both socket and alert_pipe */
3071                         if (res < 0) {
3072                                 ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", ast_iostream_get_ssl(tcptls_session->stream) ? "TLS": "TCP", res);
3073                                 goto cleanup;
3074                         } else if (res == 0) {
3075                                 /* timeout */
3076                                 ast_debug(2, "SIP %s server timed out\n", ast_iostream_get_ssl(tcptls_session->stream) ? "TLS": "TCP");
3077                                 goto cleanup;
3078                         }
3079                 }
3080
3081                 /*
3082                  * handle the socket event, check for both reads from the socket fd or TCP overflow buffer,
3083                  * and writes from alert_pipe fd.
3084                  */
3085                 if (fds[0].revents || (ast_str_strlen(tcptls_session->overflow_buf) > 0)) { /* there is data on the socket to be read */
3086                         fds[0].revents = 0;
3087
3088                         /* clear request structure */
3089                         str_save = req.data;
3090                         memset(&req, 0, sizeof(req));
3091                         req.data = str_save;
3092                         ast_str_reset(req.data);
3093
3094                         str_save = reqcpy.data;
3095                         memset(&reqcpy, 0, sizeof(reqcpy));
3096                         reqcpy.data = str_save;
3097                         ast_str_reset(reqcpy.data);
3098
3099                         memset(buf, 0, sizeof(buf));
3100
3101                         if (ast_iostream_get_ssl(tcptls_session->stream)) {
3102                                 set_socket_transport(&req.socket, AST_TRANSPORT_TLS);
3103                                 req.socket.port = htons(ourport_tls);
3104                         } else {
3105                                 set_socket_transport(&req.socket, AST_TRANSPORT_TCP);
3106                                 req.socket.port = htons(ourport_tcp);
3107                         }
3108                         req.socket.fd = ast_iostream_get_fd(tcptls_session->stream);
3109
3110                         res = sip_tcptls_read(&req, tcptls_session, authenticated, start);
3111                         if (res < 0) {
3112                                 goto cleanup;
3113                         }
3114
3115