#region License /* * HttpListenerContext.cs * * This code is derived from HttpListenerContext.cs (System.Net) of Mono * (http://www.mono-project.com). * * The MIT License * * Copyright (c) 2005 Novell, Inc. (http://www.novell.com) * Copyright (c) 2012-2022 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 Authors /* * Authors: * - Gonzalo Paniagua Javier */ #endregion using System; using System.Security.Principal; using System.Text; using WebSocketSharp.Net.WebSockets; namespace WebSocketSharp.Net { /// /// Provides the access to the HTTP request and response objects used by /// the class. /// /// /// This class cannot be inherited. /// public sealed class HttpListenerContext { #region Private Fields private HttpConnection _connection; private string _errorMessage; private int _errorStatusCode; private HttpListener _listener; private HttpListenerRequest _request; private HttpListenerResponse _response; private IPrincipal _user; private HttpListenerWebSocketContext _websocketContext; #endregion #region Internal Constructors internal HttpListenerContext (HttpConnection connection) { _connection = connection; _errorStatusCode = 400; _request = new HttpListenerRequest (this); _response = new HttpListenerResponse (this); } #endregion #region Internal Properties internal HttpConnection Connection { get { return _connection; } } internal string ErrorMessage { get { return _errorMessage; } set { _errorMessage = value; } } internal int ErrorStatusCode { get { return _errorStatusCode; } set { _errorStatusCode = value; } } internal bool HasErrorMessage { get { return _errorMessage != null; } } internal HttpListener Listener { get { return _listener; } set { _listener = value; } } #endregion #region Public Properties /// /// Gets the HTTP request object that represents a client request. /// /// /// A that represents the client request. /// public HttpListenerRequest Request { get { return _request; } } /// /// Gets the HTTP response object used to send a response to the client. /// /// /// A that represents a response to /// the client request. /// public HttpListenerResponse Response { get { return _response; } } /// /// Gets the client information. /// /// /// /// A instance that represents identity, /// authentication, and security roles for the client. /// /// /// if the client is not authenticated. /// /// public IPrincipal User { get { return _user; } } #endregion #region Private Methods private static string createErrorContent ( int statusCode, string statusDescription, string message ) { return message != null && message.Length > 0 ? String.Format ( "

{0} {1} ({2})

", statusCode, statusDescription, message ) : String.Format ( "

{0} {1}

", statusCode, statusDescription ); } #endregion #region Internal Methods internal HttpListenerWebSocketContext GetWebSocketContext (string protocol) { _websocketContext = new HttpListenerWebSocketContext (this, protocol); return _websocketContext; } internal void SendAuthenticationChallenge ( AuthenticationSchemes scheme, string realm ) { _response.StatusCode = 401; var chal = new AuthenticationChallenge (scheme, realm).ToString (); _response.Headers.InternalSet ("WWW-Authenticate", chal, true); _response.Close (); } internal void SendError () { try { _response.StatusCode = _errorStatusCode; _response.ContentType = "text/html"; var content = createErrorContent ( _errorStatusCode, _response.StatusDescription, _errorMessage ); var enc = Encoding.UTF8; var entity = enc.GetBytes (content); _response.ContentEncoding = enc; _response.ContentLength64 = entity.LongLength; _response.Close (entity, true); } catch { _connection.Close (true); } } internal void SendError (int statusCode) { _errorStatusCode = statusCode; SendError (); } internal void SendError (int statusCode, string message) { _errorStatusCode = statusCode; _errorMessage = message; SendError (); } internal bool SetUser ( AuthenticationSchemes scheme, string realm, Func credentialsFinder ) { var user = HttpUtility.CreateUser ( _request.Headers["Authorization"], scheme, realm, _request.HttpMethod, credentialsFinder ); if (user == null) return false; if (!user.Identity.IsAuthenticated) return false; _user = user; return true; } internal void Unregister () { if (_listener == null) return; _listener.UnregisterContext (this); } #endregion #region Public Methods /// /// Accepts a WebSocket connection. /// /// /// A that represents /// the WebSocket handshake request. /// /// /// /// A that specifies the name of the subprotocol /// supported on the WebSocket connection. /// /// /// if not necessary. /// /// /// /// /// This method has already been done. /// /// /// -or- /// /// /// The client request is not a WebSocket handshake request. /// /// /// /// /// is empty. /// /// /// -or- /// /// /// contains an invalid character. /// /// public HttpListenerWebSocketContext AcceptWebSocket (string protocol) { return AcceptWebSocket (protocol, null); } /// /// Accepts a WebSocket connection with initializing the WebSocket /// interface. /// /// /// A that represents /// the WebSocket handshake request. /// /// /// /// A that specifies the name of the subprotocol /// supported on the WebSocket connection. /// /// /// if not necessary. /// /// /// /// /// An delegate. /// /// /// It specifies the delegate that invokes the method called when /// initializing a new WebSocket instance. /// /// /// /// /// This method has already been done. /// /// /// -or- /// /// /// The client request is not a WebSocket handshake request. /// /// /// /// /// is empty. /// /// /// -or- /// /// /// contains an invalid character. /// /// /// -or- /// /// /// caused an exception. /// /// public HttpListenerWebSocketContext AcceptWebSocket ( string protocol, Action initializer ) { if (_websocketContext != null) { var msg = "The method has already been done."; throw new InvalidOperationException (msg); } if (!_request.IsWebSocketRequest) { var msg = "The request is not a WebSocket handshake request."; throw new InvalidOperationException (msg); } if (protocol != null) { if (protocol.Length == 0) { var msg = "An empty string."; throw new ArgumentException (msg, "protocol"); } if (!protocol.IsToken ()) { var msg = "It contains an invalid character."; throw new ArgumentException (msg, "protocol"); } } var ret = GetWebSocketContext (protocol); var ws = ret.WebSocket; if (initializer != null) { try { initializer (ws); } catch (Exception ex) { if (ws.ReadyState == WebSocketState.New) _websocketContext = null; var msg = "It caused an exception."; throw new ArgumentException (msg, "initializer", ex); } } ws.Accept (); return ret; } #endregion } }