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