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