channels/chan_sip.c

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