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