channels/chan_sip.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2006, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*!
  20  * \file
  21  * \brief Implementation of Session Initiation Protocol
  22  *
  23  * \author Mark Spencer <markster@digium.com>
  24  *
  25  * See Also:
  26  * \arg \ref AstCREDITS
  27  *
  28  * Implementation of RFC 3261 - without S/MIME, and experimental TCP and TLS support
  29  * Configuration file \link Config_sip sip.conf \endlink
  30  *
  31  * ********** IMPORTANT *
  32  * \note TCP/TLS support is EXPERIMENTAL and WILL CHANGE. This applies to configuration
  33  *      settings, dialplan commands and dialplans apps/functions
  34  * See \ref sip_tcp_tls
  35  *
  36  *
  37  * ******** General TODO:s
  38  * \todo Better support of forking
  39  * \todo VIA branch tag transaction checking
  40  * \todo Transaction support
  41  * \todo Asterisk should send a non-100 provisional response every minute to keep proxies
  42  *  from cancelling the transaction (RFC 3261 13.3.1.1). See bug #11157.
  43  *
  44  * ******** Wishlist: Improvements
  45  * - Support of SIP domains for devices, so that we match on username@domain in the From: header
  46  * - Connect registrations with a specific device on the incoming call. It's not done
  47  *   automatically in Asterisk
  48  *
  49  * \ingroup channel_drivers
  50  *
  51  * \par Overview of the handling of SIP sessions
  52  * The SIP channel handles several types of SIP sessions, or dialogs,
  53  * not all of them being "telephone calls".
  54  * - Incoming calls that will be sent to the PBX core
  55  * - Outgoing calls, generated by the PBX
  56  * - SIP subscriptions and notifications of states and voicemail messages
  57  * - SIP registrations, both inbound and outbound
  58  * - SIP peer management (peerpoke, OPTIONS)
  59  * - SIP text messages
  60  *
  61  * In the SIP channel, there's a list of active SIP dialogs, which includes
  62  * all of these when they are active. "sip show channels" in the CLI will
  63  * show most of these, excluding subscriptions which are shown by
  64  * "sip show subscriptions"
  65  *
  66  * \par incoming packets
  67  * Incoming packets are received in the monitoring thread, then handled by
  68  * sipsock_read() for udp only. In tcp, packets are read by the tcp_helper thread.
  69  * sipsock_read() function parses the packet and matches an existing
  70  * dialog or starts a new SIP dialog.
  71  *
  72  * sipsock_read sends the packet to handle_incoming(), that parses a bit more.
  73  * If it is a response to an outbound request, the packet is sent to handle_response().
  74  * If it is a request, handle_incoming() sends it to one of a list of functions
  75  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
  76  * sipsock_read locks the ast_channel if it exists (an active call) and
  77  * unlocks it after we have processed the SIP message.
  78  *
  79  * A new INVITE is sent to handle_request_invite(), that will end up
  80  * starting a new channel in the PBX, the new channel after that executing
  81  * in a separate channel thread. This is an incoming "call".
  82  * When the call is answered, either by a bridged channel or the PBX itself
  83  * the sip_answer() function is called.
  84  *
  85  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
  86  * in rtp.c
  87  *
  88  * \par Outbound calls
  89  * Outbound calls are set up by the PBX through the sip_request_call()
  90  * function. After that, they are activated by sip_call().
  91  *
  92  * \par Hanging up
  93  * The PBX issues a hangup on both incoming and outgoing calls through
  94  * the sip_hangup() function
  95  */
  96
  97 /*!
  98  * \page sip_tcp_tls SIP TCP and TLS support
  99  *
 100  * \par tcpfixes TCP implementation changes needed
 101  * \todo Fix TCP/TLS handling in dialplan, SRV records, transfers and much more
 102  * \todo Save TCP/TLS sessions in registry
 103  *      If someone registers a SIPS uri, this forces us to set up a TLS connection back.
 104  * \todo Add TCP/TLS information to function SIPPEER and SIPCHANINFO
 105  * \todo If tcpenable=yes, we must open a TCP socket on the same address as the IP for UDP.
 106  *       The tcpbindaddr config option should only be used to open ADDITIONAL ports
 107  *       So we should propably go back to
 108  *              bindaddr= the default address to bind to. If tcpenable=yes, then bind this to both udp and TCP
 109  *                              if tlsenable=yes, open TLS port (provided we also have cert)
 110  *              tcpbindaddr = extra address for additional TCP connections
 111  *              tlsbindaddr = extra address for additional TCP/TLS connections
 112  *              udpbindaddr = extra address for additional UDP connections
 113  *                      These three options should take multiple IP/port pairs
 114  *      Note: Since opening additional listen sockets is a *new* feature we do not have today
 115  *              the XXXbindaddr options needs to be disabled until we have support for it
 116  *
 117  * \todo re-evaluate the transport= setting in sip.conf. This is right now not well
 118  *      thought of. If a device in sip.conf contacts us via TCP, we should not switch transport,
 119  *      even if udp is the configured first transport.
 120  *
 121  * \todo Be prepared for one outbound and another incoming socket per pvt. This applies
 122  *       specially to communication with other peers (proxies).
 123  * \todo We need to test TCP sessions with SIP proxies and in regards
 124  *       to the SIP outbound specs.
 125  * \todo ;transport=tls was deprecated in RFC3261 and should not be used at all. See section 26.2.2.
 126  *
 127  * \todo If the message is smaller than the given Content-length, the request should get a 400 Bad request
 128  *       message. If it's a response, it should be dropped. (RFC 3261, Section 18.3)
 129  * \todo Since we have had multidomain support in Asterisk for quite a while, we need to support
 130  *       multiple domains in our TLS implementation, meaning one socket and one cert per domain
 131  * \todo Selection of transport for a request needs to be done after we've parsed all route headers,
 132  *       also considering outbound proxy options.
 133  *              First request: Outboundproxy, routes, (reg contact or URI. If URI doesn't have port:  DNS naptr, srv, AAA)
 134  *              Intermediate requests: Outboundproxy(only when forced), routes, contact/uri
 135  *      DNS naptr support is crucial. A SIP uri might lead to a TLS connection.
 136  *      Also note that due to outbound proxy settings, a SIPS uri might have to be sent on UDP (not to recommend though)
 137  * \todo Default transports are set to UDP, which cause the wrong behaviour when contacting remote
 138  *      devices directly from the dialplan. UDP is only a fallback if no other method works,
 139  *      in order to be compatible with RFC2543 (SIP/1.0) devices. For transactions that exceed the
 140  *      MTU (like INIVTE with video, audio and RTT)  TCP should be preferred.
 141  *
 142  *      When dialling unconfigured peers (with no port number)  or devices in external domains
 143  *      NAPTR records MUST be consulted to find configured transport. If they are not found,
 144  *      SRV records for both TCP and UDP should be checked. If there's a record for TCP, use that.
 145  *      If there's no record for TCP, then use UDP as a last resort. If there's no SRV records,
 146  *      \note this only applies if there's no outbound proxy configured for the session. If an outbound
 147  *      proxy is configured, these procedures might apply for locating the proxy and determining
 148  *      the transport to use for communication with the proxy.
 149  * \par Other bugs to fix ----
 150  * __set_address_from_contact(const char *fullcontact, struct sockaddr_in *sin, int tcp)
 151  *      - sets TLS port as default for all TCP connections, unless other port is given in contact.
 152  * parse_register_contact(struct sip_pvt *pvt, struct sip_peer *peer, struct sip_request *req)
 153  *      - assumes that the contact the UA registers is using the same transport as the REGISTER request, which is
 154  *        a bad guess.
 155  *      - Does not save any information about TCP/TLS connected devices, which is a severe BUG, as discussed on the mailing list.
 156  * get_destination(struct sip_pvt *p, struct sip_request *oreq)
 157  *      - Doesn't store the information that we got an incoming SIPS request in the channel, so that
 158  *        we can require a secure signalling path OUT of Asterisk (on SIP or IAX2). Possibly, the call should
 159  *        fail on in-secure signalling paths if there's no override in our configuration. At least, provide a
 160  *        channel variable in the dialplan.
 161  * get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req)
 162  *      - As above, if we have a SIPS: uri in the refer-to header
 163  *      - Does not check transport in refer_to uri.
 164  */
 165
 166 /*** MODULEINFO
 167         <depend>chan_local</depend>
 168  ***/
 169
 170 /*!  \page sip_session_timers SIP Session Timers in Asterisk Chan_sip
 171
 172         The SIP Session-Timers is an extension of the SIP protocol that allows end-points and proxies to
 173         refresh a session periodically. The sessions are kept alive by sending a RE-INVITE or UPDATE
 174         request at a negotiated interval. If a session refresh fails then all the entities that support Session-
 175         Timers clear their internal session state. In addition, UAs generate a BYE request in order to clear
 176         the state in the proxies and the remote UA (this is done for the benefit of SIP entities in the path
 177         that do not support Session-Timers).
 178
 179         The Session-Timers can be configured on a system-wide, per-user, or per-peer basis. The peruser/
 180         per-peer settings override the global settings. The following new parameters have been
 181         added to the sip.conf file.
 182                 session-timers=["accept", "originate", "refuse"]
 183                 session-expires=[integer]
 184                 session-minse=[integer]
 185                 session-refresher=["uas", "uac"]
 186
 187         The session-timers parameter in sip.conf defines the mode of operation of SIP session-timers feature in
 188         Asterisk. The Asterisk can be configured in one of the following three modes:
 189
 190         1. Accept :: In the "accept" mode, the Asterisk server honors session-timers requests
 191                 made by remote end-points. A remote end-point can request Asterisk to engage
 192                 session-timers by either sending it an INVITE request with a "Supported: timer"
 193                 header in it or by responding to Asterisk's INVITE with a 200 OK that contains
 194                 Session-Expires: header in it. In this mode, the Asterisk server does not
 195                 request session-timers from remote end-points. This is the default mode.
 196         2. Originate :: In the "originate" mode, the Asterisk server requests the remote
 197                 end-points to activate session-timers in addition to honoring such requests
 198                 made by the remote end-pints. In order to get as much protection as possible
 199                 against hanging SIP channels due to network or end-point failures, Asterisk
 200                 resends periodic re-INVITEs even if a remote end-point does not support
 201                 the session-timers feature.
 202         3. Refuse :: In the "refuse" mode, Asterisk acts as if it does not support session-
 203                 timers for inbound or outbound requests. If a remote end-point requests
 204                 session-timers in a dialog, then Asterisk ignores that request unless it's
 205                 noted as a requirement (Require: header), in which case the INVITE is
 206                 rejected with a 420 Bad Extension response.
 207
 208 */
 209
 210 #include "asterisk.h"
 211
 212 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 213
 214 #include <ctype.h>
 215 #include <sys/ioctl.h>
 216 #include <fcntl.h>
 217 #include <signal.h>
 218 #include <sys/signal.h>
 219 #include <regex.h>
 220 #include <time.h>
 221
 222 #include "asterisk/network.h"
 223 #include "asterisk/paths.h"     /* need ast_config_AST_SYSTEM_NAME */
 224
 225 #include "asterisk/lock.h"
 226 #include "asterisk/channel.h"
 227 #include "asterisk/config.h"
 228 #include "asterisk/module.h"
 229 #include "asterisk/pbx.h"
 230 #include "asterisk/sched.h"
 231 #include "asterisk/io.h"
 232 #include "asterisk/rtp_engine.h"
 233 #include "asterisk/udptl.h"
 234 #include "asterisk/acl.h"
 235 #include "asterisk/manager.h"
 236 #include "asterisk/callerid.h"
 237 #include "asterisk/cli.h"
 238 #include "asterisk/app.h"
 239 #include "asterisk/musiconhold.h"
 240 #include "asterisk/dsp.h"
 241 #include "asterisk/features.h"
 242 #include "asterisk/srv.h"
 243 #include "asterisk/astdb.h"
 244 #include "asterisk/causes.h"
 245 #include "asterisk/utils.h"
 246 #include "asterisk/file.h"
 247 #include "asterisk/astobj.h"
 248 /*
 249    Uncomment the define below,  if you are having refcount related memory leaks.
 250    With this uncommented, this module will generate a file, /tmp/refs, which contains
 251    a history of the ao2_ref() calls. To be useful, all calls to ao2_* functions should
 252    be modified to ao2_t_* calls, and include a tag describing what is happening with
 253    enough detail, to make pairing up a reference count increment with its corresponding decrement.
 254    The refcounter program in utils/ can be invaluable in highlighting objects that are not
 255    balanced, along with the complete history for that object.
 256    In normal operation, the macros defined will throw away the tags, so they do not
 257    affect the speed of the program at all. They can be considered to be documentation.
 258 */
 259 /* #define  REF_DEBUG 1 */
 260 #include "asterisk/astobj2.h"
 261 #include "asterisk/dnsmgr.h"
 262 #include "asterisk/devicestate.h"
 263 #include "asterisk/linkedlists.h"
 264 #include "asterisk/stringfields.h"
 265 #include "asterisk/monitor.h"
 266 #include "asterisk/netsock.h"
 267 #include "asterisk/localtime.h"
 268 #include "asterisk/abstract_jb.h"
 269 #include "asterisk/threadstorage.h"
 270 #include "asterisk/translate.h"
 271 #include "asterisk/ast_version.h"
 272 #include "asterisk/event.h"
 273 #include "asterisk/tcptls.h"
 274 #include "asterisk/stun.h"
 275 #include "asterisk/cel.h"
 276
 277 /*** DOCUMENTATION
 278         <application name="SIPDtmfMode" language="en_US">
 279                 <synopsis>
 280                         Change the dtmfmode for a SIP call.
 281                 </synopsis>
 282                 <syntax>
 283                         <parameter name="mode" required="true">
 284                                 <enumlist>
 285                                         <enum name="inband" />
 286                                         <enum name="info" />
 287                                         <enum name="rfc2833" />
 288                                 </enumlist>
 289                         </parameter>
 290                 </syntax>
 291                 <description>
 292                         <para>Changes the dtmfmode for a SIP call.</para>
 293                 </description>
 294         </application>
 295         <application name="SIPAddHeader" language="en_US">
 296                 <synopsis>
 297                         Add a SIP header to the outbound call.
 298                 </synopsis>
 299                 <syntax argsep=":">
 300                         <parameter name="Header" required="true" />
 301                         <parameter name="Content" required="true" />
 302                 </syntax>
 303                 <description>
 304                         <para>Adds a header to a SIP call placed with DIAL.</para>
 305                         <para>Remember to use the X-header if you are adding non-standard SIP
 306                         headers, like <literal>X-Asterisk-Accountcode:</literal>. Use this with care.
 307                         Adding the wrong headers may jeopardize the SIP dialog.</para>
 308                         <para>Always returns <literal>0</literal>.</para>
 309                 </description>
 310         </application>
 311         <application name="SIPRemoveHeader" language="en_US">
 312                 <synopsis>
 313                         Remove SIP headers previously added with SIPAddHeader
 314                 </synopsis>
 315                 <syntax>
 316                         <parameter name="Header" required="false" />
 317                 </syntax>
 318                 <description>
 319                         <para>SIPRemoveHeader() allows you to remove headers which were previously
 320                         added with SIPAddHeader(). If no parameter is supplied, all previously added
 321                         headers will be removed. If a parameter is supplied, only the matching headers
 322                         will be removed.</para>
 323                         <para>For example you have added these 2 headers:</para>
 324                         <para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
 325                         <para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
 326                         <para></para>
 327                         <para>// remove all headers</para>
 328                         <para>SIPRemoveHeader();</para>
 329                         <para>// remove all P- headers</para>
 330                         <para>SIPRemoveHeader(P-);</para>
 331                         <para>// remove only the PAI header (note the : at the end)</para>
 332                         <para>SIPRemoveHeader(P-Asserted-Identity:);</para>
 333                         <para></para>
 334                         <para>Always returns <literal>0</literal>.</para>
 335                 </description>
 336         </application>
 337         <function name="SIP_HEADER" language="en_US">
 338                 <synopsis>
 339                         Gets the specified SIP header.
 340                 </synopsis>
 341                 <syntax>
 342                         <parameter name="name" required="true" />
 343                         <parameter name="number">
 344                                 <para>If not specified, defaults to <literal>1</literal>.</para>
 345                         </parameter>
 346                 </syntax>
 347                 <description>
 348                         <para>Since there are several headers (such as Via) which can occur multiple
 349                         times, SIP_HEADER takes an optional second argument to specify which header with
 350                         that name to retrieve. Headers start at offset <literal>1</literal>.</para>
 351                 </description>
 352         </function>
 353         <function name="SIPPEER" language="en_US">
 354                 <synopsis>
 355                         Gets SIP peer information.
 356                 </synopsis>
 357                 <syntax>
 358                         <parameter name="peername" required="true" />
 359                         <parameter name="item">
 360                                 <enumlist>
 361                                         <enum name="ip">
 362                                                 <para>(default) The ip address.</para>
 363                                         </enum>
 364                                         <enum name="port">
 365                                                 <para>The port number.</para>
 366                                         </enum>
 367                                         <enum name="mailbox">
 368                                                 <para>The configured mailbox.</para>
 369                                         </enum>
 370                                         <enum name="context">
 371                                                 <para>The configured context.</para>
 372                                         </enum>
 373                                         <enum name="expire">
 374                                                 <para>The epoch time of the next expire.</para>
 375                                         </enum>
 376                                         <enum name="dynamic">
 377                                                 <para>Is it dynamic? (yes/no).</para>
 378                                         </enum>
 379                                         <enum name="callerid_name">
 380                                                 <para>The configured Caller ID name.</para>
 381                                         </enum>
 382                                         <enum name="callerid_num">
 383                                                 <para>The configured Caller ID number.</para>
 384                                         </enum>
 385                                         <enum name="callgroup">
 386                                                 <para>The configured Callgroup.</para>
 387                                         </enum>
 388                                         <enum name="pickupgroup">
 389                                                 <para>The configured Pickupgroup.</para>
 390                                         </enum>
 391                                         <enum name="codecs">
 392                                                 <para>The configured codecs.</para>
 393                                         </enum>
 394                                         <enum name="status">
 395                                                 <para>Status (if qualify=yes).</para>
 396                                         </enum>
 397                                         <enum name="regexten">
 398                                                 <para>Registration extension.</para>
 399                                         </enum>
 400                                         <enum name="limit">
 401                                                 <para>Call limit (call-limit).</para>
 402                                         </enum>
 403                                         <enum name="busylevel">
 404                                                 <para>Configured call level for signalling busy.</para>
 405                                         </enum>
 406                                         <enum name="curcalls">
 407                                                 <para>Current amount of calls. Only available if call-limit is set.</para>
 408                                         </enum>
 409                                         <enum name="language">
 410                                                 <para>Default language for peer.</para>
 411                                         </enum>
 412                                         <enum name="accountcode">
 413                                                 <para>Account code for this peer.</para>
 414                                         </enum>
 415                                         <enum name="useragent">
 416                                                 <para>Current user agent id for peer.</para>
 417                                         </enum>
 418                                         <enum name="chanvar[name]">
 419                                                 <para>A channel variable configured with setvar for this peer.</para>
 420                                         </enum>
 421                                         <enum name="codec[x]">
 422                                                 <para>Preferred codec index number <replaceable>x</replaceable> (beginning with zero).</para>
 423                                         </enum>
 424                                 </enumlist>
 425                         </parameter>
 426                 </syntax>
 427                 <description />
 428         </function>
 429         <function name="SIPCHANINFO" language="en_US">
 430                 <synopsis>
 431                         Gets the specified SIP parameter from the current channel.
 432                 </synopsis>
 433                 <syntax>
 434                         <parameter name="item" required="true">
 435                                 <enumlist>
 436                                         <enum name="peerip">
 437                                                 <para>The IP address of the peer.</para>
 438                                         </enum>
 439                                         <enum name="recvip">
 440                                                 <para>The source IP address of the peer.</para>
 441                                         </enum>
 442                                         <enum name="from">
 443                                                 <para>The URI from the <literal>From:</literal> header.</para>
 444                                         </enum>
 445                                         <enum name="uri">
 446                                                 <para>The URI from the <literal>Contact:</literal> header.</para>
 447                                         </enum>
 448                                         <enum name="useragent">
 449                                                 <para>The useragent.</para>
 450                                         </enum>
 451                                         <enum name="peername">
 452                                                 <para>The name of the peer.</para>
 453                                         </enum>
 454                                         <enum name="t38passthrough">
 455                                                 <para><literal>1</literal> if T38 is offered or enabled in this channel,
 456                                                 otherwise <literal>0</literal>.</para>
 457                                         </enum>
 458                                 </enumlist>
 459                         </parameter>
 460                 </syntax>
 461                 <description />
 462         </function>
 463         <function name="CHECKSIPDOMAIN" language="en_US">
 464                 <synopsis>
 465                         Checks if domain is a local domain.
 466                 </synopsis>
 467                 <syntax>
 468                         <parameter name="domain" required="true" />
 469                 </syntax>
 470                 <description>
 471                         <para>This function checks if the <replaceable>domain</replaceable> in the argument is configured
 472                         as a local SIP domain that this Asterisk server is configured to handle.
 473                         Returns the domain name if it is locally handled, otherwise an empty string.
 474                         Check the <literal>domain=</literal> configuration in <filename>sip.conf</filename>.</para>
 475                 </description>
 476         </function>
 477         <manager name="SIPpeers" language="en_US">
 478                 <synopsis>
 479                         List SIP peers (text format).
 480                 </synopsis>
 481                 <syntax>
 482                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 483                 </syntax>
 484                 <description>
 485                         <para>Lists SIP peers in text format with details on current status.
 486                         Peerlist will follow as separate events, followed by a final event called
 487                         PeerlistComplete.</para>
 488                 </description>
 489         </manager>
 490         <manager name="SIPshowpeer" language="en_US">
 491                 <synopsis>
 492                         show SIP peer (text format).
 493                 </synopsis>
 494                 <syntax>
 495                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 496                         <parameter name="Peer" required="true">
 497                                 <para>The peer name you want to check.</para>
 498                         </parameter>
 499                 </syntax>
 500                 <description>
 501                         <para>Show one SIP peer with details on current status.</para>
 502                 </description>
 503         </manager>
 504         <manager name="SIPqualifypeer" language="en_US">
 505                 <synopsis>
 506                         Qualify SIP peers.
 507                 </synopsis>
 508                 <syntax>
 509                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 510                         <parameter name="Peer" required="true">
 511                                 <para>The peer name you want to qualify.</para>
 512                         </parameter>
 513                 </syntax>
 514                 <description>
 515                         <para>Qualify a SIP peer.</para>
 516                 </description>
 517         </manager>
 518         <manager name="SIPshowregistry" language="en_US">
 519                 <synopsis>
 520                         Show SIP registrations (text format).
 521                 </synopsis>
 522                 <syntax>
 523                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 524                 </syntax>
 525                 <description>
 526                         <para>Lists all registration requests and status. Registrations will follow as separate
 527                         events. followed by a final event called RegistrationsComplete.</para>
 528                 </description>
 529         </manager>
 530         <manager name="SIPnotify" language="en_US">
 531                 <synopsis>
 532                         Send a SIP notify.
 533                 </synopsis>
 534                 <syntax>
 535                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 536                         <parameter name="Channel" required="true">
 537                                 <para>Peer to receive the notify.</para>
 538                         </parameter>
 539                         <parameter name="Variable" required="true">
 540                                 <para>At least one variable pair must be specified.
 541                                 <replaceable>name</replaceable>=<replaceable>value</replaceable></para>
 542                         </parameter>
 543                 </syntax>
 544                 <description>
 545                         <para>Sends a SIP Notify event.</para>
 546                         <para>All parameters for this event must be specified in the body of this request
 547                         via multiple Variable: name=value sequences.</para>
 548                 </description>
 549         </manager>
 550  ***/
 551
 552 #ifndef FALSE
 553 #define FALSE    0
 554 #endif
 555
 556 #ifndef TRUE
 557 #define TRUE     1
 558 #endif
 559
 560 /* Arguments for find_peer */
 561 #define FINDUSERS (1 << 0)
 562 #define FINDPEERS (1 << 1)
 563 #define FINDALLDEVICES (FINDUSERS | FINDPEERS)
 564
 565 #define SIPBUFSIZE              512             /*!< Buffer size for many operations */
 566
 567 #define XMIT_ERROR              -2
 568
 569 #define SIP_RESERVED ";/?:@&=+$,# "             /*!< Reserved characters in the username part of the URI */
 570
 571 /* #define VOCAL_DATA_HACK */
 572
 573 #define DEFAULT_DEFAULT_EXPIRY  120
 574 #define DEFAULT_MIN_EXPIRY      60
 575 #define DEFAULT_MAX_EXPIRY      3600
 576 #define DEFAULT_MWI_EXPIRY      3600
 577 #define DEFAULT_REGISTRATION_TIMEOUT 20
 578 #define DEFAULT_MAX_FORWARDS    "70"
 579
 580 /* guard limit must be larger than guard secs */
 581 /* guard min must be < 1000, and should be >= 250 */
 582 #define EXPIRY_GUARD_SECS       15                /*!< How long before expiry do we reregister */
 583 #define EXPIRY_GUARD_LIMIT      30                /*!< Below here, we use EXPIRY_GUARD_PCT instead of
 584                                                          EXPIRY_GUARD_SECS */
 585 #define EXPIRY_GUARD_MIN        500                /*!< This is the minimum guard time applied. If
 586                                                    GUARD_PCT turns out to be lower than this, it
 587                                                    will use this time instead.
 588                                                    This is in milliseconds. */
 589 #define EXPIRY_GUARD_PCT        0.20                /*!< Percentage of expires timeout to use when
 590                                                     below EXPIRY_GUARD_LIMIT */
 591 #define DEFAULT_EXPIRY 900                          /*!< Expire slowly */
 592
 593 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
 594 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
 595 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
 596 static int mwi_expiry = DEFAULT_MWI_EXPIRY;
 597
 598 #define DEFAULT_QUALIFY_GAP   100
 599 #define DEFAULT_QUALIFY_PEERS 1
 600
 601
 602 #define CALLERID_UNKNOWN             "Anonymous"
 603 #define FROMDOMAIN_INVALID           "anonymous.invalid"
 604
 605 #define DEFAULT_MAXMS                2000             /*!< Qualification: Must be faster than 2 seconds by default */
 606 #define DEFAULT_QUALIFYFREQ          60 * 1000        /*!< Qualification: How often to check for the host to be up */
 607 #define DEFAULT_FREQ_NOTOK           10 * 1000        /*!< Qualification: How often to check, if the host is down... */
 608
 609 #define DEFAULT_RETRANS              1000             /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
 610 #define MAX_RETRANS                  6                /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
 611 #define DEFAULT_TIMER_T1                 500              /*!< SIP timer T1 (according to RFC 3261) */
 612 #define SIP_TRANS_TIMEOUT            64 * DEFAULT_TIMER_T1 /*!< SIP request timeout (rfc 3261) 64*T1
 613                                                       \todo Use known T1 for timeout (peerpoke)
 614                                                       */
 615 #define DEFAULT_TRANS_TIMEOUT        -1               /*!< Use default SIP transaction timeout */
 616 #define MAX_AUTHTRIES                3                /*!< Try authentication three times, then fail */
 617
 618 #define SIP_MAX_HEADERS              64               /*!< Max amount of SIP headers to read */
 619 #define SIP_MAX_LINES                64               /*!< Max amount of lines in SIP attachment (like SDP) */
 620 #define SIP_MIN_PACKET               4096             /*!< Initialize size of memory to allocate for packets */
 621 #define MAX_HISTORY_ENTRIES          50               /*!< Max entires in the history list for a sip_pvt */
 622
 623 #define INITIAL_CSEQ                 101              /*!< Our initial sip sequence number */
 624
 625 #define DEFAULT_MAX_SE               1800             /*!< Session-Timer Default Session-Expires period (RFC 4028) */
 626 #define DEFAULT_MIN_SE               90               /*!< Session-Timer Default Min-SE period (RFC 4028) */
 627
 628 #define SDP_MAX_RTPMAP_CODECS        32               /*!< Maximum number of codecs allowed in received SDP */
 629
 630 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
 631 static struct ast_jb_conf default_jbconf =
 632 {
 633         .flags = 0,
 634         .max_size = -1,
 635         .resync_threshold = -1,
 636         .impl = ""
 637 };
 638 static struct ast_jb_conf global_jbconf;                /*!< Global jitterbuffer configuration */
 639
 640 static const char config[] = "sip.conf";                /*!< Main configuration file */
 641 static const char notify_config[] = "sip_notify.conf";  /*!< Configuration file for sending Notify with CLI commands to reconfigure or reboot phones */
 642
 643 #define RTP     1
 644 #define NO_RTP  0
 645
 646 /*! \brief Authorization scheme for call transfers
 647
 648 \note Not a bitfield flag, since there are plans for other modes,
 649         like "only allow transfers for authenticated devices" */
 650 enum transfermodes {
 651         TRANSFER_OPENFORALL,            /*!< Allow all SIP transfers */
 652         TRANSFER_CLOSED,                /*!< Allow no SIP transfers */
 653 };
 654
 655
 656 /*! \brief The result of a lot of functions */
 657 enum sip_result {
 658         AST_SUCCESS = 0,                /*!< FALSE means success, funny enough */
 659         AST_FAILURE = -1,               /*!< Failure code */
 660 };
 661
 662 /*! \brief States for the INVITE transaction, not the dialog
 663         \note this is for the INVITE that sets up the dialog
 664 */
 665 enum invitestates {
 666         INV_NONE = 0,           /*!< No state at all, maybe not an INVITE dialog */
 667         INV_CALLING = 1,        /*!< Invite sent, no answer */
 668         INV_PROCEEDING = 2,     /*!< We got/sent 1xx message */
 669         INV_EARLY_MEDIA = 3,    /*!< We got 18x message with to-tag back */
 670         INV_COMPLETED = 4,      /*!< Got final response with error. Wait for ACK, then CONFIRMED */
 671         INV_CONFIRMED = 5,      /*!< Confirmed response - we've got an ack (Incoming calls only) */
 672         INV_TERMINATED = 6,     /*!< Transaction done - either successful (AST_STATE_UP) or failed, but done
 673                                      The only way out of this is a BYE from one side */
 674         INV_CANCELLED = 7,      /*!< Transaction cancelled by client or server in non-terminated state */
 675 };
 676
 677 /*! \brief Readable descriptions of device states.
 678        \note Should be aligned to above table as index */
 679 static const struct invstate2stringtable {
 680         const enum invitestates state;
 681         const char *desc;
 682 } invitestate2string[] = {
 683         {INV_NONE,              "None"  },
 684         {INV_CALLING,           "Calling (Trying)"},
 685         {INV_PROCEEDING,        "Proceeding "},
 686         {INV_EARLY_MEDIA,       "Early media"},
 687         {INV_COMPLETED,         "Completed (done)"},
 688         {INV_CONFIRMED,         "Confirmed (up)"},
 689         {INV_TERMINATED,        "Done"},
 690         {INV_CANCELLED,         "Cancelled"}
 691 };
 692
 693 /*! \brief When sending a SIP message, we can send with a few options, depending on
 694         type of SIP request. UNRELIABLE is moslty used for responses to repeated requests,
 695         where the original response would be sent RELIABLE in an INVITE transaction */
 696 enum xmittype {
 697         XMIT_CRITICAL = 2,              /*!< Transmit critical SIP message reliably, with re-transmits.
 698                                               If it fails, it's critical and will cause a teardown of the session */
 699         XMIT_RELIABLE = 1,              /*!< Transmit SIP message reliably, with re-transmits */
 700         XMIT_UNRELIABLE = 0,            /*!< Transmit SIP message without bothering with re-transmits */
 701 };
 702
 703 /*! \brief Results from the parse_register() function */
 704 enum parse_register_result {
 705         PARSE_REGISTER_FAILED,
 706         PARSE_REGISTER_UPDATE,
 707         PARSE_REGISTER_QUERY,
 708 };
 709
 710 /*! \brief Type of subscription, based on the packages we do support, see \ref subscription_types */
 711 enum subscriptiontype {
 712         NONE = 0,
 713         XPIDF_XML,
 714         DIALOG_INFO_XML,
 715         CPIM_PIDF_XML,
 716         PIDF_XML,
 717         MWI_NOTIFICATION
 718 };
 719
 720 /*! \brief Subscription types that we support. We support
 721    - dialoginfo updates (really device status, not dialog info as was the original intent of the standard)
 722    - SIMPLE presence used for device status
 723    - Voicemail notification subscriptions
 724 */
 725 static const struct cfsubscription_types {
 726         enum subscriptiontype type;
 727         const char * const event;
 728         const char * const mediatype;
 729         const char * const text;
 730 } subscription_types[] = {
 731         { NONE,            "-",        "unknown",                    "unknown" },
 732         /* RFC 4235: SIP Dialog event package */
 733         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
 734         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
 735         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
 736         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
 737         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
 738 };
 739
 740
 741 /*! \brief Authentication types - proxy or www authentication
 742         \note Endpoints, like Asterisk, should always use WWW authentication to
 743         allow multiple authentications in the same call - to the proxy and
 744         to the end point.
 745 */
 746 enum sip_auth_type {
 747         PROXY_AUTH = 407,
 748         WWW_AUTH = 401,
 749 };
 750
 751 /*! \brief Authentication result from check_auth* functions */
 752 enum check_auth_result {
 753         AUTH_DONT_KNOW = -100,  /*!< no result, need to check further */
 754                 /* XXX maybe this is the same as AUTH_NOT_FOUND */
 755
 756         AUTH_SUCCESSFUL = 0,
 757         AUTH_CHALLENGE_SENT = 1,
 758         AUTH_SECRET_FAILED = -1,
 759         AUTH_USERNAME_MISMATCH = -2,
 760         AUTH_NOT_FOUND = -3,    /*!< returned by register_verify */
 761         AUTH_FAKE_AUTH = -4,
 762         AUTH_UNKNOWN_DOMAIN = -5,
 763         AUTH_PEER_NOT_DYNAMIC = -6,
 764         AUTH_ACL_FAILED = -7,
 765         AUTH_BAD_TRANSPORT = -8,
 766         AUTH_RTP_FAILED = 9,
 767 };
 768
 769 /*! \brief States for outbound registrations (with register= lines in sip.conf */
 770 enum sipregistrystate {
 771         REG_STATE_UNREGISTERED = 0,     /*!< We are not registered
 772                  *  \note Initial state. We should have a timeout scheduled for the initial
 773                  * (or next) registration transmission, calling sip_reregister
 774                  */
 775
 776         REG_STATE_REGSENT,      /*!< Registration request sent
 777                  * \note sent initial request, waiting for an ack or a timeout to
 778                  * retransmit the initial request.
 779                 */
 780
 781         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate
 782                  * \note entered after transmit_register with auth info,
 783                  * waiting for an ack.
 784                  */
 785
 786         REG_STATE_REGISTERED,   /*!< Registered and done */
 787
 788         REG_STATE_REJECTED,     /*!< Registration rejected *
 789                  * \note only used when the remote party has an expire larger than
 790                  * our max-expire. This is a final state from which we do not
 791                  * recover (not sure how correctly).
 792                  */
 793
 794         REG_STATE_TIMEOUT,      /*!< Registration timed out *
 795                 * \note XXX unused */
 796
 797         REG_STATE_NOAUTH,       /*!< We have no accepted credentials
 798                  * \note fatal - no chance to proceed */
 799
 800         REG_STATE_FAILED,       /*!< Registration failed after several tries
 801                  * \note fatal - no chance to proceed */
 802 };
 803
 804 /*! \brief Modes in which Asterisk can be configured to run SIP Session-Timers */
 805 enum st_mode {
 806         SESSION_TIMER_MODE_INVALID = 0, /*!< Invalid value */
 807         SESSION_TIMER_MODE_ACCEPT,      /*!< Honor inbound Session-Timer requests */
 808         SESSION_TIMER_MODE_ORIGINATE,   /*!< Originate outbound and honor inbound requests */
 809         SESSION_TIMER_MODE_REFUSE       /*!< Ignore inbound Session-Timers requests */
 810 };
 811
 812 /*! \brief The entity playing the refresher role for Session-Timers */
 813 enum st_refresher {
 814         SESSION_TIMER_REFRESHER_AUTO,    /*!< Negotiated                      */
 815         SESSION_TIMER_REFRESHER_UAC,     /*!< Session is refreshed by the UAC */
 816         SESSION_TIMER_REFRESHER_UAS      /*!< Session is refreshed by the UAS */
 817 };
 818
 819 /*! \brief Define some implemented SIP transports
 820         \note Asterisk does not support SCTP or UDP/DTLS
 821 */
 822 enum sip_transport {
 823         SIP_TRANSPORT_UDP = 1,          /*!< Unreliable transport for SIP, needs retransmissions */
 824         SIP_TRANSPORT_TCP = 1 << 1,     /*!< Reliable, but unsecure */
 825         SIP_TRANSPORT_TLS = 1 << 2,     /*!< TCP/TLS - reliable and secure transport for signalling */
 826 };
 827
 828 /*! \brief definition of a sip proxy server
 829  *
 830  * For outbound proxies, a sip_peer will contain a reference to a
 831  * dynamically allocated instance of a sip_proxy. A sip_pvt may also
 832  * contain a reference to a peer's outboundproxy, or it may contain
 833  * a reference to the sip_cfg.outboundproxy.
 834  */
 835 struct sip_proxy {
 836         char name[MAXHOSTNAMELEN];      /*!< DNS name of domain/host or IP */
 837         struct sockaddr_in ip;          /*!< Currently used IP address and port */
 838         time_t last_dnsupdate;          /*!< When this was resolved */
 839         enum sip_transport transport;
 840         int force;                      /*!< If it's an outbound proxy, Force use of this outbound proxy for all outbound requests */
 841         /* Room for a SRV record chain based on the name */
 842 };
 843
 844 /*! \brief argument for the 'show channels|subscriptions' callback. */
 845 struct __show_chan_arg {
 846         int fd;
 847         int subscriptions;
 848         int numchans;   /* return value */
 849 };
 850
 851
 852 /*! \brief States whether a SIP message can create a dialog in Asterisk. */
 853 enum can_create_dialog {
 854         CAN_NOT_CREATE_DIALOG,
 855         CAN_CREATE_DIALOG,
 856         CAN_CREATE_DIALOG_UNSUPPORTED_METHOD,
 857 };
 858
 859 /*! \brief SIP Request methods known by Asterisk
 860
 861    \note Do _NOT_ make any changes to this enum, or the array following it;
 862    if you think you are doing the right thing, you are probably
 863    not doing the right thing. If you think there are changes
 864    needed, get someone else to review them first _before_
 865    submitting a patch. If these two lists do not match properly
 866    bad things will happen.
 867 */
 868
 869 enum sipmethod {
 870         SIP_UNKNOWN,            /*!< Unknown response */
 871         SIP_RESPONSE,           /*!< Not request, response to outbound request */
 872         SIP_REGISTER,           /*!< Registration to the mothership, tell us where you are located */
 873         SIP_OPTIONS,            /*!< Check capabilities of a device, used for "ping" too */
 874         SIP_NOTIFY,             /*!< Status update, Part of the event package standard, result of a SUBSCRIBE or a REFER */
 875         SIP_INVITE,             /*!< Set up a session */
 876         SIP_ACK,                /*!< End of a three-way handshake started with INVITE. */
 877         SIP_PRACK,              /*!< Reliable pre-call signalling. Not supported in Asterisk. */
 878         SIP_BYE,                /*!< End of a session */
 879         SIP_REFER,              /*!< Refer to another URI (transfer) */
 880         SIP_SUBSCRIBE,          /*!< Subscribe for updates (voicemail, session status, device status, presence) */
 881         SIP_MESSAGE,            /*!< Text messaging */
 882         SIP_UPDATE,             /*!< Update a dialog. We can send UPDATE; but not accept it */
 883         SIP_INFO,               /*!< Information updates during a session */
 884         SIP_CANCEL,             /*!< Cancel an INVITE */
 885         SIP_PUBLISH,            /*!< Not supported in Asterisk */
 886         SIP_PING,               /*!< Not supported at all, no standard but still implemented out there */
 887 };
 888
 889 /*! \brief Settings for the 'notifycid' option, see sip.conf.sample for details. */
 890 enum notifycid_setting {
 891         DISABLED       = 0,
 892         ENABLED        = 1,
 893         IGNORE_CONTEXT = 2,
 894 };
 895
 896 /*! \brief The core structure to setup dialogs. We parse incoming messages by using
 897         structure and then route the messages according to the type.
 898
 899       \note Note that sip_methods[i].id == i must hold or the code breaks */
 900 static const struct  cfsip_methods {
 901         enum sipmethod id;
 902         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
 903         char * const text;
 904         enum can_create_dialog can_create;
 905 } sip_methods[] = {
 906         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",   CAN_CREATE_DIALOG },
 907         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",     CAN_NOT_CREATE_DIALOG },
 908         { SIP_REGISTER,  NO_RTP, "REGISTER",    CAN_CREATE_DIALOG },
 909         { SIP_OPTIONS,   NO_RTP, "OPTIONS",     CAN_CREATE_DIALOG },
 910         { SIP_NOTIFY,    NO_RTP, "NOTIFY",      CAN_CREATE_DIALOG },
 911         { SIP_INVITE,    RTP,    "INVITE",      CAN_CREATE_DIALOG },
 912         { SIP_ACK,       NO_RTP, "ACK",         CAN_NOT_CREATE_DIALOG },
 913         { SIP_PRACK,     NO_RTP, "PRACK",       CAN_NOT_CREATE_DIALOG },
 914         { SIP_BYE,       NO_RTP, "BYE",         CAN_NOT_CREATE_DIALOG },
 915         { SIP_REFER,     NO_RTP, "REFER",       CAN_CREATE_DIALOG },
 916         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",   CAN_CREATE_DIALOG },
 917         { SIP_MESSAGE,   NO_RTP, "MESSAGE",     CAN_CREATE_DIALOG },
 918         { SIP_UPDATE,    NO_RTP, "UPDATE",      CAN_NOT_CREATE_DIALOG },
 919         { SIP_INFO,      NO_RTP, "INFO",        CAN_NOT_CREATE_DIALOG },
 920         { SIP_CANCEL,    NO_RTP, "CANCEL",      CAN_NOT_CREATE_DIALOG },
 921         { SIP_PUBLISH,   NO_RTP, "PUBLISH",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD },
 922         { SIP_PING,      NO_RTP, "PING",        CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
 923 };
 924
 925 /*!  Define SIP option tags, used in Require: and Supported: headers
 926         We need to be aware of these properties in the phones to use
 927         the replace: header. We should not do that without knowing
 928         that the other end supports it...
 929         This is nothing we can configure, we learn by the dialog
 930         Supported: header on the REGISTER (peer) or the INVITE
 931         (other devices)
 932         We are not using many of these today, but will in the future.
 933         This is documented in RFC 3261
 934 */
 935 #define SUPPORTED               1
 936 #define NOT_SUPPORTED           0
 937
 938 /* SIP options */
 939 #define SIP_OPT_REPLACES        (1 << 0)
 940 #define SIP_OPT_100REL          (1 << 1)
 941 #define SIP_OPT_TIMER           (1 << 2)
 942 #define SIP_OPT_EARLY_SESSION   (1 << 3)
 943 #define SIP_OPT_JOIN            (1 << 4)
 944 #define SIP_OPT_PATH            (1 << 5)
 945 #define SIP_OPT_PREF            (1 << 6)
 946 #define SIP_OPT_PRECONDITION    (1 << 7)
 947 #define SIP_OPT_PRIVACY         (1 << 8)
 948 #define SIP_OPT_SDP_ANAT        (1 << 9)
 949 #define SIP_OPT_SEC_AGREE       (1 << 10)
 950 #define SIP_OPT_EVENTLIST       (1 << 11)
 951 #define SIP_OPT_GRUU            (1 << 12)
 952 #define SIP_OPT_TARGET_DIALOG   (1 << 13)
 953 #define SIP_OPT_NOREFERSUB      (1 << 14)
 954 #define SIP_OPT_HISTINFO        (1 << 15)
 955 #define SIP_OPT_RESPRIORITY     (1 << 16)
 956 #define SIP_OPT_FROMCHANGE      (1 << 17)
 957 #define SIP_OPT_RECLISTINV      (1 << 18)
 958 #define SIP_OPT_RECLISTSUB      (1 << 19)
 959 #define SIP_OPT_OUTBOUND        (1 << 20)
 960 #define SIP_OPT_UNKNOWN         (1 << 21)
 961
 962
 963 /*! \brief List of well-known SIP options. If we get this in a require,
 964    we should check the list and answer accordingly. */
 965 static const struct cfsip_options {
 966         int id;                 /*!< Bitmap ID */
 967         int supported;          /*!< Supported by Asterisk ? */
 968         char * const text;      /*!< Text id, as in standard */
 969 } sip_options[] = {     /* XXX used in 3 places */
 970         /* RFC3262: PRACK 100% reliability */
 971         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },
 972         /* RFC3959: SIP Early session support */
 973         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
 974         /* SIMPLE events:  RFC4662 */
 975         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
 976         /* RFC 4916- Connected line ID updates */
 977         { SIP_OPT_FROMCHANGE,   NOT_SUPPORTED,  "from-change" },
 978         /* GRUU: Globally Routable User Agent URI's */
 979         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
 980         /* RFC4244 History info */
 981         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
 982         /* RFC3911: SIP Join header support */
 983         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
 984         /* Disable the REFER subscription, RFC 4488 */
 985         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
 986         /* SIP outbound - the final NAT battle - draft-sip-outbound */
 987         { SIP_OPT_OUTBOUND,     NOT_SUPPORTED,  "outbound" },
 988         /* RFC3327: Path support */
 989         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
 990         /* RFC3840: Callee preferences */
 991         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
 992         /* RFC3312: Precondition support */
 993         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
 994         /* RFC3323: Privacy with proxies*/
 995         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
 996         /* RFC-ietf-sip-uri-list-conferencing-02.txt conference invite lists */
 997         { SIP_OPT_RECLISTINV,   NOT_SUPPORTED,  "recipient-list-invite" },
 998         /* RFC-ietf-sip-uri-list-subscribe-02.txt - subscription lists */
 999         { SIP_OPT_RECLISTSUB,   NOT_SUPPORTED,  "recipient-list-subscribe" },
1000         /* RFC3891: Replaces: header for transfer */
1001         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },
1002         /* One version of Polycom firmware has the wrong label */
1003         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },
1004         /* RFC4412 Resource priorities */
1005         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
1006         /* RFC3329: Security agreement mechanism */
1007         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
1008         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
1009         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
1010         /* RFC4028: SIP Session-Timers */
1011         { SIP_OPT_TIMER,        SUPPORTED,      "timer" },
1012         /* RFC4538: Target-dialog */
1013         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
1014 };
1015
1016 /*! \brief Diversion header reasons
1017  *
1018  * The core defines a bunch of constants used to define
1019  * redirecting reasons. This provides a translation table
1020  * between those and the strings which may be present in
1021  * a SIP Diversion header
1022  */
1023 static const struct sip_reasons {
1024         enum AST_REDIRECTING_REASON code;
1025         char * const text;
1026 } sip_reason_table[] = {
1027         { AST_REDIRECTING_REASON_UNKNOWN, "unknown" },
1028         { AST_REDIRECTING_REASON_USER_BUSY, "user-busy" },
1029         { AST_REDIRECTING_REASON_NO_ANSWER, "no-answer" },
1030         { AST_REDIRECTING_REASON_UNAVAILABLE, "unavailable" },
1031         { AST_REDIRECTING_REASON_UNCONDITIONAL, "unconditional" },
1032         { AST_REDIRECTING_REASON_TIME_OF_DAY, "time-of-day" },
1033         { AST_REDIRECTING_REASON_DO_NOT_DISTURB, "do-not-disturb" },
1034         { AST_REDIRECTING_REASON_DEFLECTION, "deflection" },
1035         { AST_REDIRECTING_REASON_FOLLOW_ME, "follow-me" },
1036         { AST_REDIRECTING_REASON_OUT_OF_ORDER, "out-of-service" },
1037         { AST_REDIRECTING_REASON_AWAY, "away" },
1038         { AST_REDIRECTING_REASON_CALL_FWD_DTE, "unknown"}
1039 };
1040
1041 static enum AST_REDIRECTING_REASON sip_reason_str_to_code(const char *text)
1042 {
1043         enum AST_REDIRECTING_REASON ast = AST_REDIRECTING_REASON_UNKNOWN;
1044         int i;
1045
1046         for (i = 0; i < ARRAY_LEN(sip_reason_table); ++i) {
1047                 if (!strcasecmp(text, sip_reason_table[i].text)) {
1048                         ast = sip_reason_table[i].code;
1049                         break;
1050                 }
1051         }
1052
1053         return ast;
1054 }
1055
1056 static const char *sip_reason_code_to_str(enum AST_REDIRECTING_REASON code)
1057 {
1058         if (code >= 0 && code < ARRAY_LEN(sip_reason_table)) {
1059                 return sip_reason_table[code].text;
1060         }
1061
1062         return "unknown";
1063 }
1064
1065 /*! \brief SIP Methods we support
1066         \todo This string should be set dynamically. We only support REFER and SUBSCRIBE if we have
1067         allowsubscribe and allowrefer on in sip.conf.
1068 */
1069 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY, INFO"
1070
1071 /*! \brief SIP Extensions we support
1072         \note This should be generated based on the previous array
1073                 in combination with settings.
1074         \todo We should not have "timer" if it's disabled in the configuration file.
1075 */
1076 #define SUPPORTED_EXTENSIONS "replaces, timer"
1077
1078 /*! \brief Standard SIP unsecure port for UDP and TCP from RFC 3261. DO NOT CHANGE THIS */
1079 #define STANDARD_SIP_PORT       5060
1080 /*! \brief Standard SIP TLS port from RFC 3261. DO NOT CHANGE THIS */
1081 #define STANDARD_TLS_PORT       5061
1082
1083 /*! \note in many SIP headers, absence of a port number implies port 5060,
1084  * and this is why we cannot change the above constant.
1085  * There is a limited number of places in asterisk where we could,
1086  * in principle, use a different "default" port number, but
1087  * we do not support this feature at the moment.
1088  * You can run Asterisk with SIP on a different port with a configuration
1089  * option. If you change this value, the signalling will be incorrect.
1090  */
1091
1092 /*! \name DefaultValues Default values, set and reset in reload_config before reading configuration
1093
1094    These are default values in the source. There are other recommended values in the
1095    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
1096    yet encouraging new behaviour on new installations
1097  */
1098 /*@{*/
1099 #define DEFAULT_CONTEXT         "default"       /*!< The default context for [general] section as well as devices */
1100 #define DEFAULT_MOHINTERPRET    "default"       /*!< The default music class */
1101 #define DEFAULT_MOHSUGGEST      ""
1102 #define DEFAULT_VMEXTEN         "asterisk"      /*!< Default voicemail extension */
1103 #define DEFAULT_CALLERID        "asterisk"      /*!< Default caller ID */
1104 #define DEFAULT_MWI_FROM ""
1105 #define DEFAULT_NOTIFYMIME      "application/simple-message-summary"
1106 #define DEFAULT_ALLOWGUEST      TRUE
1107 #define DEFAULT_RTPKEEPALIVE    0               /*!< Default RTPkeepalive setting */
1108 #define DEFAULT_CALLCOUNTER     FALSE
1109 #define DEFAULT_SRVLOOKUP       TRUE            /*!< Recommended setting is ON */
1110 #define DEFAULT_COMPACTHEADERS  FALSE           /*!< Send compact (one-character) SIP headers. Default off */
1111 #define DEFAULT_TOS_SIP         0               /*!< Call signalling packets should be marked as DSCP CS3, but the default is 0 to be compatible with previous versions. */
1112 #define DEFAULT_TOS_AUDIO       0               /*!< Audio packets should be marked as DSCP EF (Expedited Forwarding), but the default is 0 to be compatible with previous versions. */
1113 #define DEFAULT_TOS_VIDEO       0               /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
1114 #define DEFAULT_TOS_TEXT        0               /*!< Text packets should be marked as XXXX XXXX, but the default is 0 to be compatible with previous versions. */
1115 #define DEFAULT_COS_SIP         4               /*!< Level 2 class of service for SIP signalling */
1116 #define DEFAULT_COS_AUDIO       5               /*!< Level 2 class of service for audio media  */
1117 #define DEFAULT_COS_VIDEO       6               /*!< Level 2 class of service for video media */
1118 #define DEFAULT_COS_TEXT        5               /*!< Level 2 class of service for text media (T.140) */
1119 #define DEFAULT_ALLOW_EXT_DOM   TRUE            /*!< Allow external domains */
1120 #define DEFAULT_REALM           "asterisk"      /*!< Realm for HTTP digest authentication */
1121 #define DEFAULT_NOTIFYRINGING   TRUE            /*!< Notify devicestate system on ringing state */
1122 #define DEFAULT_NOTIFYCID               DISABLED        /*!< Include CID with ringing notifications */
1123 #define DEFAULT_PEDANTIC        FALSE           /*!< Avoid following SIP standards for dialog matching */
1124 #define DEFAULT_AUTOCREATEPEER  FALSE           /*!< Don't create peers automagically */
1125 #define DEFAULT_MATCHEXTERNIPLOCALLY FALSE      /*!< Match extern IP locally default setting */
1126 #define DEFAULT_QUALIFY         FALSE           /*!< Don't monitor devices */
1127 #define DEFAULT_CALLEVENTS      FALSE           /*!< Extra manager SIP call events */
1128 #define DEFAULT_ALWAYSAUTHREJECT        FALSE   /*!< Don't reject authentication requests always */
1129 #define DEFAULT_REGEXTENONQUALIFY FALSE
1130 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
1131 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
1132 #ifndef DEFAULT_USERAGENT
1133 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
1134 #define DEFAULT_SDPSESSION "Asterisk PBX"       /*!< Default SDP session name, (s=) header unless re-defined in sip.conf */
1135 #define DEFAULT_SDPOWNER "root"                 /*!< Default SDP username field in (o=) header unless re-defined in sip.conf */
1136 #define DEFAULT_ENGINE "asterisk"               /*!< Default RTP engine to use for sessions */
1137 #endif
1138 /*@}*/
1139
1140 /*! \name DefaultSettings
1141         Default setttings are used as a channel setting and as a default when
1142         configuring devices
1143 */
1144 /*@{*/
1145 static char default_language[MAX_LANGUAGE];
1146 static char default_callerid[AST_MAX_EXTENSION];
1147 static char default_mwi_from[80];
1148 static char default_fromdomain[AST_MAX_EXTENSION];
1149 static char default_notifymime[AST_MAX_EXTENSION];
1150 static int default_qualify;             /*!< Default Qualify= setting */
1151 static char default_vmexten[AST_MAX_EXTENSION];
1152 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
1153 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting
1154                                                     *   a bridged channel on hold */
1155 static char default_parkinglot[AST_MAX_CONTEXT]; /*!< Parkinglot */
1156 static char default_engine[256];        /*!< Default RTP engine */
1157 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
1158 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
1159 static unsigned int default_transports;                 /*!< Default Transports (enum sip_transport) that are acceptable */
1160 static unsigned int default_primary_transport;          /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
1161
1162 /*@}*/
1163
1164 /*! \name GlobalSettings
1165         Global settings apply to the channel (often settings you can change in the general section
1166         of sip.conf
1167 */
1168 /*@{*/
1169 /*! \brief a place to store all global settings for the sip channel driver
1170         These are settings that will be possibly to apply on a group level later on.
1171         \note Do not add settings that only apply to the channel itself and can't
1172               be applied to devices (trunks, services, phones)
1173 */
1174 struct sip_settings {
1175         int peer_rtupdate;              /*!< G: Update database with registration data for peer? */
1176         int rtsave_sysname;             /*!< G: Save system name at registration? */
1177         int ignore_regexpire;           /*!< G: Ignore expiration of peer  */
1178         int rtautoclear;                /*!< Realtime ?? */
1179         int directrtpsetup;             /*!< Enable support for Direct RTP setup (no re-invites) */
1180         int pedanticsipchecking;        /*!< Extra checking ?  Default off */
1181         int autocreatepeer;             /*!< Auto creation of peers at registration? Default off. */
1182         int srvlookup;                  /*!< SRV Lookup on or off. Default is on */
1183         int allowguest;                 /*!< allow unauthenticated peers to connect? */
1184         int alwaysauthreject;           /*!< Send 401 Unauthorized for all failing requests */
1185         int compactheaders;             /*!< send compact sip headers */
1186         int allow_external_domains;     /*!< Accept calls to external SIP domains? */
1187         int callevents;                 /*!< Whether we send manager events or not */
1188         int regextenonqualify;          /*!< Whether to add/remove regexten when qualifying peers */
1189         int matchexterniplocally;       /*!< Match externip/externhost setting against localnet setting */
1190         int notifyringing;              /*!< Send notifications on ringing */
1191         int notifyhold;                 /*!< Send notifications on hold */
1192         enum notifycid_setting notifycid; /*!< Send CID with ringing notifications */
1193         enum transfermodes allowtransfer;       /*!< SIP Refer restriction scheme */
1194         int allowsubscribe;             /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE
1195                                             the global setting is in globals_flags[1] */
1196         char realm[MAXHOSTNAMELEN];             /*!< Default realm */
1197         struct sip_proxy outboundproxy; /*!< Outbound proxy */
1198         char default_context[AST_MAX_CONTEXT];
1199         char default_subscribecontext[AST_MAX_CONTEXT];
1200 };
1201
1202 static struct sip_settings sip_cfg;
1203
1204 static int global_match_auth_username;          /*!< Match auth username if available instead of From: Default off. */
1205
1206 static int global_relaxdtmf;            /*!< Relax DTMF */
1207 static int global_rtptimeout;           /*!< Time out call if no RTP */
1208 static int global_rtpholdtimeout;       /*!< Time out call if no RTP during hold */
1209 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
1210 static int global_reg_timeout;
1211 static int global_regattempts_max;      /*!< Registration attempts before giving up */
1212 static int global_callcounter;          /*!< Enable call counters for all devices. This is currently enabled by setting the peer
1213                                                 call-limit to 999. When we remove the call-limit from the code, we can make it
1214                                                 with just a boolean flag in the device structure */
1215 static unsigned int global_tos_sip;             /*!< IP type of service for SIP packets */
1216 static unsigned int global_tos_audio;           /*!< IP type of service for audio RTP packets */
1217 static unsigned int global_tos_video;           /*!< IP type of service for video RTP packets */
1218 static unsigned int global_tos_text;            /*!< IP type of service for text RTP packets */
1219 static unsigned int global_cos_sip;             /*!< 802.1p class of service for SIP packets */
1220 static unsigned int global_cos_audio;           /*!< 802.1p class of service for audio RTP packets */
1221 static unsigned int global_cos_video;           /*!< 802.1p class of service for video RTP packets */
1222 static unsigned int global_cos_text;            /*!< 802.1p class of service for text RTP packets */
1223 static unsigned int recordhistory;              /*!< Record SIP history. Off by default */
1224 static unsigned int dumphistory;                /*!< Dump history to verbose before destroying SIP dialog */
1225 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
1226 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
1227 static char global_sdpsession[AST_MAX_EXTENSION];       /*!< SDP session name for the SIP channel */
1228 static char global_sdpowner[AST_MAX_EXTENSION]; /*!< SDP owner name for the SIP channel */
1229 static int global_authfailureevents;            /*!< Whether we send authentication failure manager events or not. Default no. */
1230 static int global_t1;                   /*!< T1 time */
1231 static int global_t1min;                /*!< T1 roundtrip time minimum */
1232 static int global_timer_b;                      /*!< Timer B - RFC 3261 Section 17.1.1.2 */
1233 static unsigned int global_autoframing;         /*!< Turn autoframing on or off. */
1234 static int global_qualifyfreq;                  /*!< Qualify frequency */
1235 static int global_qualify_gap;              /*!< Time between our group of peer pokes */
1236 static int global_qualify_peers;          /*!< Number of peers to poke at a given time */
1237
1238
1239 /*! \brief Codecs that we support by default: */
1240 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
1241
1242 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
1243 static enum st_refresher global_st_refresher; /*!< Session-Timer refresher                        */
1244 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
1245 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
1246
1247 /*@}*/
1248
1249 /*! \brief Global list of addresses dynamic peers are not allowed to use */
1250 static struct ast_ha *global_contact_ha = NULL;
1251 static int global_dynamic_exclude_static = 0;
1252
1253 /*! \name Object counters @{
1254  * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
1255  * should be used to modify these values. */
1256 static int speerobjs = 0;                /*!< Static peers */
1257 static int rpeerobjs = 0;                /*!< Realtime peers */
1258 static int apeerobjs = 0;                /*!< Autocreated peer objects */
1259 static int regobjs = 0;                  /*!< Registry objects */
1260 /* }@ */
1261
1262 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
1263 static char used_context[AST_MAX_CONTEXT];              /*!< name of automatically created context for unloading */
1264
1265
1266 AST_MUTEX_DEFINE_STATIC(netlock);
1267
1268 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
1269    when it's doing something critical. */
1270 AST_MUTEX_DEFINE_STATIC(monlock);
1271
1272 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
1273
1274 /*! \brief This is the thread for the monitor which checks for input on the channels
1275    which are not currently in use.  */
1276 static pthread_t monitor_thread = AST_PTHREADT_NULL;
1277
1278 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
1279 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
1280
1281 static struct sched_context *sched;     /*!< The scheduling context */
1282 static struct io_context *io;           /*!< The IO context */
1283 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
1284
1285 #define DEC_CALL_LIMIT  0
1286 #define INC_CALL_LIMIT  1
1287 #define DEC_CALL_RINGING 2
1288 #define INC_CALL_RINGING 3
1289
1290 /*! \brief The SIP socket definition */
1291 struct sip_socket {
1292         enum sip_transport type;        /*!< UDP, TCP or TLS */
1293         int fd;                         /*!< Filed descriptor, the actual socket */
1294         uint16_t port;
1295         struct ast_tcptls_session_instance *tcptls_session;     /* If tcp or tls, a socket manager */
1296 };
1297
1298 /*! \brief sip_request: The data grabbed from the UDP socket
1299  *
1300  * \verbatim
1301  * Incoming messages: we first store the data from the socket in data[],
1302  * adding a trailing \0 to make string parsing routines happy.
1303  * Then call parse_request() and req.method = find_sip_method();
1304  * to initialize the other fields. The \r\n at the end of each line is
1305  * replaced by \0, so that data[] is not a conforming SIP message anymore.
1306  * After this processing, rlPart1 is set to non-NULL to remember
1307  * that we can run get_header() on this kind of packet.
1308  *
1309  * parse_request() splits the first line as follows:
1310  * Requests have in the first line      method uri SIP/2.0
1311  *      rlPart1 = method; rlPart2 = uri;
1312  * Responses have in the first line     SIP/2.0 NNN description
1313  *      rlPart1 = SIP/2.0; rlPart2 = NNN + description;
1314  *
1315  * For outgoing packets, we initialize the fields with init_req() or init_resp()
1316  * (which fills the first line to "METHOD uri SIP/2.0" or "SIP/2.0 code text"),
1317  * and then fill the rest with add_header() and add_line().
1318  * The \r\n at the end of the line are still there, so the get_header()
1319  * and similar functions don't work on these packets.
1320  * \endverbatim
1321  */
1322 struct sip_request {
1323         ptrdiff_t rlPart1;              /*!< Offset of the SIP Method Name or "SIP/2.0" protocol version */
1324         ptrdiff_t rlPart2;              /*!< Offset of the Request URI or Response Status */
1325         int len;                /*!< bytes used in data[], excluding trailing null terminator. Rarely used. */
1326         int headers;            /*!< # of SIP Headers */
1327         int method;             /*!< Method of this request */
1328         int lines;              /*!< Body Content */
1329         unsigned int sdp_start; /*!< the line number where the SDP begins */
1330         unsigned int sdp_end;   /*!< the line number where the SDP ends */
1331         char debug;             /*!< print extra debugging if non zero */
1332         char has_to_tag;        /*!< non-zero if packet has To: tag */
1333         char ignore;            /*!< if non-zero This is a re-transmit, ignore it */
1334         /* Array of offsets into the request string of each SIP header*/
1335         ptrdiff_t header[SIP_MAX_HEADERS];
1336         /* Array of offsets into the request string of each SDP line*/
1337         ptrdiff_t line[SIP_MAX_LINES];
1338         struct ast_str *data;
1339         /* XXX Do we need to unref socket.ser when the request goes away? */
1340         struct sip_socket socket;       /*!< The socket used for this request */
1341         AST_LIST_ENTRY(sip_request) next;
1342 };
1343
1344 /* \brief given a sip_request and an offset, return the char * that resides there
1345  *
1346  * It used to be that rlPart1, rlPart2, and the header and line arrays were character
1347  * pointers. They are now offsets into the ast_str portion of the sip_request structure.
1348  * To avoid adding a bunch of redundant pointer arithmetic to the code, this macro is
1349  * provided to retrieve the string at a particular offset within the request's buffer
1350  */
1351 #define REQ_OFFSET_TO_STR(req,offset) (ast_str_buffer((req)->data) + ((req)->offset))
1352
1353 /*! \brief structure used in transfers */
1354 struct sip_dual {
1355         struct ast_channel *chan1;      /*!< First channel involved */
1356         struct ast_channel *chan2;      /*!< Second channel involved */
1357         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
1358         int seqno;                      /*!< Sequence number */
1359 };
1360
1361 struct sip_pkt;
1362
1363 /*! \brief Parameters to the transmit_invite function */
1364 struct sip_invite_param {
1365         int addsipheaders;              /*!< Add extra SIP headers */
1366         const char *uri_options;        /*!< URI options to add to the URI */
1367         const char *vxml_url;           /*!< VXML url for Cisco phones */
1368         char *auth;                     /*!< Authentication */
1369         char *authheader;               /*!< Auth header */
1370         enum sip_auth_type auth_type;   /*!< Authentication type */
1371         const char *replaces;           /*!< Replaces header for call transfers */
1372         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
1373 };
1374
1375 /*! \brief Structure to save routing information for a SIP session */
1376 struct sip_route {
1377         struct sip_route *next;
1378         char hop[0];
1379 };
1380
1381 /*! \brief Modes for SIP domain handling in the PBX */
1382 enum domain_mode {
1383         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
1384         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
1385 };
1386
1387 /*! \brief Domain data structure.
1388         \note In the future, we will connect this to a configuration tree specific
1389         for this domain
1390 */
1391 struct domain {
1392         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
1393         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
1394         enum domain_mode mode;                  /*!< How did we find this domain? */
1395         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
1396 };
1397
1398 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
1399
1400
1401 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
1402 struct sip_history {
1403         AST_LIST_ENTRY(sip_history) list;
1404         char event[0];  /* actually more, depending on needs */
1405 };
1406
1407 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
1408
1409 /*! \brief sip_auth: Credentials for authentication to other SIP services */
1410 struct sip_auth {
1411         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
1412         char username[256];             /*!< Username */
1413         char secret[256];               /*!< Secret */
1414         char md5secret[256];            /*!< MD5Secret */
1415         struct sip_auth *next;          /*!< Next auth structure in list */
1416 };
1417
1418 /*! \name SIPflags
1419         Various flags for the flags field in the pvt structure
1420         Trying to sort these up (one or more of the following):
1421         D: Dialog
1422         P: Peer/user
1423         G: Global flag
1424         When flags are used by multiple structures, it is important that
1425         they have a common layout so it is easy to copy them.
1426 */
1427 /*@{*/
1428 #define SIP_OUTGOING            (1 << 0)        /*!< D: Direction of the last transaction in this dialog */
1429 #define SIP_RINGING             (1 << 2)        /*!< D: Have sent 180 ringing */
1430 #define SIP_PROGRESS_SENT       (1 << 3)        /*!< D: Have sent 183 message progress */
1431 #define SIP_NEEDREINVITE        (1 << 4)        /*!< D: Do we need to send another reinvite? */
1432 #define SIP_PENDINGBYE          (1 << 5)        /*!< D: Need to send bye after we ack? */
1433 #define SIP_GOTREFER            (1 << 6)        /*!< D: Got a refer? */
1434 #define SIP_CALL_LIMIT          (1 << 7)        /*!< D: Call limit enforced for this call */
1435 #define SIP_INC_COUNT           (1 << 8)        /*!< D: Did this dialog increment the counter of in-use calls? */
1436 #define SIP_INC_RINGING         (1 << 9)        /*!< D: Did this connection increment the counter of in-use calls? */
1437 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 10)       /*!< D: Do not hangup at first ast_hangup */
1438
1439 #define SIP_PROMISCREDIR        (1 << 11)       /*!< DP: Promiscuous redirection */
1440 #define SIP_TRUSTRPID           (1 << 12)       /*!< DP: Trust RPID headers? */
1441 #define SIP_USEREQPHONE         (1 << 13)       /*!< DP: Add user=phone to numeric URI. Default off */
1442 #define SIP_USECLIENTCODE       (1 << 14)       /*!< DP: Trust X-ClientCode info message */
1443
1444 /* DTMF flags - see str2dtmfmode() and dtmfmode2str() */
1445 #define SIP_DTMF                (7 << 15)       /*!< DP: DTMF Support: five settings, uses three bits */
1446 #define SIP_DTMF_RFC2833        (0 << 15)       /*!< DP: DTMF Support: RTP DTMF - "rfc2833" */
1447 #define SIP_DTMF_INBAND         (1 << 15)       /*!< DP: DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
1448 #define SIP_DTMF_INFO           (2 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" */
1449 #define SIP_DTMF_AUTO           (3 << 15)       /*!< DP: DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
1450 #define SIP_DTMF_SHORTINFO      (4 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" - short variant */
1451
1452 /* NAT settings */
1453 #define SIP_NAT_FORCE_RPORT     (1 << 18)       /*!< DP: Force rport even if not present in the request */
1454 #define SIP_NAT_RPORT_PRESENT   (1 << 19)       /*!< DP: rport was present in the request */
1455
1456 /* re-INVITE related settings */
1457 #define SIP_REINVITE            (7 << 20)       /*!< DP: four settings, uses three bits */
1458 #define SIP_REINVITE_NONE       (0 << 20)       /*!< DP: no reinvite allowed */
1459 #define SIP_CAN_REINVITE        (1 << 20)       /*!< DP: allow peers to be reinvited to send media directly p2p */
1460 #define SIP_CAN_REINVITE_NAT    (2 << 20)       /*!< DP: allow media reinvite when new peer is behind NAT */
1461 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< DP: use UPDATE (RFC3311) when reinviting this peer */
1462
1463 /* "insecure" settings - see insecure2str() */
1464 #define SIP_INSECURE            (3 << 23)       /*!< DP: three settings, uses two bits */
1465 #define SIP_INSECURE_NONE       (0 << 23)       /*!< DP: secure mode */
1466 #define SIP_INSECURE_PORT       (1 << 23)       /*!< DP: don't require matching port for incoming requests */
1467 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< DP: don't require authentication for incoming INVITEs */
1468
1469 /* Sending PROGRESS in-band settings */
1470 #define SIP_PROG_INBAND         (3 << 25)       /*!< DP: three settings, uses two bits */
1471 #define SIP_PROG_INBAND_NEVER   (0 << 25)
1472 #define SIP_PROG_INBAND_NO      (1 << 25)
1473 #define SIP_PROG_INBAND_YES     (2 << 25)
1474
1475 #define SIP_SENDRPID            (3 << 29)       /*!< DP: Remote Party-ID Support */
1476 #define SIP_SENDRPID_NO     (0 << 29)
1477 #define SIP_SENDRPID_PAI    (1 << 29)   /*!< Use "P-Asserted-Identity" for rpid */
1478 #define SIP_SENDRPID_RPID   (2 << 29)   /*!< Use "Remote-Party-ID" for rpid */
1479 #define SIP_G726_NONSTANDARD    (1 << 31)       /*!< DP: Use non-standard packing for G726-32 data */
1480
1481 /*! \brief Flags to copy from peer/user to dialog */
1482 #define SIP_FLAGS_TO_COPY \
1483         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
1484          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT_FORCE_RPORT | SIP_G726_NONSTANDARD | \
1485          SIP_USEREQPHONE | SIP_INSECURE)
1486 /*@}*/
1487
1488 /*! \name SIPflags2
1489         a second page of flags (for flags[1] */
1490 /*@{*/
1491 /* realtime flags */
1492 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)        /*!< GP: Should we keep RT objects in memory for extended time? */
1493 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)        /*!< GP: Should we clean memory from peers after expiry? */
1494 #define SIP_PAGE2_RPID_UPDATE           (1 << 3)
1495 /* Space for addition of other realtime flags in the future */
1496 #define SIP_PAGE2_SYMMETRICRTP          (1 << 8)        /*!< GDP: Whether symmetric RTP is enabled or not */
1497 #define SIP_PAGE2_STATECHANGEQUEUE      (1 << 9)        /*!< D: Unsent state pending change exists */
1498
1499 #define SIP_PAGE2_CONNECTLINEUPDATE_PEND                (1 << 10)
1500 #define SIP_PAGE2_RPID_IMMEDIATE                        (1 << 11)
1501 #define SIP_PAGE2_RPORT_PRESENT         (1 << 12)       /*!< Was rport received in the Via header? */
1502 #define SIP_PAGE2_PREFERRED_CODEC       (1 << 13)       /*!< GDP: Only respond with single most preferred joint codec */
1503 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 14)       /*!< DP: Video supported if offered? */
1504 #define SIP_PAGE2_TEXTSUPPORT           (1 << 15)       /*!< GDP: Global text enable */
1505 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< GP: Allow subscriptions from this peer? */
1506 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< DP: Allow overlap dialing ? */
1507 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< GP: Only issue MWI notification if subscribed to */
1508 #define SIP_PAGE2_IGNORESDPVERSION      (1 << 19)       /*!< GDP: Ignore the SDP session version number we receive and treat all sessions as new */
1509
1510 #define SIP_PAGE2_T38SUPPORT                    (7 << 20)       /*!< GDP: T.38 Fax Support */
1511 #define SIP_PAGE2_T38SUPPORT_UDPTL              (1 << 20)       /*!< GDP: T.38 Fax Support (no error correction) */
1512 #define SIP_PAGE2_T38SUPPORT_UDPTL_FEC          (2 << 20)       /*!< GDP: T.38 Fax Support (FEC error correction) */
1513 #define SIP_PAGE2_T38SUPPORT_UDPTL_REDUNDANCY   (4 << 20)       /*!< GDP: T.38 Fax Support (redundancy error correction) */
1514
1515 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< D: Call hold states: */
1516 #define SIP_PAGE2_CALL_ONHOLD_ACTIVE    (1 << 23)       /*!< D: Active hold */
1517 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (2 << 23)       /*!< D: One directional hold */
1518 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (3 << 23)       /*!< D: Inactive hold */
1519
1520 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 25)       /*!< DP: Compensate for buggy RFC2833 implementations */
1521 #define SIP_PAGE2_BUGGY_MWI             (1 << 26)       /*!< DP: Buggy CISCO MWI fix */
1522 #define SIP_PAGE2_DIALOG_ESTABLISHED    (1 << 27)       /*!< 29: Has a dialog been established? */
1523 #define SIP_PAGE2_FAX_DETECT            (1 << 28)               /*!< DP: Fax Detection support */
1524 #define SIP_PAGE2_REGISTERTRYING        (1 << 29)       /*!< DP: Send 100 Trying on REGISTER attempts */
1525 #define SIP_PAGE2_UDPTL_DESTINATION     (1 << 30)       /*!< DP: Use source IP of RTP as destination if NAT is enabled */
1526 #define SIP_PAGE2_VIDEOSUPPORT_ALWAYS   (1 << 31)       /*!< DP: Always set up video, even if endpoints don't support it */
1527
1528 #define SIP_PAGE2_FLAGS_TO_COPY \
1529         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_IGNORESDPVERSION | \
1530         SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE | \
1531         SIP_PAGE2_BUGGY_MWI | SIP_PAGE2_TEXTSUPPORT | SIP_PAGE2_FAX_DETECT | \
1532         SIP_PAGE2_UDPTL_DESTINATION | SIP_PAGE2_VIDEOSUPPORT_ALWAYS | SIP_PAGE2_PREFERRED_CODEC | \
1533         SIP_PAGE2_RPID_IMMEDIATE | SIP_PAGE2_RPID_UPDATE | SIP_PAGE2_SYMMETRICRTP)
1534
1535 /*@}*/
1536
1537 /*! \brief debugging state
1538  * We store separately the debugging requests from the config file
1539  * and requests from the CLI. Debugging is enabled if either is set
1540  * (which means that if sipdebug is set in the config file, we can
1541  * only turn it off by reloading the config).
1542  */
1543 enum sip_debug_e {
1544         sip_debug_none = 0,
1545         sip_debug_config = 1,
1546         sip_debug_console = 2,
1547 };
1548
1549 static enum sip_debug_e sipdebug;
1550
1551 /*! \brief extra debugging for 'text' related events.
1552  * At the moment this is set together with sip_debug_console.
1553  * \note It should either go away or be implemented properly.
1554  */
1555 static int sipdebug_text;
1556
1557 /*! \brief T38 States for a call */
1558 enum t38state {
1559         T38_DISABLED = 0,                /*!< Not enabled */
1560         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
1561         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
1562         T38_ENABLED                      /*!< Negotiated (enabled) */
1563 };
1564
1565 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
1566 struct t38properties {
1567         enum t38state state;            /*!< T.38 state */
1568         struct ast_control_t38_parameters our_parms;
1569         struct ast_control_t38_parameters their_parms;
1570 };
1571
1572 /*! \brief Parameters to know status of transfer */
1573 enum referstatus {
1574         REFER_IDLE,                    /*!< No REFER is in progress */
1575         REFER_SENT,                    /*!< Sent REFER to transferee */
1576         REFER_RECEIVED,                /*!< Received REFER from transferrer */
1577         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING (unused) */
1578         REFER_ACCEPTED,                /*!< Accepted by transferee */
1579         REFER_RINGING,                 /*!< Target Ringing */
1580         REFER_200OK,                   /*!< Answered by transfer target */
1581         REFER_FAILED,                  /*!< REFER declined - go on */
1582         REFER_NOAUTH                   /*!< We had no auth for REFER */
1583 };
1584
1585 /*! \brief generic struct to map between strings and integers.
1586  * Fill it with x-s pairs, terminate with an entry with s = NULL;
1587  * Then you can call map_x_s(...) to map an integer to a string,
1588  * and map_s_x() for the string -> integer mapping.
1589  */
1590 struct _map_x_s {
1591         int x;
1592         const char *s;
1593 };
1594
1595 static const struct _map_x_s referstatusstrings[] = {
1596         { REFER_IDLE,           "<none>" },
1597         { REFER_SENT,           "Request sent" },
1598         { REFER_RECEIVED,       "Request received" },
1599         { REFER_CONFIRMED,      "Confirmed" },
1600         { REFER_ACCEPTED,       "Accepted" },
1601         { REFER_RINGING,        "Target ringing" },
1602         { REFER_200OK,          "Done" },
1603         { REFER_FAILED,         "Failed" },
1604         { REFER_NOAUTH,         "Failed - auth failure" },
1605         { -1,                   NULL} /* terminator */
1606 };
1607
1608 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed
1609         \note OEJ: Should be moved to string fields */
1610 struct sip_refer {
1611         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
1612         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
1613         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
1614         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
1615         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
1616         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
1617         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
1618         char replaces_callid[SIPBUFSIZE];                       /*!< Replace info: callid */
1619         char replaces_callid_totag[SIPBUFSIZE/2];               /*!< Replace info: to-tag */
1620         char replaces_callid_fromtag[SIPBUFSIZE/2];             /*!< Replace info: from-tag */
1621         struct sip_pvt *refer_call;                     /*!< Call we are referring. This is just a reference to a
1622                                                          * dialog owned by someone else, so we should not destroy
1623                                                          * it when the sip_refer object goes.
1624                                                          */
1625         int attendedtransfer;                           /*!< Attended or blind transfer? */
1626         int localtransfer;                              /*!< Transfer to local domain? */
1627         enum referstatus status;                        /*!< REFER status */
1628 };
1629
1630
1631 /*! \brief Structure that encapsulates all attributes related to running
1632  *   SIP Session-Timers feature on a per dialog basis.
1633  */
1634 struct sip_st_dlg {
1635         int st_active;                          /*!< Session-Timers on/off */
1636         int st_interval;                        /*!< Session-Timers negotiated session refresh interval */
1637         int st_schedid;                         /*!< Session-Timers ast_sched scheduler id */
1638         enum st_refresher st_ref;               /*!< Session-Timers session refresher */
1639         int st_expirys;                         /*!< Session-Timers number of expirys */
1640         int st_active_peer_ua;                  /*!< Session-Timers on/off in peer UA */
1641         int st_cached_min_se;                   /*!< Session-Timers cached Min-SE */
1642         int st_cached_max_se;                   /*!< Session-Timers cached Session-Expires */
1643         enum st_mode st_cached_mode;            /*!< Session-Timers cached M.O. */
1644         enum st_refresher st_cached_ref;        /*!< Session-Timers cached refresher */
1645 };
1646
1647
1648 /*! \brief Structure that encapsulates all attributes related to configuration
1649  *   of SIP Session-Timers feature on a per user/peer basis.
1650  */
1651 struct sip_st_cfg {
1652         enum st_mode st_mode_oper;      /*!< Mode of operation for Session-Timers           */
1653         enum st_refresher st_ref;       /*!< Session-Timer refresher                        */
1654         int st_min_se;                  /*!< Lowest threshold for session refresh interval  */
1655         int st_max_se;                  /*!< Highest threshold for session refresh interval */
1656 };
1657
1658 struct offered_media {
1659         int offered;
1660         char text[128];
1661 };
1662
1663 /*! \brief Structure used for each SIP dialog, ie. a call, a registration, a subscribe.
1664  * Created and initialized by sip_alloc(), the descriptor goes into the list of
1665  * descriptors (dialoglist).
1666  */
1667 struct sip_pvt {
1668         struct sip_pvt *next;                   /*!< Next dialog in chain */
1669         enum invitestates invitestate;          /*!< Track state of SIP_INVITEs */
1670         int method;                             /*!< SIP method that opened this dialog */
1671         AST_DECLARE_STRING_FIELDS(
1672                 AST_STRING_FIELD(callid);       /*!< Global CallID */
1673                 AST_STRING_FIELD(randdata);     /*!< Random data */
1674                 AST_STRING_FIELD(accountcode);  /*!< Account code */
1675                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1676                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1677                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1678                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1679                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1680                 AST_STRING_FIELD(from);         /*!< The From: header */
1681                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
1682                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
1683                 AST_STRING_FIELD(context);      /*!< Context for this call */
1684                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
1685                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
1686                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
1687                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
1688                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
1689                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
1690                 AST_STRING_FIELD(todnid);       /*!< DNID of this call (overrides host) */
1691                 AST_STRING_FIELD(language);     /*!< Default language for this call */
1692                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
1693                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
1694                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
1695                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
1696                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
1697                 AST_STRING_FIELD(username);     /*!< [user] name */
1698                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
1699                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
1700                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
1701                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
1702                 AST_STRING_FIELD(peersecret);   /*!< Password */
1703                 AST_STRING_FIELD(peermd5secret);
1704                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
1705                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
1706                 AST_STRING_FIELD(mwi_from); /*!< Name to place in the From header in outgoing NOTIFY requests */
1707                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
1708                         /* we only store the part in <brackets> in this field. */
1709                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
1710                 AST_STRING_FIELD(url);          /*!< URL to be sent with next message to peer */
1711                 AST_STRING_FIELD(parkinglot);           /*!< Parkinglot */
1712                 AST_STRING_FIELD(engine);       /*!< RTP engine to use */
1713         );
1714         char via[128];                          /*!< Via: header */
1715         struct sip_socket socket;               /*!< The socket used for this dialog */
1716         unsigned int ocseq;                     /*!< Current outgoing seqno */
1717         unsigned int icseq;                     /*!< Current incoming seqno */
1718         ast_group_t callgroup;                  /*!< Call group */
1719         ast_group_t pickupgroup;                /*!< Pickup group */
1720         int lastinvite;                         /*!< Last Cseq of invite */
1721         struct ast_flags flags[2];              /*!< SIP_ flags */
1722
1723         /* boolean flags that don't belong in flags */
1724         unsigned short do_history:1;            /*!< Set if we want to record history */
1725         unsigned short alreadygone:1;           /*!< already destroyed by our peer */
1726         unsigned short needdestroy:1;           /*!< need to be destroyed by the monitor thread */
1727         unsigned short outgoing_call:1;         /*!< this is an outgoing call */
1728         unsigned short answered_elsewhere:1;    /*!< This call is cancelled due to answer on another channel */
1729         unsigned short novideo:1;               /*!< Didn't get video in invite, don't offer */
1730         unsigned short notext:1;                /*!< Text not supported  (?) */
1731         unsigned short session_modify:1;        /*!< Session modification request true/false  */
1732         unsigned short route_persistent:1;      /*!< Is this the "real" route? */
1733         unsigned short autoframing:1;           /*!< Whether to use our local configuration for frame sizes (off)
1734                                                  *   or respect the other endpoint's request for frame sizes (on)
1735                                                  *   for incoming calls
1736                                                  */
1737         char tag[11];                           /*!< Our tag for this session */
1738         int timer_t1;                           /*!< SIP timer T1, ms rtt */
1739         int timer_b;                            /*!< SIP timer B, ms */
1740         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
1741         unsigned int reqsipoptions;             /*!< Required SIP options on the other end */
1742         struct ast_codec_pref prefs;            /*!< codec prefs */
1743         int capability;                         /*!< Special capability (codec) */
1744         int jointcapability;                    /*!< Supported capability at both ends (codecs) */
1745         int peercapability;                     /*!< Supported peer capability */
1746         int prefcodec;                          /*!< Preferred codec (outbound only) */
1747         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
1748         int jointnoncodeccapability;            /*!< Joint Non codec capability */
1749         int redircodecs;                        /*!< Redirect codecs */
1750         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */
1751         int request_queue_sched_id;             /*!< Scheduler ID of any scheduled action to process queued requests */
1752         int authtries;                          /*!< Times we've tried to authenticate */
1753         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this dialog. Use ref_proxy to set this instead of setting it directly*/
1754         struct t38properties t38;               /*!< T38 settings */
1755         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
1756         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
1757         int callingpres;                        /*!< Calling presentation */
1758         int expiry;                             /*!< How long we take to expire */
1759         int sessionversion;                     /*!< SDP Session Version */
1760         int sessionid;                          /*!< SDP Session ID */
1761         long branch;                            /*!< The branch identifier of this session */
1762         long invite_branch;                     /*!< The branch used when we sent the initial INVITE */
1763         int64_t sessionversion_remote;          /*!< Remote UA's SDP Session Version */
1764         struct sockaddr_in sa;                  /*!< Our peer */
1765         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
1766         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
1767         struct sockaddr_in tredirip;            /*!< Where our Text RTP should be going if not to us */
1768         time_t lastrtprx;                       /*!< Last RTP received */
1769         time_t lastrtptx;                       /*!< Last RTP sent */
1770         int rtptimeout;                         /*!< RTP timeout time */
1771         struct sockaddr_in recv;                /*!< Received as */
1772         struct sockaddr_in ourip;               /*!< Our IP (as seen from the outside) */
1773         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
1774         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
1775         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
1776         struct ast_variable *notify_headers;    /*!< Custom notify type */
1777         struct sip_auth *peerauth;              /*!< Realm authentication */
1778         int noncecount;                         /*!< Nonce-count */
1779         unsigned int stalenonce:1;      /*!< Marks the current nonce as responded too */
1780         char lastmsg[256];                      /*!< Last Message sent/received */
1781         int amaflags;                           /*!< AMA Flags */
1782         int pendinginvite;                      /*!< Any pending INVITE or state NOTIFY (in subscribe pvt's) ? (seqno of this) */
1783         int glareinvite;                        /*!< A invite received while a pending invite is already present is stored here.  Its seqno is the
1784                                                 value. Since this glare invite's seqno is not the same as the pending invite's, it must be
1785                                                 held in order to properly process acknowledgements for our 491 response. */
1786         struct sip_request initreq;             /*!< Latest request that opened a new transaction
1787                                                         within this dialog.
1788                                                         NOT the request that opened the dialog */
1789
1790         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
1791         int waitid;                             /*!< Wait ID for scheduler after 491 or other delays */
1792         int autokillid;                         /*!< Auto-kill ID (scheduler) */
1793         int t38id;                              /*!< T.38 Response ID */
1794         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
1795         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
1796         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
1797         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
1798         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
1799
1800         struct ast_dsp *dsp;                    /*!< Inband DTMF Detection dsp */
1801
1802         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one
1803                                                         Used in peerpoke, mwi subscriptions */
1804         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
1805         struct ast_rtp_instance *rtp;                   /*!< RTP Session */
1806         struct ast_rtp_instance *vrtp;                  /*!< Video RTP session */
1807         struct ast_rtp_instance *trtp;                  /*!< Text RTP session */
1808         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
1809         struct sip_history_head *history;       /*!< History of this SIP dialog */
1810         size_t history_entries;                 /*!< Number of entires in the history */
1811         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
1812         AST_LIST_HEAD_NOLOCK(request_queue, sip_request) request_queue; /*!< Requests that arrived but could not be processed immediately */
1813         struct sip_invite_param *options;       /*!< Options for INVITE */
1814         struct sip_st_dlg *stimer;              /*!< SIP Session-Timers */
1815
1816         int red;                                /*!< T.140 RTP Redundancy */
1817         int hangupcause;                        /*!< Storage of hangupcause copied from our owner before we disconnect from the AST channel (only used at hangup) */
1818
1819         struct sip_subscription_mwi *mwi;       /*!< If this is a subscription MWI dialog, to which subscription */
1820         /*! The SIP methods allowed on this dialog. We get this information from the Allow header present in
1821          * the peer's REGISTER. If peer does not register with us, then we will use the first transaction we
1822          * have with this peer to determine its allowed methods.
1823          */
1824         unsigned int allowed_methods;
1825         /*! When receiving an SDP offer, it is important to take note of what media types were offered.
1826          * By doing this, even if we don't want to answer a particular media stream with something meaningful, we can
1827          * still put an m= line in our answer with the port set to 0.
1828          *
1829          * The reason for the length being 4 is that in this branch of Asterisk, the only media types supported are
1830          * image, audio, text, and video. Therefore we need to keep track of which types of media were offered.
1831          *
1832          * Note that if we wanted to be 100% correct, we would keep a list of all media streams offered. That way we could respond
1833          * even to unknown media types, and we could respond to multiple streams of the same type. Such large-scale changes
1834          * are not a good idea for released branches, though, so we're compromising by just making sure that for the common cases:
1835          * audio and video, audio and T.38, and audio and text, we give the appropriate response to both media streams.
1836          *
1837          * The large-scale changes would be a good idea for implementing during an SDP rewrite.
1838          */
1839         struct offered_media offered_media[4];
1840 };
1841
1842
1843 /*! \brief
1844  * Here we implement the container for dialogs (sip_pvt), defining
1845  * generic wrapper functions to ease the transition from the current
1846  * implementation (a single linked list) to a different container.
1847  * In addition to a reference to the container, we need functions to lock/unlock
1848  * the container and individual items, and functions to add/remove
1849  * references to the individual items.
1850  */
1851 static struct ao2_container *dialogs;
1852
1853 #define sip_pvt_lock(x) ao2_lock(x)
1854 #define sip_pvt_trylock(x) ao2_trylock(x)
1855 #define sip_pvt_unlock(x) ao2_unlock(x)
1856
1857 /*! \brief
1858  * when we create or delete references, make sure to use these
1859  * functions so we keep track of the refcounts.
1860  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1861  */
1862 #ifdef REF_DEBUG
1863 #define dialog_ref(arg1,arg2) dialog_ref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1864 #define dialog_unref(arg1,arg2) dialog_unref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1865
1866 static struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1867 {
1868         if (p)
1869                 _ao2_ref_debug(p, 1, tag, file, line, func);
1870         else
1871                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1872         return p;
1873 }
1874
1875 static struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1876 {
1877         if (p)
1878                 _ao2_ref_debug(p, -1, tag, file, line, func);
1879         return NULL;
1880 }
1881 #else
1882 static struct sip_pvt *dialog_ref(struct sip_pvt *p, char *tag)
1883 {
1884         if (p)
1885                 ao2_ref(p, 1);
1886         else
1887                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1888         return p;
1889 }
1890
1891 static struct sip_pvt *dialog_unref(struct sip_pvt *p, char *tag)
1892 {
1893         if (p)
1894                 ao2_ref(p, -1);
1895         return NULL;
1896 }
1897 #endif
1898
1899 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission
1900  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1901  * Each packet holds a reference to the parent struct sip_pvt.
1902  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1903  * require retransmissions.
1904  */
1905 struct sip_pkt {
1906         struct sip_pkt *next;                   /*!< Next packet in linked list */
1907         int retrans;                            /*!< Retransmission number */
1908         int method;                             /*!< SIP method for this packet */
1909         int seqno;                              /*!< Sequence number */
1910         char is_resp;                           /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1911         char is_fatal;                          /*!< non-zero if there is a fatal error */
1912         int response_code;              /*!< If this is a response, the response code */
1913         struct sip_pvt *owner;                  /*!< Owner AST call */
1914         int retransid;                          /*!< Retransmission ID */
1915         int timer_a;                            /*!< SIP timer A, retransmission timer */
1916         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1917         int packetlen;                          /*!< Length of packet */
1918         struct ast_str *data;
1919 };
1920
1921 /*!
1922  * \brief A peer's mailbox
1923  *
1924  * We could use STRINGFIELDS here, but for only two strings, it seems like
1925  * too much effort ...
1926  */
1927 struct sip_mailbox {
1928         char *mailbox;
1929         char *context;
1930         /*! Associated MWI subscription */
1931         struct ast_event_sub *event_sub;
1932         AST_LIST_ENTRY(sip_mailbox) entry;
1933 };
1934
1935 enum sip_peer_type {
1936         SIP_TYPE_PEER = (1 << 0),
1937         SIP_TYPE_USER = (1 << 1),
1938 };
1939
1940 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host)
1941 */
1942 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail, as will astobj2 hashing of the structure */
1943 struct sip_peer {
1944         char name[80];                                  /*!< the unique name of this object */
1945         AST_DECLARE_STRING_FIELDS(
1946                 AST_STRING_FIELD(secret);               /*!< Password for inbound auth */
1947                 AST_STRING_FIELD(md5secret);            /*!< Password in MD5 */
1948                 AST_STRING_FIELD(remotesecret);         /*!< Remote secret (trunks, remote devices) */
1949                 AST_STRING_FIELD(context);              /*!< Default context for incoming calls */
1950                 AST_STRING_FIELD(subscribecontext);     /*!< Default context for subscriptions */
1951                 AST_STRING_FIELD(username);             /*!< Temporary username until registration */
1952                 AST_STRING_FIELD(accountcode);          /*!< Account code */
1953                 AST_STRING_FIELD(tohost);               /*!< If not dynamic, IP address */
1954                 AST_STRING_FIELD(regexten);             /*!< Extension to register (if regcontext is used) */
1955                 AST_STRING_FIELD(fromuser);             /*!< From: user when calling this peer */
1956                 AST_STRING_FIELD(fromdomain);           /*!< From: domain when calling this peer */
1957                 AST_STRING_FIELD(fullcontact);          /*!< Contact registered with us (not in sip.conf) */
1958                 AST_STRING_FIELD(cid_num);              /*!< Caller ID num */
1959                 AST_STRING_FIELD(cid_name);             /*!< Caller ID name */
1960                 AST_STRING_FIELD(vmexten);              /*!< Dialplan extension for MWI notify message*/
1961                 AST_STRING_FIELD(language);             /*!<  Default language for prompts */
1962                 AST_STRING_FIELD(mohinterpret);         /*!<  Music on Hold class */
1963                 AST_STRING_FIELD(mohsuggest);           /*!<  Music on Hold class */
1964                 AST_STRING_FIELD(parkinglot);           /*!<  Parkinglot */
1965                 AST_STRING_FIELD(useragent);            /*!<  User agent in SIP request (saved from registration) */
1966                 AST_STRING_FIELD(mwi_from);         /*!< Name to place in From header for outgoing NOTIFY requests */
1967                 AST_STRING_FIELD(engine);               /*!<  RTP Engine to use */
1968                 );
1969         struct sip_socket socket;       /*!< Socket used for this peer */
1970         enum sip_transport default_outbound_transport;    /*!< Peer Registration may change the default outbound transport.
1971                                                             If register expires, default should be reset. to this value */
1972         /* things that don't belong in flags */
1973         unsigned short transports:3;    /*!< Transports (enum sip_transport) that are acceptable for this peer */
1974         unsigned short is_realtime:1;   /*!< this is a 'realtime' peer */
1975         unsigned short rt_fromcontact:1;/*!< copy fromcontact from realtime */
1976         unsigned short host_dynamic:1;  /*!< Dynamic Peers register with Asterisk */
1977         unsigned short selfdestruct:1;  /*!< Automatic peers need to destruct themselves */
1978         unsigned short the_mark:1;      /*!< moved out of ASTOBJ into struct proper; That which bears the_mark should be deleted! */
1979         unsigned short autoframing:1;   /*!< Whether to use our local configuration for frame sizes (off)
1980                                          *   or respect the other endpoint's request for frame sizes (on)
1981                                          *   for incoming calls
1982                                          */
1983         struct sip_auth *auth;          /*!< Realm authentication list */
1984         int amaflags;                   /*!< AMA Flags (for billing) */
1985         int callingpres;                /*!< Calling id presentation */
1986         int inUse;                      /*!< Number of calls in use */
1987         int inRinging;                  /*!< Number of calls ringing */
1988         int onHold;                     /*!< Peer has someone on hold */
1989         int call_limit;                 /*!< Limit of concurrent calls */
1990         int busy_level;                 /*!< Level of active channels where we signal busy */
1991         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1992         struct ast_codec_pref prefs;    /*!<  codec prefs */
1993         int lastmsgssent;
1994         unsigned int sipoptions;        /*!<  Supported SIP options */
1995         struct ast_flags flags[2];      /*!<  SIP_ flags */
1996
1997         /*! Mailboxes that this peer cares about */
1998         AST_LIST_HEAD_NOLOCK(, sip_mailbox) mailboxes;
1999
2000         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
2001         int expire;                     /*!<  When to expire this peer registration */
2002         int capability;                 /*!<  Codec capability */
2003         int rtptimeout;                 /*!<  RTP timeout */
2004         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
2005         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
2006         ast_group_t callgroup;          /*!<  Call group */
2007         ast_group_t pickupgroup;        /*!<  Pickup group */
2008         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
2009         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
2010         struct sockaddr_in addr;        /*!<  IP address of peer */
2011         /* Qualification */
2012         struct sip_pvt *call;           /*!<  Call pointer */
2013         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
2014         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
2015         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
2016         int qualifyfreq;                /*!<  Qualification: How often to check for the host to be up */
2017         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
2018         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
2019         struct ast_ha *ha;              /*!<  Access control list */
2020         struct ast_ha *contactha;       /*!<  Restrict what IPs are allowed in the Contact header (for registration) */
2021         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
2022         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
2023         struct sip_st_cfg stimer;       /*!<  SIP Session-Timers */
2024         int timer_t1;                   /*!<  The maximum T1 value for the peer */
2025         int timer_b;                    /*!<  The maximum timer B (transaction timeouts) */
2026         int deprecated_username; /*!< If it's a realtime peer, are they using the deprecated "username" instead of "defaultuser" */
2027
2028         /*XXX Seems like we suddenly have two flags with the same content. Why? To be continued... */
2029         enum sip_peer_type type; /*!< Distinguish between "user" and "peer" types. This is used solely for CLI and manager commands */
2030         unsigned int allowed_methods;
2031 };
2032
2033
2034 /*!
2035  * \brief Registrations with other SIP proxies
2036  *
2037  * Created by sip_register(), the entry is linked in the 'regl' list,
2038  * and never deleted (other than at 'sip reload' or module unload times).
2039  * The entry always has a pending timeout, either waiting for an ACK to
2040  * the REGISTER message (in which case we have to retransmit the request),
2041  * or waiting for the next REGISTER message to be sent (either the initial one,
2042  * or once the previously completed registration one expires).
2043  * The registration can be in one of many states, though at the moment
2044  * the handling is a bit mixed.
2045  */
2046 struct sip_registry {
2047         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
2048         AST_DECLARE_STRING_FIELDS(
2049                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
2050                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
2051                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
2052                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
2053                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
2054                 AST_STRING_FIELD(authdomain);   /*!< Authorization domain */
2055                 AST_STRING_FIELD(regdomain);    /*!< Registration domain */
2056                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
2057                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
2058                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
2059                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
2060                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
2061                 AST_STRING_FIELD(callback);     /*!< Contact extension */
2062                 AST_STRING_FIELD(random);
2063                 AST_STRING_FIELD(peername);     /*!< Peer registering to */
2064         );
2065         enum sip_transport transport;   /*!< Transport for this registration UDP, TCP or TLS */
2066         int portno;                     /*!<  Optional port override */
2067         int expire;                     /*!< Sched ID of expiration */
2068         int expiry;                     /*!< Value to use for the Expires header */
2069         int regattempts;                /*!< Number of attempts (since the last success) */
2070         int timeout;                    /*!< sched id of sip_reg_timeout */
2071         int refresh;                    /*!< How often to refresh */
2072         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
2073         enum sipregistrystate regstate; /*!< Registration state (see above) */
2074         struct timeval regtime;         /*!< Last successful registration time */
2075         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
2076         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
2077         struct ast_dnsmgr_entry *dnsmgr;        /*!<  DNS refresh manager for register */
2078         struct sockaddr_in us;          /*!< Who the server thinks we are */
2079         int noncecount;                 /*!< Nonce-count */
2080         char lastmsg[256];              /*!< Last Message sent/received */
2081 };
2082
2083 /*! \brief Definition of a thread that handles a socket */
2084 struct sip_threadinfo {
2085         int stop;
2086         pthread_t threadid;
2087         struct ast_tcptls_session_instance *tcptls_session;
2088         enum sip_transport type;        /*!< We keep a copy of the type here so we can display it in the connection list */
2089         AST_LIST_ENTRY(sip_threadinfo) list;
2090 };
2091
2092 /*! \brief Definition of an MWI subscription to another server */
2093 struct sip_subscription_mwi {
2094         ASTOBJ_COMPONENTS_FULL(struct sip_subscription_mwi,1,1);
2095         AST_DECLARE_STRING_FIELDS(
2096                 AST_STRING_FIELD(username);     /*!< Who we are sending the subscription as */
2097                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
2098                 AST_STRING_FIELD(hostname);     /*!< Domain or host we subscribe to */
2099                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
2100                 AST_STRING_FIELD(mailbox);      /*!< Mailbox store to put MWI into */
2101                 );
2102         enum sip_transport transport;    /*!< Transport to use */
2103         int portno;                      /*!< Optional port override */
2104         int resub;                       /*!< Sched ID of resubscription */
2105         unsigned int subscribed:1;       /*!< Whether we are currently subscribed or not */
2106         struct sip_pvt *call;            /*!< Outbound subscription dialog */
2107         struct ast_dnsmgr_entry *dnsmgr; /*!< DNS refresh manager for subscription */
2108         struct sockaddr_in us;           /*!< Who the server thinks we are */
2109 };
2110
2111 /* --- Hash tables of various objects --------*/
2112
2113 #ifdef LOW_MEMORY
2114 static int hash_peer_size = 17;
2115 static int hash_dialog_size = 17;
2116 static int hash_user_size = 17;
2117 #else
2118 static int hash_peer_size = 563;        /*!< Size of peer hash table, prime number preferred! */
2119 static int hash_dialog_size = 563;
2120 static int hash_user_size = 563;
2121 #endif
2122
2123 /*! \brief  The thread list of TCP threads */
2124 static AST_LIST_HEAD_STATIC(threadl, sip_threadinfo);
2125
2126 /*! \brief  The peer list: Users, Peers and Friends */
2127 static struct ao2_container *peers;
2128 static struct ao2_container *peers_by_ip;
2129
2130 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
2131 static struct ast_register_list {
2132         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
2133         int recheck;
2134 } regl;
2135
2136 /*! \brief  The MWI subscription list */
2137 static struct ast_subscription_mwi_list {
2138         ASTOBJ_CONTAINER_COMPONENTS(struct sip_subscription_mwi);
2139 } submwil;
2140
2141 /*! \brief
2142  * \note The only member of the peer used here is the name field
2143  */
2144 static int peer_hash_cb(const void *obj, const int flags)
2145 {
2146         const struct sip_peer *peer = obj;
2147
2148         return ast_str_case_hash(peer->name);
2149 }
2150
2151 /*!
2152  * \note The only member of the peer used here is the name field
2153  */
2154 static int peer_cmp_cb(void *obj, void *arg, int flags)
2155 {
2156         struct sip_peer *peer = obj, *peer2 = arg;
2157
2158         return !strcasecmp(peer->name, peer2->name) ? CMP_MATCH | CMP_STOP : 0;
2159 }
2160
2161 /*!
2162  * \note the peer's addr struct provides to fields combined to make a key: the sin_addr.s_addr and sin_port fields.
2163  */
2164 static int peer_iphash_cb(const void *obj, const int flags)
2165 {
2166         const struct sip_peer *peer = obj;
2167         int ret1 = peer->addr.sin_addr.s_addr;
2168         if (ret1 < 0)
2169                 ret1 = -ret1;
2170
2171         if (ast_test_flag(&peer->flags[0], SIP_INSECURE_PORT)) {
2172                 return ret1;
2173         } else {
2174                 return ret1 + peer->addr.sin_port;
2175         }
2176 }
2177
2178 /*!
2179  * \note the peer's addr struct provides to fields combined to make a key: the sin_addr.s_addr and sin_port fields.
2180  */
2181 static int peer_ipcmp_cb(void *obj, void *arg, int flags)
2182 {
2183         struct sip_peer *peer = obj, *peer2 = arg;
2184
2185         if (peer->addr.sin_addr.s_addr != peer2->addr.sin_addr.s_addr)
2186                 return 0;
2187
2188         if (!ast_test_flag(&peer->flags[0], SIP_INSECURE_PORT) && !ast_test_flag(&peer2->flags[0], SIP_INSECURE_PORT)) {
2189                 if (peer->addr.sin_port == peer2->addr.sin_port)
2190                         return CMP_MATCH | CMP_STOP;
2191                 else
2192                         return 0;
2193         }
2194         return CMP_MATCH | CMP_STOP;
2195 }
2196
2197 /*!
2198  * \note The only member of the dialog used here callid string
2199  */
2200 static int dialog_hash_cb(const void *obj, const int flags)
2201 {
2202         const struct sip_pvt *pvt = obj;
2203
2204         return ast_str_case_hash(pvt->callid);
2205 }
2206
2207 /*!
2208  * \note The only member of the dialog used here callid string
2209  */
2210 static int dialog_cmp_cb(void *obj, void *arg, int flags)
2211 {
2212         struct sip_pvt *pvt = obj, *pvt2 = arg;
2213
2214         return !strcasecmp(pvt->callid, pvt2->callid) ? CMP_MATCH | CMP_STOP : 0;
2215 }
2216
2217 static int temp_pvt_init(void *);
2218 static void temp_pvt_cleanup(void *);
2219
2220 /*! \brief A per-thread temporary pvt structure */
2221 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
2222
2223 #ifdef LOW_MEMORY
2224 static void ts_ast_rtp_destroy(void *);
2225
2226 AST_THREADSTORAGE_CUSTOM(ts_audio_rtp, NULL, ts_ast_rtp_destroy);
2227 AST_THREADSTORAGE_CUSTOM(ts_video_rtp, NULL, ts_ast_rtp_destroy);
2228 AST_THREADSTORAGE_CUSTOM(ts_text_rtp, NULL, ts_ast_rtp_destroy);
2229 #endif
2230
2231 /*! \brief Authentication list for realm authentication
2232  * \todo Move the sip_auth list to AST_LIST */
2233 static struct sip_auth *authl = NULL;
2234
2235
2236 /* --- Sockets and networking --------------*/
2237
2238 /*! \brief Main socket for UDP SIP communication.
2239  *
2240  * sipsock is shared between the SIP manager thread (which handles reload
2241  * requests), the udp io handler (sipsock_read()) and the user routines that
2242  * issue udp writes (using __sip_xmit()).
2243  * The socket is -1 only when opening fails (this is a permanent condition),
2244  * or when we are handling a reload() that changes its address (this is
2245  * a transient situation during which we might have a harmless race, see
2246  * below). Because the conditions for the race to be possible are extremely
2247  * rare, we don't want to pay the cost of locking on every I/O.
2248  * Rather, we remember that when the race may occur, communication is
2249  * bound to fail anyways, so we just live with this event and let
2250  * the protocol handle this above us.
2251  */
2252 static int sipsock  = -1;
2253
2254 static struct sockaddr_in bindaddr;     /*!< UDP: The address we bind to */
2255
2256 /*! \brief our (internal) default address/port to put in SIP/SDP messages
2257  *  internip is initialized picking a suitable address from one of the
2258  * interfaces, and the same port number we bind to. It is used as the
2259  * default address/port in SIP messages, and as the default address
2260  * (but not port) in SDP messages.
2261  */
2262 static struct sockaddr_in internip;
2263
2264 /*! \brief our external IP address/port for SIP sessions.
2265  * externip.sin_addr is only set when we know we might be behind
2266  * a NAT, and this is done using a variety of (mutually exclusive)
2267  * ways from the config file:
2268  *
2269  * + with "externip = host[:port]" we specify the address/port explicitly.
2270  *   The address is looked up only once when (re)loading the config file;
2271  *
2272  * + with "externhost = host[:port]" we do a similar thing, but the
2273  *   hostname is stored in externhost, and the hostname->IP mapping
2274  *   is refreshed every 'externrefresh' seconds;
2275  *
2276  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
2277  *   to the specified server, and store the result in externip.
2278  *
2279  * Other variables (externhost, externexpire, externrefresh) are used
2280  * to support the above functions.
2281  */
2282 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
2283
2284 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
2285 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
2286 static int externrefresh = 10;
2287 static struct sockaddr_in stunaddr;             /*!< stun server address */
2288
2289 /*! \brief  List of local networks
2290  * We store "localnet" addresses from the config file into an access list,
2291  * marked as 'DENY', so the call to ast_apply_ha() will return
2292  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
2293  * (i.e. presumably public) addresses.
2294  */
2295 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
2296
2297 static int ourport_tcp;                         /*!< The port used for TCP connections */
2298 static int ourport_tls;                         /*!< The port used for TCP/TLS connections */
2299 static struct sockaddr_in debugaddr;
2300
2301 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
2302
2303 /*! some list management macros. */
2304
2305 #define UNLINK(element, head, prev) do {        \
2306         if (prev)                               \
2307                 (prev)->next = (element)->next; \
2308         else                                    \
2309                 (head) = (element)->next;       \
2310         } while (0)
2311
2312 enum t38_action_flag {
2313         SDP_T38_NONE = 0, /*!< Do not modify T38 information at all */
2314         SDP_T38_INITIATE, /*!< Remote side has requested T38 with us */
2315         SDP_T38_ACCEPT,   /*!< Remote side accepted our T38 request */
2316 };
2317
2318 /*---------------------------- Forward declarations of functions in chan_sip.c */
2319 /* Note: This is added to help splitting up chan_sip.c into several files
2320         in coming releases. */
2321
2322 /*--- PBX interface functions */
2323 static struct ast_channel *sip_request_call(const char *type, int format, const struct ast_channel *requestor, void *data, int *cause);
2324 static int sip_devicestate(void *data);
2325 static int sip_sendtext(struct ast_channel *ast, const char *text);
2326 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
2327 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
2328 static int sip_hangup(struct ast_channel *ast);
2329 static int sip_answer(struct ast_channel *ast);
2330 static struct ast_frame *sip_read(struct ast_channel *ast);
2331 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
2332 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
2333 static int sip_transfer(struct ast_channel *ast, const char *dest);
2334 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
2335 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
2336 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
2337 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
2338 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
2339 static const char *sip_get_callid(struct ast_channel *chan);
2340
2341 static int handle_request_do(struct sip_request *req, struct sockaddr_in *sin);
2342 static int sip_standard_port(enum sip_transport type, int port);
2343 static int sip_prepare_socket(struct sip_pvt *p);
2344 static int sip_parse_host(char *line, int lineno, char **hostname, int *portnum, enum sip_transport *transport);
2345
2346 /*--- Transmitting responses and requests */
2347 static int sipsock_read(int *id, int fd, short events, void *ignore);
2348 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len);
2349 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod);
2350 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
2351 static int retrans_pkt(const void *data);
2352 static int transmit_response_using_temp(ast_string_field callid, struct sockaddr_in *sin, int useglobal_nat, const int intended_method, const struct sip_request *req, const char *msg);
2353 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2354 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2355 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2356 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);
2357 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
2358 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);
2359 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
2360 static void transmit_fake_auth_response(struct sip_pvt *p, int sipmethod, struct sip_request *req, enum xmittype reliable);
2361 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
2362 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
2363 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
2364 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
2365 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
2366 static int transmit_info_with_vidupdate(struct sip_pvt *p);
2367 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
2368 static int transmit_refer(struct sip_pvt *p, const char *dest);
2369 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
2370 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
2371 static int transmit_notify_custom(struct sip_pvt *p, struct ast_variable *vars);
2372 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
2373 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
2374 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
2375 static void copy_request(struct sip_request *dst, const struct sip_request *src);
2376 static void receive_message(struct sip_pvt *p, struct sip_request *req);
2377 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
2378 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
2379
2380 /*--- Dialog management */
2381 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
2382                                  int useglobal_nat, const int intended_method, struct sip_request *req);
2383 static int __sip_autodestruct(const void *data);
2384 static void sip_scheddestroy(struct sip_pvt *p, int ms);
2385 static int sip_cancel_destroy(struct sip_pvt *p);
2386 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
2387 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist);
2388 static void *registry_unref(struct sip_registry *reg, char *tag);
2389 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
2390 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
2391 static void __sip_pretend_ack(struct sip_pvt *p);
2392 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
2393 static int auto_congest(const void *arg);
2394 static int update_call_counter(struct sip_pvt *fup, int event);
2395 static int hangup_sip2cause(int cause);
2396 static const char *hangup_cause2sip(int cause);
2397 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
2398 static void free_old_route(struct sip_route *route);
2399 static void list_route(struct sip_route *route);
2400 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
2401 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
2402                                               struct sip_request *req, const char *uri);
2403 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
2404 static void check_pendings(struct sip_pvt *p);
2405 static void *sip_park_thread(void *stuff);
2406 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
2407 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
2408
2409 /*--- Codec handling / SDP */
2410 static void try_suggested_sip_codec(struct sip_pvt *p);
2411 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
2412 static const char *get_sdp(struct sip_request *req, const char *name);
2413 static int find_sdp(struct sip_request *req);
2414 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
2415 static void add_codec_to_sdp(const struct sip_pvt *p, int codec,
2416                              struct ast_str **m_buf, struct ast_str **a_buf,
2417                              int debug, int *min_packet_size);
2418 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
2419                                 struct ast_str **m_buf, struct ast_str **a_buf,
2420                                 int debug);
2421 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
2422 static void do_setnat(struct sip_pvt *p);
2423 static void stop_media_flows(struct sip_pvt *p);
2424
2425 /*--- Authentication stuff */
2426 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
2427 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
2428 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
2429                                          const char *secret, const char *md5secret, int sipmethod,
2430                                          const char *uri, enum xmittype reliable, int ignore);
2431 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
2432                                               int sipmethod, const char *uri, enum xmittype reliable,
2433                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
2434 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct sockaddr_in *sin);
2435
2436 /*--- Domain handling */
2437 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
2438 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
2439 static void clear_sip_domains(void);
2440
2441 /*--- SIP realm authentication */
2442 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
2443 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
2444 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
2445
2446 /*--- Misc functions */
2447 static void check_rtp_timeout(struct sip_pvt *dialog, time_t t);
2448 static int sip_do_reload(enum channelreloadreason reason);
2449 static int reload_config(enum channelreloadreason reason);
2450 static int expire_register(const void *data);
2451 static void *do_monitor(void *data);
2452 static int restart_monitor(void);
2453 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
2454 static struct ast_variable *copy_vars(struct ast_variable *src);
2455 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
2456 static int sip_refer_allocate(struct sip_pvt *p);
2457 static void ast_quiet_chan(struct ast_channel *chan);
2458 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
2459 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
2460
2461 /*!
2462  * \brief generic function for determining if a correct transport is being
2463  * used to contact a peer
2464  *
2465  * this is done as a macro so that the "tmpl" var can be passed either a
2466  * sip_request or a sip_peer
2467  */
2468 #define check_request_transport(peer, tmpl) ({ \
2469         int ret = 0; \
2470         if (peer->socket.type == tmpl->socket.type) \
2471                 ; \
2472         else if (!(peer->transports & tmpl->socket.type)) {\
2473                 ast_log(LOG_ERROR, \
2474                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
2475                         get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
2476                         ); \
2477                 ret = 1; \
2478         } else if (peer->socket.type & SIP_TRANSPORT_TLS) { \
2479                 ast_log(LOG_WARNING, \
2480                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
2481                         peer->name, get_transport(tmpl->socket.type) \
2482                 ); \
2483         } else { \
2484                 ast_debug(1, \
2485                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
2486                         peer->name, get_transport(tmpl->socket.type), get_transport(peer->socket.type) \
2487                 ); \
2488         }\
2489         (ret); \
2490 })
2491
2492
2493 /*--- Device monitoring and Device/extension state/event handling */
2494 static int cb_extensionstate(char *context, char* exten, int state, void *data);
2495 static int sip_devicestate(void *data);
2496 static int sip_poke_noanswer(const void *data);
2497 static int sip_poke_peer(struct sip_peer *peer, int force);
2498 static void sip_poke_all_peers(void);
2499 static void sip_peer_hold(struct sip_pvt *p, int hold);
2500 static void mwi_event_cb(const struct ast_event *, void *);
2501
2502 /*--- Applications, functions, CLI and manager command helpers */
2503 static const char *sip_nat_mode(const struct sip_pvt *p);
2504 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2505 static char *transfermode2str(enum transfermodes mode) attribute_const;
2506 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
2507 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2508 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2509 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2510 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2511 static void  print_group(int fd, ast_group_t group, int crlf);
2512 static const char *dtmfmode2str(int mode) attribute_const;
2513 static int str2dtmfmode(const char *str) attribute_unused;
2514 static const char *insecure2str(int mode) attribute_const;
2515 static void cleanup_stale_contexts(char *new, char *old);
2516 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
2517 static const char *domain_mode_to_text(const enum domain_mode mode);
2518 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2519 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2520 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2521 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2522 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2523 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2524 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2525 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2526 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2527 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
2528 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
2529 static char *complete_sip_peer(const char *word, int state, int flags2);
2530 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
2531 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
2532 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
2533 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
2534 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
2535 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2536 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2537 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2538 static char *sip_do_debug_ip(int fd, const char *arg);
2539 static char *sip_do_debug_peer(int fd, const char *arg);
2540 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2541 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2542 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2543 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
2544 static int sip_addheader(struct ast_channel *chan, const char *data);
2545 static int sip_do_reload(enum channelreloadreason reason);
2546 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2547 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
2548
2549 /*--- Debugging
2550         Functions for enabling debug per IP or fully, or enabling history logging for
2551         a SIP dialog
2552 */
2553 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
2554 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
2555 static inline int sip_debug_test_pvt(struct sip_pvt *p);
2556
2557
2558 /*! \brief Append to SIP dialog history
2559         \return Always returns 0 */
2560 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
2561 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
2562 static void sip_dump_history(struct sip_pvt *dialog);
2563
2564 /*--- Device object handling */
2565 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
2566 static int update_call_counter(struct sip_pvt *fup, int event);
2567 static void sip_destroy_peer(struct sip_peer *peer);
2568 static void sip_destroy_peer_fn(void *peer);
2569 static void set_peer_defaults(struct sip_peer *peer);
2570 static struct sip_peer *temp_peer(const char *name);
2571 static void register_peer_exten(struct sip_peer *peer, int onoff);
2572 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime, int forcenamematch, int devstate_only);
2573 static int sip_poke_peer_s(const void *data);
2574 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
2575 static void reg_source_db(struct sip_peer *peer);
2576 static void destroy_association(struct sip_peer *peer);
2577 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
2578 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
2579 static void set_socket_transport(struct sip_socket *socket, int transport);
2580
2581 /* Realtime device support */
2582 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, const char *useragent, int expirey, int deprecated_username, int lastms);
2583 static void update_peer(struct sip_peer *p, int expire);
2584 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
2585 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
2586 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin, int devstate_only);
2587 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2588
2589 /*--- Internal UA client handling (outbound registrations) */
2590 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us, struct sip_pvt *p);
2591 static void sip_registry_destroy(struct sip_registry *reg);
2592 static int sip_register(const char *value, int lineno);
2593 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
2594 static int sip_reregister(const void *data);
2595 static int __sip_do_register(struct sip_registry *r);
2596 static int sip_reg_timeout(const void *data);
2597 static void sip_send_all_registers(void);
2598 static int sip_reinvite_retry(const void *data);
2599
2600 /*--- Parsing SIP requests and responses */
2601 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
2602 static int determine_firstline_parts(struct sip_request *req);
2603 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
2604 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
2605 static int find_sip_method(const char *msg);
2606 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
2607 static unsigned int parse_allowed_methods(struct sip_request *req);
2608 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
2609 static int parse_request(struct sip_request *req);
2610 static const char *get_header(const struct sip_request *req, const char *name);
2611 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
2612 static int method_match(enum sipmethod id, const char *name);
2613 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
2614 static char *get_in_brackets(char *tmp);
2615 static const char *find_alias(const char *name, const char *_default);
2616 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
2617 static int lws2sws(char *msgbuf, int len);
2618 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
2619 static char *remove_uri_parameters(char *uri);
2620 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
2621 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
2622 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
2623 static int set_address_from_contact(struct sip_pvt *pvt);
2624 static void check_via(struct sip_pvt *p, struct sip_request *req);
2625 static char *get_calleridname(const char *input, char *output, size_t outputsize);
2626 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
2627 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason);
2628 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
2629 static int get_msg_text(char *buf, int len, struct sip_request *req, int addnewline);
2630 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
2631 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
2632 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
2633 static void change_redirecting_information(struct sip_pvt *p, struct sip_request *req, struct ast_party_redirecting *redirecting, int set_call_forward);
2634
2635 /*-- TCP connection handling ---*/
2636 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session);
2637 static void *sip_tcp_worker_fn(void *);
2638
2639 /*--- Constructing requests and responses */
2640 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
2641 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
2642 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
2643 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
2644 static int init_resp(struct sip_request *resp, const char *msg);
2645 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
2646 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
2647 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
2648 static void build_via(struct sip_pvt *p);
2649 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
2650 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct sockaddr_in *sin, int newdialog);
2651 static char *generate_random_string(char *buf, size_t size);
2652 static void build_callid_pvt(struct sip_pvt *pvt);
2653 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
2654 static void make_our_tag(char *tagbuf, size_t len);
2655 static int add_header(struct sip_request *req, const char *var, const char *value);
2656 static int add_header_contentLength(struct sip_request *req, int len);
2657 static int add_line(struct sip_request *req, const char *line);
2658 static int add_text(struct sip_request *req, const char *text);
2659 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
2660 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
2661 static int add_vidupdate(struct sip_request *req);
2662 static void add_route(struct sip_request *req, struct sip_route *route);
2663 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
2664 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
2665 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
2666 static void set_destination(struct sip_pvt *p, char *uri);
2667 static void append_date(struct sip_request *req);
2668 static void build_contact(struct sip_pvt *p);
2669
2670 /*------Request handling functions */
2671 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
2672 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
2673 static int handle_request_invite(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *recount, const char *e, int *nounlock);
2674 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
2675 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
2676 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, const char *e);
2677 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
2678 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
2679 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
2680 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
2681 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
2682 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin);
2683 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
2684 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
2685
2686 /*------Response handling functions */
2687 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2688 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2689 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2690 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2691 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2692 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2693
2694 /*------ T38 Support --------- */
2695 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
2696 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
2697 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
2698 static void change_t38_state(struct sip_pvt *p, int state);
2699
2700 /*------ Session-Timers functions --------- */
2701 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
2702 static int  proc_session_timer(const void *vp);
2703 static void stop_session_timer(struct sip_pvt *p);
2704 static void start_session_timer(struct sip_pvt *p);
2705 static void restart_session_timer(struct sip_pvt *p);
2706 static const char *strefresher2str(enum st_refresher r);
2707 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
2708 static int parse_minse(const char *p_hdrval, int *const p_interval);
2709 static int st_get_se(struct sip_pvt *, int max);
2710 static enum st_refresher st_get_refresher(struct sip_pvt *);
2711 static enum st_mode st_get_mode(struct sip_pvt *);
2712 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
2713
2714 /*------- RTP Glue functions -------- */
2715 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, int codecs, int nat_active);
2716
2717 /*!--- SIP MWI Subscription support */
2718 static int sip_subscribe_mwi(const char *value, int lineno);
2719 static void sip_subscribe_mwi_destroy(struct sip_subscription_mwi *mwi);
2720 static void sip_send_all_mwi_subscriptions(void);
2721 static int sip_subscribe_mwi_do(const void *data);
2722 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
2723
2724 /*! \brief Definition of this channel for PBX channel registration */
2725 static const struct ast_channel_tech sip_tech = {
2726         .type = "SIP",
2727         .description = "Session Initiation Protocol (SIP)",
2728         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
2729         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
2730         .requester = sip_request_call,                  /* called with chan unlocked */
2731         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
2732         .call = sip_call,                       /* called with chan locked */
2733         .send_html = sip_sendhtml,
2734         .hangup = sip_hangup,                   /* called with chan locked */
2735         .answer = sip_answer,                   /* called with chan locked */
2736         .read = sip_read,                       /* called with chan locked */
2737         .write = sip_write,                     /* called with chan locked */
2738         .write_video = sip_write,               /* called with chan locked */
2739         .write_text = sip_write,
2740         .indicate = sip_indicate,               /* called with chan locked */
2741         .transfer = sip_transfer,               /* called with chan locked */
2742         .fixup = sip_fixup,                     /* called with chan locked */
2743         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
2744         .send_digit_end = sip_senddigit_end,
2745         .bridge = ast_rtp_instance_bridge,                      /* XXX chan unlocked ? */
2746         .early_bridge = ast_rtp_instance_early_bridge,
2747         .send_text = sip_sendtext,              /* called with chan locked */
2748         .func_channel_read = acf_channel_read,
2749         .setoption = sip_setoption,
2750         .queryoption = sip_queryoption,
2751         .get_pvt_uniqueid = sip_get_callid,
2752 };
2753
2754 /*! \brief This version of the sip channel tech has no send_digit_begin
2755  * callback so that the core knows that the channel does not want
2756  * DTMF BEGIN frames.
2757  * The struct is initialized just before registering the channel driver,
2758  * and is for use with channels using SIP INFO DTMF.
2759  */
2760 static struct ast_channel_tech sip_tech_info;
2761
2762
2763 /*! \brief Working TLS connection configuration */
2764 static struct ast_tls_config sip_tls_cfg;
2765
2766 /*! \brief Default TLS connection configuration */
2767 static struct ast_tls_config default_tls_cfg;
2768
2769 /*! \brief The TCP server definition */
2770 static struct ast_tcptls_session_args sip_tcp_desc = {
2771         .accept_fd = -1,
2772         .master = AST_PTHREADT_NULL,
2773         .tls_cfg = NULL,
2774         .poll_timeout = -1,
2775         .name = "SIP TCP server",
2776         .accept_fn = ast_tcptls_server_root,
2777         .worker_fn = sip_tcp_worker_fn,
2778 };
2779
2780 /*! \brief The TCP/TLS server definition */
2781 static struct ast_tcptls_session_args sip_tls_desc = {
2782         .accept_fd = -1,
2783         .master = AST_PTHREADT_NULL,
2784         .tls_cfg = &sip_tls_cfg,
2785         .poll_timeout = -1,
2786         .name = "SIP TLS server",
2787         .accept_fn = ast_tcptls_server_root,
2788         .worker_fn = sip_tcp_worker_fn,
2789 };
2790
2791 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
2792 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
2793
2794 /*! \brief map from an integer value to a string.
2795  * If no match is found, return errorstring
2796  */
2797 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2798 {
2799         const struct _map_x_s *cur;
2800
2801         for (cur = table; cur->s; cur++)
2802                 if (cur->x == x)
2803                         return cur->s;
2804         return errorstring;
2805 }
2806
2807 /*! \brief map from a string to an integer value, case insensitive.
2808  * If no match is found, return errorvalue.
2809  */
2810 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2811 {
2812         const struct _map_x_s *cur;
2813
2814         for (cur = table; cur->s; cur++)
2815                 if (!strcasecmp(cur->s, s))
2816                         return cur->x;
2817         return errorvalue;
2818 }
2819
2820 /*!
2821  * duplicate a list of channel variables, \return the copy.
2822  */
2823 static struct ast_variable *copy_vars(struct ast_variable *src)
2824 {
2825         struct ast_variable *res = NULL, *tmp, *v = NULL;
2826
2827         for (v = src ; v ; v = v->next) {
2828                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
2829                         tmp->next = res;
2830                         res = tmp;
2831                 }
2832         }
2833         return res;
2834 }
2835
2836 /*! \brief SIP TCP connection handler */
2837 static void *sip_tcp_worker_fn(void *data)
2838 {
2839         struct ast_tcptls_session_instance *tcptls_session = data;
2840
2841         return _sip_tcp_helper_thread(NULL, tcptls_session);
2842 }
2843
2844 /*! \brief SIP TCP thread management function
2845         This function reads from the socket, parses the packet into a request
2846 */
2847 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session)
2848 {
2849         int res, cl;
2850         struct sip_request req = { 0, } , reqcpy = { 0, };
2851         struct sip_threadinfo *me;
2852         char buf[1024] = "";
2853
2854         me = ast_calloc(1, sizeof(*me));
2855
2856         if (!me)
2857                 goto cleanup2;
2858
2859         me->threadid = pthread_self();
2860         me->tcptls_session = tcptls_session;
2861         if (tcptls_session->ssl)
2862                 me->type = SIP_TRANSPORT_TLS;
2863         else
2864                 me->type = SIP_TRANSPORT_TCP;
2865
2866         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2867
2868         AST_LIST_LOCK(&threadl);
2869         AST_LIST_INSERT_TAIL(&threadl, me, list);
2870         AST_LIST_UNLOCK(&threadl);
2871
2872         if (!(req.data = ast_str_create(SIP_MIN_PACKET)))
2873                 goto cleanup;
2874         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET)))
2875                 goto cleanup;
2876
2877         for (;;) {
2878                 struct ast_str *str_save;
2879
2880                 str_save = req.data;
2881                 memset(&req, 0, sizeof(req));
2882                 req.data = str_save;
2883                 ast_str_reset(req.data);
2884
2885                 str_save = reqcpy.data;
2886                 memset(&reqcpy, 0, sizeof(reqcpy));
2887                 reqcpy.data = str_save;
2888                 ast_str_reset(reqcpy.data);
2889
2890                 memset(buf, 0, sizeof(buf));
2891
2892                 if (tcptls_session->ssl) {
2893                         set_socket_transport(&req.socket, SIP_TRANSPORT_TLS);
2894                         req.socket.port = htons(ourport_tls);
2895                 } else {
2896                         set_socket_transport(&req.socket, SIP_TRANSPORT_TCP);
2897                         req.socket.port = htons(ourport_tcp);
2898                 }
2899                 req.socket.fd = tcptls_session->fd;
2900                 res = ast_wait_for_input(tcptls_session->fd, -1);
2901                 if (res < 0) {
2902                         ast_debug(2, "SIP %s server :: ast_wait_for_input returned %d\n", tcptls_session->ssl ? "SSL": "TCP", res);
2903                         goto cleanup;
2904                 }
2905
2906                 /* Read in headers one line at a time */
2907                 while (req.len < 4 || strncmp(REQ_OFFSET_TO_STR(&req, len - 4), "\r\n\r\n", 4)) {
2908                         ast_mutex_lock(&tcptls_session->lock);
2909                         if (!fgets(buf, sizeof(buf), tcptls_session->f)) {
2910                                 ast_mutex_unlock(&tcptls_session->lock);
2911                                 goto cleanup;
2912                         }
2913                         ast_mutex_unlock(&tcptls_session->lock);
2914                         if (me->stop)
2915                                  goto cleanup;
2916                         ast_str_append(&req.data, 0, "%s", buf);
2917                         req.len = req.data->used;
2918                 }
2919                 copy_request(&reqcpy, &req);
2920                 parse_request(&reqcpy);
2921                 /* In order to know how much to read, we need the content-length header */
2922                 if (sscanf(get_header(&reqcpy, "Content-Length"), "%d", &cl)) {
2923                         while (cl > 0) {
2924                                 ast_mutex_lock(&tcptls_session->lock);
2925                                 if (!fread(buf, (cl < sizeof(buf)) ? cl : sizeof(buf), 1, tcptls_session->f)) {
2926                                         ast_mutex_unlock(&tcptls_session->lock);
2927                                         goto cleanup;
2928                                 }
2929                                 ast_mutex_unlock(&tcptls_session->lock);
2930                                 if (me->stop)
2931                                         goto cleanup;
2932                                 cl -= strlen(buf);
2933                                 ast_str_append(&req.data, 0, "%s", buf);
2934                                 req.len = req.data->used;
2935                         }
2936                 }
2937                 /*! \todo XXX If there's no Content-Length or if the content-length and what
2938                                 we receive is not the same - we should generate an error */
2939
2940                 req.socket.tcptls_session = tcptls_session;
2941                 handle_request_do(&req, &tcptls_session->remote_address);
2942         }
2943
2944 cleanup:
2945         AST_LIST_LOCK(&threadl);
2946         AST_LIST_REMOVE(&threadl, me, list);
2947         AST_LIST_UNLOCK(&threadl);
2948         ast_free(me);
2949 cleanup2:
2950         fclose(tcptls_session->f);
2951         tcptls_session->f = NULL;
2952         tcptls_session->fd = -1;
2953         if (reqcpy.data) {
2954                 ast_free(reqcpy.data);
2955         }
2956
2957         if (req.data) {
2958                 ast_free(req.data);
2959                 req.data = NULL;
2960         }
2961
2962         ast_debug(2, "Shutting down thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2963
2964
2965         ao2_ref(tcptls_session, -1);
2966         tcptls_session = NULL;
2967
2968         return NULL;
2969 }
2970
2971
2972 /*!
2973  * helper functions to unreference various types of objects.
2974  * By handling them this way, we don't have to declare the
2975  * destructor on each call, which removes the chance of errors.
2976  */
2977 static void *unref_peer(struct sip_peer *peer, char *tag)
2978 {
2979         ao2_t_ref(peer, -1, tag);
2980         return NULL;
2981 }
2982
2983 static struct sip_peer *ref_peer(struct sip_peer *peer, char *tag)
2984 {
2985         ao2_t_ref(peer, 1, tag);
2986         return peer;
2987 }
2988
2989 /*! \brief maintain proper refcounts for a sip_pvt's outboundproxy
2990  *
2991  * This function sets pvt's outboundproxy pointer to the one referenced
2992  * by the proxy parameter. Because proxy may be a refcounted object, and
2993  * because pvt's old outboundproxy may also be a refcounted object, we need
2994  * to maintain the proper refcounts.
2995  *
2996  * \param pvt The sip_pvt for which we wish to set the outboundproxy
2997  * \param proxy The sip_proxy which we will point pvt towards.
2998  * \return Returns void
2999  */
3000 static void ref_proxy(struct sip_pvt *pvt, struct sip_proxy *proxy)
3001 {
3002         struct sip_proxy *old_obproxy = pvt->outboundproxy;
3003         /* The sip_cfg.outboundproxy is statically allocated, and so
3004          * we don't ever need to adjust refcounts for it
3005          */
3006         if (proxy && proxy != &sip_cfg.outboundproxy) {
3007                 ao2_ref(proxy, +1);
3008         }
3009         pvt->outboundproxy = proxy;
3010         if (old_obproxy && old_obproxy != &sip_cfg.outboundproxy) {
3011                 ao2_ref(old_obproxy, -1);
3012         }
3013 }
3014
3015 /*!
3016  * \brief Unlink a dialog from the dialogs container, as well as any other places
3017  * that it may be currently stored.
3018  *
3019  * \note A reference to the dialog must be held before calling this function, and this
3020  * function does not release that reference.
3021  */
3022 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist)
3023 {
3024         struct sip_pkt *cp;
3025
3026         dialog_ref(dialog, "Let's bump the count in the unlink so it doesn't accidentally become dead before we are done");
3027
3028         ao2_t_unlink(dialogs, dialog, "unlinking dialog via ao2_unlink");
3029
3030         /* Unlink us from the owner (channel) if we have one */
3031         if (dialog->owner) {
3032                 if (lockowner)
3033                         ast_channel_lock(dialog->owner);
3034                 ast_debug(1, "Detaching from channel %s\n", dialog->owner->name);
3035                 dialog->owner->tech_pvt = dialog_unref(dialog->owner->tech_pvt, "resetting channel dialog ptr in unlink_all");
3036                 if (lockowner)
3037                         ast_channel_unlock(dialog->owner);
3038         }
3039         if (dialog->registry) {
3040                 if (dialog->registry->call == dialog)
3041                         dialog->registry->call = dialog_unref(dialog->registry->call, "nulling out the registry's call dialog field in unlink_all");
3042                 dialog->registry = registry_unref(dialog->registry, "delete dialog->registry");
3043         }
3044         if (dialog->stateid > -1) {
3045                 ast_extension_state_del(dialog->stateid, NULL);
3046                 dialog_unref(dialog, "removing extension_state, should unref the associated dialog ptr that was stored there.");
3047                 dialog->stateid = -1; /* shouldn't we 'zero' this out? */
3048         }
3049         /* Remove link from peer to subscription of MWI */
3050         if (dialog->relatedpeer && dialog->relatedpeer->mwipvt == dialog)
3051                 dialog->relatedpeer->mwipvt = dialog_unref(dialog->relatedpeer->mwipvt, "delete ->relatedpeer->mwipvt");
3052         if (dialog->relatedpeer && dialog->relatedpeer->call == dialog)
3053                 dialog->relatedpeer->call = dialog_unref(dialog->relatedpeer->call, "unset the relatedpeer->call field in tandem with relatedpeer field itself");
3054
3055         /* remove all current packets in this dialog */
3056         while((cp = dialog->packets)) {
3057                 dialog->packets = dialog->packets->next;
3058                 AST_SCHED_DEL(sched, cp->retransid);
3059                 dialog_unref(cp->owner, "remove all current packets in this dialog, and the pointer to the dialog too as part of __sip_destroy");
3060                 if (cp->data) {
3061                         ast_free(cp->data);
3062                 }
3063                 ast_free(cp);
3064         }
3065
3066         AST_SCHED_DEL_UNREF(sched, dialog->waitid, dialog_unref(dialog, "when you delete the waitid sched, you should dec the refcount for the stored dialog ptr"));
3067
3068         AST_SCHED_DEL_UNREF(sched, dialog->initid, dialog_unref(dialog, "when you delete the initid sched, you should dec the refcount for the stored dialog ptr"));
3069
3070         if (dialog->autokillid > -1)
3071                 AST_SCHED_DEL_UNREF(sched, dialog->autokillid, dialog_unref(dialog, "when you delete the autokillid sched, you should dec the refcount for the stored dialog ptr"));
3072
3073         if (dialog->request_queue_sched_id > -1) {
3074                 AST_SCHED_DEL_UNREF(sched, dialog->request_queue_sched_id, dialog_unref(dialog, "when you delete the request_queue_sched_id sched, you should dec the refcount for the stored dialog ptr"));
3075         }
3076
3077         if (dialog->t38id > -1) {
3078                 AST_SCHED_DEL_UNREF(sched, dialog->t38id, dialog_unref(dialog, "when you delete the t38id sched, you should dec the refcount for the stored dialog ptr"));
3079         }
3080
3081         dialog_unref(dialog, "Let's unbump the count in the unlink so the poor pvt can disappear if it is time");
3082         return NULL;
3083 }
3084
3085 static void *registry_unref(struct sip_registry *reg, char *tag)
3086 {
3087         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
3088         ASTOBJ_UNREF(reg, sip_registry_destroy);
3089         return NULL;
3090 }
3091
3092 /*! \brief Add object reference to SIP registry */
3093 static struct sip_registry *registry_addref(struct sip_registry *reg, char *tag)
3094 {
3095         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
3096         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
3097 }
3098
3099 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
3100 static struct ast_udptl_protocol sip_udptl = {
3101         type: "SIP",
3102         get_udptl_info: sip_get_udptl_peer,
3103         set_udptl_peer: sip_set_udptl_peer,
3104 };
3105
3106 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
3107         __attribute__((format(printf, 2, 3)));
3108
3109
3110 /*! \brief Convert transfer status to string */
3111 static const char *referstatus2str(enum referstatus rstatus)
3112 {
3113         return map_x_s(referstatusstrings, rstatus, "");
3114 }
3115
3116 static inline void pvt_set_needdestroy(struct sip_pvt *pvt, const char *reason)
3117 {
3118         append_history(pvt, "NeedDestroy", "Setting needdestroy because %s", reason);
3119         pvt->needdestroy = 1;
3120 }
3121
3122 /*! \brief Initialize the initital request packet in the pvt structure.
3123         This packet is used for creating replies and future requests in
3124         a dialog */
3125 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
3126 {
3127         if (p->initreq.headers)
3128                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
3129         else
3130                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
3131         /* Use this as the basis */
3132         copy_request(&p->initreq, req);
3133         parse_request(&p->initreq);
3134         if (req->debug)
3135                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
3136 }
3137
3138 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
3139 static void sip_alreadygone(struct sip_pvt *dialog)
3140 {
3141         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
3142         dialog->alreadygone = 1;
3143 }
3144
3145 /*! Resolve DNS srv name or host name in a sip_proxy structure */
3146 static int proxy_update(struct sip_proxy *proxy)
3147 {
3148         /* if it's actually an IP address and not a name,
3149            there's no need for a managed lookup */
3150         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
3151                 /* Ok, not an IP address, then let's check if it's a domain or host */
3152                 /* XXX Todo - if we have proxy port, don't do SRV */
3153                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, sip_cfg.srvlookup ? "_sip._udp" : NULL) < 0) {
3154                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
3155                         return FALSE;
3156                 }
3157         }
3158         proxy->last_dnsupdate = time(NULL);
3159         return TRUE;
3160 }
3161
3162 /*! \brief Allocate and initialize sip proxy */
3163 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
3164 {
3165         struct sip_proxy *proxy;
3166
3167         if (ast_strlen_zero(name)) {
3168                 return NULL;
3169         }
3170
3171         proxy = ao2_alloc(sizeof(*proxy), NULL);
3172         if (!proxy)
3173                 return NULL;
3174         proxy->force = force;
3175         ast_copy_string(proxy->name, name, sizeof(proxy->name));
3176         proxy->ip.sin_port = htons((!ast_strlen_zero(port) ? atoi(port) : STANDARD_SIP_PORT));
3177         proxy_update(proxy);
3178         return proxy;
3179 }
3180
3181 /*! \brief Get default outbound proxy or global proxy */
3182 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
3183 {
3184         if (peer && peer->outboundproxy) {
3185                 if (sipdebug)
3186                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
3187                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
3188                 return peer->outboundproxy;
3189         }
3190         if (sip_cfg.outboundproxy.name[0]) {
3191                 if (sipdebug)
3192                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
3193                 append_history(dialog, "OBproxy", "Using global obproxy %s", sip_cfg.outboundproxy.name);
3194                 return &sip_cfg.outboundproxy;
3195         }
3196         if (sipdebug)
3197                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
3198         return NULL;
3199 }
3200
3201 /*! \brief returns true if 'name' (with optional trailing whitespace)
3202  * matches the sip method 'id'.
3203  * Strictly speaking, SIP methods are case SENSITIVE, but we do
3204  * a case-insensitive comparison to be more tolerant.
3205  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
3206  */
3207 static int method_match(enum sipmethod id, const char *name)
3208 {
3209         int len = strlen(sip_methods[id].text);
3210         int l_name = name ? strlen(name) : 0;
3211         /* true if the string is long enough, and ends with whitespace, and matches */
3212         return (l_name >= len && name[len] < 33 &&
3213                 !strncasecmp(sip_methods[id].text, name, len));
3214 }
3215
3216 /*! \brief  find_sip_method: Find SIP method from header */
3217 static int find_sip_method(const char *msg)
3218 {
3219         int i, res = 0;
3220
3221         if (ast_strlen_zero(msg))
3222                 return 0;
3223         for (i = 1; i < ARRAY_LEN(sip_methods) && !res; i++) {
3224                 if (method_match(i, msg))
3225                         res = sip_methods[i].id;
3226         }
3227         return res;
3228 }
3229
3230 /*! \brief Parse supported header in incoming packet */
3231 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
3232 {
3233         char *next, *sep;
3234         char *temp;
3235         unsigned int profile = 0;
3236         int i, found;
3237
3238         if (ast_strlen_zero(supported) )
3239                 return 0;
3240         temp = ast_strdupa(supported);
3241
3242         if (sipdebug)
3243                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
3244
3245         for (next = temp; next; next = sep) {
3246                 found = FALSE;
3247                 if ( (sep = strchr(next, ',')) != NULL)
3248                         *sep++ = '\0';
3249                 next = ast_skip_blanks(next);
3250                 if (sipdebug)
3251                         ast_debug(3, "Found SIP option: -%s-\n", next);
3252                 for (i = 0; i < ARRAY_LEN(sip_options); i++) {
3253                         if (!strcasecmp(next, sip_options[i].text)) {
3254                                 profile |= sip_options[i].id;
3255                                 found = TRUE;
3256                                 if (sipdebug)
3257                                         ast_debug(3, "Matched SIP option: %s\n", next);
3258                                 break;
3259                         }
3260                 }
3261
3262                 /* This function is used to parse both Suported: and Require: headers.
3263                 Let the caller of this function know that an unknown option tag was
3264                 encountered, so that if the UAC requires it then the request can be
3265                 rejected with a 420 response. */
3266                 if (!found)
3267                         profile |= SIP_OPT_UNKNOWN;
3268
3269                 if (!found && sipdebug) {
3270                         if (!strncasecmp(next, "x-", 2))
3271                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
3272                         else
3273                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
3274                 }
3275         }
3276
3277         if (pvt)
3278                 pvt->sipoptions = profile;
3279         return profile;
3280 }
3281
3282 /*! \brief See if we pass debug IP filter */
3283 static inline int sip_debug_test_addr(const struct sockaddr_in *addr)
3284 {
3285         if (!sipdebug)
3286                 return 0;
3287         if (debugaddr.sin_addr.s_addr) {
3288                 if (((ntohs(debugaddr.sin_port) != 0)
3289                         && (debugaddr.sin_port != addr->sin_port))
3290                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
3291                         return 0;
3292         }
3293         return 1;
3294 }
3295
3296 /*! \brief The real destination address for a write */
3297 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
3298 {
3299         if (p->outboundproxy)
3300                 return &p->outboundproxy->ip;
3301
3302         return ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) || ast_test_flag(&p->flags[0], SIP_NAT_RPORT_PRESENT) ? &p->recv : &p->sa;
3303 }
3304
3305 /*! \brief Display SIP nat mode */
3306 static const char *sip_nat_mode(const struct sip_pvt *p)
3307 {
3308         return ast_test_flag(&p->flags[0], SIP_NAT_FORCE_RPORT) ? "NAT" : "no NAT";
3309 }
3310
3311 /*! \brief Test PVT for debugging output */
3312 static inline int sip_debug_test_pvt(struct sip_pvt *p)
3313 {
3314         if (!sipdebug)
3315                 return 0;
3316         return sip_debug_test_addr(sip_real_dst(p));
3317 }
3318
3319 /*! \brief Return int representing a bit field of transport types found in const char *transport */
3320 static int get_transport_str2enum(const char *transport)
3321 {
3322         int res = 0;
3323
3324         if (ast_strlen_zero(transport)) {
3325                 return res;
3326         }
3327
3328         if (!strcasecmp(transport, "udp")) {
3329                 res |= SIP_TRANSPORT_UDP;
3330         }
3331         if (!strcasecmp(transport, "tcp")) {
3332                 res |= SIP_TRANSPORT_TCP;
3333         }
3334         if (!strcasecmp(transport, "tls")) {
3335                 res |= SIP_TRANSPORT_TLS;
3336         }
3337
3338         return res;
3339 }
3340
3341 /*! \brief Return configuration of transports for a device */
3342 static inline const char *get_transport_list(unsigned int transports) {
3343         switch (transports) {
3344                 case SIP_TRANSPORT_UDP:
3345                         return "UDP";
3346                 case SIP_TRANSPORT_TCP:
3347                         return "TCP";
3348                 case SIP_TRANSPORT_TLS:
3349                         return "TLS";
3350                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TCP:
3351                         return "TCP,UDP";
3352                 case SIP_TRANSPORT_UDP | SIP_TRANSPORT_TLS:
3353                         return "TLS,UDP";
3354                 case SIP_TRANSPORT_TCP | SIP_TRANSPORT_TLS:
3355                         return "TLS,TCP";
3356                 default:
3357                         return transports ?
3358                                 "TLS,TCP,UDP" : "UNKNOWN";
3359         }
3360 }
3361
3362 /*! \brief Return transport as string */
3363 static inline const char *get_transport(enum sip_transport t)
3364 {
3365         switch (t) {
3366         case SIP_TRANSPORT_UDP:
3367                 return "UDP";
3368         case SIP_TRANSPORT_TCP:
3369                 return "TCP";
3370         case SIP_TRANSPORT_TLS:
3371                 return "TLS";
3372         }
3373
3374         return "UNKNOWN";
3375 }
3376
3377 /*! \brief Return transport of dialog.
3378         \note this is based on a false assumption. We don't always use the
3379         outbound proxy for all requests in a dialog. It depends on the
3380         "force" parameter. The FIRST request is always sent to the ob proxy.
3381         \todo Fix this function to work correctly
3382 */
3383 static inline const char *get_transport_pvt(struct sip_pvt *p)
3384 {
3385         if (p->outboundproxy && p->outboundproxy->transport) {
3386                 set_socket_transport(&p->socket, p->outboundproxy->transport);
3387         }
3388
3389         return get_transport(p->socket.type);
3390 }
3391
3392 /*! \brief Transmit SIP message
3393         Sends a SIP request or response&nb