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