channels/chan_sip.c

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