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