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