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