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