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 static 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 char *referstatus2str(enum referstatus rstatus);
1177 static int method_match(enum sipmethod id, const char *name);
1178 static void parse_copy(struct sip_request *dst, struct sip_request *src);
1179 static char *get_in_brackets(char *tmp);
1180 static const char *find_alias(const char *name, const char *_default);
1181 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1182 static const char *get_header(const struct sip_request *req, const char *name);
1183 static int lws2sws(char *msgbuf, int len);
1184 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1185
1186 /*--- Constructing requests and responses */
1187 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1188 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1189 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1190 static int init_resp(struct sip_request *resp, const char *msg);
1191 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, struct sip_request *req);
1192 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1193 static void build_via(struct sip_pvt *p);
1194 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1195 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1196 static char *generate_random_string(char *buf, size_t size);
1197 static void build_callid_pvt(struct sip_pvt *pvt);
1198 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1199 static void make_our_tag(char *tagbuf, size_t len);
1200 static int add_header(struct sip_request *req, const char *var, const char *value);
1201 static int add_header_contentLength(struct sip_request *req, int len);
1202 static int add_line(struct sip_request *req, const char *line);
1203 static int add_text(struct sip_request *req, const char *text);
1204 static int add_digit(struct sip_request *req, char digit);
1205 static int add_vidupdate(struct sip_request *req);
1206 static void add_route(struct sip_request *req, struct sip_route *route);
1207 static int copy_header(struct sip_request *req, struct sip_request *orig, char *field);
1208 static int copy_all_header(struct sip_request *req, struct sip_request *orig, char *field);
1209 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, struct sip_request *orig, char *field);
1210 static void set_destination(struct sip_pvt *p, char *uri);
1211 static void append_date(struct sip_request *req);
1212 static void build_contact(struct sip_pvt *p);
1213 static void build_rpid(struct sip_pvt *p);
1214
1215 /*------Request handling functions */
1216 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);
1217 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, int *nounlock);
1218 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1219 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1220 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1221 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1222 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1223 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1224 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1225
1226 /*------Response handling functions */
1227 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1228 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1229 static int handle_response_peerpoke(struct sip_pvt *p, int resp, struct sip_request *req);
1230
1231 /*----- RTP interface functions */
1232 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp, int codecs, int nat_active);
1233 static struct ast_rtp *sip_get_rtp_peer(struct ast_channel *chan);
1234 static struct ast_rtp *sip_get_vrtp_peer(struct ast_channel *chan);
1235 static int sip_get_codec(struct ast_channel *chan);
1236 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p);
1237
1238 /*! \brief Definition of this channel for PBX channel registration */
1239 static const struct ast_channel_tech sip_tech = {
1240         .type = "SIP",
1241         .description = "Session Initiation Protocol (SIP)",
1242         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1243         .properties = AST_CHAN_TP_WANTSJITTER,
1244         .requester = sip_request_call,
1245         .devicestate = sip_devicestate,
1246         .call = sip_call,
1247         .hangup = sip_hangup,
1248         .answer = sip_answer,
1249         .read = sip_read,
1250         .write = sip_write,
1251         .write_video = sip_write,
1252         .indicate = sip_indicate,
1253         .transfer = sip_transfer,
1254         .fixup = sip_fixup,
1255         .send_digit = sip_senddigit,
1256         .bridge = ast_rtp_bridge,
1257         .send_text = sip_sendtext,
1258 };
1259
1260 /**--- some list management macros. **/
1261
1262 #define UNLINK(element, head, prev) do {        \
1263         if (prev)                               \
1264                 (prev)->next = (element)->next; \
1265         else                                    \
1266                 (head) = (element)->next;       \
1267         } while (0)
1268
1269 /*! \brief Interface structure with callbacks used to connect to RTP module */
1270 static struct ast_rtp_protocol sip_rtp = {
1271         type: "SIP",
1272         get_rtp_info: sip_get_rtp_peer,
1273         get_vrtp_info: sip_get_vrtp_peer,
1274         set_rtp_peer: sip_set_rtp_peer,
1275         get_codec: sip_get_codec,
1276 };
1277
1278 /*! \brief Convert transfer status to string */
1279 static char *referstatus2str(enum referstatus rstatus)
1280 {
1281         int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1282         int x;
1283
1284         for (x = 0; x < i; x++) {
1285                 if (referstatusstrings[x].status ==  rstatus)
1286                         return (char *) referstatusstrings[x].text;
1287         }
1288         return "";
1289 }
1290
1291 /*! \brief Initialize the initital request packet in the pvt structure.
1292         This packet is used for creating replies and future requests in
1293         a dialog */
1294 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1295 {
1296         if (p->initreq.headers) {
1297                 ast_log(LOG_DEBUG, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1298         }
1299         /* Use this as the basis */
1300         copy_request(&p->initreq, req);
1301         parse_request(&p->initreq);
1302         if (ast_test_flag(req, SIP_PKT_DEBUG))
1303                 ast_verbose("%d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1304 }
1305
1306
1307 /*! \brief returns true if 'name' (with optional trailing whitespace)
1308  * matches the sip method 'id'.
1309  * Strictly speaking, SIP methods are case SENSITIVE, but we do
1310  * a case-insensitive comparison to be more tolerant.
1311  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
1312  */
1313 static int method_match(enum sipmethod id, const char *name)
1314 {
1315         int len = strlen(sip_methods[id].text);
1316         int l_name = name ? strlen(name) : 0;
1317         /* true if the string is long enough, and ends with whitespace, and matches */
1318         return (l_name >= len && name[len] < 33 &&
1319                 !strncasecmp(sip_methods[id].text, name, len));
1320 }
1321
1322 /*! \brief  find_sip_method: Find SIP method from header */
1323 static int find_sip_method(const char *msg)
1324 {
1325         int i, res = 0;
1326
1327         if (ast_strlen_zero(msg))
1328                 return 0;
1329         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1330                 if (method_match(i, msg))
1331                         res = sip_methods[i].id;
1332         }
1333         return res;
1334 }
1335
1336 /*! \brief Parse supported header in incoming packet */
1337 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1338 {
1339         char *next, *sep;
1340         char *temp = ast_strdupa(supported);
1341         unsigned int profile = 0;
1342         int i, found;
1343
1344         if (!pvt || ast_strlen_zero(supported) )
1345                 return 0;
1346
1347         if (option_debug > 2 && sipdebug)
1348                 ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1349
1350         for (next = temp; next; next = sep) {
1351                 found = FALSE;
1352                 if ( (sep = strchr(next, ',')) != NULL)
1353                         *sep++ = '\0';
1354                 next = ast_skip_blanks(next);
1355                 if (option_debug > 2 && sipdebug)
1356                         ast_log(LOG_DEBUG, "Found SIP option: -%s-\n", next);
1357                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1358                         if (!strcasecmp(next, sip_options[i].text)) {
1359                                 profile |= sip_options[i].id;
1360                                 found = TRUE;
1361                                 if (option_debug > 2 && sipdebug)
1362                                         ast_log(LOG_DEBUG, "Matched SIP option: %s\n", next);
1363                                 break;
1364                         }
1365                 }
1366                 if (!found && option_debug > 2 && sipdebug)
1367                         ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1368         }
1369
1370         pvt->sipoptions = profile;
1371         return profile;
1372 }
1373
1374 /*! \brief See if we pass debug IP filter */
1375 static inline int sip_debug_test_addr(const struct sockaddr_in *addr)
1376 {
1377         if (!sipdebug)
1378                 return 0;
1379         if (debugaddr.sin_addr.s_addr) {
1380                 if (((ntohs(debugaddr.sin_port) != 0)
1381                         && (debugaddr.sin_port != addr->sin_port))
1382                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1383                         return 0;
1384         }
1385         return 1;
1386 }
1387
1388 /*! \brief The real destination address for a write */
1389 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1390 {
1391         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1392 }
1393
1394 /*! \brief Display SIP nat mode */
1395 static const char *sip_nat_mode(const struct sip_pvt *p)
1396 {
1397         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1398 }
1399
1400 /*! \brief Test PVT for debugging output */
1401 static inline int sip_debug_test_pvt(struct sip_pvt *p)
1402 {
1403         if (!sipdebug)
1404                 return 0;
1405         return sip_debug_test_addr(sip_real_dst(p));
1406 }
1407
1408 /*! \brief Transmit SIP message */
1409 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
1410 {
1411         int res;
1412         char iabuf[INET_ADDRSTRLEN];
1413         const struct sockaddr_in *dst = sip_real_dst(p);
1414         res=sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
1415
1416         if (res != len)
1417                 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));
1418         return res;
1419 }
1420
1421
1422 /*! \brief Build a Via header for a request */
1423 static void build_via(struct sip_pvt *p)
1424 {
1425         char iabuf[INET_ADDRSTRLEN];
1426         /* Work around buggy UNIDEN UIP200 firmware */
1427         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
1428
1429         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
1430         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
1431                          ast_inet_ntoa(iabuf, sizeof(iabuf), p->ourip), ourport, p->branch, rport);
1432 }
1433
1434 /*! \brief NAT fix - decide which IP address to use for ASterisk server?
1435  * Only used for outbound registrations */
1436 static int ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us)
1437 {
1438         /*
1439          * Using the localaddr structure built up with localnet statements
1440          * apply it to their address to see if we need to substitute our
1441          * externip or can get away with our internal bindaddr
1442          */
1443         struct sockaddr_in theirs;
1444         theirs.sin_addr = *them;
1445
1446         if (localaddr && externip.sin_addr.s_addr &&
1447            ast_apply_ha(localaddr, &theirs)) {
1448                 if (externexpire && time(NULL) >= externexpire) {
1449                         struct ast_hostent ahp;
1450                         struct hostent *hp;
1451
1452                         time(&externexpire);
1453                         externexpire += externrefresh;
1454                         if ((hp = ast_gethostbyname(externhost, &ahp))) {
1455                                 memcpy(&externip.sin_addr, hp->h_addr, sizeof(externip.sin_addr));
1456                         } else
1457                                 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
1458                 }
1459                 *us = externip.sin_addr;
1460                 if (option_debug) {
1461                         char iabuf[INET_ADDRSTRLEN];
1462                         ast_inet_ntoa(iabuf, sizeof(iabuf), *(struct in_addr *)&them->s_addr);
1463
1464                         ast_log(LOG_DEBUG, "Target address %s is not local, substituting externip\n", iabuf);
1465                 }
1466         } else if (bindaddr.sin_addr.s_addr)
1467                 *us = bindaddr.sin_addr;
1468         else
1469                 return ast_ouraddrfor(them, us);
1470         return 0;
1471 }
1472
1473 /*! \brief Append to SIP dialog history
1474         \return Always returns 0 */
1475 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1476
1477 static int append_history_full(struct sip_pvt *p, const char *fmt, ...)
1478         __attribute__ ((format (printf, 2, 3)));
1479
1480 /*! \brief Append to SIP dialog history with arg list  */
1481 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
1482 {
1483         char buf[80], *c = buf; /* max history length */
1484         struct sip_history *hist;
1485         int l;
1486
1487         vsnprintf(buf, sizeof(buf), fmt, ap);
1488         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
1489         l = strlen(buf) + 1;
1490         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
1491                 return;
1492         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
1493                 free(hist);
1494                 return;
1495         }
1496         memcpy(hist->event, buf, l);
1497         AST_LIST_INSERT_TAIL(p->history, hist, list);
1498 }
1499
1500 /*! \brief Append to SIP dialog history with arg list  */
1501 static int append_history_full(struct sip_pvt *p, const char *fmt, ...)
1502 {
1503         va_list ap;
1504
1505         if (!recordhistory || !p)
1506                 return 0;
1507         va_start(ap, fmt);
1508         append_history_va(p, fmt, ap);
1509         va_end(ap);
1510
1511         return 0;
1512 }
1513
1514 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
1515 static int retrans_pkt(void *data)
1516 {
1517         struct sip_pkt *pkt = data, *prev, *cur = NULL;
1518         char iabuf[INET_ADDRSTRLEN];
1519         int reschedule = DEFAULT_RETRANS;
1520
1521         /* Lock channel PVT */
1522         ast_mutex_lock(&pkt->owner->lock);
1523
1524         if (pkt->retrans < MAX_RETRANS) {
1525                 pkt->retrans++;
1526                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
1527                         if (sipdebug && option_debug > 3)
1528                                 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);
1529                 } else {
1530                         int siptimer_a;
1531
1532                         if (sipdebug && option_debug > 3)
1533                                 ast_log(LOG_DEBUG, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
1534                         if (!pkt->timer_a)
1535                                 pkt->timer_a = 2 ;
1536                         else
1537                                 pkt->timer_a = 2 * pkt->timer_a;
1538
1539                         /* For non-invites, a maximum of 4 secs */
1540                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
1541                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
1542                                 siptimer_a = 4000;
1543
1544                         /* Reschedule re-transmit */
1545                         reschedule = siptimer_a;
1546                         if (option_debug > 3)
1547                                 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);
1548                 }
1549
1550                 if (pkt->owner && sip_debug_test_pvt(pkt->owner)) {
1551                         if (ast_test_flag(&pkt->owner->flags[0], SIP_NAT_ROUTE))
1552                                 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);
1553                         else
1554                                 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);
1555                 }
1556
1557                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
1558                 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
1559                 ast_mutex_unlock(&pkt->owner->lock);
1560                 return  reschedule;
1561         }
1562         /* Too many retries */
1563         if (pkt->owner && pkt->method != SIP_OPTIONS) {
1564                 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
1565                         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");
1566         } else {
1567                 if ((pkt->method == SIP_OPTIONS) && sipdebug)
1568                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
1569         }
1570         append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
1571
1572         pkt->retransid = -1;
1573
1574         if (ast_test_flag(pkt, FLAG_FATAL)) {
1575                 while(pkt->owner->owner && ast_mutex_trylock(&pkt->owner->owner->lock)) {
1576                         ast_mutex_unlock(&pkt->owner->lock);
1577                         usleep(1);
1578                         ast_mutex_lock(&pkt->owner->lock);
1579                 }
1580                 if (pkt->owner->owner) {
1581                         ast_set_flag(&pkt->owner->flags[0], SIP_ALREADYGONE);
1582                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
1583                         ast_queue_hangup(pkt->owner->owner);
1584                         ast_channel_unlock(pkt->owner->owner);
1585                 } else {
1586                         /* If no channel owner, destroy now */
1587                         ast_set_flag(&pkt->owner->flags[0], SIP_NEEDDESTROY);
1588                 }
1589         }
1590         /* In any case, go ahead and remove the packet */
1591         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
1592                 if (cur == pkt)
1593                         break;
1594         }
1595         if (cur) {
1596                 if (prev)
1597                         prev->next = cur->next;
1598                 else
1599                         pkt->owner->packets = cur->next;
1600                 ast_mutex_unlock(&pkt->owner->lock);
1601                 free(cur);
1602                 pkt = NULL;
1603         } else
1604                 ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
1605         if (pkt)
1606                 ast_mutex_unlock(&pkt->owner->lock);
1607         return 0;
1608 }
1609
1610 /*! \brief Transmit packet with retransmits
1611         \return 0 on success, -1 on failure to allocate packet
1612 */
1613 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
1614 {
1615         struct sip_pkt *pkt;
1616         int siptimer_a = DEFAULT_RETRANS;
1617
1618         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
1619                 return -1;
1620         memcpy(pkt->data, data, len);
1621         pkt->method = sipmethod;
1622         pkt->packetlen = len;
1623         pkt->next = p->packets;
1624         pkt->owner = p;
1625         pkt->seqno = seqno;
1626         pkt->flags = resp;
1627         pkt->data[len] = '\0';
1628         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
1629         if (fatal)
1630                 ast_set_flag(pkt, FLAG_FATAL);
1631         if (pkt->timer_t1)
1632                 siptimer_a = pkt->timer_t1 * 2;
1633
1634         /* Schedule retransmission */
1635         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
1636         if (option_debug > 3 && sipdebug)
1637                 ast_log(LOG_DEBUG, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
1638         pkt->next = p->packets;
1639         p->packets = pkt;
1640
1641         __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);      /* Send packet */
1642         if (sipmethod == SIP_INVITE) {
1643                 /* Note this is a pending invite */
1644                 p->pendinginvite = seqno;
1645         }
1646         return 0;
1647 }
1648
1649 /*! \brief Kill a SIP dialog (called by scheduler) */
1650 static int __sip_autodestruct(void *data)
1651 {
1652         struct sip_pvt *p = data;
1653
1654         /* If this is a subscription, tell the phone that we got a timeout */
1655         if (p->subscribed) {
1656                 p->subscribed = TIMEOUT;
1657                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1); /* Send last notification */
1658                 p->subscribed = NONE;
1659                 append_history(p, "Subscribestatus", "timeout");
1660                 if (option_debug > 2)
1661                         ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
1662                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
1663         }
1664
1665         /* Reset schedule ID */
1666         p->autokillid = -1;
1667
1668         if (option_debug)
1669                 ast_log(LOG_DEBUG, "Auto destroying call '%s'\n", p->callid);
1670         append_history(p, "AutoDestroy", "");
1671         if (p->owner) {
1672                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
1673                 ast_queue_hangup(p->owner);
1674         } else {
1675                 sip_destroy(p);
1676         }
1677         return 0;
1678 }
1679
1680 /*! \brief Schedule destruction of SIP call */
1681 static int sip_scheddestroy(struct sip_pvt *p, int ms)
1682 {
1683         if (sip_debug_test_pvt(p))
1684                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
1685         if (recordhistory)
1686                 append_history(p, "SchedDestroy", "%d ms", ms);
1687
1688         if (p->autokillid > -1)
1689                 ast_sched_del(sched, p->autokillid);
1690         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
1691         return 0;
1692 }
1693
1694 /*! \brief Cancel destruction of SIP dialog */
1695 static int sip_cancel_destroy(struct sip_pvt *p)
1696 {
1697         if (p->autokillid > -1) {
1698                 ast_sched_del(sched, p->autokillid);
1699                 append_history(p, "CancelDestroy", "");
1700                 p->autokillid = -1;
1701         }
1702         return 0;
1703 }
1704
1705 /*! \brief Acknowledges receipt of a packet and stops retransmission */
1706 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset)
1707 {
1708         struct sip_pkt *cur, *prev = NULL;
1709         int res = -1;
1710
1711         /* Just in case... */
1712         char *msg;
1713
1714         msg = sip_methods[sipmethod].text;
1715
1716         ast_mutex_lock(&p->lock);
1717         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
1718                 if ((cur->seqno == seqno) && ((ast_test_flag(cur, FLAG_RESPONSE)) == resp) &&
1719                         ((ast_test_flag(cur, FLAG_RESPONSE)) ||
1720                          (!strncasecmp(msg, cur->data, strlen(msg)) && (cur->data[strlen(msg)] < 33)))) {
1721                         if (!resp && (seqno == p->pendinginvite)) {
1722                                 ast_log(LOG_DEBUG, "Acked pending invite %d\n", p->pendinginvite);
1723                                 p->pendinginvite = 0;
1724                         }
1725                         /* this is our baby */
1726                         UNLINK(cur, p->packets, prev);
1727                         if (cur->retransid > -1) {
1728                                 if (sipdebug && option_debug > 3)
1729                                         ast_log(LOG_DEBUG, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
1730                                 ast_sched_del(sched, cur->retransid);
1731                         }
1732                         if (!reset)
1733                                 free(cur);
1734                         res = 0;
1735                         break;
1736                 }
1737         }
1738         ast_mutex_unlock(&p->lock);
1739         if (option_debug)
1740                 ast_log(LOG_DEBUG, "Stopping retransmission on '%s' of %s %d: Match %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
1741         return res;
1742 }
1743
1744 /*! \brief Pretend to ack all packets */
1745 /* maybe the lock on p is not strictly necessary but there might be a race */
1746 static int __sip_pretend_ack(struct sip_pvt *p)
1747 {
1748         struct sip_pkt *cur = NULL;
1749
1750         while (p->packets) {
1751                 int method;
1752                 if (cur == p->packets) {
1753                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
1754                         return -1;
1755                 }
1756                 cur = p->packets;
1757                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
1758                 __sip_ack(p, cur->seqno, ast_test_flag(cur, FLAG_RESPONSE), method, FALSE);
1759         }
1760         return 0;
1761 }
1762
1763 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
1764 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
1765 {
1766         struct sip_pkt *cur;
1767         int res = -1;
1768
1769         for (cur = p->packets; cur; cur = cur->next) {
1770                 if (cur->seqno == seqno && ast_test_flag(cur, FLAG_RESPONSE) == resp &&
1771                         (ast_test_flag(cur, FLAG_RESPONSE) || method_match(sipmethod, cur->data))) {
1772                         /* this is our baby */
1773                         if (cur->retransid > -1) {
1774                                 if (option_debug > 3 && sipdebug)
1775                                         ast_log(LOG_DEBUG, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
1776                                 ast_sched_del(sched, cur->retransid);
1777                         }
1778                         cur->retransid = -1;
1779                         res = 0;
1780                         break;
1781                 }
1782         }
1783         if (option_debug)
1784                 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");
1785         return res;
1786 }
1787
1788
1789 /*! \brief Copy SIP request, parse it */
1790 static void parse_copy(struct sip_request *dst, struct sip_request *src)
1791 {
1792         memset(dst, 0, sizeof(*dst));
1793         memcpy(dst->data, src->data, sizeof(dst->data));
1794         dst->len = src->len;
1795         parse_request(dst);
1796 }
1797
1798 /* add a blank line if no body */
1799 static void add_blank(struct sip_request *req)
1800 {
1801         if (!req->lines) {
1802                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
1803                 snprintf(req->data + req->len, sizeof(req->data) - req->len, "\r\n");
1804                 req->len += strlen(req->data + req->len);
1805         }
1806 }
1807
1808 /*! \brief Transmit response on SIP request*/
1809 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
1810 {
1811         int res;
1812
1813         add_blank(req);
1814         if (sip_debug_test_pvt(p)) {
1815                 char iabuf[INET_ADDRSTRLEN];
1816                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
1817                         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);
1818                 else
1819                         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);
1820         }
1821         if (recordhistory) {
1822                 struct sip_request tmp;
1823                 parse_copy(&tmp, req);
1824                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"),
1825                         tmp.method == SIP_RESPONSE ? tmp.rlPart2 : sip_methods[tmp.method].text);
1826         }
1827         res = (reliable) ?
1828                 __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
1829                 __sip_xmit(p, req->data, req->len);
1830         if (res > 0)
1831                 return 0;
1832         return res;
1833 }
1834
1835 /*! \brief Send SIP Request to the other part of the dialogue */
1836 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
1837 {
1838         int res;
1839
1840         add_blank(req);
1841         if (sip_debug_test_pvt(p)) {
1842                 char iabuf[INET_ADDRSTRLEN];
1843                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
1844                         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);
1845                 else
1846                         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);
1847         }
1848         if (recordhistory) {
1849                 struct sip_request tmp;
1850                 parse_copy(&tmp, req);
1851                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
1852         }
1853         res = (reliable) ?
1854                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable > 1), req->method) :
1855                 __sip_xmit(p, req->data, req->len);
1856         return res;
1857 }
1858
1859 /*! \brief Pick out text in brackets from character string
1860         \return pointer to terminated stripped string
1861         \param tmp input string that will be modified */
1862 static char *get_in_brackets(char *tmp)
1863 {
1864         char *parse;
1865         char *first_quote;
1866         char *first_bracket;
1867         char *second_bracket;
1868         char last_char;
1869
1870         parse = tmp;
1871         for (;;) {
1872                 first_quote = strchr(parse, '"');
1873                 first_bracket = strchr(parse, '<');
1874                 if (first_quote && first_bracket && (first_quote < first_bracket)) {
1875                         last_char = '\0';
1876                         for (parse = first_quote + 1; *parse; parse++) {
1877                                 if ((*parse == '"') && (last_char != '\\'))
1878                                         break;
1879                                 last_char = *parse;
1880                         }
1881                         if (!*parse) {
1882                                 ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
1883                                 return tmp;
1884                         }
1885                         parse++;
1886                         continue;
1887                 }
1888                 if (first_bracket) {
1889                         second_bracket = strchr(first_bracket + 1, '>');
1890                         if (second_bracket) {
1891                                 *second_bracket = '\0';
1892                                 return first_bracket + 1;
1893                         } else {
1894                                 ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
1895                                 return tmp;
1896                         }
1897                 }
1898                 return tmp;
1899         }
1900 }
1901
1902 /*! \brief Send SIP MESSAGE text within a call
1903         Called from PBX core sendtext() application */
1904 static int sip_sendtext(struct ast_channel *ast, const char *text)
1905 {
1906         struct sip_pvt *p = ast->tech_pvt;
1907         int debug = sip_debug_test_pvt(p);
1908
1909         if (debug)
1910                 ast_verbose("Sending text %s on %s\n", text, ast->name);
1911         if (!p)
1912                 return -1;
1913         if (ast_strlen_zero(text))
1914                 return 0;
1915         if (debug)
1916                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
1917         transmit_message_with_text(p, text);
1918         return 0;
1919 }
1920
1921 /*! \brief Update peer object in realtime storage */
1922 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
1923 {
1924         char port[10];
1925         char ipaddr[20];
1926         char regseconds[20];
1927         time_t nowtime;
1928         const char *fc = fullcontact ? "fullcontact" : NULL;
1929
1930         time(&nowtime);
1931         nowtime += expirey;
1932         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
1933         ast_inet_ntoa(ipaddr, sizeof(ipaddr), sin->sin_addr);
1934         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
1935
1936         ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
1937                 "port", port, "regseconds", regseconds,
1938                 "username", username, fc, fullcontact, NULL); /* note fc _can_ be NULL */
1939 }
1940
1941 /*! \brief Automatically add peer extension to dial plan */
1942 static void register_peer_exten(struct sip_peer *peer, int onoff)
1943 {
1944         char multi[256];
1945         char *stringp, *ext;
1946         if (!ast_strlen_zero(global_regcontext)) {
1947
1948                 ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
1949                 stringp = multi;
1950                 while((ext = strsep(&stringp, "&"))) {
1951                         if (onoff)
1952                                 ast_add_extension(global_regcontext, 1, ext, 1, NULL, NULL, "Noop",
1953                                                   ast_strdup(peer->name), free, "SIP");
1954                         else
1955                                 ast_context_remove_extension(global_regcontext, ext, 1, NULL);
1956                 }
1957         }
1958 }
1959
1960 /*! \brief Destroy peer object from memory */
1961 static void sip_destroy_peer(struct sip_peer *peer)
1962 {
1963         if (option_debug > 2)
1964                 ast_log(LOG_DEBUG, "Destroying SIP peer %s\n", peer->name);
1965
1966         /* Delete it, it needs to disappear */
1967         if (peer->call)
1968                 sip_destroy(peer->call);
1969
1970         if (peer->mwipvt) {     /* We have an active subscription, delete it */
1971                 sip_destroy(peer->mwipvt);
1972         }
1973
1974         if (peer->chanvars) {
1975                 ast_variables_destroy(peer->chanvars);
1976                 peer->chanvars = NULL;
1977         }
1978         if (peer->expire > -1)
1979                 ast_sched_del(sched, peer->expire);
1980         if (peer->pokeexpire > -1)
1981                 ast_sched_del(sched, peer->pokeexpire);
1982         register_peer_exten(peer, FALSE);
1983         ast_free_ha(peer->ha);
1984         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
1985                 apeerobjs--;
1986         else if (ast_test_flag(&peer->flags[0], SIP_REALTIME))
1987                 rpeerobjs--;
1988         else
1989                 speerobjs--;
1990         clear_realm_authentication(peer->auth);
1991         peer->auth = NULL;
1992         if (peer->dnsmgr)
1993                 ast_dnsmgr_release(peer->dnsmgr);
1994         free(peer);
1995 }
1996
1997 /*! \brief Update peer data in database (if used) */
1998 static void update_peer(struct sip_peer *p, int expiry)
1999 {
2000         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2001         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
2002             (ast_test_flag(&p->flags[0], SIP_REALTIME) || rtcachefriends)) {
2003                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
2004         }
2005 }
2006
2007
2008 /*! \brief  realtime_peer: Get peer from realtime storage
2009  * Checks the "sippeers" realtime family from extconfig.conf
2010  * \todo Consider adding check of port address when matching here to follow the same
2011  *      algorithm as for static peers. Will we break anything by adding that?
2012 */
2013 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin)
2014 {
2015         struct sip_peer *peer = NULL;
2016         struct ast_variable *var;
2017         struct ast_variable *tmp;
2018         char *newpeername = (char *) peername;
2019         char iabuf[80];
2020
2021         /* First check on peer name */
2022         if (newpeername)
2023                 var = ast_load_realtime("sippeers", "name", peername, NULL);
2024         else if (sin) { /* Then check on IP address for dynamic peers */
2025                 ast_inet_ntoa(iabuf, sizeof(iabuf), sin->sin_addr);
2026                 var = ast_load_realtime("sippeers", "host", iabuf, NULL);       /* First check for fixed IP hosts */
2027                 if (!var)
2028                         var = ast_load_realtime("sippeers", "ipaddr", iabuf, NULL);     /* Then check for registred hosts */
2029
2030         } else
2031                 return NULL;
2032
2033         if (!var)
2034                 return NULL;
2035
2036         for (tmp = var; tmp; tmp = tmp->next) {
2037                 /* If this is type=user, then skip this object. */
2038                 if (!strcasecmp(tmp->name, "type") &&
2039                     !strcasecmp(tmp->value, "user")) {
2040                         ast_variables_destroy(var);
2041                         return NULL;
2042                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
2043                         newpeername = tmp->value;
2044                 }
2045         }
2046
2047         if (!newpeername) {     /* Did not find peer in realtime */
2048                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", iabuf);
2049                 ast_variables_destroy(var);
2050                 return NULL;
2051         }
2052
2053         /* Peer found in realtime, now build it in memory */
2054         peer = build_peer(newpeername, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2055         if (!peer) {
2056                 ast_variables_destroy(var);
2057                 return NULL;
2058         }
2059
2060         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2061                 /* Cache peer */
2062                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
2063                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
2064                         if (peer->expire > -1) {
2065                                 ast_sched_del(sched, peer->expire);
2066                         }
2067                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
2068                 }
2069                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
2070         } else {
2071                 ast_set_flag(&peer->flags[0], SIP_REALTIME);
2072         }
2073         ast_variables_destroy(var);
2074
2075         return peer;
2076 }
2077
2078 /*! \brief Support routine for find_peer */
2079 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
2080 {
2081         /* We know name is the first field, so we can cast */
2082         struct sip_peer *p = (struct sip_peer *) name;
2083         return  !(!inaddrcmp(&p->addr, sin) ||
2084                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
2085                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
2086 }
2087
2088 /*! \brief Locate peer by name or ip address
2089  *      This is used on incoming SIP message to find matching peer on ip
2090         or outgoing message to find matching peer on name */
2091 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
2092 {
2093         struct sip_peer *p = NULL;
2094
2095         if (peer)
2096                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
2097         else
2098                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
2099
2100         if (!p && realtime) {
2101                 p = realtime_peer(peer, sin);
2102         }
2103         return p;
2104 }
2105
2106 /*! \brief Remove user object from in-memory storage */
2107 static void sip_destroy_user(struct sip_user *user)
2108 {
2109         if (option_debug > 2)
2110                 ast_log(LOG_DEBUG, "Destroying user object from memory: %s\n", user->name);
2111         ast_free_ha(user->ha);
2112         if (user->chanvars) {
2113                 ast_variables_destroy(user->chanvars);
2114                 user->chanvars = NULL;
2115         }
2116         if (ast_test_flag(&user->flags[0], SIP_REALTIME))
2117                 ruserobjs--;
2118         else
2119                 suserobjs--;
2120         free(user);
2121 }
2122
2123 /*! \brief Load user from realtime storage
2124  * Loads user from "sipusers" category in realtime (extconfig.conf)
2125  * Users are matched on From: user name (the domain in skipped) */
2126 static struct sip_user *realtime_user(const char *username)
2127 {
2128         struct ast_variable *var;
2129         struct ast_variable *tmp;
2130         struct sip_user *user = NULL;
2131
2132         var = ast_load_realtime("sipusers", "name", username, NULL);
2133
2134         if (!var)
2135                 return NULL;
2136
2137         for (tmp = var; tmp; tmp = tmp->next) {
2138                 if (!strcasecmp(tmp->name, "type") &&
2139                         !strcasecmp(tmp->value, "peer")) {
2140                         ast_variables_destroy(var);
2141                         return NULL;
2142                 }
2143         }
2144
2145         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2146
2147         if (!user) {    /* No user found */
2148                 ast_variables_destroy(var);
2149                 return NULL;
2150         }
2151
2152         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2153                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2154                 suserobjs++;
2155                 ASTOBJ_CONTAINER_LINK(&userl,user);
2156         } else {
2157                 /* Move counter from s to r... */
2158                 suserobjs--;
2159                 ruserobjs++;
2160                 ast_set_flag(&user->flags[0], SIP_REALTIME);
2161         }
2162         ast_variables_destroy(var);
2163         return user;
2164 }
2165
2166 /*! \brief Locate user by name
2167  * Locates user by name (From: sip uri user name part) first
2168  * from in-memory list (static configuration) then from
2169  * realtime storage (defined in extconfig.conf) */
2170 static struct sip_user *find_user(const char *name, int realtime)
2171 {
2172         struct sip_user *u = ASTOBJ_CONTAINER_FIND(&userl, name);
2173         if (!u && realtime)
2174                 u = realtime_user(name);
2175         return u;
2176 }
2177
2178 /*! \brief Create address structure from peer reference */
2179 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer)
2180 {
2181         int natflags;
2182
2183         if ((peer->addr.sin_addr.s_addr || peer->defaddr.sin_addr.s_addr) &&
2184             (!peer->maxms || ((peer->lastms >= 0)  && (peer->lastms <= peer->maxms)))) {
2185                 r->sa = (peer->addr.sin_addr.s_addr) ? peer->addr : peer->defaddr;
2186                 r->recv = r->sa;
2187         } else {
2188                 return -1;
2189         }
2190
2191         ast_copy_flags(&r->flags[0], &peer->flags[0], SIP_FLAGS_TO_COPY);
2192         ast_copy_flags(&r->flags[1], &peer->flags[1], SIP_PAGE2_FLAGS_TO_COPY);
2193         r->capability = peer->capability;
2194         if (!ast_test_flag(&r->flags[1], SIP_PAGE2_VIDEOSUPPORT) && r->vrtp) {
2195                 ast_rtp_destroy(r->vrtp);
2196                 r->vrtp = NULL;
2197         }
2198         r->prefs = peer->prefs;
2199         natflags = ast_test_flag(&r->flags[0], SIP_NAT) & SIP_NAT_ROUTE;
2200         if (r->rtp) {
2201                 if (option_debug)
2202                         ast_log(LOG_DEBUG, "Setting NAT on RTP to %d\n", natflags);
2203                 ast_rtp_setnat(r->rtp, natflags);
2204         }
2205         if (r->vrtp) {
2206                 if (option_debug)
2207                         ast_log(LOG_DEBUG, "Setting NAT on VRTP to %d\n", natflags);
2208                 ast_rtp_setnat(r->vrtp, natflags);
2209         }
2210         ast_string_field_set(r, peername, peer->username);
2211         ast_string_field_set(r, authname, peer->username);
2212         ast_string_field_set(r, username, peer->username);
2213         ast_string_field_set(r, peersecret, peer->secret);
2214         ast_string_field_set(r, peermd5secret, peer->md5secret);
2215         ast_string_field_set(r, tohost, peer->tohost);
2216         ast_string_field_set(r, fullcontact, peer->fullcontact);
2217         if (!r->initreq.headers && !ast_strlen_zero(peer->fromdomain)) {
2218                 char *tmpcall;
2219                 char *c;
2220                 tmpcall = ast_strdupa(r->callid);
2221                 c = strchr(tmpcall, '@');
2222                 if (c) {
2223                         *c = '\0';
2224                         ast_string_field_build(r, callid, "%s@%s", tmpcall, peer->fromdomain);
2225                 }
2226         }
2227         if (ast_strlen_zero(r->tohost)) {
2228                 char iabuf[INET_ADDRSTRLEN];
2229
2230                 ast_inet_ntoa(iabuf, sizeof(iabuf),  r->sa.sin_addr);
2231                 ast_string_field_set(r, tohost, iabuf);
2232         }
2233         if (!ast_strlen_zero(peer->fromdomain))
2234                 ast_string_field_set(r, fromdomain, peer->fromdomain);
2235         if (!ast_strlen_zero(peer->fromuser))
2236                 ast_string_field_set(r, fromuser, peer->fromuser);
2237         r->maxtime = peer->maxms;
2238         r->callgroup = peer->callgroup;
2239         r->pickupgroup = peer->pickupgroup;
2240         r->allowtransfer = peer->allowtransfer;
2241         /* Set timer T1 to RTT for this peer (if known by qualify=) */
2242         /* Minimum is settable or default to 100 ms */
2243         if (peer->maxms && peer->lastms)
2244                 r->timer_t1 = peer->lastms < global_t1min ? global_t1min : peer->lastms;
2245         if ((ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_RFC2833) ||
2246             (ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_AUTO))
2247                 r->noncodeccapability |= AST_RTP_DTMF;
2248         else
2249                 r->noncodeccapability &= ~AST_RTP_DTMF;
2250         ast_string_field_set(r, context, peer->context);
2251         r->rtptimeout = peer->rtptimeout;
2252         r->rtpholdtimeout = peer->rtpholdtimeout;
2253         r->rtpkeepalive = peer->rtpkeepalive;
2254         if (peer->call_limit)
2255                 ast_set_flag(&r->flags[0], SIP_CALL_LIMIT);
2256         r->maxcallbitrate = peer->maxcallbitrate;
2257
2258         return 0;
2259 }
2260
2261 /*! \brief create address structure from peer name
2262  *      Or, if peer not found, find it in the global DNS
2263  *      returns TRUE (-1) on failure, FALSE on success */
2264 static int create_addr(struct sip_pvt *dialog, const char *opeer)
2265 {
2266         struct hostent *hp;
2267         struct ast_hostent ahp;
2268         struct sip_peer *p;
2269         int found=0;
2270         char *port;
2271         int portno;
2272         char host[MAXHOSTNAMELEN], *hostn;
2273         char peer[256];
2274
2275         ast_copy_string(peer, opeer, sizeof(peer));
2276         port = strchr(peer, ':');
2277         if (port)
2278                 *port++ = '\0';
2279         dialog->sa.sin_family = AF_INET;
2280         dialog->timer_t1 = 500; /* Default SIP retransmission timer T1 (RFC 3261) */
2281         p = find_peer(peer, NULL, 1);
2282
2283         if (p) {
2284                 found++;
2285                 if (create_addr_from_peer(dialog, p))
2286                         ASTOBJ_UNREF(p, sip_destroy_peer);
2287         }
2288         if (!p) {
2289                 if (found)
2290                         return -1;
2291
2292                 hostn = peer;
2293                 portno = port ? atoi(port) : DEFAULT_SIP_PORT;
2294                 if (srvlookup) {
2295                         char service[MAXHOSTNAMELEN];
2296                         int tportno;
2297                         int ret;
2298                         snprintf(service, sizeof(service), "_sip._udp.%s", peer);
2299                         ret = ast_get_srv(NULL, host, sizeof(host), &tportno, service);
2300                         if (ret > 0) {
2301                                 hostn = host;
2302                                 portno = tportno;
2303                         }
2304                 }
2305                 hp = ast_gethostbyname(hostn, &ahp);
2306                 if (hp) {
2307                         ast_string_field_set(dialog, tohost, peer);
2308                         memcpy(&dialog->sa.sin_addr, hp->h_addr, sizeof(dialog->sa.sin_addr));
2309                         dialog->sa.sin_port = htons(portno);
2310                         dialog->recv = dialog->sa;
2311                         return 0;
2312                 } else {
2313                         ast_log(LOG_WARNING, "No such host: %s\n", peer);
2314                         return -1;
2315                 }
2316         } else {
2317                 ASTOBJ_UNREF(p, sip_destroy_peer);
2318                 return 0;
2319         }
2320 }
2321
2322 /*! \brief Scheduled congestion on a call */
2323 static int auto_congest(void *nothing)
2324 {
2325         struct sip_pvt *p = nothing;
2326
2327         ast_mutex_lock(&p->lock);
2328         p->initid = -1;
2329         if (p->owner) {
2330                 /* XXX fails on possible deadlock */
2331                 if (!ast_channel_trylock(p->owner)) {
2332                         ast_log(LOG_NOTICE, "Auto-congesting %s\n", p->owner->name);
2333                         ast_queue_control(p->owner, AST_CONTROL_CONGESTION);
2334                         ast_channel_unlock(p->owner);
2335                 }
2336         }
2337         ast_mutex_unlock(&p->lock);
2338         return 0;
2339 }
2340
2341
2342 /*! \brief Initiate SIP call from PBX
2343  *      used from the dial() application      */
2344 static int sip_call(struct ast_channel *ast, char *dest, int timeout)
2345 {
2346         int res;
2347         struct sip_pvt *p;
2348         struct varshead *headp;
2349         struct ast_var_t *current;
2350         const char *referer = NULL;   /* SIP refererer */
2351
2352         p = ast->tech_pvt;
2353         if ((ast->_state != AST_STATE_DOWN) && (ast->_state != AST_STATE_RESERVED)) {
2354                 ast_log(LOG_WARNING, "sip_call called on %s, neither down nor reserved\n", ast->name);
2355                 return -1;
2356         }
2357
2358         /* Check whether there is vxml_url, distinctive ring variables */
2359         headp=&ast->varshead;
2360         AST_LIST_TRAVERSE(headp,current,entries) {
2361                 /* Check whether there is a VXML_URL variable */
2362                 if (!p->options->vxml_url && !strcasecmp(ast_var_name(current), "VXML_URL")) {
2363                         p->options->vxml_url = ast_var_value(current);
2364                 } else if (!p->options->uri_options && !strcasecmp(ast_var_name(current), "SIP_URI_OPTIONS")) {
2365                         p->options->uri_options = ast_var_value(current);
2366                 } else if (!p->options->distinctive_ring && !strcasecmp(ast_var_name(current), "ALERT_INFO")) {
2367                         /* Check whether there is a ALERT_INFO variable */
2368                         p->options->distinctive_ring = ast_var_value(current);
2369                 } else if (!p->options->addsipheaders && !strncasecmp(ast_var_name(current), "SIPADDHEADER", strlen("SIPADDHEADER"))) {
2370                         /* Check whether there is a variable with a name starting with SIPADDHEADER */
2371                         p->options->addsipheaders = 1;
2372                 } else if (!strcasecmp(ast_var_name(current),"SIPTRANSFER")) {
2373                         /* This is a transfered call */
2374                         p->options->transfer = 1;
2375                 } else if (!strcasecmp(ast_var_name(current),"SIPTRANSFER_REFERER")) {
2376                         /* This is the referer */
2377                         referer = ast_var_value(current);
2378                 } else if (!strcasecmp(ast_var_name(current),"SIPTRANSFER_REPLACES")) {
2379                         /* We're replacing a call. */
2380                         p->options->replaces = ast_var_value(current);
2381                 }
2382         }
2383
2384         res = 0;
2385         ast_set_flag(&p->flags[0], SIP_OUTGOING);
2386
2387         if (p->options->transfer) {
2388                 char buf[BUFSIZ/2];
2389
2390                 if (referer) {
2391                         if (sipdebug && option_debug > 2)
2392                                 ast_log(LOG_DEBUG, "Call for %s transfered by %s\n", p->username, referer);
2393                         snprintf(buf, sizeof(buf)-1, "-> %s (via %s)", p->cid_name, referer);
2394                 } else {
2395                         snprintf(buf, sizeof(buf)-1, "-> %s", p->cid_name);
2396                 }
2397                 ast_string_field_set(p, cid_name, buf);
2398         }
2399         if (option_debug)
2400                 ast_log(LOG_DEBUG, "Outgoing Call for %s\n", p->username);
2401
2402         res = update_call_counter(p, INC_CALL_LIMIT);
2403         if ( res != -1 ) {
2404                 p->callingpres = ast->cid.cid_pres;
2405                 p->jointcapability = p->capability;
2406                 transmit_invite(p, SIP_INVITE, 1, 2);
2407                 if (p->maxtime) {
2408                         /* Initialize auto-congest time */
2409                         p->initid = ast_sched_add(sched, p->maxtime * 4, auto_congest, p);
2410                 } else {
2411                         p->initid = ast_sched_add(sched, SIP_TRANS_TIMEOUT, auto_congest, p);
2412                 }
2413         }
2414         return res;
2415 }
2416
2417 /*! \brief Destroy registry object
2418         Objects created with the register= statement in static configuration */
2419 static void sip_registry_destroy(struct sip_registry *reg)
2420 {
2421         /* Really delete */
2422         if (option_debug > 2)
2423                 ast_log(LOG_DEBUG, "Destroying registry entry for %s@%s\n", reg->username, reg->hostname);
2424
2425         if (reg->call) {
2426                 /* Clear registry before destroying to ensure
2427                    we don't get reentered trying to grab the registry lock */
2428                 reg->call->registry = NULL;
2429                 if (option_debug > 2)
2430                         ast_log(LOG_DEBUG, "Destroying active SIP dialog for registry %s@%s\n", reg->username, reg->hostname);
2431                 sip_destroy(reg->call);
2432         }
2433         if (reg->expire > -1)
2434                 ast_sched_del(sched, reg->expire);
2435         if (reg->timeout > -1)
2436                 ast_sched_del(sched, reg->timeout);
2437         ast_string_field_free_all(reg);
2438         regobjs--;
2439         free(reg);
2440
2441 }
2442
2443 /*! \brief Execute destruction of SIP dialog structure, release memory */
2444 static void __sip_destroy(struct sip_pvt *p, int lockowner)
2445 {
2446         struct sip_pvt *cur, *prev = NULL;
2447         struct sip_pkt *cp;
2448
2449         if (sip_debug_test_pvt(p) || option_debug > 2)
2450                 ast_verbose("Really destroying SIP dialog '%s' Method: %s\n", p->callid, sip_methods[p->method].text);
2451
2452         /* Remove link from peer to subscription of MWI */
2453         if (p->relatedpeer && p->relatedpeer->mwipvt)
2454                 p->relatedpeer->mwipvt = NULL;
2455
2456         if (dumphistory)
2457                 sip_dump_history(p);
2458
2459         if (p->options)
2460                 free(p->options);
2461
2462         if (p->stateid > -1)
2463                 ast_extension_state_del(p->stateid, NULL);
2464         if (p->initid > -1)
2465                 ast_sched_del(sched, p->initid);
2466         if (p->autokillid > -1)
2467                 ast_sched_del(sched, p->autokillid);
2468
2469         if (p->rtp)
2470                 ast_rtp_destroy(p->rtp);
2471         if (p->vrtp)
2472                 ast_rtp_destroy(p->vrtp);
2473         if (p->refer)
2474                 free(p->refer);
2475         if (p->route) {
2476                 free_old_route(p->route);
2477                 p->route = NULL;
2478         }
2479         if (p->registry) {
2480                 if (p->registry->call == p)
2481                         p->registry->call = NULL;
2482                 ASTOBJ_UNREF(p->registry, sip_registry_destroy);
2483         }
2484
2485         /* Unlink us from the owner if we have one */
2486         if (p->owner) {
2487                 if (lockowner)
2488                         ast_channel_lock(p->owner);
2489                 if (option_debug)
2490                         ast_log(LOG_DEBUG, "Detaching from %s\n", p->owner->name);
2491                 p->owner->tech_pvt = NULL;
2492                 if (lockowner)
2493                         ast_channel_unlock(p->owner);
2494         }
2495         /* Clear history */
2496         if (p->history) {
2497                 struct sip_history *hist;
2498                 while( (hist = AST_LIST_REMOVE_HEAD(p->history, list)) )
2499                         free(hist);
2500                 free(p->history);
2501                 p->history = NULL;
2502         }
2503
2504         for (prev = NULL, cur = iflist; cur; prev = cur, cur = cur->next) {
2505                 if (cur == p) {
2506                         UNLINK(cur, iflist, prev);
2507                         break;
2508                 }
2509         }
2510         if (!cur) {
2511                 ast_log(LOG_WARNING, "Trying to destroy \"%s\", not found in dialog list?!?! \n", p->callid);
2512                 return;
2513         }
2514         if (p->initid > -1)
2515                 ast_sched_del(sched, p->initid);
2516
2517         /* remove all current packets in this dialog */
2518         while((cp = p->packets)) {
2519                 p->packets = p->packets->next;
2520                 if (cp->retransid > -1)
2521                         ast_sched_del(sched, cp->retransid);
2522                 free(cp);
2523         }
2524         if (p->chanvars) {
2525                 ast_variables_destroy(p->chanvars);
2526                 p->chanvars = NULL;
2527         }
2528         ast_mutex_destroy(&p->lock);
2529
2530         ast_string_field_free_all(p);
2531
2532         free(p);
2533 }
2534
2535 /*! \brief  update_call_counter: Handle call_limit for SIP users
2536  * Setting a call-limit will cause calls above the limit not to be accepted.
2537  *
2538  * Remember that for a type=friend, there's one limit for the user and
2539  * another for the peer, not a combined call limit.
2540  * This will cause unexpected behaviour in subscriptions, since a "friend"
2541  * is *two* devices in Asterisk, not one.
2542  *
2543  * Thought: For realtime, we should propably update storage with inuse counter...
2544  *
2545  * \return 0 if call is ok (no call limit, below treshold)
2546  *      -1 on rejection of call
2547  *
2548  */
2549 static int update_call_counter(struct sip_pvt *fup, int event)
2550 {
2551         char name[256];
2552         int *inuse, *call_limit;
2553         int outgoing = ast_test_flag(&fup->flags[0], SIP_OUTGOING);
2554         struct sip_user *u = NULL;
2555         struct sip_peer *p = NULL;
2556
2557         if (option_debug > 2)
2558                 ast_log(LOG_DEBUG, "Updating call counter for %s call\n", outgoing ? "outgoing" : "incoming");
2559         /* Test if we need to check call limits, in order to avoid
2560            realtime lookups if we do not need it */
2561         if (!ast_test_flag(&fup->flags[0], SIP_CALL_LIMIT))
2562                 return 0;
2563
2564         ast_copy_string(name, fup->username, sizeof(name));
2565
2566         /* Check the list of users */
2567         if (!outgoing)  /* Only check users for incoming calls */
2568                 u = find_user(name, 1);
2569
2570         if (u) {
2571                 inuse = &u->inUse;
2572                 call_limit = &u->call_limit;
2573                 p = NULL;
2574         } else {
2575                 /* Try to find peer */
2576                 if (!p)
2577                         p = find_peer(fup->peername, NULL, 1);
2578                 if (p) {
2579                         inuse = &p->inUse;
2580                         call_limit = &p->call_limit;
2581                         ast_copy_string(name, fup->peername, sizeof(name));
2582                 } else {
2583                         if (option_debug > 1)
2584                                 ast_log(LOG_DEBUG, "%s is not a local user, no call limit\n", name);
2585                         return 0;
2586                 }
2587         }
2588         switch(event) {
2589                 /* incoming and outgoing affects the inUse counter */
2590                 case DEC_CALL_LIMIT:
2591                         if ( *inuse > 0 ) {
2592                                 if (ast_test_flag(&fup->flags[0], SIP_INC_COUNT))
2593                                         (*inuse)--;
2594                         } else {
2595                                 *inuse = 0;
2596                         }
2597                         if (option_debug > 1 || sipdebug) {
2598                                 ast_log(LOG_DEBUG, "Call %s %s '%s' removed from call limit %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
2599                         }
2600                         break;
2601                 case INC_CALL_LIMIT:
2602                         if (*call_limit > 0 ) {
2603                                 if (*inuse >= *call_limit) {
2604                                         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);
2605                                         if (u)
2606                                                 ASTOBJ_UNREF(u, sip_destroy_user);
2607                                         else
2608                                                 ASTOBJ_UNREF(p, sip_destroy_peer);
2609                                         return -1;
2610                                 }
2611                         }
2612                         (*inuse)++;
2613                         ast_set_flag(&fup->flags[0], SIP_INC_COUNT);
2614                         if (option_debug > 1 || sipdebug) {
2615                                 ast_log(LOG_DEBUG, "Call %s %s '%s' is %d out of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *inuse, *call_limit);
2616                         }
2617                         break;
2618                 default:
2619                         ast_log(LOG_ERROR, "update_call_counter(%s, %d) called with no event!\n", name, event);
2620         }
2621         if (u)
2622                 ASTOBJ_UNREF(u, sip_destroy_user);
2623         else
2624                 ASTOBJ_UNREF(p, sip_destroy_peer);
2625         return 0;
2626 }
2627
2628 /*! \brief Destroy SIP call structure */
2629 static void sip_destroy(struct sip_pvt *p)
2630 {
2631         ast_mutex_lock(&iflock);
2632         if (option_debug > 2)
2633                 ast_log(LOG_DEBUG, "Destroying SIP dialog %s\n", p->callid);
2634         __sip_destroy(p, 1);
2635         ast_mutex_unlock(&iflock);
2636 }
2637
2638 /*! \brief Convert SIP hangup causes to Asterisk hangup causes */
2639 static int hangup_sip2cause(int cause)
2640 {
2641         /* Possible values taken from causes.h */
2642
2643         switch(cause) {
2644                 case 401:       /* Unauthorized */
2645                         return AST_CAUSE_CALL_REJECTED;
2646                 case 403:       /* Not found */
2647                         return AST_CAUSE_CALL_REJECTED;
2648                 case 404:       /* Not found */
2649                         return AST_CAUSE_UNALLOCATED;
2650                 case 405:       /* Method not allowed */
2651                         return AST_CAUSE_INTERWORKING;
2652                 case 407:       /* Proxy authentication required */
2653                         return AST_CAUSE_CALL_REJECTED;
2654                 case 408:       /* No reaction */
2655                         return AST_CAUSE_NO_USER_RESPONSE;
2656                 case 409:       /* Conflict */
2657                         return AST_CAUSE_NORMAL_TEMPORARY_FAILURE;
2658                 case 410:       /* Gone */
2659                         return AST_CAUSE_UNALLOCATED;
2660                 case 411:       /* Length required */
2661                         return AST_CAUSE_INTERWORKING;
2662                 case 413:       /* Request entity too large */
2663                         return AST_CAUSE_INTERWORKING;
2664                 case 414:       /* Request URI too large */
2665                         return AST_CAUSE_INTERWORKING;
2666                 case 415:       /* Unsupported media type */
2667                         return AST_CAUSE_INTERWORKING;
2668                 case 420:       /* Bad extension */
2669                         return AST_CAUSE_NO_ROUTE_DESTINATION;
2670                 case 480:       /* No answer */
2671                         return AST_CAUSE_NO_ANSWER;
2672                 case 481:       /* No answer */
2673                         return AST_CAUSE_INTERWORKING;
2674                 case 482:       /* Loop detected */
2675                         return AST_CAUSE_INTERWORKING;
2676                 case 483:       /* Too many hops */
2677                         return AST_CAUSE_NO_ANSWER;
2678                 case 484:       /* Address incomplete */
2679                         return AST_CAUSE_INVALID_NUMBER_FORMAT;
2680                 case 485:       /* Ambigous */
2681                         return AST_CAUSE_UNALLOCATED;
2682                 case 486:       /* Busy everywhere */
2683                         return AST_CAUSE_BUSY;
2684                 case 487:       /* Request terminated */
2685                         return AST_CAUSE_INTERWORKING;
2686                 case 488:       /* No codecs approved */
2687                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
2688                 case 491:       /* Request pending */
2689                         return AST_CAUSE_INTERWORKING;
2690                 case 493:       /* Undecipherable */
2691                         return AST_CAUSE_INTERWORKING;
2692                 case 500:       /* Server internal failure */
2693                         return AST_CAUSE_FAILURE;
2694                 case 501:       /* Call rejected */
2695                         return AST_CAUSE_FACILITY_REJECTED;
2696                 case 502:
2697                         return AST_CAUSE_DESTINATION_OUT_OF_ORDER;
2698                 case 503:       /* Service unavailable */
2699                         return AST_CAUSE_CONGESTION;
2700                 case 504:       /* Gateway timeout */
2701                         return AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE;
2702                 case 505:       /* SIP version not supported */
2703                         return AST_CAUSE_INTERWORKING;
2704                 case 600:       /* Busy everywhere */
2705                         return AST_CAUSE_USER_BUSY;
2706                 case 603:       /* Decline */
2707                         return AST_CAUSE_CALL_REJECTED;
2708                 case 604:       /* Does not exist anywhere */
2709                         return AST_CAUSE_UNALLOCATED;
2710                 case 606:       /* Not acceptable */
2711                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
2712                 default:
2713                         return AST_CAUSE_NORMAL;
2714         }
2715         /* Never reached */
2716         return 0;
2717 }
2718
2719 /*! \brief Convert Asterisk hangup causes to SIP codes
2720 \verbatim
2721  Possible values from causes.h
2722         AST_CAUSE_NOTDEFINED    AST_CAUSE_NORMAL        AST_CAUSE_BUSY
2723         AST_CAUSE_FAILURE       AST_CAUSE_CONGESTION    AST_CAUSE_UNALLOCATED
2724
2725         In addition to these, a lot of PRI codes is defined in causes.h
2726         ...should we take care of them too ?
2727
2728         Quote RFC 3398
2729
2730    ISUP Cause value                        SIP response
2731    ----------------                        ------------
2732    1  unallocated number                   404 Not Found
2733    2  no route to network                  404 Not found
2734    3  no route to destination              404 Not found
2735    16 normal call clearing                 --- (*)
2736    17 user busy                            486 Busy here
2737    18 no user responding                   408 Request Timeout
2738    19 no answer from the user              480 Temporarily unavailable
2739    20 subscriber absent                    480 Temporarily unavailable
2740    21 call rejected                        403 Forbidden (+)
2741    22 number changed (w/o diagnostic)      410 Gone
2742    22 number changed (w/ diagnostic)       301 Moved Permanently
2743    23 redirection to new destination       410 Gone
2744    26 non-selected user clearing           404 Not Found (=)
2745    27 destination out of order             502 Bad Gateway
2746    28 address incomplete                   484 Address incomplete
2747    29 facility rejected                    501 Not implemented
2748    31 normal unspecified                   480 Temporarily unavailable
2749 \endverbatim
2750 */
2751 static const char *hangup_cause2sip(int cause)
2752 {
2753         switch (cause) {
2754                 case AST_CAUSE_UNALLOCATED:             /* 1 */
2755                 case AST_CAUSE_NO_ROUTE_DESTINATION:    /* 3 IAX2: Can't find extension in context */
2756                 case AST_CAUSE_NO_ROUTE_TRANSIT_NET:    /* 2 */
2757                         return "404 Not Found";
2758                 case AST_CAUSE_CONGESTION:              /* 34 */
2759                 case AST_CAUSE_SWITCH_CONGESTION:       /* 42 */
2760                         return "503 Service Unavailable";
2761                 case AST_CAUSE_NO_USER_RESPONSE:        /* 18 */
2762                         return "408 Request Timeout";
2763                 case AST_CAUSE_NO_ANSWER:               /* 19 */
2764                         return "480 Temporarily unavailable";
2765                 case AST_CAUSE_CALL_REJECTED:           /* 21 */
2766                         return "403 Forbidden";
2767                 case AST_CAUSE_NUMBER_CHANGED:          /* 22 */
2768                         return "410 Gone";
2769                 case AST_CAUSE_NORMAL_UNSPECIFIED:      /* 31 */
2770                         return "480 Temporarily unavailable";
2771                 case AST_CAUSE_INVALID_NUMBER_FORMAT:
2772                         return "484 Address incomplete";
2773                 case AST_CAUSE_USER_BUSY:
2774                         return "486 Busy here";
2775                 case AST_CAUSE_FAILURE:
2776                         return "500 Server internal failure";
2777                 case AST_CAUSE_FACILITY_REJECTED:       /* 29 */
2778                         return "501 Not Implemented";
2779                 case AST_CAUSE_CHAN_NOT_IMPLEMENTED:
2780                         return "503 Service Unavailable";
2781                 /* Used in chan_iax2 */
2782                 case AST_CAUSE_DESTINATION_OUT_OF_ORDER:
2783                         return "502 Bad Gateway";
2784                 case AST_CAUSE_BEARERCAPABILITY_NOTAVAIL:       /* Can't find codec to connect to host */
2785                         return "488 Not Acceptable Here";
2786
2787                 case AST_CAUSE_NOTDEFINED:
2788                 default:
2789                         ast_log(LOG_DEBUG, "AST hangup cause %d (no match found in SIP)\n", cause);
2790                         return NULL;
2791         }
2792
2793         /* Never reached */
2794         return 0;
2795 }
2796
2797
2798 /*! \brief  sip_hangup: Hangup SIP call
2799  * Part of PBX interface, called from ast_hangup */
2800 static int sip_hangup(struct ast_channel *ast)
2801 {
2802         struct sip_pvt *p = ast->tech_pvt;
2803         int needcancel = FALSE;
2804         struct ast_flags locflags = {0};
2805
2806         if (!p) {
2807                 ast_log(LOG_DEBUG, "Asked to hangup channel that was not connected\n");
2808                 return 0;
2809         }
2810         if (option_debug && sipdebug)
2811                 ast_log(LOG_DEBUG, "Hangup call %s, SIP callid %s)\n", ast->name, p->callid);
2812
2813         ast_mutex_lock(&p->lock);
2814         if (option_debug && sipdebug)
2815                 ast_log(LOG_DEBUG, "update_call_counter(%s) - decrement call limit counter on hangup\n", p->username);
2816         update_call_counter(p, DEC_CALL_LIMIT);
2817         /* Determine how to disconnect */
2818         if (p->owner != ast) {
2819                 ast_log(LOG_WARNING, "Huh?  We aren't the owner? Can't hangup call.\n");
2820                 ast_mutex_unlock(&p->lock);
2821                 return 0;
2822         }
2823         /* If the call is not UP, we need to send CANCEL instead of BYE */
2824         if (ast->_state != AST_STATE_UP)
2825                 needcancel = TRUE;
2826
2827         /* Disconnect */
2828         p = ast->tech_pvt;
2829         if (p->vad)
2830                 ast_dsp_free(p->vad);
2831
2832         p->owner = NULL;
2833         ast->tech_pvt = NULL;
2834
2835         ast_mutex_lock(&usecnt_lock);
2836         usecnt--;
2837         ast_mutex_unlock(&usecnt_lock);
2838         ast_update_use_count();
2839
2840         ast_set_flag(&locflags, SIP_NEEDDESTROY);
2841
2842         /* Start the process if it's not already started */
2843         if (!ast_test_flag(&p->flags[0], SIP_ALREADYGONE) && !ast_strlen_zero(p->initreq.data)) {
2844                 if (needcancel) {       /* Outgoing call, not up */
2845                         if (ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2846                                 /* stop retransmitting an INVITE that has not received a response */
2847                                 __sip_pretend_ack(p);
2848
2849                                 /* Send a new request: CANCEL */
2850                                 transmit_request_with_auth(p, SIP_CANCEL, p->ocseq, XMIT_RELIABLE, FALSE);
2851                                 /* Actually don't destroy us yet, wait for the 487 on our original
2852                                    INVITE, but do set an autodestruct just in case we never get it. */
2853                                 ast_clear_flag(&locflags, SIP_NEEDDESTROY);
2854
2855                                 sip_scheddestroy(p, SIP_TRANS_TIMEOUT);
2856                                 if ( p->initid != -1 ) {
2857                                         /* channel still up - reverse dec of inUse counter
2858                                            only if the channel is not auto-congested */
2859                                         update_call_counter(p, INC_CALL_LIMIT);
2860                                 }
2861                         } else {        /* Incoming call, not up */
2862                                 const char *res;
2863                                 if (ast->hangupcause && (res = hangup_cause2sip(ast->hangupcause)))
2864                                         transmit_response_reliable(p, res, &p->initreq);
2865                                 else
2866                                         transmit_response_reliable(p, "603 Declined", &p->initreq);
2867                         }
2868                 } else {        /* Call is in UP state, send BYE */
2869                         if (!p->pendinginvite) {
2870                                 /* Send a hangup */
2871                                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2872                         } else {
2873                                 /* Note we will need a BYE when this all settles out
2874                                    but we can't send one while we have "INVITE" outstanding. */
2875                                 ast_set_flag(&p->flags[0], SIP_PENDINGBYE);
2876                                 ast_clear_flag(&p->flags[0], SIP_NEEDREINVITE);
2877                         }
2878                 }
2879         }
2880         ast_copy_flags(&p->flags[0], &locflags, SIP_NEEDDESTROY);
2881         ast_mutex_unlock(&p->lock);
2882         return 0;
2883 }
2884
2885 /*! \brief Try setting codec suggested by the SIP_CODEC channel variable */
2886 static void try_suggested_sip_codec(struct sip_pvt *p)
2887 {
2888         int fmt;
2889         const char *codec;
2890
2891         codec = pbx_builtin_getvar_helper(p->owner, "SIP_CODEC");
2892         if (!codec)
2893                 return;
2894
2895         fmt = ast_getformatbyname(codec);
2896         if (fmt) {
2897                 ast_log(LOG_NOTICE, "Changing codec to '%s' for this call because of ${SIP_CODEC) variable\n", codec);
2898                 if (p->jointcapability & fmt) {
2899                         p->jointcapability &= fmt;
2900                         p->capability &= fmt;
2901                 } else
2902                         ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because it is not shared by both ends.\n");
2903         } else
2904                 ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because of unrecognized/not configured codec (check allow/disallow in sip.conf): %s\n", codec);
2905         return;
2906 }
2907
2908 /*! \brief  sip_answer: Answer SIP call , send 200 OK on Invite
2909  * Part of PBX interface */
2910 static int sip_answer(struct ast_channel *ast)
2911 {
2912         int res = 0;
2913         struct sip_pvt *p = ast->tech_pvt;
2914
2915         ast_mutex_lock(&p->lock);
2916         if (ast->_state != AST_STATE_UP) {
2917                 try_suggested_sip_codec(p);
2918
2919                 ast_setstate(ast, AST_STATE_UP);
2920                 if (option_debug)
2921                         ast_log(LOG_DEBUG, "SIP answering channel: %s\n", ast->name);
2922                 res = transmit_response_with_sdp(p, "200 OK", &p->initreq, XMIT_CRITICAL);
2923         }
2924         ast_mutex_unlock(&p->lock);
2925         return res;
2926 }
2927
2928 /*! \brief Send frame to media channel (rtp) */
2929 static int sip_write(struct ast_channel *ast, struct ast_frame *frame)
2930 {
2931         struct sip_pvt *p = ast->tech_pvt;
2932         int res = 0;
2933
2934         switch (frame->frametype) {
2935         case AST_FRAME_VOICE:
2936                 if (!(frame->subclass & ast->nativeformats)) {
2937                         ast_log(LOG_WARNING, "Asked to transmit frame type %d, while native formats is %d (read/write = %d/%d)\n",
2938                                 frame->subclass, ast->nativeformats, ast->readformat, ast->writeformat);
2939                         return 0;
2940                 }
2941                 if (p) {
2942                         ast_mutex_lock(&p->lock);
2943                         if (p->rtp) {
2944                                 /* If channel is not up, activate early media session */
2945                                 if ((ast->_state != AST_STATE_UP) &&
2946                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2947                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2948                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2949                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
2950                                 }
2951                                 time(&p->lastrtptx);
2952                                 res =  ast_rtp_write(p->rtp, frame);
2953                         }
2954                         ast_mutex_unlock(&p->lock);
2955                 }
2956                 break;
2957         case AST_FRAME_VIDEO:
2958                 if (p) {
2959                         ast_mutex_lock(&p->lock);
2960                         if (p->vrtp) {
2961                                 /* Activate video early media */
2962                                 if ((ast->_state != AST_STATE_UP) &&
2963                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2964                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2965                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2966                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
2967                                 }
2968                                 time(&p->lastrtptx);
2969                                 res =  ast_rtp_write(p->vrtp, frame);
2970                         }
2971                         ast_mutex_unlock(&p->lock);
2972                 }
2973                 break;
2974         case AST_FRAME_IMAGE:
2975                 return 0;
2976                 break;
2977         default:
2978                 ast_log(LOG_WARNING, "Can't send %d type frames with SIP write\n", frame->frametype);
2979                 return 0;
2980         }
2981
2982         return res;
2983 }
2984
2985 /*! \brief  sip_fixup: Fix up a channel:  If a channel is consumed, this is called.
2986         Basically update any ->owner links */
2987 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
2988 {
2989         int ret = -1;
2990         struct sip_pvt *p;
2991
2992         if (!newchan || !newchan->tech_pvt) {
2993                 ast_log(LOG_WARNING, "No SIP tech_pvt! Fixup of %s failed.\n", oldchan->name);
2994                 return -1;
2995         }
2996         p = newchan->tech_pvt;
2997
2998         ast_mutex_lock(&p->lock);
2999         append_history(p, "Masq", "Old channel: %s\n", oldchan->name);
3000         append_history(p, "Masq (cont)", "...new owner: %s\n", p->owner->name);
3001         if (p->owner != oldchan)
3002                 ast_log(LOG_WARNING, "old channel wasn't %p but was %p\n", oldchan, p->owner);
3003         else {
3004                 p->owner = newchan;
3005                 ret = 0;
3006         }
3007         ast_mutex_unlock(&p->lock);
3008         return ret;
3009 }
3010
3011 /*! \brief Send DTMF character on SIP channel
3012         within one call, we're able to transmit in many methods simultaneously */
3013 static int sip_senddigit(struct ast_channel *ast, char digit)
3014 {
3015         struct sip_pvt *p = ast->tech_pvt;
3016         int res = 0;
3017
3018         ast_mutex_lock(&p->lock);
3019         switch (ast_test_flag(&p->flags[0], SIP_DTMF)) {
3020         case SIP_DTMF_INFO:
3021                 transmit_info_with_digit(p, digit);
3022                 break;
3023         case SIP_DTMF_RFC2833:
3024                 if (p->rtp)
3025                         ast_rtp_senddigit(p->rtp, digit);
3026                 break;
3027         case SIP_DTMF_INBAND:
3028                 res = -1;
3029                 break;
3030         }
3031         ast_mutex_unlock(&p->lock);
3032         return res;
3033 }