webrick 1.3.1

data/lib/webrick/httpversion.rb

@@ -0,0 +1,49 @@
+#--
+# HTTPVersion.rb -- presentation of HTTP version
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+# Copyright (c) 2002 Internet Programming with Ruby writers. All rights
+# reserved.
+#
+# $IPR: httpversion.rb,v 1.5 2002/09/21 12:23:37 gotoyuzo Exp $
+
+module WEBrick
+  class HTTPVersion
+    include Comparable
+
+    attr_accessor :major, :minor
+
+    def self.convert(version)
+      version.is_a?(self) ? version : new(version)
+    end
+
+    def initialize(version)
+      case version
+      when HTTPVersion
+        @major, @minor = version.major, version.minor
+      when String
+        if /^(\d+)\.(\d+)$/ =~ version
+          @major, @minor = $1.to_i, $2.to_i
+        end
+      end
+      if @major.nil? || @minor.nil?
+        raise ArgumentError,
+          format("cannot convert %s into %s", version.class, self.class)
+      end
+    end
+
+    def <=>(other)
+      unless other.is_a?(self.class)
+        other = self.class.new(other)
+      end
+      if (ret = @major <=> other.major) == 0
+        return @minor <=> other.minor
+      end
+      return ret
+    end
+
+    def to_s
+      format("%d.%d", @major, @minor)
+    end
+  end
+end

data/lib/webrick/log.rb

@@ -0,0 +1,136 @@
+#--
+# log.rb -- Log Class
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+# Copyright (c) 2000, 2001 TAKAHASHI Masayoshi, GOTOU Yuuzou
+# Copyright (c) 2002 Internet Programming with Ruby writers. All rights
+# reserved.
+#
+# $IPR: log.rb,v 1.26 2002/10/06 17:06:10 gotoyuzo Exp $
+
+module WEBrick
+
+  ##
+  # A generic logging class
+
+  class BasicLog
+    # log-level constants
+    FATAL, ERROR, WARN, INFO, DEBUG = 1, 2, 3, 4, 5
+
+    # log-level, messages above this level will be logged
+    attr_accessor :level
+
+    ##
+    # Initializes a new logger for +log_file+ that outputs messages at +level+
+    # or higher.  +log_file+ can be a filename, an IO-like object that
+    # responds to #<< or nil which outputs to $stderr.
+    #
+    # If no level is given INFO is chosen by default
+
+    def initialize(log_file=nil, level=nil)
+      @level = level || INFO
+      case log_file
+      when String
+        @log = open(log_file, "a+")
+        @log.sync = true
+        @opened = true
+      when NilClass
+        @log = $stderr
+      else
+        @log = log_file  # requires "<<". (see BasicLog#log)
+      end
+    end
+
+    ##
+    # Closes the logger (also closes the log device associated to the logger)
+    def close
+      @log.close if @opened
+      @log = nil
+    end
+
+    ##
+    # Logs +data+ at +level+ if the given level is above the current log
+    # level.
+
+    def log(level, data)
+      if @log && level <= @level
+        data += "\n" if /\n\Z/ !~ data
+        @log << data
+      end
+    end
+
+    ##
+    # Synonym for log(INFO, obj.to_s)
+    def <<(obj)
+      log(INFO, obj.to_s)
+    end
+
+    # Shortcut for logging a FATAL message
+    def fatal(msg) log(FATAL, "FATAL " << format(msg)); end
+    # Shortcut for logging an ERROR message
+    def error(msg) log(ERROR, "ERROR " << format(msg)); end
+    # Shortcut for logging a WARN message
+    def warn(msg)  log(WARN,  "WARN  " << format(msg)); end
+    # Shortcut for logging an INFO message
+    def info(msg)  log(INFO,  "INFO  " << format(msg)); end
+    # Shortcut for logging a DEBUG message
+    def debug(msg) log(DEBUG, "DEBUG " << format(msg)); end
+
+    # Will the logger output FATAL messages?
+    def fatal?; @level >= FATAL; end
+    # Will the logger output ERROR messages?
+    def error?; @level >= ERROR; end
+    # Will the logger output WARN messages?
+    def warn?;  @level >= WARN; end
+    # Will the logger output INFO messages?
+    def info?;  @level >= INFO; end
+    # Will the logger output DEBUG messages?
+    def debug?; @level >= DEBUG; end
+
+    private
+
+    ##
+    # Formats +arg+ for the logger
+    #
+    # * If +arg+ is an Exception, it will format the error message and
+    #   the back trace.
+    # * If +arg+ responds to #to_str, it will return it.
+    # * Otherwise it will return +arg+.inspect.
+    def format(arg)
+      if arg.is_a?(Exception)
+        "#{arg.class}: #{arg.message}\n\t" <<
+        arg.backtrace.join("\n\t") << "\n"
+      elsif arg.respond_to?(:to_str)
+        arg.to_str
+      else
+        arg.inspect
+      end
+    end
+  end
+
+  ##
+  # A logging class that prepends a timestamp to each message.
+
+  class Log < BasicLog
+    # Format of the timestamp which is applied to each logged line.  The
+    # default is <tt>"[%Y-%m-%d %H:%M:%S]"</tt>
+    attr_accessor :time_format
+
+    ##
+    # Same as BasicLog#initialize
+    #
+    # You can set the timestamp format through #time_format
+    def initialize(log_file=nil, level=nil)
+      super(log_file, level)
+      @time_format = "[%Y-%m-%d %H:%M:%S]"
+    end
+
+    ##
+    # Same as BasicLog#log
+    def log(level, data)
+      tmp = Time.now.strftime(@time_format)
+      tmp << " " << data
+      super(level, tmp)
+    end
+  end
+end

data/lib/webrick/server.rb

@@ -0,0 +1,218 @@
+#
+# server.rb -- GenericServer Class
+#
+# Author: IPR -- Internet Programming with Ruby -- writers
+# Copyright (c) 2000, 2001 TAKAHASHI Masayoshi, GOTOU Yuuzou
+# Copyright (c) 2002 Internet Programming with Ruby writers. All rights
+# reserved.
+#
+# $IPR: server.rb,v 1.62 2003/07/22 19:20:43 gotoyuzo Exp $
+
+require 'thread'
+require 'socket'
+require 'webrick/config'
+require 'webrick/log'
+
+module WEBrick
+
+  class ServerError < StandardError; end
+
+  class SimpleServer
+    def SimpleServer.start
+      yield
+    end
+  end
+
+  ##
+  # A generic module for daemonizing a process
+
+  class Daemon
+
+    ##
+    # Performs the standard operations for daemonizing a process.  Runs a
+    # block, if given.
+
+    def Daemon.start
+      exit!(0) if fork
+      Process::setsid
+      exit!(0) if fork
+      Dir::chdir("/")
+      File::umask(0)
+      STDIN.reopen("/dev/null")
+      STDOUT.reopen("/dev/null", "w")
+      STDERR.reopen("/dev/null", "w")
+      yield if block_given?
+    end
+  end
+
+  class GenericServer
+    attr_reader :status, :config, :logger, :tokens, :listeners
+
+    def initialize(config={}, default=Config::General)
+      @config = default.dup.update(config)
+      @status = :Stop
+      @config[:Logger] ||= Log::new
+      @logger = @config[:Logger]
+
+      @tokens = SizedQueue.new(@config[:MaxClients])
+      @config[:MaxClients].times{ @tokens.push(nil) }
+
+      webrickv = WEBrick::VERSION
+      rubyv = "#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+      @logger.info("WEBrick #{webrickv}")
+      @logger.info("ruby #{rubyv}")
+
+      @listeners = []
+      unless @config[:DoNotListen]
+        if @config[:Listen]
+          warn(":Listen option is deprecated; use GenericServer#listen")
+        end
+        listen(@config[:BindAddress], @config[:Port])
+        if @config[:Port] == 0
+          @config[:Port] = @listeners[0].addr[1]
+        end
+      end
+    end
+
+    def [](key)
+      @config[key]
+    end
+
+    def listen(address, port)
+      @listeners += Utils::create_listeners(address, port, @logger)
+    end
+
+    def start(&block)
+      raise ServerError, "already started." if @status != :Stop
+      server_type = @config[:ServerType] || SimpleServer
+
+      server_type.start{
+        @logger.info \
+          "#{self.class}#start: pid=#{$$} port=#{@config[:Port]}"
+        call_callback(:StartCallback)
+
+        thgroup = ThreadGroup.new
+        @status = :Running
+        while @status == :Running
+          begin
+            if svrs = IO.select(@listeners, nil, nil, 2.0)
+              svrs[0].each{|svr|
+                @tokens.pop          # blocks while no token is there.
+                if sock = accept_client(svr)
+                  sock.do_not_reverse_lookup = config[:DoNotReverseLookup]
+                  th = start_thread(sock, &block)
+                  th[:WEBrickThread] = true
+                  thgroup.add(th)
+                else
+                  @tokens.push(nil)
+                end
+              }
+            end
+          rescue Errno::EBADF, IOError => ex
+            # if the listening socket was closed in GenericServer#shutdown,
+            # IO::select raise it.
+          rescue Exception => ex
+            msg = "#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}"
+            @logger.error msg
+          end
+        end
+
+        @logger.info "going to shutdown ..."
+        thgroup.list.each{|th| th.join if th[:WEBrickThread] }
+        call_callback(:StopCallback)
+        @logger.info "#{self.class}#start done."
+        @status = :Stop
+      }
+    end
+
+    def stop
+      if @status == :Running
+        @status = :Shutdown
+      end
+    end
+
+    def shutdown
+      stop
+      @listeners.each{|s|
+        if @logger.debug?
+          addr = s.addr
+          @logger.debug("close TCPSocket(#{addr[2]}, #{addr[1]})")
+        end
+        begin
+          s.shutdown
+        rescue Errno::ENOTCONN
+          # when `Errno::ENOTCONN: Socket is not connected' on some platforms,
+          # call #close instead of #shutdown.
+          # (ignore @config[:ShutdownSocketWithoutClose])
+          s.close
+        else
+          unless @config[:ShutdownSocketWithoutClose]
+            s.close
+          end
+        end
+      }
+      @listeners.clear
+    end
+
+    def run(sock)
+      @logger.fatal "run() must be provided by user."
+    end
+
+    private
+
+    def accept_client(svr)
+      sock = nil
+      begin
+        sock = svr.accept
+        sock.sync = true
+        Utils::set_non_blocking(sock)
+        Utils::set_close_on_exec(sock)
+      rescue Errno::ECONNRESET, Errno::ECONNABORTED,
+             Errno::EPROTO, Errno::EINVAL => ex
+      rescue Exception => ex
+        msg = "#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}"
+        @logger.error msg
+      end
+      return sock
+    end
+
+    def start_thread(sock, &block)
+      Thread.start{
+        begin
+          Thread.current[:WEBrickSocket] = sock
+          begin
+            addr = sock.peeraddr
+            @logger.debug "accept: #{addr[3]}:#{addr[1]}"
+          rescue SocketError
+            @logger.debug "accept: <address unknown>"
+            raise
+          end
+          call_callback(:AcceptCallback, sock)
+          block ? block.call(sock) : run(sock)
+        rescue Errno::ENOTCONN
+          @logger.debug "Errno::ENOTCONN raised"
+        rescue ServerError => ex
+          msg = "#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}"
+          @logger.error msg
+        rescue Exception => ex
+          @logger.error ex
+        ensure
+          @tokens.push(nil)
+          Thread.current[:WEBrickSocket] = nil
+          if addr
+            @logger.debug "close: #{addr[3]}:#{addr[1]}"
+          else
+            @logger.debug "close: <address unknown>"
+          end
+          sock.close
+        end
+      }
+    end
+
+    def call_callback(callback_name, *args)
+      if cb = @config[callback_name]
+        cb.call(*args)
+      end
+    end
+  end    # end of GenericServer
+end

data/lib/webrick/ssl.rb

@@ -0,0 +1,127 @@
+#
+# ssl.rb -- SSL/TLS enhancement for GenericServer
+#
+# Copyright (c) 2003 GOTOU Yuuzou All rights reserved.
+#
+# $Id$
+
+require 'webrick'
+require 'openssl'
+
+module WEBrick
+  module Config
+    svrsoft = General[:ServerSoftware]
+    osslv = ::OpenSSL::OPENSSL_VERSION.split[1]
+    SSL = {
+      :ServerSoftware       => "#{svrsoft} OpenSSL/#{osslv}",
+      :SSLEnable            => false,
+      :SSLCertificate       => nil,
+      :SSLPrivateKey        => nil,
+      :SSLClientCA          => nil,
+      :SSLExtraChainCert    => nil,
+      :SSLCACertificateFile => nil,
+      :SSLCACertificatePath => nil,
+      :SSLCertificateStore  => nil,
+      :SSLVerifyClient      => ::OpenSSL::SSL::VERIFY_NONE,
+      :SSLVerifyDepth       => nil,
+      :SSLVerifyCallback    => nil,   # custom verification
+      :SSLTimeout           => nil,
+      :SSLOptions           => nil,
+      :SSLStartImmediately  => true,
+      # Must specify if you use auto generated certificate.
+      :SSLCertName          => nil,
+      :SSLCertComment       => "Generated by Ruby/OpenSSL"
+    }
+    General.update(SSL)
+  end
+
+  module Utils
+    def create_self_signed_cert(bits, cn, comment)
+      rsa = OpenSSL::PKey::RSA.new(bits){|p, n|
+        case p
+        when 0; $stderr.putc "."  # BN_generate_prime
+        when 1; $stderr.putc "+"  # BN_generate_prime
+        when 2; $stderr.putc "*"  # searching good prime,
+                                  # n = #of try,
+                                  # but also data from BN_generate_prime
+        when 3; $stderr.putc "\n" # found good prime, n==0 - p, n==1 - q,
+                                  # but also data from BN_generate_prime
+        else;   $stderr.putc "*"  # BN_generate_prime
+        end
+      }
+      cert = OpenSSL::X509::Certificate.new
+      cert.version = 2
+      cert.serial = 1
+      name = OpenSSL::X509::Name.new(cn)
+      cert.subject = name
+      cert.issuer = name
+      cert.not_before = Time.now
+      cert.not_after = Time.now + (365*24*60*60)
+      cert.public_key = rsa.public_key
+
+      ef = OpenSSL::X509::ExtensionFactory.new(nil,cert)
+      ef.issuer_certificate = cert
+      cert.extensions = [
+        ef.create_extension("basicConstraints","CA:FALSE"),
+        ef.create_extension("keyUsage", "keyEncipherment"),
+        ef.create_extension("subjectKeyIdentifier", "hash"),
+        ef.create_extension("extendedKeyUsage", "serverAuth"),
+        ef.create_extension("nsComment", comment),
+      ]
+      aki = ef.create_extension("authorityKeyIdentifier",
+                                "keyid:always,issuer:always")
+      cert.add_extension(aki)
+      cert.sign(rsa, OpenSSL::Digest::SHA1.new)
+
+      return [ cert, rsa ]
+    end
+    module_function :create_self_signed_cert
+  end
+
+  class GenericServer
+    def ssl_context
+      @ssl_context ||= nil
+    end
+
+    undef listen
+    def listen(address, port)
+      listeners = Utils::create_listeners(address, port, @logger)
+      if @config[:SSLEnable]
+        unless ssl_context
+          @ssl_context = setup_ssl_context(@config)
+          @logger.info("\n" + @config[:SSLCertificate].to_text)
+        end
+        listeners.collect!{|svr|
+          ssvr = ::OpenSSL::SSL::SSLServer.new(svr, ssl_context)
+          ssvr.start_immediately = @config[:SSLStartImmediately]
+          ssvr
+        }
+      end
+      @listeners += listeners
+    end
+
+    def setup_ssl_context(config)
+      unless config[:SSLCertificate]
+        cn = config[:SSLCertName]
+        comment = config[:SSLCertComment]
+        cert, key = Utils::create_self_signed_cert(1024, cn, comment)
+        config[:SSLCertificate] = cert
+        config[:SSLPrivateKey] = key
+      end
+      ctx = OpenSSL::SSL::SSLContext.new
+      ctx.key = config[:SSLPrivateKey]
+      ctx.cert = config[:SSLCertificate]
+      ctx.client_ca = config[:SSLClientCA]
+      ctx.extra_chain_cert = config[:SSLExtraChainCert]
+      ctx.ca_file = config[:SSLCACertificateFile]
+      ctx.ca_path = config[:SSLCACertificatePath]
+      ctx.cert_store = config[:SSLCertificateStore]
+      ctx.verify_mode = config[:SSLVerifyClient]
+      ctx.verify_depth = config[:SSLVerifyDepth]
+      ctx.verify_callback = config[:SSLVerifyCallback]
+      ctx.timeout = config[:SSLTimeout]
+      ctx.options = config[:SSLOptions]
+      ctx
+    end
+  end
+end