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  *
  42  * ******** Wishlist: Improvements
  43  * - Support of SIP domains for devices, so that we match on username@domain in the From: header
  44  * - Connect registrations with a specific device on the incoming call. It's not done
  45  *   automatically in Asterisk
  46  *
  47  * \ingroup channel_drivers
  48  *
  49  * \par Overview of the handling of SIP sessions
  50  * The SIP channel handles several types of SIP sessions, or dialogs,
  51  * not all of them being "telephone calls".
  52  * - Incoming calls that will be sent to the PBX core
  53  * - Outgoing calls, generated by the PBX
  54  * - SIP subscriptions and notifications of states and voicemail messages
  55  * - SIP registrations, both inbound and outbound
  56  * - SIP peer management (peerpoke, OPTIONS)
  57  * - SIP text messages
  58  *
  59  * In the SIP channel, there's a list of active SIP dialogs, which includes
  60  * all of these when they are active. "sip show channels" in the CLI will
  61  * show most of these, excluding subscriptions which are shown by
  62  * "sip show subscriptions"
  63  *
  64  * \par incoming packets
  65  * Incoming packets are received in the monitoring thread, then handled by
  66  * sipsock_read() for udp only. In tcp, packets are read by the tcp_helper thread.
  67  * sipsock_read() function parses the packet and matches an existing
  68  * dialog or starts a new SIP dialog.
  69  *
  70  * sipsock_read sends the packet to handle_incoming(), that parses a bit more.
  71  * If it is a response to an outbound request, the packet is sent to handle_response().
  72  * If it is a request, handle_incoming() sends it to one of a list of functions
  73  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
  74  * sipsock_read locks the ast_channel if it exists (an active call) and
  75  * unlocks it after we have processed the SIP message.
  76  *
  77  * A new INVITE is sent to handle_request_invite(), that will end up
  78  * starting a new channel in the PBX, the new channel after that executing
  79  * in a separate channel thread. This is an incoming "call".
  80  * When the call is answered, either by a bridged channel or the PBX itself
  81  * the sip_answer() function is called.
  82  *
  83  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
  84  * in rtp.c
  85  *
  86  * \par Outbound calls
  87  * Outbound calls are set up by the PBX through the sip_request_call()
  88  * function. After that, they are activated by sip_call().
  89  *
  90  * \par Hanging up
  91  * The PBX issues a hangup on both incoming and outgoing calls through
  92  * the sip_hangup() function
  93  */
  94
  95 /*!
  96  * \page sip_tcp_tls SIP TCP and TLS support
  97  *
  98  * \par tcpfixes TCP implementation changes needed
  99  * \todo Fix TCP/TLS handling in dialplan, SRV records, transfers and much more
 100  * \todo Save TCP/TLS sessions in registry
 101  *      If someone registers a SIPS uri, this forces us to set up a TLS connection back.
 102  * \todo Add TCP/TLS information to function SIPPEER and SIPCHANINFO
 103  * \todo If tcpenable=yes, we must open a TCP socket on the same address as the IP for UDP.
 104  *      The tcpbindaddr config option should only be used to open ADDITIONAL ports
 105  *      So we should propably go back to
 106  *              bindaddr= the default address to bind to. If tcpenable=yes, then bind this to both udp and TCP
 107  *                              if tlsenable=yes, open TLS port (provided we also have cert)
 108  *              tcpbindaddr = extra address for additional TCP connections
 109  *              tlsbindaddr = extra address for additional TCP/TLS connections
 110  *              udpbindaddr = extra address for additional UDP connections
 111  *                      These three options should take multiple IP/port pairs
 112  *      Note: Since opening additional listen sockets is a *new* feature we do not have today
 113  *              the XXXbindaddr options needs to be disabled until we have support for it
 114  *
 115  * \todo re-evaluate the transport= setting in sip.conf. This is right now not well
 116  *      thought of. If a device in sip.conf contacts us via TCP, we should not switch transport,
 117  *      even if udp is the configured first transport.
 118  *
 119  * \todo Be prepared for one outbound and another incoming socket per pvt. This applies
 120  *       specially to communication with other peers (proxies).
 121  * \todo We need to test TCP sessions with SIP proxies and in regards
 122  *       to the SIP outbound specs.
 123  * \todo ;transport=tls was deprecated in RFC3261 and should not be used at all. See section 26.2.2.
 124  *
 125  * \todo If the message is smaller than the given Content-length, the request should get a 400 Bad request
 126  *       message. If it's a response, it should be dropped. (RFC 3261, Section 18.3)
 127  * \todo Since we have had multidomain support in Asterisk for quite a while, we need to support
 128  *       multiple domains in our TLS implementation, meaning one socket and one cert per domain
 129  * \todo Selection of transport for a request needs to be done after we've parsed all route headers,
 130  *       also considering outbound proxy options.
 131  *              First request: Outboundproxy, routes, (reg contact or URI. If URI doesn't have port:  DNS naptr, srv, AAA)
 132  *              Intermediate requests: Outboundproxy(only when forced), routes, contact/uri
 133  *      DNS naptr support is crucial. A SIP uri might lead to a TLS connection.
 134  *      Also note that due to outbound proxy settings, a SIPS uri might have to be sent on UDP (not to recommend though)
 135  * \todo Default transports are set to UDP, which cause the wrong behaviour when contacting remote
 136  *      devices directly from the dialplan. UDP is only a fallback if no other method works,
 137  *      in order to be compatible with RFC2543 (SIP/1.0) devices. For transactions that exceed the
 138  *      MTU (like INIVTE with video, audio and RTT)  TCP should be preferred.
 139  *
 140  *      When dialling unconfigured peers (with no port number)  or devices in external domains
 141  *      NAPTR records MUST be consulted to find configured transport. If they are not found,
 142  *      SRV records for both TCP and UDP should be checked. If there's a record for TCP, use that.
 143  *      If there's no record for TCP, then use UDP as a last resort. If there's no SRV records,
 144  *      \note this only applies if there's no outbound proxy configured for the session. If an outbound
 145  *      proxy is configured, these procedures might apply for locating the proxy and determining
 146  *      the transport to use for communication with the proxy.
 147  * \par Other bugs to fix ----
 148  * __set_address_from_contact(const char *fullcontact, struct sockaddr_in *sin, int tcp)
 149  *      - sets TLS port as default for all TCP connections, unless other port is given in contact.
 150  * parse_register_contact(struct sip_pvt *pvt, struct sip_peer *peer, struct sip_request *req)
 151  *      - assumes that the contact the UA registers is using the same transport as the REGISTER request, which is
 152  *        a bad guess.
 153  *      - Does not save any information about TCP/TLS connected devices, which is a severe BUG, as discussed on the mailing list.
 154  * get_destination(struct sip_pvt *p, struct sip_request *oreq)
 155  *      - Doesn't store the information that we got an incoming SIPS request in the channel, so that
 156  *        we can require a secure signalling path OUT of Asterisk (on SIP or IAX2). Possibly, the call should
 157  *        fail on in-secure signalling paths if there's no override in our configuration. At least, provide a
 158  *        channel variable in the dialplan.
 159  * get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req)
 160  *      - As above, if we have a SIPS: uri in the refer-to header
 161  *      - Does not check transport in refer_to uri.
 162  */
 163
 164 /*** MODULEINFO
 165         <depend>chan_local</depend>
 166  ***/
 167
 168 /*!  \page sip_session_timers SIP Session Timers in Asterisk Chan_sip
 169
 170         The SIP Session-Timers is an extension of the SIP protocol that allows end-points and proxies to
 171         refresh a session periodically. The sessions are kept alive by sending a RE-INVITE or UPDATE
 172         request at a negotiated interval. If a session refresh fails then all the entities that support Session-
 173         Timers clear their internal session state. In addition, UAs generate a BYE request in order to clear
 174         the state in the proxies and the remote UA (this is done for the benefit of SIP entities in the path
 175         that do not support Session-Timers).
 176
 177         The Session-Timers can be configured on a system-wide, per-user, or per-peer basis. The peruser/
 178         per-peer settings override the global settings. The following new parameters have been
 179         added to the sip.conf file.
 180                 session-timers=["accept", "originate", "refuse"]
 181                 session-expires=[integer]
 182                 session-minse=[integer]
 183                 session-refresher=["uas", "uac"]
 184
 185         The session-timers parameter in sip.conf defines the mode of operation of SIP session-timers feature in
 186         Asterisk. The Asterisk can be configured in one of the following three modes:
 187
 188         1. Accept :: In the "accept" mode, the Asterisk server honors session-timers requests
 189                 made by remote end-points. A remote end-point can request Asterisk to engage
 190                 session-timers by either sending it an INVITE request with a "Supported: timer"
 191                 header in it or by responding to Asterisk's INVITE with a 200 OK that contains
 192                 Session-Expires: header in it. In this mode, the Asterisk server does not
 193                 request session-timers from remote end-points. This is the default mode.
 194         2. Originate :: In the "originate" mode, the Asterisk server requests the remote
 195                 end-points to activate session-timers in addition to honoring such requests
 196                 made by the remote end-pints. In order to get as much protection as possible
 197                 against hanging SIP channels due to network or end-point failures, Asterisk
 198                 resends periodic re-INVITEs even if a remote end-point does not support
 199                 the session-timers feature.
 200         3. Refuse :: In the "refuse" mode, Asterisk acts as if it does not support session-
 201                 timers for inbound or outbound requests. If a remote end-point requests
 202                 session-timers in a dialog, then Asterisk ignores that request unless it's
 203                 noted as a requirement (Require: header), in which case the INVITE is
 204                 rejected with a 420 Bad Extension response.
 205
 206 */
 207
 208 #include "asterisk.h"
 209
 210 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 211
 212 #include <ctype.h>
 213 #include <sys/ioctl.h>
 214 #include <fcntl.h>
 215 #include <signal.h>
 216 #include <sys/signal.h>
 217 #include <regex.h>
 218 #include <time.h>
 219
 220 #include "asterisk/network.h"
 221 #include "asterisk/paths.h"     /* need ast_config_AST_SYSTEM_NAME */
 222
 223 #include "asterisk/lock.h"
 224 #include "asterisk/channel.h"
 225 #include "asterisk/config.h"
 226 #include "asterisk/module.h"
 227 #include "asterisk/pbx.h"
 228 #include "asterisk/sched.h"
 229 #include "asterisk/io.h"
 230 #include "asterisk/rtp_engine.h"
 231 #include "asterisk/udptl.h"
 232 #include "asterisk/acl.h"
 233 #include "asterisk/manager.h"
 234 #include "asterisk/callerid.h"
 235 #include "asterisk/cli.h"
 236 #include "asterisk/app.h"
 237 #include "asterisk/musiconhold.h"
 238 #include "asterisk/dsp.h"
 239 #include "asterisk/features.h"
 240 #include "asterisk/srv.h"
 241 #include "asterisk/astdb.h"
 242 #include "asterisk/causes.h"
 243 #include "asterisk/utils.h"
 244 #include "asterisk/file.h"
 245 #include "asterisk/astobj.h"
 246 /*
 247    Uncomment the define below,  if you are having refcount related memory leaks.
 248    With this uncommented, this module will generate a file, /tmp/refs, which contains
 249    a history of the ao2_ref() calls. To be useful, all calls to ao2_* functions should
 250    be modified to ao2_t_* calls, and include a tag describing what is happening with
 251    enough detail, to make pairing up a reference count increment with its corresponding decrement.
 252    The refcounter program in utils/ can be invaluable in highlighting objects that are not
 253    balanced, along with the complete history for that object.
 254    In normal operation, the macros defined will throw away the tags, so they do not
 255    affect the speed of the program at all. They can be considered to be documentation.
 256 */
 257 /* #define  REF_DEBUG 1 */
 258 #include "asterisk/astobj2.h"
 259 #include "asterisk/dnsmgr.h"
 260 #include "asterisk/devicestate.h"
 261 #include "asterisk/linkedlists.h"
 262 #include "asterisk/stringfields.h"
 263 #include "asterisk/monitor.h"
 264 #include "asterisk/netsock.h"
 265 #include "asterisk/localtime.h"
 266 #include "asterisk/abstract_jb.h"
 267 #include "asterisk/threadstorage.h"
 268 #include "asterisk/translate.h"
 269 #include "asterisk/ast_version.h"
 270 #include "asterisk/event.h"
 271 #include "asterisk/tcptls.h"
 272 #include "asterisk/stun.h"
 273 #include "asterisk/cel.h"
 274 #include "asterisk/strings.h"
 275
 276 /*** DOCUMENTATION
 277         <application name="SIPDtmfMode" language="en_US">
 278                 <synopsis>
 279                         Change the dtmfmode for a SIP call.
 280                 </synopsis>
 281                 <syntax>
 282                         <parameter name="mode" required="true">
 283                                 <enumlist>
 284                                         <enum name="inband" />
 285                                         <enum name="info" />
 286                                         <enum name="rfc2833" />
 287                                 </enumlist>
 288                         </parameter>
 289                 </syntax>
 290                 <description>
 291                         <para>Changes the dtmfmode for a SIP call.</para>
 292                 </description>
 293         </application>
 294         <application name="SIPAddHeader" language="en_US">
 295                 <synopsis>
 296                         Add a SIP header to the outbound call.
 297                 </synopsis>
 298                 <syntax argsep=":">
 299                         <parameter name="Header" required="true" />
 300                         <parameter name="Content" required="true" />
 301                 </syntax>
 302                 <description>
 303                         <para>Adds a header to a SIP call placed with DIAL.</para>
 304                         <para>Remember to use the X-header if you are adding non-standard SIP
 305                         headers, like <literal>X-Asterisk-Accountcode:</literal>. Use this with care.
 306                         Adding the wrong headers may jeopardize the SIP dialog.</para>
 307                         <para>Always returns <literal>0</literal>.</para>
 308                 </description>
 309         </application>
 310         <application name="SIPRemoveHeader" language="en_US">
 311                 <synopsis>
 312                         Remove SIP headers previously added with SIPAddHeader
 313                 </synopsis>
 314                 <syntax>
 315                         <parameter name="Header" required="false" />
 316                 </syntax>
 317                 <description>
 318                         <para>SIPRemoveHeader() allows you to remove headers which were previously
 319                         added with SIPAddHeader(). If no parameter is supplied, all previously added
 320                         headers will be removed. If a parameter is supplied, only the matching headers
 321                         will be removed.</para>
 322                         <para>For example you have added these 2 headers:</para>
 323                         <para>SIPAddHeader(P-Asserted-Identity: sip:foo@bar);</para>
 324                         <para>SIPAddHeader(P-Preferred-Identity: sip:bar@foo);</para>
 325                         <para></para>
 326                         <para>// remove all headers</para>
 327                         <para>SIPRemoveHeader();</para>
 328                         <para>// remove all P- headers</para>
 329                         <para>SIPRemoveHeader(P-);</para>
 330                         <para>// remove only the PAI header (note the : at the end)</para>
 331                         <para>SIPRemoveHeader(P-Asserted-Identity:);</para>
 332                         <para></para>
 333                         <para>Always returns <literal>0</literal>.</para>
 334                 </description>
 335         </application>
 336         <function name="SIP_HEADER" language="en_US">
 337                 <synopsis>
 338                         Gets the specified SIP header.
 339                 </synopsis>
 340                 <syntax>
 341                         <parameter name="name" required="true" />
 342                         <parameter name="number">
 343                                 <para>If not specified, defaults to <literal>1</literal>.</para>
 344                         </parameter>
 345                 </syntax>
 346                 <description>
 347                         <para>Since there are several headers (such as Via) which can occur multiple
 348                         times, SIP_HEADER takes an optional second argument to specify which header with
 349                         that name to retrieve. Headers start at offset <literal>1</literal>.</para>
 350                 </description>
 351         </function>
 352         <function name="SIPPEER" language="en_US">
 353                 <synopsis>
 354                         Gets SIP peer information.
 355                 </synopsis>
 356                 <syntax>
 357                         <parameter name="peername" required="true" />
 358                         <parameter name="item">
 359                                 <enumlist>
 360                                         <enum name="ip">
 361                                                 <para>(default) The ip address.</para>
 362                                         </enum>
 363                                         <enum name="port">
 364                                                 <para>The port number.</para>
 365                                         </enum>
 366                                         <enum name="mailbox">
 367                                                 <para>The configured mailbox.</para>
 368                                         </enum>
 369                                         <enum name="context">
 370                                                 <para>The configured context.</para>
 371                                         </enum>
 372                                         <enum name="expire">
 373                                                 <para>The epoch time of the next expire.</para>
 374                                         </enum>
 375                                         <enum name="dynamic">
 376                                                 <para>Is it dynamic? (yes/no).</para>
 377                                         </enum>
 378                                         <enum name="callerid_name">
 379                                                 <para>The configured Caller ID name.</para>
 380                                         </enum>
 381                                         <enum name="callerid_num">
 382                                                 <para>The configured Caller ID number.</para>
 383                                         </enum>
 384                                         <enum name="callgroup">
 385                                                 <para>The configured Callgroup.</para>
 386                                         </enum>
 387                                         <enum name="pickupgroup">
 388                                                 <para>The configured Pickupgroup.</para>
 389                                         </enum>
 390                                         <enum name="codecs">
 391                                                 <para>The configured codecs.</para>
 392                                         </enum>
 393                                         <enum name="status">
 394                                                 <para>Status (if qualify=yes).</para>
 395                                         </enum>
 396                                         <enum name="regexten">
 397                                                 <para>Registration extension.</para>
 398                                         </enum>
 399                                         <enum name="limit">
 400                                                 <para>Call limit (call-limit).</para>
 401                                         </enum>
 402                                         <enum name="busylevel">
 403                                                 <para>Configured call level for signalling busy.</para>
 404                                         </enum>
 405                                         <enum name="curcalls">
 406                                                 <para>Current amount of calls. Only available if call-limit is set.</para>
 407                                         </enum>
 408                                         <enum name="language">
 409                                                 <para>Default language for peer.</para>
 410                                         </enum>
 411                                         <enum name="accountcode">
 412                                                 <para>Account code for this peer.</para>
 413                                         </enum>
 414                                         <enum name="useragent">
 415                                                 <para>Current user agent id for peer.</para>
 416                                         </enum>
 417                                         <enum name="chanvar[name]">
 418                                                 <para>A channel variable configured with setvar for this peer.</para>
 419                                         </enum>
 420                                         <enum name="codec[x]">
 421                                                 <para>Preferred codec index number <replaceable>x</replaceable> (beginning with zero).</para>
 422                                         </enum>
 423                                 </enumlist>
 424                         </parameter>
 425                 </syntax>
 426                 <description />
 427         </function>
 428         <function name="SIPCHANINFO" language="en_US">
 429                 <synopsis>
 430                         Gets the specified SIP parameter from the current channel.
 431                 </synopsis>
 432                 <syntax>
 433                         <parameter name="item" required="true">
 434                                 <enumlist>
 435                                         <enum name="peerip">
 436                                                 <para>The IP address of the peer.</para>
 437                                         </enum>
 438                                         <enum name="recvip">
 439                                                 <para>The source IP address of the peer.</para>
 440                                         </enum>
 441                                         <enum name="from">
 442                                                 <para>The URI from the <literal>From:</literal> header.</para>
 443                                         </enum>
 444                                         <enum name="uri">
 445                                                 <para>The URI from the <literal>Contact:</literal> header.</para>
 446                                         </enum>
 447                                         <enum name="useragent">
 448                                                 <para>The useragent.</para>
 449                                         </enum>
 450                                         <enum name="peername">
 451                                                 <para>The name of the peer.</para>
 452                                         </enum>
 453                                         <enum name="t38passthrough">
 454                                                 <para><literal>1</literal> if T38 is offered or enabled in this channel,
 455                                                 otherwise <literal>0</literal>.</para>
 456                                         </enum>
 457                                 </enumlist>
 458                         </parameter>
 459                 </syntax>
 460                 <description />
 461         </function>
 462         <function name="CHECKSIPDOMAIN" language="en_US">
 463                 <synopsis>
 464                         Checks if domain is a local domain.
 465                 </synopsis>
 466                 <syntax>
 467                         <parameter name="domain" required="true" />
 468                 </syntax>
 469                 <description>
 470                         <para>This function checks if the <replaceable>domain</replaceable> in the argument is configured
 471                         as a local SIP domain that this Asterisk server is configured to handle.
 472                         Returns the domain name if it is locally handled, otherwise an empty string.
 473                         Check the <literal>domain=</literal> configuration in <filename>sip.conf</filename>.</para>
 474                 </description>
 475         </function>
 476         <manager name="SIPpeers" language="en_US">
 477                 <synopsis>
 478                         List SIP peers (text format).
 479                 </synopsis>
 480                 <syntax>
 481                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 482                 </syntax>
 483                 <description>
 484                         <para>Lists SIP peers in text format with details on current status.
 485                         Peerlist will follow as separate events, followed by a final event called
 486                         PeerlistComplete.</para>
 487                 </description>
 488         </manager>
 489         <manager name="SIPshowpeer" language="en_US">
 490                 <synopsis>
 491                         show SIP peer (text format).
 492                 </synopsis>
 493                 <syntax>
 494                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 495                         <parameter name="Peer" required="true">
 496                                 <para>The peer name you want to check.</para>
 497                         </parameter>
 498                 </syntax>
 499                 <description>
 500                         <para>Show one SIP peer with details on current status.</para>
 501                 </description>
 502         </manager>
 503         <manager name="SIPqualifypeer" language="en_US">
 504                 <synopsis>
 505                         Qualify SIP peers.
 506                 </synopsis>
 507                 <syntax>
 508                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 509                         <parameter name="Peer" required="true">
 510                                 <para>The peer name you want to qualify.</para>
 511                         </parameter>
 512                 </syntax>
 513                 <description>
 514                         <para>Qualify a SIP peer.</para>
 515                 </description>
 516         </manager>
 517         <manager name="SIPshowregistry" language="en_US">
 518                 <synopsis>
 519                         Show SIP registrations (text format).
 520                 </synopsis>
 521                 <syntax>
 522                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 523                 </syntax>
 524                 <description>
 525                         <para>Lists all registration requests and status. Registrations will follow as separate
 526                         events. followed by a final event called RegistrationsComplete.</para>
 527                 </description>
 528         </manager>
 529         <manager name="SIPnotify" language="en_US">
 530                 <synopsis>
 531                         Send a SIP notify.
 532                 </synopsis>
 533                 <syntax>
 534                         <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
 535                         <parameter name="Channel" required="true">
 536                                 <para>Peer to receive the notify.</para>
 537                         </parameter>
 538                         <parameter name="Variable" required="true">
 539                                 <para>At least one variable pair must be specified.
 540                                 <replaceable>name</replaceable>=<replaceable>value</replaceable></para>
 541                         </parameter>
 542                 </syntax>
 543                 <description>
 544                         <para>Sends a SIP Notify event.</para>
 545                         <para>All parameters for this event must be specified in the body of this request
 546                         via multiple Variable: name=value sequences.</para>
 547                 </description>
 548         </manager>
 549  ***/
 550
 551 #ifndef FALSE
 552 #define FALSE    0
 553 #endif
 554
 555 #ifndef TRUE
 556 #define TRUE     1
 557 #endif
 558
 559 /* Arguments for find_peer */
 560 #define FINDUSERS (1 << 0)
 561 #define FINDPEERS (1 << 1)
 562 #define FINDALLDEVICES (FINDUSERS | FINDPEERS)
 563
 564 #define SIPBUFSIZE              512             /*!< Buffer size for many operations */
 565
 566 #define XMIT_ERROR              -2
 567
 568 #define SIP_RESERVED ";/?:@&=+$,# "             /*!< Reserved characters in the username part of the URI */
 569
 570 /* #define VOCAL_DATA_HACK */
 571
 572 #define DEFAULT_DEFAULT_EXPIRY  120
 573 #define DEFAULT_MIN_EXPIRY      60
 574 #define DEFAULT_MAX_EXPIRY      3600
 575 #define DEFAULT_MWI_EXPIRY      3600
 576 #define DEFAULT_REGISTRATION_TIMEOUT 20
 577 #define DEFAULT_MAX_FORWARDS    "70"
 578
 579 /* guard limit must be larger than guard secs */
 580 /* guard min must be < 1000, and should be >= 250 */
 581 #define EXPIRY_GUARD_SECS       15                /*!< How long before expiry do we reregister */
 582 #define EXPIRY_GUARD_LIMIT      30                /*!< Below here, we use EXPIRY_GUARD_PCT instead of
 583                                                          EXPIRY_GUARD_SECS */
 584 #define EXPIRY_GUARD_MIN        500                /*!< This is the minimum guard time applied. If
 585                                                    GUARD_PCT turns out to be lower than this, it
 586                                                    will use this time instead.
 587                                                    This is in milliseconds. */
 588 #define EXPIRY_GUARD_PCT        0.20                /*!< Percentage of expires timeout to use when
 589                                                     below EXPIRY_GUARD_LIMIT */
 590 #define DEFAULT_EXPIRY 900                          /*!< Expire slowly */
 591
 592 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
 593 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
 594 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
 595 static int mwi_expiry = DEFAULT_MWI_EXPIRY;
 596
 597 #define DEFAULT_QUALIFY_GAP   100
 598 #define DEFAULT_QUALIFY_PEERS 1
 599
 600
 601 #define CALLERID_UNKNOWN             "Anonymous"
 602 #define FROMDOMAIN_INVALID           "anonymous.invalid"
 603
 604 #define DEFAULT_MAXMS                2000             /*!< Qualification: Must be faster than 2 seconds by default */
 605 #define DEFAULT_QUALIFYFREQ          60 * 1000        /*!< Qualification: How often to check for the host to be up */
 606 #define DEFAULT_FREQ_NOTOK           10 * 1000        /*!< Qualification: How often to check, if the host is down... */
 607
 608 #define DEFAULT_RETRANS              1000             /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
 609 #define MAX_RETRANS                  6                /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
 610 #define DEFAULT_TIMER_T1                 500              /*!< SIP timer T1 (according to RFC 3261) */
 611 #define SIP_TRANS_TIMEOUT            64 * DEFAULT_TIMER_T1 /*!< SIP request timeout (rfc 3261) 64*T1
 612                                                       \todo Use known T1 for timeout (peerpoke)
 613                                                       */
 614 #define DEFAULT_TRANS_TIMEOUT        -1               /*!< Use default SIP transaction timeout */
 615 #define PROVIS_KEEPALIVE_TIMEOUT     60000            /*!< How long to wait before retransmitting a provisional response (rfc 3261 13.3.1.1) */
 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_DOMAINSASREALM  FALSE           /*!< Use the domain option to guess the realm for registration and invite requests */
1122 #define DEFAULT_NOTIFYRINGING   TRUE            /*!< Notify devicestate system on ringing state */
1123 #define DEFAULT_NOTIFYCID               DISABLED        /*!< Include CID with ringing notifications */
1124 #define DEFAULT_PEDANTIC        FALSE           /*!< Avoid following SIP standards for dialog matching */
1125 #define DEFAULT_AUTOCREATEPEER  FALSE           /*!< Don't create peers automagically */
1126 #define DEFAULT_MATCHEXTERNIPLOCALLY FALSE      /*!< Match extern IP locally default setting */
1127 #define DEFAULT_QUALIFY         FALSE           /*!< Don't monitor devices */
1128 #define DEFAULT_CALLEVENTS      FALSE           /*!< Extra manager SIP call events */
1129 #define DEFAULT_ALWAYSAUTHREJECT        FALSE   /*!< Don't reject authentication requests always */
1130 #define DEFAULT_REGEXTENONQUALIFY FALSE
1131 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
1132 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
1133 #ifndef DEFAULT_USERAGENT
1134 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
1135 #define DEFAULT_SDPSESSION "Asterisk PBX"       /*!< Default SDP session name, (s=) header unless re-defined in sip.conf */
1136 #define DEFAULT_SDPOWNER "root"                 /*!< Default SDP username field in (o=) header unless re-defined in sip.conf */
1137 #define DEFAULT_ENGINE "asterisk"               /*!< Default RTP engine to use for sessions */
1138 #endif
1139 /*@}*/
1140
1141 /*! \name DefaultSettings
1142         Default setttings are used as a channel setting and as a default when
1143         configuring devices
1144 */
1145 /*@{*/
1146 static char default_language[MAX_LANGUAGE];
1147 static char default_callerid[AST_MAX_EXTENSION];
1148 static char default_mwi_from[80];
1149 static char default_fromdomain[AST_MAX_EXTENSION];
1150 static char default_notifymime[AST_MAX_EXTENSION];
1151 static int default_qualify;             /*!< Default Qualify= setting */
1152 static char default_vmexten[AST_MAX_EXTENSION];
1153 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
1154 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting
1155                                                     *   a bridged channel on hold */
1156 static char default_parkinglot[AST_MAX_CONTEXT]; /*!< Parkinglot */
1157 static char default_engine[256];        /*!< Default RTP engine */
1158 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
1159 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
1160 static unsigned int default_transports;                 /*!< Default Transports (enum sip_transport) that are acceptable */
1161 static unsigned int default_primary_transport;          /*!< Default primary Transport (enum sip_transport) for outbound connections to devices */
1162
1163 /*@}*/
1164
1165 /*! \name GlobalSettings
1166         Global settings apply to the channel (often settings you can change in the general section
1167         of sip.conf
1168 */
1169 /*@{*/
1170 /*! \brief a place to store all global settings for the sip channel driver
1171         These are settings that will be possibly to apply on a group level later on.
1172         \note Do not add settings that only apply to the channel itself and can't
1173               be applied to devices (trunks, services, phones)
1174 */
1175 struct sip_settings {
1176         int peer_rtupdate;              /*!< G: Update database with registration data for peer? */
1177         int rtsave_sysname;             /*!< G: Save system name at registration? */
1178         int ignore_regexpire;           /*!< G: Ignore expiration of peer  */
1179         int rtautoclear;                /*!< Realtime ?? */
1180         int directrtpsetup;             /*!< Enable support for Direct RTP setup (no re-invites) */
1181         int pedanticsipchecking;        /*!< Extra checking ?  Default off */
1182         int autocreatepeer;             /*!< Auto creation of peers at registration? Default off. */
1183         int srvlookup;                  /*!< SRV Lookup on or off. Default is on */
1184         int allowguest;                 /*!< allow unauthenticated peers to connect? */
1185         int alwaysauthreject;           /*!< Send 401 Unauthorized for all failing requests */
1186         int compactheaders;             /*!< send compact sip headers */
1187         int allow_external_domains;     /*!< Accept calls to external SIP domains? */
1188         int callevents;                 /*!< Whether we send manager events or not */
1189         int regextenonqualify;          /*!< Whether to add/remove regexten when qualifying peers */
1190         int matchexterniplocally;       /*!< Match externip/externhost setting against localnet setting */
1191         unsigned int disallowed_methods; /*!< methods that we should never try to use */
1192         int notifyringing;              /*!< Send notifications on ringing */
1193         int notifyhold;                 /*!< Send notifications on hold */
1194         enum notifycid_setting notifycid; /*!< Send CID with ringing notifications */
1195         enum transfermodes allowtransfer;       /*!< SIP Refer restriction scheme */
1196         int allowsubscribe;             /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE
1197                                             the global setting is in globals_flags[1] */
1198         char realm[MAXHOSTNAMELEN];             /*!< Default realm */
1199         int domainsasrealm;                     /*!< Use domains lists as realms */
1200         struct sip_proxy outboundproxy; /*!< Outbound proxy */
1201         char default_context[AST_MAX_CONTEXT];
1202         char default_subscribecontext[AST_MAX_CONTEXT];
1203 };
1204
1205 static struct sip_settings sip_cfg;
1206
1207 static int global_match_auth_username;          /*!< Match auth username if available instead of From: Default off. */
1208
1209 static int global_relaxdtmf;            /*!< Relax DTMF */
1210 static int global_prematuremediafilter; /*!< Enable/disable premature frames in a call (causing 183 early media) */
1211 static int global_relaxdtmf;                    /*!< Relax DTMF */
1212 static int global_rtptimeout;           /*!< Time out call if no RTP */
1213 static int global_rtpholdtimeout;       /*!< Time out call if no RTP during hold */
1214 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
1215 static int global_reg_timeout;
1216 static int global_regattempts_max;      /*!< Registration attempts before giving up */
1217 static int global_callcounter;          /*!< Enable call counters for all devices. This is currently enabled by setting the peer
1218                                                 call-limit to 999. When we remove the call-limit from the code, we can make it
1219                                                 with just a boolean flag in the device structure */
1220 static unsigned int global_tos_sip;             /*!< IP type of service for SIP packets */
1221 static unsigned int global_tos_audio;           /*!< IP type of service for audio RTP packets */
1222 static unsigned int global_tos_video;           /*!< IP type of service for video RTP packets */
1223 static unsigned int global_tos_text;            /*!< IP type of service for text RTP packets */
1224 static unsigned int global_cos_sip;             /*!< 802.1p class of service for SIP packets */
1225 static unsigned int global_cos_audio;           /*!< 802.1p class of service for audio RTP packets */
1226 static unsigned int global_cos_video;           /*!< 802.1p class of service for video RTP packets */
1227 static unsigned int global_cos_text;            /*!< 802.1p class of service for text RTP packets */
1228 static unsigned int recordhistory;              /*!< Record SIP history. Off by default */
1229 static unsigned int dumphistory;                /*!< Dump history to verbose before destroying SIP dialog */
1230 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
1231 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
1232 static char global_sdpsession[AST_MAX_EXTENSION];       /*!< SDP session name for the SIP channel */
1233 static char global_sdpowner[AST_MAX_EXTENSION]; /*!< SDP owner name for the SIP channel */
1234 static int global_authfailureevents;            /*!< Whether we send authentication failure manager events or not. Default no. */
1235 static int global_t1;                   /*!< T1 time */
1236 static int global_t1min;                /*!< T1 roundtrip time minimum */
1237 static int global_timer_b;                      /*!< Timer B - RFC 3261 Section 17.1.1.2 */
1238 static unsigned int global_autoframing;         /*!< Turn autoframing on or off. */
1239 static int global_qualifyfreq;                  /*!< Qualify frequency */
1240 static int global_qualify_gap;              /*!< Time between our group of peer pokes */
1241 static int global_qualify_peers;          /*!< Number of peers to poke at a given time */
1242
1243
1244 /*! \brief Codecs that we support by default: */
1245 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
1246
1247 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
1248 static enum st_refresher global_st_refresher; /*!< Session-Timer refresher                        */
1249 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
1250 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
1251
1252 /*@}*/
1253
1254 /*! \brief Global list of addresses dynamic peers are not allowed to use */
1255 static struct ast_ha *global_contact_ha = NULL;
1256 static int global_dynamic_exclude_static = 0;
1257
1258 /*! \name Object counters @{
1259  * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
1260  * should be used to modify these values. */
1261 static int speerobjs = 0;                /*!< Static peers */
1262 static int rpeerobjs = 0;                /*!< Realtime peers */
1263 static int apeerobjs = 0;                /*!< Autocreated peer objects */
1264 static int regobjs = 0;                  /*!< Registry objects */
1265 /* }@ */
1266
1267 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
1268 static char used_context[AST_MAX_CONTEXT];              /*!< name of automatically created context for unloading */
1269
1270
1271 AST_MUTEX_DEFINE_STATIC(netlock);
1272
1273 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
1274    when it's doing something critical. */
1275 AST_MUTEX_DEFINE_STATIC(monlock);
1276
1277 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
1278
1279 /*! \brief This is the thread for the monitor which checks for input on the channels
1280    which are not currently in use.  */
1281 static pthread_t monitor_thread = AST_PTHREADT_NULL;
1282
1283 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
1284 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
1285
1286 static struct sched_context *sched;     /*!< The scheduling context */
1287 static struct io_context *io;           /*!< The IO context */
1288 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
1289
1290 #define DEC_CALL_LIMIT  0
1291 #define INC_CALL_LIMIT  1
1292 #define DEC_CALL_RINGING 2
1293 #define INC_CALL_RINGING 3
1294
1295 /*! \brief The SIP socket definition */
1296 struct sip_socket {
1297         enum sip_transport type;        /*!< UDP, TCP or TLS */
1298         int fd;                         /*!< Filed descriptor, the actual socket */
1299         uint16_t port;
1300         struct ast_tcptls_session_instance *tcptls_session;     /* If tcp or tls, a socket manager */
1301 };
1302
1303 /*! \brief sip_request: The data grabbed from the UDP socket
1304  *
1305  * \verbatim
1306  * Incoming messages: we first store the data from the socket in data[],
1307  * adding a trailing \0 to make string parsing routines happy.
1308  * Then call parse_request() and req.method = find_sip_method();
1309  * to initialize the other fields. The \r\n at the end of each line is
1310  * replaced by \0, so that data[] is not a conforming SIP message anymore.
1311  * After this processing, rlPart1 is set to non-NULL to remember
1312  * that we can run get_header() on this kind of packet.
1313  *
1314  * parse_request() splits the first line as follows:
1315  * Requests have in the first line      method uri SIP/2.0
1316  *      rlPart1 = method; rlPart2 = uri;
1317  * Responses have in the first line     SIP/2.0 NNN description
1318  *      rlPart1 = SIP/2.0; rlPart2 = NNN + description;
1319  *
1320  * For outgoing packets, we initialize the fields with init_req() or init_resp()
1321  * (which fills the first line to "METHOD uri SIP/2.0" or "SIP/2.0 code text"),
1322  * and then fill the rest with add_header() and add_line().
1323  * The \r\n at the end of the line are still there, so the get_header()
1324  * and similar functions don't work on these packets.
1325  * \endverbatim
1326  */
1327 struct sip_request {
1328         ptrdiff_t rlPart1;              /*!< Offset of the SIP Method Name or "SIP/2.0" protocol version */
1329         ptrdiff_t rlPart2;              /*!< Offset of the Request URI or Response Status */
1330         int len;                /*!< bytes used in data[], excluding trailing null terminator. Rarely used. */
1331         int headers;            /*!< # of SIP Headers */
1332         int method;             /*!< Method of this request */
1333         int lines;              /*!< Body Content */
1334         unsigned int sdp_start; /*!< the line number where the SDP begins */
1335         unsigned int sdp_end;   /*!< the line number where the SDP ends */
1336         char debug;             /*!< print extra debugging if non zero */
1337         char has_to_tag;        /*!< non-zero if packet has To: tag */
1338         char ignore;            /*!< if non-zero This is a re-transmit, ignore it */
1339         /* Array of offsets into the request string of each SIP header*/
1340         ptrdiff_t header[SIP_MAX_HEADERS];
1341         /* Array of offsets into the request string of each SDP line*/
1342         ptrdiff_t line[SIP_MAX_LINES];
1343         struct ast_str *data;
1344         /* XXX Do we need to unref socket.ser when the request goes away? */
1345         struct sip_socket socket;       /*!< The socket used for this request */
1346         AST_LIST_ENTRY(sip_request) next;
1347 };
1348
1349 /* \brief given a sip_request and an offset, return the char * that resides there
1350  *
1351  * It used to be that rlPart1, rlPart2, and the header and line arrays were character
1352  * pointers. They are now offsets into the ast_str portion of the sip_request structure.
1353  * To avoid adding a bunch of redundant pointer arithmetic to the code, this macro is
1354  * provided to retrieve the string at a particular offset within the request's buffer
1355  */
1356 #define REQ_OFFSET_TO_STR(req,offset) (ast_str_buffer((req)->data) + ((req)->offset))
1357
1358 /*! \brief structure used in transfers */
1359 struct sip_dual {
1360         struct ast_channel *chan1;      /*!< First channel involved */
1361         struct ast_channel *chan2;      /*!< Second channel involved */
1362         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
1363         int seqno;                      /*!< Sequence number */
1364 };
1365
1366 struct sip_pkt;
1367
1368 /*! \brief Parameters to the transmit_invite function */
1369 struct sip_invite_param {
1370         int addsipheaders;              /*!< Add extra SIP headers */
1371         const char *uri_options;        /*!< URI options to add to the URI */
1372         const char *vxml_url;           /*!< VXML url for Cisco phones */
1373         char *auth;                     /*!< Authentication */
1374         char *authheader;               /*!< Auth header */
1375         enum sip_auth_type auth_type;   /*!< Authentication type */
1376         const char *replaces;           /*!< Replaces header for call transfers */
1377         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
1378 };
1379
1380 /*! \brief Structure to save routing information for a SIP session */
1381 struct sip_route {
1382         struct sip_route *next;
1383         char hop[0];
1384 };
1385
1386 /*! \brief Modes for SIP domain handling in the PBX */
1387 enum domain_mode {
1388         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
1389         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
1390 };
1391
1392 /*! \brief Domain data structure.
1393         \note In the future, we will connect this to a configuration tree specific
1394         for this domain
1395 */
1396 struct domain {
1397         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
1398         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
1399         enum domain_mode mode;                  /*!< How did we find this domain? */
1400         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
1401 };
1402
1403 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
1404
1405
1406 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
1407 struct sip_history {
1408         AST_LIST_ENTRY(sip_history) list;
1409         char event[0];  /* actually more, depending on needs */
1410 };
1411
1412 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
1413
1414 /*! \brief sip_auth: Credentials for authentication to other SIP services */
1415 struct sip_auth {
1416         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
1417         char username[256];             /*!< Username */
1418         char secret[256];               /*!< Secret */
1419         char md5secret[256];            /*!< MD5Secret */
1420         struct sip_auth *next;          /*!< Next auth structure in list */
1421 };
1422
1423 /*! \name SIPflags
1424         Various flags for the flags field in the pvt structure
1425         Trying to sort these up (one or more of the following):
1426         D: Dialog
1427         P: Peer/user
1428         G: Global flag
1429         When flags are used by multiple structures, it is important that
1430         they have a common layout so it is easy to copy them.
1431 */
1432 /*@{*/
1433 #define SIP_OUTGOING            (1 << 0)        /*!< D: Direction of the last transaction in this dialog */
1434 #define SIP_RINGING             (1 << 2)        /*!< D: Have sent 180 ringing */
1435 #define SIP_PROGRESS_SENT       (1 << 3)        /*!< D: Have sent 183 message progress */
1436 #define SIP_NEEDREINVITE        (1 << 4)        /*!< D: Do we need to send another reinvite? */
1437 #define SIP_PENDINGBYE          (1 << 5)        /*!< D: Need to send bye after we ack? */
1438 #define SIP_GOTREFER            (1 << 6)        /*!< D: Got a refer? */
1439 #define SIP_CALL_LIMIT          (1 << 7)        /*!< D: Call limit enforced for this call */
1440 #define SIP_INC_COUNT           (1 << 8)        /*!< D: Did this dialog increment the counter of in-use calls? */
1441 #define SIP_INC_RINGING         (1 << 9)        /*!< D: Did this connection increment the counter of in-use calls? */
1442 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 10)       /*!< D: Do not hangup at first ast_hangup */
1443
1444 #define SIP_PROMISCREDIR        (1 << 11)       /*!< DP: Promiscuous redirection */
1445 #define SIP_TRUSTRPID           (1 << 12)       /*!< DP: Trust RPID headers? */
1446 #define SIP_USEREQPHONE         (1 << 13)       /*!< DP: Add user=phone to numeric URI. Default off */
1447 #define SIP_USECLIENTCODE       (1 << 14)       /*!< DP: Trust X-ClientCode info message */
1448
1449 /* DTMF flags - see str2dtmfmode() and dtmfmode2str() */
1450 #define SIP_DTMF                (7 << 15)       /*!< DP: DTMF Support: five settings, uses three bits */
1451 #define SIP_DTMF_RFC2833        (0 << 15)       /*!< DP: DTMF Support: RTP DTMF - "rfc2833" */
1452 #define SIP_DTMF_INBAND         (1 << 15)       /*!< DP: DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
1453 #define SIP_DTMF_INFO           (2 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" */
1454 #define SIP_DTMF_AUTO           (3 << 15)       /*!< DP: DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
1455 #define SIP_DTMF_SHORTINFO      (4 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" - short variant */
1456
1457 /* NAT settings */
1458 #define SIP_NAT_FORCE_RPORT     (1 << 18)       /*!< DP: Force rport even if not present in the request */
1459 #define SIP_NAT_RPORT_PRESENT   (1 << 19)       /*!< DP: rport was present in the request */
1460
1461 /* re-INVITE related settings */
1462 #define SIP_REINVITE            (7 << 20)       /*!< DP: four settings, uses three bits */
1463 #define SIP_REINVITE_NONE       (0 << 20)       /*!< DP: no reinvite allowed */
1464 #define SIP_DIRECT_MEDIA        (1 << 20)       /*!< DP: allow peers to be reinvited to send media directly p2p */
1465 #define SIP_DIRECT_MEDIA_NAT    (2 << 20)       /*!< DP: allow media reinvite when new peer is behind NAT */
1466 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< DP: use UPDATE (RFC3311) when reinviting this peer */
1467
1468 /* "insecure" settings - see insecure2str() */
1469 #define SIP_INSECURE            (3 << 23)       /*!< DP: three settings, uses two bits */
1470 #define SIP_INSECURE_NONE       (0 << 23)       /*!< DP: secure mode */
1471 #define SIP_INSECURE_PORT       (1 << 23)       /*!< DP: don't require matching port for incoming requests */
1472 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< DP: don't require authentication for incoming INVITEs */
1473
1474 /* Sending PROGRESS in-band settings */
1475 #define SIP_PROG_INBAND         (3 << 25)       /*!< DP: three settings, uses two bits */
1476 #define SIP_PROG_INBAND_NEVER   (0 << 25)
1477 #define SIP_PROG_INBAND_NO      (1 << 25)
1478 #define SIP_PROG_INBAND_YES     (2 << 25)
1479
1480 #define SIP_SENDRPID            (3 << 29)       /*!< DP: Remote Party-ID Support */
1481 #define SIP_SENDRPID_NO     (0 << 29)
1482 #define SIP_SENDRPID_PAI    (1 << 29)   /*!< Use "P-Asserted-Identity" for rpid */
1483 #define SIP_SENDRPID_RPID   (2 << 29)   /*!< Use "Remote-Party-ID" for rpid */
1484 #define SIP_G726_NONSTANDARD    (1 << 31)       /*!< DP: Use non-standard packing for G726-32 data */
1485
1486 /*! \brief Flags to copy from peer/user to dialog */
1487 #define SIP_FLAGS_TO_COPY \
1488         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
1489          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT_FORCE_RPORT | SIP_G726_NONSTANDARD | \
1490          SIP_USEREQPHONE | SIP_INSECURE)
1491 /*@}*/
1492
1493 /*! \name SIPflags2
1494         a second page of flags (for flags[1] */
1495 /*@{*/
1496 /* realtime flags */
1497 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)        /*!< GP: Should we keep RT objects in memory for extended time? */
1498 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)        /*!< GP: Should we clean memory from peers after expiry? */
1499 #define SIP_PAGE2_RPID_UPDATE           (1 << 3)
1500 /* Space for addition of other realtime flags in the future */
1501 #define SIP_PAGE2_SYMMETRICRTP          (1 << 8)        /*!< GDP: Whether symmetric RTP is enabled or not */
1502 #define SIP_PAGE2_STATECHANGEQUEUE      (1 << 9)        /*!< D: Unsent state pending change exists */
1503
1504 #define SIP_PAGE2_CONNECTLINEUPDATE_PEND                (1 << 10)
1505 #define SIP_PAGE2_RPID_IMMEDIATE                        (1 << 11)
1506 #define SIP_PAGE2_RPORT_PRESENT         (1 << 12)       /*!< Was rport received in the Via header? */
1507 #define SIP_PAGE2_PREFERRED_CODEC       (1 << 13)       /*!< GDP: Only respond with single most preferred joint codec */
1508 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 14)       /*!< DP: Video supported if offered? */
1509 #define SIP_PAGE2_TEXTSUPPORT           (1 << 15)       /*!< GDP: Global text enable */
1510 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< GP: Allow subscriptions from this peer? */
1511 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< DP: Allow overlap dialing ? */
1512 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< GP: Only issue MWI notification if subscribed to */
1513 #define SIP_PAGE2_IGNORESDPVERSION      (1 << 19)       /*!< GDP: Ignore the SDP session version number we receive and treat all sessions as new */
1514
1515 #define SIP_PAGE2_T38SUPPORT                    (7 << 20)       /*!< GDP: T.38 Fax Support */
1516 #define SIP_PAGE2_T38SUPPORT_UDPTL              (1 << 20)       /*!< GDP: T.38 Fax Support (no error correction) */
1517 #define SIP_PAGE2_T38SUPPORT_UDPTL_FEC          (2 << 20)       /*!< GDP: T.38 Fax Support (FEC error correction) */
1518 #define SIP_PAGE2_T38SUPPORT_UDPTL_REDUNDANCY   (4 << 20)       /*!< GDP: T.38 Fax Support (redundancy error correction) */
1519
1520 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< D: Call hold states: */
1521 #define SIP_PAGE2_CALL_ONHOLD_ACTIVE    (1 << 23)       /*!< D: Active hold */
1522 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (2 << 23)       /*!< D: One directional hold */
1523 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (3 << 23)       /*!< D: Inactive hold */
1524
1525 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 25)       /*!< DP: Compensate for buggy RFC2833 implementations */
1526 #define SIP_PAGE2_BUGGY_MWI             (1 << 26)       /*!< DP: Buggy CISCO MWI fix */
1527 #define SIP_PAGE2_DIALOG_ESTABLISHED    (1 << 27)       /*!< 29: Has a dialog been established? */
1528 #define SIP_PAGE2_FAX_DETECT            (1 << 28)               /*!< DP: Fax Detection support */
1529 #define SIP_PAGE2_REGISTERTRYING        (1 << 29)       /*!< DP: Send 100 Trying on REGISTER attempts */
1530 #define SIP_PAGE2_UDPTL_DESTINATION     (1 << 30)       /*!< DP: Use source IP of RTP as destination if NAT is enabled */
1531 #define SIP_PAGE2_VIDEOSUPPORT_ALWAYS   (1 << 31)       /*!< DP: Always set up video, even if endpoints don't support it */
1532
1533 #define SIP_PAGE2_FLAGS_TO_COPY \
1534         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_IGNORESDPVERSION | \
1535         SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE | \
1536         SIP_PAGE2_BUGGY_MWI | SIP_PAGE2_TEXTSUPPORT | SIP_PAGE2_FAX_DETECT | \
1537         SIP_PAGE2_UDPTL_DESTINATION | SIP_PAGE2_VIDEOSUPPORT_ALWAYS | SIP_PAGE2_PREFERRED_CODEC | \
1538         SIP_PAGE2_RPID_IMMEDIATE | SIP_PAGE2_RPID_UPDATE | SIP_PAGE2_SYMMETRICRTP)
1539
1540 /*@}*/
1541
1542 /*! \brief debugging state
1543  * We store separately the debugging requests from the config file
1544  * and requests from the CLI. Debugging is enabled if either is set
1545  * (which means that if sipdebug is set in the config file, we can
1546  * only turn it off by reloading the config).
1547  */
1548 enum sip_debug_e {
1549         sip_debug_none = 0,
1550         sip_debug_config = 1,
1551         sip_debug_console = 2,
1552 };
1553
1554 static enum sip_debug_e sipdebug;
1555
1556 /*! \brief extra debugging for 'text' related events.
1557  * At the moment this is set together with sip_debug_console.
1558  * \note It should either go away or be implemented properly.
1559  */
1560 static int sipdebug_text;
1561
1562 /*! \brief T38 States for a call */
1563 enum t38state {
1564         T38_DISABLED = 0,                /*!< Not enabled */
1565         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
1566         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
1567         T38_ENABLED                      /*!< Negotiated (enabled) */
1568 };
1569
1570 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
1571 struct t38properties {
1572         enum t38state state;            /*!< T.38 state */
1573         struct ast_control_t38_parameters our_parms;
1574         struct ast_control_t38_parameters their_parms;
1575 };
1576
1577 /*! \brief Parameters to know status of transfer */
1578 enum referstatus {
1579         REFER_IDLE,                    /*!< No REFER is in progress */
1580         REFER_SENT,                    /*!< Sent REFER to transferee */
1581         REFER_RECEIVED,                /*!< Received REFER from transferrer */
1582         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING (unused) */
1583         REFER_ACCEPTED,                /*!< Accepted by transferee */
1584         REFER_RINGING,                 /*!< Target Ringing */
1585         REFER_200OK,                   /*!< Answered by transfer target */
1586         REFER_FAILED,                  /*!< REFER declined - go on */
1587         REFER_NOAUTH                   /*!< We had no auth for REFER */
1588 };
1589
1590 /*! \brief generic struct to map between strings and integers.
1591  * Fill it with x-s pairs, terminate with an entry with s = NULL;
1592  * Then you can call map_x_s(...) to map an integer to a string,
1593  * and map_s_x() for the string -> integer mapping.
1594  */
1595 struct _map_x_s {
1596         int x;
1597         const char *s;
1598 };
1599
1600 static const struct _map_x_s referstatusstrings[] = {
1601         { REFER_IDLE,           "<none>" },
1602         { REFER_SENT,           "Request sent" },
1603         { REFER_RECEIVED,       "Request received" },
1604         { REFER_CONFIRMED,      "Confirmed" },
1605         { REFER_ACCEPTED,       "Accepted" },
1606         { REFER_RINGING,        "Target ringing" },
1607         { REFER_200OK,          "Done" },
1608         { REFER_FAILED,         "Failed" },
1609         { REFER_NOAUTH,         "Failed - auth failure" },
1610         { -1,                   NULL} /* terminator */
1611 };
1612
1613 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed
1614         \note OEJ: Should be moved to string fields */
1615 struct sip_refer {
1616         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
1617         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
1618         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
1619         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
1620         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
1621         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
1622         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
1623         char replaces_callid[SIPBUFSIZE];                       /*!< Replace info: callid */
1624         char replaces_callid_totag[SIPBUFSIZE/2];               /*!< Replace info: to-tag */
1625         char replaces_callid_fromtag[SIPBUFSIZE/2];             /*!< Replace info: from-tag */
1626         struct sip_pvt *refer_call;                     /*!< Call we are referring. This is just a reference to a
1627                                                          * dialog owned by someone else, so we should not destroy
1628                                                          * it when the sip_refer object goes.
1629                                                          */
1630         int attendedtransfer;                           /*!< Attended or blind transfer? */
1631         int localtransfer;                              /*!< Transfer to local domain? */
1632         enum referstatus status;                        /*!< REFER status */
1633 };
1634
1635
1636 /*! \brief Structure that encapsulates all attributes related to running
1637  *   SIP Session-Timers feature on a per dialog basis.
1638  */
1639 struct sip_st_dlg {
1640         int st_active;                          /*!< Session-Timers on/off */
1641         int st_interval;                        /*!< Session-Timers negotiated session refresh interval */
1642         int st_schedid;                         /*!< Session-Timers ast_sched scheduler id */
1643         enum st_refresher st_ref;               /*!< Session-Timers session refresher */
1644         int st_expirys;                         /*!< Session-Timers number of expirys */
1645         int st_active_peer_ua;                  /*!< Session-Timers on/off in peer UA */
1646         int st_cached_min_se;                   /*!< Session-Timers cached Min-SE */
1647         int st_cached_max_se;                   /*!< Session-Timers cached Session-Expires */
1648         enum st_mode st_cached_mode;            /*!< Session-Timers cached M.O. */
1649         enum st_refresher st_cached_ref;        /*!< Session-Timers cached refresher */
1650 };
1651
1652
1653 /*! \brief Structure that encapsulates all attributes related to configuration
1654  *   of SIP Session-Timers feature on a per user/peer basis.
1655  */
1656 struct sip_st_cfg {
1657         enum st_mode st_mode_oper;      /*!< Mode of operation for Session-Timers           */
1658         enum st_refresher st_ref;       /*!< Session-Timer refresher                        */
1659         int st_min_se;                  /*!< Lowest threshold for session refresh interval  */
1660         int st_max_se;                  /*!< Highest threshold for session refresh interval */
1661 };
1662
1663 struct offered_media {
1664         int offered;
1665         char text[128];
1666 };
1667
1668 /*! \brief Structure used for each SIP dialog, ie. a call, a registration, a subscribe.
1669  * Created and initialized by sip_alloc(), the descriptor goes into the list of
1670  * descriptors (dialoglist).
1671  */
1672 struct sip_pvt {
1673         struct sip_pvt *next;                   /*!< Next dialog in chain */
1674         enum invitestates invitestate;          /*!< Track state of SIP_INVITEs */
1675         int method;                             /*!< SIP method that opened this dialog */
1676         AST_DECLARE_STRING_FIELDS(
1677                 AST_STRING_FIELD(callid);       /*!< Global CallID */
1678                 AST_STRING_FIELD(randdata);     /*!< Random data */
1679                 AST_STRING_FIELD(accountcode);  /*!< Account code */
1680                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1681                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1682                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1683                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1684                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1685                 AST_STRING_FIELD(from);         /*!< The From: header */
1686                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
1687                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
1688                 AST_STRING_FIELD(context);      /*!< Context for this call */
1689                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
1690                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
1691                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
1692                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
1693                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
1694                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
1695                 AST_STRING_FIELD(todnid);       /*!< DNID of this call (overrides host) */
1696                 AST_STRING_FIELD(language);     /*!< Default language for this call */
1697                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
1698                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
1699                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
1700                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
1701                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
1702                 AST_STRING_FIELD(username);     /*!< [user] name */
1703                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
1704                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
1705                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
1706                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
1707                 AST_STRING_FIELD(peersecret);   /*!< Password */
1708                 AST_STRING_FIELD(peermd5secret);
1709                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
1710                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
1711                 AST_STRING_FIELD(mwi_from); /*!< Name to place in the From header in outgoing NOTIFY requests */
1712                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
1713                         /* we only store the part in <brackets> in this field. */
1714                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
1715                 AST_STRING_FIELD(url);          /*!< URL to be sent with next message to peer */
1716                 AST_STRING_FIELD(parkinglot);           /*!< Parkinglot */
1717                 AST_STRING_FIELD(engine);       /*!< RTP engine to use */
1718         );
1719         char via[128];                          /*!< Via: header */
1720         struct sip_socket socket;               /*!< The socket used for this dialog */
1721         unsigned int ocseq;                     /*!< Current outgoing seqno */
1722         unsigned int icseq;                     /*!< Current incoming seqno */
1723         ast_group_t callgroup;                  /*!< Call group */
1724         ast_group_t pickupgroup;                /*!< Pickup group */
1725         int lastinvite;                         /*!< Last Cseq of invite */
1726         struct ast_flags flags[2];              /*!< SIP_ flags */
1727
1728         /* boolean flags that don't belong in flags */
1729         unsigned short do_history:1;            /*!< Set if we want to record history */
1730         unsigned short alreadygone:1;           /*!< already destroyed by our peer */
1731         unsigned short needdestroy:1;           /*!< need to be destroyed by the monitor thread */
1732         unsigned short outgoing_call:1;         /*!< this is an outgoing call */
1733         unsigned short answered_elsewhere:1;    /*!< This call is cancelled due to answer on another channel */
1734         unsigned short novideo:1;               /*!< Didn't get video in invite, don't offer */
1735         unsigned short notext:1;                /*!< Text not supported  (?) */
1736         unsigned short session_modify:1;        /*!< Session modification request true/false  */
1737         unsigned short route_persistent:1;      /*!< Is this the "real" route? */
1738         unsigned short autoframing:1;           /*!< Whether to use our local configuration for frame sizes (off)
1739                                                  *   or respect the other endpoint's request for frame sizes (on)
1740                                                  *   for incoming calls
1741                                                  */
1742         char tag[11];                           /*!< Our tag for this session */
1743         int timer_t1;                           /*!< SIP timer T1, ms rtt */
1744         int timer_b;                            /*!< SIP timer B, ms */
1745         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
1746         unsigned int reqsipoptions;             /*!< Required SIP options on the other end */
1747         struct ast_codec_pref prefs;            /*!< codec prefs */
1748         int capability;                         /*!< Special capability (codec) */
1749         int jointcapability;                    /*!< Supported capability at both ends (codecs) */
1750         int peercapability;                     /*!< Supported peer capability */
1751         int prefcodec;                          /*!< Preferred codec (outbound only) */
1752         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
1753         int jointnoncodeccapability;            /*!< Joint Non codec capability */
1754         int redircodecs;                        /*!< Redirect codecs */
1755         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */
1756         int request_queue_sched_id;             /*!< Scheduler ID of any scheduled action to process queued requests */
1757         int provisional_keepalive_sched_id; /*!< Scheduler ID for provisional responses that need to be sent out to avoid cancellation */
1758         const char *last_provisional;   /*!< The last successfully transmitted provisonal response message */
1759         int authtries;                          /*!< Times we've tried to authenticate */
1760         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this dialog. Use ref_proxy to set this instead of setting it directly*/
1761         struct t38properties t38;               /*!< T38 settings */
1762         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
1763         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
1764         int callingpres;                        /*!< Calling presentation */
1765         int expiry;                             /*!< How long we take to expire */
1766         int sessionversion;                     /*!< SDP Session Version */
1767         int sessionid;                          /*!< SDP Session ID */
1768         long branch;                            /*!< The branch identifier of this session */
1769         long invite_branch;                     /*!< The branch used when we sent the initial INVITE */
1770         int64_t sessionversion_remote;          /*!< Remote UA's SDP Session Version */
1771         struct sockaddr_in sa;                  /*!< Our peer */
1772         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
1773         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
1774         struct sockaddr_in tredirip;            /*!< Where our Text RTP should be going if not to us */
1775         time_t lastrtprx;                       /*!< Last RTP received */
1776         time_t lastrtptx;                       /*!< Last RTP sent */
1777         int rtptimeout;                         /*!< RTP timeout time */
1778         struct sockaddr_in recv;                /*!< Received as */
1779         struct sockaddr_in ourip;               /*!< Our IP (as seen from the outside) */
1780         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
1781         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
1782         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
1783         struct ast_variable *notify_headers;    /*!< Custom notify type */
1784         struct sip_auth *peerauth;              /*!< Realm authentication */
1785         int noncecount;                         /*!< Nonce-count */
1786         unsigned int stalenonce:1;      /*!< Marks the current nonce as responded too */
1787         char lastmsg[256];                      /*!< Last Message sent/received */
1788         int amaflags;                           /*!< AMA Flags */
1789         int pendinginvite;                      /*!< Any pending INVITE or state NOTIFY (in subscribe pvt's) ? (seqno of this) */
1790         int glareinvite;                        /*!< A invite received while a pending invite is already present is stored here.  Its seqno is the
1791                                                 value. Since this glare invite's seqno is not the same as the pending invite's, it must be
1792                                                 held in order to properly process acknowledgements for our 491 response. */
1793         struct sip_request initreq;             /*!< Latest request that opened a new transaction
1794                                                         within this dialog.
1795                                                         NOT the request that opened the dialog */
1796
1797         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
1798         int waitid;                             /*!< Wait ID for scheduler after 491 or other delays */
1799         int autokillid;                         /*!< Auto-kill ID (scheduler) */
1800         int t38id;                              /*!< T.38 Response ID */
1801         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
1802         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
1803         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
1804         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
1805         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
1806
1807         struct ast_dsp *dsp;                    /*!< Inband DTMF Detection dsp */
1808
1809         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one
1810                                                         Used in peerpoke, mwi subscriptions */
1811         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
1812         struct ast_rtp_instance *rtp;                   /*!< RTP Session */
1813         struct ast_rtp_instance *vrtp;                  /*!< Video RTP session */
1814         struct ast_rtp_instance *trtp;                  /*!< Text RTP session */
1815         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
1816         struct sip_history_head *history;       /*!< History of this SIP dialog */
1817         size_t history_entries;                 /*!< Number of entires in the history */
1818         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
1819         AST_LIST_HEAD_NOLOCK(request_queue, sip_request) request_queue; /*!< Requests that arrived but could not be processed immediately */
1820         struct sip_invite_param *options;       /*!< Options for INVITE */
1821         struct sip_st_dlg *stimer;              /*!< SIP Session-Timers */
1822
1823         int red;                                /*!< T.140 RTP Redundancy */
1824         int hangupcause;                        /*!< Storage of hangupcause copied from our owner before we disconnect from the AST channel (only used at hangup) */
1825
1826         struct sip_subscription_mwi *mwi;       /*!< If this is a subscription MWI dialog, to which subscription */
1827         /*! The SIP methods supported by this peer. We get this information from the Allow header of the first
1828          * message we receive from an endpoint during a dialog.
1829          */
1830         unsigned int allowed_methods;
1831         /*! Some peers are not trustworthy with their Allow headers, and so we need to override their wicked
1832          * ways through configuration. This is a copy of the peer's disallowed_methods, so that we can apply them
1833          * to the sip_pvt at various stages of dialog establishment
1834          */
1835         unsigned int disallowed_methods;
1836         /*! When receiving an SDP offer, it is important to take note of what media types were offered.
1837          * By doing this, even if we don't want to answer a particular media stream with something meaningful, we can
1838          * still put an m= line in our answer with the port set to 0.
1839          *
1840          * The reason for the length being 4 is that in this branch of Asterisk, the only media types supported are
1841          * image, audio, text, and video. Therefore we need to keep track of which types of media were offered.
1842          *
1843          * Note that if we wanted to be 100% correct, we would keep a list of all media streams offered. That way we could respond
1844          * even to unknown media types, and we could respond to multiple streams of the same type. Such large-scale changes
1845          * are not a good idea for released branches, though, so we're compromising by just making sure that for the common cases:
1846          * audio and video, audio and T.38, and audio and text, we give the appropriate response to both media streams.
1847          *
1848          * The large-scale changes would be a good idea for implementing during an SDP rewrite.
1849          */
1850         struct offered_media offered_media[4];
1851 };
1852
1853
1854 /*! \brief
1855  * Here we implement the container for dialogs (sip_pvt), defining
1856  * generic wrapper functions to ease the transition from the current
1857  * implementation (a single linked list) to a different container.
1858  * In addition to a reference to the container, we need functions to lock/unlock
1859  * the container and individual items, and functions to add/remove
1860  * references to the individual items.
1861  */
1862 static struct ao2_container *dialogs;
1863
1864 #define sip_pvt_lock(x) ao2_lock(x)
1865 #define sip_pvt_trylock(x) ao2_trylock(x)
1866 #define sip_pvt_unlock(x) ao2_unlock(x)
1867
1868 /*! \brief
1869  * when we create or delete references, make sure to use these
1870  * functions so we keep track of the refcounts.
1871  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1872  */
1873 #ifdef REF_DEBUG
1874 #define dialog_ref(arg1,arg2) dialog_ref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1875 #define dialog_unref(arg1,arg2) dialog_unref_debug((arg1),(arg2), __FILE__, __LINE__, __PRETTY_FUNCTION__)
1876
1877 static struct sip_pvt *dialog_ref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1878 {
1879         if (p)
1880                 _ao2_ref_debug(p, 1, tag, file, line, func);
1881         else
1882                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1883         return p;
1884 }
1885
1886 static struct sip_pvt *dialog_unref_debug(struct sip_pvt *p, char *tag, char *file, int line, const char *func)
1887 {
1888         if (p)
1889                 _ao2_ref_debug(p, -1, tag, file, line, func);
1890         return NULL;
1891 }
1892 #else
1893 static struct sip_pvt *dialog_ref(struct sip_pvt *p, char *tag)
1894 {
1895         if (p)
1896                 ao2_ref(p, 1);
1897         else
1898                 ast_log(LOG_ERROR, "Attempt to Ref a null pointer\n");
1899         return p;
1900 }
1901
1902 static struct sip_pvt *dialog_unref(struct sip_pvt *p, char *tag)
1903 {
1904         if (p)
1905                 ao2_ref(p, -1);
1906         return NULL;
1907 }
1908 #endif
1909
1910 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission
1911  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1912  * Each packet holds a reference to the parent struct sip_pvt.
1913  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1914  * require retransmissions.
1915  */
1916 struct sip_pkt {
1917         struct sip_pkt *next;                   /*!< Next packet in linked list */
1918         int retrans;                            /*!< Retransmission number */
1919         int method;                             /*!< SIP method for this packet */
1920         int seqno;                              /*!< Sequence number */
1921         char is_resp;                           /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1922         char is_fatal;                          /*!< non-zero if there is a fatal error */
1923         int response_code;              /*!< If this is a response, the response code */
1924         struct sip_pvt *owner;                  /*!< Owner AST call */
1925         int retransid;                          /*!< Retransmission ID */
1926         int timer_a;                            /*!< SIP timer A, retransmission timer */
1927         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1928         int packetlen;                          /*!< Length of packet */
1929         struct ast_str *data;
1930 };
1931
1932 /*!
1933  * \brief A peer's mailbox
1934  *
1935  * We could use STRINGFIELDS here, but for only two strings, it seems like
1936  * too much effort ...
1937  */
1938 struct sip_mailbox {
1939         char *mailbox;
1940         char *context;
1941         /*! Associated MWI subscription */
1942         struct ast_event_sub *event_sub;
1943         AST_LIST_ENTRY(sip_mailbox) entry;
1944 };
1945
1946 enum sip_peer_type {
1947         SIP_TYPE_PEER = (1 << 0),
1948         SIP_TYPE_USER = (1 << 1),
1949 };
1950
1951 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host)
1952 */
1953 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail, as will astobj2 hashing of the structure */
1954 struct sip_peer {
1955         char name[80];                                  /*!< the unique name of this object */
1956         AST_DECLARE_STRING_FIELDS(
1957                 AST_STRING_FIELD(secret);               /*!< Password for inbound auth */
1958                 AST_STRING_FIELD(md5secret);            /*!< Password in MD5 */
1959                 AST_STRING_FIELD(remotesecret);         /*!< Remote secret (trunks, remote devices) */
1960                 AST_STRING_FIELD(context);              /*!< Default context for incoming calls */
1961                 AST_STRING_FIELD(subscribecontext);     /*!< Default context for subscriptions */
1962                 AST_STRING_FIELD(username);             /*!< Temporary username until registration */
1963                 AST_STRING_FIELD(accountcode);          /*!< Account code */
1964                 AST_STRING_FIELD(tohost);               /*!< If not dynamic, IP address */
1965                 AST_STRING_FIELD(regexten);             /*!< Extension to register (if regcontext is used) */
1966                 AST_STRING_FIELD(fromuser);             /*!< From: user when calling this peer */
1967                 AST_STRING_FIELD(fromdomain);           /*!< From: domain when calling this peer */
1968                 AST_STRING_FIELD(fullcontact);          /*!< Contact registered with us (not in sip.conf) */
1969                 AST_STRING_FIELD(cid_num);              /*!< Caller ID num */
1970                 AST_STRING_FIELD(cid_name);             /*!< Caller ID name */
1971                 AST_STRING_FIELD(vmexten);              /*!< Dialplan extension for MWI notify message*/
1972                 AST_STRING_FIELD(language);             /*!<  Default language for prompts */
1973                 AST_STRING_FIELD(mohinterpret);         /*!<  Music on Hold class */
1974                 AST_STRING_FIELD(mohsuggest);           /*!<  Music on Hold class */
1975                 AST_STRING_FIELD(parkinglot);           /*!<  Parkinglot */
1976                 AST_STRING_FIELD(useragent);            /*!<  User agent in SIP request (saved from registration) */
1977                 AST_STRING_FIELD(mwi_from);         /*!< Name to place in From header for outgoing NOTIFY requests */
1978                 AST_STRING_FIELD(engine);               /*!<  RTP Engine to use */
1979                 );
1980         struct sip_socket socket;       /*!< Socket used for this peer */
1981         enum sip_transport default_outbound_transport;    /*!< Peer Registration may change the default outbound transport.
1982                                                             If register expires, default should be reset. to this value */
1983         /* things that don't belong in flags */
1984         unsigned short transports:3;    /*!< Transports (enum sip_transport) that are acceptable for this peer */
1985         unsigned short is_realtime:1;   /*!< this is a 'realtime' peer */
1986         unsigned short rt_fromcontact:1;/*!< copy fromcontact from realtime */
1987         unsigned short host_dynamic:1;  /*!< Dynamic Peers register with Asterisk */
1988         unsigned short selfdestruct:1;  /*!< Automatic peers need to destruct themselves */
1989         unsigned short the_mark:1;      /*!< moved out of ASTOBJ into struct proper; That which bears the_mark should be deleted! */
1990         unsigned short autoframing:1;   /*!< Whether to use our local configuration for frame sizes (off)
1991                                          *   or respect the other endpoint's request for frame sizes (on)
1992                                          *   for incoming calls
1993                                          */
1994         struct sip_auth *auth;          /*!< Realm authentication list */
1995         int amaflags;                   /*!< AMA Flags (for billing) */
1996         int callingpres;                /*!< Calling id presentation */
1997         int inUse;                      /*!< Number of calls in use */
1998         int inRinging;                  /*!< Number of calls ringing */
1999         int onHold;                     /*!< Peer has someone on hold */
2000         int call_limit;                 /*!< Limit of concurrent calls */
2001         int busy_level;                 /*!< Level of active channels where we signal busy */
2002         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
2003         struct ast_codec_pref prefs;    /*!<  codec prefs */
2004         int lastmsgssent;
2005         unsigned int sipoptions;        /*!<  Supported SIP options */
2006         struct ast_flags flags[2];      /*!<  SIP_ flags */
2007
2008         /*! Mailboxes that this peer cares about */
2009         AST_LIST_HEAD_NOLOCK(, sip_mailbox) mailboxes;
2010
2011         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
2012         int expire;                     /*!<  When to expire this peer registration */
2013         int capability;                 /*!<  Codec capability */
2014         int rtptimeout;                 /*!<  RTP timeout */
2015         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
2016         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
2017         ast_group_t callgroup;          /*!<  Call group */
2018         ast_group_t pickupgroup;        /*!<  Pickup group */
2019         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
2020         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
2021         struct sockaddr_in addr;        /*!<  IP address of peer */
2022         /* Qualification */
2023         struct sip_pvt *call;           /*!<  Call pointer */
2024         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
2025         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
2026         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
2027         int qualifyfreq;                /*!<  Qualification: How often to check for the host to be up */
2028         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
2029         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
2030         struct ast_ha *ha;              /*!<  Access control list */
2031         struct ast_ha *contactha;       /*!<  Restrict what IPs are allowed in the Contact header (for registration) */
2032         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
2033         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
2034         struct sip_st_cfg stimer;       /*!<  SIP Session-Timers */
2035         int timer_t1;                   /*!<  The maximum T1 value for the peer */
2036         int timer_b;                    /*!<  The maximum timer B (transaction timeouts) */
2037         int deprecated_username; /*!< If it's a realtime peer, are they using the deprecated "username" instead of "defaultuser" */
2038
2039         /*XXX Seems like we suddenly have two flags with the same content. Why? To be continued... */
2040         enum sip_peer_type type; /*!< Distinguish between "user" and "peer" types. This is used solely for CLI and manager commands */
2041         unsigned int disallowed_methods;
2042 };
2043
2044
2045 /*!
2046  * \brief Registrations with other SIP proxies
2047  *
2048  * Created by sip_register(), the entry is linked in the 'regl' list,
2049  * and never deleted (other than at 'sip reload' or module unload times).
2050  * The entry always has a pending timeout, either waiting for an ACK to
2051  * the REGISTER message (in which case we have to retransmit the request),
2052  * or waiting for the next REGISTER message to be sent (either the initial one,
2053  * or once the previously completed registration one expires).
2054  * The registration can be in one of many states, though at the moment
2055  * the handling is a bit mixed.
2056  */
2057 struct sip_registry {
2058         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
2059         AST_DECLARE_STRING_FIELDS(
2060                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
2061                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
2062                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
2063                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
2064                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
2065                 AST_STRING_FIELD(authdomain);   /*!< Authorization domain */
2066                 AST_STRING_FIELD(regdomain);    /*!< Registration domain */
2067                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
2068                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
2069                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
2070                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
2071                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
2072                 AST_STRING_FIELD(callback);     /*!< Contact extension */
2073                 AST_STRING_FIELD(random);
2074                 AST_STRING_FIELD(peername);     /*!< Peer registering to */
2075         );
2076         enum sip_transport transport;   /*!< Transport for this registration UDP, TCP or TLS */
2077         int portno;                     /*!<  Optional port override */
2078         int expire;                     /*!< Sched ID of expiration */
2079         int configured_expiry;          /*!< Configured value to use for the Expires header */
2080         int expiry;                     /*!< Negotiated value used for the Expires header */
2081         int regattempts;                /*!< Number of attempts (since the last success) */
2082         int timeout;                    /*!< sched id of sip_reg_timeout */
2083         int refresh;                    /*!< How often to refresh */
2084         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
2085         enum sipregistrystate regstate; /*!< Registration state (see above) */
2086         struct timeval regtime;         /*!< Last successful registration time */
2087         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
2088         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
2089         struct ast_dnsmgr_entry *dnsmgr;        /*!<  DNS refresh manager for register */
2090         struct sockaddr_in us;          /*!< Who the server thinks we are */
2091         int noncecount;                 /*!< Nonce-count */
2092         char lastmsg[256];              /*!< Last Message sent/received */
2093 };
2094
2095 /*! \brief Definition of a thread that handles a socket */
2096 struct sip_threadinfo {
2097         int stop;
2098         pthread_t threadid;
2099         struct ast_tcptls_session_instance *tcptls_session;
2100         enum sip_transport type;        /*!< We keep a copy of the type here so we can display it in the connection list */
2101         AST_LIST_ENTRY(sip_threadinfo) list;
2102 };
2103
2104 /*! \brief Definition of an MWI subscription to another server */
2105 struct sip_subscription_mwi {
2106         ASTOBJ_COMPONENTS_FULL(struct sip_subscription_mwi,1,1);
2107         AST_DECLARE_STRING_FIELDS(
2108                 AST_STRING_FIELD(username);     /*!< Who we are sending the subscription as */
2109                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
2110                 AST_STRING_FIELD(hostname);     /*!< Domain or host we subscribe to */
2111                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
2112                 AST_STRING_FIELD(mailbox);      /*!< Mailbox store to put MWI into */
2113                 );
2114         enum sip_transport transport;    /*!< Transport to use */
2115         int portno;                      /*!< Optional port override */
2116         int resub;                       /*!< Sched ID of resubscription */
2117         unsigned int subscribed:1;       /*!< Whether we are currently subscribed or not */
2118         struct sip_pvt *call;            /*!< Outbound subscription dialog */
2119         struct ast_dnsmgr_entry *dnsmgr; /*!< DNS refresh manager for subscription */
2120         struct sockaddr_in us;           /*!< Who the server thinks we are */
2121 };
2122
2123 /* --- Hash tables of various objects --------*/
2124
2125 #ifdef LOW_MEMORY
2126 static int hash_peer_size = 17;
2127 static int hash_dialog_size = 17;
2128 static int hash_user_size = 17;
2129 #else
2130 static int hash_peer_size = 563;        /*!< Size of peer hash table, prime number preferred! */
2131 static int hash_dialog_size = 563;
2132 static int hash_user_size = 563;
2133 #endif
2134
2135 /*! \brief  The thread list of TCP threads */
2136 static AST_LIST_HEAD_STATIC(threadl, sip_threadinfo);
2137
2138 /*! \brief  The peer list: Users, Peers and Friends */
2139 static struct ao2_container *peers;
2140 static struct ao2_container *peers_by_ip;
2141
2142 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
2143 static struct ast_register_list {
2144         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
2145         int recheck;
2146 } regl;
2147
2148 /*! \brief  The MWI subscription list */
2149 static struct ast_subscription_mwi_list {
2150         ASTOBJ_CONTAINER_COMPONENTS(struct sip_subscription_mwi);
2151 } submwil;
2152
2153 /*! \brief
2154  * \note The only member of the peer used here is the name field
2155  */
2156 static int peer_hash_cb(const void *obj, const int flags)
2157 {
2158         const struct sip_peer *peer = obj;
2159
2160         return ast_str_case_hash(peer->name);
2161 }
2162
2163 /*!
2164  * \note The only member of the peer used here is the name field
2165  */
2166 static int peer_cmp_cb(void *obj, void *arg, int flags)
2167 {
2168         struct sip_peer *peer = obj, *peer2 = arg;
2169
2170         return !strcasecmp(peer->name, peer2->name) ? CMP_MATCH | CMP_STOP : 0;
2171 }
2172
2173 /*!
2174  * \note the peer's ip address field is used to create key.
2175  */
2176 static int peer_iphash_cb(const void *obj, const int flags)
2177 {
2178         const struct sip_peer *peer = obj;
2179         int ret1 = peer->addr.sin_addr.s_addr;
2180         if (ret1 < 0)
2181                 ret1 = -ret1;
2182
2183         return ret1;
2184 }
2185
2186 /*!
2187  * Match Peers by IP and Port number.
2188  *
2189  * This function has two modes.
2190  *  - If the peer arg does not have INSECURE_PORT set, then we will only return
2191  *    a match for a peer that matches both the IP and port.
2192  *  - If the peer arg does have the INSECURE_PORT flag set, then we will only
2193  *    return a match for a peer that matches the IP and has insecure=port
2194  *    in its configuration.
2195  *
2196  * This callback will be used twice when doing peer matching.  There is a first
2197  * pass for full IP+port matching, and a second pass in case there is a match
2198  * that meets the insecure=port criteria.
2199  *
2200  * \note Connections coming in over TCP or TLS should never be matched by port.
2201  *
2202  * \note the peer's addr struct provides to fields combined to make a key: the sin_addr.s_addr and sin_port fields.
2203  */
2204 static int peer_ipcmp_cb(void *obj, void *arg, int flags)
2205 {
2206         struct sip_peer *peer = obj, *peer2 = arg;
2207
2208         if (peer->addr.sin_addr.s_addr != peer2->addr.sin_addr.s_addr) {
2209                 /* IP doesn't match */
2210                 return 0;
2211         }
2212
2213         /* We matched the IP, check to see if we need to match by port as well. */
2214         if ((peer->transports & peer2->transports) & (SIP_TRANSPORT_TLS | SIP_TRANSPORT_TCP)) {
2215                 /* peer matching on port is not possible with TCP/TLS */
2216                 return CMP_MATCH | CMP_STOP;
2217         } else if (ast_test_flag(&peer2->flags[0], SIP_INSECURE_PORT)) {
2218                 /* We are allowing match without port for peers configured that
2219                  * way in this pass through the peers. */
2220                 return ast_test_flag(&peer->flags[0], SIP_INSECURE_PORT) ?
2221                                 (CMP_MATCH | CMP_STOP) : 0;
2222         }
2223
2224         /* Now only return a match if the port matches, as well. */
2225         return peer->addr.sin_port == peer2->addr.sin_port ? (CMP_MATCH | CMP_STOP) : 0;
2226 }
2227
2228 /*!
2229  * \note The only member of the dialog used here callid string
2230  */
2231 static int dialog_hash_cb(const void *obj, const int flags)
2232 {
2233         const struct sip_pvt *pvt = obj;
2234
2235         return ast_str_case_hash(pvt->callid);
2236 }
2237
2238 /*!
2239  * \note The only member of the dialog used here callid string
2240  */
2241 static int dialog_cmp_cb(void *obj, void *arg, int flags)
2242 {
2243         struct sip_pvt *pvt = obj, *pvt2 = arg;
2244
2245         return !strcasecmp(pvt->callid, pvt2->callid) ? CMP_MATCH | CMP_STOP : 0;
2246 }
2247
2248 static int temp_pvt_init(void *);
2249 static void temp_pvt_cleanup(void *);
2250
2251 /*! \brief A per-thread temporary pvt structure */
2252 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
2253
2254 #ifdef LOW_MEMORY
2255 static void ts_ast_rtp_destroy(void *);
2256
2257 AST_THREADSTORAGE_CUSTOM(ts_audio_rtp, NULL, ts_ast_rtp_destroy);
2258 AST_THREADSTORAGE_CUSTOM(ts_video_rtp, NULL, ts_ast_rtp_destroy);
2259 AST_THREADSTORAGE_CUSTOM(ts_text_rtp, NULL, ts_ast_rtp_destroy);
2260 #endif
2261
2262 /*! \brief Authentication list for realm authentication
2263  * \todo Move the sip_auth list to AST_LIST */
2264 static struct sip_auth *authl = NULL;
2265
2266
2267 /* --- Sockets and networking --------------*/
2268
2269 /*! \brief Main socket for UDP SIP communication.
2270  *
2271  * sipsock is shared between the SIP manager thread (which handles reload
2272  * requests), the udp io handler (sipsock_read()) and the user routines that
2273  * issue udp writes (using __sip_xmit()).
2274  * The socket is -1 only when opening fails (this is a permanent condition),
2275  * or when we are handling a reload() that changes its address (this is
2276  * a transient situation during which we might have a harmless race, see
2277  * below). Because the conditions for the race to be possible are extremely
2278  * rare, we don't want to pay the cost of locking on every I/O.
2279  * Rather, we remember that when the race may occur, communication is
2280  * bound to fail anyways, so we just live with this event and let
2281  * the protocol handle this above us.
2282  */
2283 static int sipsock  = -1;
2284
2285 static struct sockaddr_in bindaddr;     /*!< UDP: The address we bind to */
2286
2287 /*! \brief our (internal) default address/port to put in SIP/SDP messages
2288  *  internip is initialized picking a suitable address from one of the
2289  * interfaces, and the same port number we bind to. It is used as the
2290  * default address/port in SIP messages, and as the default address
2291  * (but not port) in SDP messages.
2292  */
2293 static struct sockaddr_in internip;
2294
2295 /*! \brief our external IP address/port for SIP sessions.
2296  * externip.sin_addr is only set when we know we might be behind
2297  * a NAT, and this is done using a variety of (mutually exclusive)
2298  * ways from the config file:
2299  *
2300  * + with "externip = host[:port]" we specify the address/port explicitly.
2301  *   The address is looked up only once when (re)loading the config file;
2302  *
2303  * + with "externhost = host[:port]" we do a similar thing, but the
2304  *   hostname is stored in externhost, and the hostname->IP mapping
2305  *   is refreshed every 'externrefresh' seconds;
2306  *
2307  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
2308  *   to the specified server, and store the result in externip.
2309  *
2310  * Other variables (externhost, externexpire, externrefresh) are used
2311  * to support the above functions.
2312  */
2313 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
2314
2315 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
2316 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
2317 static int externrefresh = 10;
2318 static struct sockaddr_in stunaddr;             /*!< stun server address */
2319
2320 /*! \brief  List of local networks
2321  * We store "localnet" addresses from the config file into an access list,
2322  * marked as 'DENY', so the call to ast_apply_ha() will return
2323  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
2324  * (i.e. presumably public) addresses.
2325  */
2326 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
2327
2328 static int ourport_tcp;                         /*!< The port used for TCP connections */
2329 static int ourport_tls;                         /*!< The port used for TCP/TLS connections */
2330 static struct sockaddr_in debugaddr;
2331
2332 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
2333
2334 /*! some list management macros. */
2335
2336 #define UNLINK(element, head, prev) do {        \
2337         if (prev)                               \
2338                 (prev)->next = (element)->next; \
2339         else                                    \
2340                 (head) = (element)->next;       \
2341         } while (0)
2342
2343 enum t38_action_flag {
2344         SDP_T38_NONE = 0, /*!< Do not modify T38 information at all */
2345         SDP_T38_INITIATE, /*!< Remote side has requested T38 with us */
2346         SDP_T38_ACCEPT,   /*!< Remote side accepted our T38 request */
2347 };
2348
2349 /*---------------------------- Forward declarations of functions in chan_sip.c */
2350 /* Note: This is added to help splitting up chan_sip.c into several files
2351         in coming releases. */
2352
2353 /*--- PBX interface functions */
2354 static struct ast_channel *sip_request_call(const char *type, int format, const struct ast_channel *requestor, void *data, int *cause);
2355 static int sip_devicestate(void *data);
2356 static int sip_sendtext(struct ast_channel *ast, const char *text);
2357 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
2358 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
2359 static int sip_hangup(struct ast_channel *ast);
2360 static int sip_answer(struct ast_channel *ast);
2361 static struct ast_frame *sip_read(struct ast_channel *ast);
2362 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
2363 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
2364 static int sip_transfer(struct ast_channel *ast, const char *dest);
2365 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
2366 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
2367 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
2368 static int sip_setoption(struct ast_channel *chan, int option, void *data, int datalen);
2369 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
2370 static const char *sip_get_callid(struct ast_channel *chan);
2371
2372 static int handle_request_do(struct sip_request *req, struct sockaddr_in *sin);
2373 static int sip_standard_port(enum sip_transport type, int port);
2374 static int sip_prepare_socket(struct sip_pvt *p);
2375 static int sip_parse_host(char *line, int lineno, char **hostname, int *portnum, enum sip_transport *transport);
2376
2377 /*--- Transmitting responses and requests */
2378 static int sipsock_read(int *id, int fd, short events, void *ignore);
2379 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len);
2380 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod);
2381 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
2382 static int retrans_pkt(const void *data);
2383 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);
2384 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2385 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2386 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
2387 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);
2388 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
2389 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);
2390 static int transmit_provisional_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, int with_sdp);
2391 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
2392 static void transmit_fake_auth_response(struct sip_pvt *p, int sipmethod, struct sip_request *req, enum xmittype reliable);
2393 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
2394 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
2395 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
2396 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
2397 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
2398 static int transmit_info_with_vidupdate(struct sip_pvt *p);
2399 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
2400 static int transmit_refer(struct sip_pvt *p, const char *dest);
2401 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, const char *vmexten);
2402 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
2403 static int transmit_notify_custom(struct sip_pvt *p, struct ast_variable *vars);
2404 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
2405 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
2406 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
2407 static void copy_request(struct sip_request *dst, const struct sip_request *src);
2408 static void receive_message(struct sip_pvt *p, struct sip_request *req);
2409 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req, char **name, char **number, int set_call_forward);
2410 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
2411
2412 /*--- Dialog management */
2413 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
2414                                  int useglobal_nat, const int intended_method, struct sip_request *req);
2415 static int __sip_autodestruct(const void *data);
2416 static void sip_scheddestroy(struct sip_pvt *p, int ms);
2417 static int sip_cancel_destroy(struct sip_pvt *p);
2418 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
2419 static void *dialog_unlink_all(struct sip_pvt *dialog, int lockowner, int lockdialoglist);
2420 static void *registry_unref(struct sip_registry *reg, char *tag);
2421 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
2422 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
2423 static void __sip_pretend_ack(struct sip_pvt *p);
2424 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
2425 static int auto_congest(const void *arg);
2426 static int update_call_counter(struct sip_pvt *fup, int event);
2427 static int hangup_sip2cause(int cause);
2428 static const char *hangup_cause2sip(int cause);
2429 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
2430 static void free_old_route(struct sip_route *route);
2431 static void list_route(struct sip_route *route);
2432 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
2433 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
2434                                               struct sip_request *req, const char *uri);
2435 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
2436 static void check_pendings(struct sip_pvt *p);
2437 static void *sip_park_thread(void *stuff);
2438 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
2439 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
2440
2441 /*--- Codec handling / SDP */
2442 static void try_suggested_sip_codec(struct sip_pvt *p);
2443 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
2444 static const char *get_sdp(struct sip_request *req, const char *name);
2445 static int find_sdp(struct sip_request *req);
2446 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
2447 static void add_codec_to_sdp(const struct sip_pvt *p, int codec,
2448                              struct ast_str **m_buf, struct ast_str **a_buf,
2449                              int debug, int *min_packet_size);
2450 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format,
2451                                 struct ast_str **m_buf, struct ast_str **a_buf,
2452                                 int debug);
2453 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp, int add_audio, int add_t38);
2454 static void do_setnat(struct sip_pvt *p);
2455 static void stop_media_flows(struct sip_pvt *p);
2456
2457 /*--- Authentication stuff */
2458 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
2459 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
2460 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
2461                                          const char *secret, const char *md5secret, int sipmethod,
2462                                          const char *uri, enum xmittype reliable, int ignore);
2463 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
2464                                               int sipmethod, const char *uri, enum xmittype reliable,
2465                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
2466 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, const char *uri, enum xmittype reliable, struct sockaddr_in *sin);
2467
2468 /*--- Domain handling */
2469 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
2470 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
2471 static void clear_sip_domains(void);
2472
2473 /*--- SIP realm authentication */
2474 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
2475 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
2476 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
2477
2478 /*--- Misc functions */
2479 static void check_rtp_timeout(struct sip_pvt *dialog, time_t t);
2480 static int sip_do_reload(enum channelreloadreason reason);
2481 static int reload_config(enum channelreloadreason reason);
2482 static int expire_register(const void *data);
2483 static void *do_monitor(void *data);
2484 static int restart_monitor(void);
2485 static void peer_mailboxes_to_str(struct ast_str **mailbox_str, struct sip_peer *peer);
2486 static struct ast_variable *copy_vars(struct ast_variable *src);
2487 /* static int sip_addrcmp(char *name, struct sockaddr_in *sin); Support for peer matching */
2488 static int sip_refer_allocate(struct sip_pvt *p);
2489 static void ast_quiet_chan(struct ast_channel *chan);
2490 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
2491 static int do_magic_pickup(struct ast_channel *channel, const char *extension, const char *context);
2492
2493 /*!
2494  * \brief generic function for determining if a correct transport is being
2495  * used to contact a peer
2496  *
2497  * this is done as a macro so that the "tmpl" var can be passed either a
2498  * sip_request or a sip_peer
2499  */
2500 #define check_request_transport(peer, tmpl) ({ \
2501         int ret = 0; \
2502         if (peer->socket.type == tmpl->socket.type) \
2503                 ; \
2504         else if (!(peer->transports & tmpl->socket.type)) {\
2505                 ast_log(LOG_ERROR, \
2506                         "'%s' is not a valid transport for '%s'. we only use '%s'! ending call.\n", \
2507                         get_transport(tmpl->socket.type), peer->name, get_transport_list(peer->transports) \
2508                         ); \
2509                 ret = 1; \
2510         } else if (peer->socket.type & SIP_TRANSPORT_TLS) { \
2511                 ast_log(LOG_WARNING, \
2512                         "peer '%s' HAS NOT USED (OR SWITCHED TO) TLS in favor of '%s' (but this was allowed in sip.conf)!\n", \
2513                         peer->name, get_transport(tmpl->socket.type) \
2514                 ); \
2515         } else { \
2516                 ast_debug(1, \
2517                         "peer '%s' has contacted us over %s even though we prefer %s.\n", \
2518                         peer->name, get_transport(tmpl->socket.type), get_transport(peer->socket.type) \
2519                 ); \
2520         }\
2521         (ret); \
2522 })
2523
2524
2525 /*--- Device monitoring and Device/extension state/event handling */
2526 static int cb_extensionstate(char *context, char* exten, int state, void *data);
2527 static int sip_devicestate(void *data);
2528 static int sip_poke_noanswer(const void *data);
2529 static int sip_poke_peer(struct sip_peer *peer, int force);
2530 static void sip_poke_all_peers(void);
2531 static void sip_peer_hold(struct sip_pvt *p, int hold);
2532 static void mwi_event_cb(const struct ast_event *, void *);
2533
2534 /*--- Applications, functions, CLI and manager command helpers */
2535 static const char *sip_nat_mode(const struct sip_pvt *p);
2536 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2537 static char *transfermode2str(enum transfermodes mode) attribute_const;
2538 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
2539 static char *sip_show_sched(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2540 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2541 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2542 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2543 static void  print_group(int fd, ast_group_t group, int crlf);
2544 static const char *dtmfmode2str(int mode) attribute_const;
2545 static int str2dtmfmode(const char *str) attribute_unused;
2546 static const char *insecure2str(int mode) attribute_const;
2547 static void cleanup_stale_contexts(char *new, char *old);
2548 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
2549 static const char *domain_mode_to_text(const enum domain_mode mode);
2550 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2551 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2552 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2553 static char *_sip_qualify_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
2554 static char *sip_qualify_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2555 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2556 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2557 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2558 static char *sip_show_mwi(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2559 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
2560 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
2561 static char *complete_sip_peer(const char *word, int state, int flags2);
2562 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
2563 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
2564 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
2565 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
2566 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
2567 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2568 static char *sip_show_channelstats(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2569 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2570 static char *sip_do_debug_ip(int fd, const char *arg);
2571 static char *sip_do_debug_peer(int fd, const char *arg);
2572 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2573 static char *sip_cli_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2574 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2575 static int sip_dtmfmode(struct ast_channel *chan, const char *data);
2576 static int sip_addheader(struct ast_channel *chan, const char *data);
2577 static int sip_do_reload(enum channelreloadreason reason);
2578 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2579 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
2580
2581 /*--- Debugging
2582         Functions for enabling debug per IP or fully, or enabling history logging for
2583         a SIP dialog
2584 */
2585 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
2586 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
2587 static inline int sip_debug_test_pvt(struct sip_pvt *p);
2588
2589
2590 /*! \brief Append to SIP dialog history
2591         \return Always returns 0 */
2592 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
2593 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
2594 static void sip_dump_history(struct sip_pvt *dialog);
2595
2596 /*--- Device object handling */
2597 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
2598 static int update_call_counter(struct sip_pvt *fup, int event);
2599 static void sip_destroy_peer(struct sip_peer *peer);
2600 static void sip_destroy_peer_fn(void *peer);
2601 static void set_peer_defaults(struct sip_peer *peer);
2602 static struct sip_peer *temp_peer(const char *name);
2603 static void register_peer_exten(struct sip_peer *peer, int onoff);
2604 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime, int forcenamematch, int devstate_only, int transport);
2605 static int sip_poke_peer_s(const void *data);
2606 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
2607 static void reg_source_db(struct sip_peer *peer);
2608 static void destroy_association(struct sip_peer *peer);
2609 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
2610 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
2611 static void set_socket_transport(struct sip_socket *socket, int transport);
2612
2613 /* Realtime device support */
2614 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);
2615 static void update_peer(struct sip_peer *p, int expire);
2616 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
2617 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
2618 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin, int devstate_only);
2619 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
2620
2621 /*--- Internal UA client handling (outbound registrations) */
2622 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us, struct sip_pvt *p);
2623 static void sip_registry_destroy(struct sip_registry *reg);
2624 static int sip_register(const char *value, int lineno);
2625 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
2626 static int sip_reregister(const void *data);
2627 static int __sip_do_register(struct sip_registry *r);
2628 static int sip_reg_timeout(const void *data);
2629 static void sip_send_all_registers(void);
2630 static int sip_reinvite_retry(const void *data);
2631
2632 /*--- Parsing SIP requests and responses */
2633 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
2634 static int determine_firstline_parts(struct sip_request *req);
2635 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
2636 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
2637 static int find_sip_method(const char *msg);
2638 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
2639 static unsigned int parse_allowed_methods(struct sip_request *req);
2640 static unsigned int set_pvt_allowed_methods(struct sip_pvt *pvt, struct sip_request *req);
2641 static int parse_request(struct sip_request *req);
2642 static const char *get_header(const struct sip_request *req, const char *name);
2643 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
2644 static int method_match(enum sipmethod id, const char *name);
2645 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
2646 static char *get_in_brackets(char *tmp);
2647 static const char *find_alias(const char *name, const char *_default);
2648 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
2649 static int lws2sws(char *msgbuf, int len);
2650 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
2651 static char *remove_uri_parameters(char *uri);
2652 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
2653 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
2654 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
2655 static int set_address_from_contact(struct sip_pvt *pvt);
2656 static void check_via(struct sip_pvt *p, struct sip_request *req);
2657 static char *get_calleridname(const char *input, char *output, size_t outputsize);
2658 static int get_rpid(struct sip_pvt *p, struct sip_request *oreq);
2659 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq, char **name, char **number, int *reason);
2660 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
2661 static int get_msg_text(char *buf, int len, struct sip_request *req, int addnewline);
2662 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
2663 static void update_connectedline(struct sip_pvt *p, const void *data, size_t datalen);
2664 static void update_redirecting(struct sip_pvt *p, const void *data, size_t datalen);
2665 static void change_redirecting_information(struct sip_pvt *p, struct sip_request *req, struct ast_party_redirecting *redirecting, int set_call_forward);
2666 static int get_domain(const char *str, char *domain, int len);
2667 static void get_realm(struct sip_pvt *p, const struct sip_request *req);
2668
2669 /*-- TCP connection handling ---*/
2670 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session);
2671 static void *sip_tcp_worker_fn(void *);
2672
2673 /*--- Constructing requests and responses */
2674 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
2675 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
2676 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
2677 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
2678 static int init_resp(struct sip_request *resp, const char *msg);
2679 static inline int resp_needs_contact(const char *msg, enum sipmethod method);
2680 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
2681 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
2682 static void build_via(struct sip_pvt *p);
2683 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
2684 static int create_addr(struct sip_pvt *dialog, const char *opeer, struct sockaddr_in *sin, int newdialog);
2685 static char *generate_random_string(char *buf, size_t size);
2686 static void build_callid_pvt(struct sip_pvt *pvt);
2687 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
2688 static void make_our_tag(char *tagbuf, size_t len);
2689 static int add_header(struct sip_request *req, const char *var, const char *value);
2690 static int add_header_contentLength(struct sip_request *req, int len);
2691 static int add_line(struct sip_request *req, const char *line);
2692 static int add_text(struct sip_request *req, const char *text);
2693 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
2694 static int add_rpid(struct sip_request *req, struct sip_pvt *p);
2695 static int add_vidupdate(struct sip_request *req);
2696 static void add_route(struct sip_request *req, struct sip_route *route);
2697 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
2698 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
2699 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
2700 static void set_destination(struct sip_pvt *p, char *uri);
2701 static void append_date(struct sip_request *req);
2702 static void build_contact(struct sip_pvt *p);
2703
2704 /*------Request handling functions */
2705 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
2706 static int handle_request_update(struct sip_pvt *p, struct sip_request *req);
2707 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);
2708 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
2709 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
2710 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, const char *e);
2711 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
2712 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
2713 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
2714 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
2715 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
2716 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin);
2717 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, const char *e);
2718 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
2719
2720 /*------Response handling functions */
2721 static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2722 static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2723 static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2724 static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2725 static int handle_response_register(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2726 static void handle_response(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, int seqno);
2727
2728 /*------ T38 Support --------- */
2729 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
2730 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
2731 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
2732 static void change_t38_state(struct sip_pvt *p, int state);
2733
2734 /*------ Session-Timers functions --------- */
2735 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
2736 static int  proc_session_timer(const void *vp);
2737 static void stop_session_timer(struct sip_pvt *p);
2738 static void start_session_timer(struct sip_pvt *p);
2739 static void restart_session_timer(struct sip_pvt *p);
2740 static const char *strefresher2str(enum st_refresher r);
2741 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
2742 static int parse_minse(const char *p_hdrval, int *const p_interval);
2743 static int st_get_se(struct sip_pvt *, int max);
2744 static enum st_refresher st_get_refresher(struct sip_pvt *);
2745 static enum st_mode st_get_mode(struct sip_pvt *);
2746 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
2747
2748 /*------- RTP Glue functions -------- */
2749 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);
2750
2751 /*!--- SIP MWI Subscription support */
2752 static int sip_subscribe_mwi(const char *value, int lineno);
2753 static void sip_subscribe_mwi_destroy(struct sip_subscription_mwi *mwi);
2754 static void sip_send_all_mwi_subscriptions(void);
2755 static int sip_subscribe_mwi_do(const void *data);
2756 static int __sip_subscribe_mwi_do(struct sip_subscription_mwi *mwi);
2757
2758 /*! \brief Definition of this channel for PBX channel registration */
2759 static const struct ast_channel_tech sip_tech = {
2760         .type = "SIP",
2761         .description = "Session Initiation Protocol (SIP)",
2762         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
2763         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
2764         .requester = sip_request_call,                  /* called with chan unlocked */
2765         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
2766         .call = sip_call,                       /* called with chan locked */
2767         .send_html = sip_sendhtml,
2768         .hangup = sip_hangup,                   /* called with chan locked */
2769         .answer = sip_answer,                   /* called with chan locked */
2770         .read = sip_read,                       /* called with chan locked */
2771         .write = sip_write,                     /* called with chan locked */
2772         .write_video = sip_write,               /* called with chan locked */
2773         .write_text = sip_write,
2774         .indicate = sip_indicate,               /* called with chan locked */
2775         .transfer = sip_transfer,               /* called with chan locked */
2776         .fixup = sip_fixup,                     /* called with chan locked */
2777         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
2778         .send_digit_end = sip_senddigit_end,
2779         .bridge = ast_rtp_instance_bridge,                      /* XXX chan unlocked ? */
2780         .early_bridge = ast_rtp_instance_early_bridge,
2781         .send_text = sip_sendtext,              /* called with chan locked */
2782         .func_channel_read = acf_channel_read,
2783         .setoption = sip_setoption,
2784         .queryoption = sip_queryoption,
2785         .get_pvt_uniqueid = sip_get_callid,
2786 };
2787
2788 /*! \brief This version of the sip channel tech has no send_digit_begin
2789  * callback so that the core knows that the channel does not want
2790  * DTMF BEGIN frames.
2791  * The struct is initialized just before registering the channel driver,
2792  * and is for use with channels using SIP INFO DTMF.
2793  */
2794 static struct ast_channel_tech sip_tech_info;
2795
2796
2797 /*! \brief Working TLS connection configuration */
2798 static struct ast_tls_config sip_tls_cfg;
2799
2800 /*! \brief Default TLS connection configuration */
2801 static struct ast_tls_config default_tls_cfg;
2802
2803 /*! \brief The TCP server definition */
2804 static struct ast_tcptls_session_args sip_tcp_desc = {
2805         .accept_fd = -1,
2806         .master = AST_PTHREADT_NULL,
2807         .tls_cfg = NULL,
2808         .poll_timeout = -1,
2809         .name = "SIP TCP server",
2810         .accept_fn = ast_tcptls_server_root,
2811         .worker_fn = sip_tcp_worker_fn,
2812 };
2813
2814 /*! \brief The TCP/TLS server definition */
2815 static struct ast_tcptls_session_args sip_tls_desc = {
2816         .accept_fd = -1,
2817         .master = AST_PTHREADT_NULL,
2818         .tls_cfg = &sip_tls_cfg,
2819         .poll_timeout = -1,
2820         .name = "SIP TLS server",
2821         .accept_fn = ast_tcptls_server_root,
2822         .worker_fn = sip_tcp_worker_fn,
2823 };
2824
2825 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
2826 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
2827
2828 /*! \brief map from an integer value to a string.
2829  * If no match is found, return errorstring
2830  */
2831 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2832 {
2833         const struct _map_x_s *cur;
2834
2835         for (cur = table; cur->s; cur++)
2836                 if (cur->x == x)
2837                         return cur->s;
2838         return errorstring;
2839 }
2840
2841 /*! \brief map from a string to an integer value, case insensitive.
2842  * If no match is found, return errorvalue.
2843  */
2844 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2845 {
2846         const struct _map_x_s *cur;
2847
2848         for (cur = table; cur->s; cur++)
2849                 if (!strcasecmp(cur->s, s))
2850                         return cur->x;
2851         return errorvalue;
2852 }
2853
2854 /*!
2855  * duplicate a list of channel variables, \return the copy.
2856  */
2857 static struct ast_variable *copy_vars(struct ast_variable *src)
2858 {
2859         struct ast_variable *res = NULL, *tmp, *v = NULL;
2860
2861         for (v = src ; v ; v = v->next) {
2862                 if ((tmp = ast_variable_new(v->name, v->value, v->file))) {
2863                         tmp->next = res;
2864                         res = tmp;
2865                 }
2866         }
2867         return res;
2868 }
2869
2870 /*! \brief SIP TCP connection handler */
2871 static void *sip_tcp_worker_fn(void *data)
2872 {
2873         struct ast_tcptls_session_instance *tcptls_session = data;
2874
2875         return _sip_tcp_helper_thread(NULL, tcptls_session);
2876 }
2877
2878 /*! \brief SIP TCP thread management function
2879         This function reads from the socket, parses the packet into a request
2880 */
2881 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *tcptls_session)
2882 {
2883         int res, cl;
2884         struct sip_request req = { 0, } , reqcpy = { 0, };
2885         struct sip_threadinfo *me;
2886         char buf[1024] = "";
2887
2888         me = ast_calloc(1, sizeof(*me));
2889
2890         if (!me)
2891                 goto cleanup2;
2892
2893         me->threadid = pthread_self();
2894         me->tcptls_session = tcptls_session;
2895         if (tcptls_session->ssl)
2896                 me->type = SIP_TRANSPORT_TLS;
2897         else
2898                 me->type = SIP_TRANSPORT_TCP;
2899
2900         ast_debug(2, "Starting thread for %s server\n", tcptls_session->ssl ? "SSL" : "TCP");
2901
2902         AST_LIST_LOCK(&threadl);
2903         AST_LIST_INSERT_TAIL(&threadl, me, list);
2904         AST_LIST_UNLOCK(&threadl);
2905
2906         if (!(req.data = ast_str_create(SIP_MIN_PACKET)))
2907                 goto cleanup;
2908         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET)))
2909                 goto cleanup;
2910
2911         for (;;) {
2912                 struct ast_str *str_save;
2913
2914                 str_save = req.data;
2915                 memset(&req, 0, sizeof(req));
2916                 req.data = str_save;
2917                 ast_str_reset(req.data);
2918
2919                 str_save = reqcpy.data;
2920                 memset(&reqcpy, 0, sizeof(reqcpy));
2921                 reqcpy.data = str_save;
2922                 ast_str_reset(reqcpy.data);
2923
2924                 memset(buf, 0, sizeof(buf));
2925
2926                 if (tcptls_session->ssl) {
2927                         set_socket_transport(&req.socket, SIP_TRANSPORT_TLS);
2928                         req.socket.port = htons(ourport_tls);
2929                 } else {
2930                         set_socket_transport(&req.socket, SIP_TRANSPORT_TCP);