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