BaseStreamHandlerBasicDOSProtector.cs 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using OpenSim.Framework;
  28. using System.IO;
  29. namespace OpenSim.Framework.Servers.HttpServer
  30. {
  31. /// <summary>
  32. /// BaseStreamHandlerBasicDOSProtector Base streamed request handler.
  33. /// </summary>
  34. /// <remarks>
  35. /// Inheriting classes should override ProcessRequest() rather than Handle()
  36. /// </remarks>
  37. public abstract class BaseStreamHandlerBasicDOSProtector : BaseRequestHandler, IStreamedRequestHandler
  38. {
  39. private readonly BasicDosProtectorOptions _options;
  40. private readonly BasicDOSProtector _dosProtector;
  41. protected BaseStreamHandlerBasicDOSProtector(string httpMethod, string path, BasicDosProtectorOptions options) : this(httpMethod, path, null, null, options) {}
  42. protected BaseStreamHandlerBasicDOSProtector(string httpMethod, string path, string name, string description, BasicDosProtectorOptions options)
  43. : base(httpMethod, path, name, description)
  44. {
  45. _options = options;
  46. _dosProtector = new BasicDOSProtector(_options);
  47. }
  48. public virtual byte[] Handle(
  49. string path, Stream request, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
  50. {
  51. byte[] result;
  52. RequestsReceived++;
  53. string clientstring = GetClientString(httpRequest);
  54. string endpoint = GetRemoteAddr(httpRequest);
  55. if (_dosProtector.Process(clientstring, endpoint))
  56. result = ProcessRequest(path, request, httpRequest, httpResponse);
  57. else
  58. result = ThrottledRequest(path, request, httpRequest, httpResponse);
  59. if (_options.MaxConcurrentSessions > 0)
  60. _dosProtector.ProcessEnd(clientstring, endpoint);
  61. RequestsHandled++;
  62. return result;
  63. }
  64. protected virtual byte[] ProcessRequest(
  65. string path, Stream request, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
  66. {
  67. return null;
  68. }
  69. protected virtual byte[] ThrottledRequest(
  70. string path, Stream request, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
  71. {
  72. return new byte[0];
  73. }
  74. private string GetRemoteAddr(IOSHttpRequest httpRequest)
  75. {
  76. string remoteaddr = string.Empty;
  77. if (httpRequest.Headers["remote_addr"] != null)
  78. remoteaddr = httpRequest.Headers["remote_addr"];
  79. return remoteaddr;
  80. }
  81. private string GetClientString(IOSHttpRequest httpRequest)
  82. {
  83. string clientstring = string.Empty;
  84. if (_options.AllowXForwardedFor && httpRequest.Headers["x-forwarded-for"] != null)
  85. clientstring = httpRequest.Headers["x-forwarded-for"];
  86. else
  87. clientstring = GetRemoteAddr(httpRequest);
  88. return clientstring;
  89. }
  90. }
  91. }