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