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