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