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, TCP and TLS support
  29  * Configuration file \link Config_sip sip.conf \endlink
  30  *
  31  *
  32  * \todo SIP over TCP
  33  * \todo SIP over TLS
  34  * \todo Better support of forking
  35  * \todo VIA branch tag transaction checking
  36  * \todo Transaction support
  37  *
  38  * \ingroup channel_drivers
  39  *
  40  * \par Overview of the handling of SIP sessions
  41  * The SIP channel handles several types of SIP sessions, or dialogs,
  42  * not all of them being "telephone calls".
  43  * - Incoming calls that will be sent to the PBX core
  44  * - Outgoing calls, generated by the PBX
  45  * - SIP subscriptions and notifications of states and voicemail messages
  46  * - SIP registrations, both inbound and outbound
  47  * - SIP peer management (peerpoke, OPTIONS)
  48  * - SIP text messages
  49  *
  50  * In the SIP channel, there's a list of active SIP dialogs, which includes
  51  * all of these when they are active. "sip show channels" in the CLI will
  52  * show most of these, excluding subscriptions which are shown by
  53  * "sip show subscriptions"
  54  *
  55  * \par incoming packets
  56  * Incoming packets are received in the monitoring thread, then handled by
  57  * sipsock_read(). This function parses the packet and matches an existing
  58  * dialog or starts a new SIP dialog.
  59  *
  60  * sipsock_read sends the packet to handle_request(), that parses a bit more.
  61  * if it's a response to an outbound request, it's sent to handle_response().
  62  * If it is a request, handle_request sends it to one of a list of functions
  63  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
  64  * sipsock_read locks the ast_channel if it exists (an active call) and
  65  * unlocks it after we have processed the SIP message.
  66  *
  67  * A new INVITE is sent to handle_request_invite(), that will end up
  68  * starting a new channel in the PBX, the new channel after that executing
  69  * in a separate channel thread. This is an incoming "call".
  70  * When the call is answered, either by a bridged channel or the PBX itself
  71  * the sip_answer() function is called.
  72  *
  73  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
  74  * in rtp.c
  75  *
  76  * \par Outbound calls
  77  * Outbound calls are set up by the PBX through the sip_request_call()
  78  * function. After that, they are activated by sip_call().
  79  *
  80  * \par Hanging up
  81  * The PBX issues a hangup on both incoming and outgoing calls through
  82  * the sip_hangup() function
  83  */
  84
  85
  86 #include "asterisk.h"
  87
  88 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  89
  90 #include <stdio.h>
  91 #include <ctype.h>
  92 #include <string.h>
  93 #include <unistd.h>
  94 #include <sys/socket.h>
  95 #include <sys/ioctl.h>
  96 #include <net/if.h>
  97 #include <errno.h>
  98 #include <stdlib.h>
  99 #include <fcntl.h>
 100 #include <netdb.h>
 101 #include <signal.h>
 102 #include <sys/signal.h>
 103 #include <netinet/in.h>
 104 #include <netinet/in_systm.h>
 105 #include <arpa/inet.h>
 106 #include <netinet/ip.h>
 107 #include <regex.h>
 108
 109 #include "asterisk/lock.h"
 110 #include "asterisk/channel.h"
 111 #include "asterisk/config.h"
 112 #include "asterisk/logger.h"
 113 #include "asterisk/module.h"
 114 #include "asterisk/pbx.h"
 115 #include "asterisk/options.h"
 116 #include "asterisk/lock.h"
 117 #include "asterisk/sched.h"
 118 #include "asterisk/io.h"
 119 #include "asterisk/rtp.h"
 120 #include "asterisk/udptl.h"
 121 #include "asterisk/acl.h"
 122 #include "asterisk/manager.h"
 123 #include "asterisk/callerid.h"
 124 #include "asterisk/cli.h"
 125 #include "asterisk/app.h"
 126 #include "asterisk/musiconhold.h"
 127 #include "asterisk/dsp.h"
 128 #include "asterisk/features.h"
 129 #include "asterisk/acl.h"
 130 #include "asterisk/srv.h"
 131 #include "asterisk/astdb.h"
 132 #include "asterisk/causes.h"
 133 #include "asterisk/utils.h"
 134 #include "asterisk/file.h"
 135 #include "asterisk/astobj.h"
 136 #include "asterisk/dnsmgr.h"
 137 #include "asterisk/devicestate.h"
 138 #include "asterisk/linkedlists.h"
 139 #include "asterisk/stringfields.h"
 140 #include "asterisk/monitor.h"
 141 #include "asterisk/localtime.h"
 142 #include "asterisk/abstract_jb.h"
 143 #include "asterisk/compiler.h"
 144
 145 #ifndef FALSE
 146 #define FALSE    0
 147 #endif
 148
 149 #ifndef TRUE
 150 #define TRUE     1
 151 #endif
 152
 153 #define VIDEO_CODEC_MASK        0x1fc0000 /*!< Video codecs from H.261 thru AST_FORMAT_MAX_VIDEO */
 154 #ifndef IPTOS_MINCOST
 155 #define IPTOS_MINCOST           0x02
 156 #endif
 157
 158 /* #define VOCAL_DATA_HACK */
 159
 160 #define DEFAULT_DEFAULT_EXPIRY  120
 161 #define DEFAULT_MIN_EXPIRY      60
 162 #define DEFAULT_MAX_EXPIRY      3600
 163 #define DEFAULT_REGISTRATION_TIMEOUT 20
 164 #define DEFAULT_MAX_FORWARDS    "70"
 165
 166 /* guard limit must be larger than guard secs */
 167 /* guard min must be < 1000, and should be >= 250 */
 168 #define EXPIRY_GUARD_SECS       15                /*!< How long before expiry do we reregister */
 169 #define EXPIRY_GUARD_LIMIT      30                /*!< Below here, we use EXPIRY_GUARD_PCT instead of
 170                                                    EXPIRY_GUARD_SECS */
 171 #define EXPIRY_GUARD_MIN        500                /*!< This is the minimum guard time applied. If
 172                                                    GUARD_PCT turns out to be lower than this, it
 173                                                    will use this time instead.
 174                                                    This is in milliseconds. */
 175 #define EXPIRY_GUARD_PCT        0.20                /*!< Percentage of expires timeout to use when
 176                                                     below EXPIRY_GUARD_LIMIT */
 177 #define DEFAULT_EXPIRY 900                          /*!< Expire slowly */
 178
 179 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
 180 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
 181 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
 182 static int expiry = DEFAULT_EXPIRY;
 183
 184 #ifndef MAX
 185 #define MAX(a,b) ((a) > (b) ? (a) : (b))
 186 #endif
 187
 188 #define CALLERID_UNKNOWN        "Unknown"
 189
 190 #define DEFAULT_MAXMS                2000             /*!< Qualification: Must be faster than 2 seconds by default */
 191 #define DEFAULT_FREQ_OK              60 * 1000        /*!< Qualification: How often to check for the host to be up */
 192 #define DEFAULT_FREQ_NOTOK           10 * 1000        /*!< Qualification: How often to check, if the host is down... */
 193
 194 #define DEFAULT_RETRANS              1000             /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
 195 #define MAX_RETRANS                  6                /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
 196 #define SIP_TRANS_TIMEOUT            32000            /*!< SIP request timeout (rfc 3261) 64*T1
 197                                                       \todo Use known T1 for timeout (peerpoke)
 198                                                       */
 199 #define DEFAULT_TRANS_TIMEOUT        -1               /* Use default SIP transaction timeout */
 200 #define MAX_AUTHTRIES                3                /*!< Try authentication three times, then fail */
 201
 202 #define SIP_MAX_HEADERS              64               /*!< Max amount of SIP headers to read */
 203 #define SIP_MAX_LINES                64               /*!< Max amount of lines in SIP attachment (like SDP) */
 204 #define SIP_MAX_PACKET               4096             /*!< Also from RFC 3261 (2543), should sub headers tho */
 205
 206 #define INITIAL_CSEQ                 101              /*!< our initial sip sequence number */
 207
 208 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
 209 static struct ast_jb_conf default_jbconf =
 210 {
 211         .flags = 0,
 212         .max_size = -1,
 213         .resync_threshold = -1,
 214         .impl = ""
 215 };
 216 static struct ast_jb_conf global_jbconf;
 217
 218 static const char config[] = "sip.conf";
 219 static const char notify_config[] = "sip_notify.conf";
 220 static int usecnt = 0;
 221
 222
 223 #define RTP     1
 224 #define NO_RTP  0
 225
 226 /*! \brief Authorization scheme for call transfers
 227 \note Not a bitfield flag, since there are plans for other modes,
 228         like "only allow transfers for authenticated devices" */
 229 enum transfermodes {
 230         TRANSFER_OPENFORALL,            /*!< Allow all SIP transfers */
 231         TRANSFER_CLOSED,                /*!< Allow no SIP transfers */
 232 };
 233
 234
 235 enum sip_result {
 236         AST_SUCCESS = 0,
 237         AST_FAILURE = -1,
 238 };
 239
 240 /* Do _NOT_ make any changes to this enum, or the array following it;
 241    if you think you are doing the right thing, you are probably
 242    not doing the right thing. If you think there are changes
 243    needed, get someone else to review them first _before_
 244    submitting a patch. If these two lists do not match properly
 245    bad things will happen.
 246 */
 247
 248 enum xmittype {
 249         XMIT_CRITICAL = 2,              /*!< Transmit critical SIP message reliably, with re-transmits.
 250                                               If it fails, it's critical and will cause a teardown of the session */
 251         XMIT_RELIABLE = 1,              /*!< Transmit SIP message reliably, with re-transmits */
 252         XMIT_UNRELIABLE = 0,            /*!< Transmit SIP message without bothering with re-transmits */
 253 };
 254
 255 enum parse_register_result {
 256         PARSE_REGISTER_FAILED,
 257         PARSE_REGISTER_UPDATE,
 258         PARSE_REGISTER_QUERY,
 259 };
 260
 261 enum subscriptiontype {
 262         NONE = 0,
 263         TIMEOUT,
 264         XPIDF_XML,
 265         DIALOG_INFO_XML,
 266         CPIM_PIDF_XML,
 267         PIDF_XML,
 268         MWI_NOTIFICATION
 269 };
 270
 271 static const struct cfsubscription_types {
 272         enum subscriptiontype type;
 273         const char * const event;
 274         const char * const mediatype;
 275         const char * const text;
 276 } subscription_types[] = {
 277         { NONE,            "-",        "unknown",                    "unknown" },
 278         /* RFC 4235: SIP Dialog event package */
 279         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
 280         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
 281         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
 282         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
 283         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
 284 };
 285
 286 /*! \brief SIP Request methods known by Asterisk */
 287 enum sipmethod {
 288         SIP_UNKNOWN,            /* Unknown response */
 289         SIP_RESPONSE,           /* Not request, response to outbound request */
 290         SIP_REGISTER,
 291         SIP_OPTIONS,
 292         SIP_NOTIFY,
 293         SIP_INVITE,
 294         SIP_ACK,
 295         SIP_PRACK,              /* Not supported at all */
 296         SIP_BYE,
 297         SIP_REFER,
 298         SIP_SUBSCRIBE,
 299         SIP_MESSAGE,
 300         SIP_UPDATE,             /* We can send UPDATE; but not accept it */
 301         SIP_INFO,
 302         SIP_CANCEL,
 303         SIP_PUBLISH,            /* Not supported at all */
 304 };
 305
 306 /*! \brief Authentication types - proxy or www authentication
 307         \note Endpoints, like Asterisk, should always use WWW authentication to
 308         allow multiple authentications in the same call - to the proxy and
 309         to the end point.
 310 */
 311 enum sip_auth_type {
 312         PROXY_AUTH = 407,
 313         WWW_AUTH = 401,
 314 };
 315
 316 /*! \brief Authentication result from check_auth* functions */
 317 enum check_auth_result {
 318         AUTH_SUCCESSFUL = 0,
 319         AUTH_CHALLENGE_SENT = 1,
 320         AUTH_SECRET_FAILED = -1,
 321         AUTH_USERNAME_MISMATCH = -2,
 322         AUTH_NOT_FOUND = -3,
 323         AUTH_FAKE_AUTH = -4,
 324         AUTH_UNKNOWN_DOMAIN = -5,
 325 };
 326
 327 /*! \brief States for outbound registrations (with register= lines in sip.conf */
 328 enum sipregistrystate {
 329         REG_STATE_UNREGISTERED = 0,     /*!< We are not registred */
 330         REG_STATE_REGSENT,      /*!< Registration request sent */
 331         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate */
 332         REG_STATE_REGISTERED,   /*!< Registred and done */
 333         REG_STATE_REJECTED,     /*!< Registration rejected */
 334         REG_STATE_TIMEOUT,      /*!< Registration timed out */
 335         REG_STATE_NOAUTH,       /*!< We have no accepted credentials */
 336         REG_STATE_FAILED,       /*!< Registration failed after several tries */
 337 };
 338
 339
 340 /*! XXX Note that sip_methods[i].id == i must hold or the code breaks */
 341 static const struct  cfsip_methods {
 342         enum sipmethod id;
 343         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
 344         char * const text;
 345 } sip_methods[] = {
 346         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-" },
 347         { SIP_RESPONSE,  NO_RTP, "SIP/2.0" },
 348         { SIP_REGISTER,  NO_RTP, "REGISTER" },
 349         { SIP_OPTIONS,   NO_RTP, "OPTIONS" },
 350         { SIP_NOTIFY,    NO_RTP, "NOTIFY" },
 351         { SIP_INVITE,    RTP,    "INVITE" },
 352         { SIP_ACK,       NO_RTP, "ACK" },
 353         { SIP_PRACK,     NO_RTP, "PRACK" },
 354         { SIP_BYE,       NO_RTP, "BYE" },
 355         { SIP_REFER,     NO_RTP, "REFER" },
 356         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE" },
 357         { SIP_MESSAGE,   NO_RTP, "MESSAGE" },
 358         { SIP_UPDATE,    NO_RTP, "UPDATE" },
 359         { SIP_INFO,      NO_RTP, "INFO" },
 360         { SIP_CANCEL,    NO_RTP, "CANCEL" },
 361         { SIP_PUBLISH,   NO_RTP, "PUBLISH" }
 362 };
 363
 364 /*!  Define SIP option tags, used in Require: and Supported: headers
 365         We need to be aware of these properties in the phones to use
 366         the replace: header. We should not do that without knowing
 367         that the other end supports it...
 368         This is nothing we can configure, we learn by the dialog
 369         Supported: header on the REGISTER (peer) or the INVITE
 370         (other devices)
 371         We are not using many of these today, but will in the future.
 372         This is documented in RFC 3261
 373 */
 374 #define SUPPORTED               1
 375 #define NOT_SUPPORTED           0
 376
 377 #define SIP_OPT_REPLACES        (1 << 0)
 378 #define SIP_OPT_100REL          (1 << 1)
 379 #define SIP_OPT_TIMER           (1 << 2)
 380 #define SIP_OPT_EARLY_SESSION   (1 << 3)
 381 #define SIP_OPT_JOIN            (1 << 4)
 382 #define SIP_OPT_PATH            (1 << 5)
 383 #define SIP_OPT_PREF            (1 << 6)
 384 #define SIP_OPT_PRECONDITION    (1 << 7)
 385 #define SIP_OPT_PRIVACY         (1 << 8)
 386 #define SIP_OPT_SDP_ANAT        (1 << 9)
 387 #define SIP_OPT_SEC_AGREE       (1 << 10)
 388 #define SIP_OPT_EVENTLIST       (1 << 11)
 389 #define SIP_OPT_GRUU            (1 << 12)
 390 #define SIP_OPT_TARGET_DIALOG   (1 << 13)
 391 #define SIP_OPT_NOREFERSUB      (1 << 14)
 392 #define SIP_OPT_HISTINFO        (1 << 15)
 393 #define SIP_OPT_RESPRIORITY     (1 << 16)
 394
 395 /*! \brief List of well-known SIP options. If we get this in a require,
 396    we should check the list and answer accordingly. */
 397 static const struct cfsip_options {
 398         int id;                 /*!< Bitmap ID */
 399         int supported;          /*!< Supported by Asterisk ? */
 400         char * const text;      /*!< Text id, as in standard */
 401 } sip_options[] = {     /* XXX used in 3 places */
 402         /* RFC3891: Replaces: header for transfer */
 403         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },
 404         /* One version of Polycom firmware has the wrong label */
 405         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },
 406         /* RFC3262: PRACK 100% reliability */
 407         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },
 408         /* RFC4028: SIP Session Timers */
 409         { SIP_OPT_TIMER,        NOT_SUPPORTED,  "timer" },
 410         /* RFC3959: SIP Early session support */
 411         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
 412         /* RFC3911: SIP Join header support */
 413         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
 414         /* RFC3327: Path support */
 415         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
 416         /* RFC3840: Callee preferences */
 417         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
 418         /* RFC3312: Precondition support */
 419         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
 420         /* RFC3323: Privacy with proxies*/
 421         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
 422         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
 423         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
 424         /* RFC3329: Security agreement mechanism */
 425         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
 426         /* SIMPLE events:  draft-ietf-simple-event-list-07.txt */
 427         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
 428         /* GRUU: Globally Routable User Agent URI's */
 429         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
 430         /* Target-dialog: draft-ietf-sip-target-dialog-03.txt */
 431         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
 432         /* Disable the REFER subscription, RFC 4488 */
 433         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
 434         /* ietf-sip-history-info-06.txt */
 435         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
 436         /* ietf-sip-resource-priority-10.txt */
 437         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
 438 };
 439
 440
 441 /*! \brief SIP Methods we support */
 442 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY"
 443
 444 /*! \brief SIP Extensions we support */
 445 #define SUPPORTED_EXTENSIONS "replaces"
 446
 447 /*! \brief Standard SIP port from RFC 3261. DO NOT CHANGE THIS */
 448 #define STANDARD_SIP_PORT       5060
 449 /* Note: in many SIP headers, absence of a port number implies port 5060,
 450  * and this is why we cannot change the above constant.
 451  * There is a limited number of places in asterisk where we could,
 452  * in principle, use a different "default" port number, but
 453  * we do not support this feature at the moment.
 454  */
 455
 456 /* Default values, set and reset in reload_config before reading configuration */
 457 /* These are default values in the source. There are other recommended values in the
 458    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
 459    yet encouraging new behaviour on new installations
 460  */
 461 #define DEFAULT_CONTEXT         "default"
 462 #define DEFAULT_MOHINTERPRET    "default"
 463 #define DEFAULT_MOHSUGGEST      ""
 464 #define DEFAULT_VMEXTEN         "asterisk"
 465 #define DEFAULT_CALLERID        "asterisk"
 466 #define DEFAULT_NOTIFYMIME      "application/simple-message-summary"
 467 #define DEFAULT_MWITIME         10
 468 #define DEFAULT_ALLOWGUEST      TRUE
 469 #define DEFAULT_SRVLOOKUP       FALSE           /*!< Recommended setting is ON */
 470 #define DEFAULT_COMPACTHEADERS  FALSE
 471 #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. */
 472 #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. */
 473 #define DEFAULT_TOS_VIDEO       0               /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
 474 #define DEFAULT_ALLOW_EXT_DOM   TRUE
 475 #define DEFAULT_REALM           "asterisk"
 476 #define DEFAULT_NOTIFYRINGING   TRUE
 477 #define DEFAULT_PEDANTIC        FALSE
 478 #define DEFAULT_AUTOCREATEPEER  FALSE
 479 #define DEFAULT_QUALIFY         FALSE
 480 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
 481 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
 482 #ifndef DEFAULT_USERAGENT
 483 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
 484 #endif
 485
 486
 487 /* Default setttings are used as a channel setting and as a default when
 488    configuring devices */
 489 static char default_context[AST_MAX_CONTEXT];
 490 static char default_subscribecontext[AST_MAX_CONTEXT];
 491 static char default_language[MAX_LANGUAGE];
 492 static char default_callerid[AST_MAX_EXTENSION];
 493 static char default_fromdomain[AST_MAX_EXTENSION];
 494 static char default_notifymime[AST_MAX_EXTENSION];
 495 static int default_qualify;             /*!< Default Qualify= setting */
 496 static char default_vmexten[AST_MAX_EXTENSION];
 497 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
 498 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting
 499                                                     *   a bridged channel on hold */
 500 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
 501 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
 502
 503 /* Global settings only apply to the channel */
 504 static int global_rtautoclear;
 505 static int global_notifyringing;        /*!< Send notifications on ringing */
 506 static int global_alwaysauthreject;     /*!< Send 401 Unauthorized for all failing requests */
 507 static int srvlookup;                   /*!< SRV Lookup on or off. Default is off, RFC behavior is on */
 508 static int pedanticsipchecking;         /*!< Extra checking ?  Default off */
 509 static int autocreatepeer;              /*!< Auto creation of peers at registration? Default off. */
 510 static int global_relaxdtmf;                    /*!< Relax DTMF */
 511 static int global_rtptimeout;           /*!< Time out call if no RTP */
 512 static int global_rtpholdtimeout;
 513 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
 514 static int global_reg_timeout;
 515 static int global_regattempts_max;      /*!< Registration attempts before giving up */
 516 static int global_allowguest;           /*!< allow unauthenticated users/peers to connect? */
 517 static int global_allowsubscribe;       /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE
 518                                             the global setting is in globals_flags[1] */
 519 static int global_mwitime;              /*!< Time between MWI checks for peers */
 520 static unsigned int global_tos_sip;             /*!< IP type of service for SIP packets */
 521 static unsigned int global_tos_audio;           /*!< IP type of service for audio RTP packets */
 522 static unsigned int global_tos_video;           /*!< IP type of service for video RTP packets */
 523 static int compactheaders;              /*!< send compact sip headers */
 524 static int recordhistory;               /*!< Record SIP history. Off by default */
 525 static int dumphistory;                 /*!< Dump history to verbose before destroying SIP dialog */
 526 static char global_realm[MAXHOSTNAMELEN];               /*!< Default realm */
 527 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
 528 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
 529 static int allow_external_domains;      /*!< Accept calls to external SIP domains? */
 530 static int global_callevents;           /*!< Whether we send manager events or not */
 531 static int global_t1min;                /*!< T1 roundtrip time minimum */
 532 static int global_autoframing;          /*!< ?????????? */
 533 static enum transfermodes global_allowtransfer; /*!< SIP Refer restriction scheme */
 534
 535 /*! \brief Codecs that we support by default: */
 536 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
 537 static int noncodeccapability = AST_RTP_DTMF;
 538
 539 static int global_ignoreoodresponses = 1;
 540
 541 /* Object counters */
 542 static int suserobjs = 0;                /*!< Static users */
 543 static int ruserobjs = 0;                /*!< Realtime users */
 544 static int speerobjs = 0;                /*!< Statis peers */
 545 static int rpeerobjs = 0;                /*!< Realtime peers */
 546 static int apeerobjs = 0;                /*!< Autocreated peer objects */
 547 static int regobjs = 0;                  /*!< Registry objects */
 548
 549 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
 550
 551
 552 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
 553 AST_MUTEX_DEFINE_STATIC(iflock);
 554
 555 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
 556    when it's doing something critical. */
 557 AST_MUTEX_DEFINE_STATIC(netlock);
 558
 559 AST_MUTEX_DEFINE_STATIC(monlock);
 560
 561 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
 562
 563 /*! \brief This is the thread for the monitor which checks for input on the channels
 564    which are not currently in use.  */
 565 static pthread_t monitor_thread = AST_PTHREADT_NULL;
 566
 567 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
 568 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
 569
 570 static struct sched_context *sched;     /*!< The scheduling context */
 571 static struct io_context *io;           /*!< The IO context */
 572 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
 573
 574 #define DEC_CALL_LIMIT  0
 575 #define INC_CALL_LIMIT  1
 576 #define DEC_CALL_RINGING 2
 577 #define INC_CALL_RINGING 3
 578
 579 /*! \brief sip_request: The data grabbed from the UDP socket */
 580 struct sip_request {
 581         char *rlPart1;          /*!< SIP Method Name or "SIP/2.0" protocol version */
 582         char *rlPart2;          /*!< The Request URI or Response Status */
 583         int len;                /*!< Length */
 584         int headers;            /*!< # of SIP Headers */
 585         int method;             /*!< Method of this request */
 586         int lines;              /*!< Body Content */
 587         unsigned int flags;     /*!< SIP_PKT Flags for this packet */
 588         char *header[SIP_MAX_HEADERS];
 589         char *line[SIP_MAX_LINES];
 590         char data[SIP_MAX_PACKET];
 591         unsigned int sdp_start; /*!< the line number where the SDP begins */
 592         unsigned int sdp_end;   /*!< the line number where the SDP ends */
 593 };
 594
 595 /*
 596  * A sip packet is stored into the data[] buffer, with the header followed
 597  * by an empty line and the body of the message.
 598  * On outgoing packets, data is accumulated in data[] with len reflecting
 599  * the next available byte, headers and lines count the number of lines
 600  * in both parts. There are no '\0' in data[0..len-1].
 601  *
 602  * On received packet, the input read from the socket is copied into data[],
 603  * len is set and the string is NUL-terminated. Then a parser fills up
 604  * the other fields -header[] and line[] to point to the lines of the
 605  * message, rlPart1 and rlPart2 parse the first lnie as below:
 606  *
 607  * Requests have in the first line      METHOD URI SIP/2.0
 608  *      rlPart1 = method; rlPart2 = uri;
 609  * Responses have in the first line     SIP/2.0 code description
 610  *      rlPart1 = SIP/2.0; rlPart2 = code + description;
 611  *
 612  */
 613
 614 /*! \brief structure used in transfers */
 615 struct sip_dual {
 616         struct ast_channel *chan1;      /*!< First channel involved */
 617         struct ast_channel *chan2;      /*!< Second channel involved */
 618         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
 619         int seqno;                      /*!< Sequence number */
 620 };
 621
 622 struct sip_pkt;
 623
 624 /*! \brief Parameters to the transmit_invite function */
 625 struct sip_invite_param {
 626         int addsipheaders;              /*!< Add extra SIP headers */
 627         const char *uri_options;        /*!< URI options to add to the URI */
 628         const char *vxml_url;           /*!< VXML url for Cisco phones */
 629         char *auth;                     /*!< Authentication */
 630         char *authheader;               /*!< Auth header */
 631         enum sip_auth_type auth_type;   /*!< Authentication type */
 632         const char *replaces;           /*!< Replaces header for call transfers */
 633         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
 634 };
 635
 636 /*! \brief Structure to save routing information for a SIP session */
 637 struct sip_route {
 638         struct sip_route *next;
 639         char hop[0];
 640 };
 641
 642 /*! \brief Modes for SIP domain handling in the PBX */
 643 enum domain_mode {
 644         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
 645         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
 646 };
 647
 648 /*! \brief Domain data structure.
 649         \note In the future, we will connect this to a configuration tree specific
 650         for this domain
 651 */
 652 struct domain {
 653         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
 654         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
 655         enum domain_mode mode;                  /*!< How did we find this domain? */
 656         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
 657 };
 658
 659 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
 660
 661
 662 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
 663 struct sip_history {
 664         AST_LIST_ENTRY(sip_history) list;
 665         char event[0];  /* actually more, depending on needs */
 666 };
 667
 668 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
 669
 670 /*! \brief sip_auth: Creadentials for authentication to other SIP services */
 671 struct sip_auth {
 672         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
 673         char username[256];             /*!< Username */
 674         char secret[256];               /*!< Secret */
 675         char md5secret[256];            /*!< MD5Secret */
 676         struct sip_auth *next;          /*!< Next auth structure in list */
 677 };
 678
 679 /*--- Various flags for the flags field in the pvt structure */
 680 #define SIP_ALREADYGONE         (1 << 0)        /*!< Whether or not we've already been destroyed by our peer */
 681 #define SIP_NEEDDESTROY         (1 << 1)        /*!< if we need to be destroyed by the monitor thread */
 682 #define SIP_NOVIDEO             (1 << 2)        /*!< Didn't get video in invite, don't offer */
 683 #define SIP_RINGING             (1 << 3)        /*!< Have sent 180 ringing */
 684 #define SIP_PROGRESS_SENT       (1 << 4)        /*!< Have sent 183 message progress */
 685 #define SIP_NEEDREINVITE        (1 << 5)        /*!< Do we need to send another reinvite? */
 686 #define SIP_PENDINGBYE          (1 << 6)        /*!< Need to send bye after we ack? */
 687 #define SIP_GOTREFER            (1 << 7)        /*!< Got a refer? */
 688 #define SIP_PROMISCREDIR        (1 << 8)        /*!< Promiscuous redirection */
 689 #define SIP_TRUSTRPID           (1 << 9)        /*!< Trust RPID headers? */
 690 #define SIP_USEREQPHONE         (1 << 10)       /*!< Add user=phone to numeric URI. Default off */
 691 #define SIP_REALTIME            (1 << 11)       /*!< Flag for realtime users */
 692 #define SIP_USECLIENTCODE       (1 << 12)       /*!< Trust X-ClientCode info message */
 693 #define SIP_OUTGOING            (1 << 13)       /*!< Is this an outgoing call? */
 694 #define SIP_CAN_BYE             (1 << 14)       /*!< Can we send BYE on this dialog? */
 695 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 15)       /*!< Do not hangup at first ast_hangup */
 696 #define SIP_DTMF                (3 << 16)       /*!< DTMF Support: four settings, uses two bits */
 697 #define SIP_DTMF_RFC2833        (0 << 16)       /*!< DTMF Support: RTP DTMF - "rfc2833" */
 698 #define SIP_DTMF_INBAND         (1 << 16)       /*!< DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
 699 #define SIP_DTMF_INFO           (2 << 16)       /*!< DTMF Support: SIP Info messages - "info" */
 700 #define SIP_DTMF_AUTO           (3 << 16)       /*!< DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
 701 /* NAT settings */
 702 #define SIP_NAT                 (3 << 18)       /*!< four settings, uses two bits */
 703 #define SIP_NAT_NEVER           (0 << 18)       /*!< No nat support */
 704 #define SIP_NAT_RFC3581         (1 << 18)       /*!< NAT RFC3581 */
 705 #define SIP_NAT_ROUTE           (2 << 18)       /*!< NAT Only ROUTE */
 706 #define SIP_NAT_ALWAYS          (3 << 18)       /*!< NAT Both ROUTE and RFC3581 */
 707 /* re-INVITE related settings */
 708 #define SIP_REINVITE            (7 << 20)       /*!< three bits used */
 709 #define SIP_CAN_REINVITE        (1 << 20)       /*!< allow peers to be reinvited to send media directly p2p */
 710 #define SIP_CAN_REINVITE_NAT    (2 << 20)       /*!< allow media reinvite when new peer is behind NAT */
 711 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< use UPDATE (RFC3311) when reinviting this peer */
 712 /* "insecure" settings */
 713 #define SIP_INSECURE_PORT       (1 << 23)       /*!< don't require matching port for incoming requests */
 714 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< don't require authentication for incoming INVITEs */
 715 /* Sending PROGRESS in-band settings */
 716 #define SIP_PROG_INBAND         (3 << 25)       /*!< three settings, uses two bits */
 717 #define SIP_PROG_INBAND_NEVER   (0 << 25)
 718 #define SIP_PROG_INBAND_NO      (1 << 25)
 719 #define SIP_PROG_INBAND_YES     (2 << 25)
 720 #define SIP_FREE_BIT            (1 << 27)       /*!< Undefined bit - not in use */
 721 #define SIP_CALL_LIMIT          (1 << 28)       /*!< Call limit enforced for this call */
 722 #define SIP_SENDRPID            (1 << 29)       /*!< Remote Party-ID Support */
 723 #define SIP_INC_COUNT           (1 << 30)       /*!< Did this connection increment the counter of in-use calls? */
 724 #define SIP_G726_NONSTANDARD    (1 << 31)       /*!< Use non-standard packing for G726-32 data */
 725
 726 #define SIP_FLAGS_TO_COPY \
 727         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
 728          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT | SIP_G726_NONSTANDARD | \
 729          SIP_USEREQPHONE | SIP_INSECURE_PORT | SIP_INSECURE_INVITE)
 730
 731 /*--- a new page of flags (for flags[1] */
 732 /* realtime flags */
 733 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)
 734 #define SIP_PAGE2_RTUPDATE              (1 << 1)
 735 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)
 736 #define SIP_PAGE2_RT_FROMCONTACT        (1 << 4)
 737 #define SIP_PAGE2_RTSAVE_SYSNAME        (1 << 5)
 738 /* Space for addition of other realtime flags in the future */
 739 #define SIP_PAGE2_IGNOREREGEXPIRE       (1 << 10)
 740 #define SIP_PAGE2_DEBUG                 (3 << 11)
 741 #define SIP_PAGE2_DEBUG_CONFIG          (1 << 11)
 742 #define SIP_PAGE2_DEBUG_CONSOLE         (1 << 12)
 743 #define SIP_PAGE2_DYNAMIC               (1 << 13)       /*!< Dynamic Peers register with Asterisk */
 744 #define SIP_PAGE2_SELFDESTRUCT          (1 << 14)       /*!< Automatic peers need to destruct themselves */
 745 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 15)
 746 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< Allow subscriptions from this peer? */
 747 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< Allow overlap dialing ? */
 748 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< Only issue MWI notification if subscribed to */
 749 #define SIP_PAGE2_INC_RINGING           (1 << 19)       /*!< Did this connection increment the counter of in-use calls? */
 750 #define SIP_PAGE2_T38SUPPORT            (7 << 20)       /*!< T38 Fax Passthrough Support */
 751 #define SIP_PAGE2_T38SUPPORT_UDPTL      (1 << 20)       /*!< 20: T38 Fax Passthrough Support */
 752 #define SIP_PAGE2_T38SUPPORT_RTP        (2 << 20)       /*!< 21: T38 Fax Passthrough Support */
 753 #define SIP_PAGE2_T38SUPPORT_TCP        (4 << 20)       /*!< 22: T38 Fax Passthrough Support */
 754 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< Call states */
 755 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (1 << 23)       /*!< 23: One directional hold */
 756 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (2 << 24)       /*!< 24: Inactive  */
 757 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 26)
 758
 759 #define SIP_PAGE2_FLAGS_TO_COPY \
 760         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE)
 761
 762 /* SIP packet flags */
 763 #define SIP_PKT_DEBUG           (1 << 0)        /*!< Debug this packet */
 764 #define SIP_PKT_WITH_TOTAG      (1 << 1)        /*!< This packet has a to-tag */
 765 #define SIP_PKT_IGNORE          (1 << 2)        /*!< This is a re-transmit, ignore it */
 766 #define SIP_PKT_IGNORE_RESP     (1 << 3)        /*!< Resp ignore - ??? */
 767 #define SIP_PKT_IGNORE_REQ      (1 << 4)        /*!< Req ignore - ??? */
 768
 769 /* T.38 set of flags */
 770 #define T38FAX_FILL_BIT_REMOVAL         (1 << 0)        /*!< Default: 0 (unset)*/
 771 #define T38FAX_TRANSCODING_MMR                  (1 << 1)        /*!< Default: 0 (unset)*/
 772 #define T38FAX_TRANSCODING_JBIG         (1 << 2)        /*!< Default: 0 (unset)*/
 773 /* Rate management */
 774 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF   (0 << 3)
 775 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF        (1 << 3)        /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
 776 /* UDP Error correction */
 777 #define T38FAX_UDP_EC_NONE                      (0 << 4)        /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
 778 #define T38FAX_UDP_EC_FEC                       (1 << 4)        /*!< Set for t38UDPFEC */
 779 #define T38FAX_UDP_EC_REDUNDANCY                (2 << 4)        /*!< Set for t38UDPRedundancy */
 780 /* T38 Spec version */
 781 #define T38FAX_VERSION                          (3 << 6)        /*!< two bits, 2 values so far, up to 4 values max */
 782 #define T38FAX_VERSION_0                        (0 << 6)        /*!< Version 0 */
 783 #define T38FAX_VERSION_1                        (1 << 6)        /*!< Version 1 */
 784 /* Maximum Fax Rate */
 785 #define T38FAX_RATE_2400                        (1 << 8)        /*!< 2400 bps t38FaxRate */
 786 #define T38FAX_RATE_4800                        (1 << 9)        /*!< 4800 bps t38FaxRate */
 787 #define T38FAX_RATE_7200                        (1 << 10)       /*!< 7200 bps t38FaxRate */
 788 #define T38FAX_RATE_9600                        (1 << 11)       /*!< 9600 bps t38FaxRate */
 789 #define T38FAX_RATE_12000                       (1 << 12)       /*!< 12000 bps t38FaxRate */
 790 #define T38FAX_RATE_14400                       (1 << 13)       /*!< 14400 bps t38FaxRate */
 791
 792 /*!< This is default: NO MMR and JBIG trancoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
 793 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
 794
 795 #define sipdebug                ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG)
 796 #define sipdebug_config         ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONFIG)
 797 #define sipdebug_console        ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONSOLE)
 798
 799 /*! \brief T38 States for a call */
 800 enum t38state {
 801         T38_DISABLED = 0,                /*!< Not enabled */
 802         T38_LOCAL_DIRECT,                /*!< Offered from local */
 803         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
 804         T38_PEER_DIRECT,                 /*!< Offered from peer */
 805         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
 806         T38_ENABLED                      /*!< Negotiated (enabled) */
 807 };
 808
 809 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
 810 struct t38properties {
 811         struct ast_flags t38support;    /*!< Flag for udptl, rtp or tcp support for this session */
 812         int capability;                 /*!< Our T38 capability */
 813         int peercapability;             /*!< Peers T38 capability */
 814         int jointcapability;            /*!< Supported T38 capability at both ends */
 815         enum t38state state;            /*!< T.38 state */
 816 };
 817
 818 /*! \brief Parameters to know status of transfer */
 819 enum referstatus {
 820         REFER_IDLE,                    /*!< No REFER is in progress */
 821         REFER_SENT,                    /*!< Sent REFER to transferee */
 822         REFER_RECEIVED,                /*!< Received REFER from transferer */
 823         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING */
 824         REFER_ACCEPTED,                /*!< Accepted by transferee */
 825         REFER_RINGING,                 /*!< Target Ringing */
 826         REFER_200OK,                   /*!< Answered by transfer target */
 827         REFER_FAILED,                  /*!< REFER declined - go on */
 828         REFER_NOAUTH                   /*!< We had no auth for REFER */
 829 };
 830
 831 static const struct c_referstatusstring {
 832         enum referstatus status;
 833         char *text;
 834 } referstatusstrings[] = {
 835         { REFER_IDLE,           "<none>" },
 836         { REFER_SENT,           "Request sent" },
 837         { REFER_RECEIVED,       "Request received" },
 838         { REFER_ACCEPTED,       "Accepted" },
 839         { REFER_RINGING,        "Target ringing" },
 840         { REFER_200OK,          "Done" },
 841         { REFER_FAILED,         "Failed" },
 842         { REFER_NOAUTH,         "Failed - auth failure" }
 843 } ;
 844
 845 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed  */
 846 /* OEJ: Should be moved to string fields */
 847 struct sip_refer {
 848         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
 849         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
 850         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
 851         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
 852         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
 853         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
 854         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
 855         char replaces_callid[BUFSIZ];                   /*!< Replace info: callid */
 856         char replaces_callid_totag[BUFSIZ/2];           /*!< Replace info: to-tag */
 857         char replaces_callid_fromtag[BUFSIZ/2];         /*!< Replace info: from-tag */
 858         struct sip_pvt *refer_call;                     /*!< Call we are referring */
 859         int attendedtransfer;                           /*!< Attended or blind transfer? */
 860         int localtransfer;                              /*!< Transfer to local domain? */
 861         enum referstatus status;                        /*!< REFER status */
 862 };
 863
 864 /*! \brief sip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe  */
 865 static struct sip_pvt {
 866         ast_mutex_t lock;                       /*!< Dialog private lock */
 867         int method;                             /*!< SIP method that opened this dialog */
 868         AST_DECLARE_STRING_FIELDS(
 869                 AST_STRING_FIELD(callid);       /*!< Global CallID */
 870                 AST_STRING_FIELD(randdata);     /*!< Random data */
 871                 AST_STRING_FIELD(accountcode);  /*!< Account code */
 872                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
 873                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
 874                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
 875                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
 876                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
 877                 AST_STRING_FIELD(from);         /*!< The From: header */
 878                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
 879                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
 880                 AST_STRING_FIELD(context);      /*!< Context for this call */
 881                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
 882                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
 883                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
 884                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
 885                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
 886                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
 887                 AST_STRING_FIELD(language);     /*!< Default language for this call */
 888                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
 889                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
 890                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
 891                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
 892                 AST_STRING_FIELD(username);     /*!< [user] name */
 893                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
 894                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
 895                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
 896                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
 897                 AST_STRING_FIELD(peersecret);   /*!< Password */
 898                 AST_STRING_FIELD(peermd5secret);
 899                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
 900                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
 901                 AST_STRING_FIELD(via);          /*!< Via: header */
 902                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
 903                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
 904                 AST_STRING_FIELD(rpid);         /*!< Our RPID header */
 905                 AST_STRING_FIELD(rpid_from);    /*!< Our RPID From header */
 906         );
 907         unsigned int ocseq;                     /*!< Current outgoing seqno */
 908         unsigned int icseq;                     /*!< Current incoming seqno */
 909         ast_group_t callgroup;                  /*!< Call group */
 910         ast_group_t pickupgroup;                /*!< Pickup group */
 911         int lastinvite;                         /*!< Last Cseq of invite */
 912         struct ast_flags flags[2];              /*!< SIP_ flags */
 913         int timer_t1;                           /*!< SIP timer T1, ms rtt */
 914         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
 915         struct ast_codec_pref prefs;            /*!< codec prefs */
 916         int capability;                         /*!< Special capability (codec) */
 917         int jointcapability;                    /*!< Supported capability at both ends (codecs ) */
 918         int peercapability;                     /*!< Supported peer capability */
 919         int prefcodec;                          /*!< Preferred codec (outbound only) */
 920         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
 921         int redircodecs;                        /*!< Redirect codecs */
 922         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */
 923         struct t38properties t38;               /*!< T38 settings */
 924         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
 925         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
 926         int callingpres;                        /*!< Calling presentation */
 927         int authtries;                          /*!< Times we've tried to authenticate */
 928         int expiry;                             /*!< How long we take to expire */
 929         long branch;                            /*!< The branch identifier of this session */
 930         char tag[11];                           /*!< Our tag for this session */
 931         int sessionid;                          /*!< SDP Session ID */
 932         int sessionversion;                     /*!< SDP Session Version */
 933         struct sockaddr_in sa;                  /*!< Our peer */
 934         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
 935         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
 936         time_t lastrtprx;                       /*!< Last RTP received */
 937         time_t lastrtptx;                       /*!< Last RTP sent */
 938         int rtptimeout;                         /*!< RTP timeout time */
 939         int rtpholdtimeout;                     /*!< RTP timeout when on hold */
 940         int rtpkeepalive;                       /*!< Send RTP packets for keepalive */
 941         struct sockaddr_in recv;                /*!< Received as */
 942         struct in_addr ourip;                   /*!< Our IP */
 943         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
 944         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
 945         int route_persistant;                   /*!< Is this the "real" route? */
 946         struct sip_auth *peerauth;              /*!< Realm authentication */
 947         int noncecount;                         /*!< Nonce-count */
 948         char lastmsg[256];                      /*!< Last Message sent/received */
 949         int amaflags;                           /*!< AMA Flags */
 950         int pendinginvite;                      /*!< Any pending invite ? (seqno of this) */
 951         struct sip_request initreq;             /*!< Initial request that opened the SIP dialog */
 952
 953         int maxtime;                            /*!< Max time for first response */
 954         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
 955         int autokillid;                         /*!< Auto-kill ID (scheduler) */
 956         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
 957         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
 958         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
 959         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
 960         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
 961         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
 962
 963         struct ast_dsp *vad;                    /*!< Voice Activation Detection dsp */
 964
 965         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one
 966                                                         Used in peerpoke, mwi subscriptions */
 967         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
 968         struct ast_rtp *rtp;                    /*!< RTP Session */
 969         struct ast_rtp *vrtp;                   /*!< Video RTP session */
 970         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
 971         struct sip_history_head *history;       /*!< History of this SIP dialog */
 972         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
 973         struct sip_pvt *next;                   /*!< Next dialog in chain */
 974         struct sip_invite_param *options;       /*!< Options for INVITE */
 975         int autoframing;
 976 } *iflist = NULL;
 977
 978 #define FLAG_RESPONSE (1 << 0)
 979 #define FLAG_FATAL (1 << 1)
 980
 981 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission */
 982 struct sip_pkt {
 983         struct sip_pkt *next;                   /*!< Next packet in linked list */
 984         int retrans;                            /*!< Retransmission number */
 985         int method;                             /*!< SIP method for this packet */
 986         int seqno;                              /*!< Sequence number */
 987         unsigned int flags;                     /*!< non-zero if this is a response packet (e.g. 200 OK) */
 988         struct sip_pvt *owner;                  /*!< Owner AST call */
 989         int retransid;                          /*!< Retransmission ID */
 990         int timer_a;                            /*!< SIP timer A, retransmission timer */
 991         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
 992         int packetlen;                          /*!< Length of packet */
 993         char data[0];
 994 };
 995
 996 /*! \brief Structure for SIP user data. User's place calls to us */
 997 struct sip_user {
 998         /* Users who can access various contexts */
 999         ASTOBJ_COMPONENTS(struct sip_user);
1000         char secret[80];                /*!< Password */
1001         char md5secret[80];             /*!< Password in md5 */
1002         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1003         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1004         char cid_num[80];               /*!< Caller ID num */
1005         char cid_name[80];              /*!< Caller ID name */
1006         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1007         char language[MAX_LANGUAGE];    /*!< Default language for this user */
1008         char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1009         char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1010         char useragent[256];            /*!< User agent in SIP request */
1011         struct ast_codec_pref prefs;    /*!< codec prefs */
1012         ast_group_t callgroup;          /*!< Call group */
1013         ast_group_t pickupgroup;        /*!< Pickup Group */
1014         unsigned int sipoptions;        /*!< Supported SIP options */
1015         struct ast_flags flags[2];      /*!< SIP_ flags */
1016         int amaflags;                   /*!< AMA flags for billing */
1017         int callingpres;                /*!< Calling id presentation */
1018         int capability;                 /*!< Codec capability */
1019         int inUse;                      /*!< Number of calls in use */
1020         int call_limit;                 /*!< Limit of concurrent calls */
1021         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1022         struct ast_ha *ha;              /*!< ACL setting */
1023         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1024         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1025         int autoframing;
1026 };
1027
1028 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1029 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1030 struct sip_peer {
1031         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1032                                         /*!< peer->name is the unique name of this object */
1033         char secret[80];                /*!< Password */
1034         char md5secret[80];             /*!< Password in MD5 */
1035         struct sip_auth *auth;          /*!< Realm authentication list */
1036         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1037         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1038         char username[80];              /*!< Temporary username until registration */
1039         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1040         int amaflags;                   /*!< AMA Flags (for billing) */
1041         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1042         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1043         char fromuser[80];              /*!< From: user when calling this peer */
1044         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1045         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1046         char cid_num[80];               /*!< Caller ID num */
1047         char cid_name[80];              /*!< Caller ID name */
1048         int callingpres;                /*!< Calling id presentation */
1049         int inUse;                      /*!< Number of calls in use */
1050         int inRinging;                  /*!< Number of calls ringing */
1051         int onHold;                     /*!< Peer has someone on hold */
1052         int call_limit;                 /*!< Limit of concurrent calls */
1053         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1054         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1055         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox setting for MWI checks */
1056         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1057         char mohinterpret[MAX_MUSICCLASS];/*!<  Music on Hold class */
1058         char mohsuggest[MAX_MUSICCLASS];/*!<  Music on Hold class */
1059         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1060         struct ast_codec_pref prefs;    /*!<  codec prefs */
1061         int lastmsgssent;
1062         time_t  lastmsgcheck;           /*!<  Last time we checked for MWI */
1063         unsigned int sipoptions;        /*!<  Supported SIP options */
1064         struct ast_flags flags[2];      /*!<  SIP_ flags */
1065         int expire;                     /*!<  When to expire this peer registration */
1066         int capability;                 /*!<  Codec capability */
1067         int rtptimeout;                 /*!<  RTP timeout */
1068         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1069         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1070         ast_group_t callgroup;          /*!<  Call group */
1071         ast_group_t pickupgroup;        /*!<  Pickup group */
1072         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1073         struct sockaddr_in addr;        /*!<  IP address of peer */
1074         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1075
1076         /* Qualification */
1077         struct sip_pvt *call;           /*!<  Call pointer */
1078         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1079         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1080         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1081         struct timeval ps;              /*!<  Ping send time */
1082
1083         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1084         struct ast_ha *ha;              /*!<  Access control list */
1085         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1086         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1087         int lastmsg;
1088         int autoframing;
1089 };
1090
1091
1092
1093 /*! \brief Registrations with other SIP proxies */
1094 struct sip_registry {
1095         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1096         AST_DECLARE_STRING_FIELDS(
1097                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1098                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1099                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1100                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1101                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1102                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1103                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1104                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1105                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1106                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
1107                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1108                 AST_STRING_FIELD(contact);      /*!< Contact extension */
1109                 AST_STRING_FIELD(random);
1110         );
1111         int portno;                     /*!<  Optional port override */
1112         int expire;                     /*!< Sched ID of expiration */
1113         int regattempts;                /*!< Number of attempts (since the last success) */
1114         int timeout;                    /*!< sched id of sip_reg_timeout */
1115         int refresh;                    /*!< How often to refresh */
1116         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1117         enum sipregistrystate regstate; /*!< Registration state (see above) */
1118         time_t regtime;         /*!< Last succesful registration time */
1119         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1120         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1121         struct sockaddr_in us;          /*!< Who the server thinks we are */
1122         int noncecount;                 /*!< Nonce-count */
1123         char lastmsg[256];              /*!< Last Message sent/received */
1124 };
1125
1126 /* --- Linked lists of various objects --------*/
1127
1128 /*! \brief  The user list: Users and friends */
1129 static struct ast_user_list {
1130         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1131 } userl;
1132
1133 /*! \brief  The peer list: Peers and Friends */
1134 static struct ast_peer_list {
1135         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1136 } peerl;
1137
1138 /*! \brief  The register list: Other SIP proxys we register with and place calls to */
1139 static struct ast_register_list {
1140         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1141         int recheck;
1142 } regl;
1143
1144 /*! \todo Move the sip_auth list to AST_LIST */
1145 static struct sip_auth *authl = NULL;           /*!< Authentication list for realm authentication */
1146
1147
1148 /* --- Sockets and networking --------------*/
1149 static int sipsock  = -1;                       /*!< Main socket for SIP network communication */
1150 static struct sockaddr_in bindaddr = { 0, };    /*!< The address we bind to */
1151 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1152 static char externhost[MAXHOSTNAMELEN];         /*!< External host name (possibly with dynamic DNS and DHCP */
1153 static time_t externexpire = 0;                 /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1154 static int externrefresh = 10;
1155 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1156 static struct in_addr __ourip;
1157 static struct sockaddr_in outboundproxyip;
1158 static int ourport;
1159 static struct sockaddr_in debugaddr;
1160
1161 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1162
1163 /*---------------------------- Forward declarations of functions in chan_sip.c */
1164 /*! \note This is added to help splitting up chan_sip.c into several files
1165         in coming releases */
1166
1167 /*--- PBX interface functions */
1168 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1169 static int sip_devicestate(void *data);
1170 static int sip_sendtext(struct ast_channel *ast, const char *text);
1171 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1172 static int sip_hangup(struct ast_channel *ast);
1173 static int sip_answer(struct ast_channel *ast);
1174 static struct ast_frame *sip_read(struct ast_channel *ast);
1175 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1176 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1177 static int sip_transfer(struct ast_channel *ast, const char *dest);
1178 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1179 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1180 static int sip_senddigit_end(struct ast_channel *ast, char digit);
1181
1182 /*--- Transmitting responses and requests */
1183 static int sipsock_read(int *id, int fd, short events, void *ignore);
1184 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1185 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1186 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1187 static int retrans_pkt(void *data);
1188 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1189 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1190 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1191 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1192 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1193 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1194 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);
1195 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1196 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1197 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1198 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1199 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1200 static int transmit_reinvite_with_sdp(struct sip_pvt *p);
1201 static int transmit_info_with_digit(struct sip_pvt *p, const char digit);
1202 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1203 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1204 static int transmit_refer(struct sip_pvt *p, const char *dest);
1205 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1206 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1207 static int transmit_state_notify(struct sip_pvt *p, int state, int full);
1208 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1209 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1210 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1211 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1212 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1213 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1214 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1215 static int does_peer_need_mwi(struct sip_peer *peer);
1216
1217 /*--- Dialog management */
1218 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1219                                  int useglobal_nat, const int intended_method);
1220 static int __sip_autodestruct(void *data);
1221 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1222 static void sip_cancel_destroy(struct sip_pvt *p);
1223 static void sip_destroy(struct sip_pvt *p);
1224 static void __sip_destroy(struct sip_pvt *p, int lockowner);
1225 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset);
1226 static void __sip_pretend_ack(struct sip_pvt *p);
1227 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1228 static int auto_congest(void *nothing);
1229 static int update_call_counter(struct sip_pvt *fup, int event);
1230 static int hangup_sip2cause(int cause);
1231 static const char *hangup_cause2sip(int cause);
1232 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1233 static void free_old_route(struct sip_route *route);
1234 static void list_route(struct sip_route *route);
1235 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1236 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1237                                               struct sip_request *req, char *uri);
1238 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1239 static void check_pendings(struct sip_pvt *p);
1240 static void *sip_park_thread(void *stuff);
1241 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1242 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1243
1244 /*--- Codec handling / SDP */
1245 static void try_suggested_sip_codec(struct sip_pvt *p);
1246 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1247 static const char *get_sdp(struct sip_request *req, const char *name);
1248 static int find_sdp(struct sip_request *req);
1249 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1250 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1251                              char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1252                              int debug, int *min_packet_size);
1253 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1254                                 char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1255                                 int debug);
1256 static int add_sdp(struct sip_request *resp, struct sip_pvt *p);
1257 static void do_setnat(struct sip_pvt *p, int natflags);
1258
1259 /*--- Authentication stuff */
1260 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1261 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1262 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1263 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);   /* Add realm authentication in list */
1264 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);        /* Find authentication for a specific realm */
1265 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1266                                          const char *secret, const char *md5secret, int sipmethod,
1267                                          char *uri, enum xmittype reliable, int ignore);
1268 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1269                                               int sipmethod, char *uri, enum xmittype reliable,
1270                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1271 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1272
1273 /*--- Domain handling */
1274 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1275 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1276 static void clear_sip_domains(void);
1277
1278 /*--- SIP realm authentication */
1279 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);
1280 static int clear_realm_authentication(struct sip_auth *authlist);
1281 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1282
1283 /*--- Misc functions */
1284 static int sip_do_reload(enum channelreloadreason reason);
1285 static int reload_config(enum channelreloadreason reason);
1286 static int expire_register(void *data);
1287 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1288 static void *do_monitor(void *data);
1289 static int restart_monitor(void);
1290 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1291 static void sip_destroy(struct sip_pvt *p);
1292 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1293 static int sip_refer_allocate(struct sip_pvt *p);
1294 static void ast_quiet_chan(struct ast_channel *chan);
1295 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1296
1297 /*--- Device monitoring and Device/extension state handling */
1298 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1299 static int sip_devicestate(void *data);
1300 static int sip_poke_noanswer(void *data);
1301 static int sip_poke_peer(struct sip_peer *peer);
1302 static void sip_poke_all_peers(void);
1303 static void sip_peer_hold(struct sip_pvt *p, int hold);
1304
1305 /*--- Applications, functions, CLI and manager command helpers */
1306 static const char *sip_nat_mode(const struct sip_pvt *p);
1307 static int sip_show_inuse(int fd, int argc, char *argv[]);
1308 static char *transfermode2str(enum transfermodes mode) attribute_const;
1309 static char *nat2str(int nat) attribute_const;
1310 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1311 static int sip_show_users(int fd, int argc, char *argv[]);
1312 static int _sip_show_peers(int fd, int *total, struct mansession *s, struct message *m, int argc, char *argv[]);
1313 static int manager_sip_show_peers( struct mansession *s, struct message *m );
1314 static int sip_show_peers(int fd, int argc, char *argv[]);
1315 static int sip_show_objects(int fd, int argc, char *argv[]);
1316 static void  print_group(int fd, ast_group_t group, int crlf);
1317 static const char *dtmfmode2str(int mode) attribute_const;
1318 static const char *insecure2str(int port, int invite) attribute_const;
1319 static void cleanup_stale_contexts(char *new, char *old);
1320 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1321 static const char *domain_mode_to_text(const enum domain_mode mode);
1322 static int sip_show_domains(int fd, int argc, char *argv[]);
1323 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1324 static int manager_sip_show_peer( struct mansession *s, struct message *m);
1325 static int sip_show_peer(int fd, int argc, char *argv[]);
1326 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1327 static int sip_show_user(int fd, int argc, char *argv[]);
1328 static int sip_show_registry(int fd, int argc, char *argv[]);
1329 static int sip_show_settings(int fd, int argc, char *argv[]);
1330 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1331 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1332 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1333 static int sip_show_channels(int fd, int argc, char *argv[]);
1334 static int sip_show_subscriptions(int fd, int argc, char *argv[]);
1335 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1336 static char *complete_sipch(const char *line, const char *word, int pos, int state);
1337 static char *complete_sip_peer(const char *word, int state, int flags2);
1338 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1339 static char *complete_sip_debug_peer(const char *line, const char *word, int pos, int state);
1340 static char *complete_sip_user(const char *word, int state, int flags2);
1341 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1342 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1343 static char *complete_sip_prune_realtime_peer(const char *line, const char *word, int pos, int state);
1344 static char *complete_sip_prune_realtime_user(const char *line, const char *word, int pos, int state);
1345 static int sip_show_channel(int fd, int argc, char *argv[]);
1346 static int sip_show_history(int fd, int argc, char *argv[]);
1347 static int sip_do_debug_ip(int fd, int argc, char *argv[]);
1348 static int sip_do_debug_peer(int fd, int argc, char *argv[]);
1349 static int sip_do_debug(int fd, int argc, char *argv[]);
1350 static int sip_no_debug(int fd, int argc, char *argv[]);
1351 static int sip_notify(int fd, int argc, char *argv[]);
1352 static int sip_do_history(int fd, int argc, char *argv[]);
1353 static int sip_no_history(int fd, int argc, char *argv[]);
1354 static int func_header_read(struct ast_channel *chan, char *function, char *data, char *buf, size_t len);
1355 static int func_check_sipdomain(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1356 static int function_sippeer(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1357 static int function_sipchaninfo_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1358 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1359 static int sip_addheader(struct ast_channel *chan, void *data);
1360 static int sip_do_reload(enum channelreloadreason reason);
1361 static int sip_reload(int fd, int argc, char *argv[]);
1362
1363 /*--- Debugging
1364         Functions for enabling debug per IP or fully, or enabling history logging for
1365         a SIP dialog
1366 */
1367 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
1368 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1369 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1370 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1371 static void sip_dump_history(struct sip_pvt *dialog);
1372
1373 /*--- Device object handling */
1374 static struct sip_peer *temp_peer(const char *name);
1375 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1376 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1377 static int update_call_counter(struct sip_pvt *fup, int event);
1378 static void sip_destroy_peer(struct sip_peer *peer);
1379 static void sip_destroy_user(struct sip_user *user);
1380 static int sip_poke_peer(struct sip_peer *peer);
1381 static void set_peer_defaults(struct sip_peer *peer);
1382 static struct sip_peer *temp_peer(const char *name);
1383 static void register_peer_exten(struct sip_peer *peer, int onoff);
1384 static void sip_destroy_peer(struct sip_peer *peer);
1385 static void sip_destroy_user(struct sip_user *user);
1386 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1387 static struct sip_user *find_user(const char *name, int realtime);
1388 static int sip_poke_peer_s(void *data);
1389 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1390 static int expire_register(void *data);
1391 static void reg_source_db(struct sip_peer *peer);
1392 static void destroy_association(struct sip_peer *peer);
1393 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1394
1395 /* Realtime device support */
1396 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1397 static struct sip_user *realtime_user(const char *username);
1398 static void update_peer(struct sip_peer *p, int expiry);
1399 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1400 static int sip_prune_realtime(int fd, int argc, char *argv[]);
1401
1402 /*--- Internal UA client handling (outbound registrations) */
1403 static int ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us);
1404 static void sip_registry_destroy(struct sip_registry *reg);
1405 static int sip_register(char *value, int lineno);
1406 static char *regstate2str(enum sipregistrystate regstate) attribute_const;
1407 static int sip_reregister(void *data);
1408 static int __sip_do_register(struct sip_registry *r);
1409 static int sip_reg_timeout(void *data);
1410 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod,  char *digest, int digest_len);
1411 static void sip_send_all_registers(void);
1412
1413 /*--- Parsing SIP requests and responses */
1414 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1415 static int determine_firstline_parts(struct sip_request *req);
1416 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1417 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1418 static int find_sip_method(const char *msg);
1419 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1420 static void parse_request(struct sip_request *req);
1421 static const char *get_header(const struct sip_request *req, const char *name);
1422 static char *referstatus2str(enum referstatus rstatus) attribute_pure;
1423 static int method_match(enum sipmethod id, const char *name);
1424 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1425 static char *get_in_brackets(char *tmp);
1426 static const char *find_alias(const char *name, const char *_default);
1427 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1428 static const char *get_header(const struct sip_request *req, const char *name);
1429 static int lws2sws(char *msgbuf, int len);
1430 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1431 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1432 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1433 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1434 static int set_address_from_contact(struct sip_pvt *pvt);
1435 static void check_via(struct sip_pvt *p, struct sip_request *req);
1436 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1437 static int get_rpid_num(const char *input, char *output, int maxlen);
1438 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1439 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1440 static int get_msg_text(char *buf, int len, struct sip_request *req);
1441 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1442 static void free_old_route(struct sip_route *route);
1443
1444 /*--- Constructing requests and responses */
1445 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1446 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1447 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1448 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1449 static int init_resp(struct sip_request *resp, const char *msg);
1450 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1451 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1452 static void build_via(struct sip_pvt *p);
1453 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1454 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1455 static char *generate_random_string(char *buf, size_t size);
1456 static void build_callid_pvt(struct sip_pvt *pvt);
1457 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1458 static void make_our_tag(char *tagbuf, size_t len);
1459 static int add_header(struct sip_request *req, const char *var, const char *value);
1460 static int add_header_contentLength(struct sip_request *req, int len);
1461 static int add_line(struct sip_request *req, const char *line);
1462 static int add_text(struct sip_request *req, const char *text);
1463 static int add_digit(struct sip_request *req, char digit);
1464 static int add_vidupdate(struct sip_request *req);
1465 static void add_route(struct sip_request *req, struct sip_route *route);
1466 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1467 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1468 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1469 static void set_destination(struct sip_pvt *p, char *uri);
1470 static void append_date(struct sip_request *req);
1471 static void build_contact(struct sip_pvt *p);
1472 static void build_rpid(struct sip_pvt *p);
1473
1474 /*------Request handling functions */
1475 static int handle_request(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1476 static int handle_request_invite(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *recount, char *e);
1477 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, int *nounlock);
1478 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1479 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1480 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1481 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1482 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1483 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1484 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1485 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1486 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1487 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1488 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1489
1490 /*------Response handling functions */
1491 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1492 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1493 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int ignore, int seqno);
1494 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int ignore, int seqno);
1495
1496 /*----- RTP interface functions */
1497 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp, int codecs, int nat_active);
1498 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1499 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1500 static int sip_get_codec(struct ast_channel *chan);
1501 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1502
1503 /*------ T38 Support --------- */
1504 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); /*!< T38 negotiation helper function */
1505 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1506 static int transmit_reinvite_with_t38_sdp(struct sip_pvt *p);
1507 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1508 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1509
1510 /*! \brief Definition of this channel for PBX channel registration */
1511 static const struct ast_channel_tech sip_tech = {
1512         .type = "SIP",
1513         .description = "Session Initiation Protocol (SIP)",
1514         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1515         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1516         .requester = sip_request_call,
1517         .devicestate = sip_devicestate,
1518         .call = sip_call,
1519         .hangup = sip_hangup,
1520         .answer = sip_answer,
1521         .read = sip_read,
1522         .write = sip_write,
1523         .write_video = sip_write,
1524         .indicate = sip_indicate,
1525         .transfer = sip_transfer,
1526         .fixup = sip_fixup,
1527         .send_digit_begin = sip_senddigit_begin,
1528         .send_digit_end = sip_senddigit_end,
1529         .bridge = ast_rtp_bridge,
1530         .early_bridge = ast_rtp_early_bridge,
1531         .send_text = sip_sendtext,
1532 };
1533
1534 /**--- some list management macros. **/
1535
1536 #define UNLINK(element, head, prev) do {        \
1537         if (prev)                               \
1538                 (prev)->next = (element)->next; \
1539         else                                    \
1540                 (head) = (element)->next;       \
1541         } while (0)
1542
1543 /*! \brief Interface structure with callbacks used to connect to RTP module */
1544 static struct ast_rtp_protocol sip_rtp = {
1545         type: "SIP",
1546         get_rtp_info: sip_get_rtp_peer,
1547         get_vrtp_info: sip_get_vrtp_peer,
1548         set_rtp_peer: sip_set_rtp_peer,
1549         get_codec: sip_get_codec,
1550 };
1551
1552 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
1553 static struct ast_udptl_protocol sip_udptl = {
1554         type: "SIP",
1555         get_udptl_info: sip_get_udptl_peer,
1556         set_udptl_peer: sip_set_udptl_peer,
1557 };
1558
1559 /*! \brief Convert transfer status to string */
1560 static char *referstatus2str(enum referstatus rstatus)
1561 {
1562         int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1563         int x;
1564
1565         for (x = 0; x < i; x++) {
1566                 if (referstatusstrings[x].status ==  rstatus)
1567                         return (char *) referstatusstrings[x].text;
1568         }
1569         return "";
1570 }
1571
1572 /*! \brief Initialize the initital request packet in the pvt structure.
1573         This packet is used for creating replies and future requests in
1574         a dialog */
1575 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1576 {
1577         if (p->initreq.headers && option_debug) {
1578                 ast_log(LOG_DEBUG, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1579         }
1580         /* Use this as the basis */
1581         copy_request(&p->initreq, req);
1582         parse_request(&p->initreq);
1583         if (ast_test_flag(req, SIP_PKT_DEBUG))
1584                 ast_verbose("%d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1585 }
1586
1587
1588 /*! \brief returns true if 'name' (with optional trailing whitespace)
1589  * matches the sip method 'id'.
1590  * Strictly speaking, SIP methods are case SENSITIVE, but we do
1591  * a case-insensitive comparison to be more tolerant.
1592  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
1593  */
1594 static int method_match(enum sipmethod id, const char *name)
1595 {
1596         int len = strlen(sip_methods[id].text);
1597         int l_name = name ? strlen(name) : 0;
1598         /* true if the string is long enough, and ends with whitespace, and matches */
1599         return (l_name >= len && name[len] < 33 &&
1600                 !strncasecmp(sip_methods[id].text, name, len));
1601 }
1602
1603 /*! \brief  find_sip_method: Find SIP method from header */
1604 static int find_sip_method(const char *msg)
1605 {
1606         int i, res = 0;
1607
1608         if (ast_strlen_zero(msg))
1609                 return 0;
1610         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1611                 if (method_match(i, msg))
1612                         res = sip_methods[i].id;
1613         }
1614         return res;
1615 }
1616
1617 /*! \brief Parse supported header in incoming packet */
1618 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1619 {
1620         char *next, *sep;
1621         char *temp = ast_strdupa(supported);
1622         unsigned int profile = 0;
1623         int i, found;
1624
1625         if (ast_strlen_zero(supported) )
1626                 return 0;
1627
1628         if (option_debug > 2 && sipdebug)
1629                 ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1630
1631         for (next = temp; next; next = sep) {
1632                 found = FALSE;
1633                 if ( (sep = strchr(next, ',')) != NULL)
1634                         *sep++ = '\0';
1635                 next = ast_skip_blanks(next);
1636                 if (option_debug > 2 && sipdebug)
1637                         ast_log(LOG_DEBUG, "Found SIP option: -%s-\n", next);
1638                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1639                         if (!strcasecmp(next, sip_options[i].text)) {
1640                                 profile |= sip_options[i].id;
1641                                 found = TRUE;
1642                                 if (option_debug > 2 && sipdebug)
1643                                         ast_log(LOG_DEBUG, "Matched SIP option: %s\n", next);
1644                                 break;
1645                         }
1646                 }
1647                 if (!found && option_debug > 2 && sipdebug) {
1648                         if (!strncasecmp(next, "x-", 2))
1649                                 ast_log(LOG_DEBUG, "Found private SIP option, not supported: %s\n", next);
1650                         else
1651                                 ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1652                 }
1653         }
1654
1655         if (pvt)
1656                 pvt->sipoptions = profile;
1657         return profile;
1658 }
1659
1660 /*! \brief See if we pass debug IP filter */
1661 static inline int sip_debug_test_addr(const struct sockaddr_in *addr)
1662 {
1663         if (!sipdebug)
1664                 return 0;
1665         if (debugaddr.sin_addr.s_addr) {
1666                 if (((ntohs(debugaddr.sin_port) != 0)
1667                         && (debugaddr.sin_port != addr->sin_port))
1668                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1669                         return 0;
1670         }
1671         return 1;
1672 }
1673
1674 /*! \brief The real destination address for a write */
1675 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1676 {
1677         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1678 }
1679
1680 /*! \brief Display SIP nat mode */
1681 static const char *sip_nat_mode(const struct sip_pvt *p)
1682 {
1683         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1684 }
1685
1686 /*! \brief Test PVT for debugging output */
1687 static inline int sip_debug_test_pvt(struct sip_pvt *p)
1688 {
1689         if (!sipdebug)
1690                 return 0;
1691         return sip_debug_test_addr(sip_real_dst(p));
1692 }
1693
1694 /*! \brief Transmit SIP message */
1695 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
1696 {
1697         int res;
1698         const struct sockaddr_in *dst = sip_real_dst(p);
1699         res = sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
1700
1701         if (res != len)
1702                 ast_log(LOG_WARNING, "sip_xmit of %p (len %d) to %s:%d returned %d: %s\n", data, len, ast_inet_ntoa(dst->sin_addr), ntohs(dst->sin_port), res, strerror(errno));
1703         return res;
1704 }
1705
1706
1707 /*! \brief Build a Via header for a request */
1708 static void build_via(struct sip_pvt *p)
1709 {
1710         /* Work around buggy UNIDEN UIP200 firmware */
1711         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
1712
1713         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
1714         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
1715                          ast_inet_ntoa(p->ourip), ourport, p->branch, rport);
1716 }
1717
1718 /*! \brief NAT fix - decide which IP address to use for ASterisk server?
1719  *
1720  * Using the localaddr structure built up with localnet statements in sip.conf
1721  * apply it to their address to see if we need to substitute our
1722  * externip or can get away with our internal bindaddr
1723  */
1724 static enum sip_result ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us)
1725 {
1726         struct sockaddr_in theirs, ours;
1727
1728         /* Get our local information */
1729         ast_ouraddrfor(them, us);
1730         theirs.sin_addr = *them;
1731         ours.sin_addr = *us;
1732
1733         if (localaddr && externip.sin_addr.s_addr &&
1734             ast_apply_ha(localaddr, &theirs) &&
1735             !ast_apply_ha(localaddr, &ours)) {
1736                 if (externexpire && time(NULL) >= externexpire) {
1737                         struct ast_hostent ahp;
1738                         struct hostent *hp;
1739
1740                         externexpire = time(NULL) + externrefresh;
1741                         if ((hp = ast_gethostbyname(externhost, &ahp))) {
1742                                 memcpy(&externip.sin_addr, hp->h_addr, sizeof(externip.sin_addr));
1743                         } else
1744                                 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
1745                 }
1746                 *us = externip.sin_addr;
1747                 if (option_debug) {
1748                         ast_log(LOG_DEBUG, "Target address %s is not local, substituting externip\n",
1749                                 ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
1750                 }
1751         } else if (bindaddr.sin_addr.s_addr)
1752                 *us = bindaddr.sin_addr;
1753         return AST_SUCCESS;
1754 }
1755
1756 /*! \brief Append to SIP dialog history
1757         \return Always returns 0 */
1758 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1759
1760 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1761         __attribute__ ((format (printf, 2, 3)));
1762
1763 /*! \brief Append to SIP dialog history with arg list  */
1764 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
1765 {
1766         char buf[80], *c = buf; /* max history length */
1767         struct sip_history *hist;
1768         int l;
1769
1770         vsnprintf(buf, sizeof(buf), fmt, ap);
1771         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
1772         l = strlen(buf) + 1;
1773         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
1774                 return;
1775         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
1776                 free(hist);
1777                 return;
1778         }
1779         memcpy(hist->event, buf, l);
1780         AST_LIST_INSERT_TAIL(p->history, hist, list);
1781 }
1782
1783 /*! \brief Append to SIP dialog history with arg list  */
1784 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1785 {
1786         va_list ap;
1787
1788         if (!recordhistory || !p)
1789                 return;
1790         va_start(ap, fmt);
1791         append_history_va(p, fmt, ap);
1792         va_end(ap);
1793
1794         return;
1795 }
1796
1797 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
1798 static int retrans_pkt(void *data)
1799 {
1800         struct sip_pkt *pkt = data, *prev, *cur = NULL;
1801         int reschedule = DEFAULT_RETRANS;
1802
1803         /* Lock channel PVT */
1804         ast_mutex_lock(&pkt->owner->lock);
1805
1806         if (pkt->retrans < MAX_RETRANS) {
1807                 pkt->retrans++;
1808                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
1809                         if (sipdebug && option_debug > 3)
1810                                 ast_log(LOG_DEBUG, "SIP TIMER: Not rescheduling id #%d:%s (Method %d) (No timer T1)\n", pkt->retransid, sip_methods[pkt->method].text, pkt->method);
1811                 } else {
1812                         int siptimer_a;
1813
1814                         if (sipdebug && option_debug > 3)
1815                                 ast_log(LOG_DEBUG, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
1816                         if (!pkt->timer_a)
1817                                 pkt->timer_a = 2 ;
1818                         else
1819                                 pkt->timer_a = 2 * pkt->timer_a;
1820
1821                         /* For non-invites, a maximum of 4 secs */
1822                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
1823                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
1824                                 siptimer_a = 4000;
1825
1826                         /* Reschedule re-transmit */
1827                         reschedule = siptimer_a;
1828                         if (option_debug > 3)
1829                                 ast_log(LOG_DEBUG, "** SIP timers: Rescheduling retransmission %d to %d ms (t1 %d ms (Retrans id #%d)) \n", pkt->retrans +1, siptimer_a, pkt->timer_t1, pkt->retransid);
1830                 }
1831
1832                 if (sip_debug_test_pvt(pkt->owner)) {
1833                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
1834                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
1835                                 pkt->retrans, sip_nat_mode(pkt->owner),
1836                                 ast_inet_ntoa(dst->sin_addr),
1837                                 ntohs(dst->sin_port), pkt->data);
1838                 }
1839
1840                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
1841                 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
1842                 ast_mutex_unlock(&pkt->owner->lock);
1843                 return  reschedule;
1844         }
1845         /* Too many retries */
1846         if (pkt->owner && pkt->method != SIP_OPTIONS) {
1847                 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
1848                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n", pkt->owner->callid, pkt->seqno, (ast_test_flag(pkt, FLAG_FATAL)) ? "Critical" : "Non-critical", (ast_test_flag(pkt, FLAG_RESPONSE)) ? "Response" : "Request");
1849         } else {
1850                 if ((pkt->method == SIP_OPTIONS) && sipdebug)
1851                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
1852         }
1853         append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
1854
1855         pkt->retransid = -1;
1856
1857         if (ast_test_flag(pkt, FLAG_FATAL)) {
1858                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
1859                         ast_mutex_unlock(&pkt->owner->lock);    /* SIP_PVT, not channel */
1860                         usleep(1);
1861                         ast_mutex_lock(&pkt->owner->lock);
1862                 }
1863                 if (pkt->owner->owner) {
1864                         ast_set_flag(&pkt->owner->flags[0], SIP_ALREADYGONE);
1865                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
1866                         ast_queue_hangup(pkt->owner->owner);
1867                         ast_channel_unlock(pkt->owner->owner);
1868                 } else {
1869                         /* If no channel owner, destroy now */
1870                         ast_set_flag(&pkt->owner->flags[0], SIP_NEEDDESTROY);
1871                 }
1872         }
1873         /* In any case, go ahead and remove the packet */
1874         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
1875                 if (cur == pkt)
1876                         break;
1877         }
1878         if (cur) {
1879                 if (prev)
1880                         prev->next = cur->next;
1881                 else
1882                         pkt->owner->packets = cur->next;
1883                 ast_mutex_unlock(&pkt->owner->lock);
1884                 free(cur);
1885                 pkt = NULL;
1886         } else
1887                 ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
1888         if (pkt)
1889                 ast_mutex_unlock(&pkt->owner->lock);
1890         return 0;
1891 }
1892
1893 /*! \brief Transmit packet with retransmits
1894         \return 0 on success, -1 on failure to allocate packet
1895 */
1896 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
1897 {
1898         struct sip_pkt *pkt;
1899         int siptimer_a = DEFAULT_RETRANS;
1900
1901         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
1902                 return AST_FAILURE;
1903         memcpy(pkt->data, data, len);
1904         pkt->method = sipmethod;
1905         pkt->packetlen = len;
1906         pkt->next = p->packets;
1907         pkt->owner = p;
1908         pkt->seqno = seqno;
1909         pkt->flags = resp;
1910         pkt->data[len] = '\0';
1911         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
1912         if (fatal)
1913                 ast_set_flag(pkt, FLAG_FATAL);
1914         if (pkt->timer_t1)
1915                 siptimer_a = pkt->timer_t1 * 2;
1916
1917         /* Schedule retransmission */
1918         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
1919         if (option_debug > 3 && sipdebug)
1920                 ast_log(LOG_DEBUG, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
1921         pkt->next = p->packets;
1922         p->packets = pkt;
1923
1924         __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);      /* Send packet */
1925         if (sipmethod == SIP_INVITE) {
1926                 /* Note this is a pending invite */
1927                 p->pendinginvite = seqno;
1928         }
1929         return AST_SUCCESS;
1930 }
1931
1932 /*! \brief Kill a SIP dialog (called by scheduler) */
1933 static int __sip_autodestruct(void *data)
1934 {
1935         struct sip_pvt *p = data;
1936
1937         /* If this is a subscription, tell the phone that we got a timeout */
1938         if (p->subscribed) {
1939                 p->subscribed = TIMEOUT;
1940                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1); /* Send last notification */
1941                 p->subscribed = NONE;
1942                 append_history(p, "Subscribestatus", "timeout");
1943                 if (option_debug > 2)
1944                         ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
1945                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
1946         }
1947
1948         /* Reset schedule ID */
1949         p->autokillid = -1;
1950
1951         if (option_debug)
1952                 ast_log(LOG_DEBUG, "Auto destroying SIP dialog '%s'\n", p->callid);
1953         append_history(p, "AutoDestroy", "%s", p->callid);
1954         if (p->owner) {
1955                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
1956                 ast_queue_hangup(p->owner);
1957         } else if (p->refer) {
1958                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
1959         } else {
1960                 sip_destroy(p);
1961         }
1962         return 0;
1963 }
1964
1965 /*! \brief Schedule destruction of SIP dialog */
1966 static void sip_scheddestroy(struct sip_pvt *p, int ms)
1967 {
1968         if (ms < 0) {
1969                 if (p->timer_t1 == 0)
1970                         p->timer_t1 = 500;      /* Set timer T1 if not set (RFC 3261) */
1971                 ms = p->timer_t1 * 64;
1972         }
1973         if (sip_debug_test_pvt(p))
1974                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
1975         if (recordhistory)
1976                 append_history(p, "SchedDestroy", "%d ms", ms);
1977
1978         if (p->autokillid > -1)
1979                 ast_sched_del(sched, p->autokillid);
1980         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
1981 }
1982
1983 /*! \brief Cancel destruction of SIP dialog */
1984 static void sip_cancel_destroy(struct sip_pvt *p)
1985 {
1986         if (p->autokillid > -1) {
1987                 ast_sched_del(sched, p->autokillid);
1988                 append_history(p, "CancelDestroy", "");
1989                 p->autokillid = -1;
1990         }
1991 }
1992
1993 /*! \brief Acknowledges receipt of a packet and stops retransmission */
1994 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset)
1995 {
1996         struct sip_pkt *cur, *prev = NULL;
1997
1998         /* Just in case... */
1999         char *msg;
2000         int res = FALSE;
2001
2002         msg = sip_methods[sipmethod].text;
2003
2004         ast_mutex_lock(&p->lock);
2005         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2006                 if ((cur->seqno == seqno) && ((ast_test_flag(cur, FLAG_RESPONSE)) == resp) &&
2007                         ((ast_test_flag(cur, FLAG_RESPONSE)) ||
2008                          (!strncasecmp(msg, cur->data, strlen(msg)) && (cur->data[strlen(msg)] < 33)))) {
2009                         if (!resp && (seqno == p->pendinginvite)) {
2010                                 if (option_debug)
2011                                         ast_log(LOG_DEBUG, "Acked pending invite %d\n", p->pendinginvite);
2012                                 p->pendinginvite = 0;
2013                         }
2014                         /* this is our baby */
2015                         res = TRUE;
2016                         UNLINK(cur, p->packets, prev);
2017                         if (cur->retransid > -1) {
2018                                 if (sipdebug && option_debug > 3)
2019                                         ast_log(LOG_DEBUG, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2020                                 ast_sched_del(sched, cur->retransid);
2021                         }
2022                         if (!reset)
2023                                 free(cur);
2024                         break;
2025                 }
2026         }
2027         ast_mutex_unlock(&p->lock);
2028         if (option_debug)
2029                 ast_log(LOG_DEBUG, "Stopping retransmission on '%s' of %s %d: Match %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
2030 }
2031
2032 /*! \brief Pretend to ack all packets
2033  * maybe the lock on p is not strictly necessary but there might be a race */
2034 static void __sip_pretend_ack(struct sip_pvt *p)
2035 {
2036         struct sip_pkt *cur = NULL;
2037
2038         while (p->packets) {
2039                 int method;
2040                 if (cur == p->packets) {
2041                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2042                         return;
2043                 }
2044                 cur = p->packets;
2045                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2046                 __sip_ack(p, cur->seqno, ast_test_flag(cur, FLAG_RESPONSE), method, FALSE);
2047         }
2048 }
2049
2050 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2051 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2052 {
2053         struct sip_pkt *cur;
2054         int res = -1;
2055
2056         for (cur = p->packets; cur; cur = cur->next) {
2057                 if (cur->seqno == seqno && ast_test_flag(cur, FLAG_RESPONSE) == resp &&
2058                         (ast_test_flag(cur, FLAG_RESPONSE) || method_match(sipmethod, cur->data))) {
2059                         /* this is our baby */
2060                         if (cur->retransid > -1) {
2061                                 if (option_debug > 3 && sipdebug)
2062                                         ast_log(LOG_DEBUG, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2063                                 ast_sched_del(sched, cur->retransid);
2064                         }
2065                         cur->retransid = -1;
2066                         res = 0;
2067                         break;
2068                 }
2069         }
2070         if (option_debug)
2071                 ast_log(LOG_DEBUG, "(Provisional) Stopping retransmission (but retaining packet) on '%s' %s %d: %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
2072         return res;
2073 }
2074
2075
2076 /*! \brief Copy SIP request, parse it */
2077 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2078 {
2079         memset(dst, 0, sizeof(*dst));
2080         memcpy(dst->data, src->data, sizeof(dst->data));
2081         dst->len = src->len;
2082         parse_request(dst);
2083 }
2084
2085 /*! \brief add a blank line if no body */
2086 static void add_blank(struct sip_request *req)
2087 {
2088         if (!req->lines) {
2089                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2090                 snprintf(req->data + req->len, sizeof(req->data) - req->len, "\r\n");
2091                 req->len += strlen(req->data + req->len);
2092         }
2093 }
2094
2095 /*! \brief Transmit response on SIP request*/
2096 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2097 {
2098         int res;
2099
2100         add_blank(req);
2101         if (sip_debug_test_pvt(p)) {
2102                 const struct sockaddr_in *dst = sip_real_dst(p);
2103
2104                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
2105                         reliable ? "Reliably " : "", sip_nat_mode(p),
2106                         ast_inet_ntoa(dst->sin_addr),
2107                         ntohs(dst->sin_port), req->data);
2108         }
2109         if (recordhistory) {
2110                 struct sip_request tmp;
2111                 parse_copy(&tmp, req);
2112                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"),
2113                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
2114         }
2115         res = (reliable) ?
2116                 __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2117                 __sip_xmit(p, req->data, req->len);
2118         if (res > 0)
2119                 return 0;
2120         return res;
2121 }
2122
2123 /*! \brief Send SIP Request to the other part of the dialogue */
2124 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2125 {
2126         int res;
2127
2128         add_blank(req);
2129         if (sip_debug_test_pvt(p)) {
2130                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
2131                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->recv.sin_addr), ntohs(p->recv.sin_port), req->data);
2132                 else
2133                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->sa.sin_addr), ntohs(p->sa.sin_port), req->data);
2134         }
2135         if (recordhistory) {
2136                 struct sip_request tmp;
2137                 parse_copy(&tmp, req);
2138                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
2139         }
2140         res = (reliable) ?
2141                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable > 1), req->method) :
2142                 __sip_xmit(p, req->data, req->len);
2143         return res;
2144 }
2145
2146 /*! \brief Locate closing quote in a string, skipping escaped quotes.
2147  * optionally with a limit on the search.
2148  * start must be past the first quote.
2149  */
2150 static const char *find_closing_quote(const char *start, const char *lim)
2151 {
2152         char last_char = '\0';
2153         const char *s;
2154         for (s = start; *s && s != lim; last_char = *s++) {
2155                 if (*s == '"' && last_char != '\\')
2156                         break;
2157         }
2158         return s;
2159 }
2160
2161 /*! \brief Pick out text in brackets from character string
2162         \return pointer to terminated stripped string
2163         \param tmp input string that will be modified
2164         Examples:
2165
2166         "foo" <bar>     valid input, returns bar
2167         foo             returns the whole string
2168         < "foo ... >    returns the string between brackets
2169         < "foo...       bogus (missing closing bracket), returns the whole string
2170                         XXX maybe should still skip the opening bracket
2171  */
2172 static char *get_in_brackets(char *tmp)
2173 {
2174         const char *parse = tmp;
2175         char *first_bracket;
2176
2177         /*
2178          * Skip any quoted text until we find the part in brackets.
2179          * On any error give up and return the full string.
2180          */
2181         while ( (first_bracket = strchr(parse, '<')) ) {
2182                 char *first_quote = strchr(parse, '"');
2183
2184                 if (!first_quote || first_quote > first_bracket)
2185                         break; /* no need to look at quoted part */
2186                 /* the bracket is within quotes, so ignore it */
2187                 parse = find_closing_quote(first_quote + 1, NULL);
2188                 if (!*parse) { /* not found, return full string ? */
2189                         /* XXX or be robust and return in-bracket part ? */
2190                         ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
2191                         break;
2192                 }
2193                 parse++;
2194         }
2195         if (first_bracket) {
2196                 char *second_bracket = strchr(first_bracket + 1, '>');
2197                 if (second_bracket) {
2198                         *second_bracket = '\0';
2199                         tmp = first_bracket + 1;
2200                 } else {
2201                         ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
2202                 }
2203         }
2204         return tmp;
2205 }
2206
2207 /*! \brief Send SIP MESSAGE text within a call
2208         Called from PBX core sendtext() application */
2209 static int sip_sendtext(struct ast_channel *ast, const char *text)
2210 {
2211         struct sip_pvt *p = ast->tech_pvt;
2212         int debug = sip_debug_test_pvt(p);
2213
2214         if (debug)
2215                 ast_verbose("Sending text %s on %s\n", text, ast->name);
2216         if (!p)
2217                 return -1;
2218         if (ast_strlen_zero(text))
2219                 return 0;
2220         if (debug)
2221                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
2222         transmit_message_with_text(p, text);
2223         return 0;
2224 }
2225
2226 /*! \brief Update peer object in realtime storage
2227         If the Asterisk system name is set in asterisk.conf, we will use
2228         that name and store that in the "regserver" field in the sippeers
2229         table to facilitate multi-server setups.
2230 */
2231 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
2232 {
2233         char port[10];
2234         char ipaddr[INET_ADDRSTRLEN];
2235         char regseconds[20];
2236
2237         char *sysname = ast_config_AST_SYSTEM_NAME;
2238         char *syslabel = NULL;
2239
2240         time_t nowtime = time(NULL) + expirey;
2241         const char *fc = fullcontact ? "fullcontact" : NULL;
2242
2243         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
2244         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2245         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
2246
2247         if (ast_strlen_zero(sysname))   /* No system name, disable this */
2248                 sysname = NULL;
2249         else if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTSAVE_SYSNAME))
2250                 syslabel = "regserver";
2251
2252         if (fc)
2253                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2254                         "port", port, "regseconds", regseconds,
2255                         "username", username, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
2256         else
2257                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2258                         "port", port, "regseconds", regseconds,
2259                         "username", username, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
2260 }
2261
2262 /*! \brief Automatically add peer extension to dial plan */
2263 static void register_peer_exten(struct sip_peer *peer, int onoff)
2264 {
2265         char multi[256];
2266         char *stringp, *ext, *context;
2267
2268         /* XXX note that global_regcontext is both a global 'enable' flag and
2269          * the name of the global regexten context, if not specified
2270          * individually.
2271          */
2272         if (ast_strlen_zero(global_regcontext))
2273                 return;
2274
2275         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
2276         stringp = multi;
2277         while ((ext = strsep(&stringp, "&"))) {
2278                 if ((context = strchr(ext, '@'))) {
2279                         *context++ = '\0';      /* split ext@context */
2280                         if (!ast_context_find(context)) {
2281                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
2282                                 continue;
2283                         }
2284                 } else {
2285                         context = global_regcontext;
2286                 }
2287                 if (onoff)
2288                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
2289                                  ast_strdup(peer->name), ast_free, "SIP");
2290                 else
2291                         ast_context_remove_extension(context, ext, 1, NULL);
2292         }
2293 }
2294
2295 /*! \brief Destroy peer object from memory */
2296 static void sip_destroy_peer(struct sip_peer *peer)
2297 {
2298         if (option_debug > 2)
2299                 ast_log(LOG_DEBUG, "Destroying SIP peer %s\n", peer->name);
2300
2301         /* Delete it, it needs to disappear */
2302         if (peer->call)
2303                 sip_destroy(peer->call);
2304
2305         if (peer->mwipvt)       /* We have an active subscription, delete it */
2306                 sip_destroy(peer->mwipvt);
2307
2308         if (peer->chanvars) {
2309                 ast_variables_destroy(peer->chanvars);
2310                 peer->chanvars = NULL;
2311         }
2312         if (peer->expire > -1)
2313                 ast_sched_del(sched, peer->expire);
2314         if (peer->pokeexpire > -1)
2315                 ast_sched_del(sched, peer->pokeexpire);
2316         register_peer_exten(peer, FALSE);
2317         ast_free_ha(peer->ha);
2318         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
2319                 apeerobjs--;
2320         else if (ast_test_flag(&peer->flags[0], SIP_REALTIME))
2321                 rpeerobjs--;
2322         else
2323                 speerobjs--;
2324         clear_realm_authentication(peer->auth);
2325         peer->auth = NULL;
2326         if (peer->dnsmgr)
2327                 ast_dnsmgr_release(peer->dnsmgr);
2328         free(peer);
2329 }
2330
2331 /*! \brief Update peer data in database (if used) */
2332 static void update_peer(struct sip_peer *p, int expiry)
2333 {
2334         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2335         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
2336             (ast_test_flag(&p->flags[0], SIP_REALTIME) || rtcachefriends)) {
2337                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
2338         }
2339 }
2340
2341
2342 /*! \brief  realtime_peer: Get peer from realtime storage
2343  * Checks the "sippeers" realtime family from extconfig.conf
2344  * \todo Consider adding check of port address when matching here to follow the same
2345  *      algorithm as for static peers. Will we break anything by adding that?
2346 */
2347 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin)
2348 {
2349         struct sip_peer *peer;
2350         struct ast_variable *var = NULL;
2351         struct ast_variable *tmp;
2352         char ipaddr[INET_ADDRSTRLEN];
2353
2354         /* First check on peer name */
2355         if (newpeername)
2356                 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2357         else if (sin) { /* Then check on IP address for dynamic peers */
2358                 ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2359                 var = ast_load_realtime("sippeers", "host", ipaddr, NULL);      /* First check for fixed IP hosts */
2360                 if (!var)
2361                         var = ast_load_realtime("sippeers", "ipaddr", ipaddr, NULL);    /* Then check for registred hosts */
2362         }
2363
2364         if (!var)
2365                 return NULL;
2366
2367         for (tmp = var; tmp; tmp = tmp->next) {
2368                 /* If this is type=user, then skip this object. */
2369                 if (!strcasecmp(tmp->name, "type") &&
2370                     !strcasecmp(tmp->value, "user")) {
2371                         ast_variables_destroy(var);
2372                         return NULL;
2373                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
2374                         newpeername = tmp->value;
2375                 }
2376         }
2377
2378         if (!newpeername) {     /* Did not find peer in realtime */
2379                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", ipaddr);
2380                 ast_variables_destroy(var);
2381                 return NULL;
2382         }
2383
2384         /* Peer found in realtime, now build it in memory */
2385         peer = build_peer(newpeername, var, NULL, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2386         if (!peer) {
2387                 ast_variables_destroy(var);
2388                 return NULL;
2389         }
2390
2391         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2392                 /* Cache peer */
2393                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
2394                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
2395                         if (peer->expire > -1) {
2396                                 ast_sched_del(sched, peer->expire);
2397                         }
2398                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
2399                 }
2400                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
2401         } else {
2402                 ast_set_flag(&peer->flags[0], SIP_REALTIME);
2403         }
2404         ast_variables_destroy(var);
2405
2406         return peer;
2407 }
2408
2409 /*! \brief Support routine for find_peer */
2410 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
2411 {
2412         /* We know name is the first field, so we can cast */
2413         struct sip_peer *p = (struct sip_peer *) name;
2414         return  !(!inaddrcmp(&p->addr, sin) ||
2415                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
2416                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
2417 }
2418
2419 /*! \brief Locate peer by name or ip address
2420  *      This is used on incoming SIP message to find matching peer on ip
2421         or outgoing message to find matching peer on name */
2422 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
2423 {
2424         struct sip_peer *p = NULL;
2425
2426         if (peer)
2427                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
2428         else
2429                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
2430
2431         if (!p && realtime)
2432                 p = realtime_peer(peer, sin);
2433
2434         return p;
2435 }
2436
2437 /*! \brief Remove user object from in-memory storage */
2438 static void sip_destroy_user(struct sip_user *user)
2439 {
2440         if (option_debug > 2)
2441                 ast_log(LOG_DEBUG, "Destroying user object from memory: %s\n", user->name);
2442         ast_free_ha(user->ha);
2443         if (user->chanvars) {
2444                 ast_variables_destroy(user->chanvars);
2445                 user->chanvars = NULL;
2446         }
2447         if (ast_test_flag(&user->flags[0], SIP_REALTIME))
2448                 ruserobjs--;
2449         else
2450                 suserobjs--;
2451         free(user);
2452 }
2453
2454 /*! \brief Load user from realtime storage
2455  * Loads user from "sipusers" category in realtime (extconfig.conf)
2456  * Users are matched on From: user name (the domain in skipped) */
2457 static struct sip_user *realtime_user(const char *username)
2458 {
2459         struct ast_variable *var;
2460         struct ast_variable *tmp;
2461         struct sip_user *user = NULL;
2462
2463         var = ast_load_realtime("sipusers", "name", username, NULL);
2464
2465         if (!var)
2466                 return NULL;
2467
2468         for (tmp = var; tmp; tmp = tmp->next) {
2469                 if (!strcasecmp(tmp->name, "type") &&
2470                         !strcasecmp(tmp->value, "peer")) {
2471                         ast_variables_destroy(var);
2472                         return NULL;
2473                 }
2474         }
2475
2476         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2477
2478         if (!user) {    /* No user found */
2479                 ast_variables_destroy(var);
2480                 return NULL;
2481         }
2482
2483         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2484                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2485                 suserobjs++;
2486                 ASTOBJ_CONTAINER_LINK(&userl,user);
2487         } else {
2488                 /* Move counter from s to r... */
2489                 suserobjs--;
2490                 ruserobjs++;
2491                 ast_set_flag(&user->flags[0], SIP_REALTIME);
2492         }
2493         ast_variables_destroy(var);
2494         return user;
2495 }
2496
2497 /*! \brief Locate user by name
2498  * Locates user by name (From: sip uri user name part) first
2499  * from in-memory list (static configuration) then from
2500  * realtime storage (defined in extconfig.conf) */
2501 static struct sip_user *find_user(const char *name, int realtime)
2502 {
2503         struct sip_user *u = ASTOBJ_CONTAINER_FIND(&userl, name);
2504         if (!u && realtime)
2505                 u = realtime_user(name);
2506         return u;
2507 }
2508
2509 /*! \brief Set nat mode on the various data sockets */
2510 static void do_setnat(struct sip_pvt *p, int natflags)
2511 {
2512         const char *mode = natflags ? "On" : "Off";
2513
2514         if (p->rtp) {
2515                 if (option_debug)
2516                         ast_log(LOG_DEBUG, "Setting NAT on RTP to %s\n", mode);
2517                 ast_rtp_setnat(p->rtp, natflags);
2518         }
2519         if (p->vrtp) {
2520                 if (option_debug)
2521                         ast_log(LOG_DEBUG, "Setting NAT on VRTP to %s\n", mode);
2522                 ast_rtp_setnat(p->vrtp, natflags);
2523         }
2524         if (p->udptl) {
2525                 if (option_debug)
2526                         ast_log(LOG_DEBUG, "Setting NAT on UDPTL to %s\n", mode);
2527                 ast_udptl_setnat(p->udptl, natflags);
2528         }
2529 }
2530
2531 /*! \brief Create address structure from peer reference.
2532  *  return -1 on error, 0 on success.
2533  */
2534 static int create_addr_from_peer(struct sip_pvt *dialog, struct sip_peer *peer)
2535 {
2536         if ((peer->addr.sin_addr.s_addr || peer->defaddr.sin_addr.s_addr) &&
2537             (!peer->maxms || ((peer->lastms >= 0)  && (peer->lastms <= peer->maxms)))) {
2538                 dialog->sa = (peer->addr.sin_addr.s_addr) ? peer->addr : peer->defaddr;
2539                 dialog->recv = dialog->sa;
2540         } else
2541                 return -1;
2542
2543         ast_copy_flags(&dialog->flags[0], &peer->flags[0], SIP_FLAGS_TO_COPY);
2544         ast_copy_flags(&dialog->flags[1], &peer->flags[1], SIP_PAGE2_FLAGS_TO_COPY);
2545         dialog->capability = peer->capability;
2546         if (!ast_test_flag(&dialog->flags[1], SIP_PAGE2_VIDEOSUPPORT) && dialog->vrtp) {
2547                 ast_rtp_destroy(dialog->vrtp);
2548                 dialog->vrtp = NULL;
2549         }
2550         dialog->prefs = peer->prefs;
2551         if (ast_test_flag(&dialog->flags[1], SIP_PAGE2_T38SUPPORT)) {
2552                 dialog->t38.capability = global_t38_capability;
2553                 if (dialog->udptl) {
2554                         if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_FEC )
2555                                 dialog->t38.capability |= T38FAX_UDP_EC_FEC;
2556                         else if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_REDUNDANCY )
2557                                 dialog->t38.capability |= T38FAX_UDP_EC_REDUNDANCY;
2558                         else if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_NONE )
2559                                 dialog->t38.capability |= T38FAX_UDP_EC_NONE;
2560                         dialog->t38.capability |= T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF;
2561                         if (option_debug > 1)
2562                                 ast_log(LOG_DEBUG,"Our T38 capability (%d)\n", dialog->t38.capability);
2563                 }
2564                 dialog->t38.jointcapability = dialog->t38.capability;
2565         } else if (dialog->udptl) {
2566                 ast_udptl_destroy(dialog->udptl);
2567                 dialog->udptl = NULL;
2568         }
2569         do_setnat(dialog, ast_test_flag(&dialog->flags[0], SIP_NAT) & SIP_NAT_ROUTE );
2570
2571         if (dialog->rtp) {
2572                 ast_rtp_setdtmf(dialog->rtp, ast_test_flag(&dialog->flags[0], SIP_DTMF) != SIP_DTMF_INFO);
2573                 ast_rtp_setdtmfcompensate(dialog->rtp, ast_test_flag(&dialog->flags[1], SIP_PAGE2_RFC2833_COMPENSATE));
2574         }
2575         if (dialog->vrtp) {
2576                 ast_rtp_setdtmf(dialog->vrtp, 0);
2577                 ast_rtp_setdtmfcompensate(dialog->vrtp, 0);
2578         }
2579
2580         /* Set Frame packetization */
2581         if (dialog->rtp) {
2582                 ast_rtp_codec_setpref(dialog->rtp, &dialog->prefs);
2583                 dialog->autoframing = peer->autoframing;
2584         }
2585         ast_string_field_set(dialog, peername, peer->username);
2586         ast_string_field_set(dialog, authname, peer->username);
2587         ast_string_field_set(dialog, username, peer->username);
2588         ast_string_field_set(dialog, peersecret, peer->secret);
2589         ast_string_field_set(dialog, peermd5secret, peer->md5secret);
2590         ast_string_field_set(dialog, tohost, peer->tohost);
2591         ast_string_field_set(dialog, fullcontact, peer->fullcontact);
2592         if (!dialog->initreq.headers && !ast_strlen_zero(peer->fromdomain)) {
2593                 char *tmpcall;
2594                 char *c;
2595                 tmpcall = ast_strdupa(dialog->callid);
2596                 c = strchr(tmpcall, '@');
2597                 if (c) {
2598                         *c = '\0';
2599                         ast_string_field_build(dialog, callid, "%s@%s", tmpcall, peer->fromdomain);
2600                 }
2601         }
2602         if (ast_strlen_zero(dialog->tohost))
2603                 ast_string_field_set(dialog, tohost, ast_inet_ntoa(dialog->sa.sin_addr));
2604         if (!ast_strlen_zero(peer->fromdomain))
2605                 ast_string_field_set(dialog, fromdomain, peer->fromdomain);
2606         if (!ast_strlen_zero(peer->fromuser))
2607                 ast_string_field_set(dialog, fromuser, peer->fromuser);
2608         dialog->maxtime = peer->maxms;
2609         dialog->callgroup = peer->callgroup;
2610         dialog->pickupgroup = peer->pickupgroup;
2611         dialog->allowtransfer = peer->allowtransfer;
2612         /* Set timer T1 to RTT for this peer (if known by qualify=) */
2613         /* Minimum is settable or default to 100 ms */
2614         if (peer->maxms && peer->lastms)
2615                 dialog->timer_t1 = peer->lastms < global_t1min ? global_t1min : peer->lastms;
2616         if ((ast_test_flag(&dialog->flags[0], SIP_DTMF) == SIP_DTMF_RFC2833) ||
2617             (ast_test_flag(&dialog->flags[0], SIP_DTMF) == SIP_DTMF_AUTO))
2618                 dialog->noncodeccapability |= AST_RTP_DTMF;
2619         else
2620                 dialog->noncodeccapability &= ~AST_RTP_DTMF;
2621         ast_string_field_set(dialog, context, peer->context);
2622         dialog->rtptimeout = peer->rtptimeout;
2623         dialog->rtpholdtimeout = peer->rtpholdtimeout;
2624         dialog->rtpkeepalive = peer->rtpkeepalive;
2625         if (peer->call_limit)
2626                 ast_set_flag(&dialog->flags[0], SIP_CALL_LIMIT);
2627         dialog->maxcallbitrate = peer->maxcallbitrate;
2628
2629         return 0;
2630 }
2631
2632 /*! \brief create address structure from peer name
2633  *      Or, if peer not found, find it in the global DNS
2634  *      returns TRUE (-1) on failure, FALSE on success */
2635 static int create_addr(struct sip_pvt *dialog, const char *opeer)
2636 {
2637         struct hostent *hp;
2638         struct ast_hostent ahp;
2639         struct sip_peer *p;
2640         char *port;
2641         int portno;
2642         char host[MAXHOSTNAMELEN], *hostn;
2643         char peer[256];
2644
2645         ast_copy_string(peer, opeer, sizeof(peer));
2646         port = strchr(peer, ':');
2647         if (port)
2648                 *port++ = '\0';
2649         dialog->sa.sin_family = AF_INET;
2650         dialog->timer_t1 = 500; /* Default SIP retransmission timer T1 (RFC 3261) */
2651         p = find_peer(peer, NULL, 1);
2652
2653         if (p) {
2654                 int res = create_addr_from_peer(dialog, p);
2655                 ASTOBJ_UNREF(p, sip_destroy_peer);
2656                 return res;
2657         }
2658         hostn = peer;
2659         portno = port ? atoi(port) : STANDARD_SIP_PORT;
2660         if (srvlookup) {
2661                 char service[MAXHOSTNAMELEN];
2662                 int tportno;
2663                 int ret;
2664
2665                 snprintf(service, sizeof(service), "_sip._udp.%s", peer);
2666                 ret = ast_get_srv(NULL, host, sizeof(host), &tportno, service);
2667                 if (ret > 0) {
2668                         hostn = host;
2669                         portno = tportno;
2670                 }
2671         }
2672         hp = ast_gethostbyname(hostn, &ahp);
2673         if (!hp) {
2674                 ast_log(LOG_WARNING, "No such host: %s\n", peer);
2675                 return -1;
2676         }
2677         ast_string_field_set(dialog, tohost, peer);
2678         memcpy(&dialog->sa.sin_addr, hp->h_addr, sizeof(dialog->sa.sin_addr));
2679         dialog->sa.sin_port = htons(portno);
2680         dialog->recv = dialog->sa;
2681         return 0;
2682 }
2683
2684 /*! \brief Scheduled congestion on a call */
2685 static int auto_congest(void *nothing)
2686 {
2687         struct sip_pvt *p = nothing;
2688
2689         ast_mutex_lock(&p->lock);
2690         p->initid = -1;
2691         if (p->owner) {
2692                 /* XXX fails on possible deadlock */
2693                 if (!ast_channel_trylock(p->owner)) {
2694                         ast_log(LOG_NOTICE, "Auto-congesting %s\n", p->owner->name);
2695                         append_history(p, "Cong", "Auto-congesting (timer)");
2696                         ast_queue_control(p->owner, AST_CONTROL_CONGESTION);
2697                         ast_channel_unlock(p->owner);
2698                 }
2699         }
2700         ast_mutex_unlock(&p->lock);
2701         return 0;
2702 }
2703
2704
2705 /*! \brief Initiate SIP call from PBX
2706  *      used from the dial() application      */
2707 static int sip_call(struct ast_channel *ast, char *dest, int timeout)
2708 {
2709         int res;
2710         struct sip_pvt *p;
2711         struct varshead *headp;
2712         struct ast_var_t *current;
2713         const char *referer = NULL;   /* SIP refererer */
2714
2715         p = ast->tech_pvt;
2716         if ((ast->_state != AST_STATE_DOWN) && (ast->_state != AST_STATE_RESERVED)) {
2717                 ast_log(LOG_WARNING, "sip_call called on %s, neither down nor reserved\n", ast->name);
2718                 return -1;
2719         }
2720
2721         /* Check whether there is vxml_url, distinctive ring variables */
2722         headp=&ast->varshead;
2723         AST_LIST_TRAVERSE(headp,current,entries) {
2724                 /* Check whether there is a VXML_URL variable */
2725                 if (!p->options->vxml_url && !strcasecmp(ast_var_name(current), "VXML_URL")) {
2726                         p->options->vxml_url = ast_var_value(current);
2727                 } else if (!p->options->uri_options && !strcasecmp(ast_var_name(current), "SIP_URI_OPTIONS")) {
2728                         p->options->uri_options = ast_var_value(current);
2729                 } else if (!p->options->addsipheaders && !strncasecmp(ast_var_name(current), "SIPADDHEADER", strlen("SIPADDHEADER"))) {
2730                         /* Check whether there is a variable with a name starting with SIPADDHEADER */
2731                         p->options->addsipheaders = 1;
2732                 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER")) {
2733                         /* This is a transfered call */
2734                         p->options->transfer = 1;
2735                 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER_REFERER")) {
2736                         /* This is the referer */
2737                         referer = ast_var_value(current);
2738                 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER_REPLACES")) {
2739                         /* We're replacing a call. */
2740                         p->options->replaces = ast_var_value(current);
2741                 } else if (!strcasecmp(ast_var_name(current), "T38CALL")) {
2742                         p->t38.state = T38_LOCAL_DIRECT;
2743                         if (option_debug)
2744                                 ast_log(LOG_DEBUG,"T38State change to %d on channel %s\n", p->t38.state, ast->name);
2745                 }
2746
2747         }
2748
2749         res = 0;
2750         ast_set_flag(&p->flags[0], SIP_OUTGOING);
2751
2752         if (p->options->transfer) {
2753                 char buf[BUFSIZ/2];
2754
2755                 if (referer) {
2756                         if (sipdebug && option_debug > 2)
2757                                 ast_log(LOG_DEBUG, "Call for %s transfered by %s\n", p->username, referer);
2758                         snprintf(buf, sizeof(buf)-1, "-> %s (via %s)", p->cid_name, referer);
2759                 } else
2760                         snprintf(buf, sizeof(buf)-1, "-> %s", p->cid_name);
2761                 ast_string_field_set(p, cid_name, buf);
2762         }
2763         if (option_debug)
2764                 ast_log(LOG_DEBUG, "Outgoing Call for %s\n", p->username);
2765
2766         res = update_call_counter(p, INC_CALL_RINGING);
2767         if ( res != -1 ) {
2768                 p->callingpres = ast->cid.cid_pres;
2769                 p->jointcapability = p->capability;
2770                 p->t38.jointcapability = p->t38.capability;
2771                 if (option_debug)
2772                         ast_log(LOG_DEBUG,"Our T38 capability (%d), joint T38 capability (%d)\n", p->t38.capability, p->t38.jointcapability);
2773                 transmit_invite(p, SIP_INVITE, 1, 2);
2774                 if (p->maxtime)
2775                         /* Initialize auto-congest time */
2776                         p->initid = ast_sched_add(sched, p->maxtime * 4, auto_congest, p);
2777                 else
2778                         p->initid = ast_sched_add(sched, SIP_TRANS_TIMEOUT, auto_congest, p);
2779         }
2780         return res;
2781 }
2782
2783 /*! \brief Destroy registry object
2784         Objects created with the register= statement in static configuration */
2785 static void sip_registry_destroy(struct sip_registry *reg)
2786 {
2787         /* Really delete */
2788         if (option_debug > 2)
2789                 ast_log(LOG_DEBUG, "Destroying registry entry for %s@%s\n", reg->username, reg->hostname);
2790
2791         if (reg->call) {
2792                 /* Clear registry before destroying to ensure
2793                    we don't get reentered trying to grab the registry lock */
2794                 reg->call->registry = NULL;
2795                 if (option_debug > 2)
2796                         ast_log(LOG_DEBUG, "Destroying active SIP dialog for registry %s@%s\n", reg->username, reg->hostname);
2797                 sip_destroy(reg->call);
2798         }
2799         if (reg->expire > -1)
2800                 ast_sched_del(sched, reg->expire);
2801         if (reg->timeout > -1)
2802                 ast_sched_del(sched, reg->timeout);
2803         ast_string_field_free_all(reg);
2804         regobjs--;
2805         free(reg);
2806
2807 }
2808
2809 /*! \brief Execute destruction of SIP dialog structure, release memory */
2810 static void __sip_destroy(struct sip_pvt *p, int lockowner)
2811 {
2812         struct sip_pvt *cur, *prev = NULL;
2813         struct sip_pkt *cp;
2814
2815         if (sip_debug_test_pvt(p) || option_debug > 2)
2816                 ast_verbose("Really destroying SIP dialog '%s' Method: %s\n", p->callid, sip_methods[p->method].text);
2817
2818         /* Remove link from peer to subscription of MWI */
2819         if (p->relatedpeer && p->relatedpeer->mwipvt)
2820                 p->relatedpeer->mwipvt = NULL;
2821
2822         if (dumphistory)
2823                 sip_dump_history(p);
2824
2825         if (p->options)
2826                 free(p->options);
2827
2828         if (p->stateid > -1)
2829                 ast_extension_state_del(p->stateid, NULL);
2830         if (p->initid > -1)
2831                 ast_sched_del(sched, p->initid);
2832         if (p->autokillid > -1)
2833                 ast_sched_del(sched, p->autokillid);
2834
2835         if (p->rtp)
2836                 ast_rtp_destroy(p->rtp);
2837         if (p->vrtp)
2838                 ast_rtp_destroy(p->vrtp);
2839         if (p->udptl)
2840                 ast_udptl_destroy(p->udptl);
2841         if (p->refer)
2842                 free(p->refer);
2843         if (p->route) {
2844                 free_old_route(p->route);
2845                 p->route = NULL;
2846         }
2847         if (p->registry) {
2848                 if (p->registry->call == p)
2849                         p->registry->call = NULL;
2850                 ASTOBJ_UNREF(p->registry, sip_registry_destroy);
2851         }
2852
2853         /* Unlink us from the owner if we have one */
2854         if (p->owner) {
2855                 if (lockowner)
2856                         ast_channel_lock(p->owner);
2857                 if (option_debug)
2858                         ast_log(LOG_DEBUG, "Detaching from %s\n", p->owner->name);
2859                 p->owner->tech_pvt = NULL;
2860                 if (lockowner)
2861                         ast_channel_unlock(p->owner);
2862         }
2863         /* Clear history */
2864         if (p->history) {
2865                 struct sip_history *hist;
2866                 while( (hist = AST_LIST_REMOVE_HEAD(p->history, list)) )
2867                         free(hist);
2868                 free(p->history);
2869                 p->history = NULL;
2870         }
2871
2872         for (prev = NULL, cur = iflist; cur; prev = cur, cur = cur->next) {
2873                 if (cur == p) {
2874                         UNLINK(cur, iflist, prev);
2875                         break;
2876                 }
2877         }
2878         if (!cur) {
2879                 ast_log(LOG_WARNING, "Trying to destroy \"%s\", not found in dialog list?!?! \n", p->callid);
2880                 return;
2881         }
2882
2883         /* remove all current packets in this dialog */
2884         while((cp = p->packets)) {
2885                 p->packets = p->packets->next;
2886                 if (cp->retransid > -1)
2887                         ast_sched_del(sched, cp->retransid);
2888                 free(cp);
2889         }
2890         if (p->chanvars) {
2891                 ast_variables_destroy(p->chanvars);
2892                 p->chanvars = NULL;
2893         }
2894         ast_mutex_destroy(&p->lock);
2895
2896         ast_string_field_free_all(p);
2897
2898         free(p);
2899 }
2900
2901 /*! \brief  update_call_counter: Handle call_limit for SIP users
2902  * Setting a call-limit will cause calls above the limit not to be accepted.
2903  *
2904  * Remember that for a type=friend, there's one limit for the user and
2905  * another for the peer, not a combined call limit.
2906  * This will cause unexpected behaviour in subscriptions, since a "friend"
2907  * is *two* devices in Asterisk, not one.
2908  *
2909  * Thought: For realtime, we should propably update storage with inuse counter...
2910  *
2911  * \return 0 if call is ok (no call limit, below treshold)
2912  *      -1 on rejection of call
2913  *
2914  */
2915 static int update_call_counter(struct sip_pvt *fup, int event)
2916 {
2917         char name[256];
2918         int *inuse, *call_limit, *inringing;
2919         int outgoing = ast_test_flag(&fup->flags[0], SIP_OUTGOING);
2920         struct sip_user *u = NULL;
2921         struct sip_peer *p = NULL;
2922
2923         if (option_debug > 2)
2924                 ast_log(LOG_DEBUG, "Updating call counter for %s call\n", outgoing ? "outgoing" : "incoming");
2925         /* Test if we need to check call limits, in order to avoid
2926            realtime lookups if we do not need it */
2927         if (!ast_test_flag(&fup->flags[0], SIP_CALL_LIMIT))
2928                 return 0;
2929
2930         ast_copy_string(name, fup->username, sizeof(name));
2931
2932         /* Check the list of users only for incoming calls */
2933         if (!outgoing && (u = find_user(name, 1)) ) {
2934                 inuse = &u->inUse;
2935                 call_limit = &u->call_limit;
2936                 inringing = NULL;
2937         } else if ( (p = find_peer(fup->peername, NULL, 1) ) ) { /* Try to find peer */
2938                 inuse = &p->inUse;
2939                 call_limit = &p->call_limit;
2940                 inringing = &p->inRinging;
2941                 ast_copy_string(name, fup->peername, sizeof(name));
2942         } else {
2943                 if (option_debug > 1)
2944                         ast_log(LOG_DEBUG, "%s is not a local device, no call limit\n", name);
2945                 return 0;
2946         }
2947
2948         switch(event) {
2949         /* incoming and outgoing affects the inUse counter */
2950         case DEC_CALL_LIMIT:
2951                 if ( *inuse > 0 ) {
2952                         if (ast_test_flag(&fup->flags[0], SIP_INC_COUNT))
2953                                 (*inuse)--;
2954                 } else {
2955                         *inuse = 0;
2956                 }
2957                 if (inringing) {
2958                         if (ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
2959                                 if (*inringing > 0)
2960                                         (*inringing)--;
2961                                 else
2962                                         ast_log(LOG_WARNING, "Inringing for peer '%s' < 0?\n", fup->peername);
2963                                 ast_clear_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
2964                         }
2965                 }
2966                 if (option_debug > 1 || sipdebug) {
2967                         ast_log(LOG_DEBUG, "Call %s %s '%s' removed from call limit %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
2968                 }
2969                 break;
2970
2971         case INC_CALL_RINGING:
2972         case INC_CALL_LIMIT:
2973                 if (*call_limit > 0 ) {
2974                         if (*inuse >= *call_limit) {
2975                                 ast_log(LOG_ERROR, "Call %s %s '%s' rejected due to usage limit of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
2976                                 if (u)
2977                                         ASTOBJ_UNREF(u, sip_destroy_user);
2978                                 else
2979                                         ASTOBJ_UNREF(p, sip_destroy_peer);
2980                                 return -1;
2981                         }
2982                 }
2983                 if (inringing && (event == INC_CALL_RINGING)) {
2984                         if (!ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
2985                                 (*inringing)++;
2986                                 ast_set_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
2987                         }
2988                 }
2989                 /* Continue */
2990                 (*inuse)++;
2991                 ast_set_flag(&fup->flags[0], SIP_INC_COUNT);
2992                 if (option_debug > 1 || sipdebug) {
2993                         ast_log(LOG_DEBUG, "Call %s %s '%s' is %d out of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *inuse, *call_limit);
2994                 }
2995                 break;
2996
2997         case DEC_CALL_RINGING:
2998                 if (inringing) {
2999                         if (ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
3000                                 if (*inringing > 0)
3001                                         (*inringing)--;
3002                                 else
3003                                         ast_log(LOG_WARNING, "Inringing for peer '%s' < 0?\n", p->name);
3004                                 ast_clear_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
3005                         }
3006                 }
3007                 break;
3008
3009         default:
3010                 ast_log(LOG_ERROR, "update_call_counter(%s, %d) called with no event!\n", name, event);
3011         }
3012         if (p) {
3013                 ast_device_state_changed("SIP/%s", p->name);
3014                 ASTOBJ_UNREF(p, sip_destroy_peer);
3015         } else /* u must be set */
3016                 ASTOBJ_UNREF(u, sip_destroy_user);
3017         return 0;
3018 }
3019
3020 /*! \brief Destroy SIP call structure */
3021 static void sip_destroy(struct sip_pvt *p)
3022 {
3023         ast_mutex_lock(&iflock);
3024         if (option_debug > 2)
3025                 ast_log(LOG_DEBUG, "Destroying SIP dialog %s\n", p->callid);
3026         __sip_destroy(p, 1);
3027         ast_mutex_unlock(&iflock);
3028 }
3029
3030 /*! \brief Convert SIP hangup causes to Asterisk hangup causes */
3031 static int hangup_sip2cause(int cause)
3032 {
3033         /* Possible values taken from causes.h */
3034
3035         switch(cause) {
3036                 case 401:       /* Unauthorized */
3037                         return AST_CAUSE_CALL_REJECTED;
3038                 case 403:       /* Not found */
3039                         return AST_CAUSE_CALL_REJECTED;
3040                 case 404:       /* Not found */
3041                         return AST_CAUSE_UNALLOCATED;
3042                 case 405:       /* Method not allowed */
3043                         return AST_CAUSE_INTERWORKING;
3044                 case 407:       /* Proxy authentication required */
3045                         return AST_CAUSE_CALL_REJECTED;
3046                 case 408:       /* No reaction */
3047                         return AST_CAUSE_NO_USER_RESPONSE;
3048                 case 409:       /* Conflict */
3049                         return AST_CAUSE_NORMAL_TEMPORARY_FAILURE;
3050                 case 410:       /* Gone */
3051                         return AST_CAUSE_UNALLOCATED;
3052                 case 411:       /* Length required */
3053                         return AST_CAUSE_INTERWORKING;
3054                 case 413:       /* Request entity too large */
3055                         return AST_CAUSE_INTERWORKING;
3056                 case 414:       /* Request URI too large */
3057                         return AST_CAUSE_INTERWORKING;
3058                 case 415:       /* Unsupported media type */
3059                         return AST_CAUSE_INTERWORKING;
3060                 case 420:       /* Bad extension */
3061                         return AST_CAUSE_NO_ROUTE_DESTINATION;
3062                 case 480:       /* No answer */
3063                         return AST_CAUSE_NO_ANSWER;
3064                 case 481:       /* No answer */
3065                         return AST_CAUSE_INTERWORKING;
3066                 case 482:       /* Loop detected */
3067                         return AST_CAUSE_INTERWORKING;
3068                 case 483:       /* Too many hops */
3069                         return AST_CAUSE_NO_ANSWER;
3070                 case 484:       /* Address incomplete */
3071                         return AST_CAUSE_INVALID_NUMBER_FORMAT;
3072                 case 485:       /* Ambigous */
3073                         return AST_CAUSE_UNALLOCATED;
3074                 case 486:       /* Busy everywhere */
3075                         return AST_CAUSE_BUSY;
3076                 case 487:       /* Request terminated */
3077                         return AST_CAUSE_INTERWORKING;
3078                 case 488:       /* No codecs approved */
3079                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
3080                 case 491:       /* Request pending */
3081                         return AST_CAUSE_INTERWORKING;
3082                 case 493:       /* Undecipherable */
3083                         return AST_CAUSE_INTERWORKING;
3084                 case 500:       /* Server internal failure */
3085                         return AST_CAUSE_FAILURE;
3086                 case 501:       /* Call rejected */
3087                         return AST_CAUSE_FACILITY_REJECTED;
3088                 case 502:
3089                         return AST_CAUSE_DESTINATION_OUT_OF_ORDER;
3090                 case 503:       /* Service unavailable */
3091                         return AST_CAUSE_CONGESTION;
3092                 case 504:       /* Gateway timeout */
3093                         return AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE;
3094                 case 505:       /* SIP version not supported */
3095                         return AST_CAUSE_INTERWORKING;
3096                 case 600:       /* Busy everywhere */
3097                         return AST_CAUSE_USER_BUSY;
3098                 case 603:       /* Decline */
3099                         return AST_CAUSE_CALL_REJECTED;
3100                 case 604:       /* Does not exist anywhere */
3101                         return AST_CAUSE_UNALLOCATED;
3102                 case 606:       /* Not acceptable */
3103                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
3104                 default:
3105                         return AST_CAUSE_NORMAL;
3106         }
3107         /* Never reached */
3108         return 0;
3109 }
3110
3111 /*! \brief Convert Asterisk hangup causes to SIP codes
3112 \verbatim
3113  Possible values from causes.h
3114         AST_CAUSE_NOTDEFINED    AST_CAUSE_NORMAL        AST_CAUSE_BUSY
3115         AST_CAUSE_FAILURE       AST_CAUSE_CONGESTION    AST_CAUSE_UNALLOCATED
3116
3117         In addition to these, a lot of PRI codes is defined in causes.h
3118         ...should we take care of them too ?
3119
3120         Quote RFC 3398
3121
3122    ISUP Cause value                        SIP response
3123    ----------------                        ------------
3124    1  unallocated number                   404 Not Found
3125    2  no route to network                  404 Not found
3126    3  no route to destination              404 Not found
3127    16 normal call clearing                 --- (*)
3128    17 user busy                            486 Busy here
3129    18 no user responding                   408 Request Timeout
3130    19 no answer from the user              480 Temporarily unavailable
3131    20 subscriber absent                    480 Temporarily unavailable
3132    21 call rejected                        403 Forbidden (+)
3133    22 number changed (w/o diagnostic)      410 Gone
3134    22 number changed (w/ diagnostic)       301 Moved Permanently
3135    23 redirection to new destination       410 Gone
3136    26 non-selected user clearing           404 Not Found (=)
3137    27 destination out of order             502 Bad Gateway
3138    28 address incomplete                   484 Address incomplete
3139    29 facility rejected                    501 Not implemented
3140    31 normal unspecified                   480 Temporarily unavailable
3141 \endverbatim
3142 */
3143 static const char *hangup_cause2sip(int cause)
3144 {
3145         switch (cause) {
3146                 case AST_CAUSE_UNALLOCATED:             /* 1 */
3147                 case AST_CAUSE_NO_ROUTE_DESTINATION:    /* 3 IAX2: Can't find extension in context */
3148                 case AST_CAUSE_NO_ROUTE_TRANSIT_NET:    /* 2 */
3149                         return "404 Not Found";
3150                 case AST_CAUSE_CONGESTION:              /* 34 */
3151                 case AST_CAUSE_SWITCH_CONGESTION:       /* 42 */
3152                         return "503 Service Unavailable";
3153                 case AST_CAUSE_NO_USER_RESPONSE:        /* 18 */
3154                         return "408 Request Timeout";
3155                 case AST_CAUSE_NO_ANSWER:               /* 19 */
3156                         return "480 Temporarily unavailable";
3157                 case AST_CAUSE_CALL_REJECTED:           /* 21 */
3158                         return "403 Forbidden";
3159                 case AST_CAUSE_NUMBER_CHANGED:          /* 22 */
3160                         return "410 Gone";
3161                 case AST_CAUSE_NORMAL_UNSPECIFIED:      /* 31 */
3162                         return "480 Temporarily unavailable";
3163                 case AST_CAUSE_INVALID_NUMBER_FORMAT:
3164                         return "484 Address incomplete";
3165                 case AST_CAUSE_USER_BUSY:
3166                         return "486 Busy here";
3167                 case AST_CAUSE_FAILURE:
3168                         return "500 Server internal failure";
3169                 case AST_CAUSE_FACILITY_REJECTED:       /* 29 */
3170                         return "501 Not Implemented";
3171                 case AST_CAUSE_CHAN_NOT_IMPLEMENTED:
3172                         return "503 Service Unavailable";
3173                 /* Used in chan_iax2 */
3174                 case AST_CAUSE_DESTINATION_OUT_OF_ORDER:
3175                         return "502 Bad Gateway";
3176                 case AST_CAUSE_BEARERCAPABILITY_NOTAVAIL:       /* Can't find codec to connect to host */
3177                         return "488 Not Acceptable Here";
3178
3179                 case AST_CAUSE_NOTDEFINED:
3180                 default:
3181                         if (option_debug)
3182                                 ast_log(LOG_DEBUG, "AST hangup cause %d (no match found in SIP)\n", cause);
3183                         return NULL;
3184         }
3185
3186         /* Never reached */
3187         return 0;
3188 }
3189
3190
3191 /*! \brief  sip_hangup: Hangup SIP call
3192  * Part of PBX interface, called from ast_hangup */
3193 static int sip_hangup(struct ast_channel *ast)
3194 {
3195         struct sip_pvt *p = ast->tech_pvt;
3196         int needcancel = FALSE;
3197         int needdestroy = 0;
3198         struct ast_channel *oldowner = ast;
3199
3200         if (!p) {
3201                 if (option_debug)
3202                         ast_log(LOG_DEBUG, "Asked to hangup channel that was not connected\n");
3203                 return 0;
3204         }
3205
3206         if (ast_test_flag(&p->flags[0], SIP_DEFER_BYE_ON_TRANSFER)) {
3207                 if (option_debug >3)
3208                         ast_log(LOG_DEBUG, "SIP Transfer: Not hanging up right now... Rescheduling hangup for %s.\n", p->callid);
3209                 if (p->autokillid > -1)
3210                         sip_cancel_destroy(p);
3211                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
3212                 ast_clear_flag(&p->flags[0], SIP_DEFER_BYE_ON_TRANSFER);        /* Really hang up next time */
3213                 ast_clear_flag(&p->flags[0], SIP_NEEDDESTROY);
3214                 p->owner->tech_pvt = NULL;
3215                 p->owner = NULL;  /* Owner will be gone after we return, so take it away */
3216                 return 0;
3217         }
3218         if (option_debug) {
3219                 if (ast_test_flag(ast, AST_FLAG_ZOMBIE) && p->refer && option_debug)
3220                         ast_log(LOG_DEBUG, "SIP Transfer: Hanging up Zombie channel %s after transfer ... Call-ID: %s\n", ast->name, p->callid);
3221                 else  {
3222                         if (option_debug)
3223                                 ast_log(LOG_DEBUG, "Hangup call %s, SIP callid %s)\n", ast->name, p->callid);
3224                 }
3225         }
3226         if (option_debug && ast_test_flag(ast, AST_FLAG_ZOMBIE))
3227                 ast_log(LOG_DEBUG, "Hanging up zombie call. Be scared.\n");
3228
3229         ast_mutex_lock(&p->lock);
3230         if (option_debug && sipdebug)
3231                 ast_log(LOG_DEBUG, "update_call_counter(%s) - decrement call limit counter on hangup\n", p->username);
3232         update_call_counter(p, DEC_CALL_LIMIT);
3233
3234         /* Determine how to disconnect */
3235         if (p->owner != ast) {
3236                 ast_log(LOG_WARNING, "Huh?  We aren't the owner? Can't hangup call.\n");
3237                 ast_mutex_unlock(&p->lock);
3238                 return 0;
3239         }
3240         /* If the call is not UP, we need to send CANCEL instead of BYE */
3241         if (ast->_state == AST_STATE_RING || ast->_state == AST_STATE_RINGING) {
3242                 needcancel = TRUE;
3243                 if (option_debug > 3)
3244                         ast_log(LOG_DEBUG, "Hanging up channel in state %s (not UP)\n", ast_state2str(ast->_state));
3245         }
3246
3247         /* Disconnect */
3248         if (p->vad)
3249                 ast_dsp_free(p->vad);
3250
3251         p->owner = NULL;
3252         ast->tech_pvt = NULL;
3253
3254         ast_atomic_fetchadd_int(&usecnt, -1);
3255         ast_update_use_count();
3256
3257         /* Do not destroy this pvt until we have timeout or
3258            get an answer to the BYE or INVITE/CANCEL
3259            If we get no answer during retransmit period, drop the call anyway.
3260            (Sorry, mother-in-law, you can't deny a hangup by sending
3261            603 declined to BYE...)
3262         */
3263         if (ast_test_flag(&p->flags[0], SIP_ALREADYGONE))
3264                 needdestroy = 1;        /* Set destroy flag at end of this function */
3265         else
3266                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
3267
3268         /* Start the process if it's not already started */
3269         if (!ast_test_flag(&p->flags[0], SIP_ALREADYGONE) && !ast_strlen_zero(p->initreq.data)) {
3270                 if (needcancel) {       /* Outgoing call, not up */
3271                         if (ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3272                                 /* stop retransmitting an INVITE that has not received a response */
3273                                 __sip_pretend_ack(p);
3274
3275                                 /* if we can't send right now, mark it pending */
3276                                 if (!ast_test_flag(&p->flags[0], SIP_CAN_BYE)) {
3277                                         ast_set_flag(&p->flags[0], SIP_PENDINGBYE);
3278                                         /* Do we need a timer here if we don't hear from them at all? */
3279                                 } else {
3280                                         /* Send a new request: CANCEL */
3281                                         transmit_request_with_auth(p, SIP_CANCEL, p->ocseq, XMIT_RELIABLE, FALSE);
3282                                         /* Actually don't destroy us yet, wait for the 487 on our original
3283                                            INVITE, but do set an autodestruct just in case we never get it. */
3284                                         needdestroy = 0;
3285                                         sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
3286                                 }
3287                                 if ( p->initid != -1 ) {
3288                                         /* channel still up - reverse dec of inUse counter
3289                                            only if the channel is not auto-congested */
3290                                         update_call_counter(p, INC_CALL_LIMIT);
3291                                 }
3292                         } else {        /* Incoming call, not up */
3293                                 const char *res;
3294                                 if (ast->hangupcause && (res = hangup_cause2sip(ast->hangupcause)))
3295                                         transmit_response_reliable(p, res, &p->initreq);
3296                                 else
3297                                         transmit_response_reliable(p, "603 Declined", &p->initreq);
3298                         }
3299                 } else {        /* Call is in UP state, send BYE */
3300                         if (!p->pendinginvite) {
3301                                 char *audioqos = "";
3302                                 char *videoqos = "";
3303                                 if (p->rtp)
3304                                         audioqos = ast_rtp_get_quality(p->rtp);
3305                                 if (p->vrtp)
3306                                         videoqos = ast_rtp_get_quality(p->vrtp);
3307                                 /* Send a hangup */
3308                                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
3309
3310                                 /* Get RTCP quality before end of call */
3311                                 if (recordhistory) {
3312                                         if (p->rtp)
3313                                                 append_history(p, "RTCPaudio", "Quality:%s", audioqos);
3314                                         if (p->vrtp)
3315                                                 append_history(p, "RTCPvideo", "Quality:%s", videoqos);
3316                                 }
3317                                 if (p->rtp && oldowner)
3318                                         pbx_builtin_setvar_helper(oldowner, "RTPAUDIOQOS", audioqos);
3319                                 if (p->vrtp && oldowner)
3320                                         pbx_builtin_setvar_helper(oldowner, "RTPVIDEOQOS", videoqos);
3321                         } else {
3322                                 /* Note we will need a BYE when this all settles out
3323                                    but we can't send one while we have "INVITE" outstanding. */
3324                                 ast_set_flag(&p->flags[0], SIP_PENDINGBYE);
3325                                 ast_clear_flag(&p->flags[0], SIP_NEEDREINVITE);
3326                         }
3327                 }
3328         }
3329         if (needdestroy)
3330                 ast_set_flag(&p->flags[0], SIP_NEEDDESTROY);
3331         ast_mutex_unlock(&p->lock);
3332         return 0;
3333 }
3334
3335 /*! \brief Try setting codec suggested by the SIP_CODEC channel variable */
3336 static void try_suggested_sip_codec(struct sip_pvt *p)
3337 {
3338         int fmt;
3339         const char *codec;
3340
3341         codec = pbx_builtin_getvar_helper(p->owner, "SIP_CODEC");
3342         if (!codec)
3343                 return;
3344
3345         fmt = ast_getformatbyname(codec);
3346         if (fmt) {
3347                 ast_log(LOG_NOTICE, "Changing codec to '%s' for this call because of ${SIP_CODEC} variable\n", codec);
3348                 if (p->jointcapability & fmt) {
3349                         p->jointcapability &= fmt;
3350                         p->capability &= fmt;
3351                 } else
3352                         ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because it is not shared by both ends.\n");
3353         } else
3354                 ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because of unrecognized/not configured codec (check allow/disallow in sip.conf): %s\n", codec);
3355         return;
3356 }
3357
3358 /*! \brief  sip_answer: Answer SIP call , send 200 OK on Invite
3359  * Part of PBX interface */
3360 static int sip_answer(struct ast_channel *ast)
3361 {
3362         int res = 0;
3363         struct sip_pvt *p = ast->tech_pvt;
3364
3365         ast_mutex_lock(&p->lock);
3366         if (ast->_state != AST_STATE_UP) {
3367                 try_suggested_sip_codec(p);
3368
3369                 ast_setstate(ast, AST_STATE_UP);
3370                 if (option_debug)
3371                         ast_log(LOG_DEBUG, "SIP answering channel: %s\n", ast->name);
3372                 if (p->t38.state == T38_PEER_DIRECT) {
3373                         p->t38.state = T38_ENABLED;
3374                         if (option_debug > 1)
3375                                 ast_log(LOG_DEBUG,"T38State change to %d on channel %s\n", p->t38.state, ast->name);
3376                         res = transmit_response_with_t38_sdp(p, "200 OK", &p->initreq, XMIT_CRITICAL);
3377                 } else
3378                         res = transmit_response_with_sdp(p, "200 OK", &p->initreq, XMIT_CRITICAL);
3379         }
3380         ast_mutex_unlock(&p->lock);
3381         return res;
3382 }
3383
3384 /*! \brief Send frame to media channel (rtp) */
3385 static int sip_write(struct ast_channel *ast, struct ast_frame *frame)
3386 {
3387         struct sip_pvt *p = ast->tech_pvt;
3388         int res = 0;
3389
3390         switch (frame->frametype) {
3391         case AST_FRAME_VOICE:
3392                 if (!(frame->subclass & ast->nativeformats)) {
3393                         char s1[512], s2[512], s3[512];
3394                         ast_log(LOG_WARNING, "Asked to transmit frame type %d, while native formats is %s(%d) read/write = %s(%d)/%s(%d)\n",
3395                                 frame->subclass,
3396                                 ast_getformatname_multiple(s1, sizeof(s1) - 1, ast->nativeformats & AST_FORMAT_AUDIO_MASK),
3397                                 ast->nativeformats & AST_FORMAT_AUDIO_MASK,
3398                                 ast_getformatname_multiple(s2, sizeof(s2) - 1, ast->readformat),
3399                                 ast->readformat,
3400                                 ast_getformatname_multiple(s3, sizeof(s3) - 1, ast->writeformat),
3401                                 ast->writeformat);
3402                         return 0;
3403                 }
3404                 if (p) {
3405                         ast_mutex_lock(&p->lock);
3406                         if (p->rtp) {
3407                                 /* If channel is not up, activate early media session */
3408                                 if ((ast->_state != AST_STATE_UP) &&
3409                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
3410                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3411                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
3412                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
3413                                 }
3414                                 p->lastrtptx = time(NULL);
3415                                 res = ast_rtp_write(p->rtp, frame);
3416                         }
3417                         ast_mutex_unlock(&p->lock);
3418                 }
3419                 break;
3420         case AST_FRAME_VIDEO:
3421                 if (p) {
3422                         ast_mutex_lock(&p->lock);
3423                         if (p->vrtp) {
3424                                 /* Activate video early media */
3425                                 if ((ast->_state != AST_STATE_UP) &&
3426                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
3427                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3428                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
3429                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
3430                                 }
3431                                 p->lastrtptx = time(NULL);
3432                                 res = ast_rtp_write(p->vrtp, frame);
3433                         }
3434                         ast_mutex_unlock(&p->lock);
3435                 }
3436                 break;
3437         case AST_FRAME_IMAGE:
3438                 return 0;
3439                 break;
3440         case AST_FRAME_MODEM:
3441                 if (p) {
3442                         ast_mutex_lock(&p->lock);
3443                         if (p->udptl) {