rubysl-webrick 1.0.0 → 2.0.0

data/lib/webrick/ssl.rb

@@ -2,8 +2,8 @@
 # ssl.rb -- SSL/TLS enhancement for GenericServer
 #
 # Copyright (c) 2003 GOTOU Yuuzou All rights reserved.
-# 
-# $Id: ssl.rb 11708 2007-02-12 23:01:19Z shyouhei $
+#
+# $Id$
 
 require 'webrick'
 require 'openssl'
@@ -12,6 +12,53 @@ module WEBrick
   module Config
     svrsoft = General[:ServerSoftware]
     osslv = ::OpenSSL::OPENSSL_VERSION.split[1]
+
+    ##
+    # Default SSL server configuration.
+    #
+    # WEBrick can automatically create a self-signed certificate if
+    # <code>:SSLCertName</code> is set.  For more information on the various
+    # SSL options see OpenSSL::SSL::SSLContext.
+    #
+    # :ServerSoftware       ::
+    #   The server software name used in the Server: header.
+    # :SSLEnable            :: false,
+    #   Enable SSL for this server.  Defaults to false.
+    # :SSLCertificate       ::
+    #   The SSL certificate for the server.
+    # :SSLPrivateKey        ::
+    #   The SSL private key for the server certificate.
+    # :SSLClientCA          :: nil,
+    #   Array of certificates that will be sent to the client.
+    # :SSLExtraChainCert    :: nil,
+    #   Array of certificates that willbe added to the certificate chain
+    # :SSLCACertificateFile :: nil,
+    #   Path to a CA certificate file
+    # :SSLCACertificatePath :: nil,
+    #   Path to a directory containing CA certificates
+    # :SSLCertificateStore  :: nil,
+    #   OpenSSL::X509::Store used for certificate validation of the client
+    # :SSLTmpDhCallback     :: nil,
+    #   Callback invoked when DH parameters are required.
+    # :SSLVerifyClient      ::
+    #   Sets whether the client is verified.  This defaults to VERIFY_NONE
+    #   which is typical for an HTTPS server.
+    # :SSLVerifyDepth       ::
+    #   Number of CA certificates to walk when verifying a certificate chain
+    # :SSLVerifyCallback    ::
+    #   Custom certificate verification callback
+    # :SSLTimeout           ::
+    #   Maximum session lifetime
+    # :SSLOptions           ::
+    #   Various SSL options
+    # :SSLStartImmediately  ::
+    #   Immediately start SSL upon connection?  Defaults to true
+    # :SSLCertName          ::
+    #   SSL certificate name.  Must be set to enable automatic certificate
+    #   creation.
+    # :SSLCertComment       ::
+    #   Comment used during automatic certificate creation.
+
     SSL = {
       :ServerSoftware       => "#{svrsoft} OpenSSL/#{osslv}",
       :SSLEnable            => false,
@@ -22,6 +69,7 @@ module WEBrick
       :SSLCACertificateFile => nil,
       :SSLCACertificatePath => nil,
       :SSLCertificateStore  => nil,
+      :SSLTmpDhCallback     => nil,
       :SSLVerifyClient      => ::OpenSSL::SSL::VERIFY_NONE,
       :SSLVerifyDepth       => nil,
       :SSLVerifyCallback    => nil,   # custom verification
@@ -36,12 +84,16 @@ module WEBrick
   end
 
   module Utils
+    ##
+    # Creates a self-signed certificate with the given number of +bits+,
+    # the issuer +cn+ and a +comment+ to be stored in the certificate.
+
     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,  
+        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,
@@ -50,8 +102,8 @@ module WEBrick
         end
       }
       cert = OpenSSL::X509::Certificate.new
-      cert.version = 3
-      cert.serial = 0
+      cert.version = 2
+      cert.serial = 1
       name = OpenSSL::X509::Name.new(cn)
       cert.subject = name
       cert.issuer = name
@@ -78,17 +130,30 @@ module WEBrick
     module_function :create_self_signed_cert
   end
 
+  ##
+  #--
+  # Updates WEBrick::GenericServer with SSL functionality
+
   class GenericServer
-    def ssl_context
+
+    ##
+    # SSL context for the server when run in SSL mode
+
+    def ssl_context # :nodoc:
       @ssl_context ||= nil
     end
 
-    def listen(address, port)
+    undef listen
+
+    ##
+    # Updates +listen+ to enable SSL when the SSL configuration is active.
+
+    def listen(address, port) # :nodoc:
       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) 
+          @logger.info("\n" + @config[:SSLCertificate].to_text)
         end
         listeners.collect!{|svr|
           ssvr = ::OpenSSL::SSL::SSLServer.new(svr, ssl_context)
@@ -99,7 +164,10 @@ module WEBrick
       @listeners += listeners
     end
 
-    def setup_ssl_context(config)
+    ##
+    # Sets up an SSL context for +config+
+
+    def setup_ssl_context(config) # :nodoc:
       unless config[:SSLCertificate]
         cn = config[:SSLCertName]
         comment = config[:SSLCertComment]
@@ -115,6 +183,7 @@ module WEBrick
       ctx.ca_file = config[:SSLCACertificateFile]
       ctx.ca_path = config[:SSLCACertificatePath]
       ctx.cert_store = config[:SSLCertificateStore]
+      ctx.tmp_dh_callback = config[:SSLTmpDhCallback]
       ctx.verify_mode = config[:SSLVerifyClient]
       ctx.verify_depth = config[:SSLVerifyDepth]
       ctx.verify_callback = config[:SSLVerifyCallback]

data/lib/webrick/utils.rb

@@ -18,6 +18,8 @@ end
 
 module WEBrick
   module Utils
+    ##
+    # Sets IO operations on +io+ to be non-blocking
     def set_non_blocking(io)
       flag = File::NONBLOCK
       if defined?(Fcntl::F_GETFL)
@@ -27,13 +29,17 @@ module WEBrick
     end
     module_function :set_non_blocking
 
+    ##
+    # Sets the close on exec flag for +io+
     def set_close_on_exec(io)
       if defined?(Fcntl::FD_CLOEXEC)
-        io.fcntl(Fcntl::FD_CLOEXEC, 1)
+        io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
       end
     end
     module_function :set_close_on_exec
 
+    ##
+    # Changes the process's uid and gid to the ones of +user+
     def su(user)
       if defined?(Etc)
         pw = Etc.getpwnam(user)
@@ -46,6 +52,8 @@ module WEBrick
     end
     module_function :su
 
+    ##
+    # The server hostname
     def getservername
       host = Socket::gethostname
       begin
@@ -56,6 +64,10 @@ module WEBrick
     end
     module_function :getservername
 
+    ##
+    # Creates TCP server sockets bound to +address+:+port+ and returns them.
+    #
+    # It will create IPV4 and IPV6 sockets on all interfaces.
     def create_listeners(address, port, logger=nil)
       unless port
         raise ArgumentError, "must specify port"
@@ -84,17 +96,151 @@ module WEBrick
     end
     module_function :create_listeners
 
+    ##
+    # Characters used to generate random strings
     RAND_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" +
                  "0123456789" +
-                 "abcdefghijklmnopqrstuvwxyz" 
+                 "abcdefghijklmnopqrstuvwxyz"
 
+    ##
+    # Generates a random string of length +len+
     def random_string(len)
-      rand_max = RAND_CHARS.size
-      ret = "" 
+      rand_max = RAND_CHARS.bytesize
+      ret = ""
       len.times{ ret << RAND_CHARS[rand(rand_max)] }
-      ret 
+      ret
     end
     module_function :random_string
 
+    ###########
+
+    require "thread"
+    require "timeout"
+    require "singleton"
+
+    ##
+    # Class used to manage timeout handlers across multiple threads.
+    #
+    # Timeout handlers should be managed by using the class methods which are
+    # synchronized.
+    #
+    #   id = TimeoutHandler.register(10, Timeout::Error)
+    #   begin
+    #     sleep 20
+    #     puts 'foo'
+    #   ensure
+    #     TimeoutHandler.cancel(id)
+    #   end
+    #
+    # will raise Timeout::Error
+    #
+    #   id = TimeoutHandler.register(10, Timeout::Error)
+    #   begin
+    #     sleep 5
+    #     puts 'foo'
+    #   ensure
+    #     TimeoutHandler.cancel(id)
+    #   end
+    #
+    # will print 'foo'
+    #
+    class TimeoutHandler
+      include Singleton
+
+      ##
+      # Mutex used to synchronize access across threads
+      TimeoutMutex = Mutex.new # :nodoc:
+
+      ##
+      # Registers a new timeout handler
+      #
+      # +time+:: Timeout in seconds
+      # +exception+:: Exception to raise when timeout elapsed
+      def TimeoutHandler.register(seconds, exception)
+        TimeoutMutex.synchronize{
+          instance.register(Thread.current, Time.now + seconds, exception)
+        }
+      end
+
+      ##
+      # Cancels the timeout handler +id+
+      def TimeoutHandler.cancel(id)
+        TimeoutMutex.synchronize{
+          instance.cancel(Thread.current, id)
+        }
+      end
+
+      ##
+      # Creates a new TimeoutHandler.  You should use ::register and ::cancel
+      # instead of creating the timeout handler directly.
+      def initialize
+        @timeout_info = Hash.new
+        Thread.start{
+          while true
+            now = Time.now
+            @timeout_info.keys.each{|thread|
+              ary = @timeout_info[thread]
+              next unless ary
+              ary.dup.each{|info|
+                time, exception = *info
+                interrupt(thread, info.object_id, exception) if time < now
+              }
+            }
+            sleep 0.5
+          end
+        }
+      end
+
+      ##
+      # Interrupts the timeout handler +id+ and raises +exception+
+      def interrupt(thread, id, exception)
+        TimeoutMutex.synchronize{
+          if cancel(thread, id) && thread.alive?
+            thread.raise(exception, "execution timeout")
+          end
+        }
+      end
+
+      ##
+      # Registers a new timeout handler
+      #
+      # +time+:: Timeout in seconds
+      # +exception+:: Exception to raise when timeout elapsed
+      def register(thread, time, exception)
+        @timeout_info[thread] ||= Array.new
+        @timeout_info[thread] << [time, exception]
+        return @timeout_info[thread].last.object_id
+      end
+
+      ##
+      # Cancels the timeout handler +id+
+      def cancel(thread, id)
+        if ary = @timeout_info[thread]
+          ary.delete_if{|info| info.object_id == id }
+          if ary.empty?
+            @timeout_info.delete(thread)
+          end
+          return true
+        end
+        return false
+      end
+    end
+
+    ##
+    # Executes the passed block and raises +exception+ if execution takes more
+    # than +seconds+.
+    #
+    # If +seconds+ is zero or nil, simply executes the block
+    def timeout(seconds, exception=Timeout::Error)
+      return yield if seconds.nil? or seconds.zero?
+      # raise ThreadError, "timeout within critical session" if Thread.critical
+      id = TimeoutHandler.register(seconds, exception)
+      begin
+        yield(seconds)
+      ensure
+        TimeoutHandler.cancel(id)
+      end
+    end
+    module_function :timeout
   end
 end

data/lib/webrick/version.rb

@@ -1,4 +1,4 @@
-#
+#--
 # version.rb -- version and release date
 #
 # Author: IPR -- Internet Programming with Ruby -- writers
@@ -9,5 +9,9 @@
 # $IPR: version.rb,v 1.74 2003/07/22 19:20:43 gotoyuzo Exp $
 
 module WEBrick
+
+  ##
+  # The WEBrick version
+
   VERSION      = "1.3.1"
 end

data/rubysl-webrick.gemspec

@@ -19,5 +19,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "mspec", "~> 1.5"
-  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-webrick
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -18,13 +19,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -32,13 +33,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: mspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -46,26 +47,11 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubysl-prettyprint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Ruby standard library webrick.
 email:
 - brixen@gmail.com
@@ -128,17 +114,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: !binary |-
+        MA==
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: !binary |-
+        MA==
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby standard library webrick.