DevWiki/websocket-sharp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Modified validating the cookies from client

Browse Source
This commit is contained in:
sta 2013-08-08 15:12:29 +09:00
parent 93b30f94d7
commit acde107832
3 changed files with 165 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Example2/Echo.cs
View File

@ -3,19 +3,19 @@ using WebSocketSharp;
using WebSocketSharp.Net;
using WebSocketSharp.Server;
namespace Example2 {
namespace Example2
{
public class Echo : WebSocketService
{
protected override void OnMessage (MessageEventArgs e)
{
var msg = QueryString.Contains ("name")
? String.Format("'{0}' returns to {1}", e.Data, QueryString["name"])
? String.Format ("Returns '{0}' to {1}", e.Data, QueryString ["name"])
: e.Data;
Send (msg);
}
protected override bool ProcessCookies(CookieCollection request, CookieCollection response)
protected override bool ValidateCookies (CookieCollection request, CookieCollection response)
{
foreach (Cookie cookie in request)
{

142
websocket-sharp/Server/WebSocketService.cs
View File

@ -33,16 +33,16 @@ using System.Threading;
using WebSocketSharp.Net;
using WebSocketSharp.Net.WebSockets;
namespace WebSocketSharp.Server {
namespace WebSocketSharp.Server
{
/// <summary>
/// Provides the basic functions of the WebSocket service.
/// </summary>
/// <remarks>
/// The WebSocketService class is an abstract class.
/// </remarks>
public abstract class WebSocketService {
public abstract class WebSocketService
{
#region Private Fields
private WebSocketContext _context;
@ -80,7 +80,7 @@ namespace WebSocketSharp.Server {
/// Gets or sets the logging functions.
/// </summary>
/// <remarks>
/// If you wanted to change the current logger to the service own logger, you would set this property
/// If you want to change the current logger to the service own logger, you set this property
/// to a new <see cref="Logger"/> instance that you created.
/// </remarks>
/// <value>
@ -102,7 +102,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Gets the collection of query string variables used in the WebSocket opening handshake.
/// Gets the collection of query string variables used in the WebSocket connection request.
/// </summary>
/// <value>
/// A <see cref="NameValueCollection"/> that contains the collection of query string variables.
@ -116,10 +116,11 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Gets the sessions to the <see cref="WebSocketService"/>.
/// Gets the sessions to the <see cref="WebSocketService"/> instances.
/// </summary>
/// <value>
/// A <see cref="WebSocketServiceManager"/> that contains the sessions to the the <see cref="WebSocketService"/>.
/// A <see cref="WebSocketServiceManager"/> that contains the sessions to
/// the <see cref="WebSocketService"/> instances.
/// </value>
protected WebSocketServiceManager Sessions {
get {
@ -134,20 +135,26 @@ namespace WebSocketSharp.Server {
#region Public Properties
/// <summary>
/// Gets the ID of the <see cref="WebSocketService"/> instance.
/// Gets the ID of the current <see cref="WebSocketService"/> instance.
/// </summary>
/// <value>
/// A <see cref="string"/> that contains an ID.
/// </value>
public string ID { get; private set; }
public string ID {
get; private set;
}
/// <summary>
/// Gets a value indicating whether the <see cref="WebSocketService"/> instance is bound to a <see cref="WebSocket"/>.
/// Gets a value indicating whether the current <see cref="WebSocketService"/> instance
/// has been bound to a <see cref="WebSocket"/>.
/// </summary>
/// <value>
/// <c>true</c> if the <see cref="WebSocketService"/> instance is bound to a <see cref="WebSocket"/>; otherwise, <c>false</c>.
/// <c>true</c> if the current <see cref="WebSocketService"/> instance has been bound to
/// a <see cref="WebSocket"/>; otherwise, <c>false</c>.
/// </value>
public bool IsBound { get; private set; }
public bool IsBound {
get; private set;
}
#endregion
@ -184,16 +191,10 @@ namespace WebSocketSharp.Server {
if (IsBound)
return;
if (!ProcessCookies(context.CookieCollection, context.WebSocket.CookieCollection))
{
context.WebSocket.Close(HttpStatusCode.BadRequest);
return;
}
_context = context;
_sessions = sessions;
_websocket = context.WebSocket;
_websocket.CookiesValidation = ValidateCookies;
_websocket.OnOpen += onOpen;
_websocket.OnMessage += onMessage;
_websocket.OnError += onError;
@ -217,55 +218,64 @@ namespace WebSocketSharp.Server {
#region Protected Methods
/// <summary>
/// Occurs when the inner <see cref="WebSocket"/> receives a Close frame or the Stop method is called.
/// Is called when the WebSocket connection has been closed.
/// </summary>
/// <param name="e">
/// A <see cref="CloseEventArgs"/> that contains the event data associated with a <see cref="WebSocket.OnClose"/> event.
/// A <see cref="CloseEventArgs"/> that contains an event data associated with
/// an inner <see cref="WebSocket.OnClose"/> event.
/// </param>
protected virtual void OnClose (CloseEventArgs e)
{
}
/// <summary>
/// Occurs when the inner <see cref="WebSocket"/> gets an error.
/// Is called when the inner <see cref="WebSocket"/> gets an error.
/// </summary>
/// <param name="e">
/// An <see cref="ErrorEventArgs"/> that contains the event data associated with a <see cref="WebSocket.OnError"/> event.
/// An <see cref="ErrorEventArgs"/> that contains an event data associated with
/// an inner <see cref="WebSocket.OnError"/> event.
/// </param>
protected virtual void OnError (ErrorEventArgs e)
{
}
/// <summary>
/// Occurs when the inner <see cref="WebSocket"/> receives a data frame.
/// Is called when the inner <see cref="WebSocket"/> receives a data frame.
/// </summary>
/// <param name="e">
/// A <see cref="MessageEventArgs"/> that contains the event data associated with a <see cref="WebSocket.OnMessage"/> event.
/// A <see cref="MessageEventArgs"/> that contains an event data associated with
/// an inner <see cref="WebSocket.OnMessage"/> event.
/// </param>
protected virtual void OnMessage (MessageEventArgs e)
{
}
/// <summary>
/// Occurs when the WebSocket connection has been established.
/// Is called when the WebSocket connection has been established.
/// </summary>
protected virtual void OnOpen ()
{
}
/// <summary>
/// Processes the cookies used in the WebSocket opening handshake.
/// Validates the cookies used in the WebSocket connection request.
/// </summary>
/// <remarks>
/// This method is called when the inner <see cref="WebSocket"/> validates
/// the WebSocket connection request.
/// </remarks>
/// <returns>
/// <c>true</c> if processing the cookies is successfully; otherwise, <c>false</c>.
/// <c>true</c> if the cookies is valid; otherwise, <c>false</c>.
/// The default returns <c>true</c>.
/// </returns>
/// <param name="request">
/// A <see cref="CookieCollection"/> that contains a collection of the HTTP Cookies received from the client.
/// A <see cref="CookieCollection"/> that contains a collection of the HTTP Cookies
/// to validate.
/// </param>
/// <param name="response">
/// A <see cref="CookieCollection"/> that contains a collection of the HTTP Cookies to send to the client.
/// A <see cref="CookieCollection"/> that receives the HTTP Cookies to send to the client.
/// </param>
protected virtual bool ProcessCookies(CookieCollection request, CookieCollection response)
protected virtual bool ValidateCookies (CookieCollection request, CookieCollection response)
{
return true;
}
@ -275,8 +285,8 @@ namespace WebSocketSharp.Server {
#region Public Methods
/// <summary>
/// Broadcasts the specified array of <see cref="byte"/> to the clients of every <see cref="WebSocketService"/> instances
/// in the <see cref="WebSocketService.Sessions"/>.
/// Broadcasts the specified array of <see cref="byte"/> to the clients of
/// every <see cref="WebSocketService"/> instances in the <see cref="WebSocketService.Sessions"/>.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> to broadcast.
@ -288,8 +298,8 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Broadcasts the specified <see cref="string"/> to the clients of every <see cref="WebSocketService"/> instances
/// in the <see cref="WebSocketService.Sessions"/>.
/// Broadcasts the specified <see cref="string"/> to the clients of
/// every <see cref="WebSocketService"/> instances in the <see cref="WebSocketService.Sessions"/>.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> to broadcast.
@ -301,12 +311,12 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Pings to the clients of every <see cref="WebSocketService"/> instances
/// Sends Pings to the clients of every <see cref="WebSocketService"/> instances
/// in the <see cref="WebSocketService.Sessions"/>.
/// </summary>
/// <returns>
/// A Dictionary&lt;string, bool&gt; that contains the collection of IDs and values
/// indicating whether each <see cref="WebSocketService"/> instances received a Pong in a time.
/// indicating whether the each <see cref="WebSocketService"/> instances received a Pong in a time.
/// </returns>
public Dictionary<string, bool> Broadping ()
{
@ -314,15 +324,15 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Pings with the specified <see cref="string"/> to the clients of every <see cref="WebSocketService"/> instances
/// in the <see cref="WebSocketService.Sessions"/>.
/// Sends Pings with the specified <see cref="string"/> to the clients of
/// every <see cref="WebSocketService"/> instances in the <see cref="WebSocketService.Sessions"/>.
/// </summary>
/// <returns>
/// A Dictionary&lt;string, bool&gt; that contains the collection of IDs and values
/// indicating whether each <see cref="WebSocketService"/> instances received a Pong in a time.
/// indicating whether the each <see cref="WebSocketService"/> instances received a Pong in a time.
/// </returns>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// A <see cref="string"/> that contains a message to send.
/// </param>
public Dictionary<string, bool> Broadping (string message)
{
@ -332,10 +342,11 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Pings to the client of the <see cref="WebSocketService"/> instance.
/// Sends a Ping to the client of the current <see cref="WebSocketService"/> instance.
/// </summary>
/// <returns>
/// <c>true</c> if the <see cref="WebSocketService"/> instance receives a Pong in a time; otherwise, <c>false</c>.
/// <c>true</c> if the current <see cref="WebSocketService"/> instance receives a Pong in a time;
/// otherwise, <c>false</c>.
/// </returns>
public bool Ping ()
{
@ -343,13 +354,15 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Pings with the specified <see cref="string"/> to the client of the <see cref="WebSocketService"/> instance.
/// Sends a Ping with the specified <see cref="string"/> to the client of
/// the current <see cref="WebSocketService"/> instance.
/// </summary>
/// <returns>
/// <c>true</c> if the <see cref="WebSocketService"/> instance receives a Pong in a time; otherwise, <c>false</c>.
/// <c>true</c> if the current <see cref="WebSocketService"/> instance receives a Pong in a time;
/// otherwise, <c>false</c>.
/// </returns>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// A <see cref="string"/> that contains a message to send.
/// </param>
public bool Ping (string message)
{
@ -359,11 +372,12 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Pings to the client of the <see cref="WebSocketService"/> instance
/// Sends a Ping to the client of the <see cref="WebSocketService"/> instance
/// associated with the specified <paramref name="id"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the <see cref="WebSocketService"/> instance receives a Pong in a time; otherwise, <c>false</c>.
/// <c>true</c> if the <see cref="WebSocketService"/> instance receives a Pong in a time;
/// otherwise, <c>false</c>.
/// </returns>
/// <param name="id">
/// A <see cref="string"/> that contains an ID that represents the destination for the Ping.
@ -374,17 +388,18 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Pings with the specified <see cref="string"/> to the client of the <see cref="WebSocketService"/> instance
/// associated with the specified <paramref name="id"/>.
/// Sends a Ping with the specified <see cref="string"/> to the client of
/// the <see cref="WebSocketService"/> instance associated with the specified <paramref name="id"/>.
/// </summary>
/// <returns>
/// <c>true</c> if the <see cref="WebSocketService"/> instance receives a Pong in a time; otherwise, <c>false</c>.
/// <c>true</c> if the <see cref="WebSocketService"/> instance receives a Pong in a time;
/// otherwise, <c>false</c>.
/// </returns>
/// <param name="id">
/// A <see cref="string"/> that contains an ID that represents the destination for the Ping.
/// </param>
/// <param name="message">
/// A <see cref="string"/> that contains a message.
/// A <see cref="string"/> that contains a message to send.
/// </param>
public bool PingTo (string id, string message)
{
@ -398,7 +413,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Sends a binary data to the client of the <see cref="WebSocketService"/> instance.
/// Sends a binary data to the client of the current <see cref="WebSocketService"/> instance.
/// </summary>
/// <param name="data">
/// An array of <see cref="byte"/> that contains a binary data to send.
@ -410,7 +425,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Sends a text data to the client of the <see cref="WebSocketService"/> instance.
/// Sends a text data to the client of the current <see cref="WebSocketService"/> instance.
/// </summary>
/// <param name="data">
/// A <see cref="string"/> that contains a text data to send.
@ -462,7 +477,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Starts the <see cref="WebSocketService"/> instance.
/// Starts a <see cref="WebSocketService"/> instance.
/// </summary>
public void Start ()
{
@ -471,7 +486,7 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Stops the <see cref="WebSocketService"/> instance.
/// Stops the current <see cref="WebSocketService"/> instance.
/// </summary>
public void Stop ()
{
@ -482,13 +497,14 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Stops the <see cref="WebSocketService"/> instance with the specified <see cref="ushort"/> and <see cref="string"/>.
/// Stops the current <see cref="WebSocketService"/> instance with the specified
/// <see cref="ushort"/> and <see cref="string"/>.
/// </summary>
/// <param name="code">
/// A <see cref="ushort"/> that contains a status code indicating the reason for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that contains a reason for stop.
/// A <see cref="string"/> that contains the reason for stop.
/// </param>
public void Stop (ushort code, string reason)
{
@ -499,13 +515,15 @@ namespace WebSocketSharp.Server {
}
/// <summary>
/// Stops the <see cref="WebSocketService"/> instance with the specified <see cref="CloseStatusCode"/> and <see cref="string"/>.
/// Stops the current <see cref="WebSocketService"/> instance with the specified
/// <see cref="CloseStatusCode"/> and <see cref="string"/>.
/// </summary>
/// <param name="code">
/// One of the <see cref="CloseStatusCode"/> values that contains a status code indicating the reason for stop.
/// One of the <see cref="CloseStatusCode"/> values that indicates a status code
/// indicating the reason for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that contains a reason for stop.
/// A <see cref="string"/> that contains the reason for stop.
/// </param>
public void Stop (CloseStatusCode code, string reason)
{

23
websocket-sharp/WebSocket.cs
View File

@ -71,9 +71,11 @@ namespace WebSocketSharp
_certValidationCallback;
private bool _client;
private Action _closeContext;
private CookieCollection _cookies;
private CompressionMethod _compression;
private WebSocketContext _context;
private CookieCollection _cookies;
private Func<CookieCollection, CookieCollection, bool>
_cookiesValidation;
private WsCredential _credentials;
private string _extensions;
private AutoResetEvent _exitReceiving;
@ -222,9 +224,13 @@ namespace WebSocketSharp
#region Internal Properties
internal CookieCollection CookieCollection {
internal Func<CookieCollection, CookieCollection, bool> CookiesValidation {
get {
return _cookies;
return _cookiesValidation;
}
set {
_cookiesValidation = value;
}
}
@ -1264,7 +1270,8 @@ namespace WebSocketSharp
return context.IsWebSocketRequest &&
validateHostHeader (context.Host) &&
!context.SecWebSocketKey.IsNullOrEmpty () &&
((version = context.SecWebSocketVersion) != null && version == _version);
((version = context.SecWebSocketVersion) != null && version == _version) &&
validateCookies (context.CookieCollection, _cookies);
}
// As client
@ -1276,6 +1283,14 @@ namespace WebSocketSharp
((version = response.Headers ["Sec-WebSocket-Version"]) == null || version == _version);
}
// As server
private bool validateCookies (CookieCollection request, CookieCollection response)
{
return _cookiesValidation != null
? _cookiesValidation (request, response)
: true;
}
// As server
private bool validateHostHeader (string value)
{