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