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