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