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