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