445 lines
12 KiB
C#
445 lines
12 KiB
C#
#region License
|
|
/*
|
|
* TcpListenerWebSocketContext.cs
|
|
*
|
|
* The MIT License
|
|
*
|
|
* Copyright (c) 2012-2016 sta.blockhead
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
#endregion
|
|
|
|
#region Contributors
|
|
/*
|
|
* Contributors:
|
|
* - Liryna <liryna.stark@gmail.com>
|
|
*/
|
|
#endregion
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Collections.Specialized;
|
|
using System.IO;
|
|
using System.Net.Security;
|
|
using System.Net.Sockets;
|
|
using System.Security.Principal;
|
|
using System.Text;
|
|
|
|
namespace WebSocketSharp.Net.WebSockets
|
|
{
|
|
/// <summary>
|
|
/// Provides the properties used to access the information in
|
|
/// a WebSocket handshake request received by the <see cref="TcpListener"/>.
|
|
/// </summary>
|
|
internal class TcpListenerWebSocketContext : WebSocketContext
|
|
{
|
|
#region Private Fields
|
|
|
|
private CookieCollection _cookies;
|
|
private Logger _logger;
|
|
private NameValueCollection _queryString;
|
|
private HttpRequest _request;
|
|
private bool _secure;
|
|
private Stream _stream;
|
|
private TcpClient _tcpClient;
|
|
private Uri _uri;
|
|
private IPrincipal _user;
|
|
private WebSocket _websocket;
|
|
|
|
#endregion
|
|
|
|
#region Internal Constructors
|
|
|
|
internal TcpListenerWebSocketContext (
|
|
TcpClient tcpClient,
|
|
string protocol,
|
|
bool secure,
|
|
ServerSslConfiguration sslConfig,
|
|
Logger logger
|
|
)
|
|
{
|
|
_tcpClient = tcpClient;
|
|
_secure = secure;
|
|
_logger = logger;
|
|
|
|
var netStream = tcpClient.GetStream ();
|
|
if (secure) {
|
|
var sslStream =
|
|
new SslStream (netStream, false, sslConfig.ClientCertificateValidationCallback);
|
|
|
|
sslStream.AuthenticateAsServer (
|
|
sslConfig.ServerCertificate,
|
|
sslConfig.ClientCertificateRequired,
|
|
sslConfig.EnabledSslProtocols,
|
|
sslConfig.CheckCertificateRevocation
|
|
);
|
|
|
|
_stream = sslStream;
|
|
}
|
|
else {
|
|
_stream = netStream;
|
|
}
|
|
|
|
_request = HttpRequest.Read (_stream, 90000);
|
|
_uri =
|
|
HttpUtility.CreateRequestUrl (
|
|
_request.RequestUri, _request.Headers["Host"], _request.IsWebSocketRequest, secure
|
|
);
|
|
|
|
_websocket = new WebSocket (this, protocol);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Internal Properties
|
|
|
|
internal Logger Log {
|
|
get {
|
|
return _logger;
|
|
}
|
|
}
|
|
|
|
internal Stream Stream {
|
|
get {
|
|
return _stream;
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Public Properties
|
|
|
|
/// <summary>
|
|
/// Gets the HTTP cookies included in the request.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="WebSocketSharp.Net.CookieCollection"/> that contains the cookies.
|
|
/// </value>
|
|
public override CookieCollection CookieCollection {
|
|
get {
|
|
return _cookies ?? (_cookies = _request.Cookies);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the HTTP headers included in the request.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="NameValueCollection"/> that contains the headers.
|
|
/// </value>
|
|
public override NameValueCollection Headers {
|
|
get {
|
|
return _request.Headers;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the value of the Host header included in the request.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="string"/> that represents the value of the Host header.
|
|
/// </value>
|
|
public override string Host {
|
|
get {
|
|
return _request.Headers["Host"];
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the client is authenticated.
|
|
/// </summary>
|
|
/// <value>
|
|
/// <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
|
|
/// </value>
|
|
public override bool IsAuthenticated {
|
|
get {
|
|
return _user != null;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the client connected from the local computer.
|
|
/// </summary>
|
|
/// <value>
|
|
/// <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>.
|
|
/// </value>
|
|
public override bool IsLocal {
|
|
get {
|
|
return UserEndPoint.Address.IsLocal ();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the WebSocket connection is secured.
|
|
/// </summary>
|
|
/// <value>
|
|
/// <c>true</c> if the connection is secured; otherwise, <c>false</c>.
|
|
/// </value>
|
|
public override bool IsSecureConnection {
|
|
get {
|
|
return _secure;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the request is a WebSocket handshake request.
|
|
/// </summary>
|
|
/// <value>
|
|
/// <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>.
|
|
/// </value>
|
|
public override bool IsWebSocketRequest {
|
|
get {
|
|
return _request.IsWebSocketRequest;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the value of the Origin header included in the request.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="string"/> that represents the value of the Origin header.
|
|
/// </value>
|
|
public override string Origin {
|
|
get {
|
|
return _request.Headers["Origin"];
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the query string included in the request.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="NameValueCollection"/> that contains the query string parameters.
|
|
/// </value>
|
|
public override NameValueCollection QueryString {
|
|
get {
|
|
return _queryString
|
|
?? (
|
|
_queryString =
|
|
HttpUtility.InternalParseQueryString (
|
|
_uri != null ? _uri.Query : null, Encoding.UTF8
|
|
)
|
|
);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the URI requested by the client.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="Uri"/> that represents the requested URI.
|
|
/// </value>
|
|
public override Uri RequestUri {
|
|
get {
|
|
return _uri;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the value of the Sec-WebSocket-Key header included in the request.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This property provides a part of the information used by the server to prove that
|
|
/// it received a valid WebSocket handshake request.
|
|
/// </remarks>
|
|
/// <value>
|
|
/// A <see cref="string"/> that represents the value of the Sec-WebSocket-Key header.
|
|
/// </value>
|
|
public override string SecWebSocketKey {
|
|
get {
|
|
return _request.Headers["Sec-WebSocket-Key"];
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the values of the Sec-WebSocket-Protocol header included in the request.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This property represents the subprotocols requested by the client.
|
|
/// </remarks>
|
|
/// <value>
|
|
/// An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides
|
|
/// an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol
|
|
/// header.
|
|
/// </value>
|
|
public override IEnumerable<string> SecWebSocketProtocols {
|
|
get {
|
|
var protocols = _request.Headers["Sec-WebSocket-Protocol"];
|
|
if (protocols != null) {
|
|
foreach (var protocol in protocols.Split (','))
|
|
yield return protocol.Trim ();
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the value of the Sec-WebSocket-Version header included in the request.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This property represents the WebSocket protocol version.
|
|
/// </remarks>
|
|
/// <value>
|
|
/// A <see cref="string"/> that represents the value of the Sec-WebSocket-Version header.
|
|
/// </value>
|
|
public override string SecWebSocketVersion {
|
|
get {
|
|
return _request.Headers["Sec-WebSocket-Version"];
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the server endpoint as an IP address and a port number.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="System.Net.IPEndPoint"/> that represents the server endpoint.
|
|
/// </value>
|
|
public override System.Net.IPEndPoint ServerEndPoint {
|
|
get {
|
|
return (System.Net.IPEndPoint) _tcpClient.Client.LocalEndPoint;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the client information (identity, authentication, and security roles).
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="IPrincipal"/> instance that represents the client information.
|
|
/// </value>
|
|
public override IPrincipal User {
|
|
get {
|
|
return _user;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the client endpoint as an IP address and a port number.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="System.Net.IPEndPoint"/> that represents the client endpoint.
|
|
/// </value>
|
|
public override System.Net.IPEndPoint UserEndPoint {
|
|
get {
|
|
return (System.Net.IPEndPoint) _tcpClient.Client.RemoteEndPoint;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the <see cref="WebSocketSharp.WebSocket"/> instance used for
|
|
/// two-way communication between client and server.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="WebSocketSharp.WebSocket"/>.
|
|
/// </value>
|
|
public override WebSocket WebSocket {
|
|
get {
|
|
return _websocket;
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Internal Methods
|
|
|
|
internal bool Authenticate (
|
|
AuthenticationSchemes scheme,
|
|
string realm,
|
|
Func<IIdentity, NetworkCredential> credentialsFinder
|
|
)
|
|
{
|
|
if (scheme == AuthenticationSchemes.Anonymous)
|
|
return true;
|
|
|
|
if (scheme == AuthenticationSchemes.None) {
|
|
Close (HttpStatusCode.Forbidden);
|
|
return false;
|
|
}
|
|
|
|
var chal = new AuthenticationChallenge (scheme, realm).ToString ();
|
|
|
|
var retry = -1;
|
|
Func<bool> auth = null;
|
|
auth =
|
|
() => {
|
|
retry++;
|
|
if (retry > 99) {
|
|
Close (HttpStatusCode.Forbidden);
|
|
return false;
|
|
}
|
|
|
|
var user =
|
|
HttpUtility.CreateUser (
|
|
_request.Headers["Authorization"],
|
|
scheme,
|
|
realm,
|
|
_request.HttpMethod,
|
|
credentialsFinder
|
|
);
|
|
|
|
if (user == null || !user.Identity.IsAuthenticated) {
|
|
SendAuthenticationChallenge (chal);
|
|
return auth ();
|
|
}
|
|
|
|
_user = user;
|
|
return true;
|
|
};
|
|
|
|
return auth ();
|
|
}
|
|
|
|
internal void Close ()
|
|
{
|
|
_stream.Close ();
|
|
_tcpClient.Close ();
|
|
}
|
|
|
|
internal void Close (HttpStatusCode code)
|
|
{
|
|
_websocket.Close (HttpResponse.CreateCloseResponse (code));
|
|
}
|
|
|
|
internal void SendAuthenticationChallenge (string challenge)
|
|
{
|
|
var buff = HttpResponse.CreateUnauthorizedResponse (challenge).ToByteArray ();
|
|
_stream.Write (buff, 0, buff.Length);
|
|
_request = HttpRequest.Read (_stream, 15000);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Public Methods
|
|
|
|
/// <summary>
|
|
/// Returns a <see cref="string"/> that represents
|
|
/// the current <see cref="TcpListenerWebSocketContext"/>.
|
|
/// </summary>
|
|
/// <returns>
|
|
/// A <see cref="string"/> that represents
|
|
/// the current <see cref="TcpListenerWebSocketContext"/>.
|
|
/// </returns>
|
|
public override string ToString ()
|
|
{
|
|
return _request.ToString ();
|
|
}
|
|
|
|
#endregion
|
|
}
|
|
}
|