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