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