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