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