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