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