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