8a8ae8150cd6c88890c7aba7f072f310fda55c40
[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
968 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 14)       /*!< DP: Video supported if offered? */
969 #define SIP_PAGE2_TEXTSUPPORT           (1 << 15)       /*!< GDP: Global text enable */
970 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< GP: Allow subscriptions from this peer? */
971 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< DP: Allow overlap dialing ? */
972 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< GP: Only issue MWI notification if subscribed to */
973
974 #define SIP_PAGE2_T38SUPPORT            (7 << 20)       /*!< GDP: T38 Fax Passthrough Support */
975 #define SIP_PAGE2_T38SUPPORT_UDPTL      (1 << 20)       /*!< GDP: T38 Fax Passthrough Support */
976 #define SIP_PAGE2_T38SUPPORT_RTP        (2 << 20)       /*!< GDP: T38 Fax Passthrough Support (not implemented) */
977 #define SIP_PAGE2_T38SUPPORT_TCP        (4 << 20)       /*!< GDP: T38 Fax Passthrough Support (not implemented) */
978
979 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< D: Call hold states: */
980 #define SIP_PAGE2_CALL_ONHOLD_ACTIVE    (1 << 23)       /*!< D: Active hold */
981 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (2 << 23)       /*!< D: One directional hold */
982 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (3 << 23)       /*!< D: Inactive hold */
983
984 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 25)       /*!< DP: Compensate for buggy RFC2833 implementations */
985 #define SIP_PAGE2_BUGGY_MWI             (1 << 26)       /*!< DP: Buggy CISCO MWI fix */
986 #define SIP_PAGE2_REGISTERTRYING        (1 << 29)       /*!< DP: Send 100 Trying on REGISTER attempts */
987
988 #define SIP_PAGE2_FLAGS_TO_COPY \
989         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT | \
990         SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE | SIP_PAGE2_BUGGY_MWI | \
991         SIP_PAGE2_TEXTSUPPORT )
992
993 /*@}*/ 
994
995 /*! \name SIPflagsT38
996         T.38 set of flags */
997
998 /*@{*/ 
999 #define T38FAX_FILL_BIT_REMOVAL                 (1 << 0)        /*!< Default: 0 (unset)*/
1000 #define T38FAX_TRANSCODING_MMR                  (1 << 1)        /*!< Default: 0 (unset)*/
1001 #define T38FAX_TRANSCODING_JBIG                 (1 << 2)        /*!< Default: 0 (unset)*/
1002 /* Rate management */
1003 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF   (0 << 3)
1004 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF        (1 << 3)        /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
1005 /* UDP Error correction */
1006 #define T38FAX_UDP_EC_NONE                      (0 << 4)        /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
1007 #define T38FAX_UDP_EC_FEC                       (1 << 4)        /*!< Set for t38UDPFEC */
1008 #define T38FAX_UDP_EC_REDUNDANCY                (2 << 4)        /*!< Set for t38UDPRedundancy */
1009 /* T38 Spec version */
1010 #define T38FAX_VERSION                          (3 << 6)        /*!< two bits, 2 values so far, up to 4 values max */
1011 #define T38FAX_VERSION_0                        (0 << 6)        /*!< Version 0 */
1012 #define T38FAX_VERSION_1                        (1 << 6)        /*!< Version 1 */
1013 /* Maximum Fax Rate */
1014 #define T38FAX_RATE_2400                        (1 << 8)        /*!< 2400 bps t38FaxRate */
1015 #define T38FAX_RATE_4800                        (1 << 9)        /*!< 4800 bps t38FaxRate */
1016 #define T38FAX_RATE_7200                        (1 << 10)       /*!< 7200 bps t38FaxRate */
1017 #define T38FAX_RATE_9600                        (1 << 11)       /*!< 9600 bps t38FaxRate */
1018 #define T38FAX_RATE_12000                       (1 << 12)       /*!< 12000 bps t38FaxRate */
1019 #define T38FAX_RATE_14400                       (1 << 13)       /*!< 14400 bps t38FaxRate */
1020
1021 /*!< This is default: NO MMR and JBIG transcoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
1022 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
1023 /*@}*/ 
1024
1025 /*! \brief debugging state
1026  * We store separately the debugging requests from the config file
1027  * and requests from the CLI. Debugging is enabled if either is set
1028  * (which means that if sipdebug is set in the config file, we can
1029  * only turn it off by reloading the config).
1030  */
1031 enum sip_debug_e {
1032         sip_debug_none = 0,
1033         sip_debug_config = 1,
1034         sip_debug_console = 2,
1035 };
1036
1037 static enum sip_debug_e sipdebug;
1038
1039 /*! \brief extra debugging for 'text' related events.
1040  * At thie moment this is set together with sip_debug_console.
1041  * It should either go away or be implemented properly.
1042  */
1043 static int sipdebug_text;
1044
1045 /*! \brief T38 States for a call */
1046 enum t38state {
1047         T38_DISABLED = 0,                /*!< Not enabled */
1048         T38_LOCAL_DIRECT,                /*!< Offered from local */
1049         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
1050         T38_PEER_DIRECT,                 /*!< Offered from peer */
1051         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
1052         T38_ENABLED                      /*!< Negotiated (enabled) */
1053 };
1054
1055 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
1056 struct t38properties {
1057         struct ast_flags t38support;    /*!< Flag for udptl, rtp or tcp support for this session */
1058         int capability;                 /*!< Our T38 capability */
1059         int peercapability;             /*!< Peers T38 capability */
1060         int jointcapability;            /*!< Supported T38 capability at both ends */
1061         enum t38state state;            /*!< T.38 state */
1062 };
1063
1064 /*! \brief Parameters to know status of transfer */
1065 enum referstatus {
1066         REFER_IDLE,                    /*!< No REFER is in progress */
1067         REFER_SENT,                    /*!< Sent REFER to transferee */
1068         REFER_RECEIVED,                /*!< Received REFER from transferrer */
1069         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING (unused) */
1070         REFER_ACCEPTED,                /*!< Accepted by transferee */
1071         REFER_RINGING,                 /*!< Target Ringing */
1072         REFER_200OK,                   /*!< Answered by transfer target */
1073         REFER_FAILED,                  /*!< REFER declined - go on */
1074         REFER_NOAUTH                   /*!< We had no auth for REFER */
1075 };
1076
1077 /*! \brief generic struct to map between strings and integers.
1078  * Fill it with x-s pairs, terminate with an entry with s = NULL;
1079  * Then you can call map_x_s(...) to map an integer to a string,
1080  * and map_s_x() for the string -> integer mapping.
1081  */
1082 struct _map_x_s {
1083         int x;
1084         const char *s;
1085 };              
1086
1087 static const struct _map_x_s referstatusstrings[] = {
1088         { REFER_IDLE,           "<none>" },
1089         { REFER_SENT,           "Request sent" },
1090         { REFER_RECEIVED,       "Request received" },
1091         { REFER_CONFIRMED,      "Confirmed" },
1092         { REFER_ACCEPTED,       "Accepted" },
1093         { REFER_RINGING,        "Target ringing" },
1094         { REFER_200OK,          "Done" },
1095         { REFER_FAILED,         "Failed" },
1096         { REFER_NOAUTH,         "Failed - auth failure" },
1097         { -1,                   NULL} /* terminator */
1098 };
1099
1100 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed
1101         \note OEJ: Should be moved to string fields */
1102 struct sip_refer {
1103         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
1104         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
1105         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
1106         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
1107         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
1108         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
1109         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
1110         char replaces_callid[SIPBUFSIZE];                       /*!< Replace info: callid */
1111         char replaces_callid_totag[SIPBUFSIZE/2];               /*!< Replace info: to-tag */
1112         char replaces_callid_fromtag[SIPBUFSIZE/2];             /*!< Replace info: from-tag */
1113         struct sip_pvt *refer_call;                     /*!< Call we are referring. This is just a reference to a
1114                                                          * dialog owned by someone else, so we should not destroy
1115                                                          * it when the sip_refer object goes.
1116                                                          */
1117         int attendedtransfer;                           /*!< Attended or blind transfer? */
1118         int localtransfer;                              /*!< Transfer to local domain? */
1119         enum referstatus status;                        /*!< REFER status */
1120 };
1121
1122
1123 /*! \brief Structure that encapsulates all attributes related to running 
1124  *   SIP Session-Timers feature on a per dialog basis.
1125  */
1126 struct sip_st_dlg {
1127         int st_active;                          /*!< Session-Timers on/off */ 
1128         int st_interval;                        /*!< Session-Timers negotiated session refresh interval */
1129         int st_schedid;                         /*!< Session-Timers ast_sched scheduler id */
1130         enum st_refresher st_ref;               /*!< Session-Timers session refresher */
1131         int st_expirys;                         /*!< Session-Timers number of expirys */
1132         int st_active_peer_ua;                  /*!< Session-Timers on/off in peer UA */
1133         int st_cached_min_se;                   /*!< Session-Timers cached Min-SE */
1134         int st_cached_max_se;                   /*!< Session-Timers cached Session-Expires */
1135         enum st_mode st_cached_mode;            /*!< Session-Timers cached M.O. */
1136         enum st_refresher st_cached_ref;        /*!< Session-Timers cached refresher */
1137 };
1138
1139
1140 /*! \brief Structure that encapsulates all attributes related to configuration 
1141  *   of SIP Session-Timers feature on a per user/peer basis.
1142  */
1143 struct sip_st_cfg {
1144         enum st_mode st_mode_oper;      /*!< Mode of operation for Session-Timers           */
1145         enum st_refresher st_ref;       /*!< Session-Timer refresher                        */
1146         int st_min_se;                  /*!< Lowest threshold for session refresh interval  */
1147         int st_max_se;                  /*!< Highest threshold for session refresh interval */
1148 };
1149
1150
1151
1152
1153 /*! \brief sip_pvt: structures used for each SIP dialog, ie. a call, a registration, a subscribe.
1154  * Created and initialized by sip_alloc(), the descriptor goes into the list of
1155  * descriptors (dialoglist).
1156  */
1157 struct sip_pvt {
1158         struct sip_pvt *next;                   /*!< Next dialog in chain */
1159         ast_mutex_t pvt_lock;                   /*!< Dialog private lock */
1160         enum invitestates invitestate;          /*!< Track state of SIP_INVITEs */
1161         int method;                             /*!< SIP method that opened this dialog */
1162         AST_DECLARE_STRING_FIELDS(
1163                 AST_STRING_FIELD(callid);       /*!< Global CallID */
1164                 AST_STRING_FIELD(randdata);     /*!< Random data */
1165                 AST_STRING_FIELD(accountcode);  /*!< Account code */
1166                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1167                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1168                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1169                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1170                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1171                 AST_STRING_FIELD(from);         /*!< The From: header */
1172                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
1173                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
1174                 AST_STRING_FIELD(context);      /*!< Context for this call */
1175                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
1176                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
1177                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
1178                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
1179                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
1180                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
1181                 AST_STRING_FIELD(todnid);       /*!< DNID of this call (overrides host) */
1182                 AST_STRING_FIELD(language);     /*!< Default language for this call */
1183                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
1184                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
1185                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
1186                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
1187                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
1188                 AST_STRING_FIELD(username);     /*!< [user] name */
1189                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
1190                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
1191                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
1192                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
1193                 AST_STRING_FIELD(peersecret);   /*!< Password */
1194                 AST_STRING_FIELD(peermd5secret);
1195                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
1196                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
1197                 AST_STRING_FIELD(via);          /*!< Via: header */
1198                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
1199                         /* we only store the part in <brackets> in this field. */
1200                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
1201                 AST_STRING_FIELD(rpid);         /*!< Our RPID header */
1202                 AST_STRING_FIELD(rpid_from);    /*!< Our RPID From header */
1203                 AST_STRING_FIELD(url);          /*!< URL to be sent with next message to peer */
1204         );
1205         struct sip_socket socket;               /*!< The socket used for this dialog */
1206         unsigned int ocseq;                     /*!< Current outgoing seqno */
1207         unsigned int icseq;                     /*!< Current incoming seqno */
1208         ast_group_t callgroup;                  /*!< Call group */
1209         ast_group_t pickupgroup;                /*!< Pickup group */
1210         int lastinvite;                         /*!< Last Cseq of invite */
1211         int lastnoninvite;                      /*!< Last Cseq of non-invite */
1212         struct ast_flags flags[2];              /*!< SIP_ flags */
1213
1214         /* boolean or small integers that don't belong in flags */
1215         char do_history;                        /*!< Set if we want to record history */
1216         char alreadygone;                       /*!< already destroyed by our peer */
1217         char needdestroy;                       /*!< need to be destroyed by the monitor thread */
1218         char outgoing_call;                     /*!< this is an outgoing call */
1219         char answered_elsewhere;                /*!< This call is cancelled due to answer on another channel */
1220         char novideo;                           /*!< Didn't get video in invite, don't offer */
1221         char notext;                            /*!< Text not supported  (?) */
1222
1223         int timer_t1;                           /*!< SIP timer T1, ms rtt */
1224         int timer_b;                            /*!< SIP timer B, ms */
1225         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
1226         unsigned int reqsipoptions;             /*!< Required SIP options on the other end */
1227         struct ast_codec_pref prefs;            /*!< codec prefs */
1228         int capability;                         /*!< Special capability (codec) */
1229         int jointcapability;                    /*!< Supported capability at both ends (codecs) */
1230         int peercapability;                     /*!< Supported peer capability */
1231         int prefcodec;                          /*!< Preferred codec (outbound only) */
1232         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
1233         int jointnoncodeccapability;            /*!< Joint Non codec capability */
1234         int redircodecs;                        /*!< Redirect codecs */
1235         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */    
1236         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this dialog */
1237         struct t38properties t38;               /*!< T38 settings */
1238         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
1239         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
1240         int callingpres;                        /*!< Calling presentation */
1241         int authtries;                          /*!< Times we've tried to authenticate */
1242         int expiry;                             /*!< How long we take to expire */
1243         long branch;                            /*!< The branch identifier of this session */
1244         char tag[11];                           /*!< Our tag for this session */
1245         int sessionid;                          /*!< SDP Session ID */
1246         int sessionversion;                     /*!< SDP Session Version */
1247         int sessionversion_remote;              /*!< Remote UA's SDP Session Version */
1248         int session_modify;                     /*!< Session modification request true/false  */
1249         struct sockaddr_in sa;                  /*!< Our peer */
1250         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
1251         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
1252         struct sockaddr_in tredirip;            /*!< Where our Text RTP should be going if not to us */
1253         time_t lastrtprx;                       /*!< Last RTP received */
1254         time_t lastrtptx;                       /*!< Last RTP sent */
1255         int rtptimeout;                         /*!< RTP timeout time */
1256         struct sockaddr_in recv;                /*!< Received as */
1257         struct sockaddr_in ourip;               /*!< Our IP (as seen from the outside) */
1258         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
1259         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
1260         int route_persistant;                   /*!< Is this the "real" route? */
1261         struct sip_auth *peerauth;              /*!< Realm authentication */
1262         int noncecount;                         /*!< Nonce-count */
1263         char lastmsg[256];                      /*!< Last Message sent/received */
1264         int amaflags;                           /*!< AMA Flags */
1265         int pendinginvite;                      /*!< Any pending invite ? (seqno of this) */
1266         struct sip_request initreq;             /*!< Latest request that opened a new transaction
1267                                                         within this dialog.
1268                                                         NOT the request that opened the dialog
1269                                                 */
1270         
1271         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
1272         int waitid;                             /*!< Wait ID for scheduler after 491 or other delays */
1273         int autokillid;                         /*!< Auto-kill ID (scheduler) */
1274         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
1275         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
1276         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
1277         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
1278         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
1279         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
1280         
1281         struct ast_dsp *vad;                    /*!< Inband DTMF Detection dsp */
1282         
1283         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one 
1284                                                         Used in peerpoke, mwi subscriptions */
1285         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
1286         struct ast_rtp *rtp;                    /*!< RTP Session */
1287         struct ast_rtp *vrtp;                   /*!< Video RTP session */
1288         struct ast_rtp *trtp;                   /*!< Text RTP session */
1289         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
1290         struct sip_history_head *history;       /*!< History of this SIP dialog */
1291         size_t history_entries;                 /*!< Number of entires in the history */
1292         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
1293         struct sip_invite_param *options;       /*!< Options for INVITE */
1294         int autoframing;                        /*!< The number of Asters we group in a Pyroflax
1295                                                         before strolling to the Grokyzp√•
1296                                                         (A bit unsure of this, please correct if
1297                                                         you know more) */
1298         struct sip_st_dlg *stimer;              /*!< SIP Session-Timers */              
1299 };
1300
1301
1302 /*! Max entires in the history list for a sip_pvt */
1303 #define MAX_HISTORY_ENTRIES 50
1304
1305 /*!
1306  * Here we implement the container for dialogs (sip_pvt), defining
1307  * generic wrapper functions to ease the transition from the current
1308  * implementation (a single linked list) to a different container.
1309  * In addition to a reference to the container, we need functions to lock/unlock
1310  * the container and individual items, and functions to add/remove
1311  * references to the individual items.
1312  */
1313 static struct sip_pvt *dialoglist = NULL;
1314
1315 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
1316 AST_MUTEX_DEFINE_STATIC(dialoglock);
1317
1318 #ifndef DETECT_DEADLOCKS
1319 /*! \brief hide the way the list is locked/unlocked */
1320 static void dialoglist_lock(void)
1321 {
1322         ast_mutex_lock(&dialoglock);
1323 }
1324
1325 static void dialoglist_unlock(void)
1326 {
1327         ast_mutex_unlock(&dialoglock);
1328 }
1329 #else
1330 /* we don't want to HIDE the information about where the lock was requested if trying to debug 
1331  * deadlocks!  So, just make these macros! */
1332 #define dialoglist_lock(x) ast_mutex_lock(&dialoglock)
1333 #define dialoglist_unlock(x) ast_mutex_unlock(&dialoglock)
1334 #endif
1335
1336 /*!
1337  * when we create or delete references, make sure to use these
1338  * functions so we keep track of the refcounts.
1339  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1340  */
1341 static struct sip_pvt *dialog_ref(struct sip_pvt *p)
1342 {
1343         return p;
1344 }
1345
1346 static struct sip_pvt *dialog_unref(struct sip_pvt *p)
1347 {
1348         return NULL;
1349 }
1350
1351 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission
1352  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1353  * Each packet holds a reference to the parent struct sip_pvt.
1354  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1355  * require retransmissions.
1356  */
1357 struct sip_pkt {
1358         struct sip_pkt *next;                   /*!< Next packet in linked list */
1359         int retrans;                            /*!< Retransmission number */
1360         int method;                             /*!< SIP method for this packet */
1361         int seqno;                              /*!< Sequence number */
1362         char is_resp;                           /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1363         char is_fatal;                          /*!< non-zero if there is a fatal error */
1364         struct sip_pvt *owner;                  /*!< Owner AST call */
1365         int retransid;                          /*!< Retransmission ID */
1366         int timer_a;                            /*!< SIP timer A, retransmission timer */
1367         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1368         int packetlen;                          /*!< Length of packet */
1369         char data[0];
1370 };      
1371
1372 /*! \brief Structure for SIP user data. User's place calls to us */
1373 struct sip_user {
1374         /* Users who can access various contexts */
1375         ASTOBJ_COMPONENTS(struct sip_user);
1376         char secret[80];                /*!< Password */
1377         char md5secret[80];             /*!< Password in md5 */
1378         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1379         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1380         char cid_num[80];               /*!< Caller ID num */
1381         char cid_name[80];              /*!< Caller ID name */
1382         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1383         char language[MAX_LANGUAGE];    /*!< Default language for this user */
1384         char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1385         char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1386         char useragent[256];            /*!< User agent in SIP request */
1387         struct ast_codec_pref prefs;    /*!< codec prefs */
1388         ast_group_t callgroup;          /*!< Call group */
1389         ast_group_t pickupgroup;        /*!< Pickup Group */
1390         unsigned int sipoptions;        /*!< Supported SIP options */
1391         struct ast_flags flags[2];      /*!< SIP_ flags */
1392
1393         /* things that don't belong in flags */
1394         char is_realtime;               /*!< this is a 'realtime' user */
1395
1396         int amaflags;                   /*!< AMA flags for billing */
1397         int callingpres;                /*!< Calling id presentation */
1398         int capability;                 /*!< Codec capability */
1399         int inUse;                      /*!< Number of calls in use */
1400         int call_limit;                 /*!< Limit of concurrent calls */
1401         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1402         struct ast_ha *ha;              /*!< ACL setting */
1403         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1404         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1405         int autoframing;
1406         struct sip_st_cfg stimer;       /*!< SIP Session-Timers */
1407 };
1408
1409 /*!
1410  * \brief A peer's mailbox
1411  *
1412  * We could use STRINGFIELDS here, but for only two strings, it seems like
1413  * too much effort ...
1414  */
1415 struct sip_mailbox {
1416         char *mailbox;
1417         char *context;
1418         /*! Associated MWI subscription */
1419         struct ast_event_sub *event_sub;
1420         AST_LIST_ENTRY(sip_mailbox) entry;
1421 };
1422
1423 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1424 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1425 struct sip_peer {
1426         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1427                                         /*!< peer->name is the unique name of this object */
1428         struct sip_socket socket;       /*!< Socket used for this peer */
1429         char secret[80];                /*!< Password */
1430         char md5secret[80];             /*!< Password in MD5 */
1431         struct sip_auth *auth;          /*!< Realm authentication list */
1432         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1433         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1434         char username[80];              /*!< Temporary username until registration */ 
1435         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1436         int amaflags;                   /*!< AMA Flags (for billing) */
1437         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1438         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1439         char fromuser[80];              /*!< From: user when calling this peer */
1440         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1441         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1442         char cid_num[80];               /*!< Caller ID num */
1443         char cid_name[80];              /*!< Caller ID name */
1444         int callingpres;                /*!< Calling id presentation */
1445         int inUse;                      /*!< Number of calls in use */
1446         int inRinging;                  /*!< Number of calls ringing */
1447         int onHold;                     /*!< Peer has someone on hold */
1448         int call_limit;                 /*!< Limit of concurrent calls */
1449         int busy_level;                 /*!< Level of active channels where we signal busy */
1450         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1451         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1452         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1453         char mohinterpret[MAX_MUSICCLASS];/*!<  Music on Hold class */
1454         char mohsuggest[MAX_MUSICCLASS];/*!<  Music on Hold class */
1455         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1456         struct ast_codec_pref prefs;    /*!<  codec prefs */
1457         int lastmsgssent;
1458         unsigned int sipoptions;        /*!<  Supported SIP options */
1459         struct ast_flags flags[2];      /*!<  SIP_ flags */
1460         
1461         /*! Mailboxes that this peer cares about */
1462         AST_LIST_HEAD_NOLOCK(, sip_mailbox) mailboxes;
1463
1464         /* things that don't belong in flags */
1465         char is_realtime;               /*!< this is a 'realtime' peer */
1466         char rt_fromcontact;            /*!< P: copy fromcontact from realtime */
1467         char host_dynamic;              /*!< P: Dynamic Peers register with Asterisk */
1468         char selfdestruct;              /*!< P: Automatic peers need to destruct themselves */
1469
1470         int expire;                     /*!<  When to expire this peer registration */
1471         int capability;                 /*!<  Codec capability */
1472         int rtptimeout;                 /*!<  RTP timeout */
1473         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1474         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1475         ast_group_t callgroup;          /*!<  Call group */
1476         ast_group_t pickupgroup;        /*!<  Pickup group */
1477         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
1478         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1479         struct sockaddr_in addr;        /*!<  IP address of peer */
1480         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1481         
1482         /* Qualification */
1483         struct sip_pvt *call;           /*!<  Call pointer */
1484         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1485         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1486         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1487         int qualifyfreq;                /*!<  Qualification: How often to check for the host to be up */
1488         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
1489         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1490         struct ast_ha *ha;              /*!<  Access control list */
1491         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1492         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1493         int autoframing;
1494         struct sip_st_cfg stimer;       /*!<  SIP Session-Timers */
1495         int timer_t1;                   /*!<  The maximum T1 value for the peer */
1496         int timer_b;                    /*!<  The maximum timer B (transaction timeouts) */
1497 };
1498
1499
1500 /*! \brief Registrations with other SIP proxies
1501  * Created by sip_register(), the entry is linked in the 'regl' list,
1502  * and never deleted (other than at 'sip reload' or module unload times).
1503  * The entry always has a pending timeout, either waiting for an ACK to
1504  * the REGISTER message (in which case we have to retransmit the request),
1505  * or waiting for the next REGISTER message to be sent (either the initial one,
1506  * or once the previously completed registration one expires).
1507  * The registration can be in one of many states, though at the moment
1508  * the handling is a bit mixed.
1509  * Note that the entire evolution of sip_registry (transmissions,
1510  * incoming packets and timeouts) is driven by one single thread,
1511  * do_monitor(), so there is almost no synchronization issue.
1512  * The only exception  is the sip_pvt creation/lookup,
1513  * as the dialoglist is also manipulated by other threads.
1514  */
1515 struct sip_registry {
1516         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1517         AST_DECLARE_STRING_FIELDS(
1518                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1519                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1520                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1521                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1522                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1523                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1524                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1525                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1526                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1527                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
1528                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1529                 AST_STRING_FIELD(callback);     /*!< Contact extension */
1530                 AST_STRING_FIELD(random);
1531         );
1532         enum sip_transport transport;
1533         int portno;                     /*!<  Optional port override */
1534         int expire;                     /*!< Sched ID of expiration */
1535         int expiry;                     /*!< Value to use for the Expires header */
1536         int regattempts;                /*!< Number of attempts (since the last success) */
1537         int timeout;                    /*!< sched id of sip_reg_timeout */
1538         int refresh;                    /*!< How often to refresh */
1539         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1540         enum sipregistrystate regstate; /*!< Registration state (see above) */
1541         struct timeval regtime;         /*!< Last successful registration time */
1542         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1543         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1544         struct sockaddr_in us;          /*!< Who the server thinks we are */
1545         int noncecount;                 /*!< Nonce-count */
1546         char lastmsg[256];              /*!< Last Message sent/received */
1547 };
1548
1549 struct sip_threadinfo {
1550         int stop;
1551         pthread_t threadid;
1552         struct server_instance *ser;
1553         enum sip_transport type;        /* We keep a copy of the type here so we can display it in the connection list */
1554         AST_LIST_ENTRY(sip_threadinfo) list;
1555 };
1556
1557 /* --- Linked lists of various objects --------*/
1558
1559 /*! \brief  The thread list of TCP threads */
1560 static AST_LIST_HEAD_STATIC(threadl, sip_threadinfo);
1561
1562 /*! \brief  The user list: Users and friends */
1563 static struct ast_user_list {
1564         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1565 } userl;
1566
1567 /*! \brief  The peer list: Peers and Friends */
1568 static struct ast_peer_list {
1569         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1570 } peerl;
1571
1572 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
1573 static struct ast_register_list {
1574         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1575         int recheck;
1576 } regl;
1577
1578 static int temp_pvt_init(void *);
1579 static void temp_pvt_cleanup(void *);
1580
1581 /*! \brief A per-thread temporary pvt structure */
1582 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1583
1584 /*! \brief Authentication list for realm authentication 
1585  * \todo Move the sip_auth list to AST_LIST */
1586 static struct sip_auth *authl = NULL;
1587
1588
1589 /* --- Sockets and networking --------------*/
1590
1591 /*! \brief Main socket for SIP communication.
1592  *
1593  * sipsock is shared between the SIP manager thread (which handles reload
1594  * requests), the io handler (sipsock_read()) and the user routines that
1595  * issue writes (using __sip_xmit()).
1596  * The socket is -1 only when opening fails (this is a permanent condition),
1597  * or when we are handling a reload() that changes its address (this is
1598  * a transient situation during which we might have a harmless race, see
1599  * below). Because the conditions for the race to be possible are extremely
1600  * rare, we don't want to pay the cost of locking on every I/O.
1601  * Rather, we remember that when the race may occur, communication is
1602  * bound to fail anyways, so we just live with this event and let
1603  * the protocol handle this above us.
1604  */
1605 static int sipsock  = -1;
1606
1607 static struct sockaddr_in bindaddr;     /*!< The address we bind to */
1608
1609 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1610  *  internip is initialized picking a suitable address from one of the
1611  * interfaces, and the same port number we bind to. It is used as the
1612  * default address/port in SIP messages, and as the default address
1613  * (but not port) in SDP messages.
1614  */
1615 static struct sockaddr_in internip;
1616
1617 /*! \brief our external IP address/port for SIP sessions.
1618  * externip.sin_addr is only set when we know we might be behind
1619  * a NAT, and this is done using a variety of (mutually exclusive)
1620  * ways from the config file:
1621  *
1622  * + with "externip = host[:port]" we specify the address/port explicitly.
1623  *   The address is looked up only once when (re)loading the config file;
1624  * 
1625  * + with "externhost = host[:port]" we do a similar thing, but the
1626  *   hostname is stored in externhost, and the hostname->IP mapping
1627  *   is refreshed every 'externrefresh' seconds;
1628  * 
1629  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
1630  *   to the specified server, and store the result in externip.
1631  *
1632  * Other variables (externhost, externexpire, externrefresh) are used
1633  * to support the above functions.
1634  */
1635 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1636
1637 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
1638 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1639 static int externrefresh = 10;
1640 static struct sockaddr_in stunaddr;             /*!< stun server address */
1641
1642 /*! \brief  List of local networks
1643  * We store "localnet" addresses from the config file into an access list,
1644  * marked as 'DENY', so the call to ast_apply_ha() will return
1645  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1646  * (i.e. presumably public) addresses.
1647  */
1648 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1649
1650 static int ourport_tcp;
1651 static int ourport_tls;
1652 static struct sockaddr_in debugaddr;
1653
1654 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1655
1656 /*! some list management macros. */
1657  
1658 #define UNLINK(element, head, prev) do {        \
1659         if (prev)                               \
1660                 (prev)->next = (element)->next; \
1661         else                                    \
1662                 (head) = (element)->next;       \
1663         } while (0)
1664
1665 /*---------------------------- Forward declarations of functions in chan_sip.c */
1666 /*! \note This is added to help splitting up chan_sip.c into several files
1667         in coming releases */
1668
1669 /*--- PBX interface functions */
1670 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1671 static int sip_devicestate(void *data);
1672 static int sip_sendtext(struct ast_channel *ast, const char *text);
1673 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1674 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1675 static int sip_hangup(struct ast_channel *ast);
1676 static int sip_answer(struct ast_channel *ast);
1677 static struct ast_frame *sip_read(struct ast_channel *ast);
1678 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1679 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1680 static int sip_transfer(struct ast_channel *ast, const char *dest);
1681 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1682 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1683 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1684 static char *sip_get_callid(struct ast_channel *chan);
1685
1686 static int handle_request_do(struct sip_request *req, struct sockaddr_in *sin);
1687 static int sip_standard_port(struct sip_socket s);
1688 static int sip_prepare_socket(struct sip_pvt *p);
1689
1690 /*--- Transmitting responses and requests */
1691 static int sipsock_read(int *id, int fd, short events, void *ignore);
1692 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1693 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1694 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1695 static int retrans_pkt(const void *data);
1696 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1697 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);
1698 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1699 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1700 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1701 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable, int oldsdp);
1702 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1703 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);
1704 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1705 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1706 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1707 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1708 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1709 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
1710 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1711 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1712 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1713 static int transmit_refer(struct sip_pvt *p, const char *dest);
1714 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1715 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1716 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1717 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1718 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1719 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1720 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1721 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1722 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1723
1724 /*--- Dialog management */
1725 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1726                                  int useglobal_nat, const int intended_method);
1727 static int __sip_autodestruct(const void *data);
1728 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1729 static void sip_cancel_destroy(struct sip_pvt *p);
1730 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
1731 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1732 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1733 static void __sip_pretend_ack(struct sip_pvt *p);
1734 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1735 static int auto_congest(const void *arg);
1736 static int update_call_counter(struct sip_pvt *fup, int event);
1737 static int hangup_sip2cause(int cause);
1738 static const char *hangup_cause2sip(int cause);
1739 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1740 static void free_old_route(struct sip_route *route);
1741 static void list_route(struct sip_route *route);
1742 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1743 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1744                                               struct sip_request *req, char *uri);
1745 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1746 static void check_pendings(struct sip_pvt *p);
1747 static void *sip_park_thread(void *stuff);
1748 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1749 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1750
1751 /*--- Codec handling / SDP */
1752 static void try_suggested_sip_codec(struct sip_pvt *p);
1753 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1754 static const char *get_sdp(struct sip_request *req, const char *name);
1755 static int find_sdp(struct sip_request *req);
1756 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1757 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1758                              struct ast_str **m_buf, struct ast_str **a_buf,
1759                              int debug, int *min_packet_size);
1760 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1761                                 struct ast_str **m_buf, struct ast_str **a_buf,
1762                                 int debug);
1763 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp);
1764 static void do_setnat(struct sip_pvt *p, int natflags);
1765 static void stop_media_flows(struct sip_pvt *p);
1766
1767 /*--- Authentication stuff */
1768 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1769 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1770 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1771                                          const char *secret, const char *md5secret, int sipmethod,
1772                                          char *uri, enum xmittype reliable, int ignore);
1773 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1774                                               int sipmethod, char *uri, enum xmittype reliable,
1775                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1776 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1777
1778 /*--- Domain handling */
1779 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1780 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1781 static void clear_sip_domains(void);
1782
1783 /*--- SIP realm authentication */
1784 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
1785 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1786 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1787
1788 /*--- Misc functions */
1789 static int sip_do_reload(enum channelreloadreason reason);
1790 static int reload_config(enum channelreloadreason reason);
1791 static int expire_register(const void *data);
1792 static void *do_monitor(void *data);
1793 static int restart_monitor(void);
1794 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1795 static int sip_refer_allocate(struct sip_pvt *p);
1796 static void ast_quiet_chan(struct ast_channel *chan);
1797 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1798
1799 /*--- Device monitoring and Device/extension state/event handling */
1800 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1801 static int sip_devicestate(void *data);
1802 static int sip_poke_noanswer(const void *data);
1803 static int sip_poke_peer(struct sip_peer *peer);
1804 static void sip_poke_all_peers(void);
1805 static void sip_peer_hold(struct sip_pvt *p, int hold);
1806 static void mwi_event_cb(const struct ast_event *, void *);
1807
1808 /*--- Applications, functions, CLI and manager command helpers */
1809 static const char *sip_nat_mode(const struct sip_pvt *p);
1810 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1811 static char *transfermode2str(enum transfermodes mode) attribute_const;
1812 static const char *nat2str(int nat) attribute_const;
1813 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1814 static char *sip_show_users(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1815 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1816 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1817 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1818 static void  print_group(int fd, ast_group_t group, int crlf);
1819 static const char *dtmfmode2str(int mode) attribute_const;
1820 static int str2dtmfmode(const char *str) attribute_unused;
1821 static const char *insecure2str(int mode) attribute_const;
1822 static void cleanup_stale_contexts(char *new, char *old);
1823 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1824 static const char *domain_mode_to_text(const enum domain_mode mode);
1825 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1826 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1827 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1828 static char *sip_show_user(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1829 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1830 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1831 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1832 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1833 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1834 static char *complete_sip_peer(const char *word, int state, int flags2);
1835 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1836 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1837 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1838 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1839 static char *complete_sip_user(const char *word, int state, int flags2);
1840 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1841 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1842 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1843 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1844 static char *sip_do_debug_ip(int fd, char *arg);
1845 static char *sip_do_debug_peer(int fd, char *arg);
1846 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1847 static char *sip_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1848 static char *sip_do_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1849 static char *sip_no_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1850 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1851 static int sip_addheader(struct ast_channel *chan, void *data);
1852 static int sip_do_reload(enum channelreloadreason reason);
1853 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1854 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1855
1856 /*--- Debugging 
1857         Functions for enabling debug per IP or fully, or enabling history logging for
1858         a SIP dialog
1859 */
1860 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1861 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1862 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1863
1864
1865 /*! \brief Append to SIP dialog history 
1866         \return Always returns 0 */
1867 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1868 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1869 static void sip_dump_history(struct sip_pvt *dialog);
1870
1871 /*--- Device object handling */
1872 static struct sip_peer *temp_peer(const char *name);
1873 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1874 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1875 static int update_call_counter(struct sip_pvt *fup, int event);
1876 static void sip_destroy_peer(struct sip_peer *peer);
1877 static void sip_destroy_user(struct sip_user *user);
1878 static int sip_poke_peer(struct sip_peer *peer);
1879 static void set_peer_defaults(struct sip_peer *peer);
1880 static struct sip_peer *temp_peer(const char *name);
1881 static void register_peer_exten(struct sip_peer *peer, int onoff);
1882 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1883 static struct sip_user *find_user(const char *name, int realtime);
1884 static int sip_poke_peer_s(const void *data);
1885 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1886 static void reg_source_db(struct sip_peer *peer);
1887 static void destroy_association(struct sip_peer *peer);
1888 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1889 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1890
1891 /* Realtime device support */
1892 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1893 static struct sip_user *realtime_user(const char *username);
1894 static void update_peer(struct sip_peer *p, int expiry);
1895 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1896 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
1897 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1898 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1899
1900 /*--- Internal UA client handling (outbound registrations) */
1901 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us);
1902 static void sip_registry_destroy(struct sip_registry *reg);
1903 static int sip_register(const char *value, int lineno);
1904 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1905 static int sip_reregister(const void *data);
1906 static int __sip_do_register(struct sip_registry *r);
1907 static int sip_reg_timeout(const void *data);
1908 static void sip_send_all_registers(void);
1909
1910 /*--- Parsing SIP requests and responses */
1911 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1912 static int determine_firstline_parts(struct sip_request *req);
1913 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1914 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1915 static int find_sip_method(const char *msg);
1916 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1917 static void parse_request(struct sip_request *req);
1918 static const char *get_header(const struct sip_request *req, const char *name);
1919 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1920 static int method_match(enum sipmethod id, const char *name);
1921 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1922 static char *get_in_brackets(char *tmp);
1923 static const char *find_alias(const char *name, const char *_default);
1924 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1925 static int lws2sws(char *msgbuf, int len);
1926 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1927 static char *remove_uri_parameters(char *uri);
1928 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1929 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1930 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1931 static int set_address_from_contact(struct sip_pvt *pvt);
1932 static void check_via(struct sip_pvt *p, struct sip_request *req);
1933 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1934 static int get_rpid_num(const char *input, char *output, int maxlen);
1935 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1936 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1937 static int get_msg_text(char *buf, int len, struct sip_request *req);
1938 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1939
1940 /*--- Constructing requests and responses */
1941 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1942 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1943 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1944 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1945 static int init_resp(struct sip_request *resp, const char *msg);
1946 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1947 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1948 static void build_via(struct sip_pvt *p);
1949 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1950 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1951 static char *generate_random_string(char *buf, size_t size);
1952 static void build_callid_pvt(struct sip_pvt *pvt);
1953 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1954 static void make_our_tag(char *tagbuf, size_t len);
1955 static int add_header(struct sip_request *req, const char *var, const char *value);
1956 static int add_header_contentLength(struct sip_request *req, int len);
1957 static int add_line(struct sip_request *req, const char *line);
1958 static int add_text(struct sip_request *req, const char *text);
1959 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1960 static int add_vidupdate(struct sip_request *req);
1961 static void add_route(struct sip_request *req, struct sip_route *route);
1962 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1963 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1964 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1965 static void set_destination(struct sip_pvt *p, char *uri);
1966 static void append_date(struct sip_request *req);
1967 static void build_contact(struct sip_pvt *p);
1968 static void build_rpid(struct sip_pvt *p);
1969
1970 /*------Request handling functions */
1971 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1972 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);
1973 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1974 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1975 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1976 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1977 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1978 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1979 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1980 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1981 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin);
1982 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1983 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1984
1985 /*------Response handling functions */
1986 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1987 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1988 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1989 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1990
1991 /*----- RTP interface functions */
1992 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);
1993 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1994 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1995 static enum ast_rtp_get_result sip_get_trtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1996 static int sip_get_codec(struct ast_channel *chan);
1997 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1998
1999 /*------ T38 Support --------- */
2000 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); 
2001 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
2002 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
2003 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
2004
2005 /*------ Session-Timers functions --------- */
2006 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
2007 static int  proc_session_timer(const void *vp);
2008 static void stop_session_timer(struct sip_pvt *p);
2009 static void start_session_timer(struct sip_pvt *p);
2010 static void restart_session_timer(struct sip_pvt *p);
2011 static const char *strefresher2str(enum st_refresher r);
2012 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
2013 static int parse_minse(const char *p_hdrval, int *const p_interval);
2014 static int st_get_se(struct sip_pvt *, int max);
2015 static enum st_refresher st_get_refresher(struct sip_pvt *);
2016 static enum st_mode st_get_mode(struct sip_pvt *);
2017 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
2018
2019
2020 /*! \brief Definition of this channel for PBX channel registration */
2021 static const struct ast_channel_tech sip_tech = {
2022         .type = "SIP",
2023         .description = "Session Initiation Protocol (SIP)",
2024         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
2025         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
2026         .requester = sip_request_call,                  /* called with chan unlocked */
2027         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
2028         .call = sip_call,                       /* called with chan locked */
2029         .send_html = sip_sendhtml,
2030         .hangup = sip_hangup,                   /* called with chan locked */
2031         .answer = sip_answer,                   /* called with chan locked */
2032         .read = sip_read,                       /* called with chan locked */
2033         .write = sip_write,                     /* called with chan locked */
2034         .write_video = sip_write,               /* called with chan locked */
2035         .write_text = sip_write,
2036         .indicate = sip_indicate,               /* called with chan locked */
2037         .transfer = sip_transfer,               /* called with chan locked */
2038         .fixup = sip_fixup,                     /* called with chan locked */
2039         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
2040         .send_digit_end = sip_senddigit_end,
2041         .bridge = ast_rtp_bridge,                       /* XXX chan unlocked ? */
2042         .early_bridge = ast_rtp_early_bridge,
2043         .send_text = sip_sendtext,              /* called with chan locked */
2044         .func_channel_read = acf_channel_read,
2045         .get_pvt_uniqueid = sip_get_callid,
2046 };
2047
2048 /*! \brief This version of the sip channel tech has no send_digit_begin
2049  * callback so that the core knows that the channel does not want
2050  * DTMF BEGIN frames.
2051  * The struct is initialized just before registering the channel driver,
2052  * and is for use with channels using SIP INFO DTMF.
2053  */
2054 static struct ast_channel_tech sip_tech_info;
2055
2056 static void *sip_tcp_worker_fn(void *);
2057
2058 static struct ast_tls_config sip_tls_cfg;
2059 static struct ast_tls_config default_tls_cfg;
2060
2061 static struct server_args sip_tcp_desc = {
2062         .accept_fd = -1,
2063         .master = AST_PTHREADT_NULL,
2064         .tls_cfg = NULL,
2065         .poll_timeout = -1,
2066         .name = "sip tcp server",
2067         .accept_fn = server_root,
2068         .worker_fn = sip_tcp_worker_fn,
2069 };
2070
2071 static struct server_args sip_tls_desc = {
2072         .accept_fd = -1,
2073         .master = AST_PTHREADT_NULL,
2074         .tls_cfg = &sip_tls_cfg,
2075         .poll_timeout = -1,
2076         .name = "sip tls server",
2077         .accept_fn = server_root,
2078         .worker_fn = sip_tcp_worker_fn,
2079 };
2080
2081 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
2082 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
2083
2084 /*! \brief map from an integer value to a string.
2085  * If no match is found, return errorstring
2086  */
2087 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2088 {
2089         const struct _map_x_s *cur;
2090
2091         for (cur = table; cur->s; cur++)
2092                 if (cur->x == x)
2093                         return cur->s;
2094         return errorstring;
2095 }
2096
2097 /*! \brief map from a string to an integer value, case insensitive.
2098  * If no match is found, return errorvalue.
2099  */
2100 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2101 {
2102         const struct _map_x_s *cur;
2103
2104         for (cur = table; cur->s; cur++)
2105                 if (!strcasecmp(cur->s, s))
2106                         return cur->x;
2107         return errorvalue;
2108 }
2109
2110
2111 /*! \brief Interface structure with callbacks used to connect to RTP module */
2112 static struct ast_rtp_protocol sip_rtp = {
2113         .type = "SIP",
2114         .get_rtp_info = sip_get_rtp_peer,
2115         .get_vrtp_info = sip_get_vrtp_peer,
2116         .get_trtp_info = sip_get_trtp_peer,
2117         .set_rtp_peer = sip_set_rtp_peer,
2118         .get_codec = sip_get_codec,
2119 };
2120
2121 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct server_instance *ser);
2122
2123 static void *sip_tcp_helper_thread(void *data)
2124 {
2125         struct sip_pvt *pvt = data;
2126         struct server_instance *ser = pvt->socket.ser;
2127
2128         return _sip_tcp_helper_thread(pvt, ser);
2129 }
2130
2131 static void *sip_tcp_worker_fn(void *data)
2132 {
2133         struct server_instance *ser = data;
2134
2135         return _sip_tcp_helper_thread(NULL, ser);
2136 }
2137
2138 /*! \brief SIP TCP helper function */
2139 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct server_instance *ser) 
2140 {
2141         int res, cl;
2142         struct sip_request req = { 0, } , reqcpy = { 0, };
2143         struct sip_threadinfo *me;
2144         char buf[1024];
2145
2146         me = ast_calloc(1, sizeof(*me));
2147
2148         if (!me)
2149                 goto cleanup2;
2150
2151         me->threadid = pthread_self();
2152         me->ser = ser;
2153         if (ser->ssl)
2154                 me->type = SIP_TRANSPORT_TLS;
2155         else
2156                 me->type = SIP_TRANSPORT_TCP;
2157
2158         AST_LIST_LOCK(&threadl);
2159         AST_LIST_INSERT_TAIL(&threadl, me, list);
2160         AST_LIST_UNLOCK(&threadl);
2161
2162         req.socket.lock = ast_calloc(1, sizeof(*req.socket.lock));
2163
2164         if (!req.socket.lock)
2165                 goto cleanup;
2166
2167         ast_mutex_init(req.socket.lock);
2168
2169         for (;;) {
2170                 memset(req.data, 0, sizeof(req.data));
2171                 req.len = 0;
2172                 req.ignore = 0;
2173
2174                 req.socket.fd = ser->fd;
2175                 if (ser->ssl) {
2176                         req.socket.type = SIP_TRANSPORT_TLS;
2177                         req.socket.port = htons(ourport_tls);
2178                 } else {
2179                         req.socket.type = SIP_TRANSPORT_TCP;
2180                         req.socket.port = htons(ourport_tcp);
2181                 }
2182                 res = ast_wait_for_input(ser->fd, -1);
2183                 if (res < 0) {
2184                         ast_debug(1, "ast_wait_for_input returned %d\n", res);
2185                         goto cleanup;
2186                 }
2187
2188                 /* Read in headers one line at a time */
2189                 while (req.len < 4 || strncmp((char *)&req.data + req.len - 4, "\r\n\r\n", 4)) {
2190                         if (req.socket.lock) 
2191                                 ast_mutex_lock(req.socket.lock);
2192                         if (!fgets(buf, sizeof(buf), ser->f))
2193                                 goto cleanup;
2194                         if (req.socket.lock) 
2195                                 ast_mutex_unlock(req.socket.lock);
2196                         if (me->stop) 
2197                                  goto cleanup;
2198                         strncat(req.data, buf, sizeof(req.data) - req.len);
2199                         req.len = strlen(req.data);
2200                 }
2201                 parse_copy(&reqcpy, &req);
2202                 if (sscanf(get_header(&reqcpy, "Content-Length"), "%d", &cl)) {
2203                         while (cl > 0) {
2204                                 if (req.socket.lock) 
2205                                         ast_mutex_lock(req.socket.lock);
2206                                 if (!fread(buf, (cl < sizeof(buf)) ? cl : sizeof(buf), 1, ser->f))
2207                                         goto cleanup;
2208                                 if (req.socket.lock) 
2209                                         ast_mutex_unlock(req.socket.lock);
2210                                 if (me->stop)
2211                                         goto cleanup;
2212                                 cl -= strlen(buf);
2213                                 strncat(req.data, buf, sizeof(req.data) - req.len);
2214                                 req.len = strlen(req.data);
2215                         }
2216                 }
2217                 req.socket.ser = ser;
2218                 handle_request_do(&req, &ser->requestor);
2219         }
2220
2221 cleanup:
2222         AST_LIST_LOCK(&threadl);
2223         AST_LIST_REMOVE(&threadl, me, list);
2224         AST_LIST_UNLOCK(&threadl);
2225         ast_free(me);
2226 cleanup2:
2227         fclose(ser->f);
2228         ast_free(ser);
2229         ast_free(req.socket.lock);
2230
2231         return NULL;
2232 }
2233
2234 #define sip_pvt_lock(x) ast_mutex_lock(&x->pvt_lock)
2235 #define sip_pvt_unlock(x) ast_mutex_unlock(&x->pvt_lock)
2236
2237 /*!
2238  * helper functions to unreference various types of objects.
2239  * By handling them this way, we don't have to declare the
2240  * destructor on each call, which removes the chance of errors.
2241  */
2242 static void unref_peer(struct sip_peer *peer)
2243 {
2244         ASTOBJ_UNREF(peer, sip_destroy_peer);
2245 }
2246
2247 static void unref_user(struct sip_user *user)
2248 {
2249         ASTOBJ_UNREF(user, sip_destroy_user);
2250 }
2251
2252 static void *registry_unref(struct sip_registry *reg)
2253 {
2254         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
2255         ASTOBJ_UNREF(reg, sip_registry_destroy);
2256         return NULL;
2257 }
2258
2259 /*! \brief Add object reference to SIP registry */
2260 static struct sip_registry *registry_addref(struct sip_registry *reg)
2261 {
2262         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
2263         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
2264 }
2265
2266 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
2267 static struct ast_udptl_protocol sip_udptl = {
2268         type: "SIP",
2269         get_udptl_info: sip_get_udptl_peer,
2270         set_udptl_peer: sip_set_udptl_peer,
2271 };
2272
2273 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2274         __attribute__ ((format (printf, 2, 3)));
2275
2276
2277 /*! \brief Convert transfer status to string */
2278 static const char *referstatus2str(enum referstatus rstatus)
2279 {
2280         return map_x_s(referstatusstrings, rstatus, "");
2281 }
2282
2283 /*! \brief Initialize the initital request packet in the pvt structure.
2284         This packet is used for creating replies and future requests in
2285         a dialog */
2286 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
2287 {
2288         if (p->initreq.headers)
2289                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
2290         else
2291                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
2292         /* Use this as the basis */
2293         copy_request(&p->initreq, req);
2294         parse_request(&p->initreq);
2295         if (req->debug)
2296                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
2297 }
2298
2299 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
2300 static void sip_alreadygone(struct sip_pvt *dialog)
2301 {
2302         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
2303         dialog->alreadygone = 1;
2304 }
2305
2306 /*! Resolve DNS srv name or host name in a sip_proxy structure */
2307 static int proxy_update(struct sip_proxy *proxy)
2308 {
2309         /* if it's actually an IP address and not a name,
2310            there's no need for a managed lookup */
2311         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
2312                 /* Ok, not an IP address, then let's check if it's a domain or host */
2313                 /* XXX Todo - if we have proxy port, don't do SRV */
2314                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, global_srvlookup ? "_sip._udp" : NULL) < 0) {
2315                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
2316                         return FALSE;
2317                 }
2318         }
2319         proxy->last_dnsupdate = time(NULL);
2320         return TRUE;
2321 }
2322
2323 /*! \brief Allocate and initialize sip proxy */
2324 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
2325 {
2326         struct sip_proxy *proxy;
2327         proxy = ast_calloc(1, sizeof(*proxy));
2328         if (!proxy)
2329                 return NULL;
2330         proxy->force = force;
2331         ast_copy_string(proxy->name, name, sizeof(proxy->name));
2332         proxy->ip.sin_port = htons((!ast_strlen_zero(port) ? atoi(port) : STANDARD_SIP_PORT));
2333         proxy_update(proxy);
2334         return proxy;
2335 }
2336
2337 /*! \brief Get default outbound proxy or global proxy */
2338 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
2339 {
2340         if (peer && peer->outboundproxy) {
2341                 if (sipdebug)
2342                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
2343                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
2344                 return peer->outboundproxy;
2345         }
2346         if (global_outboundproxy.name[0]) {
2347                 if (sipdebug)
2348                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
2349                 append_history(dialog, "OBproxy", "Using global obproxy %s", global_outboundproxy.name);
2350                 return &global_outboundproxy;
2351         }
2352         if (sipdebug)
2353                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
2354         return NULL;
2355 }
2356
2357 /*! \brief returns true if 'name' (with optional trailing whitespace)
2358  * matches the sip method 'id'.
2359  * Strictly speaking, SIP methods are case SENSITIVE, but we do
2360  * a case-insensitive comparison to be more tolerant.
2361  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
2362  */
2363 static int method_match(enum sipmethod id, const char *name)
2364 {
2365         int len = strlen(sip_methods[id].text);
2366         int l_name = name ? strlen(name) : 0;
2367         /* true if the string is long enough, and ends with whitespace, and matches */
2368         return (l_name >= len && name[len] < 33 &&
2369                 !strncasecmp(sip_methods[id].text, name, len));
2370 }
2371
2372 /*! \brief  find_sip_method: Find SIP method from header */
2373 static int find_sip_method(const char *msg)
2374 {
2375         int i, res = 0;
2376         
2377         if (ast_strlen_zero(msg))
2378                 return 0;
2379         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
2380                 if (method_match(i, msg))
2381                         res = sip_methods[i].id;
2382         }
2383         return res;
2384 }
2385
2386 /*! \brief Parse supported header in incoming packet */
2387 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
2388 {
2389         char *next, *sep;
2390         char *temp;
2391         unsigned int profile = 0;
2392         int i, found;
2393
2394         if (ast_strlen_zero(supported) )
2395                 return 0;
2396         temp = ast_strdupa(supported);
2397
2398         if (sipdebug)
2399                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
2400
2401         for (next = temp; next; next = sep) {
2402                 found = FALSE;
2403                 if ( (sep = strchr(next, ',')) != NULL)
2404                         *sep++ = '\0';
2405                 next = ast_skip_blanks(next);
2406                 if (sipdebug)
2407                         ast_debug(3, "Found SIP option: -%s-\n", next);
2408                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
2409                         if (!strcasecmp(next, sip_options[i].text)) {
2410                                 profile |= sip_options[i].id;
2411                                 found = TRUE;
2412                                 if (sipdebug)
2413                                         ast_debug(3, "Matched SIP option: %s\n", next);
2414                                 break;
2415                         }
2416                 }
2417
2418                 /* This function is used to parse both Suported: and Require: headers.
2419                 Let the caller of this function know that an unknown option tag was 
2420                 encountered, so that if the UAC requires it then the request can be 
2421                 rejected with a 420 response. */
2422                 if (!found)
2423                         profile |= SIP_OPT_UNKNOWN;
2424
2425                 if (!found && sipdebug) {
2426                         if (!strncasecmp(next, "x-", 2))
2427                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
2428                         else
2429                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
2430                 }
2431         }
2432
2433         if (pvt)
2434                 pvt->sipoptions = profile;
2435         return profile;
2436 }
2437
2438 /*! \brief See if we pass debug IP filter */
2439 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
2440 {
2441         if (!sipdebug)
2442                 return 0;
2443         if (debugaddr.sin_addr.s_addr) {
2444                 if (((ntohs(debugaddr.sin_port) != 0)
2445                         && (debugaddr.sin_port != addr->sin_port))
2446                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
2447                         return 0;
2448         }
2449         return 1;
2450 }
2451
2452 /*! \brief The real destination address for a write */
2453 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
2454 {
2455         if (p->outboundproxy)
2456                 return &p->outboundproxy->ip;
2457
2458         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
2459 }
2460
2461 /*! \brief Display SIP nat mode */
2462 static const char *sip_nat_mode(const struct sip_pvt *p)
2463 {
2464         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
2465 }
2466
2467 /*! \brief Test PVT for debugging output */
2468 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
2469 {
2470         if (!sipdebug)
2471                 return 0;
2472         return sip_debug_test_addr(sip_real_dst(p));
2473 }
2474
2475 static inline const char *get_transport(enum sip_transport t)
2476 {
2477         switch (t) {
2478         case SIP_TRANSPORT_UDP:
2479                 return "UDP";
2480         case SIP_TRANSPORT_TCP:
2481                 return "TCP";
2482         case SIP_TRANSPORT_TLS:
2483                 return "TLS";
2484         }
2485
2486         return "UNKNOWN";
2487 }
2488
2489 /*! \brief Transmit SIP message 
2490         Sends a SIP request or response on a given socket (in the pvt)
2491         Called by retrans_pkt, send_request, send_response and 
2492         __sip_reliable_xmit
2493 */
2494 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
2495 {
2496         int res = 0;
2497         const struct sockaddr_in *dst = sip_real_dst(p);
2498
2499         ast_debug(1, "Trying to put '%.10s' onto %s socket...\n", data, get_transport(p->socket.type));
2500
2501         if (sip_prepare_socket(p) < 0)
2502                 return XMIT_ERROR;
2503
2504         if (p->socket.lock)
2505                 ast_mutex_lock(p->socket.lock);
2506
2507         if (p->socket.type & SIP_TRANSPORT_UDP) 
2508                 res = sendto(p->socket.fd, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
2509         else {
2510                 if (p->socket.ser->f) 
2511                         res = server_write(p->socket.ser, data, len);
2512                 else
2513                         ast_debug(1, "No p->socket.ser->f len=%d\n", len);
2514         } 
2515
2516         if (p->socket.lock)
2517                 ast_mutex_unlock(p->socket.lock);
2518
2519         if (res == -1) {
2520                 switch (errno) {
2521                         case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
2522                         case EHOSTUNREACH:      /* Host can't be reached */
2523                         case ENETDOWN:          /* Interface down */
2524                         case ENETUNREACH:       /* Network failure */
2525                                 res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
2526                 }
2527         }
2528         if (res != len)
2529                 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));
2530
2531         return res;
2532 }
2533
2534 /*! \brief Build a Via header for a request */
2535 static void build_via(struct sip_pvt *p)
2536 {
2537         /* Work around buggy UNIDEN UIP200 firmware */
2538         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
2539
2540         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
2541         ast_string_field_build(p, via, "SIP/2.0/%s %s:%d;branch=z9hG4bK%08x%s",
2542                         get_transport(p->socket.type),
2543                         ast_inet_ntoa(p->ourip.sin_addr),
2544                         ntohs(p->ourip.sin_port), p->branch, rport);
2545 }
2546
2547 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
2548  *
2549  * Using the localaddr structure built up with localnet statements in sip.conf
2550  * apply it to their address to see if we need to substitute our
2551  * externip or can get away with our internal bindaddr
2552  * 'us' is always overwritten.
2553  */
2554 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us)
2555 {
2556         struct sockaddr_in theirs;
2557         /* Set want_remap to non-zero if we want to remap 'us' to an externally
2558          * reachable IP address and port. This is done if:
2559          * 1. we have a localaddr list (containing 'internal' addresses marked
2560          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
2561          *    and AST_SENSE_ALLOW on 'external' ones);
2562          * 2. either stunaddr or externip is set, so we know what to use as the
2563          *    externally visible address;
2564          * 3. the remote address, 'them', is external;
2565          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
2566          *    when passed to ast_apply_ha() so it does need to be remapped.
2567          *    This fourth condition is checked later.
2568          */
2569         int want_remap;
2570
2571         *us = internip;         /* starting guess for the internal address */
2572         /* now ask the system what would it use to talk to 'them' */
2573         ast_ouraddrfor(them, &us->sin_addr);
2574         theirs.sin_addr = *them;
2575
2576         want_remap = localaddr &&
2577                 (externip.sin_addr.s_addr || stunaddr.sin_addr.s_addr) &&
2578                 ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
2579
2580         if (want_remap &&
2581             (!global_matchexterniplocally || !ast_apply_ha(localaddr, us)) ) {
2582                 /* if we used externhost or stun, see if it is time to refresh the info */
2583                 if (externexpire && time(NULL) >= externexpire) {
2584                         if (stunaddr.sin_addr.s_addr) {
2585                                 ast_stun_request(sipsock, &stunaddr, NULL, &externip);
2586                         } else {
2587                                 if (ast_parse_arg(externhost, PARSE_INADDR, &externip))
2588                                         ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
2589                         }
2590                         externexpire = time(NULL) + externrefresh;
2591                 }
2592                 if (externip.sin_addr.s_addr)
2593                         *us = externip;
2594                 else
2595                         ast_log(LOG_WARNING, "stun failed\n");
2596                 ast_debug(1, "Target address %s is not local, substituting externip\n", 
2597                         ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
2598         } else if (bindaddr.sin_addr.s_addr) {
2599                 /* no remapping, but we bind to a specific address, so use it. */
2600                 *us = bindaddr;
2601         }
2602 }
2603
2604 /*! \brief Append to SIP dialog history with arg list  */
2605 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
2606 {
2607         char buf[80], *c = buf; /* max history length */
2608         struct sip_history *hist;
2609         int l;
2610
2611         vsnprintf(buf, sizeof(buf), fmt, ap);
2612         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
2613         l = strlen(buf) + 1;
2614         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
2615                 return;
2616         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
2617                 ast_free(hist);
2618                 return;
2619         }
2620         memcpy(hist->event, buf, l);
2621         if (p->history_entries == MAX_HISTORY_ENTRIES) {
2622                 struct sip_history *oldest;
2623                 oldest = AST_LIST_REMOVE_HEAD(p->history, list);
2624                 p->history_entries--;
2625                 ast_free(oldest);
2626         }
2627         AST_LIST_INSERT_TAIL(p->history, hist, list);
2628         p->history_entries++;
2629 }
2630
2631 /*! \brief Append to SIP dialog history with arg list  */
2632 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2633 {
2634         va_list ap;
2635
2636         if (!p)
2637                 return;
2638
2639         if (!p->do_history && !recordhistory && !dumphistory)
2640                 return;
2641
2642         va_start(ap, fmt);
2643         append_history_va(p, fmt, ap);
2644         va_end(ap);
2645
2646         return;
2647 }
2648
2649 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
2650 static int retrans_pkt(const void *data)
2651 {
2652         struct sip_pkt *pkt = (struct sip_pkt *)data, *prev, *cur = NULL;
2653         int reschedule = DEFAULT_RETRANS;
2654         int xmitres = 0;
2655
2656         /* Lock channel PVT */
2657         sip_pvt_lock(pkt->owner);
2658
2659         if (pkt->retrans < MAX_RETRANS) {
2660                 pkt->retrans++;
2661                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
2662                         if (sipdebug)
2663                                 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);
2664                 } else {
2665                         int siptimer_a;
2666
2667                         if (sipdebug)
2668                                 ast_debug(4, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
2669                         if (!pkt->timer_a)
2670                                 pkt->timer_a = 2 ;
2671                         else
2672                                 pkt->timer_a = 2 * pkt->timer_a;
2673  
2674                         /* For non-invites, a maximum of 4 secs */
2675                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
2676                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
2677                                 siptimer_a = 4000;
2678                 
2679                         /* Reschedule re-transmit */
2680                         reschedule = siptimer_a;
2681                         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);
2682                 } 
2683
2684                 if (sip_debug_test_pvt(pkt->owner)) {
2685                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
2686                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
2687                                 pkt->retrans, sip_nat_mode(pkt->owner),
2688                                 ast_inet_ntoa(dst->sin_addr),
2689                                 ntohs(dst->sin_port), pkt->data);
2690                 }
2691
2692                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
2693                 xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
2694                 sip_pvt_unlock(pkt->owner);
2695                 if (xmitres == XMIT_ERROR)
2696                         ast_log(LOG_WARNING, "Network error on retransmit in dialog %s\n", pkt->owner->callid);
2697                 else 
2698                         return  reschedule;
2699         } 
2700         /* Too many retries */
2701         if (pkt->owner && pkt->method != SIP_OPTIONS && xmitres == 0) {
2702                 if (pkt->is_fatal || sipdebug)  /* Tell us if it's critical or if we're debugging */
2703                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n",
2704                                 pkt->owner->callid, pkt->seqno,
2705                                 pkt->is_fatal ? "Critical" : "Non-critical", pkt->is_resp ? "Response" : "Request");
2706         } else if (pkt->method == SIP_OPTIONS && sipdebug) {
2707                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
2708
2709         } 
2710         if (xmitres == XMIT_ERROR) {
2711                 ast_log(LOG_WARNING, "Transmit error :: Cancelling transmission on Call ID %s\n", pkt->owner->callid);
2712                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2713         } else 
2714                 append_history(pkt->owner, "MaxRetries", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2715                 
2716         pkt->retransid = -1;
2717
2718         if (pkt->is_fatal) {
2719                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
2720                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
2721                         usleep(1);
2722                         sip_pvt_lock(pkt->owner);
2723                 }
2724
2725                 if (pkt->owner->owner && !pkt->owner->owner->hangupcause) 
2726                         pkt->owner->owner->hangupcause = AST_CAUSE_NO_USER_RESPONSE;
2727                 
2728                 if (pkt->owner->owner) {
2729                         sip_alreadygone(pkt->owner);
2730                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
2731                         ast_queue_hangup(pkt->owner->owner);
2732                         ast_channel_unlock(pkt->owner->owner);
2733                 } else {
2734                         /* If no channel owner, destroy now */
2735
2736                         /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
2737                         if (pkt->method != SIP_OPTIONS && pkt->method != SIP_REGISTER) {
2738                                 pkt->owner->needdestroy = 1;
2739                                 sip_alreadygone(pkt->owner);
2740                                 append_history(pkt->owner, "DialogKill", "Killing this failed dialog immediately");
2741                         }
2742                 }
2743         }
2744
2745         if (pkt->method == SIP_BYE) {
2746                 /* We're not getting answers on SIP BYE's.  Tear down the call anyway. */
2747                 if (pkt->owner->owner) 
2748                         ast_channel_unlock(pkt->owner->owner);
2749                 append_history(pkt->owner, "ByeFailure", "Remote peer doesn't respond to bye. Destroying call anyway.");
2750                 pkt->owner->needdestroy = 1;
2751         }
2752
2753         /* Remove the packet */
2754         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
2755                 if (cur == pkt) {
2756                         UNLINK(cur, pkt->owner->packets, prev);
2757                         sip_pvt_unlock(pkt->owner);
2758                         ast_free(pkt);
2759                         return 0;
2760                 }
2761         }
2762         /* error case */
2763         ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
2764         sip_pvt_unlock(pkt->owner);
2765         return 0;
2766 }
2767
2768 /*! \brief Transmit packet with retransmits 
2769         \return 0 on success, -1 on failure to allocate packet 
2770 */
2771 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
2772 {
2773         struct sip_pkt *pkt = NULL;
2774         int siptimer_a = DEFAULT_RETRANS;
2775         int xmitres = 0;
2776
2777         if (sipmethod == SIP_INVITE) {
2778                 /* Note this is a pending invite */
2779                 p->pendinginvite = seqno;
2780         }
2781
2782         /* If the transport is something reliable (TCP or TLS) then don't really send this reliably */
2783         /* I removed the code from retrans_pkt that does the same thing so it doesn't get loaded into the scheduler */
2784         /* According to the RFC some packets need to be retransmitted even if its TCP, so this needs to get revisited */
2785         if (!(p->socket.type & SIP_TRANSPORT_UDP)) {
2786                 xmitres = __sip_xmit(dialog_ref(p), data, len); /* Send packet */
2787                 if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2788                         append_history(p, "XmitErr", "%s", fatal ? "(Critical)" : "(Non-critical)");
2789                         return AST_FAILURE;
2790                 } else
2791                         return AST_SUCCESS;
2792         }
2793
2794         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
2795                 return AST_FAILURE;
2796         /* copy data, add a terminator and save length */
2797         memcpy(pkt->data, data, len);
2798         pkt->data[len] = '\0';
2799         pkt->packetlen = len;
2800         /* copy other parameters from the caller */
2801         pkt->method = sipmethod;
2802         pkt->seqno = seqno;
2803         pkt->is_resp = resp;
2804         pkt->is_fatal = fatal;
2805         pkt->owner = dialog_ref(p);
2806         pkt->next = p->packets;
2807         p->packets = pkt;       /* Add it to the queue */
2808         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
2809         if (pkt->timer_t1)
2810                 siptimer_a = pkt->timer_t1 * 2;
2811
2812         /* Schedule retransmission */
2813         pkt->retransid = ast_sched_replace_variable(pkt->retransid, sched, 
2814                 siptimer_a, retrans_pkt, pkt, 1);
2815         if (sipdebug)
2816                 ast_debug(4, "*** SIP TIMER: Initializing retransmit timer on packet: Id  #%d\n", pkt->retransid);
2817
2818         xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);    /* Send packet */
2819
2820         if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2821                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2822                 ast_sched_del(sched, pkt->retransid);   /* No more retransmission */
2823                 pkt->retransid = -1;
2824                 return AST_FAILURE;
2825         } else
2826                 return AST_SUCCESS;
2827 }
2828
2829 /*! \brief Kill a SIP dialog (called only by the scheduler)
2830  * The scheduler has a reference to this dialog when p->autokillid != -1,
2831  * and we are called using that reference. So if the event is not
2832  * rescheduled, we need to call dialog_unref().
2833  */
2834 static int __sip_autodestruct(const void *data)
2835 {
2836         struct sip_pvt *p = (struct sip_pvt *)data;
2837
2838         /* If this is a subscription, tell the phone that we got a timeout */
2839         if (p->subscribed) {
2840                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE);   /* Send last notification */
2841                 p->subscribed = NONE;
2842                 append_history(p, "Subscribestatus", "timeout");
2843                 ast_debug(3, "Re-scheduled destruction of SIP subscription %s\n", p->callid ? p->callid : "<unknown>");
2844                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
2845         }
2846
2847         /* If there are packets still waiting for delivery, delay the destruction */
2848         if (p->packets) {
2849                 ast_debug(3, "Re-scheduled destruction of SIP call %s\n", p->callid ? p->callid : "<unknown>");
2850                 append_history(p, "ReliableXmit", "timeout");
2851                 return 10000;
2852         }
2853
2854         if (p->subscribed == MWI_NOTIFICATION)
2855                 if (p->relatedpeer)
2856                         unref_peer(p->relatedpeer);     /* Remove link to peer. If it's realtime, make sure it's gone from memory) */
2857
2858         /* Reset schedule ID */
2859         p->autokillid = -1;
2860
2861         if (p->owner) {
2862                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2863                 ast_queue_hangup(p->owner);
2864                 dialog_unref(p);
2865         } else if (p->refer) {
2866                 ast_debug(3, "Finally hanging up channel after transfer: %s\n", p->callid);
2867                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2868                 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2869                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2870                 dialog_unref(p);
2871         } else {
2872                 append_history(p, "AutoDestroy", "%s", p->callid);
2873                 ast_debug(3, "Auto destroying SIP dialog '%s'\n", p->callid);
2874                 sip_destroy(p);         /* Go ahead and destroy dialog. All attempts to recover is done */
2875                 /* sip_destroy also absorbs the reference */
2876         }
2877         return 0;
2878 }
2879
2880 /*! \brief Schedule destruction of SIP dialog */
2881 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2882 {
2883         if (ms < 0) {
2884                 if (p->timer_t1 == 0) {
2885                         p->timer_t1 = global_t1;        /* Set timer T1 if not set (RFC 3261) */
2886                         p->timer_b = global_timer_b;  /* Set timer B if not set (RFC 3261) */
2887                 }
2888                 ms = p->timer_t1 * 64;
2889         }
2890         if (sip_debug_test_pvt(p))
2891                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2892         sip_cancel_destroy(p);
2893         if (p->do_history)
2894                 append_history(p, "SchedDestroy", "%d ms", ms);
2895         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, dialog_ref(p));
2896
2897         if (p->stimer && p->stimer->st_active == TRUE && p->stimer->st_schedid > 0)
2898                 stop_session_timer(p);
2899 }
2900
2901 /*! \brief Cancel destruction of SIP dialog.
2902  * Be careful as this also absorbs the reference - if you call it
2903  * from within the scheduler, this might be the last reference.
2904  */
2905 static void sip_cancel_destroy(struct sip_pvt *p)
2906 {
2907         if (p->autokillid > -1) {
2908                 ast_sched_del(sched, p->autokillid);
2909                 append_history(p, "CancelDestroy", "");
2910                 p->autokillid = -1;
2911                 dialog_unref(p);
2912         }
2913 }
2914
2915 /*! \brief Acknowledges receipt of a packet and stops retransmission */
2916 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2917 {
2918         struct sip_pkt *cur, *prev = NULL;
2919         const char *msg = "Not Found";  /* used only for debugging */
2920
2921         sip_pvt_lock(p);
2922
2923         /* If we have an outbound proxy for this dialog, then delete it now since
2924           the rest of the requests in this dialog needs to follow the routing.
2925           If obforcing is set, we will keep the outbound proxy during the whole
2926           dialog, regardless of what the SIP rfc says
2927         */
2928         if (p->outboundproxy && !p->outboundproxy->force)
2929                 p->outboundproxy = NULL;
2930
2931         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2932                 if (cur->seqno != seqno || cur->is_resp != resp)
2933                         continue;
2934                 if (cur->is_resp || cur->method == sipmethod) {
2935                         msg = "Found";
2936                         if (!resp && (seqno == p->pendinginvite)) {
2937                                 ast_debug(1, "Acked pending invite %d\n", p->pendinginvite);
2938                                 p->pendinginvite = 0;
2939                         }
2940                         if (cur->retransid > -1) {
2941                                 if (sipdebug)
2942                                         ast_debug(4, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2943                                 ast_sched_del(sched, cur->retransid);
2944                                 cur->retransid = -1;
2945                         }
2946                         UNLINK(cur, p->packets, prev);
2947                         dialog_unref(cur->owner);
2948                         ast_free(cur);
2949                         break;
2950                 }
2951         }
2952         sip_pvt_unlock(p);
2953         ast_debug(1, "Stopping retransmission on '%s' of %s %d: Match %s\n",
2954                 p->callid, resp ? "Response" : "Request", seqno, msg);
2955 }
2956
2957 /*! \brief Pretend to ack all packets
2958  * maybe the lock on p is not strictly necessary but there might be a race */
2959 static void __sip_pretend_ack(struct sip_pvt *p)
2960 {
2961         struct sip_pkt *cur = NULL;
2962
2963         while (p->packets) {
2964                 int method;
2965                 if (cur == p->packets) {
2966                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2967                         return;
2968                 }
2969                 cur = p->packets;
2970                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2971                 __sip_ack(p, cur->seqno, cur->is_resp, method);
2972         }
2973 }
2974
2975 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2976 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2977 {
2978         struct sip_pkt *cur;
2979         int res = -1;
2980
2981         for (cur = p->packets; cur; cur = cur->next) {
2982                 if (cur->seqno == seqno && cur->is_resp == resp &&
2983                         (cur->is_resp || method_match(sipmethod, cur->data))) {
2984                         /* this is our baby */
2985                         if (cur->retransid > -1) {
2986                                 if (sipdebug)
2987                                         ast_debug(4, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2988                                 ast_sched_del(sched, cur->retransid);
2989                                 cur->retransid = -1;
2990                         }
2991                         res = 0;
2992                         break;
2993                 }
2994         }
2995         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");
2996         return res;
2997 }
2998
2999
3000 /*! \brief Copy SIP request, parse it */
3001 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
3002 {
3003         memset(dst, 0, sizeof(*dst));
3004         memcpy(dst->data, src->data, sizeof(dst->data));
3005         dst->len = src->len;
3006         parse_request(dst);
3007 }
3008
3009 /*! \brief add a blank line if no body */
3010 static void add_blank(struct sip_request *req)
3011 {
3012         if (!req->lines) {
3013                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
3014                 ast_copy_string(req->data + req->len, "\r\n", sizeof(req->data) - req->len);
3015                 req->len += strlen(req->data + req->len);
3016         }
3017 }
3018
3019 /*! \brief Transmit response on SIP request*/
3020 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
3021 {
3022         int res;
3023
3024         add_blank(req);
3025         if (sip_debug_test_pvt(p)) {
3026                 const struct sockaddr_in *dst = sip_real_dst(p);
3027
3028                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
3029                         reliable ? "Reliably " : "", sip_nat_mode(p),
3030                         ast_inet_ntoa(dst->sin_addr),
3031                         ntohs(dst->sin_port), req->data);
3032         }
3033         if (p->do_history) {
3034                 struct sip_request tmp;
3035                 parse_copy(&tmp, req);
3036                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), 
3037                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
3038         }
3039         res = (reliable) ?
3040                  __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
3041                 __sip_xmit(p, req->data, req->len);
3042         if (res > 0)
3043                 return 0;
3044         return res;
3045 }
3046
3047 /*! \brief Send SIP Request to the other part of the dialogue */
3048 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
3049 {
3050         int res;
3051
3052         /* If we have an outbound proxy, reset peer address 
3053                 Only do this once.
3054         */
3055         if (p->outboundproxy) {
3056                 p->sa = p->outboundproxy->ip;
3057         }
3058
3059         add_blank(req);
3060         if (sip_debug_test_pvt(p)) {
3061                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
3062                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->recv.sin_addr), ntohs(p->recv.sin_port), req->data);
3063                 else
3064                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->sa.sin_addr), ntohs(p->sa.sin_port), req->data);
3065         }
3066         if (p->do_history) {
3067                 struct sip_request tmp;
3068                 parse_copy(&tmp, req);
3069                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
3070         }
3071         res = (reliable) ?
3072                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
3073                 __sip_xmit(p, req->data, req->len);
3074         return res;
3075 }
3076
3077 /*! \brief Locate closing quote in a string, skipping escaped quotes.
3078  * optionally with a limit on the search.
3079  * start must be past the first quote.
3080  */
3081 static const char *find_closing_quote(const char *start, const char *lim)
3082 {
3083         char last_char = '\0';
3084         const char *s;
3085         for (s = start; *s && s != lim; last_char = *s++) {
3086                 if (*s == '"' && last_char != '\\')
3087                         break;
3088         }
3089         return s;
3090 }
3091
3092 /*! \brief Pick out text in brackets from character string
3093         \return pointer to terminated stripped string
3094         \param tmp input string that will be modified
3095         Examples:
3096 \verbatim
3097         "foo" <bar>     valid input, returns bar
3098         foo             returns the whole string
3099         < "foo ... >    returns the string between brackets
3100         < "foo...       bogus (missing closing bracket), returns the whole string
3101                         XXX maybe should still skip the opening bracket
3102 \endverbatim
3103  */
3104 static char *get_in_brackets(char *tmp)
3105 {
3106         const char *parse = tmp;
3107         char *first_bracket;
3108
3109         /*
3110          * Skip any quoted text until we find the part in brackets.
3111         * On any error give up and return the full string.
3112         */
3113         while ( (first_bracket = strchr(parse, '<')) ) {
3114                 char *first_quote = strchr(parse, '"');
3115
3116                 if (!first_quote || first_quote > first_bracket)
3117                         break; /* no need to look at quoted part */
3118                 /* the bracket is within quotes, so ignore it */
3119                 parse = find_closing_quote(first_quote + 1, NULL);
3120                 if (!*parse) { /* not found, return full string ? */
3121                         /* XXX or be robust and return in-bracket part ? */
3122                         ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
3123                         break;
3124                 }
3125                 parse++;
3126         }
3127         if (first_bracket) {
3128                 char *second_bracket = strchr(first_bracket + 1, '>');
3129                 if (second_bracket) {
3130                         *second_bracket = '\0';
3131                         tmp = first_bracket + 1;
3132                 } else {
3133                         ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
3134                 }
3135         }
3136         
3137         return tmp;
3138 }
3139
3140 /*! \brief * parses a URI in its components.
3141  *
3142  * \note 
3143  * - If scheme is specified, drop it from the top.
3144  * - If a component is not requested, do not split around it.
3145  *
3146  * This means that if we don't have domain, we cannot split
3147  * name:pass and domain:port.
3148  * It is safe to call with ret_name, pass, domain, port
3149  * pointing all to the same place.
3150  * Init pointers to empty string so we never get NULL dereferencing.
3151  * Overwrites the string.
3152  * return 0 on success, other values on error.
3153  * \verbatim 
3154  * general form we are expecting is sip[s]:username[:password][;parameter]@host[:port][;...] 
3155  * \endverbatim
3156  */
3157 static int parse_uri(char *uri, char *scheme,
3158         char **ret_name, char **pass, char **domain, char **port, char **options)
3159 {
3160         char *name = NULL;
3161         int error = 0;
3162
3163         /* init field as required */
3164         if (pass)
3165                 *pass = "";
3166         if (port)
3167                 *port = "";
3168         if (scheme) {
3169                 int l = strlen(scheme);
3170                 if (!strncasecmp(uri, scheme, l))
3171                         uri += l;
3172                 else {
3173                         ast_debug(1, "Missing scheme '%s' in '%s'\n", scheme, uri);
3174                         error = -1;
3175                 }
3176         }
3177         if (!domain) {
3178                 /* if we don't want to split around domain, keep everything as a name,
3179                  * so we need to do nothing here, except remember why.
3180                  */
3181         } else {
3182                 /* store the result in a temp. variable to avoid it being
3183                  * overwritten if arguments point to the same place.
3184                  */
3185                 char *c, *dom = "";
3186
3187                 if ((c = strchr(uri, '@')) == NULL) {
3188                         /* domain-only URI, according to the SIP RFC. */
3189                         dom = uri;
3190                         name = "";
3191                 } else {
3192                         *c++ = '\0';
3193                         dom = c;
3194                         name = uri;
3195                 }
3196
3197                 /* Remove options in domain and name */
3198                 dom = strsep(&dom, ";");
3199                 name = strsep(&name, ";");
3200
3201                 if (port && (c = strchr(dom, ':'))) { /* Remove :port */
3202                         *c++ = '\0';
3203                         *port = c;
3204                 }
3205                 if (pass && (c = strchr(name, ':'))) {  /* user:password */
3206                         *c++ = '\0';
3207                         *pass = c;
3208                 }
3209                 *domain = dom;
3210         }
3211         if (ret_name)   /* same as for domain, store the result only at the end */
3212                 *ret_name = name;
3213         if (options)
3214                 *options = uri ? uri : "";
3215
3216         return error;
3217 }
3218
3219 /*! \brief Send message with Access-URL header, if this is an HTML URL only! */
3220 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen)
3221 {
3222         struct sip_pvt *p = chan->tech_pvt;
3223
3224         if (subclass != AST_HTML_URL)
3225                 return -1;
3226
3227         ast_string_field_build(p, url, "<%s>;mode=active", data);
3228
3229         if (sip_debug_test_pvt(p))
3230                 ast_debug(1, "Send URL %s, state = %d!\n", data, chan->_state);
3231
3232         switch (chan->_state) {
3233         case AST_STATE_RING:
3234                 transmit_response(p, "100 Trying", &p->initreq);
3235                 break;
3236         case AST_STATE_RINGING:
3237                 transmit_response(p, "180 Ringing", &p->initreq);
3238                 break;
3239         case AST_STATE_UP:
3240                 if (!p->pendinginvite) {                /* We are up, and have no outstanding invite */
3241                         transmit_reinvite_with_sdp(p, FALSE, FALSE);
3242                 } else if (!ast_test_flag(&p->flags[0], SIP_PENDINGBYE)) {
3243                         ast_set_flag(&p->flags[0], SIP_NEEDREINVITE);   
3244                 }       
3245                 break;
3246         default:
3247                 ast_log(LOG_WARNING, "Don't know how to send URI when state is %d!\n", chan->_state);
3248         }
3249
3250         return 0;
3251 }
3252
3253 /*! \brief Deliver SIP call ID for the call */
3254 static char *sip_get_callid(struct ast_channel *chan)
3255 {
3256         struct sip_pvt *p = chan->tech_pvt;
3257         if (!p)
3258                 return "";
3259         return ((char *)p->callid);
3260 }
3261
3262 /*! \brief Send SIP MESSAGE text within a call
3263         Called from PBX core sendtext() application */
3264 static int sip_sendtext(struct ast_channel *ast, const char *text)
3265 {
3266         struct sip_pvt *p = ast->tech_pvt;
3267         int debug = sip_debug_test_pvt(p);
3268
3269         if (debug)
3270                 ast_verbose("Sending text %s on %s\n", text, ast->name);
3271         if (!p)
3272                 return -1;
3273         if (ast_strlen_zero(text))
3274                 return 0;
3275         if (debug)
3276                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
3277         transmit_message_with_text(p, text);
3278         return 0;       
3279 }
3280
3281 /*! \brief Update peer object in realtime storage 
3282         If the Asterisk system name is set in asterisk.conf, we will use
3283         that name and store that in the "regserver" field in the sippeers
3284         table to facilitate multi-server setups.
3285 */
3286 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *defaultuser, const char *fullcontact, int expirey)
3287 {
3288         char port[10];
3289         char ipaddr[INET_ADDRSTRLEN];
3290         char regseconds[20];
3291         char *tablename = NULL;
3292
3293         const char *sysname = ast_config_AST_SYSTEM_NAME;
3294         char *syslabel = NULL;
3295
3296         time_t nowtime = time(NULL) + expirey;
3297         const char *fc = fullcontact ? "fullcontact" : NULL;
3298
3299         int realtimeregs = ast_check_realtime("sipregs");
3300
3301         tablename = realtimeregs ? "sipregs" : "sippeers";
3302         
3303         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
3304         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
3305         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
3306         
3307         if (ast_strlen_zero(sysname))   /* No system name, disable this */
3308                 sysname = NULL;
3309         else if (sip_cfg.rtsave_sysname)
3310                 syslabel = "regserver";
3311
3312         if (fc)
3313                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
3314                         "port", port, "regseconds", regseconds,
3315                         "defaultuser", defaultuser, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
3316         else
3317                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
3318                         "port", port, "regseconds", regseconds,
3319                         "defaultuser", defaultuser, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
3320 }
3321
3322 /*! \brief Automatically add peer extension to dial plan */
3323 static void register_peer_exten(struct sip_peer *peer, int onoff)
3324 {
3325         char multi[256];
3326         char *stringp, *ext, *context;
3327
3328         /* XXX note that global_regcontext is both a global 'enable' flag and
3329          * the name of the global regexten context, if not specified
3330          * individually.
3331          */
3332         if (ast_strlen_zero(global_regcontext))
3333                 return;
3334
3335         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
3336         stringp = multi;
3337         while ((ext = strsep(&stringp, "&"))) {
3338                 if ((context = strchr(ext, '@'))) {
3339                         *context++ = '\0';      /* split ext@context */
3340                         if (!ast_context_find(context)) {
3341                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
3342                                 continue;
3343                         }
3344                 } else {
3345                         context = global_regcontext;
3346                 }
3347                 if (onoff)
3348                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
3349                                  ast_strdup(peer->name), ast_free_ptr, "SIP");
3350                 else
3351                         ast_context_remove_extension(context, ext, 1, NULL);
3352         }
3353 }
3354
3355 /*! Destroy mailbox subscriptions */
3356 static void destroy_mailbox(struct sip_mailbox *mailbox)
3357 {
3358         if (mailbox->mailbox)
3359                 ast_free(mailbox->mailbox);
3360         if (mailbox->context)
3361                 ast_free(mailbox->context);
3362         if (mailbox->event_sub)
3363                 ast_event_unsubscribe(mailbox->event_sub);
3364         ast_free(mailbox);
3365 }
3366
3367 /*! Destroy all peer-related mailbox subscriptions */
3368 static void clear_peer_mailboxes(struct sip_peer *peer)
3369 {
3370         struct sip_mailbox *mailbox;
3371
3372         while ((mailbox = AST_LIST_REMOVE_HEAD(&peer->mailboxes, entry)))
3373                 destroy_mailbox(mailbox);
3374 }
3375
3376 /*! \brief Destroy peer object from memory */
3377 static void sip_destroy_peer(struct sip_peer *peer)
3378 {
3379         ast_debug(3, "Destroying SIP peer %s\n", peer->name);
3380
3381         if (peer->outboundproxy)
3382                 ast_free(peer->outboundproxy);
3383         peer->outboundproxy = NULL;
3384
3385         /* Delete it, it needs to disappear */
3386         if (peer->call)
3387                 peer->call = sip_destroy(peer->call);
3388
3389         if (peer->mwipvt)       /* We have an active subscription, delete it */
3390                 peer->mwipvt = sip_destroy(peer->mwipvt);
3391
3392         if (peer->chanvars) {
3393                 ast_variables_destroy(peer->chanvars);
3394                 peer->chanvars = NULL;
3395         }
3396
3397         /* If the schedule delete fails, that means the schedule is currently
3398          * running, which means we should wait for that thread to complete.
3399          * Otherwise, there's a crashable race condition.
3400          *
3401          * NOTE: once peer is refcounted, this probably is no longer necessary.
3402          */
3403         while (peer->expire > -1 && ast_sched_del(sched, peer->expire))
3404                 usleep(1);
3405         while (peer->pokeexpire > -1 && ast_sched_del(sched, peer->pokeexpire))
3406                 usleep(1);
3407
3408         register_peer_exten(peer, FALSE);
3409         ast_free_ha(peer->ha);
3410         if (peer->selfdestruct)
3411                 apeerobjs--;
3412         else if (peer->is_realtime) {
3413                 rpeerobjs--;
3414                 ast_debug(3,"-REALTIME- peer Destroyed. Name: %s. Realtime Peer objects: %d\n", peer->name, rpeerobjs);
3415         } else
3416                 speerobjs--;
3417         clear_realm_authentication(peer->auth);
3418         peer->auth = NULL;
3419         if (peer->dnsmgr)
3420                 ast_dnsmgr_release(peer->dnsmgr);
3421         clear_peer_mailboxes(peer);
3422         ast_free(peer);
3423 }
3424
3425 /*! \brief Update peer data in database (if used) */
3426 static void update_peer(struct sip_peer *p, int expiry)
3427 {
3428         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
3429         if (sip_cfg.peer_rtupdate &&
3430             (p->is_realtime || rtcachefriends)) {
3431                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
3432         }
3433 }
3434
3435 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config)
3436 {
3437         struct ast_variable *var = NULL;
3438         struct ast_flags flags = {0};
3439         char *cat = NULL;
3440         const char *insecure;
3441         while ((cat = ast_category_browse(config, cat))) {
3442                 insecure = ast_variable_retrieve(config, cat, "insecure");
3443                 set_insecure_flags(&flags, insecure, -1);
3444                 if (ast_test_flag(&flags, SIP_INSECURE_PORT)) {
3445                         var = ast_category_root(config, cat);
3446                         break;
3447                 }
3448         }
3449         return var;
3450 }
3451
3452 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername)
3453 {
3454         struct ast_variable *tmp;
3455         for (tmp = var; tmp; tmp = tmp->next) {
3456                 if (!newpeername && !strcasecmp(tmp->name, "name"))
3457                         newpeername = tmp->value;
3458         }
3459         return newpeername;
3460 }
3461
3462 /*! \brief  realtime_peer: Get peer from realtime storage
3463  * Checks the "sippeers" realtime family from extconfig.conf 
3464  * Checks the "sipregs" realtime family from extconfig.conf if it's configured.
3465 */
3466 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin)
3467 {
3468         struct sip_peer *peer;
3469         struct ast_variable *var = NULL;
3470         struct ast_variable *varregs = NULL;
3471         struct ast_variable *tmp;
3472         struct ast_config *peerlist = NULL;
3473         char ipaddr[INET_ADDRSTRLEN];
3474         char portstring[6]; /*up to 5 digits plus null terminator*/
3475         char *cat = NULL;
3476         unsigned short portnum;
3477         int realtimeregs = ast_check_realtime("sipregs");
3478
3479         /* First check on peer name */
3480         if (newpeername) {
3481                 if (realtimeregs)
3482                         varregs = ast_load_realtime("sipregs", "name", newpeername, NULL);
3483
3484                 var = ast_load_realtime("sippeers", "name", newpeername, "host", "dynamic", NULL);
3485                 if (!var && sin)
3486                         var = ast_load_realtime("sippeers", "name", newpeername, "host", ast_inet_ntoa(sin->sin_addr), NULL);
3487                 if (!var) {
3488                         var = ast_load_realtime("sippeers", "name", newpeername, NULL);
3489                         /*!\note
3490                          * If this one loaded something, then we need to ensure that the host
3491                          * field matched.  The only reason why we can't have this as a criteria
3492                          * is because we only have the IP address and the host field might be
3493                          * set as a name (and the reverse PTR might not match).
3494                          */
3495                         if (var) {
3496                                 for (tmp = var; tmp; tmp = tmp->next) {
3497                                         if (!strcasecmp(var->name, "host")) {
3498                                                 struct in_addr sin2 = { 0, };
3499           &nbs