Class StunnelHandler

java.lang.Object
sunlabs.brazil.sunlabs.StunnelHandler
All Implemented Interfaces:
Handler
public class StunnelHandler extends Object implements Handler
Handler to enable proper interaction with a protocol conversion gateway, by rewriting "redirect" directives properly. For example, this handler may be used with stunnel (see stunnel.org), configured as an SSL gateway. enabling Brazil with an external ssl protocol stack. For example, the stunnel configuration 
 [https]
 accept  = 443
 connect = 8080
Will allow "https" connections on the standard port ssl (443) to access a Brazil server on port 8080. When using Brazil in this configuration without this handler, since Brazil talks to the gateway via "http", it will issue redirects to "http", which is the wrong protocol. This template looks at the origin ip address, and if it matches, changes the server protocol for this request, resulting in the client redirecting back through the gateway properly.

Properties:

ssl
The regexp to match client ip addresses that are coming from ssl gateways (such as stunnel).
protocol
The protocol to replace "http" with when redirection via a gateway (defaults to "https").

  • Constructor Details

    • StunnelHandler

      public StunnelHandler()

  • Method Details

    • init

      public boolean init(Server server, String prefix)
      Description copied from interface: Handler
      Initializes the handler.
      Specified by:
      init in interface Handler
      Parameters:
      server - The HTTP server that created this Handler. Typical Handlers will use Server.props to obtain run-time configuration information.
      prefix - The handlers name. The string this Handler may prepend to all of the keys that it uses to extract configuration information from Server.props. This is set (by the Server and ChainHandler) to help avoid configuration parameter namespace collisions.
      Returns:
      true if this Handler initialized successfully, false otherwise. If false is returned, this Handler should not be used.

    • respond

      public boolean respond(Request request) throws IOException
      If we are coming from the machine which is designated as our ssl gateway, then we need to change the protocol to "https" and remap the default port.
      Specified by:
      respond in interface Handler
      Parameters:
      request - The Request object that represents the HTTP request.
      Returns:
      true if the request was handled. A request was handled if a response was supplied to the client, typically by calling Request.sendResponse() or Request.sendError.
      Throws:
      IOException - if there was an I/O error while sending the response to the client. Typically, in that case, the Server will (try to) send an error message to the client and then close the client's connection.

      The IOException should not be used to silently ignore problems such as being unable to access some server-side resource (for example getting a FileNotFoundException due to not being able to open a file). In that case, the Handler's duty is to turn that IOException into a HTTP response indicating, in this case, that a file could not be found.