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