4d6463780d59733764243dfc184859b797eaf9e1
[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  * \todo VIA branch tag transaction checking
36  * \todo Transaction support
37  *
38  * \ingroup channel_drivers
39  *
40  * \par Overview of the handling of SIP sessions
41  * The SIP channel handles several types of SIP sessions, or dialogs,
42  * not all of them being "telephone calls".
43  * - Incoming calls that will be sent to the PBX core
44  * - Outgoing calls, generated by the PBX
45  * - SIP subscriptions and notifications of states and voicemail messages
46  * - SIP registrations, both inbound and outbound
47  * - SIP peer management (peerpoke, OPTIONS)
48  * - SIP text messages
49  *
50  * In the SIP channel, there's a list of active SIP dialogs, which includes
51  * all of these when they are active. "sip show channels" in the CLI will
52  * show most of these, excluding subscriptions which are shown by
53  * "sip show subscriptions"
54  *
55  * \par incoming packets
56  * Incoming packets are received in the monitoring thread, then handled by
57  * sipsock_read(). This function parses the packet and matches an existing
58  * dialog or starts a new SIP dialog.
59  * 
60  * sipsock_read sends the packet to handle_request(), that parses a bit more.
61  * if it's a response to an outbound request, it's sent to handle_response().
62  * If it is a request, handle_request sends it to one of a list of functions
63  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
64  * sipsock_read locks the ast_channel if it exists (an active call) and
65  * unlocks it after we have processed the SIP message.
66  *
67  * A new INVITE is sent to handle_request_invite(), that will end up
68  * starting a new channel in the PBX, the new channel after that executing
69  * in a separate channel thread. This is an incoming "call".
70  * When the call is answered, either by a bridged channel or the PBX itself
71  * the sip_answer() function is called.
72  *
73  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
74  * in rtp.c 
75  * 
76  * \par Outbound calls
77  * Outbound calls are set up by the PBX through the sip_request_call()
78  * function. After that, they are activated by sip_call().
79  * 
80  * \par Hanging up
81  * The PBX issues a hangup on both incoming and outgoing calls through
82  * the sip_hangup() function
83  */
84
85
86 #include "asterisk.h"
87
88 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
89
90 #include <stdio.h>
91 #include <ctype.h>
92 #include <string.h>
93 #include <unistd.h>
94 #include <sys/socket.h>
95 #include <sys/ioctl.h>
96 #include <net/if.h>
97 #include <errno.h>
98 #include <stdlib.h>
99 #include <fcntl.h>
100 #include <netdb.h>
101 #include <signal.h>
102 #include <sys/signal.h>
103 #include <netinet/in.h>
104 #include <netinet/in_systm.h>
105 #include <arpa/inet.h>
106 #include <netinet/ip.h>
107 #include <regex.h>
108
109 #include "asterisk/lock.h"
110 #include "asterisk/channel.h"
111 #include "asterisk/config.h"
112 #include "asterisk/logger.h"
113 #include "asterisk/module.h"
114 #include "asterisk/pbx.h"
115 #include "asterisk/options.h"
116 #include "asterisk/lock.h"
117 #include "asterisk/sched.h"
118 #include "asterisk/io.h"
119 #include "asterisk/rtp.h"
120 #include "asterisk/udptl.h"
121 #include "asterisk/acl.h"
122 #include "asterisk/manager.h"
123 #include "asterisk/callerid.h"
124 #include "asterisk/cli.h"
125 #include "asterisk/app.h"
126 #include "asterisk/musiconhold.h"
127 #include "asterisk/dsp.h"
128 #include "asterisk/features.h"
129 #include "asterisk/acl.h"
130 #include "asterisk/srv.h"
131 #include "asterisk/astdb.h"
132 #include "asterisk/causes.h"
133 #include "asterisk/utils.h"
134 #include "asterisk/file.h"
135 #include "asterisk/astobj.h"
136 #include "asterisk/dnsmgr.h"
137 #include "asterisk/devicestate.h"
138 #include "asterisk/linkedlists.h"
139 #include "asterisk/stringfields.h"
140 #include "asterisk/monitor.h"
141 #include "asterisk/localtime.h"
142 #include "asterisk/abstract_jb.h"
143 #include "asterisk/compiler.h"
144 #include "asterisk/threadstorage.h"
145 #include "asterisk/translate.h"
146
147 #ifndef FALSE
148 #define FALSE    0
149 #endif
150
151 #ifndef TRUE
152 #define TRUE     1
153 #endif
154
155 #define VIDEO_CODEC_MASK        0x1fc0000 /*!< Video codecs from H.261 thru AST_FORMAT_MAX_VIDEO */
156 #ifndef IPTOS_MINCOST
157 #define IPTOS_MINCOST           0x02
158 #endif
159
160 /* #define VOCAL_DATA_HACK */
161
162 #define DEFAULT_DEFAULT_EXPIRY  120
163 #define DEFAULT_MIN_EXPIRY      60
164 #define DEFAULT_MAX_EXPIRY      3600
165 #define DEFAULT_REGISTRATION_TIMEOUT 20
166 #define DEFAULT_MAX_FORWARDS    "70"
167
168 /* guard limit must be larger than guard secs */
169 /* guard min must be < 1000, and should be >= 250 */
170 #define EXPIRY_GUARD_SECS       15                /*!< How long before expiry do we reregister */
171 #define EXPIRY_GUARD_LIMIT      30                /*!< Below here, we use EXPIRY_GUARD_PCT instead of 
172                                                    EXPIRY_GUARD_SECS */
173 #define EXPIRY_GUARD_MIN        500                /*!< This is the minimum guard time applied. If 
174                                                    GUARD_PCT turns out to be lower than this, it 
175                                                    will use this time instead.
176                                                    This is in milliseconds. */
177 #define EXPIRY_GUARD_PCT        0.20                /*!< Percentage of expires timeout to use when 
178                                                     below EXPIRY_GUARD_LIMIT */
179 #define DEFAULT_EXPIRY 900                          /*!< Expire slowly */
180
181 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
182 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
183 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
184 static int expiry = DEFAULT_EXPIRY;
185
186 #ifndef MAX
187 #define MAX(a,b) ((a) > (b) ? (a) : (b))
188 #endif
189
190 #define CALLERID_UNKNOWN        "Unknown"
191
192 #define DEFAULT_MAXMS                2000             /*!< Qualification: Must be faster than 2 seconds by default */
193 #define DEFAULT_FREQ_OK              60 * 1000        /*!< Qualification: How often to check for the host to be up */
194 #define DEFAULT_FREQ_NOTOK           10 * 1000        /*!< Qualification: How often to check, if the host is down... */
195
196 #define DEFAULT_RETRANS              1000             /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
197 #define MAX_RETRANS                  6                /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
198 #define SIP_TRANS_TIMEOUT            32000            /*!< SIP request timeout (rfc 3261) 64*T1 
199                                                       \todo Use known T1 for timeout (peerpoke)
200                                                       */
201 #define DEFAULT_TRANS_TIMEOUT        -1               /* Use default SIP transaction timeout */
202 #define MAX_AUTHTRIES                3                /*!< Try authentication three times, then fail */
203
204 #define SIP_MAX_HEADERS              64               /*!< Max amount of SIP headers to read */
205 #define SIP_MAX_LINES                64               /*!< Max amount of lines in SIP attachment (like SDP) */
206 #define SIP_MAX_PACKET               4096             /*!< Also from RFC 3261 (2543), should sub headers tho */
207
208 #define INITIAL_CSEQ                 101              /*!< our initial sip sequence number */
209
210 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
211 static struct ast_jb_conf default_jbconf =
212 {
213         .flags = 0,
214         .max_size = -1,
215         .resync_threshold = -1,
216         .impl = ""
217 };
218 static struct ast_jb_conf global_jbconf;
219
220 static const char config[] = "sip.conf";
221 static const char notify_config[] = "sip_notify.conf";
222 static int usecnt = 0;
223
224
225 #define RTP     1
226 #define NO_RTP  0
227
228 /*! \brief Authorization scheme for call transfers 
229 \note Not a bitfield flag, since there are plans for other modes,
230         like "only allow transfers for authenticated devices" */
231 enum transfermodes {
232         TRANSFER_OPENFORALL,            /*!< Allow all SIP transfers */
233         TRANSFER_CLOSED,                /*!< Allow no SIP transfers */
234 };
235
236
237 enum sip_result {
238         AST_SUCCESS = 0,
239         AST_FAILURE = -1,
240 };
241
242 /* Do _NOT_ make any changes to this enum, or the array following it;
243    if you think you are doing the right thing, you are probably
244    not doing the right thing. If you think there are changes
245    needed, get someone else to review them first _before_
246    submitting a patch. If these two lists do not match properly
247    bad things will happen.
248 */
249
250 enum xmittype {
251         XMIT_CRITICAL = 2,              /*!< Transmit critical SIP message reliably, with re-transmits.
252                                               If it fails, it's critical and will cause a teardown of the session */
253         XMIT_RELIABLE = 1,              /*!< Transmit SIP message reliably, with re-transmits */
254         XMIT_UNRELIABLE = 0,            /*!< Transmit SIP message without bothering with re-transmits */
255 };
256
257 enum parse_register_result {
258         PARSE_REGISTER_FAILED,
259         PARSE_REGISTER_UPDATE,
260         PARSE_REGISTER_QUERY,
261 };
262
263 enum subscriptiontype { 
264         NONE = 0,
265         TIMEOUT,
266         XPIDF_XML,
267         DIALOG_INFO_XML,
268         CPIM_PIDF_XML,
269         PIDF_XML,
270         MWI_NOTIFICATION
271 };
272
273 static const struct cfsubscription_types {
274         enum subscriptiontype type;
275         const char * const event;
276         const char * const mediatype;
277         const char * const text;
278 } subscription_types[] = {
279         { NONE,            "-",        "unknown",                    "unknown" },
280         /* RFC 4235: SIP Dialog event package */
281         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
282         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
283         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
284         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
285         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
286 };
287
288 /*! \brief SIP Request methods known by Asterisk */
289 enum sipmethod {
290         SIP_UNKNOWN,            /* Unknown response */
291         SIP_RESPONSE,           /* Not request, response to outbound request */
292         SIP_REGISTER,
293         SIP_OPTIONS,
294         SIP_NOTIFY,
295         SIP_INVITE,
296         SIP_ACK,
297         SIP_PRACK,              /* Not supported at all */
298         SIP_BYE,
299         SIP_REFER,
300         SIP_SUBSCRIBE,
301         SIP_MESSAGE,
302         SIP_UPDATE,             /* We can send UPDATE; but not accept it */
303         SIP_INFO,
304         SIP_CANCEL,
305         SIP_PUBLISH,            /* Not supported at all */
306         SIP_PING,               /* Not supported at all, no standard but still implemented out there */
307 };
308
309 /*! \brief Authentication types - proxy or www authentication 
310         \note Endpoints, like Asterisk, should always use WWW authentication to
311         allow multiple authentications in the same call - to the proxy and
312         to the end point.
313 */
314 enum sip_auth_type {
315         PROXY_AUTH = 407,
316         WWW_AUTH = 401,
317 };
318
319 /*! \brief Authentication result from check_auth* functions */
320 enum check_auth_result {
321         AUTH_DONT_KNOW = -100,  /*!< no result, need to check further */
322                 /* XXX maybe this is the same as AUTH_NOT_FOUND */
323
324         AUTH_SUCCESSFUL = 0,
325         AUTH_CHALLENGE_SENT = 1,
326         AUTH_SECRET_FAILED = -1,
327         AUTH_USERNAME_MISMATCH = -2,
328         AUTH_NOT_FOUND = -3,    /* returned by register_verify */
329         AUTH_FAKE_AUTH = -4,
330         AUTH_UNKNOWN_DOMAIN = -5,
331 };
332
333 /*! \brief States for outbound registrations (with register= lines in sip.conf */
334 enum sipregistrystate {
335         REG_STATE_UNREGISTERED = 0,     /*!< We are not registred */
336         REG_STATE_REGSENT,      /*!< Registration request sent */
337         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate */
338         REG_STATE_REGISTERED,   /*!< Registred and done */
339         REG_STATE_REJECTED,     /*!< Registration rejected */
340         REG_STATE_TIMEOUT,      /*!< Registration timed out */
341         REG_STATE_NOAUTH,       /*!< We have no accepted credentials */
342         REG_STATE_FAILED,       /*!< Registration failed after several tries */
343 };
344
345 enum can_create_dialog {
346         CAN_NOT_CREATE_DIALOG,
347         CAN_CREATE_DIALOG,
348         CAN_CREATE_DIALOG_UNSUPPORTED_METHOD,
349 };
350
351 /*! XXX Note that sip_methods[i].id == i must hold or the code breaks */
352 static const struct  cfsip_methods { 
353         enum sipmethod id;
354         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
355         char * const text;
356         enum can_create_dialog can_create;
357 } sip_methods[] = {
358         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",   CAN_CREATE_DIALOG },
359         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",     CAN_NOT_CREATE_DIALOG },
360         { SIP_REGISTER,  NO_RTP, "REGISTER",    CAN_CREATE_DIALOG },
361         { SIP_OPTIONS,   NO_RTP, "OPTIONS",     CAN_CREATE_DIALOG },
362         { SIP_NOTIFY,    NO_RTP, "NOTIFY",      CAN_CREATE_DIALOG },
363         { SIP_INVITE,    RTP,    "INVITE",      CAN_CREATE_DIALOG },
364         { SIP_ACK,       NO_RTP, "ACK",         CAN_NOT_CREATE_DIALOG },
365         { SIP_PRACK,     NO_RTP, "PRACK",       CAN_NOT_CREATE_DIALOG },
366         { SIP_BYE,       NO_RTP, "BYE",         CAN_NOT_CREATE_DIALOG },
367         { SIP_REFER,     NO_RTP, "REFER",       CAN_CREATE_DIALOG },
368         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",   CAN_CREATE_DIALOG },
369         { SIP_MESSAGE,   NO_RTP, "MESSAGE",     CAN_CREATE_DIALOG },
370         { SIP_UPDATE,    NO_RTP, "UPDATE",      CAN_NOT_CREATE_DIALOG },
371         { SIP_INFO,      NO_RTP, "INFO",        CAN_NOT_CREATE_DIALOG },
372         { SIP_CANCEL,    NO_RTP, "CANCEL",      CAN_NOT_CREATE_DIALOG },
373         { SIP_PUBLISH,   NO_RTP, "PUBLISH",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD },
374         { SIP_PING,      NO_RTP, "PING",        CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
375 };
376
377 /*!  Define SIP option tags, used in Require: and Supported: headers 
378         We need to be aware of these properties in the phones to use 
379         the replace: header. We should not do that without knowing
380         that the other end supports it... 
381         This is nothing we can configure, we learn by the dialog
382         Supported: header on the REGISTER (peer) or the INVITE
383         (other devices)
384         We are not using many of these today, but will in the future.
385         This is documented in RFC 3261
386 */
387 #define SUPPORTED               1
388 #define NOT_SUPPORTED           0
389
390 #define SIP_OPT_REPLACES        (1 << 0)
391 #define SIP_OPT_100REL          (1 << 1)
392 #define SIP_OPT_TIMER           (1 << 2)
393 #define SIP_OPT_EARLY_SESSION   (1 << 3)
394 #define SIP_OPT_JOIN            (1 << 4)
395 #define SIP_OPT_PATH            (1 << 5)
396 #define SIP_OPT_PREF            (1 << 6)
397 #define SIP_OPT_PRECONDITION    (1 << 7)
398 #define SIP_OPT_PRIVACY         (1 << 8)
399 #define SIP_OPT_SDP_ANAT        (1 << 9)
400 #define SIP_OPT_SEC_AGREE       (1 << 10)
401 #define SIP_OPT_EVENTLIST       (1 << 11)
402 #define SIP_OPT_GRUU            (1 << 12)
403 #define SIP_OPT_TARGET_DIALOG   (1 << 13)
404 #define SIP_OPT_NOREFERSUB      (1 << 14)
405 #define SIP_OPT_HISTINFO        (1 << 15)
406 #define SIP_OPT_RESPRIORITY     (1 << 16)
407
408 /*! \brief List of well-known SIP options. If we get this in a require,
409    we should check the list and answer accordingly. */
410 static const struct cfsip_options {
411         int id;                 /*!< Bitmap ID */
412         int supported;          /*!< Supported by Asterisk ? */
413         char * const text;      /*!< Text id, as in standard */
414 } sip_options[] = {     /* XXX used in 3 places */
415         /* RFC3891: Replaces: header for transfer */
416         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },   
417         /* One version of Polycom firmware has the wrong label */
418         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },    
419         /* RFC3262: PRACK 100% reliability */
420         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },     
421         /* RFC4028: SIP Session Timers */
422         { SIP_OPT_TIMER,        NOT_SUPPORTED,  "timer" },
423         /* RFC3959: SIP Early session support */
424         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
425         /* RFC3911: SIP Join header support */
426         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
427         /* RFC3327: Path support */
428         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
429         /* RFC3840: Callee preferences */
430         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
431         /* RFC3312: Precondition support */
432         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
433         /* RFC3323: Privacy with proxies*/
434         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
435         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
436         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
437         /* RFC3329: Security agreement mechanism */
438         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
439         /* SIMPLE events:  draft-ietf-simple-event-list-07.txt */
440         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
441         /* GRUU: Globally Routable User Agent URI's */
442         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
443         /* Target-dialog: draft-ietf-sip-target-dialog-03.txt */
444         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
445         /* Disable the REFER subscription, RFC 4488 */
446         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
447         /* ietf-sip-history-info-06.txt */
448         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
449         /* ietf-sip-resource-priority-10.txt */
450         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
451 };
452
453
454 /*! \brief SIP Methods we support */
455 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY"
456
457 /*! \brief SIP Extensions we support */
458 #define SUPPORTED_EXTENSIONS "replaces" 
459
460 /*! \brief Standard SIP port from RFC 3261. DO NOT CHANGE THIS */
461 #define STANDARD_SIP_PORT       5060
462 /* Note: in many SIP headers, absence of a port number implies port 5060,
463  * and this is why we cannot change the above constant.
464  * There is a limited number of places in asterisk where we could,
465  * in principle, use a different "default" port number, but
466  * we do not support this feature at the moment.
467  */
468
469 /* Default values, set and reset in reload_config before reading configuration */
470 /* These are default values in the source. There are other recommended values in the
471    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
472    yet encouraging new behaviour on new installations 
473  */
474 #define DEFAULT_CONTEXT         "default"
475 #define DEFAULT_MOHINTERPRET    "default"
476 #define DEFAULT_MOHSUGGEST      ""
477 #define DEFAULT_VMEXTEN         "asterisk"
478 #define DEFAULT_CALLERID        "asterisk"
479 #define DEFAULT_NOTIFYMIME      "application/simple-message-summary"
480 #define DEFAULT_MWITIME         10
481 #define DEFAULT_ALLOWGUEST      TRUE
482 #define DEFAULT_SRVLOOKUP       FALSE           /*!< Recommended setting is ON */
483 #define DEFAULT_COMPACTHEADERS  FALSE
484 #define DEFAULT_TOS_SIP         0               /*!< Call signalling packets should be marked as DSCP CS3, but the default is 0 to be compatible with previous versions. */
485 #define DEFAULT_TOS_AUDIO       0               /*!< Audio packets should be marked as DSCP EF (Expedited Forwarding), but the default is 0 to be compatible with previous versions. */
486 #define DEFAULT_TOS_VIDEO       0               /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
487 #define DEFAULT_ALLOW_EXT_DOM   TRUE
488 #define DEFAULT_REALM           "asterisk"
489 #define DEFAULT_NOTIFYRINGING   TRUE
490 #define DEFAULT_PEDANTIC        FALSE
491 #define DEFAULT_AUTOCREATEPEER  FALSE
492 #define DEFAULT_QUALIFY         FALSE
493 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
494 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
495 #ifndef DEFAULT_USERAGENT
496 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
497 #endif
498
499
500 /* Default setttings are used as a channel setting and as a default when
501    configuring devices */
502 static char default_context[AST_MAX_CONTEXT];
503 static char default_subscribecontext[AST_MAX_CONTEXT];
504 static char default_language[MAX_LANGUAGE];
505 static char default_callerid[AST_MAX_EXTENSION];
506 static char default_fromdomain[AST_MAX_EXTENSION];
507 static char default_notifymime[AST_MAX_EXTENSION];
508 static int default_qualify;             /*!< Default Qualify= setting */
509 static char default_vmexten[AST_MAX_EXTENSION];
510 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
511 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting 
512                                                     *   a bridged channel on hold */
513 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
514 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
515
516 /* Global settings only apply to the channel */
517 static int global_rtautoclear;
518 static int global_notifyringing;        /*!< Send notifications on ringing */
519 static int global_alwaysauthreject;     /*!< Send 401 Unauthorized for all failing requests */
520 static int srvlookup;                   /*!< SRV Lookup on or off. Default is off, RFC behavior is on */
521 static int pedanticsipchecking;         /*!< Extra checking ?  Default off */
522 static int autocreatepeer;              /*!< Auto creation of peers at registration? Default off. */
523 static int match_auth_username;         /*!< Match auth username if available instead of From: Default off. */
524 static int global_relaxdtmf;                    /*!< Relax DTMF */
525 static int global_rtptimeout;           /*!< Time out call if no RTP */
526 static int global_rtpholdtimeout;
527 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
528 static int global_reg_timeout;  
529 static int global_regattempts_max;      /*!< Registration attempts before giving up */
530 static int global_allowguest;           /*!< allow unauthenticated users/peers to connect? */
531 static int global_allowsubscribe;       /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE 
532                                             the global setting is in globals_flags[1] */
533 static int global_mwitime;              /*!< Time between MWI checks for peers */
534 static unsigned int global_tos_sip;             /*!< IP type of service for SIP packets */
535 static unsigned int global_tos_audio;           /*!< IP type of service for audio RTP packets */
536 static unsigned int global_tos_video;           /*!< IP type of service for video RTP packets */
537 static int compactheaders;              /*!< send compact sip headers */
538 static int recordhistory;               /*!< Record SIP history. Off by default */
539 static int dumphistory;                 /*!< Dump history to verbose before destroying SIP dialog */
540 static char global_realm[MAXHOSTNAMELEN];               /*!< Default realm */
541 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
542 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
543 static int allow_external_domains;      /*!< Accept calls to external SIP domains? */
544 static int global_callevents;           /*!< Whether we send manager events or not */
545 static int global_t1min;                /*!< T1 roundtrip time minimum */
546 static int global_autoframing;          /*!< ?????????? */
547 static enum transfermodes global_allowtransfer; /*!< SIP Refer restriction scheme */
548
549 /*! \brief Codecs that we support by default: */
550 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
551 static int noncodeccapability = AST_RTP_DTMF;
552
553 /* Object counters */
554 static int suserobjs = 0;                /*!< Static users */
555 static int ruserobjs = 0;                /*!< Realtime users */
556 static int speerobjs = 0;                /*!< Statis peers */
557 static int rpeerobjs = 0;                /*!< Realtime peers */
558 static int apeerobjs = 0;                /*!< Autocreated peer objects */
559 static int regobjs = 0;                  /*!< Registry objects */
560
561 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
562
563 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
564 AST_MUTEX_DEFINE_STATIC(dialoglock);
565
566 AST_MUTEX_DEFINE_STATIC(netlock);
567
568 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
569    when it's doing something critical. */
570
571 AST_MUTEX_DEFINE_STATIC(monlock);
572
573 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
574
575 /*! \brief This is the thread for the monitor which checks for input on the channels
576    which are not currently in use.  */
577 static pthread_t monitor_thread = AST_PTHREADT_NULL;
578
579 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
580 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
581
582 static struct sched_context *sched;     /*!< The scheduling context */
583 static struct io_context *io;           /*!< The IO context */
584 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
585
586 #define DEC_CALL_LIMIT  0
587 #define INC_CALL_LIMIT  1
588 #define DEC_CALL_RINGING 2
589 #define INC_CALL_RINGING 3
590
591 /*! \brief sip_request: The data grabbed from the UDP socket */
592 struct sip_request {
593         char *rlPart1;          /*!< SIP Method Name or "SIP/2.0" protocol version */
594         char *rlPart2;          /*!< The Request URI or Response Status */
595         int len;                /*!< Length */
596         int headers;            /*!< # of SIP Headers */
597         int method;             /*!< Method of this request */
598         int lines;              /*!< Body Content */
599         unsigned int flags;     /*!< SIP_PKT Flags for this packet */
600         char *header[SIP_MAX_HEADERS];
601         char *line[SIP_MAX_LINES];
602         char data[SIP_MAX_PACKET];
603         unsigned int sdp_start; /*!< the line number where the SDP begins */
604         unsigned int sdp_end;   /*!< the line number where the SDP ends */
605 };
606
607 /*
608  * A sip packet is stored into the data[] buffer, with the header followed
609  * by an empty line and the body of the message.
610  * On outgoing packets, data is accumulated in data[] with len reflecting
611  * the next available byte, headers and lines count the number of lines
612  * in both parts. There are no '\0' in data[0..len-1].
613  *
614  * On received packet, the input read from the socket is copied into data[],
615  * len is set and the string is NUL-terminated. Then a parser fills up
616  * the other fields -header[] and line[] to point to the lines of the
617  * message, rlPart1 and rlPart2 parse the first lnie as below:
618  *
619  * Requests have in the first line      METHOD URI SIP/2.0
620  *      rlPart1 = method; rlPart2 = uri;
621  * Responses have in the first line     SIP/2.0 code description
622  *      rlPart1 = SIP/2.0; rlPart2 = code + description;
623  *
624  */
625
626 /*! \brief structure used in transfers */
627 struct sip_dual {
628         struct ast_channel *chan1;      /*!< First channel involved */
629         struct ast_channel *chan2;      /*!< Second channel involved */
630         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
631         int seqno;                      /*!< Sequence number */
632 };
633
634 struct sip_pkt;
635
636 /*! \brief Parameters to the transmit_invite function */
637 struct sip_invite_param {
638         int addsipheaders;              /*!< Add extra SIP headers */
639         const char *uri_options;        /*!< URI options to add to the URI */
640         const char *vxml_url;           /*!< VXML url for Cisco phones */
641         char *auth;                     /*!< Authentication */
642         char *authheader;               /*!< Auth header */
643         enum sip_auth_type auth_type;   /*!< Authentication type */
644         const char *replaces;           /*!< Replaces header for call transfers */
645         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
646 };
647
648 /*! \brief Structure to save routing information for a SIP session */
649 struct sip_route {
650         struct sip_route *next;
651         char hop[0];
652 };
653
654 /*! \brief Modes for SIP domain handling in the PBX */
655 enum domain_mode {
656         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
657         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
658 };
659
660 /*! \brief Domain data structure. 
661         \note In the future, we will connect this to a configuration tree specific
662         for this domain
663 */
664 struct domain {
665         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
666         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
667         enum domain_mode mode;                  /*!< How did we find this domain? */
668         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
669 };
670
671 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
672
673
674 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
675 struct sip_history {
676         AST_LIST_ENTRY(sip_history) list;
677         char event[0];  /* actually more, depending on needs */
678 };
679
680 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
681
682 /*! \brief sip_auth: Creadentials for authentication to other SIP services */
683 struct sip_auth {
684         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
685         char username[256];             /*!< Username */
686         char secret[256];               /*!< Secret */
687         char md5secret[256];            /*!< MD5Secret */
688         struct sip_auth *next;          /*!< Next auth structure in list */
689 };
690
691 /*--- Various flags for the flags field in the pvt structure */
692 #define SIP_ALREADYGONE         (1 << 0)        /*!< Whether or not we've already been destroyed by our peer */
693 #define SIP_NEEDDESTROY         (1 << 1)        /*!< if we need to be destroyed by the monitor thread */
694 #define SIP_NOVIDEO             (1 << 2)        /*!< Didn't get video in invite, don't offer */
695 #define SIP_RINGING             (1 << 3)        /*!< Have sent 180 ringing */
696 #define SIP_PROGRESS_SENT       (1 << 4)        /*!< Have sent 183 message progress */
697 #define SIP_NEEDREINVITE        (1 << 5)        /*!< Do we need to send another reinvite? */
698 #define SIP_PENDINGBYE          (1 << 6)        /*!< Need to send bye after we ack? */
699 #define SIP_GOTREFER            (1 << 7)        /*!< Got a refer? */
700 #define SIP_PROMISCREDIR        (1 << 8)        /*!< Promiscuous redirection */
701 #define SIP_TRUSTRPID           (1 << 9)        /*!< Trust RPID headers? */
702 #define SIP_USEREQPHONE         (1 << 10)       /*!< Add user=phone to numeric URI. Default off */
703 #define SIP_REALTIME            (1 << 11)       /*!< Flag for realtime users */
704 #define SIP_USECLIENTCODE       (1 << 12)       /*!< Trust X-ClientCode info message */
705 #define SIP_OUTGOING            (1 << 13)       /*!< Is this an outgoing call? */
706 #define SIP_CAN_BYE             (1 << 14)       /*!< Can we send BYE on this dialog? */
707 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 15)       /*!< Do not hangup at first ast_hangup */
708 #define SIP_DTMF                (3 << 16)       /*!< DTMF Support: four settings, uses two bits */
709 #define SIP_DTMF_RFC2833        (0 << 16)       /*!< DTMF Support: RTP DTMF - "rfc2833" */
710 #define SIP_DTMF_INBAND         (1 << 16)       /*!< DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
711 #define SIP_DTMF_INFO           (2 << 16)       /*!< DTMF Support: SIP Info messages - "info" */
712 #define SIP_DTMF_AUTO           (3 << 16)       /*!< DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
713 /* NAT settings */
714 #define SIP_NAT                 (3 << 18)       /*!< four settings, uses two bits */
715 #define SIP_NAT_NEVER           (0 << 18)       /*!< No nat support */
716 #define SIP_NAT_RFC3581         (1 << 18)       /*!< NAT RFC3581 */
717 #define SIP_NAT_ROUTE           (2 << 18)       /*!< NAT Only ROUTE */
718 #define SIP_NAT_ALWAYS          (3 << 18)       /*!< NAT Both ROUTE and RFC3581 */
719 /* re-INVITE related settings */
720 #define SIP_REINVITE            (7 << 20)       /*!< three bits used */
721 #define SIP_CAN_REINVITE        (1 << 20)       /*!< allow peers to be reinvited to send media directly p2p */
722 #define SIP_CAN_REINVITE_NAT    (2 << 20)       /*!< allow media reinvite when new peer is behind NAT */
723 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< use UPDATE (RFC3311) when reinviting this peer */
724 /* "insecure" settings */
725 #define SIP_INSECURE_PORT       (1 << 23)       /*!< don't require matching port for incoming requests */
726 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< don't require authentication for incoming INVITEs */
727 /* Sending PROGRESS in-band settings */
728 #define SIP_PROG_INBAND         (3 << 25)       /*!< three settings, uses two bits */
729 #define SIP_PROG_INBAND_NEVER   (0 << 25)
730 #define SIP_PROG_INBAND_NO      (1 << 25)
731 #define SIP_PROG_INBAND_YES     (2 << 25)
732 #define SIP_NO_HISTORY          (1 << 27)       /*!< Suppress recording request/response history */
733 #define SIP_CALL_LIMIT          (1 << 28)       /*!< Call limit enforced for this call */
734 #define SIP_SENDRPID            (1 << 29)       /*!< Remote Party-ID Support */
735 #define SIP_INC_COUNT           (1 << 30)       /*!< Did this connection increment the counter of in-use calls? */
736 #define SIP_G726_NONSTANDARD    (1 << 31)       /*!< Use non-standard packing for G726-32 data */
737
738 #define SIP_FLAGS_TO_COPY \
739         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
740          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT | SIP_G726_NONSTANDARD | \
741          SIP_USEREQPHONE | SIP_INSECURE_PORT | SIP_INSECURE_INVITE)
742
743 /*--- a new page of flags (for flags[1] */
744 /* realtime flags */
745 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)
746 #define SIP_PAGE2_RTUPDATE              (1 << 1)
747 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)
748 #define SIP_PAGE2_RT_FROMCONTACT        (1 << 4)
749 #define SIP_PAGE2_RTSAVE_SYSNAME        (1 << 5)
750 /* Space for addition of other realtime flags in the future */
751 #define SIP_PAGE2_IGNOREREGEXPIRE       (1 << 10)
752 #define SIP_PAGE2_DEBUG                 (3 << 11)
753 #define SIP_PAGE2_DEBUG_CONFIG          (1 << 11)
754 #define SIP_PAGE2_DEBUG_CONSOLE         (1 << 12)
755 #define SIP_PAGE2_DYNAMIC               (1 << 13)       /*!< Dynamic Peers register with Asterisk */
756 #define SIP_PAGE2_SELFDESTRUCT          (1 << 14)       /*!< Automatic peers need to destruct themselves */
757 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 15)
758 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< Allow subscriptions from this peer? */
759 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< Allow overlap dialing ? */
760 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< Only issue MWI notification if subscribed to */
761 #define SIP_PAGE2_INC_RINGING           (1 << 19)       /*!< Did this connection increment the counter of in-use calls? */
762 #define SIP_PAGE2_T38SUPPORT            (7 << 20)       /*!< T38 Fax Passthrough Support */
763 #define SIP_PAGE2_T38SUPPORT_UDPTL      (1 << 20)       /*!< 20: T38 Fax Passthrough Support */
764 #define SIP_PAGE2_T38SUPPORT_RTP        (2 << 20)       /*!< 21: T38 Fax Passthrough Support */
765 #define SIP_PAGE2_T38SUPPORT_TCP        (4 << 20)       /*!< 22: T38 Fax Passthrough Support */
766 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< Call states */
767 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (1 << 23)       /*!< 23: One directional hold */
768 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (2 << 24)       /*!< 24: Inactive  */
769 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 26)
770
771 #define SIP_PAGE2_FLAGS_TO_COPY \
772         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE)
773
774 /* SIP packet flags */
775 #define SIP_PKT_DEBUG           (1 << 0)        /*!< Debug this packet */
776 #define SIP_PKT_WITH_TOTAG      (1 << 1)        /*!< This packet has a to-tag */
777 #define SIP_PKT_IGNORE          (1 << 2)        /*!< This is a re-transmit, ignore it */
778 #define SIP_PKT_IGNORE_RESP     (1 << 3)        /*!< Resp ignore - ??? */
779 #define SIP_PKT_IGNORE_REQ      (1 << 4)        /*!< Req ignore - ??? */
780
781 /* T.38 set of flags */
782 #define T38FAX_FILL_BIT_REMOVAL         (1 << 0)        /*!< Default: 0 (unset)*/
783 #define T38FAX_TRANSCODING_MMR                  (1 << 1)        /*!< Default: 0 (unset)*/
784 #define T38FAX_TRANSCODING_JBIG         (1 << 2)        /*!< Default: 0 (unset)*/
785 /* Rate management */
786 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF   (0 << 3)
787 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF        (1 << 3)        /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
788 /* UDP Error correction */
789 #define T38FAX_UDP_EC_NONE                      (0 << 4)        /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
790 #define T38FAX_UDP_EC_FEC                       (1 << 4)        /*!< Set for t38UDPFEC */
791 #define T38FAX_UDP_EC_REDUNDANCY                (2 << 4)        /*!< Set for t38UDPRedundancy */
792 /* T38 Spec version */
793 #define T38FAX_VERSION                          (3 << 6)        /*!< two bits, 2 values so far, up to 4 values max */
794 #define T38FAX_VERSION_0                        (0 << 6)        /*!< Version 0 */
795 #define T38FAX_VERSION_1                        (1 << 6)        /*!< Version 1 */
796 /* Maximum Fax Rate */
797 #define T38FAX_RATE_2400                        (1 << 8)        /*!< 2400 bps t38FaxRate */
798 #define T38FAX_RATE_4800                        (1 << 9)        /*!< 4800 bps t38FaxRate */
799 #define T38FAX_RATE_7200                        (1 << 10)       /*!< 7200 bps t38FaxRate */
800 #define T38FAX_RATE_9600                        (1 << 11)       /*!< 9600 bps t38FaxRate */
801 #define T38FAX_RATE_12000                       (1 << 12)       /*!< 12000 bps t38FaxRate */
802 #define T38FAX_RATE_14400                       (1 << 13)       /*!< 14400 bps t38FaxRate */
803
804 /*!< This is default: NO MMR and JBIG trancoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
805 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
806
807 #define sipdebug                ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG)
808 #define sipdebug_config         ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONFIG)
809 #define sipdebug_console        ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONSOLE)
810
811 /*! \brief T38 States for a call */
812 enum t38state {
813         T38_DISABLED = 0,                /*!< Not enabled */
814         T38_LOCAL_DIRECT,                /*!< Offered from local */
815         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
816         T38_PEER_DIRECT,                 /*!< Offered from peer */
817         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
818         T38_ENABLED                      /*!< Negotiated (enabled) */
819 };
820
821 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
822 struct t38properties {
823         struct ast_flags t38support;    /*!< Flag for udptl, rtp or tcp support for this session */
824         int capability;                 /*!< Our T38 capability */
825         int peercapability;             /*!< Peers T38 capability */
826         int jointcapability;            /*!< Supported T38 capability at both ends */
827         enum t38state state;            /*!< T.38 state */
828 };
829
830 /*! \brief Parameters to know status of transfer */
831 enum referstatus {
832         REFER_IDLE,                    /*!< No REFER is in progress */
833         REFER_SENT,                    /*!< Sent REFER to transferee */
834         REFER_RECEIVED,                /*!< Received REFER from transferer */
835         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING */
836         REFER_ACCEPTED,                /*!< Accepted by transferee */
837         REFER_RINGING,                 /*!< Target Ringing */
838         REFER_200OK,                   /*!< Answered by transfer target */
839         REFER_FAILED,                  /*!< REFER declined - go on */
840         REFER_NOAUTH                   /*!< We had no auth for REFER */
841 };
842
843 static const struct c_referstatusstring {
844         enum referstatus status;
845         char *text;
846 } referstatusstrings[] = {
847         { REFER_IDLE,           "<none>" },
848         { REFER_SENT,           "Request sent" },
849         { REFER_RECEIVED,       "Request received" },
850         { REFER_ACCEPTED,       "Accepted" },
851         { REFER_RINGING,        "Target ringing" },
852         { REFER_200OK,          "Done" },
853         { REFER_FAILED,         "Failed" },
854         { REFER_NOAUTH,         "Failed - auth failure" }
855 } ;
856
857 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed  */
858 /* OEJ: Should be moved to string fields */
859 struct sip_refer {
860         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
861         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
862         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
863         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
864         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
865         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
866         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
867         char replaces_callid[BUFSIZ];                   /*!< Replace info: callid */
868         char replaces_callid_totag[BUFSIZ/2];           /*!< Replace info: to-tag */
869         char replaces_callid_fromtag[BUFSIZ/2];         /*!< Replace info: from-tag */
870         struct sip_pvt *refer_call;                     /*!< Call we are referring */
871         int attendedtransfer;                           /*!< Attended or blind transfer? */
872         int localtransfer;                              /*!< Transfer to local domain? */
873         enum referstatus status;                        /*!< REFER status */
874 };
875
876 /*! \brief sip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe  */
877 struct sip_pvt {
878         ast_mutex_t pvt_lock;                   /*!< Dialog private lock */
879         int method;                             /*!< SIP method that opened this dialog */
880         AST_DECLARE_STRING_FIELDS(
881                 AST_STRING_FIELD(callid);       /*!< Global CallID */
882                 AST_STRING_FIELD(randdata);     /*!< Random data */
883                 AST_STRING_FIELD(accountcode);  /*!< Account code */
884                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
885                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
886                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
887                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
888                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
889                 AST_STRING_FIELD(from);         /*!< The From: header */
890                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
891                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
892                 AST_STRING_FIELD(context);      /*!< Context for this call */
893                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
894                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
895                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
896                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
897                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
898                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
899                 AST_STRING_FIELD(language);     /*!< Default language for this call */
900                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
901                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
902                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
903                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
904                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
905                 AST_STRING_FIELD(username);     /*!< [user] name */
906                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
907                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
908                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
909                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
910                 AST_STRING_FIELD(peersecret);   /*!< Password */
911                 AST_STRING_FIELD(peermd5secret);
912                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
913                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
914                 AST_STRING_FIELD(via);          /*!< Via: header */
915                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
916                         /* we only store the part in <brackets> in this field. */
917                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
918                 AST_STRING_FIELD(rpid);         /*!< Our RPID header */
919                 AST_STRING_FIELD(rpid_from);    /*!< Our RPID From header */
920         );
921         unsigned int ocseq;                     /*!< Current outgoing seqno */
922         unsigned int icseq;                     /*!< Current incoming seqno */
923         ast_group_t callgroup;                  /*!< Call group */
924         ast_group_t pickupgroup;                /*!< Pickup group */
925         int lastinvite;                         /*!< Last Cseq of invite */
926         struct ast_flags flags[2];              /*!< SIP_ flags */
927         int timer_t1;                           /*!< SIP timer T1, ms rtt */
928         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
929         struct ast_codec_pref prefs;            /*!< codec prefs */
930         int capability;                         /*!< Special capability (codec) */
931         int jointcapability;                    /*!< Supported capability at both ends (codecs) */
932         int peercapability;                     /*!< Supported peer capability */
933         int prefcodec;                          /*!< Preferred codec (outbound only) */
934         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
935         int redircodecs;                        /*!< Redirect codecs */
936         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */    
937         struct t38properties t38;               /*!< T38 settings */
938         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
939         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
940         int callingpres;                        /*!< Calling presentation */
941         int authtries;                          /*!< Times we've tried to authenticate */
942         int expiry;                             /*!< How long we take to expire */
943         long branch;                            /*!< The branch identifier of this session */
944         char tag[11];                           /*!< Our tag for this session */
945         int sessionid;                          /*!< SDP Session ID */
946         int sessionversion;                     /*!< SDP Session Version */
947         struct sockaddr_in sa;                  /*!< Our peer */
948         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
949         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
950         time_t lastrtprx;                       /*!< Last RTP received */
951         time_t lastrtptx;                       /*!< Last RTP sent */
952         int rtptimeout;                         /*!< RTP timeout time */
953         int rtpholdtimeout;                     /*!< RTP timeout when on hold */
954         int rtpkeepalive;                       /*!< Send RTP packets for keepalive */
955         struct sockaddr_in recv;                /*!< Received as */
956         struct in_addr ourip;                   /*!< Our IP */
957         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
958         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
959         int route_persistant;                   /*!< Is this the "real" route? */
960         struct sip_auth *peerauth;              /*!< Realm authentication */
961         int noncecount;                         /*!< Nonce-count */
962         char lastmsg[256];                      /*!< Last Message sent/received */
963         int amaflags;                           /*!< AMA Flags */
964         int pendinginvite;                      /*!< Any pending invite ? (seqno of this) */
965         struct sip_request initreq;             /*!< Initial request that opened the SIP dialog 
966                                                         ... but keeps getting overwritten, so
967                                                         when we want to send a BYE or a CANCEL,
968                                                         we might be totally lost and have no
969                                                         record of what opened the dialog...
970                                                         XXX BUG!!! XXX
971                                                 */
972         
973         int maxtime;                            /*!< Max time for first response */
974         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
975         int autokillid;                         /*!< Auto-kill ID (scheduler) */
976         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
977         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
978         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
979         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
980         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
981         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
982         
983         struct ast_dsp *vad;                    /*!< Voice Activation Detection dsp */
984         
985         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one 
986                                                         Used in peerpoke, mwi subscriptions */
987         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
988         struct ast_rtp *rtp;                    /*!< RTP Session */
989         struct ast_rtp *vrtp;                   /*!< Video RTP session */
990         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
991         struct sip_history_head *history;       /*!< History of this SIP dialog */
992         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
993         struct sip_pvt *next;                   /*!< Next dialog in chain */
994         struct sip_invite_param *options;       /*!< Options for INVITE */
995         int autoframing;
996 };
997
998 static struct sip_pvt *dialoglist = NULL;
999
1000 #define FLAG_RESPONSE (1 << 0)
1001 #define FLAG_FATAL (1 << 1)
1002
1003 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission */
1004 struct sip_pkt {
1005         struct sip_pkt *next;                   /*!< Next packet in linked list */
1006         int retrans;                            /*!< Retransmission number */
1007         int method;                             /*!< SIP method for this packet */
1008         int seqno;                              /*!< Sequence number */
1009         unsigned int flags;                     /*!< non-zero if this is a response packet (e.g. 200 OK) */
1010         struct sip_pvt *owner;                  /*!< Owner AST call */
1011         int retransid;                          /*!< Retransmission ID */
1012         int timer_a;                            /*!< SIP timer A, retransmission timer */
1013         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1014         int packetlen;                          /*!< Length of packet */
1015         char data[0];
1016 };      
1017
1018 /*! \brief Structure for SIP user data. User's place calls to us */
1019 struct sip_user {
1020         /* Users who can access various contexts */
1021         ASTOBJ_COMPONENTS(struct sip_user);
1022         char secret[80];                /*!< Password */
1023         char md5secret[80];             /*!< Password in md5 */
1024         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1025         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1026         char cid_num[80];               /*!< Caller ID num */
1027         char cid_name[80];              /*!< Caller ID name */
1028         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1029         char language[MAX_LANGUAGE];    /*!< Default language for this user */
1030         char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1031         char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1032         char useragent[256];            /*!< User agent in SIP request */
1033         struct ast_codec_pref prefs;    /*!< codec prefs */
1034         ast_group_t callgroup;          /*!< Call group */
1035         ast_group_t pickupgroup;        /*!< Pickup Group */
1036         unsigned int sipoptions;        /*!< Supported SIP options */
1037         struct ast_flags flags[2];      /*!< SIP_ flags */
1038         int amaflags;                   /*!< AMA flags for billing */
1039         int callingpres;                /*!< Calling id presentation */
1040         int capability;                 /*!< Codec capability */
1041         int inUse;                      /*!< Number of calls in use */
1042         int call_limit;                 /*!< Limit of concurrent calls */
1043         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1044         struct ast_ha *ha;              /*!< ACL setting */
1045         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1046         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1047         int autoframing;
1048 };
1049
1050 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1051 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1052 struct sip_peer {
1053         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1054                                         /*!< peer->name is the unique name of this object */
1055         char secret[80];                /*!< Password */
1056         char md5secret[80];             /*!< Password in MD5 */
1057         struct sip_auth *auth;          /*!< Realm authentication list */
1058         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1059         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1060         char username[80];              /*!< Temporary username until registration */ 
1061         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1062         int amaflags;                   /*!< AMA Flags (for billing) */
1063         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1064         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1065         char fromuser[80];              /*!< From: user when calling this peer */
1066         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1067         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1068         char cid_num[80];               /*!< Caller ID num */
1069         char cid_name[80];              /*!< Caller ID name */
1070         int callingpres;                /*!< Calling id presentation */
1071         int inUse;                      /*!< Number of calls in use */
1072         int inRinging;                  /*!< Number of calls ringing */
1073         int onHold;                     /*!< Peer has someone on hold */
1074         int call_limit;                 /*!< Limit of concurrent calls */
1075         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1076         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1077         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox setting for MWI checks */
1078         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1079         char mohinterpret[MAX_MUSICCLASS];/*!<  Music on Hold class */
1080         char mohsuggest[MAX_MUSICCLASS];/*!<  Music on Hold class */
1081         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1082         struct ast_codec_pref prefs;    /*!<  codec prefs */
1083         int lastmsgssent;
1084         time_t  lastmsgcheck;           /*!<  Last time we checked for MWI */
1085         unsigned int sipoptions;        /*!<  Supported SIP options */
1086         struct ast_flags flags[2];      /*!<  SIP_ flags */
1087         int expire;                     /*!<  When to expire this peer registration */
1088         int capability;                 /*!<  Codec capability */
1089         int rtptimeout;                 /*!<  RTP timeout */
1090         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1091         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1092         ast_group_t callgroup;          /*!<  Call group */
1093         ast_group_t pickupgroup;        /*!<  Pickup group */
1094         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1095         struct sockaddr_in addr;        /*!<  IP address of peer */
1096         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1097         
1098         /* Qualification */
1099         struct sip_pvt *call;           /*!<  Call pointer */
1100         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1101         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1102         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1103         struct timeval ps;              /*!<  Ping send time */
1104         
1105         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1106         struct ast_ha *ha;              /*!<  Access control list */
1107         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1108         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1109         int lastmsg;
1110         int autoframing;
1111 };
1112
1113
1114
1115 /*! \brief Registrations with other SIP proxies */
1116 struct sip_registry {
1117         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1118         AST_DECLARE_STRING_FIELDS(
1119                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1120                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1121                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1122                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1123                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1124                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1125                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1126                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1127                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1128                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
1129                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1130                 AST_STRING_FIELD(contact);      /*!< Contact extension */
1131                 AST_STRING_FIELD(random);
1132         );
1133         int portno;                     /*!<  Optional port override */
1134         int expire;                     /*!< Sched ID of expiration */
1135         int expiry;                     /*!< Value to use for the Expires header */
1136         int regattempts;                /*!< Number of attempts (since the last success) */
1137         int timeout;                    /*!< sched id of sip_reg_timeout */
1138         int refresh;                    /*!< How often to refresh */
1139         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1140         enum sipregistrystate regstate; /*!< Registration state (see above) */
1141         time_t regtime;         /*!< Last succesful registration time */
1142         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1143         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1144         struct sockaddr_in us;          /*!< Who the server thinks we are */
1145         int noncecount;                 /*!< Nonce-count */
1146         char lastmsg[256];              /*!< Last Message sent/received */
1147 };
1148
1149 /* --- Linked lists of various objects --------*/
1150
1151 /*! \brief  The user list: Users and friends */
1152 static struct ast_user_list {
1153         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1154 } userl;
1155
1156 /*! \brief  The peer list: Peers and Friends */
1157 static struct ast_peer_list {
1158         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1159 } peerl;
1160
1161 /*! \brief  The register list: Other SIP proxys we register with and place calls to */
1162 static struct ast_register_list {
1163         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1164         int recheck;
1165 } regl;
1166
1167 static int temp_pvt_init(void *);
1168 static void temp_pvt_cleanup(void *);
1169
1170 /*! \brief A per-thread temporary pvt structure */
1171 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1172
1173 /*! \todo Move the sip_auth list to AST_LIST */
1174 static struct sip_auth *authl = NULL;           /*!< Authentication list for realm authentication */
1175
1176
1177 /* --- Sockets and networking --------------*/
1178 static int sipsock  = -1;                       /*!< Main socket for SIP network communication */
1179 static struct sockaddr_in bindaddr = { 0, };    /*!< The address we bind to */
1180 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1181 static char externhost[MAXHOSTNAMELEN];         /*!< External host name (possibly with dynamic DNS and DHCP */
1182 static time_t externexpire = 0;                 /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1183 static int externrefresh = 10;
1184 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1185 static struct in_addr __ourip;
1186 static struct sockaddr_in outboundproxyip;
1187 static int ourport;
1188 static struct sockaddr_in debugaddr;
1189
1190 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1191
1192 /*---------------------------- Forward declarations of functions in chan_sip.c */
1193 /*! \note This is added to help splitting up chan_sip.c into several files
1194         in coming releases */
1195
1196 /*--- PBX interface functions */
1197 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1198 static int sip_devicestate(void *data);
1199 static int sip_sendtext(struct ast_channel *ast, const char *text);
1200 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1201 static int sip_hangup(struct ast_channel *ast);
1202 static int sip_answer(struct ast_channel *ast);
1203 static struct ast_frame *sip_read(struct ast_channel *ast);
1204 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1205 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1206 static int sip_transfer(struct ast_channel *ast, const char *dest);
1207 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1208 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1209 static int sip_senddigit_end(struct ast_channel *ast, char digit);
1210
1211 /*--- Transmitting responses and requests */
1212 static int sipsock_read(int *id, int fd, short events, void *ignore);
1213 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1214 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1215 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1216 static int retrans_pkt(void *data);
1217 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1218 static int transmit_response_using_temp(ast_string_field callid, struct sockaddr_in *sin, int useglobal_nat, const int intended_method, const struct sip_request *req, const char *msg);
1219 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1220 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1221 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1222 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1223 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1224 static int transmit_response_with_auth(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *rand, enum xmittype reliable, const char *header, int stale);
1225 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1226 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1227 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1228 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1229 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1230 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version);
1231 static int transmit_info_with_digit(struct sip_pvt *p, const char digit);
1232 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1233 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1234 static int transmit_refer(struct sip_pvt *p, const char *dest);
1235 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1236 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1237 static int transmit_state_notify(struct sip_pvt *p, int state, int full);
1238 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1239 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1240 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1241 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1242 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1243 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1244 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1245 static int does_peer_need_mwi(struct sip_peer *peer);
1246
1247 /*--- Dialog management */
1248 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1249                                  int useglobal_nat, const int intended_method);
1250 static int __sip_autodestruct(void *data);
1251 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1252 static void sip_cancel_destroy(struct sip_pvt *p);
1253 static void sip_destroy(struct sip_pvt *p);
1254 static void __sip_destroy(struct sip_pvt *p, int lockowner);
1255 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset);
1256 static void __sip_pretend_ack(struct sip_pvt *p);
1257 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1258 static int auto_congest(void *nothing);
1259 static int update_call_counter(struct sip_pvt *fup, int event);
1260 static int hangup_sip2cause(int cause);
1261 static const char *hangup_cause2sip(int cause);
1262 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1263 static void free_old_route(struct sip_route *route);
1264 static void list_route(struct sip_route *route);
1265 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1266 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1267                                               struct sip_request *req, char *uri);
1268 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1269 static void check_pendings(struct sip_pvt *p);
1270 static void *sip_park_thread(void *stuff);
1271 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1272 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1273
1274 /*--- Codec handling / SDP */
1275 static void try_suggested_sip_codec(struct sip_pvt *p);
1276 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1277 static const char *get_sdp(struct sip_request *req, const char *name);
1278 static int find_sdp(struct sip_request *req);
1279 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1280 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1281                              char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1282                              int debug, int *min_packet_size);
1283 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1284                                 char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1285                                 int debug);
1286 static int add_sdp(struct sip_request *resp, struct sip_pvt *p);
1287 static void do_setnat(struct sip_pvt *p, int natflags);
1288
1289 /*--- Authentication stuff */
1290 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1291 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1292 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1293                                          const char *secret, const char *md5secret, int sipmethod,
1294                                          char *uri, enum xmittype reliable, int ignore);
1295 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1296                                               int sipmethod, char *uri, enum xmittype reliable,
1297                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1298 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1299
1300 /*--- Domain handling */
1301 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1302 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1303 static void clear_sip_domains(void);
1304
1305 /*--- SIP realm authentication */
1306 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);
1307 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1308 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1309
1310 /*--- Misc functions */
1311 static int sip_do_reload(enum channelreloadreason reason);
1312 static int reload_config(enum channelreloadreason reason);
1313 static int expire_register(void *data);
1314 static void *do_monitor(void *data);
1315 static int restart_monitor(void);
1316 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1317 static void sip_destroy(struct sip_pvt *p);
1318 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1319 static int sip_refer_allocate(struct sip_pvt *p);
1320 static void ast_quiet_chan(struct ast_channel *chan);
1321 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1322
1323 /*--- Device monitoring and Device/extension state handling */
1324 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1325 static int sip_devicestate(void *data);
1326 static int sip_poke_noanswer(void *data);
1327 static int sip_poke_peer(struct sip_peer *peer);
1328 static void sip_poke_all_peers(void);
1329 static void sip_peer_hold(struct sip_pvt *p, int hold);
1330
1331 /*--- Applications, functions, CLI and manager command helpers */
1332 static const char *sip_nat_mode(const struct sip_pvt *p);
1333 static int sip_show_inuse(int fd, int argc, char *argv[]);
1334 static char *transfermode2str(enum transfermodes mode) attribute_const;
1335 static char *nat2str(int nat) attribute_const;
1336 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1337 static int sip_show_users(int fd, int argc, char *argv[]);
1338 static int _sip_show_peers(int fd, int *total, struct mansession *s, struct message *m, int argc, char *argv[]);
1339 static int manager_sip_show_peers( struct mansession *s, struct message *m );
1340 static int sip_show_peers(int fd, int argc, char *argv[]);
1341 static int sip_show_objects(int fd, int argc, char *argv[]);
1342 static void  print_group(int fd, ast_group_t group, int crlf);
1343 static const char *dtmfmode2str(int mode) attribute_const;
1344 static const char *insecure2str(int port, int invite) attribute_const;
1345 static void cleanup_stale_contexts(char *new, char *old);
1346 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1347 static const char *domain_mode_to_text(const enum domain_mode mode);
1348 static int sip_show_domains(int fd, int argc, char *argv[]);
1349 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1350 static int manager_sip_show_peer( struct mansession *s, struct message *m);
1351 static int sip_show_peer(int fd, int argc, char *argv[]);
1352 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1353 static int sip_show_user(int fd, int argc, char *argv[]);
1354 static int sip_show_registry(int fd, int argc, char *argv[]);
1355 static int sip_show_settings(int fd, int argc, char *argv[]);
1356 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1357 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1358 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1359 static int sip_show_channels(int fd, int argc, char *argv[]);
1360 static int sip_show_subscriptions(int fd, int argc, char *argv[]);
1361 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1362 static char *complete_sipch(const char *line, const char *word, int pos, int state);
1363 static char *complete_sip_peer(const char *word, int state, int flags2);
1364 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1365 static char *complete_sip_debug_peer(const char *line, const char *word, int pos, int state);
1366 static char *complete_sip_user(const char *word, int state, int flags2);
1367 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1368 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1369 static char *complete_sip_prune_realtime_peer(const char *line, const char *word, int pos, int state);
1370 static char *complete_sip_prune_realtime_user(const char *line, const char *word, int pos, int state);
1371 static int sip_show_channel(int fd, int argc, char *argv[]);
1372 static int sip_show_history(int fd, int argc, char *argv[]);
1373 static int sip_do_debug_ip(int fd, int argc, char *argv[]);
1374 static int sip_do_debug_peer(int fd, int argc, char *argv[]);
1375 static int sip_do_debug(int fd, int argc, char *argv[]);
1376 static int sip_no_debug(int fd, int argc, char *argv[]);
1377 static int sip_notify(int fd, int argc, char *argv[]);
1378 static int sip_do_history(int fd, int argc, char *argv[]);
1379 static int sip_no_history(int fd, int argc, char *argv[]);
1380 static int func_header_read(struct ast_channel *chan, char *function, char *data, char *buf, size_t len);
1381 static int func_check_sipdomain(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1382 static int function_sippeer(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1383 static int function_sipchaninfo_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1384 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1385 static int sip_addheader(struct ast_channel *chan, void *data);
1386 static int sip_do_reload(enum channelreloadreason reason);
1387 static int sip_reload(int fd, int argc, char *argv[]);
1388
1389 /*--- Debugging 
1390         Functions for enabling debug per IP or fully, or enabling history logging for
1391         a SIP dialog
1392 */
1393 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
1394 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1395 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1396 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1397 static void sip_dump_history(struct sip_pvt *dialog);
1398
1399 /*--- Device object handling */
1400 static struct sip_peer *temp_peer(const char *name);
1401 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1402 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1403 static int update_call_counter(struct sip_pvt *fup, int event);
1404 static void sip_destroy_peer(struct sip_peer *peer);
1405 static void sip_destroy_user(struct sip_user *user);
1406 static int sip_poke_peer(struct sip_peer *peer);
1407 static void set_peer_defaults(struct sip_peer *peer);
1408 static struct sip_peer *temp_peer(const char *name);
1409 static void register_peer_exten(struct sip_peer *peer, int onoff);
1410 static void sip_destroy_peer(struct sip_peer *peer);
1411 static void sip_destroy_user(struct sip_user *user);
1412 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1413 static struct sip_user *find_user(const char *name, int realtime);
1414 static int sip_poke_peer_s(void *data);
1415 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1416 static void reg_source_db(struct sip_peer *peer);
1417 static void destroy_association(struct sip_peer *peer);
1418 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1419
1420 /* Realtime device support */
1421 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1422 static struct sip_user *realtime_user(const char *username);
1423 static void update_peer(struct sip_peer *p, int expiry);
1424 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1425 static int sip_prune_realtime(int fd, int argc, char *argv[]);
1426
1427 /*--- Internal UA client handling (outbound registrations) */
1428 static int ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us);
1429 static void sip_registry_destroy(struct sip_registry *reg);
1430 static int sip_register(char *value, int lineno);
1431 static char *regstate2str(enum sipregistrystate regstate) attribute_const;
1432 static int sip_reregister(void *data);
1433 static int __sip_do_register(struct sip_registry *r);
1434 static int sip_reg_timeout(void *data);
1435 static void sip_send_all_registers(void);
1436
1437 /*--- Parsing SIP requests and responses */
1438 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1439 static int determine_firstline_parts(struct sip_request *req);
1440 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1441 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1442 static int find_sip_method(const char *msg);
1443 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1444 static void parse_request(struct sip_request *req);
1445 static const char *get_header(const struct sip_request *req, const char *name);
1446 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1447 static int method_match(enum sipmethod id, const char *name);
1448 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1449 static char *get_in_brackets(char *tmp);
1450 static const char *find_alias(const char *name, const char *_default);
1451 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1452 static int lws2sws(char *msgbuf, int len);
1453 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1454 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1455 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1456 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1457 static int set_address_from_contact(struct sip_pvt *pvt);
1458 static void check_via(struct sip_pvt *p, struct sip_request *req);
1459 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1460 static int get_rpid_num(const char *input, char *output, int maxlen);
1461 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1462 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1463 static int get_msg_text(char *buf, int len, struct sip_request *req);
1464 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1465 static void free_old_route(struct sip_route *route);
1466
1467 /*--- Constructing requests and responses */
1468 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1469 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1470 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1471 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1472 static int init_resp(struct sip_request *resp, const char *msg);
1473 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1474 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1475 static void build_via(struct sip_pvt *p);
1476 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1477 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1478 static char *generate_random_string(char *buf, size_t size);
1479 static void build_callid_pvt(struct sip_pvt *pvt);
1480 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1481 static void make_our_tag(char *tagbuf, size_t len);
1482 static int add_header(struct sip_request *req, const char *var, const char *value);
1483 static int add_header_contentLength(struct sip_request *req, int len);
1484 static int add_line(struct sip_request *req, const char *line);
1485 static int add_text(struct sip_request *req, const char *text);
1486 static int add_digit(struct sip_request *req, char digit);
1487 static int add_vidupdate(struct sip_request *req);
1488 static void add_route(struct sip_request *req, struct sip_route *route);
1489 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1490 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1491 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1492 static void set_destination(struct sip_pvt *p, char *uri);
1493 static void append_date(struct sip_request *req);
1494 static void build_contact(struct sip_pvt *p);
1495 static void build_rpid(struct sip_pvt *p);
1496
1497 /*------Request handling functions */
1498 static int handle_request(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1499 static int handle_request_invite(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *recount, char *e);
1500 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1501 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1502 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1503 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1504 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1505 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1506 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1507 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1508 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1509 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1510 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1511 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1512
1513 /*------Response handling functions */
1514 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1515 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1516 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1517 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1518
1519 /*----- RTP interface functions */
1520 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp, int codecs, int nat_active);
1521 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1522 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1523 static int sip_get_codec(struct ast_channel *chan);
1524 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1525
1526 /*------ T38 Support --------- */
1527 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); /*!< T38 negotiation helper function */
1528 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1529 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1530 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1531
1532 /*! \brief Definition of this channel for PBX channel registration */
1533 static const struct ast_channel_tech sip_tech = {
1534         .type = "SIP",
1535         .description = "Session Initiation Protocol (SIP)",
1536         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1537         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1538         .requester = sip_request_call,
1539         .devicestate = sip_devicestate,
1540         .call = sip_call,
1541         .hangup = sip_hangup,
1542         .answer = sip_answer,
1543         .read = sip_read,
1544         .write = sip_write,
1545         .write_video = sip_write,
1546         .indicate = sip_indicate,
1547         .transfer = sip_transfer,
1548         .fixup = sip_fixup,
1549         .send_digit_begin = sip_senddigit_begin,
1550         .send_digit_end = sip_senddigit_end,
1551         .bridge = ast_rtp_bridge,
1552         .early_bridge = ast_rtp_early_bridge,
1553         .send_text = sip_sendtext,
1554 };
1555
1556 /**--- some list management macros. **/
1557  
1558 #define UNLINK(element, head, prev) do {        \
1559         if (prev)                               \
1560                 (prev)->next = (element)->next; \
1561         else                                    \
1562                 (head) = (element)->next;       \
1563         } while (0)
1564
1565 /*! \brief Interface structure with callbacks used to connect to RTP module */
1566 static struct ast_rtp_protocol sip_rtp = {
1567         type: "SIP",
1568         get_rtp_info: sip_get_rtp_peer,
1569         get_vrtp_info: sip_get_vrtp_peer,
1570         set_rtp_peer: sip_set_rtp_peer,
1571         get_codec: sip_get_codec,
1572 };
1573
1574 /*!
1575  * Helper functions to lock/unlock pvt, hiding the
1576  * underlying locking mechanism.
1577  */
1578 static void sip_pvt_lock(struct sip_pvt *pvt)
1579 {
1580         ast_mutex_lock(&pvt->pvt_lock);
1581 }
1582
1583 static void sip_pvt_unlock(struct sip_pvt *pvt)
1584 {
1585         ast_mutex_unlock(&pvt->pvt_lock);
1586 }
1587
1588 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
1589 static struct ast_udptl_protocol sip_udptl = {
1590         type: "SIP",
1591         get_udptl_info: sip_get_udptl_peer,
1592         set_udptl_peer: sip_set_udptl_peer,
1593 };
1594
1595 /*! \brief Convert transfer status to string */
1596 static const char *referstatus2str(enum referstatus rstatus)
1597 {
1598         int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1599         int x;
1600
1601         for (x = 0; x < i; x++) {
1602                 if (referstatusstrings[x].status ==  rstatus)
1603                         return referstatusstrings[x].text;
1604         }
1605         return "";
1606 }
1607
1608 /*! \brief Initialize the initital request packet in the pvt structure.
1609         This packet is used for creating replies and future requests in
1610         a dialog */
1611 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1612 {
1613         if (p->initreq.headers && option_debug) {
1614                 ast_log(LOG_DEBUG, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1615         }
1616         /* Use this as the basis */
1617         copy_request(&p->initreq, req);
1618         parse_request(&p->initreq);
1619         if (ast_test_flag(req, SIP_PKT_DEBUG))
1620                 ast_verbose("%d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1621 }
1622
1623
1624 /*! \brief returns true if 'name' (with optional trailing whitespace)
1625  * matches the sip method 'id'.
1626  * Strictly speaking, SIP methods are case SENSITIVE, but we do
1627  * a case-insensitive comparison to be more tolerant.
1628  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
1629  */
1630 static int method_match(enum sipmethod id, const char *name)
1631 {
1632         int len = strlen(sip_methods[id].text);
1633         int l_name = name ? strlen(name) : 0;
1634         /* true if the string is long enough, and ends with whitespace, and matches */
1635         return (l_name >= len && name[len] < 33 &&
1636                 !strncasecmp(sip_methods[id].text, name, len));
1637 }
1638
1639 /*! \brief  find_sip_method: Find SIP method from header */
1640 static int find_sip_method(const char *msg)
1641 {
1642         int i, res = 0;
1643         
1644         if (ast_strlen_zero(msg))
1645                 return 0;
1646         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1647                 if (method_match(i, msg))
1648                         res = sip_methods[i].id;
1649         }
1650         return res;
1651 }
1652
1653 /*! \brief Parse supported header in incoming packet */
1654 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1655 {
1656         char *next, *sep;
1657         char *temp;
1658         unsigned int profile = 0;
1659         int i, found;
1660
1661         if (ast_strlen_zero(supported) )
1662                 return 0;
1663         temp = ast_strdupa(supported);
1664
1665         if (option_debug > 2 && sipdebug)
1666                 ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1667
1668         for (next = temp; next; next = sep) {
1669                 found = FALSE;
1670                 if ( (sep = strchr(next, ',')) != NULL)
1671                         *sep++ = '\0';
1672                 next = ast_skip_blanks(next);
1673                 if (option_debug > 2 && sipdebug)
1674                         ast_log(LOG_DEBUG, "Found SIP option: -%s-\n", next);
1675                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1676                         if (!strcasecmp(next, sip_options[i].text)) {
1677                                 profile |= sip_options[i].id;
1678                                 found = TRUE;
1679                                 if (option_debug > 2 && sipdebug)
1680                                         ast_log(LOG_DEBUG, "Matched SIP option: %s\n", next);
1681                                 break;
1682                         }
1683                 }
1684                 if (!found && option_debug > 2 && sipdebug) {
1685                         if (!strncasecmp(next, "x-", 2))
1686                                 ast_log(LOG_DEBUG, "Found private SIP option, not supported: %s\n", next);
1687                         else
1688                                 ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1689                 }
1690         }
1691
1692         if (pvt)
1693                 pvt->sipoptions = profile;
1694         return profile;
1695 }
1696
1697 /*! \brief See if we pass debug IP filter */
1698 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
1699 {
1700         if (!sipdebug)
1701                 return 0;
1702         if (debugaddr.sin_addr.s_addr) {
1703                 if (((ntohs(debugaddr.sin_port) != 0)
1704                         && (debugaddr.sin_port != addr->sin_port))
1705                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1706                         return 0;
1707         }
1708         return 1;
1709 }
1710
1711 /*! \brief The real destination address for a write */
1712 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1713 {
1714         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1715 }
1716
1717 /*! \brief Display SIP nat mode */
1718 static const char *sip_nat_mode(const struct sip_pvt *p)
1719 {
1720         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1721 }
1722
1723 /*! \brief Test PVT for debugging output */
1724 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
1725 {
1726         if (!sipdebug)
1727                 return 0;
1728         return sip_debug_test_addr(sip_real_dst(p));
1729 }
1730
1731 /*! \brief Transmit SIP message */
1732 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
1733 {
1734         int res;
1735         const struct sockaddr_in *dst = sip_real_dst(p);
1736         res = sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
1737
1738         if (res != len)
1739                 ast_log(LOG_WARNING, "sip_xmit of %p (len %d) to %s:%d returned %d: %s\n", data, len, ast_inet_ntoa(dst->sin_addr), ntohs(dst->sin_port), res, strerror(errno));
1740         return res;
1741 }
1742
1743
1744 /*! \brief Build a Via header for a request */
1745 static void build_via(struct sip_pvt *p)
1746 {
1747         /* Work around buggy UNIDEN UIP200 firmware */
1748         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
1749
1750         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
1751         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
1752                          ast_inet_ntoa(p->ourip), ourport, p->branch, rport);
1753 }
1754
1755 /*! \brief NAT fix - decide which IP address to use for ASterisk server?
1756  *
1757  * Using the localaddr structure built up with localnet statements in sip.conf
1758  * apply it to their address to see if we need to substitute our
1759  * externip or can get away with our internal bindaddr
1760  */
1761 static enum sip_result ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us)
1762 {
1763         struct sockaddr_in theirs, ours;
1764
1765         /* Get our local information */
1766         ast_ouraddrfor(them, us);
1767         theirs.sin_addr = *them;
1768         ours.sin_addr = *us;
1769
1770         if (localaddr && externip.sin_addr.s_addr &&
1771             ast_apply_ha(localaddr, &theirs) &&
1772             !ast_apply_ha(localaddr, &ours)) {
1773                 if (externexpire && time(NULL) >= externexpire) {
1774                         struct ast_hostent ahp;
1775                         struct hostent *hp;
1776
1777                         externexpire = time(NULL) + externrefresh;
1778                         if ((hp = ast_gethostbyname(externhost, &ahp))) {
1779                                 memcpy(&externip.sin_addr, hp->h_addr, sizeof(externip.sin_addr));
1780                         } else
1781                                 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
1782                 }
1783                 *us = externip.sin_addr;
1784                 if (option_debug) {
1785                         ast_log(LOG_DEBUG, "Target address %s is not local, substituting externip\n", 
1786                                 ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
1787                 }
1788         } else if (bindaddr.sin_addr.s_addr)
1789                 *us = bindaddr.sin_addr;
1790         return AST_SUCCESS;
1791 }
1792
1793 /*! \brief Append to SIP dialog history 
1794         \return Always returns 0 */
1795 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1796
1797 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1798         __attribute__ ((format (printf, 2, 3)));
1799
1800 /*! \brief Append to SIP dialog history with arg list  */
1801 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
1802 {
1803         char buf[80], *c = buf; /* max history length */
1804         struct sip_history *hist;
1805         int l;
1806
1807         vsnprintf(buf, sizeof(buf), fmt, ap);
1808         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
1809         l = strlen(buf) + 1;
1810         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
1811                 return;
1812         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
1813                 free(hist);
1814                 return;
1815         }
1816         memcpy(hist->event, buf, l);
1817         AST_LIST_INSERT_TAIL(p->history, hist, list);
1818 }
1819
1820 /*! \brief Append to SIP dialog history with arg list  */
1821 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1822 {
1823         va_list ap;
1824
1825         if (!p)
1826                 return;
1827         va_start(ap, fmt);
1828         append_history_va(p, fmt, ap);
1829         va_end(ap);
1830
1831         return;
1832 }
1833
1834 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
1835 static int retrans_pkt(void *data)
1836 {
1837         struct sip_pkt *pkt = data, *prev, *cur = NULL;
1838         int reschedule = DEFAULT_RETRANS;
1839
1840         /* Lock channel PVT */
1841         sip_pvt_lock(pkt->owner);
1842
1843         if (pkt->retrans < MAX_RETRANS) {
1844                 pkt->retrans++;
1845                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
1846                         if (sipdebug && option_debug > 3)
1847                                 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);
1848                 } else {
1849                         int siptimer_a;
1850
1851                         if (sipdebug && option_debug > 3)
1852                                 ast_log(LOG_DEBUG, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
1853                         if (!pkt->timer_a)
1854                                 pkt->timer_a = 2 ;
1855                         else
1856                                 pkt->timer_a = 2 * pkt->timer_a;
1857  
1858                         /* For non-invites, a maximum of 4 secs */
1859                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
1860                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
1861                                 siptimer_a = 4000;
1862                 
1863                         /* Reschedule re-transmit */
1864                         reschedule = siptimer_a;
1865                         if (option_debug > 3)
1866                                 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);
1867                 } 
1868
1869                 if (sip_debug_test_pvt(pkt->owner)) {
1870                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
1871                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
1872                                 pkt->retrans, sip_nat_mode(pkt->owner),
1873                                 ast_inet_ntoa(dst->sin_addr),
1874                                 ntohs(dst->sin_port), pkt->data);
1875                 }
1876
1877                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
1878                 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
1879                 sip_pvt_unlock(pkt->owner);
1880                 return  reschedule;
1881         } 
1882         /* Too many retries */
1883         if (pkt->owner && pkt->method != SIP_OPTIONS) {
1884                 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
1885                         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");
1886         } else {
1887                 if ((pkt->method == SIP_OPTIONS) && sipdebug)
1888                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
1889         }
1890         append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
1891                 
1892         pkt->retransid = -1;
1893
1894         if (ast_test_flag(pkt, FLAG_FATAL)) {
1895                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
1896                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
1897                         usleep(1);
1898                         sip_pvt_lock(pkt->owner);
1899                 }
1900                 if (pkt->owner->owner) {
1901                         ast_set_flag(&pkt->owner->flags[0], SIP_ALREADYGONE);
1902                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
1903                         ast_queue_hangup(pkt->owner->owner);
1904                         ast_channel_unlock(pkt->owner->owner);
1905                 } else {
1906                         /* If no channel owner, destroy now */
1907                         ast_set_flag(&pkt->owner->flags[0], SIP_NEEDDESTROY);   
1908                 }
1909         }
1910         /* In any case, go ahead and remove the packet */
1911         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
1912                 if (cur == pkt)
1913                         break;
1914         }
1915         if (cur) {
1916                 if (prev)
1917                         prev->next = cur->next;
1918                 else
1919                         pkt->owner->packets = cur->next;
1920                 sip_pvt_unlock(pkt->owner);
1921                 free(cur);
1922                 pkt = NULL;
1923         } else
1924                 ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
1925         if (pkt)
1926                 sip_pvt_unlock(pkt->owner);
1927         return 0;
1928 }
1929
1930 /*! \brief Transmit packet with retransmits 
1931         \return 0 on success, -1 on failure to allocate packet 
1932 */
1933 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
1934 {
1935         struct sip_pkt *pkt;
1936         int siptimer_a = DEFAULT_RETRANS;
1937
1938         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
1939                 return AST_FAILURE;
1940         memcpy(pkt->data, data, len);
1941         pkt->method = sipmethod;
1942         pkt->packetlen = len;
1943         pkt->next = p->packets;
1944         pkt->owner = p;
1945         pkt->seqno = seqno;
1946         pkt->flags = resp;
1947         pkt->data[len] = '\0';
1948         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
1949         if (fatal)
1950                 ast_set_flag(pkt, FLAG_FATAL);
1951         if (pkt->timer_t1)
1952                 siptimer_a = pkt->timer_t1 * 2;
1953
1954         /* Schedule retransmission */
1955         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
1956         if (option_debug > 3 && sipdebug)
1957                 ast_log(LOG_DEBUG, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
1958         pkt->next = p->packets;
1959         p->packets = pkt;
1960
1961         __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);      /* Send packet */
1962         if (sipmethod == SIP_INVITE) {
1963                 /* Note this is a pending invite */
1964                 p->pendinginvite = seqno;
1965         }
1966         return AST_SUCCESS;
1967 }
1968
1969 /*! \brief Kill a SIP dialog (called by scheduler) */
1970 static int __sip_autodestruct(void *data)
1971 {
1972         struct sip_pvt *p = data;
1973
1974         /* If this is a subscription, tell the phone that we got a timeout */
1975         if (p->subscribed) {
1976                 p->subscribed = TIMEOUT;
1977                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1); /* Send last notification */
1978                 p->subscribed = NONE;
1979                 append_history(p, "Subscribestatus", "timeout");
1980                 if (option_debug > 2)
1981                         ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
1982                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
1983         }
1984
1985         /* Reset schedule ID */
1986         p->autokillid = -1;
1987
1988         if (option_debug)
1989                 ast_log(LOG_DEBUG, "Auto destroying SIP dialog '%s'\n", p->callid);
1990         append_history(p, "AutoDestroy", "%s", p->callid);
1991         if (p->owner) {
1992                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
1993                 ast_queue_hangup(p->owner);
1994         } else if (p->refer) {
1995                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
1996         } else {
1997                 sip_destroy(p);
1998         }
1999         return 0;
2000 }
2001
2002 /*! \brief Schedule destruction of SIP dialog */
2003 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2004 {
2005         if (ms < 0) {
2006                 if (p->timer_t1 == 0)
2007                         p->timer_t1 = 500;      /* Set timer T1 if not set (RFC 3261) */
2008                 ms = p->timer_t1 * 64;
2009         }
2010         if (sip_debug_test_pvt(p))
2011                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2012         if (!ast_test_flag(&p->flags[0], SIP_NO_HISTORY))
2013                 append_history(p, "SchedDestroy", "%d ms", ms);
2014
2015         if (p->autokillid > -1)
2016                 ast_sched_del(sched, p->autokillid);
2017         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
2018 }
2019
2020 /*! \brief Cancel destruction of SIP dialog */
2021 static void sip_cancel_destroy(struct sip_pvt *p)
2022 {
2023         if (p->autokillid > -1) {
2024                 ast_sched_del(sched, p->autokillid);
2025                 append_history(p, "CancelDestroy", "");
2026                 p->autokillid = -1;
2027         }
2028 }
2029
2030 /*! \brief Acknowledges receipt of a packet and stops retransmission */
2031 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset)
2032 {
2033         struct sip_pkt *cur, *prev = NULL;
2034
2035         /* Just in case... */
2036         char *msg;
2037         int res = FALSE;
2038
2039         msg = sip_methods[sipmethod].text;
2040
2041         sip_pvt_lock(p);
2042         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2043                 if ((cur->seqno == seqno) && ((ast_test_flag(cur, FLAG_RESPONSE)) == resp) &&
2044                         ((ast_test_flag(cur, FLAG_RESPONSE)) || 
2045                          (!strncasecmp(msg, cur->data, strlen(msg)) && (cur->data[strlen(msg)] < 33)))) {
2046                         if (!resp && (seqno == p->pendinginvite)) {
2047                                 if (option_debug)
2048                                         ast_log(LOG_DEBUG, "Acked pending invite %d\n", p->pendinginvite);
2049                                 p->pendinginvite = 0;
2050                         }
2051                         /* this is our baby */
2052                         res = TRUE;
2053                         UNLINK(cur, p->packets, prev);
2054                         if (cur->retransid > -1) {
2055                                 if (sipdebug && option_debug > 3)
2056                                         ast_log(LOG_DEBUG, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2057                                 ast_sched_del(sched, cur->retransid);
2058                         }
2059                         if (!reset)
2060                                 free(cur);
2061                         break;
2062                 }
2063         }
2064         sip_pvt_unlock(p);
2065         if (option_debug)
2066                 ast_log(LOG_DEBUG, "Stopping retransmission on '%s' of %s %d: Match %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
2067 }
2068
2069 /*! \brief Pretend to ack all packets
2070  * maybe the lock on p is not strictly necessary but there might be a race */
2071 static void __sip_pretend_ack(struct sip_pvt *p)
2072 {
2073         struct sip_pkt *cur = NULL;
2074
2075         while (p->packets) {
2076                 int method;
2077                 if (cur == p->packets) {
2078                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2079                         return;
2080                 }
2081                 cur = p->packets;
2082                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2083                 __sip_ack(p, cur->seqno, ast_test_flag(cur, FLAG_RESPONSE), method, FALSE);
2084         }
2085 }
2086
2087 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2088 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2089 {
2090         struct sip_pkt *cur;
2091         int res = -1;
2092
2093         for (cur = p->packets; cur; cur = cur->next) {
2094                 if (cur->seqno == seqno && ast_test_flag(cur, FLAG_RESPONSE) == resp &&
2095                         (ast_test_flag(cur, FLAG_RESPONSE) || method_match(sipmethod, cur->data))) {
2096                         /* this is our baby */
2097                         if (cur->retransid > -1) {
2098                                 if (option_debug > 3 && sipdebug)
2099                                         ast_log(LOG_DEBUG, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2100                                 ast_sched_del(sched, cur->retransid);
2101                         }
2102                         cur->retransid = -1;
2103                         res = 0;
2104                         break;
2105                 }
2106         }
2107         if (option_debug)
2108                 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");
2109         return res;
2110 }
2111
2112
2113 /*! \brief Copy SIP request, parse it */
2114 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2115 {
2116         memset(dst, 0, sizeof(*dst));
2117         memcpy(dst->data, src->data, sizeof(dst->data));
2118         dst->len = src->len;
2119         parse_request(dst);
2120 }
2121
2122 /*! \brief add a blank line if no body */
2123 static void add_blank(struct sip_request *req)
2124 {
2125         if (!req->lines) {
2126                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2127                 snprintf(req->data + req->len, sizeof(req->data) - req->len, "\r\n");
2128                 req->len += strlen(req->data + req->len);
2129         }
2130 }
2131
2132 /*! \brief Transmit response on SIP request*/
2133 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2134 {
2135         int res;
2136
2137         add_blank(req);
2138         if (sip_debug_test_pvt(p)) {
2139                 const struct sockaddr_in *dst = sip_real_dst(p);
2140
2141                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
2142                         reliable ? "Reliably " : "", sip_nat_mode(p),
2143                         ast_inet_ntoa(dst->sin_addr),
2144                         ntohs(dst->sin_port), req->data);
2145         }
2146         if (!ast_test_flag(&p->flags[0], SIP_NO_HISTORY)) {
2147                 struct sip_request tmp;
2148                 parse_copy(&tmp, req);
2149                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), 
2150                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
2151         }
2152         res = (reliable) ?
2153                 __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2154                 __sip_xmit(p, req->data, req->len);
2155         if (res > 0)
2156                 return 0;
2157         return res;
2158 }
2159
2160 /*! \brief Send SIP Request to the other part of the dialogue */
2161 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2162 {
2163         int res;
2164
2165         add_blank(req);
2166         if (sip_debug_test_pvt(p)) {
2167                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
2168                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->recv.sin_addr), ntohs(p->recv.sin_port), req->data);
2169                 else
2170                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->sa.sin_addr), ntohs(p->sa.sin_port), req->data);
2171         }
2172         if (!ast_test_flag(&p->flags[0], SIP_NO_HISTORY)) {
2173                 struct sip_request tmp;
2174                 parse_copy(&tmp, req);
2175                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
2176         }
2177         res = (reliable) ?
2178                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable > 1), req->method) :
2179                 __sip_xmit(p, req->data, req->len);
2180         return res;
2181 }
2182
2183 /*! \brief Locate closing quote in a string, skipping escaped quotes.
2184  * optionally with a limit on the search.
2185  * start must be past the first quote.
2186  */
2187 static const char *find_closing_quote(const char *start, const char *lim)
2188 {
2189         char last_char = '\0';
2190         const char *s;
2191         for (s = start; *s && s != lim; last_char = *s++) {
2192                 if (*s == '"' && last_char != '\\')
2193                         break;
2194         }
2195         return s;
2196 }
2197
2198 /*! \brief Pick out text in brackets from character string
2199         \return pointer to terminated stripped string
2200         \param tmp input string that will be modified
2201         Examples:
2202
2203         "foo" <bar>     valid input, returns bar
2204         foo             returns the whole string
2205         < "foo ... >    returns the string between brackets
2206         < "foo...       bogus (missing closing bracket), returns the whole string
2207                         XXX maybe should still skip the opening bracket
2208  */
2209 static char *get_in_brackets(char *tmp)
2210 {
2211         const char *parse = tmp;
2212         char *first_bracket;
2213
2214         /*
2215          * Skip any quoted text until we find the part in brackets.
2216          * On any error give up and return the full string.
2217          */
2218         while ( (first_bracket = strchr(parse, '<')) ) {
2219                 char *first_quote = strchr(parse, '"');
2220
2221                 if (!first_quote || first_quote > first_bracket)
2222                         break; /* no need to look at quoted part */
2223                 /* the bracket is within quotes, so ignore it */
2224                 parse = find_closing_quote(first_quote + 1, NULL);
2225                 if (!*parse) { /* not found, return full string ? */
2226                         /* XXX or be robust and return in-bracket part ? */
2227                         ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
2228                         break;
2229                 }
2230                 parse++;
2231         }
2232         if (first_bracket) {
2233                 char *second_bracket = strchr(first_bracket + 1, '>');
2234                 if (second_bracket) {
2235                         *second_bracket = '\0';
2236                         tmp = first_bracket + 1;
2237                 } else {
2238                         ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
2239                 }
2240         }
2241         return tmp;
2242 }
2243
2244 /*!
2245  * parses a URI in its components.
2246  * If scheme is specified, drop it from the top.
2247  * If a component is not requested, do not split around it.
2248  * This means that if we don't have domain, we cannot split
2249  * name:pass and domain:port.
2250  * It is safe to call with ret_name, pass, domain, port
2251  * pointing all to the same place.
2252  * Init pointers to empty string so we never get NULL dereferencing.
2253  * Overwrites the string.
2254  * return 0 on success, other values on error.
2255  */
2256 static int parse_uri(char *uri, char *scheme,
2257         char **ret_name, char **pass, char **domain, char **port, char **options)
2258 {
2259         char *name = NULL;
2260         int error = 0;
2261
2262         /* init field as required */
2263         if (pass)
2264                 *pass = "";
2265         if (port)
2266                 *port = "";
2267         name = strsep(&uri, ";");       /* remove options */
2268         if (scheme) {
2269                 int l = strlen(scheme);
2270                 if (!strncmp(name, scheme, l))
2271                         name += l;
2272                 else {
2273                         ast_log(LOG_NOTICE, "Missing scheme '%s' in '%s'\n", scheme, name);
2274                         error = -1;
2275                 }
2276         }
2277         if (!domain) {
2278                 /* if we don't want to split around domain, keep everything as a name,
2279                  * so we need to do nothing here, except remember why.
2280                  */
2281         } else {
2282                 /* store the result in a temp. variable to avoid it being
2283                  * overwritten if arguments point to the same place.
2284                  */
2285                 char *c, *dom = "";
2286
2287                 if ((c = strchr(name, '@')) == NULL) {
2288                         /* domain-only URI, according to the SIP RFC. */
2289                         dom = name;
2290                         name = "";
2291                 } else {
2292                         *c++ = '\0';
2293                         dom = c;
2294                 }
2295                 if (port && (c = strchr(dom, ':'))) { /* Remove :port */
2296                         *c++ = '\0';
2297                         *port = c;
2298                 }
2299                 if (pass && (c = strchr(name, ':'))) {  /* user:password */
2300                         *c++ = '\0';
2301                         *pass = c;
2302                 }
2303                 *domain = dom;
2304         }
2305         if (ret_name)   /* same as for domain, store the result only at the end */
2306                 *ret_name = name;
2307         if (options)
2308                 *options = uri ? uri : "";
2309
2310         return error;
2311 }
2312
2313 /*! \brief Send SIP MESSAGE text within a call
2314         Called from PBX core sendtext() application */
2315 static int sip_sendtext(struct ast_channel *ast, const char *text)
2316 {
2317         struct sip_pvt *p = ast->tech_pvt;
2318         int debug = sip_debug_test_pvt(p);
2319
2320         if (debug)
2321                 ast_verbose("Sending text %s on %s\n", text, ast->name);
2322         if (!p)
2323                 return -1;
2324         if (ast_strlen_zero(text))
2325                 return 0;
2326         if (debug)
2327                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
2328         transmit_message_with_text(p, text);
2329         return 0;       
2330 }
2331
2332 /*! \brief Update peer object in realtime storage 
2333         If the Asterisk system name is set in asterisk.conf, we will use
2334         that name and store that in the "regserver" field in the sippeers
2335         table to facilitate multi-server setups.
2336 */
2337 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
2338 {
2339         char port[10];
2340         char ipaddr[INET_ADDRSTRLEN];
2341         char regseconds[20];
2342
2343         char *sysname = ast_config_AST_SYSTEM_NAME;
2344         char *syslabel = NULL;
2345
2346         time_t nowtime = time(NULL) + expirey;
2347         const char *fc = fullcontact ? "fullcontact" : NULL;
2348         
2349         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
2350         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2351         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
2352         
2353         if (ast_strlen_zero(sysname))   /* No system name, disable this */
2354                 sysname = NULL;
2355         else if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTSAVE_SYSNAME))
2356                 syslabel = "regserver";
2357
2358         if (fc)
2359                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2360                         "port", port, "regseconds", regseconds,
2361                         "username", username, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
2362         else
2363                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2364                         "port", port, "regseconds", regseconds,
2365                         "username", username, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
2366 }
2367
2368 /*! \brief Automatically add peer extension to dial plan */
2369 static void register_peer_exten(struct sip_peer *peer, int onoff)
2370 {
2371         char multi[256];
2372         char *stringp, *ext, *context;
2373
2374         /* XXX note that global_regcontext is both a global 'enable' flag and
2375          * the name of the global regexten context, if not specified
2376          * individually.
2377          */
2378         if (ast_strlen_zero(global_regcontext))
2379                 return;
2380
2381         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
2382         stringp = multi;
2383         while ((ext = strsep(&stringp, "&"))) {
2384                 if ((context = strchr(ext, '@'))) {
2385                         *context++ = '\0';      /* split ext@context */
2386                         if (!ast_context_find(context)) {
2387                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
2388                                 continue;
2389                         }
2390                 } else {
2391                         context = global_regcontext;
2392                 }
2393                 if (onoff)
2394                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
2395                                  ast_strdup(peer->name), ast_free, "SIP");
2396                 else
2397                         ast_context_remove_extension(context, ext, 1, NULL);
2398         }
2399 }
2400
2401 /*! \brief Destroy peer object from memory */
2402 static void sip_destroy_peer(struct sip_peer *peer)
2403 {
2404         if (option_debug > 2)
2405                 ast_log(LOG_DEBUG, "Destroying SIP peer %s\n", peer->name);
2406
2407         /* Delete it, it needs to disappear */
2408         if (peer->call)
2409                 sip_destroy(peer->call);
2410
2411         if (peer->mwipvt)       /* We have an active subscription, delete it */
2412                 sip_destroy(peer->mwipvt);
2413
2414         if (peer->chanvars) {
2415                 ast_variables_destroy(peer->chanvars);
2416                 peer->chanvars = NULL;
2417         }
2418         if (peer->expire > -1)
2419                 ast_sched_del(sched, peer->expire);
2420         if (peer->pokeexpire > -1)
2421                 ast_sched_del(sched, peer->pokeexpire);
2422         register_peer_exten(peer, FALSE);
2423         ast_free_ha(peer->ha);
2424         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
2425                 apeerobjs--;
2426         else if (ast_test_flag(&peer->flags[0], SIP_REALTIME))
2427                 rpeerobjs--;
2428         else
2429                 speerobjs--;
2430         clear_realm_authentication(peer->auth);
2431         peer->auth = NULL;
2432         if (peer->dnsmgr)
2433                 ast_dnsmgr_release(peer->dnsmgr);
2434         free(peer);
2435 }
2436
2437 /*! \brief Update peer data in database (if used) */
2438 static void update_peer(struct sip_peer *p, int expiry)
2439 {
2440         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2441         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
2442             (ast_test_flag(&p->flags[0], SIP_REALTIME) || rtcachefriends)) {
2443                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
2444         }
2445 }
2446
2447
2448 /*! \brief  realtime_peer: Get peer from realtime storage
2449  * Checks the "sippeers" realtime family from extconfig.conf 
2450  * \todo Consider adding check of port address when matching here to follow the same
2451  *      algorithm as for static peers. Will we break anything by adding that?
2452 */
2453 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin)
2454 {
2455         struct sip_peer *peer;
2456         struct ast_variable *var = NULL;
2457         struct ast_variable *tmp;
2458         char ipaddr[INET_ADDRSTRLEN];
2459
2460         /* First check on peer name */
2461         if (newpeername) 
2462                 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2463         else if (sin) { /* Then check on IP address for dynamic peers */
2464                 ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2465                 var = ast_load_realtime("sippeers", "host", ipaddr, NULL);      /* First check for fixed IP hosts */
2466                 if (!var)
2467                         var = ast_load_realtime("sippeers", "ipaddr", ipaddr, NULL);    /* Then check for registred hosts */
2468         }
2469
2470         if (!var)
2471                 return NULL;
2472
2473         for (tmp = var; tmp; tmp = tmp->next) {
2474                 /* If this is type=user, then skip this object. */
2475                 if (!strcasecmp(tmp->name, "type") &&
2476                     !strcasecmp(tmp->value, "user")) {
2477                         ast_variables_destroy(var);
2478                         return NULL;
2479                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
2480                         newpeername = tmp->value;
2481                 }
2482         }
2483         
2484         if (!newpeername) {     /* Did not find peer in realtime */
2485                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", ipaddr);
2486                 ast_variables_destroy(var);
2487                 return NULL;
2488         }
2489
2490         /* Peer found in realtime, now build it in memory */
2491         peer = build_peer(newpeername, var, NULL, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2492         if (!peer) {
2493                 ast_variables_destroy(var);
2494                 return NULL;
2495         }
2496
2497         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2498                 /* Cache peer */
2499                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
2500                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
2501                         if (peer->expire > -1) {
2502                                 ast_sched_del(sched, peer->expire);
2503                         }
2504                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
2505                 }
2506                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
2507         } else {
2508                 ast_set_flag(&peer->flags[0], SIP_REALTIME);
2509         }
2510         ast_variables_destroy(var);
2511
2512         return peer;
2513 }
2514
2515 /*! \brief Support routine for find_peer */
2516 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
2517 {
2518         /* We know name is the first field, so we can cast */
2519         struct sip_peer *p = (struct sip_peer *) name;
2520         return  !(!inaddrcmp(&p->addr, sin) || 
2521                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
2522                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
2523 }
2524
2525 /*! \brief Locate peer by name or ip address 
2526  *      This is used on incoming SIP message to find matching peer on ip
2527         or outgoing message to find matching peer on name */
2528 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
2529 {
2530         struct sip_peer *p = NULL;
2531
2532         if (peer)
2533                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
2534         else
2535                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
2536
2537         if (!p && realtime)
2538                 p = realtime_peer(peer, sin);
2539
2540         return p;
2541 }
2542
2543 /*! \brief Remove user object from in-memory storage */
2544 static void sip_destroy_user(struct sip_user *user)
2545 {
2546         if (option_debug > 2)
2547                 ast_log(LOG_DEBUG, "Destroying user object from memory: %s\n", user->name);
2548         ast_free_ha(user->ha);
2549         if (user->chanvars) {
2550                 ast_variables_destroy(user->chanvars);
2551                 user->chanvars = NULL;
2552         }
2553         if (ast_test_flag(&user->flags[0], SIP_REALTIME))
2554                 ruserobjs--;
2555         else
2556                 suserobjs--;
2557         free(user);
2558 }
2559
2560 /*! \brief Load user from realtime storage
2561  * Loads user from "sipusers" category in realtime (extconfig.conf)
2562  * Users are matched on From: user name (the domain in skipped) */
2563 static struct sip_user *realtime_user(const char *username)
2564 {
2565         struct ast_variable *var;
2566         struct ast_variable *tmp;
2567         struct sip_user *user = NULL;
2568
2569         var = ast_load_realtime("sipusers", "name", username, NULL);
2570
2571         if (!var)
2572                 return NULL;
2573
2574         for (tmp = var; tmp; tmp = tmp->next) {
2575                 if (!strcasecmp(tmp->name, "type") &&
2576                         !strcasecmp(tmp->value, "peer")) {
2577                         ast_variables_destroy(var);
2578                         return NULL;
2579                 }
2580         }
2581
2582         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2583         
2584         if (!user) {    /* No user found */
2585                 ast_variables_destroy(var);
2586                 return NULL;
2587         }
2588
2589         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2590                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2591                 suserobjs++;
2592                 ASTOBJ_CONTAINER_LINK(&userl,user);
2593         } else {
2594                 /* Move counter from s to r... */
2595                 suserobjs--;
2596                 ruserobjs++;
2597                 ast_set_flag(&user->flags[0], SIP_REALTIME);
2598         }
2599         ast_variables_destroy(var);
2600         return user;
2601 }
2602
2603 /*! \brief Locate user by name 
2604  * Locates user by name (From: sip uri user name part) first
2605  * from in-memory list (static configuration) then from 
2606  * realtime storage (defined in extconfig.conf) */
2607 static struct sip_user *find_user(const char *name, int realtime)
2608 {
2609         struct sip_user *u = ASTOBJ_CONTAINER_FIND(&userl, name);
2610         if (!u && realtime)
2611                 u = realtime_user(name);
2612         return u;
2613 }
2614
2615 /*! \brief Set nat mode on the various data sockets */
2616 static void do_setnat(struct sip_pvt *p, int natflags)
2617 {
2618         const char *mode = natflags ? "On" : "Off";
2619
2620         if (p->rtp) {
2621                 if (option_debug)
2622                         ast_log(LOG_DEBUG, "Setting NAT on RTP to %s\n", mode);
2623                 ast_rtp_setnat(p->rtp, natflags);
2624         }
2625         if (p->vrtp) {
2626                 if (option_debug)
2627                         ast_log(LOG_DEBUG, "Setting NAT on VRTP to %s\n", mode);
2628                 ast_rtp_setnat(p->vrtp, natflags);
2629         }
2630         if (p->udptl) {
2631                 if (option_debug)
2632                         ast_log(LOG_DEBUG, "Setting NAT on UDPTL to %s\n", mode);
2633                 ast_udptl_setnat(p->udptl, natflags);
2634         }
2635 }
2636
2637 /*! \brief Create address structure from peer reference.
2638  *  return -1 on error, 0 on success.
2639  */
2640 static int create_addr_from_peer(struct sip_pvt *dialog, struct sip_peer *peer)
2641 {
2642         if ((peer->addr.sin_addr.s_addr || peer->defaddr.sin_addr.s_addr) &&
2643             (!peer->maxms || ((peer->lastms >= 0)  && (peer->lastms <= peer->maxms)))) {
2644                 dialog->sa = (peer->addr.sin_addr.s_addr) ? peer->addr : peer->defaddr;
2645                 dialog->recv = dialog->sa;
2646         } else 
2647                 return -1;
2648
2649         ast_copy_flags(&dialog->flags[0], &peer->flags[0], SIP_FLAGS_TO_COPY);
2650         ast_copy_flags(&dialog->flags[1], &peer->flags[1], SIP_PAGE2_FLAGS_TO_COPY);
2651         dialog->capability = peer->capability;
2652         if (!ast_test_flag(&dialog->flags[1], SIP_PAGE2_VIDEOSUPPORT) && dialog->vrtp) {
2653                 ast_rtp_destroy(dialog->vrtp);
2654                 dialog->vrtp = NULL;
2655         }
2656         dialog->prefs = peer->prefs;
2657         if (ast_test_flag(&dialog->flags[1], SIP_PAGE2_T38SUPPORT)) {
2658                 dialog->t38.capability = global_t38_capability;
2659                 if (dialog->udptl) {
2660                         if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_FEC )
2661                                 dialog->t38.capability |= T38FAX_UDP_EC_FEC;
2662                         else if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_REDUNDANCY )
2663                                 dialog->t38.capability |= T38FAX_UDP_EC_REDUNDANCY;
2664                         else if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_NONE )
2665                                 dialog->t38.capability |= T38FAX_UDP_EC_NONE;
2666                         dialog->t38.capability |= T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF;
2667                         if (option_debug > 1)
2668                                 ast_log(LOG_DEBUG,"Our T38 capability (%d)\n", dialog->t38.capability);
2669                 }
2670                 dialog->t38.jointcapability = dialog->t38.capability;
2671         } else if (dialog->udptl) {
2672                 ast_udptl_destroy(dialog->udptl);
2673                 dialog->udptl = NULL;
2674         }
2675         do_setnat(dialog, ast_test_flag(&dialog->flags[0], SIP_NAT) & SIP_NAT_ROUTE );
2676
2677         if (dialog->rtp) {
2678                 ast_rtp_setdtmf(dialog->rtp, ast_test_flag(&dialog->flags[0], SIP_DTMF) != SIP_DTMF_INFO);
2679                 ast_rtp_setdtmfcompensate(dialog->rtp, ast_test_flag(&dialog->flags[1], SIP_PAGE2_RFC2833_COMPENSATE));
2680         }
2681         if (dialog->vrtp) {
2682                 ast_rtp_setdtmf(dialog->vrtp, 0);
2683                 ast_rtp_setdtmfcompensate(dialog->vrtp, 0);
2684         }
2685
2686         /* Set Frame packetization */
2687         if (dialog->rtp) {
2688                 ast_rtp_codec_setpref(dialog->rtp, &dialog->prefs);
2689                 dialog->autoframing = peer->autoframing;
2690         }
2691         ast_string_field_set(dialog, peername, peer->username);
2692         ast_string_field_set(dialog, authname, peer->username);
2693         ast_string_field_set(dialog, username, peer->username);
2694         ast_string_field_set(dialog, peersecret, peer->secret);
2695         ast_string_field_set(dialog, peermd5secret, peer->md5secret);
2696         ast_string_field_set(dialog, tohost, peer->tohost);
2697         ast_string_field_set(dialog, fullcontact, peer->fullcontact);
2698         if (!dialog->initreq.headers && !ast_strlen_zero(peer->fromdomain)) {
2699                 char *tmpcall;
2700                 char *c;
2701                 tmpcall = ast_strdupa(dialog->callid);
2702                 c = strchr(tmpcall, '@');
2703                 if (c) {
2704                         *c = '\0';
2705                         ast_string_field_build(dialog, callid, "%s@%s", tmpcall, peer->fromdomain);
2706                 }
2707         }
2708         if (ast_strlen_zero(dialog->tohost))
2709                 ast_string_field_set(dialog, tohost, ast_inet_ntoa(dialog->sa.sin_addr));
2710         if (!ast_strlen_zero(peer->fromdomain))
2711                 ast_string_field_set(dialog, fromdomain, peer->fromdomain);
2712         if (!ast_strlen_zero(peer->fromuser))
2713                 ast_string_field_set(dialog, fromuser, peer->fromuser);
2714         dialog->maxtime = peer->maxms;
2715         dialog->callgroup = peer->callgroup;
2716         dialog->pickupgroup = peer->pickupgroup;
2717         dialog->allowtransfer = peer->allowtransfer;
2718         /* Set timer T1 to RTT for this peer (if known by qualify=) */
2719         /* Minimum is settable or default to 100 ms */
2720         if (peer->maxms && peer->lastms)
2721                 dialog->timer_t1 = peer->lastms < global_t1min ? global_t1min : peer->lastms;
2722         if ((ast_test_flag(&dialog->flags[0], SIP_DTMF) == SIP_DTMF_RFC2833) ||
2723             (ast_test_flag(&dialog->flags[0], SIP_DTMF) == SIP_DTMF_AUTO))
2724                 dialog->noncodeccapability |= AST_RTP_DTMF;
2725         else
2726                 dialog->noncodeccapability &= ~AST_RTP_DTMF;
2727         ast_string_field_set(dialog, context, peer->context);
2728         dialog->rtptimeout = peer->rtptimeout;
2729         dialog->rtpholdtimeout = peer->rtpholdtimeout;
2730         dialog->rtpkeepalive = peer->rtpkeepalive;
2731         if (peer->call_limit)
2732                 ast_set_flag(&dialog->flags[0], SIP_CALL_LIMIT);
2733         dialog->maxcallbitrate = peer->maxcallbitrate;
2734         
2735         return 0;
2736 }
2737
2738 /*! \brief create address structure from peer name
2739  *      Or, if peer not found, find it in the global DNS 
2740  *      returns TRUE (-1) on failure, FALSE on success */
2741 static int create_addr(struct sip_pvt *dialog, const char *opeer)
2742 {
2743         struct hostent *hp;
2744         struct ast_hostent ahp;
2745         struct sip_peer *p;
2746         char *port;
2747         int portno;
2748         char host[MAXHOSTNAMELEN], *hostn;
2749         char peer[256];
2750
2751         ast_copy_string(peer, opeer, sizeof(peer));
2752         port = strchr(peer, ':');
2753         if (port)
2754                 *port++ = '\0';
2755         dialog->sa.sin_family = AF_INET;
2756         dialog->timer_t1 = 500; /* Default SIP retransmission timer T1 (RFC 3261) */
2757         p = find_peer(peer, NULL, 1);
2758
2759         if (p) {
2760                 int res = create_addr_from_peer(dialog, p);
2761                 ASTOBJ_UNREF(p, sip_destroy_peer);
2762                 return res;
2763         }
2764         hostn = peer;
2765         portno = port ? atoi(port) : STANDARD_SIP_PORT;
2766         if (srvlookup) {
2767                 char service[MAXHOSTNAMELEN];
2768                 int tportno;
2769                 int ret;
2770
2771                 snprintf(service, sizeof(service), "_sip._udp.%s", peer);
2772                 ret = ast_get_srv(NULL, host, sizeof(host), &tportno, service);
2773                 if (ret > 0) {
2774                         hostn = host;
2775                         portno = tportno;
2776                 }
2777         }
2778         hp = ast_gethostbyname(hostn, &ahp);
2779         if (!hp) {
2780                 ast_log(LOG_WARNING, "No such host: %s\n", peer);
2781                 return -1;
2782         }
2783         ast_string_field_set(dialog, tohost, peer);
2784         memcpy(&dialog->sa.sin_addr, hp->h_addr, sizeof(dialog->sa.sin_addr));
2785         dialog->sa.sin_port = htons(portno);
2786         dialog->recv = dialog->sa;
2787         return 0;
2788 }
2789
2790 /*! \brief Scheduled congestion on a call */
2791 static int auto_congest(void *nothing)
2792 {
2793         struct sip_pvt *p = nothing;
2794
2795         sip_pvt_lock(p);
2796         p->initid = -1;
2797         if (p->owner) {
2798                 /* XXX fails on possible deadlock */
2799                 if (!ast_channel_trylock(p->owner)) {
2800                         ast_log(LOG_NOTICE, "Auto-congesting %s\n", p->owner->name);
2801                         append_history(p, "Cong", "Auto-congesting (timer)");
2802                         ast_queue_control(p->owner, AST_CONTROL_CONGESTION);
2803                         ast_channel_unlock(p->owner);
2804                 }
2805         }
2806         sip_pvt_unlock(p);
2807         return 0;
2808 }
2809
2810
2811 /*! \brief Initiate SIP call from PBX 
2812  *      used from the dial() application      */
2813 static int sip_call(struct ast_channel *ast, char *dest, int timeout)
2814 {
2815         int res;
2816         struct sip_pvt *p;
2817         struct varshead *headp;
2818         struct ast_var_t *current;
2819         const char *referer = NULL;   /* SIP refererer */       
2820
2821         p = ast->tech_pvt;
2822         if ((ast->_state != AST_STATE_DOWN) && (ast->_state != AST_STATE_RESERVED)) {
2823                 ast_log(LOG_WARNING, "sip_call called on %s, neither down nor reserved\n", ast->name);
2824                 return -1;
2825         }
2826
2827         /* Check whether there is vxml_url, distinctive ring variables */
2828         headp=&ast->varshead;
2829         AST_LIST_TRAVERSE(headp,current,entries) {
2830                 /* Check whether there is a VXML_URL variable */
2831                 if (!p->options->vxml_url && !strcasecmp(ast_var_name(current), "VXML_URL")) {
2832                         p->options->vxml_url = ast_var_value(current);
2833                 } else if (!p->options->uri_options && !strcasecmp(ast_var_name(current), "SIP_URI_OPTIONS")) {
2834                         p->options->uri_options = ast_var_value(current);
2835                 } else if (!p->options->addsipheaders && !strncasecmp(ast_var_name(current), "SIPADDHEADER", strlen("SIPADDHEADER"))) {
2836                         /* Check whether there is a variable with a name starting with SIPADDHEADER */
2837                         p->options->addsipheaders = 1;
2838                 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER")) {
2839                         /* This is a transfered call */
2840                         p->options->transfer = 1;
2841                 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER_REFERER")) {
2842                         /* This is the referer */
2843                         referer = ast_var_value(current);
2844                 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER_REPLACES")) {
2845                         /* We're replacing a call. */
2846                         p->options->replaces = ast_var_value(current);
2847                 } else if (!strcasecmp(ast_var_name(current), "T38CALL")) {
2848                         p->t38.state = T38_LOCAL_DIRECT;
2849                         if (option_debug)
2850                                 ast_log(LOG_DEBUG,"T38State change to %d on channel %s\n", p->t38.state, ast->name);
2851                 }
2852
2853         }
2854         
2855         res = 0;
2856         ast_set_flag(&p->flags[0], SIP_OUTGOING);
2857
2858         if (p->options->transfer) {
2859                 char buf[BUFSIZ/2];
2860
2861                 if (referer) {
2862                         if (sipdebug && option_debug > 2)
2863                                 ast_log(LOG_DEBUG, "Call for %s transfered by %s\n", p->username, referer);
2864                         snprintf(buf, sizeof(buf)-1, "-> %s (via %s)", p->cid_name, referer);
2865                 } else 
2866                         snprintf(buf, sizeof(buf)-1, "-> %s", p->cid_name);
2867                 ast_string_field_set(p, cid_name, buf);
2868         } 
2869         if (option_debug)
2870                 ast_log(LOG_DEBUG, "Outgoing Call for %s\n", p->username);
2871
2872         res = update_call_counter(p, INC_CALL_RINGING);
2873         if ( res != -1 ) {
2874                 p->callingpres = ast->cid.cid_pres;
2875                 p->jointcapability = p->capability;
2876                 p->t38.jointcapability = p->t38.capability;
2877                 if (option_debug)
2878                         ast_log(LOG_DEBUG,"Our T38 capability (%d), joint T38 capability (%d)\n", p->t38.capability, p->t38.jointcapability);
2879                 transmit_invite(p, SIP_INVITE, 1, 2);
2880                 if (p->maxtime)
2881                         /* Initialize auto-congest time */
2882                         p->initid = ast_sched_add(sched, p->maxtime * 4, auto_congest, p);
2883                 else 
2884                         p->initid = ast_sched_add(sched, SIP_TRANS_TIMEOUT, auto_congest, p);
2885         }
2886         return res;
2887 }
2888
2889 /*! \brief Destroy registry object
2890         Objects created with the register= statement in static configuration */
2891 static void sip_registry_destroy(struct sip_registry *reg)
2892 {
2893         /* Really delete */
2894         if (option_debug > 2)
2895                 ast_log(LOG_DEBUG, "Destroying registry entry for %s@%s\n", reg->username, reg->hostname);
2896
2897         if (reg->call) {
2898                 /* Clear registry before destroying to ensure
2899                    we don't get reentered trying to grab the registry lock */
2900                 reg->call->registry = NULL;
2901                 if (option_debug > 2)
2902                         ast_log(LOG_DEBUG, "Destroying active SIP dialog for registry %s@%s\n", reg->username, reg->hostname);
2903                 sip_destroy(reg->call);
2904         }
2905         if (reg->expire > -1)
2906                 ast_sched_del(sched, reg->expire);
2907         if (reg->timeout > -1)
2908                 ast_sched_del(sched, reg->timeout);
2909         ast_string_field_free_pools(reg);
2910         regobjs--;
2911         free(reg);
2912         
2913 }
2914
2915 /*! \brief Execute destruction of SIP dialog structure, release memory */
2916 static void __sip_destroy(struct sip_pvt *p, int lockowner)
2917 {
2918         struct sip_pvt *cur, *prev = NULL;
2919         struct sip_pkt *cp;
2920
2921         if (sip_debug_test_pvt(p) || option_debug > 2)
2922                 ast_verbose("Really destroying SIP dialog '%s' Method: %s\n", p->callid, sip_methods[p->method].text);
2923
2924         /* Remove link from peer to subscription of MWI */
2925         if (p->relatedpeer && p->relatedpeer->mwipvt)
2926                 p->relatedpeer->mwipvt = NULL;
2927
2928         if (dumphistory)
2929                 sip_dump_history(p);
2930
2931         if (p->options)
2932                 free(p->options);
2933
2934         if (p->stateid > -1)
2935                 ast_extension_state_del(p->stateid, NULL);
2936         if (p->initid > -1)
2937                 ast_sched_del(sched, p->initid);
2938         if (p->autokillid > -1)
2939                 ast_sched_del(sched, p->autokillid);
2940
2941         if (p->rtp)
2942                 ast_rtp_destroy(p->rtp);
2943         if (p->vrtp)
2944                 ast_rtp_destroy(p->vrtp);
2945         if (p->udptl)
2946                 ast_udptl_destroy(p->udptl);
2947         if (p->refer)
2948                 free(p->refer);
2949         if (p->route) {
2950                 free_old_route(p->route);
2951                 p->route = NULL;
2952         }
2953         if (p->registry) {
2954                 if (p->registry->call == p)
2955                         p->registry->call = NULL;
2956                 ASTOBJ_UNREF(p->registry, sip_registry_destroy);
2957         }
2958
2959         /* Unlink us from the owner if we have one */
2960         if (p->owner) {
2961                 if (lockowner)
2962                         ast_channel_lock(p->owner);
2963                 if (option_debug)
2964                         ast_log(LOG_DEBUG, "Detaching from %s\n", p->owner->name);
2965                 p->owner->tech_pvt = NULL;
2966                 if (lockowner)
2967                         ast_channel_unlock(p->owner);
2968         }
2969         /* Clear history */
2970         if (p->history) {
2971                 struct sip_history *hist;
2972                 while( (hist = AST_LIST_REMOVE_HEAD(p->history, list)) )
2973                         free(hist);
2974                 free(p->history);
2975                 p->history = NULL;
2976         }
2977
2978         /* Lock dialog list before removing ourselves from the list */
2979         ast_mutex_lock(&dialoglock);
2980         for (prev = NULL, cur = dialoglist; cur; prev = cur, cur = cur->next) {
2981                 if (cur == p) {
2982                         UNLINK(cur, dialoglist, prev);
2983                         break;
2984                 }
2985         }
2986         ast_mutex_unlock(&dialoglock);
2987         if (!cur) {
2988                 ast_log(LOG_WARNING, "Trying to destroy \"%s\", not found in dialog list?!?! \n", p->callid);
2989                 return;
2990         } 
2991
2992         /* remove all current packets in this dialog */
2993         while((cp = p->packets)) {
2994                 p->packets = p->packets->next;
2995                 if (cp->retransid > -1)
2996                         ast_sched_del(sched, cp->retransid);
2997                 free(cp);
2998         }
2999         if (p->chanvars) {
3000                 ast_variables_destroy(p->chanvars);
3001                 p->chanvars = NULL;
3002         }
3003         ast_mutex_destroy(&p->pvt_lock);
3004
3005         ast_string_field_free_pools(p);
3006
3007         free(p);
3008 }
3009
3010 /*! \brief  update_call_counter: Handle call_limit for SIP users 
3011  * Setting a call-limit will cause calls above the limit not to be accepted.
3012  *
3013  * Remember that for a type=friend, there's one limit for the user and
3014  * another for the peer, not a combined call limit.
3015  * This will cause unexpected behaviour in subscriptions, since a "friend"
3016  * is *two* devices in Asterisk, not one.
3017  *
3018  * Thought: For realtime, we should propably update storage with inuse counter... 
3019  *
3020  * \return 0 if call is ok (no call limit, below treshold)
3021  *      -1 on rejection of call
3022  *              
3023  */
3024 static int update_call_counter(struct sip_pvt *fup, int event)
3025 {
3026         char name[256];
3027         int *inuse, *call_limit, *inringing;
3028         int outgoing = ast_test_flag(&fup->flags[0], SIP_OUTGOING);
3029         struct sip_user *u = NULL;
3030         struct sip_peer *p = NULL;
3031
3032         if (option_debug > 2)
3033                 ast_log(LOG_DEBUG, "Updating call counter for %s call\n", outgoing ? "outgoing" : "incoming");
3034         /* Test if we need to check call limits, in order to avoid 
3035            realtime lookups if we do not need it */
3036         if (!ast_test_flag(&fup->flags[0], SIP_CALL_LIMIT))
3037                 return 0;
3038
3039         ast_copy_string(name, fup->username, sizeof(name));
3040
3041         /* Check the list of users only for incoming calls */
3042         if (!outgoing && (u = find_user(name, 1)) ) {
3043                 inuse = &u->inUse;
3044                 call_limit = &u->call_limit;
3045                 inringing = NULL;
3046         } else if ( (p = find_peer(fup->peername, NULL, 1) ) ) { /* Try to find peer */
3047                 inuse = &p->inUse;
3048                 call_limit = &p->call_limit;
3049                 inringing = &p->inRinging;
3050                 ast_copy_string(name, fup->peername, sizeof(name));
3051         } else {
3052                 if (option_debug > 1)
3053                         ast_log(LOG_DEBUG, "%s is not a local device, no call limit\n", name);
3054                 return 0;
3055         }
3056
3057         switch(event) {
3058         /* incoming and outgoing affects the inUse counter */
3059         case DEC_CALL_LIMIT:
3060                 if ( *inuse > 0 ) {
3061                         if (ast_test_flag(&fup->flags[0], SIP_INC_COUNT))
3062                                 (*inuse)--;
3063                 } else {
3064                         *inuse = 0;
3065                 }
3066                 if (inringing) {
3067                         if (ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
3068                                 if (*inringing > 0)
3069                                         (*inringing)--;
3070                                 else
3071                                         ast_log(LOG_WARNING, "Inringing for peer '%s' < 0?\n", fup->peername);
3072                                 ast_clear_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
3073                         }
3074                 }
3075                 if (option_debug > 1 || sipdebug) {
3076                         ast_log(LOG_DEBUG, "Call %s %s '%s' removed from call limit %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
3077                 }
3078                 break;
3079
3080         case INC_CALL_RINGING:
3081         case INC_CALL_LIMIT:
3082                 if (*call_limit > 0 ) {
3083                         if (*inuse >= *call_limit) {
3084                                 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);
3085                                 if (u)
3086                                         ASTOBJ_UNREF(u, sip_destroy_user);
3087                                 else
3088                                         ASTOBJ_UNREF(p, sip_destroy_peer);
3089                                 return -1; 
3090                         }
3091                 }
3092                 if (inringing && (event == INC_CALL_RINGING)) {
3093                         if (!ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
3094                                 (*inringing)++;
3095                                 ast_set_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
3096                         }
3097                 }
3098                 /* Continue */
3099                 (*inuse)++;
3100                 ast_set_flag(&fup->flags[0], SIP_INC_COUNT);
3101                 if (option_debug > 1 || sipdebug) {
3102                         ast_log(LOG_DEBUG, "Call %s %s '%s' is %d out of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *inuse, *call_limit);
3103                 }
3104                 break;
3105
3106         case DEC_CALL_RINGING:
3107                 if (inringing) {
3108                         if (ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
3109                                 if (*inringing > 0)
3110                                         (*inringing)--;
3111                                 else
3112                                         ast_log(LOG_WARNING, "Inringing for peer '%s' < 0?\n", p->name);
3113                                 ast_clear_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
3114                         }
3115                 }
3116                 break;
3117
3118         default:
3119                 ast_log(LOG_ERROR, "update_call_counter(%s, %d) called with no event!\n", name, event);
3120         }
3121         if (p) {
3122                 ast_device_state_changed("SIP/%s", p->name);
3123                 ASTOBJ_UNREF(p, sip_destroy_peer);
3124         } else /* u must be set */
3125                 ASTOBJ_UNREF(u, sip_destroy_user);
3126         return 0;
3127 }
3128
3129 /*! \brief Destroy SIP call structure */
3130 static void sip_destroy(struct sip_pvt *p)
3131 {
3132         if (option_debug > 2)
3133                 ast_log(LOG_DEBUG, "Destroying SIP dialog %s\n", p->callid);
3134         __sip_destroy(p, 1);
3135 }
3136
3137 /*! \brief Convert SIP hangup causes to Asterisk hangup causes */
3138 static int hangup_sip2cause(int cause)
3139 {
3140         /* Possible values taken from causes.h */
3141
3142         switch(cause) {
3143                 case 401:       /* Unauthorized */
3144                         return AST_CAUSE_CALL_REJECTED;
3145                 case 403:       /* Not found */
3146                         return AST_CAUSE_CALL_REJECTED;
3147                 case 404:       /* Not found */
3148                         return AST_CAUSE_UNALLOCATED;
3149                 case 405:       /* Method not allowed */
3150                         return AST_CAUSE_INTERWORKING;
3151                 case 407:       /* Proxy authentication required */
3152                         return AST_CAUSE_CALL_REJECTED;
3153                 case 408:       /* No reaction */
3154                         return AST_CAUSE_NO_USER_RESPONSE;
3155                 case 409:       /* Conflict */
3156                         return AST_CAUSE_NORMAL_TEMPORARY_FAILURE;
3157                 case 410:       /* Gone */
3158                         return AST_CAUSE_UNALLOCATED;
3159                 case 411:       /* Length required */
3160                         return AST_CAUSE_INTERWORKING;
3161                 case 413:       /* Request entity too large */
3162                         return AST_CAUSE_INTERWORKING;
3163                 case 414:       /* Request URI too large */
3164                         return AST_CAUSE_INTERWORKING;
3165                 case 415:       /* Unsupported media type */
3166                         return AST_CAUSE_INTERWORKING;
3167                 case 420:       /* Bad extension */
3168                         return AST_CAUSE_NO_ROUTE_DESTINATION;
3169                 case 480:       /* No answer */
3170                         return AST_CAUSE_NO_ANSWER;
3171                 case 481:       /* No answer */
3172                         return AST_CAUSE_INTERWORKING;
3173                 case 482:       /* Loop detected */
3174                         return AST_CAUSE_INTERWORKING;
3175                 case 483:       /* Too many hops */
3176                         return AST_CAUSE_NO_ANSWER;
3177                 case 484:       /* Address incomplete */
3178                         return AST_CAUSE_INVALID_NUMBER_FORMAT;
3179                 case 485:       /* Ambigous */
3180                         return AST_CAUSE_UNALLOCATED;
3181                 case 486:       /* Busy everywhere */
3182                         return AST_CAUSE_BUSY;
3183                 case 487:       /* Request terminated */
3184                         return AST_CAUSE_INTERWORKING;
3185                 case 488:       /* No codecs approved */
3186                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
3187                 case 491:       /* Request pending */
3188                         return AST_CAUSE_INTERWORKING;
3189                 case 493:       /* Undecipherable */
3190                         return AST_CAUSE_INTERWORKING;
3191                 case 500:       /* Server internal failure */
3192                         return AST_CAUSE_FAILURE;
3193                 case 501:       /* Call rejected */
3194                         return AST_CAUSE_FACILITY_REJECTED;
3195                 case 502:       
3196                         return AST_CAUSE_DESTINATION_OUT_OF_ORDER;
3197                 case 503:       /* Service unavailable */
3198                         return AST_CAUSE_CONGESTION;
3199                 case 504:       /* Gateway timeout */
3200                         return AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE;
3201                 case 505:       /* SIP version not supported */
3202                         return AST_CAUSE_INTERWORKING;
3203                 case 600:       /* Busy everywhere */
3204                         return AST_CAUSE_USER_BUSY;
3205                 case 603:       /* Decline */
3206                         return AST_CAUSE_CALL_REJECTED;
3207                 case 604:       /* Does not exist anywhere */
3208                         return AST_CAUSE_UNALLOCATED;
3209                 case 606:       /* Not acceptable */
3210                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
3211                 default:
3212                         return AST_CAUSE_NORMAL;
3213         }
3214         /* Never reached */
3215         return 0;
3216 }
3217
3218 /*! \brief Convert Asterisk hangup causes to SIP codes 
3219 \verbatim
3220  Possible values from causes.h
3221         AST_CAUSE_NOTDEFINED    AST_CAUSE_NORMAL        AST_CAUSE_BUSY
3222         AST_CAUSE_FAILURE       AST_CAUSE_CONGESTION    AST_CAUSE_UNALLOCATED
3223
3224         In addition to these, a lot of PRI codes is defined in causes.h 
3225         ...should we take care of them too ?
3226         
3227         Quote RFC 3398
3228
3229    ISUP Cause value                        SIP response
3230    ----------------                        ------------
3231    1  unallocated number                   404 Not Found
3232    2  no route to network                  404 Not found
3233    3  no route to destination              404 Not found
3234    16 normal call clearing                 --- (*)
3235    17 user busy                            486 Busy here
3236    18 no user responding                   408 Request Timeout
3237    19 no answer from the user              480 Temporarily unavailable
3238    20 subscriber absent                    480 Temporarily unavailable
3239    21 call rejected                        403 Forbidden (+)
3240    22 number changed (w/o diagnostic)      410 Gone
3241    22 number changed (w/ diagnostic)       301 Moved Permanently
3242    23 redirection to new destination       410 Gone
3243    26 non-selected user clearing           404 Not Found (=)
3244    27 destination out of order             502 Bad Gateway
3245    28 address incomplete                   484 Address incomplete
3246    29 facility rejected                    501 Not implemented
3247    31 normal unspecified                   480 Temporarily unavailable
3248 \endverbatim
3249 */
3250 static const char *hangup_cause2sip(int cause)
3251 {
3252         switch (cause) {
3253                 case AST_CAUSE_UNALLOCATED:             /* 1 */
3254                 case AST_CAUSE_NO_ROUTE_DESTINATION:    /* 3 IAX2: Can't find extension in context */
3255                 case AST_CAUSE_NO_ROUTE_TRANSIT_NET:    /* 2 */
3256                         return "404 Not Found";
3257                 case AST_CAUSE_CONGESTION:              /* 34 */
3258                 case AST_CAUSE_SWITCH_CONGESTION:       /* 42 */
3259                         return "503 Service Unavailable";
3260                 case AST_CAUSE_NO_USER_RESPONSE:        /* 18 */
3261                         return "408 Request Timeout";
3262                 case AST_CAUSE_NO_ANSWER:               /* 19 */
3263                         return "480 Temporarily unavailable";
3264                 case AST_CAUSE_CALL_REJECTED:           /* 21 */
3265                         return "403 Forbidden";
3266                 case AST_CAUSE_NUMBER_CHANGED:          /* 22 */
3267                         return "410 Gone";
3268                 case AST_CAUSE_NORMAL_UNSPECIFIED:      /* 31 */
3269                         return "480 Temporarily unavailable";
3270                 case AST_CAUSE_INVALID_NUMBER_FORMAT:
3271                         return "484 Address incomplete";
3272                 case AST_CAUSE_USER_BUSY:
3273                         return "486 Busy here";
3274                 case AST_CAUSE_FAILURE:
3275                         return "500 Server internal failure";
3276                 case AST_CAUSE_FACILITY_REJECTED:       /* 29 */
3277                         return "501 Not Implemented";
3278                 case AST_CAUSE_CHAN_NOT_IMPLEMENTED:
3279                         return "503 Service Unavailable";
3280                 /* Used in chan_iax2 */
3281                 case AST_CAUSE_DESTINATION_OUT_OF_ORDER:
3282                         return "502 Bad Gateway";
3283                 case AST_CAUSE_BEARERCAPABILITY_NOTAVAIL:       /* Can't find codec to connect to host */
3284                         return "488 Not Acceptable Here";
3285                         
3286                 case AST_CAUSE_NOTDEFINED:
3287                 default:
3288                         if (option_debug)
3289                                 ast_log(LOG_DEBUG, "AST hangup cause %d (no match found in SIP)\n", cause);
3290                         return NULL;
3291         }
3292
3293         /* Never reached */
3294         return 0;
3295 }
3296
3297
3298 /*! \brief  sip_hangup: Hangup SIP call
3299  * Part of PBX interface, called from ast_hangup */
3300 static int sip_hangup(struct ast_channel *ast)
3301 {
3302         struct sip_pvt *p = ast->tech_pvt;
3303         int needcancel = FALSE;
3304         int needdestroy = 0;
3305         struct ast_channel *oldowner = ast;
3306
3307         if (!p) {
3308                 if (option_debug)
3309                         ast_log(LOG_DEBUG, "Asked to hangup channel that was not connected\n");
3310                 return 0;
3311         }
3312
3313         if (ast_test_flag(&p->flags[0], SIP_DEFER_BYE_ON_TRANSFER)) {
3314                 if (option_debug >3)
3315                         ast_log(LOG_DEBUG, "SIP Transfer: Not hanging up right now... Rescheduling hangup for %s.\n", p->callid);
3316                 if (p->autokillid > -1)
3317                         sip_cancel_destroy(p);
3318                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
3319                 ast_clear_flag(&p->flags[0], SIP_DEFER_BYE_ON_TRANSFER);        /* Really hang up next time */
3320                 ast_clear_flag(&p->flags[0], SIP_NEEDDESTROY);
3321                 p->owner->tech_pvt = NULL;
3322                 p->owner = NULL;  /* Owner will be gone after we return, so take it away */
3323                 return 0;
3324         }
3325         if (option_debug) {
3326                 if (ast_test_flag(ast, AST_FLAG_ZOMBIE) && p->refer && option_debug)
3327                         ast_log(LOG_DEBUG, "SIP Transfer: Hanging up Zombie channel %s after transfer ... Call-ID: %s\n", ast->name, p->callid);
3328                 else  {
3329                         if (option_debug)
3330                                 ast_log(LOG_DEBUG, "Hangup call %s, SIP callid %s)\n", ast->name, p->callid);
3331                 }
3332         }
3333         if (option_debug && ast_test_flag(ast, AST_FLAG_ZOMBIE)) 
3334                 ast_log(LOG_DEBUG, "Hanging up zombie call. Be scared.\n");
3335
3336         sip_pvt_lock(p);
3337         if (option_debug && sipdebug)
3338                 ast_log(LOG_DEBUG, "update_call_counter(%s) - decrement call limit counter on hangup\n", p->username);
3339         update_call_counter(p, DEC_CALL_LIMIT);
3340
3341         /* Determine how to disconnect */
3342         if (p->owner != ast) {
3343                 ast_log(LOG_WARNING, "Huh?  We aren't the owner? Can't hangup call.\n");
3344                 sip_pvt_unlock(p);
3345                 return 0;
3346         }
3347         /* If the call is not UP, we need to send CANCEL instead of BYE */
3348         if (ast->_state == AST_STATE_RING || ast->_state == AST_STATE_RINGING) {
3349                 needcancel = TRUE;
3350                 if (option_debug > 3)
3351                         ast_log(LOG_DEBUG, "Hanging up channel in state %s (not UP)\n", ast_state2str(ast->_state));
3352         }
3353
3354         /* Disconnect */
3355         if (p->vad)
3356                 ast_dsp_free(p->vad);
3357
3358         p->owner = NULL;
3359         ast->tech_pvt = NULL;
3360
3361         ast_atomic_fetchadd_int(&usecnt, -1);
3362         ast_update_use_count();
3363
3364         /* Do not destroy this pvt until we have timeout or
3365            get an answer to the BYE or INVITE/CANCEL 
3366            If we get no answer during retransmit period, drop the call anyway.
3367            (Sorry, mother-in-law, you can't deny a hangup by sending
3368            603 declined to BYE...)
3369         */
3370         if (ast_test_flag(&p->flags[0], SIP_ALREADYGONE))
3371                 needdestroy = 1;        /* Set destroy flag at end of this function */
3372         else
3373                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
3374
3375         /* Start the process if it's not already started */
3376         if (!ast_test_flag(&p->flags[0], SIP_ALREADYGONE) && !ast_strlen_zero(p->initreq.data)) {
3377                 if (needcancel) {       /* Outgoing call, not up */
3378                         if (ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3379                                 /* stop retransmitting an INVITE that has not received a response */
3380                                 __sip_pretend_ack(p);
3381
3382                                 /* if we can't send right now, mark it pending */
3383                                 if (!ast_test_flag(&p->flags[0], SIP_CAN_BYE)) {
3384                                         ast_set_flag(&p->flags[0], SIP_PENDINGBYE);
3385                                         /* Do we need a timer here if we don't hear from them at all? */
3386                                 } else {
3387                                         /* Send a new request: CANCEL */
3388                                         transmit_request_with_auth(p, SIP_CANCEL, p->ocseq, XMIT_RELIABLE, FALSE);
3389                                         /* Actually don't destroy us yet, wait for the 487 on our original 
3390                                            INVITE, but do set an autodestruct just in case we never get it. */
3391                                         needdestroy = 0;
3392                                         sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
3393                                 }
3394                                 if ( p->initid != -1 ) {
3395                                         /* channel still up - reverse dec of inUse counter
3396                                            only if the channel is not auto-congested */
3397                                         update_call_counter(p, INC_CALL_LIMIT);
3398                                 }
3399                         } else {        /* Incoming call, not up */
3400                                 const char *res;
3401                                 if (ast->hangupcause && (res = hangup_cause2sip(ast->hangupcause)))
3402                                         transmit_response_reliable(p, res, &p->initreq);
3403                                 else 
3404                                         transmit_response_reliable(p, "603 Declined", &p->initreq);
3405                         }
3406                 } else {        /* Call is in UP state, send BYE */
3407                         if (!p->pendinginvite) {
3408                                 char *audioqos = "";
3409                                 char *videoqos = "";
3410                                 if (p->rtp)
3411                                         audioqos = ast_rtp_get_quality(p->rtp);
3412                                 if (p->vrtp)
3413                                         videoqos = ast_rtp_get_quality(p->vrtp);
3414                                 /* Send a hangup */
3415                                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
3416
3417                                 /* Get RTCP quality before end of call */
3418                                 if (!ast_test_flag(&p->flags[0], SIP_NO_HISTORY)) {
3419                                         if (p->rtp)
3420                                                 append_history(p, "RTCPaudio", "Quality:%s", audioqos);
3421                                         if (p->vrtp)
3422                                                 append_history(p, "RTCPvideo", "Quality:%s", videoqos);
3423                                 }
3424                                 if (p->rtp && oldowner)
3425                                         pbx_builtin_setvar_helper(oldowner, "RTPAUDIOQOS", audioqos);
3426                                 if (p->vrtp && oldowner)
3427                                         pbx_builtin_setvar_helper(oldowner, "RTPVIDEOQOS", videoqos);
3428                         } else {
3429                                 /* Note we will need a BYE when this all settles out
3430                                    but we can't send one while we have "INVITE" outstanding. */
3431                                 ast_set_flag(&p->flags[0], SIP_PENDINGBYE);     
3432                                 ast_clear_flag(&p->flags[0], SIP_NEEDREINVITE); 
3433                         }
3434                 }
3435         }
3436         if (needdestroy)
3437                 ast_set_flag(&p->flags[0], SIP_NEEDDESTROY);
3438         sip_pvt_unlock(p);
3439         return 0;
3440 }
3441
3442 /*! \brief Try setting codec suggested by the SIP_CODEC channel variable */
3443 static void try_suggested_sip_codec(struct sip_pvt *p)
3444 {
3445         int fmt;
3446         const char *codec;
3447
3448         codec = pbx_builtin_getvar_helper(p->owner, "SIP_CODEC");
3449         if (!codec) 
3450                 return;
3451
3452         fmt = ast_getformatbyname(codec);
3453         if (fmt) {
3454                 ast_log(LOG_NOTICE, "Changing codec to '%s' for this call because of ${SIP_CODEC} variable\n", codec);