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