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