webrick 1.3.1

data/README.txt

@@ -0,0 +1,21 @@
+= WEB server toolkit.
+
+WEBrick is an HTTP server toolkit that can be configured as an HTTPS server,
+a proxy server, and a virtual-host server.  WEBrick features complete
+logging of both server operations and HTTP access.  WEBrick supports both
+basic and digest authentication in addition to algorithms not in RFC 2617.
+
+A WEBrick servers can be composed of multiple WEBrick servers or servlets to
+provide differing behavior on a per-host or per-path basis.  WEBrick
+includes servlets for handling CGI scripts, ERb pages, ruby blocks and
+directory listings.
+
+WEBrick also includes tools for daemonizing a process and starting a process
+at a higher privilege level and dropping permissions.
+
+== Copyright
+
+Author: IPR -- Internet Programming with Ruby -- writers
+
+Copyright (c) 2000 TAKAHASHI Masayoshi, GOTOU YUUZOU
+Copyright (c) 2002 Internet Programming with Ruby writers. All rights reserved.

data/lib/webrick.rb

@@ -0,0 +1,227 @@
+##
+# = WEB server toolkit.
+#
+# WEBrick is an HTTP server toolkit that can be configured as an HTTPS server,
+# a proxy server, and a virtual-host server.  WEBrick features complete
+# logging of both server operations and HTTP access.  WEBrick supports both
+# basic and digest authentication in addition to algorithms not in RFC 2617.
+#
+# A WEBrick servers can be composed of multiple WEBrick servers or servlets to
+# provide differing behavior on a per-host or per-path basis.  WEBrick
+# includes servlets for handling CGI scripts, ERb pages, ruby blocks and
+# directory listings.
+#
+# WEBrick also includes tools for daemonizing a process and starting a process
+# at a higher privilege level and dropping permissions.
+#
+# == Starting an HTTP server
+#
+# To create a new WEBrick::HTTPServer that will listen to connections on port
+# 8000 and serve documents from the current user's public_html folder:
+#
+#   require 'webrick'
+#
+#   root = File.expand_path '~/public_html'
+#   server = WEBrick::HTTPServer.new :Port => 8000, :DocumentRoot => root
+#
+# To run the server you will need to provide a suitable shutdown hook as
+# starting the server blocks the current thread:
+#
+#   trap 'INT' do server.shutdown end
+#
+#   server.start
+#
+# == Custom Behavior
+#
+# The easiest way to have a server perform custom operations is through
+# WEBrick::HTTPServer#mount_proc.  The block given will be called with a
+# WEBrick::HTTPRequest with request info and a WEBrick::HTTPResponse which
+# must be filled in appropriately:
+#
+#   server.mount_proc '/' do |req, res|
+#     res.body = 'Hello, world!'
+#   end
+#
+# Remember that <tt>server.mount_proc</tt> must <tt>server.start</tt>.
+#
+# == Servlets
+#
+# Advanced custom behavior can be obtained through mounting a subclass of
+# WEBrick::HTTPServlet::AbstractServlet.  Servlets provide more modularity
+# when writing an HTTP server than mount_proc allows.  Here is a simple
+# servlet:
+#
+#   class Simple < WEBrick::HTTPServlet::AbstractServlet
+#     def do_GET request, response
+#       status, content_type, body = do_stuff_with request
+#
+#       response.status = 200
+#       response['Content-Type'] = 'text/plain'
+#       response.body = 'Hello, World!'
+#     end
+#   end
+#
+# To initialize the servlet you mount it on the server:
+#
+#   server.mount '/simple', Simple
+#
+# See WEBrick::HTTPServlet::AbstractServlet for more details.
+#
+# == Virtual Hosts
+#
+# A server can act as a virtual host for multiple host names.  After creating
+# the listening host, additional hosts that do not listen can be created and
+# attached as virtual hosts:
+#
+#   server = WEBrick::HTTPServer.new # ...
+#
+#   vhost = WEBrick::HTTPServer.new :ServerName => 'vhost.example',
+#                                   :DoNotListen => true, # ...
+#   vhost.mount '/', ...
+#
+#   server.virtual_host vhost
+#
+# If no +:DocumentRoot+ is provided and no servlets or procs are mounted on the
+# main server it will return 404 for all URLs.
+#
+# == HTTPS
+#
+# To create an HTTPS server you only need to enable SSL and provide an SSL
+# certificate name:
+#
+#   require 'webrick'
+#   require 'webrick/https'
+#
+#   cert_name = [
+#     %w[CN localhost],
+#   ]
+#
+#   server = WEBrick::HTTPServer.new(:Port => 8000,
+#                                    :SSLEnable => true,
+#                                    :SSLCertName => cert_name)
+#
+# This will start the server with a self-generated self-signed certificate.
+# The certificate will be changed every time the server is restarted.
+#
+# To create a server with a pre-determined key and certificate you can provide
+# them:
+#
+#   require 'webrick'
+#   require 'webrick/https'
+#   require 'openssl'
+#
+#   cert = OpenSSL::X509::Certificate.new File.read '/path/to/cert.pem'
+#   pkey = OpenSSL::PKey::RSA.new File.read '/path/to/pkey.pem'
+#
+#   server = WEBrick::HTTPServer.new(:Port => 8000,
+#                                    :SSLEnable => true,
+#                                    :SSLCertificate => cert,
+#                                    :SSLPrivateKey => pkey)
+#
+# == Proxy Server
+#
+# WEBrick can act as a proxy server:
+#
+#   require 'webrick'
+#   require 'webrick/httpproxy'
+#
+#   proxy = WEBrick::HTTPProxyServer.new :Port => 8000
+#
+#   trap 'INT' do proxy.shutdown end
+#
+# Proxies may modifier the content of the response through the
+# +:ProxyContentHandler+ callback which will be invoked with the request and
+# respone after the remote content has been fetched.
+#
+# == Basic and Digest authentication
+#
+# WEBrick provides both Basic and Digest authentication for regular and proxy
+# servers.  See WEBrick::HTTPAuth, WEBrick::HTTPAuth::BasicAuth and
+# WEBrick::HTTPAuth::DigestAuth.
+#
+# == WEBrick as a Production Web Server
+#
+# WEBrick can be run as a production server for small loads.
+#
+# === Daemonizing
+#
+# To start a WEBrick server as a daemon simple run WEBrick::Daemon.start
+# before starting the server.
+#
+# === Dropping Permissions
+#
+# WEBrick can be started as one user to gain permission to bind to port 80 or
+# 443 for serving HTTP or HTTPS traffic then can drop these permissions for
+# regular operation.  To listen on all interfaces for HTTP traffic:
+#
+#   sockets = WEBrick::Utils.create_listeners nil, 80
+#
+# Then drop privileges:
+#
+#   WEBrick::Utils.su 'www'
+#
+# Then create a server that does not listen by default:
+#
+#   server = WEBrick::HTTPServer.new :DoNotListen => true, # ...
+#
+# Then overwrite the listening sockets with the port 80 sockets:
+#
+#   server.listeners.replace sockets
+#
+# === Logging
+#
+# WEBrick can separately log server operations and end-user access.  For
+# server operations:
+#
+#   log_file = File.open '/var/log/webrick.log', 'a+'
+#   log = WEBrick::Log.new log_file
+#
+# For user access logging:
+#
+#   access_log = [
+#     [log_file, WEBrick::AccessLog::COMBINED_LOG_FORMAT],
+#   ]
+#
+#   server = WEBrick::HTTPServer.new :Logger => log, :AccessLog => access_log
+#
+# See WEBrick::AccessLog for further log formats.
+#
+# === Log Rotation
+#
+# To rotate logs in WEBrick on a HUP signal (like syslogd can send), open the
+# log file in 'a+' mode (as above) and trap 'HUP' to reopen the log file:
+#
+#   trap 'HUP' do log_file.reopen '/path/to/webrick.log', 'a+'
+#
+# == Copyright
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+#
+# Copyright (c) 2000 TAKAHASHI Masayoshi, GOTOU YUUZOU
+# Copyright (c) 2002 Internet Programming with Ruby writers. All rights
+# reserved.
+#--
+# $IPR: webrick.rb,v 1.12 2002/10/01 17:16:31 gotoyuzo Exp $
+
+module WEBrick
+end
+
+require 'webrick/compat.rb'
+
+require 'webrick/version.rb'
+require 'webrick/config.rb'
+require 'webrick/log.rb'
+require 'webrick/server.rb'
+require 'webrick/utils.rb'
+require 'webrick/accesslog'
+
+require 'webrick/htmlutils.rb'
+require 'webrick/httputils.rb'
+require 'webrick/cookie.rb'
+require 'webrick/httpversion.rb'
+require 'webrick/httpstatus.rb'
+require 'webrick/httprequest.rb'
+require 'webrick/httpresponse.rb'
+require 'webrick/httpserver.rb'
+require 'webrick/httpservlet.rb'
+require 'webrick/httpauth.rb'

data/lib/webrick/accesslog.rb

@@ -0,0 +1,151 @@
+#--
+# accesslog.rb -- Access log handling utilities
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+# Copyright (c) 2002 keita yamaguchi
+# Copyright (c) 2002 Internet Programming with Ruby writers
+#
+# $IPR: accesslog.rb,v 1.1 2002/10/01 17:16:32 gotoyuzo Exp $
+
+module WEBrick
+
+  ##
+  # AccessLog provides logging to various files in various formats.
+  #
+  # Multiple logs may be written to at the same time:
+  #
+  #   access_log = [
+  #     [$stderr, WEBrick::AccessLog::COMMON_LOG_FORMAT],
+  #     [$stderr, WEBrick::AccessLog::REFERER_LOG_FORMAT],
+  #   ]
+  #
+  #   server = WEBrick::HTTPServer.new :AccessLog => access_log
+  #
+  # Custom log formats may be defined.  WEBrick::AccessLog provides a subset
+  # of the formatting from Apache's mod_log_config
+  # http://httpd.apache.org/docs/mod/mod_log_config.html#formats.  See
+  # AccessLog::setup_params for a list of supported options
+
+  module AccessLog
+
+    ##
+    # Raised if a parameter such as %e, %i, %o or %n is used without fetching
+    # a specific field.
+
+    class AccessLogError < StandardError; end
+
+    ##
+    # The Common Log Format's time format
+
+    CLF_TIME_FORMAT     = "[%d/%b/%Y:%H:%M:%S %Z]"
+
+    ##
+    # Common Log Format
+
+    COMMON_LOG_FORMAT   = "%h %l %u %t \"%r\" %s %b"
+
+    ##
+    # Short alias for Common Log Format
+
+    CLF                 = COMMON_LOG_FORMAT
+
+    ##
+    # Referer Log Format
+
+    REFERER_LOG_FORMAT  = "%{Referer}i -> %U"
+
+    ##
+    # User-Agent Log Format
+
+    AGENT_LOG_FORMAT    = "%{User-Agent}i"
+
+    ##
+    # Combined Log Format
+
+    COMBINED_LOG_FORMAT = "#{CLF} \"%{Referer}i\" \"%{User-agent}i\""
+
+    module_function
+
+    # This format specification is a subset of mod_log_config of Apache:
+    #
+    # %a:: Remote IP address
+    # %b:: Total response size
+    # %e{variable}:: Given variable in ENV
+    # %f:: Response filename
+    # %h:: Remote host name
+    # %{header}i:: Given request header
+    # %l:: Remote logname, always "-"
+    # %m:: Request method
+    # %{attr}n:: Given request attribute from <tt>req.attributes</tt>
+    # %{header}o:: Given response header
+    # %p:: Server's request port
+    # %{format}p:: The canonical port of the server serving the request or the
+    #              actual port or the client's actual port.  Valid formats are
+    #              canonical, local or remote.
+    # %q:: Request query string
+    # %r:: First line of the request
+    # %s:: Request status
+    # %t:: Time the request was recieved
+    # %T:: Time taken to process the request
+    # %u:: Remote user from auth
+    # %U:: Unparsed URI
+    # %%:: Literal %
+
+    def setup_params(config, req, res)
+      params = Hash.new("")
+      params["a"] = req.peeraddr[3]
+      params["b"] = res.sent_size
+      params["e"] = ENV
+      params["f"] = res.filename || ""
+      params["h"] = req.peeraddr[2]
+      params["i"] = req
+      params["l"] = "-"
+      params["m"] = req.request_method
+      params["n"] = req.attributes
+      params["o"] = res
+      params["p"] = req.port
+      params["q"] = req.query_string
+      params["r"] = req.request_line.sub(/\x0d?\x0a\z/o, '')
+      params["s"] = res.status       # won't support "%>s"
+      params["t"] = req.request_time
+      params["T"] = Time.now - req.request_time
+      params["u"] = req.user || "-"
+      params["U"] = req.unparsed_uri
+      params["v"] = config[:ServerName]
+      params
+    end
+
+    def format(format_string, params)
+      format_string.gsub(/\%(?:\{(.*?)\})?>?([a-zA-Z%])/){
+         param, spec = $1, $2
+         case spec[0]
+         when ?e, ?i, ?n, ?o
+           raise AccessLogError,
+             "parameter is required for \"#{spec}\"" unless param
+           (param = params[spec][param]) ? escape(param) : "-"
+         when ?t
+           params[spec].strftime(param || CLF_TIME_FORMAT)
+         when ?p
+           case param
+           when 'remote'
+             escape(params["i"].peeraddr[1].to_s)
+           else
+             escape(params["p"].to_s)
+           end
+         when ?%
+           "%"
+         else
+           escape(params[spec].to_s)
+         end
+      }
+    end
+
+    def escape(data)
+      if data.tainted?
+        data.gsub(/[[:cntrl:]\\]+/) {$&.dump[1...-1]}.untaint
+      else
+        data
+      end
+    end
+  end
+end

data/lib/webrick/cgi.rb

@@ -0,0 +1,260 @@
+#
+# cgi.rb -- Yet another CGI library
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+# Copyright (c) 2003 Internet Programming with Ruby writers. All rights
+# reserved.
+#
+# $Id$
+
+require "webrick/httprequest"
+require "webrick/httpresponse"
+require "webrick/config"
+require "stringio"
+
+module WEBrick
+  class CGI
+    CGIError = Class.new(StandardError)
+
+    attr_reader :config, :logger
+
+    def initialize(*args)
+      if defined?(MOD_RUBY)
+        unless ENV.has_key?("GATEWAY_INTERFACE")
+          Apache.request.setup_cgi_env
+        end
+      end
+      if %r{HTTP/(\d+\.\d+)} =~ ENV["SERVER_PROTOCOL"]
+        httpv = $1
+      end
+      @config = WEBrick::Config::HTTP.dup.update(
+        :ServerSoftware => ENV["SERVER_SOFTWARE"] || "null",
+        :HTTPVersion    => HTTPVersion.new(httpv || "1.0"),
+        :RunOnCGI       => true,   # to detect if it runs on CGI.
+        :NPH            => false   # set true to run as NPH script.
+      )
+      if config = args.shift
+        @config.update(config)
+      end
+      @config[:Logger] ||= WEBrick::BasicLog.new($stderr)
+      @logger = @config[:Logger]
+      @options = args
+    end
+
+    def [](key)
+      @config[key]
+    end
+
+    def start(env=ENV, stdin=$stdin, stdout=$stdout)
+      sock = WEBrick::CGI::Socket.new(@config, env, stdin, stdout)
+      req = HTTPRequest.new(@config)
+      res = HTTPResponse.new(@config)
+      unless @config[:NPH] or defined?(MOD_RUBY)
+        def res.setup_header
+          unless @header["status"]
+            phrase = HTTPStatus::reason_phrase(@status)
+            @header["status"] = "#{@status} #{phrase}"
+          end
+          super
+        end
+        def res.status_line
+          ""
+        end
+      end
+
+      begin
+        req.parse(sock)
+        req.script_name = (env["SCRIPT_NAME"] || File.expand_path($0)).dup
+        req.path_info = (env["PATH_INFO"] || "").dup
+        req.query_string = env["QUERY_STRING"]
+        req.user = env["REMOTE_USER"]
+        res.request_method = req.request_method
+        res.request_uri = req.request_uri
+        res.request_http_version = req.http_version
+        res.keep_alive = req.keep_alive?
+        self.service(req, res)
+      rescue HTTPStatus::Error => ex
+        res.set_error(ex)
+      rescue HTTPStatus::Status => ex
+        res.status = ex.code
+      rescue Exception => ex
+        @logger.error(ex)
+        res.set_error(ex, true)
+      ensure
+        req.fixup
+        if defined?(MOD_RUBY)
+          res.setup_header
+          Apache.request.status_line = "#{res.status} #{res.reason_phrase}"
+          Apache.request.status = res.status
+          table = Apache.request.headers_out
+          res.header.each{|key, val|
+            case key
+            when /^content-encoding$/i
+              Apache::request.content_encoding = val
+            when /^content-type$/i
+              Apache::request.content_type = val
+            else
+              table[key] = val.to_s
+            end
+          }
+          res.cookies.each{|cookie|
+            table.add("Set-Cookie", cookie.to_s)
+          }
+          Apache.request.send_http_header
+          res.send_body(sock)
+        else
+          res.send_response(sock)
+        end
+      end
+    end
+
+    def service(req, res)
+      method_name = "do_" + req.request_method.gsub(/-/, "_")
+      if respond_to?(method_name)
+        __send__(method_name, req, res)
+      else
+        raise HTTPStatus::MethodNotAllowed,
+              "unsupported method `#{req.request_method}'."
+      end
+    end
+
+    class Socket
+      include Enumerable
+
+      private
+
+      def initialize(config, env, stdin, stdout)
+        @config = config
+        @env = env
+        @header_part = StringIO.new
+        @body_part = stdin
+        @out_port = stdout
+        @out_port.binmode
+
+        @server_addr = @env["SERVER_ADDR"] || "0.0.0.0"
+        @server_name = @env["SERVER_NAME"]
+        @server_port = @env["SERVER_PORT"]
+        @remote_addr = @env["REMOTE_ADDR"]
+        @remote_host = @env["REMOTE_HOST"] || @remote_addr
+        @remote_port = @env["REMOTE_PORT"] || 0
+
+        begin
+          @header_part << request_line << CRLF
+          setup_header
+          @header_part << CRLF
+          @header_part.rewind
+        rescue Exception
+          raise CGIError, "invalid CGI environment"
+        end
+      end
+
+      def request_line
+        meth = @env["REQUEST_METHOD"] || "GET"
+        unless url = @env["REQUEST_URI"]
+          url = (@env["SCRIPT_NAME"] || File.expand_path($0)).dup
+          url << @env["PATH_INFO"].to_s
+          url = WEBrick::HTTPUtils.escape_path(url)
+          if query_string = @env["QUERY_STRING"]
+            unless query_string.empty?
+              url << "?" << query_string
+            end
+          end
+        end
+        # we cannot get real HTTP version of client ;)
+        httpv = @config[:HTTPVersion]
+        return "#{meth} #{url} HTTP/#{httpv}"
+      end
+
+      def setup_header
+        @env.each{|key, value|
+          case key
+          when "CONTENT_TYPE", "CONTENT_LENGTH"
+            add_header(key.gsub(/_/, "-"), value)
+          when /^HTTP_(.*)/
+            add_header($1.gsub(/_/, "-"), value)
+          end
+        }
+      end
+
+      def add_header(hdrname, value)
+        unless value.empty?
+          @header_part << hdrname << ": " << value << CRLF
+        end
+      end
+
+      def input
+        @header_part.eof? ? @body_part : @header_part
+      end
+
+      public
+
+      def peeraddr
+        [nil, @remote_port, @remote_host, @remote_addr]
+      end
+
+      def addr
+        [nil, @server_port, @server_name, @server_addr]
+      end
+
+      def gets(eol=LF, size=nil)
+        input.gets(eol, size)
+      end
+
+      def read(size=nil)
+        input.read(size)
+      end
+
+      def each
+        input.each{|line| yield(line) }
+      end
+
+      def eof?
+        input.eof?
+      end
+
+      def <<(data)
+        @out_port << data
+      end
+
+      def cert
+        return nil unless defined?(OpenSSL)
+        if pem = @env["SSL_SERVER_CERT"]
+          OpenSSL::X509::Certificate.new(pem) unless pem.empty?
+        end
+      end
+
+      def peer_cert
+        return nil unless defined?(OpenSSL)
+        if pem = @env["SSL_CLIENT_CERT"]
+          OpenSSL::X509::Certificate.new(pem) unless pem.empty?
+        end
+      end
+
+      def peer_cert_chain
+        return nil unless defined?(OpenSSL)
+        if @env["SSL_CLIENT_CERT_CHAIN_0"]
+          keys = @env.keys
+          certs = keys.sort.collect{|k|
+            if /^SSL_CLIENT_CERT_CHAIN_\d+$/ =~ k
+              if pem = @env[k]
+                OpenSSL::X509::Certificate.new(pem) unless pem.empty?
+              end
+            end
+          }
+          certs.compact
+        end
+      end
+
+      def cipher
+        return nil unless defined?(OpenSSL)
+        if cipher = @env["SSL_CIPHER"]
+          ret = [ cipher ]
+          ret << @env["SSL_PROTOCOL"]
+          ret << @env["SSL_CIPHER_USEKEYSIZE"]
+          ret << @env["SSL_CIPHER_ALGKEYSIZE"]
+          ret
+        end
+      end
+    end
+  end
+end