#region License /* * HttpServer.cs * * A simple HTTP server that allows to accept the WebSocket connection requests. * * The MIT License * * Copyright (c) 2012-2015 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: * - Juan Manuel Lallana * - Liryna */ #endregion using System; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Net.Sockets; using System.Security.Cryptography.X509Certificates; using System.Security.Principal; using System.Threading; using WebSocketSharp.Net; using WebSocketSharp.Net.WebSockets; namespace WebSocketSharp.Server { /// /// Provides a simple HTTP server that allows to accept the WebSocket connection requests. /// /// /// The HttpServer class can provide multiple WebSocket services. /// public class HttpServer { #region Private Fields private HttpListener _listener; private Logger _logger; private int _port; private Thread _receiveThread; private string _rootPath; private bool _secure; private WebSocketServiceManager _services; private volatile ServerState _state; private object _sync; private bool _windows; #endregion #region Public Constructors /// /// Initializes a new instance of the class. /// /// /// An instance initialized by this constructor listens for the incoming requests on port 80. /// public HttpServer () { init ("*", 80, false); } /// /// Initializes a new instance of the class with /// the specified . /// /// /// /// An instance initialized by this constructor listens for the incoming /// requests on . /// /// /// If is 443, that instance provides a secure connection. /// /// /// /// An that represents the port number on which to listen. /// /// /// isn't between 1 and 65535 inclusive. /// public HttpServer (int port) : this (port, port == 443) { } /// /// Initializes a new instance of the class with /// the specified and . /// /// /// An instance initialized by this constructor listens for the incoming /// requests on . /// /// /// An that represents the port number on which to listen. /// /// /// A that indicates providing a secure connection or not. /// (true indicates providing a secure connection.) /// /// /// isn't between 1 and 65535 inclusive. /// public HttpServer (int port, bool secure) { if (!port.IsPortNumber ()) throw new ArgumentOutOfRangeException ( "port", "Not between 1 and 65535 inclusive: " + port); init ("*", port, secure); } /// /// Initializes a new instance of the class with /// the specified and . /// /// /// /// An instance initialized by this constructor listens for the incoming /// connection requests on . /// /// /// If is 443, that instance provides a secure connection. /// /// /// /// A that represents the local IP address of the server. /// /// /// An that represents the port number on which to listen. /// /// /// is . /// /// /// isn't a local IP address. /// /// /// isn't between 1 and 65535 inclusive. /// public HttpServer (System.Net.IPAddress address, int port) : this (address, port, port == 443) { } /// /// Initializes a new instance of the class with /// the specified , , /// and . /// /// /// An instance initialized by this constructor listens for the incoming /// connection requests on . /// /// /// A that represents the local IP address of the server. /// /// /// An that represents the port number on which to listen. /// /// /// A that indicates providing a secure connection or not. /// (true indicates providing a secure connection.) /// /// /// is . /// /// /// isn't a local IP address. /// /// /// isn't between 1 and 65535 inclusive. /// public HttpServer (System.Net.IPAddress address, int port, bool secure) { if (address == null) throw new ArgumentNullException ("address"); if (!address.IsLocal ()) throw new ArgumentException ("Not a local IP address: " + address, "address"); if (!port.IsPortNumber ()) throw new ArgumentOutOfRangeException ( "port", "Not between 1 and 65535 inclusive: " + port); init (address.ToString (), port, secure); } #endregion #region Public Properties /// /// Gets or sets the scheme used to authenticate the clients. /// /// /// One of the enum values, /// indicates the scheme used to authenticate the clients. The default value is /// . /// public AuthenticationSchemes AuthenticationSchemes { get { return _listener.AuthenticationSchemes; } set { var msg = _state.CheckIfStartable (); if (msg != null) { _logger.Error (msg); return; } _listener.AuthenticationSchemes = value; } } /// /// Gets a value indicating whether the server has started. /// /// /// true if the server has started; otherwise, false. /// public bool IsListening { get { return _state == ServerState.Start; } } /// /// Gets a value indicating whether the server provides a secure connection. /// /// /// true if the server provides a secure connection; otherwise, false. /// public bool IsSecure { get { return _secure; } } /// /// Gets or sets a value indicating whether the server cleans up /// the inactive sessions in the WebSocket services periodically. /// /// /// true if the server cleans up the inactive sessions every 60 seconds; /// otherwise, false. The default value is true. /// public bool KeepClean { get { return _services.KeepClean; } set { var msg = _state.CheckIfStartable (); if (msg != null) { _logger.Error (msg); return; } _services.KeepClean = value; } } /// /// Gets the logging functions. /// /// /// The default logging level is . If you would like to change it, /// you should set the Log.Level property to any of the enum /// values. /// /// /// A that provides the logging functions. /// public Logger Log { get { return _logger; } } /// /// Gets the port on which to listen for incoming requests. /// /// /// An that represents the port number on which to listen. /// public int Port { get { return _port; } } /// /// Gets or sets the name of the realm associated with the server. /// /// /// A that represents the name of the realm. The default value is /// "SECRET AREA". /// public string Realm { get { return _listener.Realm; } set { var msg = _state.CheckIfStartable (); if (msg != null) { _logger.Error (msg); return; } _listener.Realm = value; } } /// /// Gets or sets a value indicating whether the server is allowed to be bound to /// an address that is already in use. /// /// /// If you would like to resolve to wait for socket in TIME_WAIT state, /// you should set this property to true. /// /// /// true if the server is allowed to be bound to an address that is already in use; /// otherwise, false. The default value is false. /// public bool ReuseAddress { get { return _listener.ReuseAddress; } set { var msg = _state.CheckIfStartable (); if (msg != null) { _logger.Error (msg); return; } _listener.ReuseAddress = value; } } /// /// Gets or sets the document root path of the server. /// /// /// A that represents the document root path of the server. /// The default value is "./Public". /// public string RootPath { get { return _rootPath != null && _rootPath.Length > 0 ? _rootPath : (_rootPath = "./Public"); } set { var msg = _state.CheckIfStartable (); if (msg != null) { _logger.Error (msg); return; } _rootPath = value; } } /// /// Gets or sets the SSL configuration used to authenticate the server and /// optionally the client for secure connection. /// /// /// A that represents the configuration used to /// authenticate the server and optionally the client for secure connection. /// public ServerSslConfiguration SslConfiguration { get { return _listener.SslConfiguration; } set { var msg = _state.CheckIfStartable (); if (msg != null) { _logger.Error (msg); return; } _listener.SslConfiguration = value; } } /// /// Gets or sets the delegate called to find the credentials for an identity used to /// authenticate a client. /// /// /// A Func<, > delegate that /// references the method(s) used to find the credentials. The default value is a function that /// only returns . /// public Func UserCredentialsFinder { get { return _listener.UserCredentialsFinder; } set { var msg = _state.CheckIfStartable (); if (msg != null) { _logger.Error (msg); return; } _listener.UserCredentialsFinder = value; } } /// /// Gets or sets the wait time for the response to the WebSocket Ping or Close. /// /// /// A that represents the wait time. The default value is /// the same as 1 second. /// public TimeSpan WaitTime { get { return _services.WaitTime; } set { var msg = _state.CheckIfStartable () ?? value.CheckIfValidWaitTime (); if (msg != null) { _logger.Error (msg); return; } _services.WaitTime = value; } } /// /// Gets the access to the WebSocket services provided by the server. /// /// /// A that manages the WebSocket services. /// public WebSocketServiceManager WebSocketServices { get { return _services; } } #endregion #region Public Events /// /// Occurs when the server receives an HTTP CONNECT request. /// public event EventHandler OnConnect; /// /// Occurs when the server receives an HTTP DELETE request. /// public event EventHandler OnDelete; /// /// Occurs when the server receives an HTTP GET request. /// public event EventHandler OnGet; /// /// Occurs when the server receives an HTTP HEAD request. /// public event EventHandler OnHead; /// /// Occurs when the server receives an HTTP OPTIONS request. /// public event EventHandler OnOptions; /// /// Occurs when the server receives an HTTP PATCH request. /// public event EventHandler OnPatch; /// /// Occurs when the server receives an HTTP POST request. /// public event EventHandler OnPost; /// /// Occurs when the server receives an HTTP PUT request. /// public event EventHandler OnPut; /// /// Occurs when the server receives an HTTP TRACE request. /// public event EventHandler OnTrace; #endregion #region Private Methods private void abort () { lock (_sync) { if (!IsListening) return; _state = ServerState.ShuttingDown; } _services.Stop (new CloseEventArgs (CloseStatusCode.ServerError), true, false); _listener.Abort (); _state = ServerState.Stop; } private string checkIfCertificateExists () { if (!_secure) return null; var usr = _listener.SslConfiguration.ServerCertificate != null; var port = EndPointListener.CertificateExists (_port, _listener.CertificateFolderPath); if (usr && port) { _logger.Warn ("The server certificate associated with the port number already exists."); return null; } return !(usr || port) ? "The secure connection requires a server certificate." : null; } private void init (string hostname, int port, bool secure) { _port = port; _secure = secure; _listener = new HttpListener (); _listener.Prefixes.Add ( String.Format ("http{0}://{1}:{2}/", secure ? "s" : "", hostname, port)); _logger = _listener.Log; _services = new WebSocketServiceManager (_logger); _sync = new object (); var os = Environment.OSVersion; _windows = os.Platform != PlatformID.Unix && os.Platform != PlatformID.MacOSX; } private void processRequest (HttpListenerContext context) { var method = context.Request.HttpMethod; var evt = method == "GET" ? OnGet : method == "HEAD" ? OnHead : method == "POST" ? OnPost : method == "PUT" ? OnPut : method == "DELETE" ? OnDelete : method == "OPTIONS" ? OnOptions : method == "TRACE" ? OnTrace : method == "CONNECT" ? OnConnect : method == "PATCH" ? OnPatch : null; if (evt != null) evt (this, new HttpRequestEventArgs (context)); else context.Response.StatusCode = (int) HttpStatusCode.NotImplemented; context.Response.Close (); } private void processRequest (HttpListenerWebSocketContext context) { WebSocketServiceHost host; if (!_services.InternalTryGetServiceHost (context.RequestUri.AbsolutePath, out host)) { context.Close (HttpStatusCode.NotImplemented); return; } host.StartSession (context); } private void receiveRequest () { while (true) { try { var ctx = _listener.GetContext (); ThreadPool.QueueUserWorkItem ( state => { try { if (ctx.Request.IsUpgradeTo ("websocket")) { processRequest (ctx.AcceptWebSocket (null)); return; } processRequest (ctx); } catch (Exception ex) { _logger.Fatal (ex.ToString ()); ctx.Connection.Close (true); } }); } catch (HttpListenerException ex) { _logger.Warn ("Receiving has been stopped.\n reason: " + ex.Message); break; } catch (Exception ex) { _logger.Fatal (ex.ToString ()); break; } } if (IsListening) abort (); } private void startReceiving () { _listener.Start (); _receiveThread = new Thread (new ThreadStart (receiveRequest)); _receiveThread.IsBackground = true; _receiveThread.Start (); } private void stopReceiving (int millisecondsTimeout) { _listener.Close (); _receiveThread.Join (millisecondsTimeout); } #endregion #region Public Methods /// /// Adds the WebSocket service with the specified behavior, , /// and . /// /// /// /// This method converts to URL-decoded string, /// and removes '/' from tail end of . /// /// /// returns an initialized specified typed /// instance. /// /// /// /// A that represents the absolute path to the service to add. /// /// /// A Func<T> delegate that references the method used to initialize /// a new specified typed instance (a new /// instance). /// /// /// The type of the behavior of the service to add. The TBehavior must inherit /// the class. /// public void AddWebSocketService (string path, Func initializer) where TBehavior : WebSocketBehavior { var msg = path.CheckIfValidServicePath () ?? (initializer == null ? "'initializer' is null." : null); if (msg != null) { _logger.Error (msg); return; } _services.Add (path, initializer); } /// /// Adds a WebSocket service with the specified behavior and . /// /// /// This method converts to URL-decoded string, /// and removes '/' from tail end of . /// /// /// A that represents the absolute path to the service to add. /// /// /// The type of the behavior of the service to add. The TBehaviorWithNew must inherit /// the class, and must have a public parameterless /// constructor. /// public void AddWebSocketService (string path) where TBehaviorWithNew : WebSocketBehavior, new () { AddWebSocketService (path, () => new TBehaviorWithNew ()); } /// /// Gets the contents of the file with the specified . /// /// /// An array of that receives the contents of the file, /// or if it doesn't exist. /// /// /// A that represents the virtual path to the file to find. /// public byte[] GetFile (string path) { path = RootPath + path; if (_windows) path = path.Replace ("/", "\\"); return File.Exists (path) ? File.ReadAllBytes (path) : null; } /// /// Removes the WebSocket service with the specified . /// /// /// This method converts to URL-decoded string, /// and removes '/' from tail end of . /// /// /// true if the service is successfully found and removed; otherwise, false. /// /// /// A that represents the absolute path to the service to find. /// public bool RemoveWebSocketService (string path) { var msg = path.CheckIfValidServicePath (); if (msg != null) { _logger.Error (msg); return false; } return _services.Remove (path); } /// /// Starts receiving the HTTP requests. /// public void Start () { lock (_sync) { var msg = _state.CheckIfStartable () ?? checkIfCertificateExists (); if (msg != null) { _logger.Error (msg); return; } _services.Start (); startReceiving (); _state = ServerState.Start; } } /// /// Stops receiving the HTTP requests. /// public void Stop () { lock (_sync) { var msg = _state.CheckIfStart (); if (msg != null) { _logger.Error (msg); return; } _state = ServerState.ShuttingDown; } _services.Stop (new CloseEventArgs (), true, true); stopReceiving (5000); _state = ServerState.Stop; } /// /// Stops receiving the HTTP requests with the specified and /// used to stop the WebSocket services. /// /// /// A that represents the status code indicating the reason for the stop. /// /// /// A that represents the reason for the stop. /// public void Stop (ushort code, string reason) { lock (_sync) { var msg = _state.CheckIfStart () ?? WebSocket.CheckCloseParameters (code, reason, false); if (msg != null) { _logger.Error (msg); return; } _state = ServerState.ShuttingDown; } if (code == (ushort) CloseStatusCode.NoStatus) { _services.Stop (new CloseEventArgs (), true, true); } else { var send = !code.IsReserved (); _services.Stop (new CloseEventArgs (code, reason), send, send); } stopReceiving (5000); _state = ServerState.Stop; } /// /// Stops receiving the HTTP requests with the specified and /// used to stop the WebSocket services. /// /// /// One of the enum values, represents the status code indicating /// the reason for the stop. /// /// /// A that represents the reason for the stop. /// public void Stop (CloseStatusCode code, string reason) { lock (_sync) { var msg = _state.CheckIfStart () ?? WebSocket.CheckCloseParameters (code, reason, false); if (msg != null) { _logger.Error (msg); return; } _state = ServerState.ShuttingDown; } if (code == CloseStatusCode.NoStatus) { _services.Stop (new CloseEventArgs (), true, true); } else { var send = !code.IsReserved (); _services.Stop (new CloseEventArgs (code, reason), send, send); } stopReceiving (5000); _state = ServerState.Stop; } #endregion } }