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