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  *
  36  * \ingroup channel_drivers
  37  *
  38  */
  39
  40
  41 #include <stdio.h>
  42 #include <ctype.h>
  43 #include <string.h>
  44 #include <unistd.h>
  45 #include <sys/socket.h>
  46 #include <sys/ioctl.h>
  47 #include <net/if.h>
  48 #include <errno.h>
  49 #include <stdlib.h>
  50 #include <fcntl.h>
  51 #include <netdb.h>
  52 #include <signal.h>
  53 #include <sys/signal.h>
  54 #include <netinet/in.h>
  55 #include <netinet/in_systm.h>
  56 #include <arpa/inet.h>
  57 #include <netinet/ip.h>
  58 #include <regex.h>
  59
  60 #include "asterisk.h"
  61
  62 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  63
  64 #include "asterisk/lock.h"
  65 #include "asterisk/channel.h"
  66 #include "asterisk/config.h"
  67 #include "asterisk/logger.h"
  68 #include "asterisk/module.h"
  69 #include "asterisk/pbx.h"
  70 #include "asterisk/options.h"
  71 #include "asterisk/lock.h"
  72 #include "asterisk/sched.h"
  73 #include "asterisk/io.h"
  74 #include "asterisk/rtp.h"
  75 #include "asterisk/acl.h"
  76 #include "asterisk/manager.h"
  77 #include "asterisk/callerid.h"
  78 #include "asterisk/cli.h"
  79 #include "asterisk/app.h"
  80 #include "asterisk/musiconhold.h"
  81 #include "asterisk/dsp.h"
  82 #include "asterisk/features.h"
  83 #include "asterisk/acl.h"
  84 #include "asterisk/srv.h"
  85 #include "asterisk/astdb.h"
  86 #include "asterisk/causes.h"
  87 #include "asterisk/utils.h"
  88 #include "asterisk/file.h"
  89 #include "asterisk/astobj.h"
  90 #include "asterisk/dnsmgr.h"
  91 #include "asterisk/devicestate.h"
  92 #include "asterisk/linkedlists.h"
  93 #include "asterisk/stringfields.h"
  94 #include "asterisk/monitor.h"
  95
  96 #ifdef OSP_SUPPORT
  97 #include "asterisk/astosp.h"
  98 #endif
  99
 100 #ifndef FALSE
 101 #define FALSE   0
 102 #endif
 103
 104 #ifndef TRUE
 105 #define TRUE 1
 106 #endif
 107
 108
 109 #define VIDEO_CODEC_MASK        0x1fc0000 /*!< Video codecs from H.261 thru AST_FORMAT_MAX_VIDEO */
 110 #ifndef IPTOS_MINCOST
 111 #define IPTOS_MINCOST           0x02
 112 #endif
 113
 114 /* #define VOCAL_DATA_HACK */
 115
 116 #define DEFAULT_DEFAULT_EXPIRY  120
 117 #define DEFAULT_MIN_EXPIRY      60
 118 #define DEFAULT_MAX_EXPIRY      3600
 119 #define DEFAULT_REGISTRATION_TIMEOUT    20
 120 #define DEFAULT_MAX_FORWARDS    "70"
 121
 122 /* guard limit must be larger than guard secs */
 123 /* guard min must be < 1000, and should be >= 250 */
 124 #define EXPIRY_GUARD_SECS       15              /*!< How long before expiry do we reregister */
 125 #define EXPIRY_GUARD_LIMIT      30              /*!< Below here, we use EXPIRY_GUARD_PCT instead of
 126                                                   EXPIRY_GUARD_SECS */
 127 #define EXPIRY_GUARD_MIN        500             /*!< This is the minimum guard time applied. If
 128                                                   GUARD_PCT turns out to be lower than this, it
 129                                                    will use this time instead.
 130                                                    This is in milliseconds. */
 131 #define EXPIRY_GUARD_PCT        0.20            /*!< Percentage of expires timeout to use when
 132                                                    below EXPIRY_GUARD_LIMIT */
 133 #define DEFAULT_EXPIRY 900                      /*!< Expire slowly */
 134
 135 static int min_expiry = DEFAULT_MIN_EXPIRY;     /*!< Minimum accepted registration time */
 136 static int max_expiry = DEFAULT_MAX_EXPIRY;     /*!< Maximum accepted registration time */
 137 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
 138 static int expiry = DEFAULT_EXPIRY;
 139
 140 #ifndef MAX
 141 #define MAX(a,b) ((a) > (b) ? (a) : (b))
 142 #endif
 143
 144 #define CALLERID_UNKNOWN        "Unknown"
 145
 146 #define DEFAULT_MAXMS           2000            /*!< Qualification: Must be faster than 2 seconds by default */
 147 #define DEFAULT_FREQ_OK         60 * 1000       /*!< Qualification: How often to check for the host to be up */
 148 #define DEFAULT_FREQ_NOTOK      10 * 1000       /*!< Qualification: How often to check, if the host is down... */
 149
 150 #define DEFAULT_RETRANS         1000            /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
 151 #define MAX_RETRANS             6               /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
 152 #define MAX_AUTHTRIES           3               /*!< Try authentication three times, then fail */
 153
 154 #define SIP_MAX_HEADERS         64                      /*!< Max amount of SIP headers to read */
 155 #define SIP_MAX_LINES           64                      /*!< Max amount of lines in SIP attachment (like SDP) */
 156 #define SIP_MAX_PACKET          4096    /*!< Also from RFC 3261 (2543), should sub headers tho */
 157
 158
 159 static const char desc[] = "Session Initiation Protocol (SIP)";
 160 static const char config[] = "sip.conf";
 161 static const char notify_config[] = "sip_notify.conf";
 162 static int usecnt = 0;
 163
 164
 165 #define RTP     1
 166 #define NO_RTP  0
 167
 168 /* Do _NOT_ make any changes to this enum, or the array following it;
 169    if you think you are doing the right thing, you are probably
 170    not doing the right thing. If you think there are changes
 171    needed, get someone else to review them first _before_
 172    submitting a patch. If these two lists do not match properly
 173    bad things will happen.
 174 */
 175
 176 enum xmittype {
 177         XMIT_CRITICAL = 2,              /*!< Transmit critical SIP message reliably, with re-transmits.
 178                                                         If it fails, it's critical and will cause a teardown of the session */
 179         XMIT_RELIABLE = 1,              /*!< Transmit SIP message reliably, with re-transmits */
 180         XMIT_UNRELIABLE = 0,            /*!< Transmit SIP message without bothering with re-transmits */
 181 };
 182
 183 enum subscriptiontype {
 184         NONE = 0,
 185         TIMEOUT,
 186         XPIDF_XML,
 187         DIALOG_INFO_XML,
 188         CPIM_PIDF_XML,
 189         PIDF_XML,
 190         MWI_NOTIFICATION
 191 };
 192
 193 static const struct cfsubscription_types {
 194         enum subscriptiontype type;
 195         const char * const event;
 196         const char * const mediatype;
 197         const char * const text;
 198 } subscription_types[] = {
 199         { NONE,            "-",        "unknown",                    "unknown" },
 200         /* IETF draft: draft-ietf-sipping-dialog-package-05.txt */
 201         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
 202         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
 203         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
 204         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
 205         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* Mailbox notification */
 206 };
 207
 208 enum sipmethod {
 209         SIP_UNKNOWN,
 210         SIP_RESPONSE,
 211         SIP_REGISTER,
 212         SIP_OPTIONS,
 213         SIP_NOTIFY,
 214         SIP_INVITE,
 215         SIP_ACK,
 216         SIP_PRACK,
 217         SIP_BYE,
 218         SIP_REFER,
 219         SIP_SUBSCRIBE,
 220         SIP_MESSAGE,
 221         SIP_UPDATE,
 222         SIP_INFO,
 223         SIP_CANCEL,
 224         SIP_PUBLISH,
 225 } sip_method_list;
 226
 227 enum sip_auth_type {
 228         PROXY_AUTH,
 229         WWW_AUTH,
 230 };
 231
 232 /* States for outbound registrations (with register= lines in sip.conf */
 233 enum sipregistrystate {
 234         REG_STATE_UNREGISTERED = 0,     /*!< We are not registred */
 235         REG_STATE_REGSENT,      /*!< Registration request sent */
 236         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate */
 237         REG_STATE_REGISTERED,   /*!< Registred and done */
 238         REG_STATE_REJECTED,     /*!< Registration rejected */
 239         REG_STATE_TIMEOUT,      /*!< Registration timed out */
 240         REG_STATE_NOAUTH,       /*!< We have no accepted credentials */
 241         REG_STATE_FAILED,       /*!< Registration failed after several tries */
 242 };
 243
 244
 245 /*! XXX Note that sip_methods[i].id == i must hold or the code breaks */
 246 static const struct  cfsip_methods {
 247         enum sipmethod id;
 248         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
 249         char * const text;
 250 } sip_methods[] = {
 251         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-" },
 252         { SIP_RESPONSE,  NO_RTP, "SIP/2.0" },
 253         { SIP_REGISTER,  NO_RTP, "REGISTER" },
 254         { SIP_OPTIONS,   NO_RTP, "OPTIONS" },
 255         { SIP_NOTIFY,    NO_RTP, "NOTIFY" },
 256         { SIP_INVITE,    RTP,    "INVITE" },
 257         { SIP_ACK,       NO_RTP, "ACK" },
 258         { SIP_PRACK,     NO_RTP, "PRACK" },
 259         { SIP_BYE,       NO_RTP, "BYE" },
 260         { SIP_REFER,     NO_RTP, "REFER" },
 261         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE" },
 262         { SIP_MESSAGE,   NO_RTP, "MESSAGE" },
 263         { SIP_UPDATE,    NO_RTP, "UPDATE" },
 264         { SIP_INFO,      NO_RTP, "INFO" },
 265         { SIP_CANCEL,    NO_RTP, "CANCEL" },
 266         { SIP_PUBLISH,   NO_RTP, "PUBLISH" }
 267 };
 268
 269 /*! \brief Structure for conversion between compressed SIP and "normal" SIP */
 270 static const struct cfalias {
 271         char * const fullname;
 272         char * const shortname;
 273 } aliases[] = {
 274         { "Content-Type", "c" },
 275         { "Content-Encoding", "e" },
 276         { "From", "f" },
 277         { "Call-ID", "i" },
 278         { "Contact", "m" },
 279         { "Content-Length", "l" },
 280         { "Subject", "s" },
 281         { "To", "t" },
 282         { "Supported", "k" },
 283         { "Refer-To", "r" },
 284         { "Referred-By", "b" },
 285         { "Allow-Events", "u" },
 286         { "Event", "o" },
 287         { "Via", "v" },
 288         { "Accept-Contact", "a" },
 289         { "Reject-Contact", "j" },
 290         { "Request-Disposition", "d" },
 291         { "Session-Expires", "x" },
 292 };
 293
 294 /*!  Define SIP option tags, used in Require: and Supported: headers
 295         We need to be aware of these properties in the phones to use
 296         the replace: header. We should not do that without knowing
 297         that the other end supports it...
 298         This is nothing we can configure, we learn by the dialog
 299         Supported: header on the REGISTER (peer) or the INVITE
 300         (other devices)
 301         We are not using many of these today, but will in the future.
 302         This is documented in RFC 3261
 303 */
 304 #define SUPPORTED               1
 305 #define NOT_SUPPORTED           0
 306
 307 #define SIP_OPT_REPLACES        (1 << 0)
 308 #define SIP_OPT_100REL          (1 << 1)
 309 #define SIP_OPT_TIMER           (1 << 2)
 310 #define SIP_OPT_EARLY_SESSION   (1 << 3)
 311 #define SIP_OPT_JOIN            (1 << 4)
 312 #define SIP_OPT_PATH            (1 << 5)
 313 #define SIP_OPT_PREF            (1 << 6)
 314 #define SIP_OPT_PRECONDITION    (1 << 7)
 315 #define SIP_OPT_PRIVACY         (1 << 8)
 316 #define SIP_OPT_SDP_ANAT        (1 << 9)
 317 #define SIP_OPT_SEC_AGREE       (1 << 10)
 318 #define SIP_OPT_EVENTLIST       (1 << 11)
 319 #define SIP_OPT_GRUU            (1 << 12)
 320 #define SIP_OPT_TARGET_DIALOG   (1 << 13)
 321
 322 /*! \brief List of well-known SIP options. If we get this in a require,
 323    we should check the list and answer accordingly. */
 324 static const struct cfsip_options {
 325         int id;                 /*!< Bitmap ID */
 326         int supported;          /*!< Supported by Asterisk ? */
 327         char * const text;      /*!< Text id, as in standard */
 328 } sip_options[] = {
 329         /* Replaces: header for transfer */
 330         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },
 331         /* RFC3262: PRACK 100% reliability */
 332         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },
 333         /* SIP Session Timers */
 334         { SIP_OPT_TIMER,        NOT_SUPPORTED,  "timer" },
 335         /* RFC3959: SIP Early session support */
 336         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
 337         /* SIP Join header support */
 338         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
 339         /* RFC3327: Path support */
 340         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
 341         /* RFC3840: Callee preferences */
 342         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
 343         /* RFC3312: Precondition support */
 344         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
 345         /* RFC3323: Privacy with proxies*/
 346         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
 347         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
 348         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
 349         /* RFC3329: Security agreement mechanism */
 350         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
 351         /* SIMPLE events:  draft-ietf-simple-event-list-07.txt */
 352         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
 353         /* GRUU: Globally Routable User Agent URI's */
 354         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
 355         /* Target-dialog: draft-ietf-sip-target-dialog-00.txt */
 356         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "target-dialog" },
 357 };
 358
 359
 360 /*! \brief SIP Methods we support */
 361 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY"
 362
 363 /*! \brief SIP Extensions we support */
 364 #define SUPPORTED_EXTENSIONS "replaces"
 365
 366
 367 /* Default values, set and reset in reload_config before reading configuration */
 368 /* These are default values in the source. There are other recommended values in the
 369    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
 370    yet encouraging new behaviour on new installations
 371  */
 372 #define DEFAULT_SIP_PORT        5060    /*!< From RFC 3261 (former 2543) */
 373 #define DEFAULT_CONTEXT         "default"
 374 #define DEFAULT_MUSICCLASS      "default"
 375 #define DEFAULT_VMEXTEN         "asterisk"
 376 #define DEFAULT_CALLERID        "asterisk"
 377 #define DEFAULT_NOTIFYMIME      "application/simple-message-summary"
 378 #define DEFAULT_MWITIME         10
 379 #define DEFAULT_ALLOWGUEST      TRUE
 380 #define DEFAULT_SRVLOOKUP       FALSE           /*!< Recommended setting is ON */
 381 #define DEFAULT_COMPACTHEADERS  FALSE
 382 #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. */
 383 #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. */
 384 #define DEFAULT_TOS_VIDEO       0               /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
 385 #define DEFAULT_ALLOW_EXT_DOM   TRUE
 386 #define DEFAULT_REALM           "asterisk"
 387 #define DEFAULT_NOTIFYRINGING   TRUE
 388 #define DEFAULT_PEDANTIC        FALSE
 389 #define DEFAULT_AUTOCREATEPEER  FALSE
 390 #define DEFAULT_QUALIFY         FALSE
 391 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
 392 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
 393 #ifndef DEFAULT_USERAGENT
 394 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
 395 #endif
 396
 397
 398 /* Default setttings are used as a channel setting and as a default when
 399    configuring devices */
 400 static char default_context[AST_MAX_CONTEXT];
 401 static char default_subscribecontext[AST_MAX_CONTEXT];
 402 static char default_language[MAX_LANGUAGE];
 403 static char default_callerid[AST_MAX_EXTENSION];
 404 static char default_fromdomain[AST_MAX_EXTENSION];
 405 static char default_notifymime[AST_MAX_EXTENSION];
 406 static int default_qualify;             /*!< Default Qualify= setting */
 407 static char default_vmexten[AST_MAX_EXTENSION];
 408 static char default_musicclass[MAX_MUSICCLASS];         /*!< Global music on hold class */
 409 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
 410 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
 411
 412 /* Global settings only apply to the channel */
 413 static int global_rtautoclear;
 414 static int global_notifyringing;        /*!< Send notifications on ringing */
 415 static int srvlookup;                   /*!< SRV Lookup on or off. Default is off, RFC behavior is on */
 416 static int pedanticsipchecking;         /*!< Extra checking ?  Default off */
 417 static int autocreatepeer;              /*!< Auto creation of peers at registration? Default off. */
 418 static int global_relaxdtmf;                    /*!< Relax DTMF */
 419 static int global_rtptimeout;           /*!< Time out call if no RTP */
 420 static int global_rtpholdtimeout;
 421 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
 422 static int global_reg_timeout;
 423 static int global_regattempts_max;      /*!< Registration attempts before giving up */
 424 static int global_allowguest;           /*!< allow unauthenticated users/peers to connect? */
 425 static int global_allowsubscribe;       /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE
 426                                             the global setting is in globals_flags[1] */
 427 static int global_mwitime;              /*!< Time between MWI checks for peers */
 428 static int global_tos_sip;              /*!< IP type of service for SIP packets */
 429 static int global_tos_audio;            /*!< IP type of service for audio RTP packets */
 430 static int global_tos_video;            /*!< IP type of service for video RTP packets */
 431 static int compactheaders;              /*!< send compact sip headers */
 432 static int recordhistory;               /*!< Record SIP history. Off by default */
 433 static int dumphistory;                 /*!< Dump history to verbose before destroying SIP dialog */
 434 static char global_realm[MAXHOSTNAMELEN];               /*!< Default realm */
 435 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
 436 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
 437 static int allow_external_domains;      /*!< Accept calls to external SIP domains? */
 438 static int global_callevents;           /*!< Whether we send manager events or not */
 439 static int global_t1min;                /*!< T1 roundtrip time minimum */
 440
 441 /*! \brief Codecs that we support by default: */
 442 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
 443 static int noncodeccapability = AST_RTP_DTMF;
 444
 445 /* Object counters */
 446 static int suserobjs = 0;               /*!< Static users */
 447 static int ruserobjs = 0;               /*!< Realtime users */
 448 static int speerobjs = 0;               /*!< Statis peers */
 449 static int rpeerobjs = 0;               /*!< Realtime peers */
 450 static int apeerobjs = 0;               /*!< Autocreated peer objects */
 451 static int regobjs = 0;                 /*!< Registry objects */
 452
 453 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
 454
 455 AST_MUTEX_DEFINE_STATIC(usecnt_lock);
 456
 457 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
 458 AST_MUTEX_DEFINE_STATIC(iflock);
 459
 460 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
 461    when it's doing something critical. */
 462 AST_MUTEX_DEFINE_STATIC(netlock);
 463
 464 AST_MUTEX_DEFINE_STATIC(monlock);
 465
 466 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
 467
 468 /*! \brief This is the thread for the monitor which checks for input on the channels
 469    which are not currently in use.  */
 470 static pthread_t monitor_thread = AST_PTHREADT_NULL;
 471
 472 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
 473 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
 474
 475 static struct sched_context *sched;     /*!< The scheduling context */
 476 static struct io_context *io;           /*!< The IO context */
 477
 478 #define DEC_CALL_LIMIT  0
 479 #define INC_CALL_LIMIT  1
 480
 481
 482 /*! \brief sip_request: The data grabbed from the UDP socket */
 483 struct sip_request {
 484         char *rlPart1;          /*!< SIP Method Name or "SIP/2.0" protocol version */
 485         char *rlPart2;          /*!< The Request URI or Response Status */
 486         int len;                /*!< Length */
 487         int headers;            /*!< # of SIP Headers */
 488         int method;             /*!< Method of this request */
 489         char *header[SIP_MAX_HEADERS];
 490         int lines;              /*!< SDP Content */
 491         char *line[SIP_MAX_LINES];
 492         char data[SIP_MAX_PACKET];
 493         int debug;              /*!< Debug flag for this packet */
 494         unsigned int flags;     /*!< SIP_PKT Flags for this packet */
 495 };
 496
 497 /*! \brief structure used in transfers */
 498 struct sip_dual {
 499         struct ast_channel *chan1;
 500         struct ast_channel *chan2;
 501         struct sip_request req;
 502 };
 503
 504 struct sip_pkt;
 505
 506 /*! \brief Parameters to the transmit_invite function */
 507 struct sip_invite_param {
 508         const char *distinctive_ring;   /*!< Distinctive ring header */
 509         const char *osptoken;           /*!< OSP token for this call */
 510         int addsipheaders;      /*!< Add extra SIP headers */
 511         const char *uri_options;        /*!< URI options to add to the URI */
 512         const char *vxml_url;           /*!< VXML url for Cisco phones */
 513         char *auth;             /*!< Authentication */
 514         char *authheader;       /*!< Auth header */
 515         enum sip_auth_type auth_type;   /*!< Authentication type */
 516 };
 517
 518 /*! \brief Structure to save routing information for a SIP session */
 519 struct sip_route {
 520         struct sip_route *next;
 521         char hop[0];
 522 };
 523
 524 /*! \brief Modes for SIP domain handling in the PBX */
 525 enum domain_mode {
 526         SIP_DOMAIN_AUTO,        /*!< This domain is auto-configured */
 527         SIP_DOMAIN_CONFIG,      /*!< This domain is from configuration */
 528 };
 529
 530 struct domain {
 531         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
 532         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
 533         enum domain_mode mode;                  /*!< How did we find this domain? */
 534         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
 535 };
 536
 537 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
 538
 539
 540 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
 541 struct sip_history {
 542         AST_LIST_ENTRY(sip_history) list;
 543         char event[0];  /* actually more, depending on needs */
 544 };
 545
 546 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
 547
 548 /*! \brief sip_auth: Creadentials for authentication to other SIP services */
 549 struct sip_auth {
 550         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
 551         char username[256];             /*!< Username */
 552         char secret[256];               /*!< Secret */
 553         char md5secret[256];            /*!< MD5Secret */
 554         struct sip_auth *next;          /*!< Next auth structure in list */
 555 };
 556
 557 /*--- Various flags for the flags field in the pvt structure
 558  Peer only flags should be set in PAGE2 below
 559 */
 560 #define SIP_ALREADYGONE         (1 << 0)        /*!< Whether or not we've already been destroyed by our peer */
 561 #define SIP_NEEDDESTROY         (1 << 1)        /*!< if we need to be destroyed */
 562 #define SIP_NOVIDEO             (1 << 2)        /*!< Didn't get video in invite, don't offer */
 563 #define SIP_RINGING             (1 << 3)        /*!< Have sent 180 ringing */
 564 #define SIP_PROGRESS_SENT       (1 << 4)        /*!< Have sent 183 message progress */
 565 #define SIP_NEEDREINVITE        (1 << 5)        /*!< Do we need to send another reinvite? */
 566 #define SIP_PENDINGBYE          (1 << 6)        /*!< Need to send bye after we ack? */
 567 #define SIP_GOTREFER            (1 << 7)        /*!< Got a refer? */
 568 #define SIP_PROMISCREDIR        (1 << 8)        /*!< Promiscuous redirection */
 569 #define SIP_TRUSTRPID           (1 << 9)        /*!< Trust RPID headers? */
 570 #define SIP_USEREQPHONE         (1 << 10)       /*!< Add user=phone to numeric URI. Default off */
 571 #define SIP_REALTIME            (1 << 11)       /*!< Flag for realtime users */
 572 #define SIP_USECLIENTCODE       (1 << 12)       /*!< Trust X-ClientCode info message */
 573 #define SIP_OUTGOING            (1 << 13)       /*!< Is this an outgoing call? */
 574 #define SIP_FREEBIT             (1 << 14)       /*!< Free for session-related use */
 575 #define SIP_FREEBIT3            (1 << 15)       /*!< Free for session-related use */
 576 #define SIP_DTMF                (3 << 16)       /*!< DTMF Support: four settings, uses two bits */
 577 #define SIP_DTMF_RFC2833        (0 << 16)       /*!< DTMF Support: RTP DTMF - "rfc2833" */
 578 #define SIP_DTMF_INBAND         (1 << 16)       /*!< DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
 579 #define SIP_DTMF_INFO           (2 << 16)       /*!< DTMF Support: SIP Info messages - "info" */
 580 #define SIP_DTMF_AUTO           (3 << 16)       /*!< DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
 581 /* NAT settings */
 582 #define SIP_NAT                 (3 << 18)       /*!< four settings, uses two bits */
 583 #define SIP_NAT_NEVER           (0 << 18)       /*!< No nat support */
 584 #define SIP_NAT_RFC3581         (1 << 18)       /*!< NAT RFC3581 */
 585 #define SIP_NAT_ROUTE           (2 << 18)       /*!< NAT Only ROUTE */
 586 #define SIP_NAT_ALWAYS          (3 << 18)       /*!< NAT Both ROUTE and RFC3581 */
 587 /* re-INVITE related settings */
 588 #define SIP_REINVITE            (3 << 20)       /*!< two bits used */
 589 #define SIP_CAN_REINVITE        (1 << 20)       /*!< allow peers to be reinvited to send media directly p2p */
 590 #define SIP_REINVITE_UPDATE     (2 << 20)       /*!< use UPDATE (RFC3311) when reinviting this peer */
 591 /* "insecure" settings */
 592 #define SIP_INSECURE_PORT       (1 << 22)       /*!< don't require matching port for incoming requests */
 593 #define SIP_INSECURE_INVITE     (1 << 23)       /*!< don't require authentication for incoming INVITEs */
 594 /* Sending PROGRESS in-band settings */
 595 #define SIP_PROG_INBAND         (3 << 24)       /*!< three settings, uses two bits */
 596 #define SIP_PROG_INBAND_NEVER   (0 << 24)
 597 #define SIP_PROG_INBAND_NO      (1 << 24)
 598 #define SIP_PROG_INBAND_YES     (2 << 24)
 599 /* Open Settlement Protocol authentication */
 600 #define SIP_OSPAUTH             (3 << 26)       /*!< four settings, uses two bits */
 601 #define SIP_OSPAUTH_NO          (0 << 26)
 602 #define SIP_OSPAUTH_GATEWAY     (1 << 26)
 603 #define SIP_OSPAUTH_PROXY       (2 << 26)
 604 #define SIP_OSPAUTH_EXCLUSIVE   (3 << 26)
 605 #define SIP_CALL_ONHOLD         (1 << 28)       /*!< Call states */
 606 #define SIP_CALL_LIMIT          (1 << 29)       /*!< Call limit enforced for this call */
 607 #define SIP_SENDRPID            (1 << 30)       /*!< Remote Party-ID Support */
 608 #define SIP_INC_COUNT           (1 << 31)       /*!< Did this connection increment the counter of in-use calls? */
 609
 610 #define SIP_FLAGS_TO_COPY \
 611         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
 612          SIP_PROG_INBAND | SIP_OSPAUTH | SIP_USECLIENTCODE | SIP_NAT | \
 613          SIP_USEREQPHONE | SIP_INSECURE_PORT | SIP_INSECURE_INVITE)
 614
 615 /* a new page of flags for peers */
 616 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)
 617 #define SIP_PAGE2_RTUPDATE              (1 << 1)
 618 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)
 619 #define SIP_PAGE2_IGNOREREGEXPIRE       (1 << 3)
 620 #define SIP_PAGE2_RT_FROMCONTACT        (1 << 4)
 621 #define SIP_PAGE2_DEBUG                 (3 << 5)
 622 #define SIP_PAGE2_DEBUG_CONFIG          (1 << 5)
 623 #define SIP_PAGE2_DEBUG_CONSOLE         (1 << 6)
 624 #define SIP_PAGE2_DYNAMIC               (1 << 7)        /*!< Dynamic Peers register with Asterisk */
 625 #define SIP_PAGE2_SELFDESTRUCT          (1 << 8)        /*!< Automatic peers need to destruct themselves */
 626 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 9)
 627 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 10)       /*!< Allow subscriptions from this peer? */
 628 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 11)       /*!< Allow overlap dialing ? */
 629 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 12)       /*!< Only issue MWI notification if subscribed to */
 630
 631
 632 #define SIP_PAGE2_FLAGS_TO_COPY \
 633         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT)
 634
 635 /* SIP packet flags */
 636 #define SIP_PKT_DEBUG           (1 << 0)        /*!< Debug this packet */
 637 #define SIP_PKT_WITH_TOTAG      (1 << 1)        /*!< This packet has a to-tag */
 638
 639 #define sipdebug                ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG)
 640 #define sipdebug_config         ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONFIG)
 641 #define sipdebug_console        ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONSOLE)
 642
 643 /*! \brief sip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe  */
 644 static struct sip_pvt {
 645         ast_mutex_t lock;                       /*!< Dialog private lock */
 646         int method;                             /*!< SIP method that opened this dialog */
 647         AST_DECLARE_STRING_FIELDS(
 648                 AST_STRING_FIELD(callid);       /*!< Global CallID */
 649                 AST_STRING_FIELD(randdata);     /*!< Random data */
 650                 AST_STRING_FIELD(accountcode);  /*!< Account code */
 651                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
 652                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
 653                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
 654                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
 655                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
 656                 AST_STRING_FIELD(refer_to);     /*!< Place to store REFER-TO extension */
 657                 AST_STRING_FIELD(referred_by);  /*!< Place to store REFERRED-BY extension */
 658                 AST_STRING_FIELD(refer_contact);/*!< Place to store Contact info from a REFER extension */
 659                 AST_STRING_FIELD(from);         /*!< The From: header */
 660                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
 661                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
 662                 AST_STRING_FIELD(context);      /*!< Context for this call */
 663                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
 664                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
 665                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
 666                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
 667                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
 668                 AST_STRING_FIELD(language);     /*!< Default language for this call */
 669                 AST_STRING_FIELD(musicclass);   /*!< Music on Hold class */
 670                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
 671                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
 672                 AST_STRING_FIELD(username);     /*!< [user] name */
 673                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
 674                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
 675                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
 676                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
 677                 AST_STRING_FIELD(peersecret);   /*!< Password */
 678                 AST_STRING_FIELD(peermd5secret);
 679                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID */
 680                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID */
 681                 AST_STRING_FIELD(via);          /*!< Via: header */
 682                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
 683                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
 684                 AST_STRING_FIELD(rpid);         /*!< Our RPID header */
 685                 AST_STRING_FIELD(rpid_from);    /*!< Our RPID From header */
 686         );
 687         struct ast_codec_pref prefs;            /*!< codec prefs */
 688         unsigned int ocseq;                     /*!< Current outgoing seqno */
 689         unsigned int icseq;                     /*!< Current incoming seqno */
 690         ast_group_t callgroup;                  /*!< Call group */
 691         ast_group_t pickupgroup;                /*!< Pickup group */
 692         int lastinvite;                         /*!< Last Cseq of invite */
 693         struct ast_flags flags[2];              /*!< SIP_ flags */
 694         int timer_t1;                           /*!< SIP timer T1, ms rtt */
 695         unsigned int sipoptions;                /*!< Supported SIP sipoptions on the other end */
 696         int capability;                         /*!< Special capability (codec) */
 697         int jointcapability;                    /*!< Supported capability at both ends (codecs ) */
 698         int peercapability;                     /*!< Supported peer capability */
 699         int prefcodec;                          /*!< Preferred codec (outbound only) */
 700         int noncodeccapability;
 701         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */
 702         int callingpres;                        /*!< Calling presentation */
 703         int authtries;                          /*!< Times we've tried to authenticate */
 704         int expiry;                             /*!< How long we take to expire */
 705         long branch;                            /*!< One random number */
 706         char tag[11];                           /*!< Another random number */
 707         int sessionid;                          /*!< SDP Session ID */
 708         int sessionversion;                     /*!< SDP Session Version */
 709         struct sockaddr_in sa;                  /*!< Our peer */
 710         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
 711         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
 712         int redircodecs;                        /*!< Redirect codecs */
 713         struct sockaddr_in recv;                /*!< Received as */
 714         struct in_addr ourip;                   /*!< Our IP */
 715         struct ast_channel *owner;              /*!< Who owns us */
 716         struct sip_pvt *refer_call;             /*!< Call we are referring */
 717         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
 718         int route_persistant;                   /*!< Is this the "real" route? */
 719         struct sip_auth *peerauth;              /*!< Realm authentication */
 720         int noncecount;                         /*!< Nonce-count */
 721         char lastmsg[256];                      /*!< Last Message sent/received */
 722         int amaflags;                           /*!< AMA Flags */
 723         int pendinginvite;                      /*!< Any pending invite */
 724 #ifdef OSP_SUPPORT
 725         int osphandle;                          /*!< OSP Handle for call */
 726         time_t ospstart;                        /*!< OSP Start time */
 727         unsigned int osptimelimit;              /*!< OSP call duration limit */
 728 #endif
 729         struct sip_request initreq;             /*!< Initial request that opened the SIP dialog */
 730
 731         int maxtime;                            /*!< Max time for first response */
 732         int initid;                             /*!< Auto-congest ID if appropriate */
 733         int autokillid;                         /*!< Auto-kill ID */
 734         time_t lastrtprx;                       /*!< Last RTP received */
 735         time_t lastrtptx;                       /*!< Last RTP sent */
 736         int rtptimeout;                         /*!< RTP timeout time */
 737         int rtpholdtimeout;                     /*!< RTP timeout when on hold */
 738         int rtpkeepalive;                       /*!< Send RTP packets for keepalive */
 739         enum subscriptiontype subscribed;       /*!< Is this dialog a subscription?  */
 740         int stateid;
 741         int laststate;                          /*!< Last known extension state */
 742         int dialogver;
 743
 744         struct ast_dsp *vad;                    /*!< Voice Activation Detection dsp */
 745
 746         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one
 747                                                         Used in peerpoke, mwi subscriptions */
 748         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
 749         struct ast_rtp *rtp;                    /*!< RTP Session */
 750         struct ast_rtp *vrtp;                   /*!< Video RTP session */
 751         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
 752         struct sip_history_head *history;       /*!< History of this SIP dialog */
 753         struct ast_variable *chanvars;          /*!< Channel variables to set for call */
 754         struct sip_pvt *next;                   /*!< Next dialog in chain */
 755         struct sip_invite_param *options;       /*!< Options for INVITE */
 756 } *iflist = NULL;
 757
 758 #define FLAG_RESPONSE (1 << 0)
 759 #define FLAG_FATAL (1 << 1)
 760
 761 /*! \brief sip packet - read in sipsock_read(), transmitted in send_request() */
 762 struct sip_pkt {
 763         struct sip_pkt *next;                   /*!< Next packet */
 764         int retrans;                            /*!< Retransmission number */
 765         int method;                             /*!< SIP method for this packet */
 766         int seqno;                              /*!< Sequence number */
 767         unsigned int flags;                     /*!< non-zero if this is a response packet (e.g. 200 OK) */
 768         struct sip_pvt *owner;                  /*!< Owner AST call */
 769         int retransid;                          /*!< Retransmission ID */
 770         int timer_a;                            /*!< SIP timer A, retransmission timer */
 771         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
 772         int packetlen;                          /*!< Length of packet */
 773         char data[0];
 774 };
 775
 776 /*! \brief Structure for SIP user data. User's place calls to us */
 777 struct sip_user {
 778         /* Users who can access various contexts */
 779         ASTOBJ_COMPONENTS(struct sip_user);
 780         char secret[80];                /*!< Password */
 781         char md5secret[80];             /*!< Password in md5 */
 782         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
 783         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
 784         char cid_num[80];               /*!< Caller ID num */
 785         char cid_name[80];              /*!< Caller ID name */
 786         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
 787         char language[MAX_LANGUAGE];    /*!< Default language for this user */
 788         char musicclass[MAX_MUSICCLASS];/*!< Music on Hold class */
 789         char useragent[256];            /*!< User agent in SIP request */
 790         struct ast_codec_pref prefs;    /*!< codec prefs */
 791         ast_group_t callgroup;          /*!< Call group */
 792         ast_group_t pickupgroup;        /*!< Pickup Group */
 793         unsigned int sipoptions;        /*!< Supported SIP options */
 794         struct ast_flags flags[2];      /*!< SIP_ flags */
 795         int amaflags;                   /*!< AMA flags for billing */
 796         int callingpres;                /*!< Calling id presentation */
 797         int capability;                 /*!< Codec capability */
 798         int inUse;                      /*!< Number of calls in use */
 799         int call_limit;                 /*!< Limit of concurrent calls */
 800         struct ast_ha *ha;              /*!< ACL setting */
 801         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
 802         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
 803 };
 804
 805 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
 806 struct sip_peer {
 807         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
 808                                         /*!< peer->name is the unique name of this object */
 809         char secret[80];                /*!< Password */
 810         char md5secret[80];             /*!< Password in MD5 */
 811         struct sip_auth *auth;          /*!< Realm authentication list */
 812         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
 813         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
 814         char username[80];              /*!< Temporary username until registration */
 815         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
 816         int amaflags;                   /*!< AMA Flags (for billing) */
 817         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
 818         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
 819         char fromuser[80];              /*!< From: user when calling this peer */
 820         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
 821         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
 822         char cid_num[80];               /*!< Caller ID num */
 823         char cid_name[80];              /*!< Caller ID name */
 824         int callingpres;                /*!< Calling id presentation */
 825         int inUse;                      /*!< Number of calls in use */
 826         int call_limit;                 /*!< Limit of concurrent calls */
 827         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
 828         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox setting for MWI checks */
 829         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
 830         char musicclass[MAX_MUSICCLASS];/*!<  Music on Hold class */
 831         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
 832         struct ast_codec_pref prefs;    /*!<  codec prefs */
 833         int lastmsgssent;
 834         time_t  lastmsgcheck;           /*!<  Last time we checked for MWI */
 835         unsigned int sipoptions;        /*!<  Supported SIP options */
 836         struct ast_flags flags[2];      /*!<  SIP_ flags */
 837         int expire;                     /*!<  When to expire this peer registration */
 838         int capability;                 /*!<  Codec capability */
 839         int rtptimeout;                 /*!<  RTP timeout */
 840         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
 841         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
 842         ast_group_t callgroup;          /*!<  Call group */
 843         ast_group_t pickupgroup;        /*!<  Pickup group */
 844         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
 845         struct sockaddr_in addr;        /*!<  IP address of peer */
 846         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
 847
 848         /* Qualification */
 849         struct sip_pvt *call;           /*!<  Call pointer */
 850         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
 851         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
 852         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
 853         struct timeval ps;              /*!<  Ping send time */
 854
 855         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
 856         struct ast_ha *ha;              /*!<  Access control list */
 857         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
 858         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
 859         int lastmsg;
 860 };
 861
 862
 863
 864 /*! \brief Registrations with other SIP proxies */
 865 struct sip_registry {
 866         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
 867         AST_DECLARE_STRING_FIELDS(
 868                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
 869                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
 870                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
 871                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
 872                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
 873                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
 874                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
 875                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
 876                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
 877                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
 878                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
 879                 AST_STRING_FIELD(contact);      /*!< Contact extension */
 880                 AST_STRING_FIELD(random);
 881         );
 882         int portno;                     /*!<  Optional port override */
 883         int expire;                     /*!< Sched ID of expiration */
 884         int regattempts;                /*!< Number of attempts (since the last success) */
 885         int timeout;                    /*!< sched id of sip_reg_timeout */
 886         int refresh;                    /*!< How often to refresh */
 887         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
 888         enum sipregistrystate regstate; /*!< Registration state (see above) */
 889         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
 890         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
 891         struct sockaddr_in us;          /*!< Who the server thinks we are */
 892         int noncecount;                 /*!< Nonce-count */
 893         char lastmsg[256];              /*!< Last Message sent/received */
 894 };
 895
 896 /* --- Linked lists of various objects --------*/
 897
 898 /*! \brief  The user list: Users and friends */
 899 static struct ast_user_list {
 900         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
 901 } userl;
 902
 903 /*! \brief  The peer list: Peers and Friends */
 904 static struct ast_peer_list {
 905         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
 906 } peerl;
 907
 908 /*! \brief  The register list: Other SIP proxys we register with and place calls to */
 909 static struct ast_register_list {
 910         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
 911         int recheck;
 912 } regl;
 913
 914 /*! \todo Move the sip_auth list to AST_LIST */
 915 static struct sip_auth *authl = NULL;           /*!< Authentication list for realm authentication */
 916
 917
 918 /* --- Sockets and networking --------------*/
 919 static int sipsock  = -1;                       /*!< Main socket for SIP network communication */
 920 static struct sockaddr_in bindaddr = { 0, };    /*!< The address we bind to */
 921 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
 922 static char externhost[MAXHOSTNAMELEN];         /*!< External host name (possibly with dynamic DNS and DHCP */
 923 static time_t externexpire = 0;                 /*!< Expiration counter for re-resolving external host name in dynamic DNS */
 924 static int externrefresh = 10;
 925 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
 926 static struct in_addr __ourip;
 927 static struct sockaddr_in outboundproxyip;
 928 static int ourport;
 929 static struct sockaddr_in debugaddr;
 930
 931 struct ast_config *notify_types;                /*!< The list of manual NOTIFY types we know how to send */
 932
 933
 934
 935 /*---------------------------- Forward declarations of functions in chan_sip.c */
 936 static int transmit_response(struct sip_pvt *p, char *msg, struct sip_request *req);
 937 static int transmit_response_with_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, enum xmittype reliable);
 938 static int transmit_response_with_unsupported(struct sip_pvt *p, char *msg, struct sip_request *req, char *unsupported);
 939 static int transmit_response_with_auth(struct sip_pvt *p, const char *msg, struct sip_request *req, const char *rand, enum xmittype reliable, const char *header, int stale);
 940 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
 941 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
 942 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sendsdp, int init);
 943 static int transmit_reinvite_with_sdp(struct sip_pvt *p);
 944 static int transmit_info_with_digit(struct sip_pvt *p, char digit);
 945 static int transmit_info_with_vidupdate(struct sip_pvt *p);
 946 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
 947 static int transmit_refer(struct sip_pvt *p, const char *dest);
 948 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
 949 static struct sip_peer *temp_peer(const char *name);
 950 static int do_proxy_auth(struct sip_pvt *p, struct sip_request *req, char *header, char *respheader, int sipmethod, int init);
 951 static void free_old_route(struct sip_route *route);
 952 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
 953 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
 954 static int update_call_counter(struct sip_pvt *fup, int event);
 955 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, int realtime);
 956 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
 957 static int sip_do_reload(enum channelreloadreason reason);
 958 static int expire_register(void *data);
 959 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
 960 static int sip_devicestate(void *data);
 961 static int sip_sendtext(struct ast_channel *ast, const char *text);
 962 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
 963 static int sip_hangup(struct ast_channel *ast);
 964 static int sip_answer(struct ast_channel *ast);
 965 static struct ast_frame *sip_read(struct ast_channel *ast);
 966 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
 967 static int sip_indicate(struct ast_channel *ast, int condition);
 968 static int sip_transfer(struct ast_channel *ast, const char *dest);
 969 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
 970 static int sip_senddigit(struct ast_channel *ast, char digit);
 971 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
 972 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);   /* Add realm authentication in list */
 973 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);        /* Find authentication for a specific realm */
 974 static int check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
 975                 const char *secret, const char *md5secret, int sipmethod,
 976                 char *uri, enum xmittype reliable, int ignore);
 977 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
 978 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
 979 static int determine_firstline_parts(struct sip_request *req);
 980 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
 981 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
 982 static int transmit_state_notify(struct sip_pvt *p, int state, int full);
 983 static char *gettag(struct sip_request *req, char *header, char *tagbuf, int tagbufsize);
 984 static int find_sip_method(char *msg);
 985 static unsigned int parse_sip_options(struct sip_pvt *pvt, char *supported);
 986 static void sip_destroy(struct sip_pvt *p);
 987 static void sip_destroy_peer(struct sip_peer *peer);
 988 static void sip_destroy_user(struct sip_user *user);
 989 static void parse_request(struct sip_request *req);
 990 static char *get_header(struct sip_request *req, const char *name);
 991 static void copy_request(struct sip_request *dst,struct sip_request *src);
 992 static int transmit_response_reliable(struct sip_pvt *p, char *msg, struct sip_request *req);
 993 static int transmit_register(struct sip_registry *r, int sipmethod, char *auth, char *authheader);
 994 static int sip_poke_peer(struct sip_peer *peer);
 995 static int __sip_do_register(struct sip_registry *r);
 996 static int restart_monitor(void);
 997 static void set_peer_defaults(struct sip_peer *peer);
 998 static struct sip_peer *temp_peer(const char *name);
 999 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1000 static int sip_scheddestroy(struct sip_pvt *p, int ms);
1001
1002
1003 /*----- RTP interface functions */
1004 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp, int codecs, int nat_active);
1005 static struct ast_rtp *sip_get_rtp_peer(struct ast_channel *chan);
1006 static struct ast_rtp *sip_get_vrtp_peer(struct ast_channel *chan);
1007 static int sip_get_codec(struct ast_channel *chan);
1008
1009 /*! \brief Definition of this channel for PBX channel registration */
1010 static const struct ast_channel_tech sip_tech = {
1011         .type = "SIP",
1012         .description = "Session Initiation Protocol (SIP)",
1013         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1014         .properties = AST_CHAN_TP_WANTSJITTER,
1015         .requester = sip_request_call,
1016         .devicestate = sip_devicestate,
1017         .call = sip_call,
1018         .hangup = sip_hangup,
1019         .answer = sip_answer,
1020         .read = sip_read,
1021         .write = sip_write,
1022         .write_video = sip_write,
1023         .indicate = sip_indicate,
1024         .transfer = sip_transfer,
1025         .fixup = sip_fixup,
1026         .send_digit = sip_senddigit,
1027         .bridge = ast_rtp_bridge,
1028         .send_text = sip_sendtext,
1029 };
1030
1031 /*! \brief Interface structure with callbacks used to connect to RTP module */
1032 static struct ast_rtp_protocol sip_rtp = {
1033         type: "SIP",
1034         get_rtp_info: sip_get_rtp_peer,
1035         get_vrtp_info: sip_get_vrtp_peer,
1036         set_rtp_peer: sip_set_rtp_peer,
1037         get_codec: sip_get_codec,
1038 };
1039
1040
1041 /*! \brief Find SIP method from header
1042  * Strictly speaking, SIP methods are case SENSITIVE, but we don't check
1043  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send */
1044 static int find_sip_method(char *msg)
1045 {
1046         int i, res = 0;
1047
1048         if (ast_strlen_zero(msg))
1049                 return 0;
1050
1051         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1052                 if (!strcasecmp(sip_methods[i].text, msg))
1053                         res = sip_methods[i].id;
1054         }
1055         return res;
1056 }
1057
1058 /*! \brief Parse supported header in incoming packet */
1059 static unsigned int parse_sip_options(struct sip_pvt *pvt, char *supported)
1060 {
1061         char *next, *sep;
1062         char *temp = ast_strdupa(supported);
1063         unsigned int profile = 0;
1064         int i, found;
1065
1066         if (!pvt || ast_strlen_zero(supported) )
1067                 return 0;
1068
1069         if (option_debug > 2 && sipdebug)
1070                 ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1071
1072         for (next = temp; next; next = sep) {
1073                 found = FALSE;
1074                 if ( (sep = strchr(next, ',')) != NULL)
1075                         *sep++ = '\0';
1076                 next = ast_skip_blanks(next);
1077                 if (option_debug > 2 && sipdebug)
1078                         ast_log(LOG_DEBUG, "Found SIP option: -%s-\n", next);
1079                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1080                         if (!strcasecmp(next, sip_options[i].text)) {
1081                                 profile |= sip_options[i].id;
1082                                 found = TRUE;
1083                                 if (option_debug > 2 && sipdebug)
1084                                         ast_log(LOG_DEBUG, "Matched SIP option: %s\n", next);
1085                                 break;
1086                         }
1087                 }
1088                 if (!found && option_debug > 2 && sipdebug)
1089                         ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1090         }
1091
1092         pvt->sipoptions = profile;
1093         return profile;
1094 }
1095
1096 /*! \brief See if we pass debug IP filter */
1097 static inline int sip_debug_test_addr(const struct sockaddr_in *addr)
1098 {
1099         if (!sipdebug)
1100                 return 0;
1101         if (debugaddr.sin_addr.s_addr) {
1102                 if (((ntohs(debugaddr.sin_port) != 0)
1103                         && (debugaddr.sin_port != addr->sin_port))
1104                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1105                         return 0;
1106         }
1107         return 1;
1108 }
1109
1110 /*! \brief Test PVT for debugging output */
1111 static inline int sip_debug_test_pvt(struct sip_pvt *p)
1112 {
1113         if (!sipdebug)
1114                 return 0;
1115         return sip_debug_test_addr(ast_test_flag(&p->flags[0], SIP_NAT_ROUTE) ? &p->recv : &p->sa);
1116 }
1117
1118
1119 /*! \brief Transmit SIP message */
1120 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
1121 {
1122         int res;
1123         char iabuf[INET_ADDRSTRLEN];
1124
1125         if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
1126                 res=sendto(sipsock, data, len, 0, (struct sockaddr *)&p->recv, sizeof(struct sockaddr_in));
1127         else
1128                 res=sendto(sipsock, data, len, 0, (struct sockaddr *)&p->sa, sizeof(struct sockaddr_in));
1129
1130         if (res != len) {
1131                 ast_log(LOG_WARNING, "sip_xmit of %p (len %d) to %s:%d returned %d: %s\n", data, len, ast_inet_ntoa(iabuf, sizeof(iabuf), p->sa.sin_addr), ntohs(p->sa.sin_port), res, strerror(errno));
1132         }
1133         return res;
1134 }
1135
1136
1137 /*! \brief Build a Via header for a request */
1138 static void build_via(struct sip_pvt *p)
1139 {
1140         char iabuf[INET_ADDRSTRLEN];
1141         /* Work around buggy UNIDEN UIP200 firmware */
1142         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
1143
1144         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
1145         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
1146                          ast_inet_ntoa(iabuf, sizeof(iabuf), p->ourip), ourport, p->branch, rport);
1147 }
1148
1149 /*! \brief NAT fix - decide which IP address to use for ASterisk server?
1150  * Only used for outbound registrations */
1151 static int ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us)
1152 {
1153         /*
1154          * Using the localaddr structure built up with localnet statements
1155          * apply it to their address to see if we need to substitute our
1156          * externip or can get away with our internal bindaddr
1157          */
1158         struct sockaddr_in theirs;
1159         theirs.sin_addr = *them;
1160
1161         if (localaddr && externip.sin_addr.s_addr &&
1162            ast_apply_ha(localaddr, &theirs)) {
1163                 if (externexpire && (time(NULL) >= externexpire)) {
1164                         struct ast_hostent ahp;
1165                         struct hostent *hp;
1166
1167                         time(&externexpire);
1168                         externexpire += externrefresh;
1169                         if ((hp = ast_gethostbyname(externhost, &ahp))) {
1170                                 memcpy(&externip.sin_addr, hp->h_addr, sizeof(externip.sin_addr));
1171                         } else
1172                                 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
1173                 }
1174                 *us = externip.sin_addr;
1175                 if (option_debug) {
1176                         char iabuf[INET_ADDRSTRLEN];
1177                         ast_inet_ntoa(iabuf, sizeof(iabuf), *(struct in_addr *)&them->s_addr);
1178
1179                         ast_log(LOG_DEBUG, "Target address %s is not local, substituting externip\n", iabuf);
1180                 }
1181         } else if (bindaddr.sin_addr.s_addr)
1182                 *us = bindaddr.sin_addr;
1183         else
1184                 return ast_ouraddrfor(them, us);
1185         return 0;
1186 }
1187
1188 /*! \brief Append to SIP dialog history
1189         \return Always returns 0 */
1190 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1191
1192 static int append_history_full(struct sip_pvt *p, const char *fmt, ...)
1193         __attribute__ ((format (printf, 2, 3)));
1194
1195 /*! \brief Append to SIP dialog history with arg list  */
1196 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
1197 {
1198         char buf[80], *c = buf; /* max history length */
1199         struct sip_history *hist;
1200         int l;
1201
1202         vsnprintf(buf, sizeof(buf), fmt, ap);
1203         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
1204         l = strlen(buf) + 1;
1205         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
1206                 return;
1207         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
1208                 free(hist);
1209                 return;
1210         }
1211         memcpy(hist->event, buf, l);
1212         AST_LIST_INSERT_TAIL(p->history, hist, list);
1213 }
1214
1215 /*! \brief Append to SIP dialog history with arg list  */
1216 static int append_history_full(struct sip_pvt *p, const char *fmt, ...)
1217 {
1218         va_list ap;
1219
1220         if (!recordhistory || !p)
1221                 return 0;
1222         va_start(ap, fmt);
1223         append_history_va(p, fmt, ap);
1224         va_end(ap);
1225
1226         return 0;
1227 }
1228
1229 /*! \brief Retransmit SIP message if no answer */
1230 static int retrans_pkt(void *data)
1231 {
1232         struct sip_pkt *pkt=data, *prev, *cur = NULL;
1233         char iabuf[INET_ADDRSTRLEN];
1234         int reschedule = DEFAULT_RETRANS;
1235
1236         /* Lock channel */
1237         ast_mutex_lock(&pkt->owner->lock);
1238
1239         if (pkt->retrans < MAX_RETRANS) {
1240                 pkt->retrans++;
1241                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
1242                         if (sipdebug && option_debug > 3)
1243                                 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);
1244                 } else {
1245                         int siptimer_a;
1246
1247                         if (sipdebug && option_debug > 3)
1248                                 ast_log(LOG_DEBUG, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
1249                         if (!pkt->timer_a)
1250                                 pkt->timer_a = 2 ;
1251                         else
1252                                 pkt->timer_a = 2 * pkt->timer_a;
1253
1254                         /* For non-invites, a maximum of 4 secs */
1255                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
1256                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
1257                                 siptimer_a = 4000;
1258
1259                         /* Reschedule re-transmit */
1260                         reschedule = siptimer_a;
1261                         if (option_debug > 3)
1262                                 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);
1263                 }
1264
1265                 if (pkt->owner && sip_debug_test_pvt(pkt->owner)) {
1266                         if (ast_test_flag(&pkt->owner->flags[0], SIP_NAT_ROUTE))
1267                                 ast_verbose("Retransmitting #%d (NAT) to %s:%d:\n%s\n---\n", pkt->retrans, ast_inet_ntoa(iabuf, sizeof(iabuf), pkt->owner->recv.sin_addr), ntohs(pkt->owner->recv.sin_port), pkt->data);
1268                         else
1269                                 ast_verbose("Retransmitting #%d (no NAT) to %s:%d:\n%s\n---\n", pkt->retrans, ast_inet_ntoa(iabuf, sizeof(iabuf), pkt->owner->sa.sin_addr), ntohs(pkt->owner->sa.sin_port), pkt->data);
1270                 }
1271
1272                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
1273                 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
1274                 ast_mutex_unlock(&pkt->owner->lock);
1275                 return  reschedule;
1276         }
1277         /* Too many retries */
1278         if (pkt->owner && pkt->method != SIP_OPTIONS) {
1279                 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
1280                         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");
1281         } else {
1282                 if ((pkt->method == SIP_OPTIONS) && sipdebug)
1283                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
1284         }
1285         append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
1286
1287         pkt->retransid = -1;
1288
1289         if (ast_test_flag(pkt, FLAG_FATAL)) {
1290                 while(pkt->owner->owner && ast_mutex_trylock(&pkt->owner->owner->lock)) {
1291                         ast_mutex_unlock(&pkt->owner->lock);
1292                         usleep(1);
1293                         ast_mutex_lock(&pkt->owner->lock);
1294                 }
1295                 if (pkt->owner->owner) {
1296                         ast_set_flag(&pkt->owner->flags[0], SIP_ALREADYGONE);
1297                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
1298                         ast_queue_hangup(pkt->owner->owner);
1299                         ast_mutex_unlock(&pkt->owner->owner->lock);
1300                 } else {
1301                         /* If no channel owner, destroy now */
1302                         ast_set_flag(&pkt->owner->flags[0], SIP_NEEDDESTROY);
1303                 }
1304         }
1305         /* In any case, go ahead and remove the packet */
1306         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
1307                 if (cur == pkt)
1308                         break;
1309         }
1310         if (cur) {
1311                 if (prev)
1312                         prev->next = cur->next;
1313                 else
1314                         pkt->owner->packets = cur->next;
1315                 ast_mutex_unlock(&pkt->owner->lock);
1316                 free(cur);
1317                 pkt = NULL;
1318         } else
1319                 ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
1320         if (pkt)
1321                 ast_mutex_unlock(&pkt->owner->lock);
1322         return 0;
1323 }
1324
1325 /*! \brief Transmit packet with retransmits
1326         \return 0 on success, -1 on failure to allocate packet
1327 */
1328 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
1329 {
1330         struct sip_pkt *pkt;
1331         int siptimer_a = DEFAULT_RETRANS;
1332
1333         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
1334                 return -1;
1335         memcpy(pkt->data, data, len);
1336         pkt->method = sipmethod;
1337         pkt->packetlen = len;
1338         pkt->next = p->packets;
1339         pkt->owner = p;
1340         pkt->seqno = seqno;
1341         pkt->flags = resp;
1342         pkt->data[len] = '\0';
1343         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
1344         if (fatal)
1345                 ast_set_flag(pkt, FLAG_FATAL);
1346
1347         if (pkt->timer_t1)
1348                 siptimer_a = pkt->timer_t1 * 2;
1349
1350         /* Schedule retransmission */
1351         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
1352         if (option_debug > 3 && sipdebug)
1353                 ast_log(LOG_DEBUG, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
1354         pkt->next = p->packets;
1355         p->packets = pkt;
1356
1357         __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);      /* Send packet */
1358         if (sipmethod == SIP_INVITE) {
1359                 /* Note this is a pending invite */
1360                 p->pendinginvite = seqno;
1361         }
1362         return 0;
1363 }
1364
1365 /*! \brief Kill a SIP dialog (called by scheduler) */
1366 static int __sip_autodestruct(void *data)
1367 {
1368         struct sip_pvt *p = data;
1369
1370         /* If this is a subscription, tell the phone that we got a timeout */
1371         if (p->subscribed) {
1372                 p->subscribed = TIMEOUT;
1373                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1); /* Send last notification */
1374                 p->subscribed = NONE;
1375                 append_history(p, "Subscribestatus", "timeout");
1376                 if (option_debug > 2)
1377                         ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
1378                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
1379         }
1380
1381         /* Reset schedule ID */
1382         p->autokillid = -1;
1383
1384         if (option_debug)
1385                 ast_log(LOG_DEBUG, "Auto destroying call '%s'\n", p->callid);
1386         append_history(p, "AutoDestroy", "");
1387         if (p->owner) {
1388                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
1389                 ast_queue_hangup(p->owner);
1390         } else {
1391                 sip_destroy(p);
1392         }
1393         return 0;
1394 }
1395
1396 /*! \brief Schedule destruction of SIP call */
1397 static int sip_scheddestroy(struct sip_pvt *p, int ms)
1398 {
1399         if (sip_debug_test_pvt(p))
1400                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
1401         if (recordhistory)
1402                 append_history(p, "SchedDestroy", "%d ms", ms);
1403
1404         if (p->autokillid > -1)
1405                 ast_sched_del(sched, p->autokillid);
1406         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
1407         return 0;
1408 }
1409
1410 /*! \brief Cancel destruction of SIP dialog */
1411 static int sip_cancel_destroy(struct sip_pvt *p)
1412 {
1413         if (p->autokillid > -1)
1414                 ast_sched_del(sched, p->autokillid);
1415         append_history(p, "CancelDestroy", "");
1416         p->autokillid = -1;
1417         return 0;
1418 }
1419
1420 /*! \brief Acknowledges receipt of a packet and stops retransmission */
1421 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset)
1422 {
1423         struct sip_pkt *cur, *prev = NULL;
1424         int res = -1;
1425
1426         /* Just in case... */
1427         char *msg;
1428
1429         msg = sip_methods[sipmethod].text;
1430
1431         ast_mutex_lock(&p->lock);
1432         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
1433                 if ((cur->seqno == seqno) && ((ast_test_flag(cur, FLAG_RESPONSE)) == resp) &&
1434                         ((ast_test_flag(cur, FLAG_RESPONSE)) ||
1435                          (!strncasecmp(msg, cur->data, strlen(msg)) && (cur->data[strlen(msg)] < 33)))) {
1436                         if (!resp && (seqno == p->pendinginvite)) {
1437                                 ast_log(LOG_DEBUG, "Acked pending invite %d\n", p->pendinginvite);
1438                                 p->pendinginvite = 0;
1439                         }
1440                         /* this is our baby */
1441                         if (prev)
1442                                 prev->next = cur->next;
1443                         else
1444                                 p->packets = cur->next;
1445                         if (cur->retransid > -1) {
1446                                 if (sipdebug && option_debug > 3)
1447                                         ast_log(LOG_DEBUG, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
1448                                 ast_sched_del(sched, cur->retransid);
1449                         }
1450                         if (!reset)
1451                                 free(cur);
1452                         res = 0;
1453                         break;
1454                 }
1455         }
1456         ast_mutex_unlock(&p->lock);
1457         if (option_debug)
1458                 ast_log(LOG_DEBUG, "Stopping retransmission on '%s' of %s %d: Match %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
1459         return res;
1460 }
1461
1462 /*! \brief Pretend to ack all packets */
1463 static int __sip_pretend_ack(struct sip_pvt *p)
1464 {
1465         struct sip_pkt *cur=NULL;
1466
1467         while(p->packets) {
1468                 if (cur == p->packets) {
1469                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
1470                         return -1;
1471                 }
1472                 cur = p->packets;
1473                 if (cur->method)
1474                         __sip_ack(p, p->packets->seqno, (ast_test_flag(p->packets, FLAG_RESPONSE)), cur->method, FALSE);
1475                 else {  /* Unknown packet type */
1476                         char *c;
1477                         char method[128];
1478
1479                         ast_copy_string(method, p->packets->data, sizeof(method));
1480                         c = ast_skip_blanks(method); /* XXX what ? */
1481                         *c = '\0';
1482                         __sip_ack(p, p->packets->seqno, (ast_test_flag(p->packets, FLAG_RESPONSE)), find_sip_method(method), FALSE);
1483                 }
1484         }
1485         return 0;
1486 }
1487
1488 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
1489 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
1490 {
1491         struct sip_pkt *cur;
1492         int res = -1;
1493         char *msg = sip_methods[sipmethod].text;
1494
1495         for (cur = p->packets; cur ; cur = cur->next) {
1496                 if ((cur->seqno == seqno) && ((ast_test_flag(cur, FLAG_RESPONSE)) == resp) &&
1497                         ((ast_test_flag(cur, FLAG_RESPONSE)) ||
1498                          (!strncasecmp(msg, cur->data, strlen(msg)) && (cur->data[strlen(msg)] < 33)))) {
1499                         /* this is our baby */
1500                         if (cur->retransid > -1) {
1501                                 if (option_debug > 3 && sipdebug)
1502                                         ast_log(LOG_DEBUG, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, msg);
1503                                 ast_sched_del(sched, cur->retransid);
1504                         }
1505                         cur->retransid = -1;
1506                         res = 0;
1507                         break;
1508                 }
1509         }
1510         if (option_debug)
1511                 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");
1512         return res;
1513 }
1514
1515
1516 /*! \brief Copy SIP request, parse it */
1517 static void parse_copy(struct sip_request *dst, struct sip_request *src)
1518 {
1519         memset(dst, 0, sizeof(*dst));
1520         memcpy(dst->data, src->data, sizeof(dst->data));
1521         dst->len = src->len;
1522         parse_request(dst);
1523 }
1524
1525 /*! \brief Transmit response on SIP request*/
1526 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
1527 {
1528         int res;
1529
1530         if (sip_debug_test_pvt(p)) {
1531                 char iabuf[INET_ADDRSTRLEN];
1532                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
1533                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(iabuf, sizeof(iabuf), p->recv.sin_addr), ntohs(p->recv.sin_port), req->data);
1534                 else
1535                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(iabuf, sizeof(iabuf), p->sa.sin_addr), ntohs(p->sa.sin_port), req->data);
1536         }
1537         if (recordhistory) {
1538                 struct sip_request tmp;
1539                 parse_copy(&tmp, req);
1540                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s", tmp.data, get_header(&tmp, "CSeq"));
1541         }
1542         res = (reliable) ?
1543                 __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
1544                 __sip_xmit(p, req->data, req->len);
1545         if (res > 0)
1546                 return 0;
1547         return res;
1548 }
1549
1550 /*! \brief Send SIP Request to the other part of the dialogue */
1551 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
1552 {
1553         int res;
1554
1555         if (sip_debug_test_pvt(p)) {
1556                 char iabuf[INET_ADDRSTRLEN];
1557                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
1558                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(iabuf, sizeof(iabuf), p->recv.sin_addr), ntohs(p->recv.sin_port), req->data);
1559                 else
1560                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(iabuf, sizeof(iabuf), p->sa.sin_addr), ntohs(p->sa.sin_port), req->data);
1561         }
1562         if (recordhistory) {
1563                 struct sip_request tmp;
1564                 parse_copy(&tmp, req);
1565                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s", tmp.data, get_header(&tmp, "CSeq"));
1566         }
1567         res = (reliable) ?
1568                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable > 1), req->method) :
1569                 __sip_xmit(p, req->data, req->len);
1570         return res;
1571 }
1572
1573 /*! \brief Pick out text in brackets from character string
1574         \return pointer to terminated stripped string
1575         \param tmp input string that will be modified */
1576 static char *get_in_brackets(char *tmp)
1577 {
1578         char *parse;
1579         char *first_quote;
1580         char *first_bracket;
1581         char *second_bracket;
1582         char last_char;
1583
1584         parse = tmp;
1585         for (;;) {
1586                 first_quote = strchr(parse, '"');
1587                 first_bracket = strchr(parse, '<');
1588                 if (first_quote && first_bracket && (first_quote < first_bracket)) {
1589                         last_char = '\0';
1590                         for (parse = first_quote + 1; *parse; parse++) {
1591                                 if ((*parse == '"') && (last_char != '\\'))
1592                                         break;
1593                                 last_char = *parse;
1594                         }
1595                         if (!*parse) {
1596                                 ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
1597                                 return tmp;
1598                         }
1599                         parse++;
1600                         continue;
1601                 }
1602                 if (first_bracket) {
1603                         second_bracket = strchr(first_bracket + 1, '>');
1604                         if (second_bracket) {
1605                                 *second_bracket = '\0';
1606                                 return first_bracket + 1;
1607                         } else {
1608                                 ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
1609                                 return tmp;
1610                         }
1611                 }
1612                 return tmp;
1613         }
1614 }
1615
1616 /*! \brief Send SIP MESSAGE text within a call
1617         Called from PBX core sendtext() application */
1618 static int sip_sendtext(struct ast_channel *ast, const char *text)
1619 {
1620         struct sip_pvt *p = ast->tech_pvt;
1621         int debug = sip_debug_test_pvt(p);
1622
1623         if (debug)
1624                 ast_verbose("Sending text %s on %s\n", text, ast->name);
1625         if (!p)
1626                 return -1;
1627         if (ast_strlen_zero(text))
1628                 return 0;
1629         if (debug)
1630                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
1631         transmit_message_with_text(p, text);
1632         return 0;
1633 }
1634
1635 /*! \brief Update peer object in realtime storage */
1636 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
1637 {
1638         char port[10];
1639         char ipaddr[20];
1640         char regseconds[20];
1641         time_t nowtime;
1642
1643         time(&nowtime);
1644         nowtime += expirey;
1645         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
1646         ast_inet_ntoa(ipaddr, sizeof(ipaddr), sin->sin_addr);
1647         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
1648
1649         if (fullcontact)
1650                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr, "port", port, "regseconds", regseconds, "username", username, "fullcontact", fullcontact, NULL);
1651         else
1652                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr, "port", port, "regseconds", regseconds, "username", username, NULL);
1653 }
1654
1655 /*! \brief Automatically add peer extension to dial plan */
1656 static void register_peer_exten(struct sip_peer *peer, int onoff)
1657 {
1658         char multi[256];
1659         char *stringp, *ext;
1660         if (!ast_strlen_zero(global_regcontext)) {
1661
1662                 ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
1663                 stringp = multi;
1664                 while((ext = strsep(&stringp, "&"))) {
1665                         if (onoff)
1666                                 ast_add_extension(global_regcontext, 1, ext, 1, NULL, NULL, "Noop",
1667                                                   ast_strdup(peer->name), free, "SIP");
1668                         else
1669                                 ast_context_remove_extension(global_regcontext, ext, 1, NULL);
1670                 }
1671         }
1672 }
1673
1674 /*! \brief Destroy peer object from memory */
1675 static void sip_destroy_peer(struct sip_peer *peer)
1676 {
1677         if (option_debug > 2)
1678                 ast_log(LOG_DEBUG, "Destroying SIP peer %s\n", peer->name);
1679
1680         /* Delete it, it needs to disappear */
1681         if (peer->call)
1682                 sip_destroy(peer->call);
1683
1684         if (peer->mwipvt) {     /* We have an active subscription, delete it */
1685                 sip_destroy(peer->mwipvt);
1686         }
1687
1688         if (peer->chanvars) {
1689                 ast_variables_destroy(peer->chanvars);
1690                 peer->chanvars = NULL;
1691         }
1692         if (peer->expire > -1)
1693                 ast_sched_del(sched, peer->expire);
1694         if (peer->pokeexpire > -1)
1695                 ast_sched_del(sched, peer->pokeexpire);
1696         register_peer_exten(peer, FALSE);
1697         ast_free_ha(peer->ha);
1698         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
1699                 apeerobjs--;
1700         else if (ast_test_flag(&peer->flags[0], SIP_REALTIME))
1701                 rpeerobjs--;
1702         else
1703                 speerobjs--;
1704         clear_realm_authentication(peer->auth);
1705         peer->auth = (struct sip_auth *) NULL;
1706         if (peer->dnsmgr)
1707                 ast_dnsmgr_release(peer->dnsmgr);
1708         free(peer);
1709 }
1710
1711 /*! \brief Update peer data in database (if used) */
1712 static void update_peer(struct sip_peer *p, int expiry)
1713 {
1714         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
1715         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
1716             (ast_test_flag(&p->flags[0], SIP_REALTIME) || rtcachefriends)) {
1717                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
1718         }
1719 }
1720
1721
1722 /*! \brief  realtime_peer: Get peer from realtime storage
1723  * Checks the "sippeers" realtime family from extconfig.conf
1724  * \todo Consider adding check of port address when matching here to follow the same
1725  *      algorithm as for static peers. Will we break anything by adding that?
1726 */
1727 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin)
1728 {
1729         struct sip_peer *peer = NULL;
1730         struct ast_variable *var;
1731         struct ast_variable *tmp;
1732         char *newpeername = (char *) peername;
1733         char iabuf[80];
1734
1735         /* First check on peer name */
1736         if (newpeername)
1737                 var = ast_load_realtime("sippeers", "name", peername, NULL);
1738         else if (sin) { /* Then check on IP address for dynamic peers */
1739                 ast_inet_ntoa(iabuf, sizeof(iabuf), sin->sin_addr);
1740                 var = ast_load_realtime("sippeers", "host", iabuf, NULL);       /* First check for fixed IP hosts */
1741                 if (!var)
1742                         var = ast_load_realtime("sippeers", "ipaddr", iabuf, NULL);     /* Then check for registred hosts */
1743
1744         } else
1745                 return NULL;
1746
1747         if (!var)
1748                 return NULL;
1749
1750         for (tmp = var; tmp; tmp = tmp->next) {
1751                 /* If this is type=user, then skip this object. */
1752                 if (!strcasecmp(tmp->name, "type") &&
1753                     !strcasecmp(tmp->value, "user")) {
1754                         ast_variables_destroy(var);
1755                         return NULL;
1756                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
1757                         newpeername = tmp->value;
1758                 }
1759         }
1760
1761         if (!newpeername) {     /* Did not find peer in realtime */
1762                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", iabuf);
1763                 ast_variables_destroy(var);
1764                 return (struct sip_peer *) NULL;
1765         }
1766
1767         /* Peer found in realtime, now build it in memory */
1768         peer = build_peer(newpeername, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
1769         if (!peer) {
1770                 ast_variables_destroy(var);
1771                 return (struct sip_peer *) NULL;
1772         }
1773
1774         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
1775                 /* Cache peer */
1776                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
1777                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
1778                         if (peer->expire > -1) {
1779                                 ast_sched_del(sched, peer->expire);
1780                         }
1781                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
1782                 }
1783                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
1784         } else {
1785                 ast_set_flag(&peer->flags[0], SIP_REALTIME);
1786         }
1787         ast_variables_destroy(var);
1788
1789         return peer;
1790 }
1791
1792 /*! \brief Support routine for find_peer */
1793 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
1794 {
1795         /* We know name is the first field, so we can cast */
1796         struct sip_peer *p = (struct sip_peer *) name;
1797         return  !(!inaddrcmp(&p->addr, sin) ||
1798                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
1799                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
1800 }
1801
1802 /*! \brief Locate peer by name or ip address
1803  *      This is used on incoming SIP message to find matching peer on ip
1804         or outgoing message to find matching peer on name */
1805 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
1806 {
1807         struct sip_peer *p = NULL;
1808
1809         if (peer)
1810                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
1811         else
1812                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
1813
1814         if (!p && realtime) {
1815                 p = realtime_peer(peer, sin);
1816         }
1817         return p;
1818 }
1819
1820 /*! \brief Remove user object from in-memory storage */
1821 static void sip_destroy_user(struct sip_user *user)
1822 {
1823         if (option_debug > 2)
1824                 ast_log(LOG_DEBUG, "Destroying user object from memory: %s\n", user->name);
1825         ast_free_ha(user->ha);
1826         if (user->chanvars) {
1827                 ast_variables_destroy(user->chanvars);
1828                 user->chanvars = NULL;
1829         }
1830         if (ast_test_flag(&user->flags[0], SIP_REALTIME))
1831                 ruserobjs--;
1832         else
1833                 suserobjs--;
1834         free(user);
1835 }
1836
1837 /*! \brief Load user from realtime storage
1838  * Loads user from "sipusers" category in realtime (extconfig.conf)
1839  * Users are matched on From: user name (the domain in skipped) */
1840 static struct sip_user *realtime_user(const char *username)
1841 {
1842         struct ast_variable *var;
1843         struct ast_variable *tmp;
1844         struct sip_user *user = NULL;
1845
1846         var = ast_load_realtime("sipusers", "name", username, NULL);
1847
1848         if (!var)
1849                 return NULL;
1850
1851         for (tmp = var; tmp; tmp = tmp->next) {
1852                 if (!strcasecmp(tmp->name, "type") &&
1853                         !strcasecmp(tmp->value, "peer")) {
1854                         ast_variables_destroy(var);
1855                         return NULL;
1856                 }
1857         }
1858
1859         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
1860
1861         if (!user) {    /* No user found */
1862                 ast_variables_destroy(var);
1863                 return NULL;
1864         }
1865
1866         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
1867                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
1868                 suserobjs++;
1869                 ASTOBJ_CONTAINER_LINK(&userl,user);
1870         } else {
1871                 /* Move counter from s to r... */
1872                 suserobjs--;
1873                 ruserobjs++;
1874                 ast_set_flag(&user->flags[0], SIP_REALTIME);
1875         }
1876         ast_variables_destroy(var);
1877         return user;
1878 }
1879
1880 /*! \brief Locate user by name
1881  * Locates user by name (From: sip uri user name part) first
1882  * from in-memory list (static configuration) then from
1883  * realtime storage (defined in extconfig.conf) */
1884 static struct sip_user *find_user(const char *name, int realtime)
1885 {
1886         struct sip_user *u = NULL;
1887         u = ASTOBJ_CONTAINER_FIND(&userl,name);
1888         if (!u && realtime) {
1889                 u = realtime_user(name);
1890         }
1891         return u;
1892 }
1893
1894 /*! \brief Create address structure from peer reference */
1895 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer)
1896 {
1897         if ((peer->addr.sin_addr.s_addr || peer->defaddr.sin_addr.s_addr) &&
1898             (!peer->maxms || ((peer->lastms >= 0)  && (peer->lastms <= peer->maxms)))) {
1899                 r->sa = (peer->addr.sin_addr.s_addr) ? peer->addr : peer->defaddr;
1900                 r->recv = r->sa;
1901         } else {
1902                 return -1;
1903         }
1904
1905         ast_copy_flags(&r->flags[0], &peer->flags[0], SIP_FLAGS_TO_COPY);
1906         ast_copy_flags(&r->flags[1], &peer->flags[1], SIP_PAGE2_FLAGS_TO_COPY);
1907         r->capability = peer->capability;
1908         if (!ast_test_flag(&r->flags[1], SIP_PAGE2_VIDEOSUPPORT) && r->vrtp) {
1909                 ast_rtp_destroy(r->vrtp);
1910                 r->vrtp = NULL;
1911         }
1912         r->prefs = peer->prefs;
1913         if (r->rtp) {
1914                 if (option_debug)
1915                         ast_log(LOG_DEBUG, "Setting NAT on RTP to %d\n", (ast_test_flag(&r->flags[0], SIP_NAT) & SIP_NAT_ROUTE));
1916                 ast_rtp_setnat(r->rtp, (ast_test_flag(&r->flags[0], SIP_NAT) & SIP_NAT_ROUTE));
1917         }
1918         if (r->vrtp) {
1919                 if (option_debug)
1920                         ast_log(LOG_DEBUG, "Setting NAT on VRTP to %d\n", (ast_test_flag(&r->flags[0], SIP_NAT) & SIP_NAT_ROUTE));
1921                 ast_rtp_setnat(r->vrtp, (ast_test_flag(&r->flags[0], SIP_NAT) & SIP_NAT_ROUTE));
1922         }
1923         ast_string_field_set(r, peername, peer->username);
1924         ast_string_field_set(r, authname, peer->username);
1925         ast_string_field_set(r, username, peer->username);
1926         ast_string_field_set(r, peersecret, peer->secret);
1927         ast_string_field_set(r, peermd5secret, peer->md5secret);
1928         ast_string_field_set(r, tohost, peer->tohost);
1929         ast_string_field_set(r, fullcontact, peer->fullcontact);
1930         if (!r->initreq.headers && !ast_strlen_zero(peer->fromdomain)) {
1931                 char *tmpcall;
1932                 char *c;
1933                 tmpcall = ast_strdupa(r->callid);
1934                 if (tmpcall) {
1935                         c = strchr(tmpcall, '@');
1936                         if (c) {
1937                                 *c = '\0';
1938                                 ast_string_field_build(r, callid, "%s@%s", tmpcall, peer->fromdomain);
1939                         }
1940                 }
1941         }
1942         if (ast_strlen_zero(r->tohost)) {
1943                 char iabuf[INET_ADDRSTRLEN];
1944
1945                 ast_inet_ntoa(iabuf, sizeof(iabuf),  peer->addr.sin_addr.s_addr ? peer->addr.sin_addr : peer->defaddr.sin_addr);
1946
1947                 ast_string_field_set(r, tohost, iabuf);
1948         }
1949         if (!ast_strlen_zero(peer->fromdomain))
1950                 ast_string_field_set(r, fromdomain, peer->fromdomain);
1951         if (!ast_strlen_zero(peer->fromuser))
1952                 ast_string_field_set(r, fromuser, peer->fromuser);
1953         r->maxtime = peer->maxms;
1954         r->callgroup = peer->callgroup;
1955         r->pickupgroup = peer->pickupgroup;
1956         /* Set timer T1 to RTT for this peer (if known by qualify=) */
1957         /* Minimum is settable or default to 100 ms */
1958         if (peer->maxms && peer->lastms)
1959                 r->timer_t1 = peer->lastms < global_t1min ? global_t1min : peer->lastms;
1960         if ((ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_RFC2833) ||
1961             (ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_AUTO))
1962                 r->noncodeccapability |= AST_RTP_DTMF;
1963         else
1964                 r->noncodeccapability &= ~AST_RTP_DTMF;
1965         ast_string_field_set(r, context, peer->context);
1966         r->rtptimeout = peer->rtptimeout;
1967         r->rtpholdtimeout = peer->rtpholdtimeout;
1968         r->rtpkeepalive = peer->rtpkeepalive;
1969         if (peer->call_limit)
1970                 ast_set_flag(&r->flags[0], SIP_CALL_LIMIT);
1971         r->maxcallbitrate = peer->maxcallbitrate;
1972
1973         return 0;
1974 }
1975
1976 /*! \brief create address structure from peer name
1977  *      Or, if peer not found, find it in the global DNS
1978  *      returns TRUE (-1) on failure, FALSE on success */
1979 static int create_addr(struct sip_pvt *dialog, const char *opeer)
1980 {
1981         struct hostent *hp;
1982         struct ast_hostent ahp;
1983         struct sip_peer *p;
1984         int found=0;
1985         char *port;
1986         int portno;
1987         char host[MAXHOSTNAMELEN], *hostn;
1988         char peer[256];
1989
1990         ast_copy_string(peer, opeer, sizeof(peer));
1991         port = strchr(peer, ':');
1992         if (port) {
1993                 *port = '\0';
1994                 port++;
1995         }
1996         dialog->sa.sin_family = AF_INET;
1997         dialog->timer_t1 = 500; /* Default SIP retransmission timer T1 (RFC 3261) */
1998         p = find_peer(peer, NULL, 1);
1999
2000         if (p) {
2001                 found++;
2002                 if (create_addr_from_peer(dialog, p))
2003                         ASTOBJ_UNREF(p, sip_destroy_peer);
2004         }
2005         if (!p) {
2006                 if (found)
2007                         return -1;
2008
2009                 hostn = peer;
2010                 if (port)
2011                         portno = atoi(port);
2012                 else
2013                         portno = DEFAULT_SIP_PORT;
2014                 if (srvlookup) {
2015                         char service[MAXHOSTNAMELEN];
2016                         int tportno;
2017                         int ret;
2018                         snprintf(service, sizeof(service), "_sip._udp.%s", peer);
2019                         ret = ast_get_srv(NULL, host, sizeof(host), &tportno, service);
2020                         if (ret > 0) {
2021                                 hostn = host;
2022                                 portno = tportno;
2023                         }
2024                 }
2025                 hp = ast_gethostbyname(hostn, &ahp);
2026                 if (hp) {
2027                         ast_string_field_set(dialog, tohost, peer);
2028                         memcpy(&dialog->sa.sin_addr, hp->h_addr, sizeof(dialog->sa.sin_addr));
2029                         dialog->sa.sin_port = htons(portno);
2030                         dialog->recv = dialog->sa;
2031                         return 0;
2032                 } else {
2033                         ast_log(LOG_WARNING, "No such host: %s\n", peer);
2034                         return -1;
2035                 }
2036         } else {
2037                 ASTOBJ_UNREF(p, sip_destroy_peer);
2038                 return 0;
2039         }
2040 }
2041
2042 /*! \brief Scheduled congestion on a call */
2043 static int auto_congest(void *nothing)
2044 {
2045         struct sip_pvt *p = nothing;
2046
2047         ast_mutex_lock(&p->lock);
2048         p->initid = -1;
2049         if (p->owner) {
2050                 if (!ast_mutex_trylock(&p->owner->lock)) {
2051                         ast_log(LOG_NOTICE, "Auto-congesting %s\n", p->owner->name);
2052                         ast_queue_control(p->owner, AST_CONTROL_CONGESTION);
2053                         ast_mutex_unlock(&p->owner->lock);
2054                 }
2055         }
2056         ast_mutex_unlock(&p->lock);
2057         return 0;
2058 }
2059
2060
2061
2062
2063 /*! \brief Initiate SIP call from PBX
2064  *      used from the dial() application      */
2065 static int sip_call(struct ast_channel *ast, char *dest, int timeout)
2066 {
2067         int res;
2068         struct sip_pvt *p;
2069 #ifdef OSP_SUPPORT
2070         const char *osphandle = NULL;
2071 #endif
2072         struct varshead *headp;
2073         struct ast_var_t *current;
2074
2075         p = ast->tech_pvt;
2076         if ((ast->_state != AST_STATE_DOWN) && (ast->_state != AST_STATE_RESERVED)) {
2077                 ast_log(LOG_WARNING, "sip_call called on %s, neither down nor reserved\n", ast->name);
2078                 return -1;
2079         }
2080
2081         /* Check whether there is vxml_url, distinctive ring variables */
2082         headp=&ast->varshead;
2083         AST_LIST_TRAVERSE(headp,current,entries) {
2084                 /* Check whether there is a VXML_URL variable */
2085                 if (!p->options->vxml_url && !strcasecmp(ast_var_name(current), "VXML_URL")) {
2086                         p->options->vxml_url = ast_var_value(current);
2087                 } else if (!p->options->uri_options && !strcasecmp(ast_var_name(current), "SIP_URI_OPTIONS")) {
2088                         p->options->uri_options = ast_var_value(current);
2089                 } else if (!p->options->distinctive_ring && !strcasecmp(ast_var_name(current), "ALERT_INFO")) {
2090                         /* Check whether there is a ALERT_INFO variable */
2091                         p->options->distinctive_ring = ast_var_value(current);
2092                 } else if (!p->options->addsipheaders && !strncasecmp(ast_var_name(current), "SIPADDHEADER", strlen("SIPADDHEADER"))) {
2093                         /* Check whether there is a variable with a name starting with SIPADDHEADER */
2094                         p->options->addsipheaders = 1;
2095                 }
2096
2097
2098 #ifdef OSP_SUPPORT
2099                 else if (!p->options->osptoken && !strcasecmp(ast_var_name(current), "OSPTOKEN")) {
2100                         p->options->osptoken = ast_var_value(current);
2101                 } else if (!osphandle && !strcasecmp(ast_var_name(current), "OSPHANDLE")) {
2102                         osphandle = ast_var_value(current);
2103                 }
2104 #endif
2105         }
2106
2107         res = 0;
2108         ast_set_flag(&p->flags[0], SIP_OUTGOING);
2109 #ifdef OSP_SUPPORT
2110         if (!p->options->osptoken || !osphandle || (sscanf(osphandle, "%d", &p->osphandle) != 1)) {
2111                 /* Force Disable OSP support */
2112                 if (option_debug)
2113                         ast_log(LOG_DEBUG, "Disabling OSP support for this call. osptoken = %s, osphandle = %s\n", p->options->osptoken, osphandle);
2114                 p->options->osptoken = NULL;
2115                 osphandle = NULL;
2116                 p->osphandle = -1;
2117         }
2118 #endif
2119         ast_log(LOG_DEBUG, "Outgoing Call for %s\n", p->username);
2120         res = update_call_counter(p, INC_CALL_LIMIT);
2121         if ( res != -1 ) {
2122                 p->callingpres = ast->cid.cid_pres;
2123                 p->jointcapability = p->capability;
2124                 transmit_invite(p, SIP_INVITE, 1, 2);
2125                 if (p->maxtime) {
2126                         /* Initialize auto-congest time */
2127                         p->initid = ast_sched_add(sched, p->maxtime * 4, auto_congest, p);
2128                 }
2129         }
2130         return res;
2131 }
2132
2133 /*! \brief Destroy registry object
2134         Objects created with the register= statement in static configuration */
2135 static void sip_registry_destroy(struct sip_registry *reg)
2136 {
2137         /* Really delete */
2138         if (option_debug > 2)
2139                 ast_log(LOG_DEBUG, "Destroying registry entry for %s@%s\n", reg->username, reg->hostname);
2140
2141         if (reg->call) {
2142                 /* Clear registry before destroying to ensure
2143                    we don't get reentered trying to grab the registry lock */
2144                 reg->call->registry = NULL;
2145                 if (option_debug > 2)
2146                         ast_log(LOG_DEBUG, "Destroying active SIP dialog for registry %s@%s\n", reg->username, reg->hostname);
2147                 sip_destroy(reg->call);
2148         }
2149         if (reg->expire > -1)
2150                 ast_sched_del(sched, reg->expire);
2151         if (reg->timeout > -1)
2152                 ast_sched_del(sched, reg->timeout);
2153         ast_string_field_free_all(reg);
2154         regobjs--;
2155         free(reg);
2156
2157 }
2158
2159 /*! \brief Execute destrucion of SIP dialog structure, release memory */
2160 static void __sip_destroy(struct sip_pvt *p, int lockowner)
2161 {
2162         struct sip_pvt *cur, *prev = NULL;
2163         struct sip_pkt *cp;
2164
2165         if (sip_debug_test_pvt(p) || option_debug > 2)
2166                 ast_verbose("Really destroying SIP dialog '%s' Method: %s\n", p->callid, sip_methods[p->method].text);
2167
2168         /* Remove link from peer to subscription of MWI */
2169         if (p->relatedpeer && p->relatedpeer->mwipvt)
2170                 p->relatedpeer->mwipvt = (struct sip_pvt *) NULL;
2171
2172         if (dumphistory)
2173                 sip_dump_history(p);
2174
2175         if (p->options)
2176                 free(p->options);
2177
2178         if (p->stateid > -1)
2179                 ast_extension_state_del(p->stateid, NULL);
2180         if (p->initid > -1)
2181                 ast_sched_del(sched, p->initid);
2182         if (p->autokillid > -1)
2183                 ast_sched_del(sched, p->autokillid);
2184
2185         if (p->rtp)
2186                 ast_rtp_destroy(p->rtp);
2187         if (p->vrtp)
2188                 ast_rtp_destroy(p->vrtp);
2189         if (p->route) {
2190                 free_old_route(p->route);
2191                 p->route = NULL;
2192         }
2193         if (p->registry) {
2194                 if (p->registry->call == p)
2195                         p->registry->call = NULL;
2196                 ASTOBJ_UNREF(p->registry, sip_registry_destroy);
2197         }
2198
2199         /* Unlink us from the owner if we have one */
2200         if (p->owner) {
2201                 if (lockowner)
2202                         ast_mutex_lock(&p->owner->lock);
2203                 if (option_debug)
2204                         ast_log(LOG_DEBUG, "Detaching from %s\n", p->owner->name);
2205                 p->owner->tech_pvt = NULL;
2206                 if (lockowner)
2207                         ast_mutex_unlock(&p->owner->lock);
2208         }
2209         /* Clear history */
2210         if (p->history) {
2211                 struct sip_history *hist;
2212                 while( (hist = AST_LIST_REMOVE_HEAD(p->history, list)) )
2213                         free(hist);
2214                 free(p->history);
2215                 p->history = NULL;
2216         }
2217
2218         for (prev = NULL, cur = iflist; cur; prev = cur, cur = cur->next) {
2219                 if (cur == p) {
2220                         if (prev)
2221                                 prev->next = cur->next;
2222                         else
2223                                 iflist = cur->next;
2224                         break;
2225                 }
2226         }
2227         if (!cur) {
2228                 ast_log(LOG_WARNING, "Trying to destroy \"%s\", not found in dialog list?!?! \n", p->callid);
2229                 return;
2230         }
2231         if (p->initid > -1)
2232                 ast_sched_del(sched, p->initid);
2233
2234         /* remove all current packets in this dialog */
2235         while((cp = p->packets)) {
2236                 p->packets = p->packets->next;
2237                 if (cp->retransid > -1) {
2238                         ast_sched_del(sched, cp->retransid);
2239                 }
2240                 free(cp);
2241         }
2242         if (p->chanvars) {
2243                 ast_variables_destroy(p->chanvars);
2244                 p->chanvars = NULL;
2245         }
2246         ast_mutex_destroy(&p->lock);
2247
2248         ast_string_field_free_all(p);
2249
2250         free(p);
2251 }
2252
2253 /*! \brief  update_call_counter: Handle call_limit for SIP users
2254  * Setting a call-limit will cause calls above the limit not to be accepted.
2255  *
2256  * Remember that for a type=friend, there's one limit for the user and
2257  * another for the peer, not a combined call limit.
2258  * This will cause unexpected behaviour in subscriptions, since a "friend"
2259  * is *two* devices in Asterisk, not one.
2260  *
2261  * Thought: For realtime, we should propably update storage with inuse counter...
2262  *
2263  * \return 0 if call is ok (no call limit, below treshold)
2264  *      -1 on rejection of call
2265  *
2266  */
2267 static int update_call_counter(struct sip_pvt *fup, int event)
2268 {
2269         char name[256];
2270         int *inuse, *call_limit;
2271         int outgoing = ast_test_flag(&fup->flags[0], SIP_OUTGOING);
2272         struct sip_user *u = NULL;
2273         struct sip_peer *p = NULL;
2274
2275         if (option_debug > 2)
2276                 ast_log(LOG_DEBUG, "Updating call counter for %s call\n", outgoing ? "outgoing" : "incoming");
2277         /* Test if we need to check call limits, in order to avoid
2278            realtime lookups if we do not need it */
2279         if (!ast_test_flag(&fup->flags[0], SIP_CALL_LIMIT))
2280                 return 0;
2281
2282         ast_copy_string(name, fup->username, sizeof(name));
2283
2284         /* Check the list of users */
2285         if (!outgoing)  /* Only check users for incoming calls */
2286                 u = find_user(name, 1);
2287
2288         if (u) {
2289                 inuse = &u->inUse;
2290                 call_limit = &u->call_limit;
2291                 p = NULL;
2292         } else {
2293                 /* Try to find peer */
2294                 if (!p)
2295                         p = find_peer(fup->peername, NULL, 1);
2296                 if (p) {
2297                         inuse = &p->inUse;
2298                         call_limit = &p->call_limit;
2299                         ast_copy_string(name, fup->peername, sizeof(name));
2300                 } else {
2301                         if (option_debug > 1)
2302                                 ast_log(LOG_DEBUG, "%s is not a local user, no call limit\n", name);
2303                         return 0;
2304                 }
2305         }
2306         switch(event) {
2307                 /* incoming and outgoing affects the inUse counter */
2308                 case DEC_CALL_LIMIT:
2309                         if ( *inuse > 0 ) {
2310                                 if (ast_test_flag(&fup->flags[0], SIP_INC_COUNT))
2311                                         (*inuse)--;
2312                         } else {
2313                                 *inuse = 0;
2314                         }
2315                         if (option_debug > 1 || sipdebug) {
2316                                 ast_log(LOG_DEBUG, "Call %s %s '%s' removed from call limit %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
2317                         }
2318                         break;
2319                 case INC_CALL_LIMIT:
2320                         if (*call_limit > 0 ) {
2321                                 if (*inuse >= *call_limit) {
2322                                         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);
2323                                         if (u)
2324                                                 ASTOBJ_UNREF(u, sip_destroy_user);
2325                                         else
2326                                                 ASTOBJ_UNREF(p, sip_destroy_peer);
2327                                         return -1;
2328                                 }
2329                         }
2330                         (*inuse)++;
2331                         ast_set_flag(&fup->flags[0], SIP_INC_COUNT);
2332                         if (option_debug > 1 || sipdebug) {
2333                                 ast_log(LOG_DEBUG, "Call %s %s '%s' is %d out of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *inuse, *call_limit);
2334                         }
2335                         break;
2336                 default:
2337                         ast_log(LOG_ERROR, "update_call_counter(%s, %d) called with no event!\n", name, event);
2338         }
2339         if (u)
2340                 ASTOBJ_UNREF(u, sip_destroy_user);
2341         else
2342                 ASTOBJ_UNREF(p, sip_destroy_peer);
2343         return 0;
2344 }
2345
2346 /*! \brief Destroy SIP call structure */
2347 static void sip_destroy(struct sip_pvt *p)
2348 {
2349         ast_mutex_lock(&iflock);
2350         if (option_debug > 2)
2351                 ast_log(LOG_DEBUG, "Destroying SIP dialog %s\n", p->callid);
2352         __sip_destroy(p, 1);
2353         ast_mutex_unlock(&iflock);
2354 }
2355
2356 /*! \brief Convert SIP hangup causes to Asterisk hangup causes */
2357 static int hangup_sip2cause(int cause)
2358 {
2359         /* Possible values taken from causes.h */
2360
2361         switch(cause) {
2362                 case 401:       /* Unauthorized */
2363                         return AST_CAUSE_CALL_REJECTED;
2364                 case 403:       /* Not found */
2365                         return AST_CAUSE_CALL_REJECTED;
2366                 case 404:       /* Not found */
2367                         return AST_CAUSE_UNALLOCATED;
2368                 case 405:       /* Method not allowed */
2369                         return AST_CAUSE_INTERWORKING;
2370                 case 407:       /* Proxy authentication required */
2371                         return AST_CAUSE_CALL_REJECTED;
2372                 case 408:       /* No reaction */
2373                         return AST_CAUSE_NO_USER_RESPONSE;
2374                 case 409:       /* Conflict */
2375                         return AST_CAUSE_NORMAL_TEMPORARY_FAILURE;
2376                 case 410:       /* Gone */
2377                         return AST_CAUSE_UNALLOCATED;
2378                 case 411:       /* Length required */
2379                         return AST_CAUSE_INTERWORKING;
2380                 case 413:       /* Request entity too large */
2381                         return AST_CAUSE_INTERWORKING;
2382                 case 414:       /* Request URI too large */
2383                         return AST_CAUSE_INTERWORKING;
2384                 case 415:       /* Unsupported media type */
2385                         return AST_CAUSE_INTERWORKING;
2386                 case 420:       /* Bad extension */
2387                         return AST_CAUSE_NO_ROUTE_DESTINATION;
2388                 case 480:       /* No answer */
2389                         return AST_CAUSE_FAILURE;
2390                 case 481:       /* No answer */
2391                         return AST_CAUSE_INTERWORKING;
2392                 case 482:       /* Loop detected */
2393                         return AST_CAUSE_INTERWORKING;
2394                 case 483:       /* Too many hops */
2395                         return AST_CAUSE_NO_ANSWER;
2396                 case 484:       /* Address incomplete */
2397                         return AST_CAUSE_INVALID_NUMBER_FORMAT;
2398                 case 485:       /* Ambigous */
2399                         return AST_CAUSE_UNALLOCATED;
2400                 case 486:       /* Busy everywhere */
2401                         return AST_CAUSE_BUSY;
2402                 case 487:       /* Request terminated */
2403                         return AST_CAUSE_INTERWORKING;
2404                 case 488:       /* No codecs approved */
2405                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
2406                 case 491:       /* Request pending */
2407                         return AST_CAUSE_INTERWORKING;
2408                 case 493:       /* Undecipherable */
2409                         return AST_CAUSE_INTERWORKING;
2410                 case 500:       /* Server internal failure */
2411                         return AST_CAUSE_FAILURE;
2412                 case 501:       /* Call rejected */
2413                         return AST_CAUSE_FACILITY_REJECTED;
2414                 case 502:
2415                         return AST_CAUSE_DESTINATION_OUT_OF_ORDER;
2416                 case 503:       /* Service unavailable */
2417                         return AST_CAUSE_CONGESTION;
2418                 case 504:       /* Gateway timeout */
2419                         return AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE;
2420                 case 505:       /* SIP version not supported */
2421                         return AST_CAUSE_INTERWORKING;
2422                 case 600:       /* Busy everywhere */
2423                         return AST_CAUSE_USER_BUSY;
2424                 case 603:       /* Decline */
2425                         return AST_CAUSE_CALL_REJECTED;
2426                 case 604:       /* Does not exist anywhere */
2427                         return AST_CAUSE_UNALLOCATED;
2428                 case 606:       /* Not acceptable */
2429                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
2430                 default:
2431                         return AST_CAUSE_NORMAL;
2432         }
2433         /* Never reached */
2434         return 0;
2435 }
2436
2437 /*! \brief Convert Asterisk hangup causes to SIP codes
2438 \verbatim
2439  Possible values from causes.h
2440         AST_CAUSE_NOTDEFINED    AST_CAUSE_NORMAL        AST_CAUSE_BUSY
2441         AST_CAUSE_FAILURE       AST_CAUSE_CONGESTION    AST_CAUSE_UNALLOCATED
2442
2443         In addition to these, a lot of PRI codes is defined in causes.h
2444         ...should we take care of them too ?
2445
2446         Quote RFC 3398
2447
2448    ISUP Cause value                        SIP response
2449    ----------------                        ------------
2450    1  unallocated number                   404 Not Found
2451    2  no route to network                  404 Not found
2452    3  no route to destination              404 Not found
2453    16 normal call clearing                 --- (*)
2454    17 user busy                            486 Busy here
2455    18 no user responding                   408 Request Timeout
2456    19 no answer from the user              480 Temporarily unavailable
2457    20 subscriber absent                    480 Temporarily unavailable
2458    21 call rejected                        403 Forbidden (+)
2459    22 number changed (w/o diagnostic)      410 Gone
2460    22 number changed (w/ diagnostic)       301 Moved Permanently
2461    23 redirection to new destination       410 Gone
2462    26 non-selected user clearing           404 Not Found (=)
2463    27 destination out of order             502 Bad Gateway
2464    28 address incomplete                   484 Address incomplete
2465    29 facility rejected                    501 Not implemented
2466    31 normal unspecified                   480 Temporarily unavailable
2467 \endverbatim
2468 */
2469 static char *hangup_cause2sip(int cause)
2470 {
2471         switch(cause)
2472         {
2473                 case AST_CAUSE_UNALLOCATED:             /* 1 */
2474                 case AST_CAUSE_NO_ROUTE_DESTINATION:    /* 3 IAX2: Can't find extension in context */
2475                 case AST_CAUSE_NO_ROUTE_TRANSIT_NET:    /* 2 */
2476                         return "404 Not Found";
2477                 case AST_CAUSE_CONGESTION:              /* 34 */
2478                 case AST_CAUSE_SWITCH_CONGESTION:       /* 42 */
2479                         return "503 Service Unavailable";
2480                 case AST_CAUSE_NO_USER_RESPONSE:        /* 18 */
2481                         return "408 Request Timeout";
2482                 case AST_CAUSE_NO_ANSWER:               /* 19 */
2483                         return "480 Temporarily unavailable";
2484                 case AST_CAUSE_CALL_REJECTED:           /* 21 */
2485                         return "403 Forbidden";
2486                 case AST_CAUSE_NUMBER_CHANGED:          /* 22 */
2487                         return "410 Gone";
2488                 case AST_CAUSE_NORMAL_UNSPECIFIED:      /* 31 */
2489                         return "480 Temporarily unavailable";
2490                 case AST_CAUSE_INVALID_NUMBER_FORMAT:
2491                         return "484 Address incomplete";
2492                 case AST_CAUSE_USER_BUSY:
2493                         return "486 Busy here";
2494                 case AST_CAUSE_FAILURE:
2495                         return "500 Server internal failure";
2496                 case AST_CAUSE_FACILITY_REJECTED:       /* 29 */
2497                         return "501 Not Implemented";
2498                 case AST_CAUSE_CHAN_NOT_IMPLEMENTED:
2499                         return "503 Service Unavailable";
2500                 /* Used in chan_iax2 */
2501                 case AST_CAUSE_DESTINATION_OUT_OF_ORDER:
2502                         return "502 Bad Gateway";
2503                 case AST_CAUSE_BEARERCAPABILITY_NOTAVAIL:       /* Can't find codec to connect to host */
2504                         return "488 Not Acceptable Here";
2505
2506                 case AST_CAUSE_NOTDEFINED:
2507                 default:
2508                         ast_log(LOG_DEBUG, "AST hangup cause %d (no match found in SIP)\n", cause);
2509                         return NULL;
2510         }
2511
2512         /* Never reached */
2513         return 0;
2514 }
2515
2516
2517 /*! \brief  sip_hangup: Hangup SIP call
2518  * Part of PBX interface, called from ast_hangup */
2519 static int sip_hangup(struct ast_channel *ast)
2520 {
2521         struct sip_pvt *p = ast->tech_pvt;
2522         int needcancel = FALSE;
2523         struct ast_flags locflags = {0};
2524
2525         if (!p) {
2526                 ast_log(LOG_DEBUG, "Asked to hangup channel that was not connected\n");
2527                 return 0;
2528         }
2529         if (option_debug && sipdebug)
2530                 ast_log(LOG_DEBUG, "Hangup call %s, SIP callid %s)\n", ast->name, p->callid);
2531
2532         ast_mutex_lock(&p->lock);
2533 #ifdef OSP_SUPPORT
2534         if ((p->osphandle > -1) && (ast->_state == AST_STATE_UP)) {
2535                 ast_osp_terminate(p->osphandle, AST_CAUSE_NORMAL, p->ospstart, time(NULL) - p->ospstart);
2536         }
2537 #endif
2538         if (option_debug && sipdebug)
2539                 ast_log(LOG_DEBUG, "update_call_counter(%s) - decrement call limit counter on hangup\n", p->username);
2540         update_call_counter(p, DEC_CALL_LIMIT);
2541         /* Determine how to disconnect */
2542         if (p->owner != ast) {
2543                 ast_log(LOG_WARNING, "Huh?  We aren't the owner? Can't hangup call.\n");
2544                 ast_mutex_unlock(&p->lock);
2545                 return 0;
2546         }
2547         /* If the call is not UP, we need to send CANCEL instead of BYE */
2548         if (ast->_state != AST_STATE_UP)
2549                 needcancel = TRUE;
2550
2551         /* Disconnect */
2552         p = ast->tech_pvt;
2553         if (p->vad)
2554                 ast_dsp_free(p->vad);
2555
2556         p->owner = NULL;
2557         ast->tech_pvt = NULL;
2558
2559         ast_mutex_lock(&usecnt_lock);
2560         usecnt--;
2561         ast_mutex_unlock(&usecnt_lock);
2562         ast_update_use_count();
2563
2564         ast_set_flag(&locflags, SIP_NEEDDESTROY);
2565
2566         /* Start the process if it's not already started */
2567         if (!ast_test_flag(&p->flags[0], SIP_ALREADYGONE) && !ast_strlen_zero(p->initreq.data)) {
2568                 if (needcancel) {       /* Outgoing call, not up */
2569                         if (ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2570                                 /* stop retransmitting an INVITE that has not received a response */
2571                                 __sip_pretend_ack(p);
2572
2573                                 /* Send a new request: CANCEL */
2574                                 transmit_request_with_auth(p, SIP_CANCEL, p->ocseq, XMIT_RELIABLE, 0);
2575                                 /* Actually don't destroy us yet, wait for the 487 on our original
2576                                    INVITE, but do set an autodestruct just in case we never get it. */
2577                                 ast_clear_flag(&locflags, SIP_NEEDDESTROY);
2578
2579                                 sip_scheddestroy(p, 32000);
2580                                 if ( p->initid != -1 ) {
2581                                         /* channel still up - reverse dec of inUse counter
2582                                            only if the channel is not auto-congested */
2583                                         update_call_counter(p, INC_CALL_LIMIT);
2584                                 }
2585                         } else {        /* Incoming call, not up */
2586                                 char *res;
2587                                 if (ast->hangupcause && ((res = hangup_cause2sip(ast->hangupcause)))) {
2588                                         transmit_response_reliable(p, res, &p->initreq);
2589                                 } else
2590                                         transmit_response_reliable(p, "603 Declined", &p->initreq);
2591                         }
2592                 } else {        /* Call is in UP state, send BYE */
2593                         if (!p->pendinginvite) {
2594                                 /* Send a hangup */
2595                                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2596                         } else {
2597                                 /* Note we will need a BYE when this all settles out
2598                                    but we can't send one while we have "INVITE" outstanding. */
2599                                 ast_set_flag(&p->flags[0], SIP_PENDINGBYE);
2600                                 ast_clear_flag(&p->flags[0], SIP_NEEDREINVITE);
2601                         }
2602                 }
2603         }
2604         ast_copy_flags(&p->flags[0], &locflags, SIP_NEEDDESTROY);
2605         ast_mutex_unlock(&p->lock);
2606         return 0;
2607 }
2608
2609 /*! \brief Try setting codec suggested by the SIP_CODEC channel variable */
2610 static void try_suggested_sip_codec(struct sip_pvt *p)
2611 {
2612         int fmt;
2613         const char *codec;
2614
2615         codec = pbx_builtin_getvar_helper(p->owner, "SIP_CODEC");
2616         if (!codec)
2617                 return;
2618
2619         fmt = ast_getformatbyname(codec);
2620         if (fmt) {
2621                 ast_log(LOG_NOTICE, "Changing codec to '%s' for this call because of ${SIP_CODEC) variable\n", codec);
2622                 if (p->jointcapability & fmt) {
2623                         p->jointcapability &= fmt;
2624                         p->capability &= fmt;
2625                 } else
2626                         ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because it is not shared by both ends.\n");
2627         } else
2628                 ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because of unrecognized/not configured codec (check allow/disallow in sip.conf): %s\n", codec);
2629         return;
2630 }
2631
2632 /*! \brief  sip_answer: Answer SIP call , send 200 OK on Invite
2633  * Part of PBX interface */
2634 static int sip_answer(struct ast_channel *ast)
2635 {
2636         int res = 0;
2637         struct sip_pvt *p = ast->tech_pvt;
2638
2639         ast_mutex_lock(&p->lock);
2640         if (ast->_state != AST_STATE_UP) {
2641 #ifdef OSP_SUPPORT
2642                 time(&p->ospstart);
2643 #endif
2644                 try_suggested_sip_codec(p);
2645
2646                 ast_setstate(ast, AST_STATE_UP);
2647                 if (option_debug)
2648                         ast_log(LOG_DEBUG, "SIP answering channel: %s\n", ast->name);
2649                 res = transmit_response_with_sdp(p, "200 OK", &p->initreq, XMIT_RELIABLE);
2650         }
2651         ast_mutex_unlock(&p->lock);
2652         return res;
2653 }
2654
2655 /*! \brief Send frame to media channel (rtp) */
2656 static int sip_write(struct ast_channel *ast, struct ast_frame *frame)
2657 {
2658         struct sip_pvt *p = ast->tech_pvt;
2659         int res = 0;
2660
2661         switch (frame->frametype) {
2662         case AST_FRAME_VOICE:
2663                 if (!(frame->subclass & ast->nativeformats)) {
2664                         ast_log(LOG_WARNING, "Asked to transmit frame type %d, while native formats is %d (read/write = %d/%d)\n",
2665                                 frame->subclass, ast->nativeformats, ast->readformat, ast->writeformat);
2666                         return 0;
2667                 }
2668                 if (p) {
2669                         ast_mutex_lock(&p->lock);
2670                         if (p->rtp) {
2671                                 /* If channel is not up, activate early media session */
2672                                 if ((ast->_state != AST_STATE_UP) &&
2673                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2674                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2675                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2676                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
2677                                 }
2678                                 time(&p->lastrtptx);
2679                                 res =  ast_rtp_write(p->rtp, frame);
2680                         }
2681                         ast_mutex_unlock(&p->lock);
2682                 }
2683                 break;
2684         case AST_FRAME_VIDEO:
2685                 if (p) {
2686                         ast_mutex_lock(&p->lock);
2687                         if (p->vrtp) {
2688                                 /* Activate video early media */
2689                                 if ((ast->_state != AST_STATE_UP) &&
2690                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2691                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2692                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2693                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
2694                                 }
2695                                 time(&p->lastrtptx);
2696                                 res =  ast_rtp_write(p->vrtp, frame);
2697                         }
2698                         ast_mutex_unlock(&p->lock);
2699                 }
2700                 break;
2701         case AST_FRAME_IMAGE:
2702                 return 0;
2703                 break;
2704         default:
2705                 ast_log(LOG_WARNING, "Can't send %d type frames with SIP write\n", frame->frametype);
2706                 return 0;
2707         }
2708
2709         return res;
2710 }
2711
2712 /*! \brief  sip_fixup: Fix up a channel:  If a channel is consumed, this is called.
2713         Basically update any ->owner links */
2714 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
2715 {
2716         struct sip_pvt *p = newchan->tech_pvt;
2717         ast_mutex_lock(&p->lock);
2718         if (p->owner != oldchan) {
2719                 ast_log(LOG_WARNING, "old channel wasn't %p but was %p\n", oldchan, p->owner);
2720                 ast_mutex_unlock(&p->lock);
2721                 return -1;
2722         }
2723         p->owner = newchan;
2724         ast_mutex_unlock(&p->lock);
2725         return 0;
2726 }
2727
2728 /*! \brief Send DTMF character on SIP channel
2729         within one call, we're able to transmit in many methods simultaneously */
2730 static int sip_senddigit(struct ast_channel *ast, char digit)
2731 {
2732         struct sip_pvt *p = ast->tech_pvt;
2733         int res = 0;
2734
2735         ast_mutex_lock(&p->lock);
2736         switch (ast_test_flag(&p->flags[0], SIP_DTMF)) {
2737         case SIP_DTMF_INFO:
2738                 transmit_info_with_digit(p, digit);
2739                 break;
2740         case SIP_DTMF_RFC2833:
2741                 if (p->rtp)
2742                         ast_rtp_senddigit(p->rtp, digit);
2743                 break;
2744         case SIP_DTMF_INBAND:
2745                 res = -1;
2746                 break;
2747         }
2748         ast_mutex_unlock(&p->lock);
2749         return res;
2750 }
2751
2752 /*! \brief Transfer SIP call */
2753 static int sip_transfer(struct ast_channel *ast, const char *dest)
2754 {
2755         struct sip_pvt *p = ast->tech_pvt;
2756         int res;
2757
2758         ast_mutex_lock(&p->lock);
2759         if (ast->_state == AST_STATE_RING)
2760                 res = sip_sipredirect(p, dest);
2761         else
2762                 res = transmit_refer(p, dest);
2763         ast_mutex_unlock(&p->lock);
2764         return res;
2765 }
2766
2767 /*! \brief Play indication to user
2768  * With SIP a lot of indications is sent as messages, letting the device play
2769    the indication - busy signal, congestion etc
2770    \return -1 to force ast_indicate to send indication in audio, 0 if SIP can handle the indication by sending a message
2771 */
2772 static int sip_indicate(struct ast_channel *ast, int condition)
2773 {
2774         struct sip_pvt *p = ast->tech_pvt;
2775         int res = 0;
2776
2777         ast_mutex_lock(&p->lock);
2778         switch(condition) {
2779         case AST_CONTROL_RINGING:
2780                 if (ast->_state == AST_STATE_RING) {
2781                         if (!ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) ||
2782                             (ast_test_flag(&p->flags[0], SIP_PROG_INBAND) == SIP_PROG_INBAND_NEVER)) {
2783                                 /* Send 180 ringing if out-of-band seems reasonable */
2784                                 transmit_response(p, "180 Ringing", &p->initreq);
2785                                 ast_set_flag(&p->flags[0], SIP_RINGING);
2786                                 if (ast_test_flag(&p->flags[0], SIP_PROG_INBAND) != SIP_PROG_INBAND_YES)
2787                                         break;
2788                         } else {
2789                                 /* Well, if it's not reasonable, just send in-band */
2790                         }
2791                 }
2792                 res = -1;
2793                 break;
2794         case AST_CONTROL_BUSY:
2795                 if (ast->_state != AST_STATE_UP) {
2796                         transmit_response(p, "486 Busy Here", &p->initreq);
2797                         ast_set_flag(&p->flags[0], SIP_ALREADYGONE);
2798                         ast_softhangup_nolock(ast, AST_SOFTHANGUP_DEV);
2799                         break;
2800                 }
2801                 res = -1;
2802                 break;
2803         case AST_CONTROL_CONGESTION:
2804                 if (ast->_state != AST_STATE_UP) {
2805                         transmit_response(p, "503 Service Unavailable", &p->initreq);
2806                         ast_set_flag(&p->flags[0], SIP_ALREADYGONE);
2807                         ast_softhangup_nolock(ast, AST_SOFTHANGUP_DEV);
2808                         break;
2809                 }
2810                 res = -1;
2811                 break;
2812         case AST_CONTROL_PROCEEDING:
2813                 if ((ast->_state != AST_STATE_UP) &&
2814                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2815                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2816                         transmit_response(p, "100 Trying", &p->initreq);
2817                         break;
2818                 }
2819                 res = -1;
2820                 break;
2821         case AST_CONTROL_PROGRESS:
2822                 if ((ast->_state != AST_STATE_UP) &&
2823                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2824                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2825                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2826                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
2827                         break;
2828                 }
2829                 res = -1;
2830                 break;
2831         case AST_CONTROL_HOLD:  /* The other part of the bridge are put on hold */
2832                 if (sipdebug)
2833                         ast_log(LOG_DEBUG, "Bridged channel now on hold - %s\n", p->callid);
2834                 res = -1;
2835                 break;
2836         case AST_CONTROL_UNHOLD:        /* The other part of the bridge are back from hold */
2837                 if (sipdebug)
2838                         ast_log(LOG_DEBUG, "Bridged channel is back from hold, let's talk! : %s\n", p->callid);
2839                 res = -1;
2840                 break;
2841         case AST_CONTROL_VIDUPDATE:     /* Request a video frame update */
2842                 if (p->vrtp && !ast_test_flag(&p->flags[0], SIP_NOVIDEO)) {
2843                         transmit_info_with_vidupdate(p);
2844                         /* ast_rtcp_send_h261fur(p->vrtp); */
2845                         res = 0;
2846                 } else
2847                         res = -1;
2848                 break;
2849         case -1:
2850                 res = -1;
2851                 break;
2852         default:
2853                 ast_log(LOG_WARNING, "Don't know how to indicate condition %d\n", condition);
2854                 res = -1;
2855                 break;
2856         }
2857         ast_mutex_unlock(&p->lock);
2858         return res;
2859 }
2860
2861
2862
2863 /*! \brief Initiate a call in the SIP channel
2864         called from sip_request_call (calls from the pbx ) */
2865 static struct ast_channel *sip_new(struct sip_pvt *i, int state, const char *title)
2866 {
2867         struct ast_channel *tmp;
2868         struct ast_variable *v = NULL;
2869         int fmt;
2870         int what;
2871 #ifdef OSP_SUPPORT
2872         char iabuf[INET_ADDRSTRLEN];
2873         char peer[MAXHOSTNAMELEN];
2874 #endif
2875
2876         ast_mutex_unlock(&i->lock);
2877         /* Don't hold a sip pvt lock while we allocate a channel */
2878         tmp = ast_channel_alloc(1);
2879         ast_mutex_lock(&i->lock);
2880         if (!tmp) {
2881                 ast_log(LOG_WARNING, "Unable to allocate SIP channel structure\n");
2882                 return NULL;
2883         }
2884         tmp->tech = &sip_tech;
2885         /* Select our native format based on codec preference until we receive
2886            something from another device to the contrary. */
2887         if (i->jointcapability)
2888                 what = i->jointcapability;
2889         else if (i->capability)
2890                 what = i->capability;
2891         else
2892                 what = global_capability;
2893         tmp->nativeformats = ast_codec_choose(&i->prefs, what, 1) | (i->jointcapability & AST_FORMAT_VIDEO_MASK);
2894         fmt = ast_best_codec(tmp->nativeformats);
2895
2896         if (title)
2897                 ast_string_field_build(tmp, name, "SIP/%s-%04lx", title, ast_random() & 0xffff);
2898         else if (strchr(i->fromdomain,':'))
2899                 ast_string_field_build(tmp, name, "SIP/%s-%08x", strchr(i->fromdomain,':')+1, (int)(long)(i));
2900         else
2901                 ast_string_field_build(tmp, name, "SIP/%s-%08x", i->fromdomain, (int)(long)(i));
2902
2903         if (ast_test_flag(&i->flags[0], SIP_DTMF) ==  SIP_DTMF_INBAND) {
2904                 i->vad = ast_dsp_new();
2905                 ast_dsp_set_features(i->vad, DSP_FEATURE_DTMF_DETECT);
2906                 if (global_relaxdtmf)
2907                         ast_dsp_digitmode(i->vad, DSP_DIGITMODE_DTMF | DSP_DIGITMODE_RELAXDTMF);
2908         }
2909         if (i->rtp) {
2910                 tmp->fds[0] = ast_rtp_fd(i->rtp);
2911                 tmp->fds[1] = ast_rtcp_fd(i->rtp);
2912         }
2913         if (i->vrtp) {
2914                 tmp->fds[2] = ast_rtp_fd(i->vrtp);
2915                 tmp->fds[3] = ast_rtcp_fd(i->vrtp);
2916         }
2917         if (state == AST_STATE_RING)
2918                 tmp->rings = 1;
2919         tmp->adsicpe = AST_ADSI_UNAVAILABLE;
2920         tmp->writeformat = fmt;
2921         tmp->rawwriteformat = fmt;
2922         tmp->readformat = fmt;
2923         tmp->rawreadformat = fmt;
2924         tmp->tech_pvt = i;
2925
2926         tmp->callgroup = i->callgroup;
2927         tmp->pickupgroup = i->pickupgroup;
2928         tmp->cid.cid_pres = i->callingpres;
2929         if (!ast_strlen_zero(i->accountcode))
2930                 ast_string_field_set(tmp, accountcode, i->accountcode);
2931         if (i->amaflags)
2932                 tmp->amaflags = i->amaflags;
2933         if (!ast_strlen_zero(i->language))
2934                 ast_string_field_set(tmp, language, i->language);
2935         if (!ast_strlen_zero(i->musicclass))
2936                 ast_string_field_set(tmp, musicclass, i->musicclass);
2937         i->owner = tmp;
2938         ast_mutex_lock(&usecnt_lock);
2939         usecnt++;
2940         ast_mutex_unlock(&usecnt_lock);
2941         ast_copy_string(tmp->context, i->context, sizeof(tmp->context));
2942         ast_copy_string(tmp->exten, i->exten, sizeof(tmp->exten));
2943         if (!ast_strlen_zero(i->cid_num))
2944                 tmp->cid.cid_num = ast_strdup(i->cid_num);
2945         if (!ast_strlen_zero(i->cid_name))
2946                 tmp->cid.cid_name = ast_strdup(i->cid_name);
2947         if (!ast_strlen_zero(i->rdnis))
2948                 tmp->cid.cid_rdnis = ast_strdup(i->rdnis);
2949         if (!ast_strlen_zero(i->exten) && strcmp(i->exten, "s"))
2950                 tmp->cid.cid_dnid = ast_strdup(i->exten);
2951         tmp->priority = 1;
2952         if (!ast_strlen_zero(i->uri)) {
2953                 pbx_builtin_setvar_helper(tmp, "SIPURI", i->uri);
2954         }
2955         if (!ast_strlen_zero(i->domain)) {
2956                 pbx_builtin_setvar_helper(tmp, "SIPDOMAIN", i->domain);
2957         }
2958         if (!ast_strlen_zero(i->useragent)) {
2959                 pbx_builtin_setvar_helper(tmp, "SIPUSERAGENT", i->useragent);
2960         }
2961         if (!ast_strlen_zero(i->callid)) {
2962                 pbx_builtin_setvar_helper(tmp, "SIPCALLID", i->callid);
2963         }
2964 #ifdef OSP_SUPPORT
2965         snprintf(peer, sizeof(peer), "[%s]:%d", ast_inet_ntoa(iabuf, sizeof(iabuf), i->sa.sin_addr), ntohs(i->sa.sin_port));
2966         pbx_builtin_setvar_helper(tmp, "OSPPEER", peer);
2967 #endif
2968         ast_setstate(tmp, state);
2969         if (state != AST_STATE_DOWN) {
2970                 if (ast_pbx_start(tmp)) {
2971                         ast_log(LOG_WARNING, "Unable to start PBX on %s\n", tmp->name);
2972                         tmp->hangupcause = AST_CAUSE_SWITCH_CONGESTION;
2973                         ast_hangup(tmp);
2974                         tmp = NULL;
2975                 }
2976         }
2977         /* Set channel variables for this call from configuration */
2978         for (v = i->chanvars ; v ; v = v->next)
2979                 pbx_builtin_setvar_helper(tmp,v->name,v->value);
2980
2981         append_history(i, "NewChan", "Channel %s - from %s", tmp->name, i->callid);
2982
2983         return tmp;
2984 }
2985
2986 /*! \brief Reads one line of SIP message body */
2987 static char* get_sdp_by_line(char* line, char *name, int nameLen)
2988 {
2989         if (strncasecmp(line, name, nameLen) == 0 && line[nameLen] == '=') {
2990                 return ast_skip_blanks(line + nameLen + 1);
2991         }
2992         return "";
2993 }
2994
2995 /*! \brief Gets all kind of SIP message bodies, including SDP,
2996    but the name wrongly applies _only_ sdp */
2997 static char *get_sdp(struct sip_request *req, char *name)
2998 {
2999         int x;
3000         int len = strlen(name);
3001         char *r;
3002
3003         for (x = 0; x < req->lines; x++) {
3004                 r = get_sdp_by_line(req->line[x], name, len);
3005                 if (r[0] != '\0')
3006                         return r;
3007         }
3008         return "";
3009 }
3010
3011
3012 static void sdpLineNum_iterator_init(int* iterator)
3013 {
3014         *iterator = 0;
3015 }
3016
3017 static char* get_sdp_iterate(int* iterator,
3018                              struct sip_request *req, char *name)
3019 {
3020         int len = strlen(name);
3021         char *r;
3022
3023         while (*iterator < req->lines) {
3024                 r = get_sdp_by_line(req->line[(*iterator)++], name, len);
3025                 if (r[0] != '\0')
3026                         return r;
3027         }
3028         return "";
3029 }
3030
3031 static char *find_alias(const char *name, char *_default)
3032 {
3033         int x;
3034         for (x=0;x<sizeof(aliases) / sizeof(aliases[0]); x++)
3035                 if (!strcasecmp(aliase