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