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