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