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