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