drb 2.0.4

data/lib/drb/eq.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: false
+module DRb
+  class DRbObject # :nodoc:
+    def ==(other)
+      return false unless DRbObject === other
+     (@ref == other.__drbref) && (@uri == other.__drburi)
+    end
+
+    def hash
+      [@uri, @ref].hash
+    end
+
+    alias eql? ==
+  end
+end

data/lib/drb/extserv.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: false
+=begin
+ external service
+        Copyright (c) 2000,2002 Masatoshi SEKI
+=end
+
+require_relative 'drb'
+require 'monitor'
+
+module DRb
+  class ExtServ
+    include MonitorMixin
+    include DRbUndumped
+
+    def initialize(there, name, server=nil)
+      super()
+      @server = server || DRb::primary_server
+      @name = name
+      ro = DRbObject.new(nil, there)
+      synchronize do
+        @invoker = ro.regist(name, DRbObject.new(self, @server.uri))
+      end
+    end
+    attr_reader :server
+
+    def front
+      DRbObject.new(nil, @server.uri)
+    end
+
+    def stop_service
+      synchronize do
+        @invoker.unregist(@name)
+        server = @server
+        @server = nil
+        server.stop_service
+        true
+      end
+    end
+
+    def alive?
+      @server ? @server.alive? : false
+    end
+  end
+end

data/lib/drb/extservm.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: false
+=begin
+ external service manager
+        Copyright (c) 2000 Masatoshi SEKI
+=end
+
+require_relative 'drb'
+require 'monitor'
+
+module DRb
+  class ExtServManager
+    include DRbUndumped
+    include MonitorMixin
+
+    @@command = {}
+
+    def self.command
+      @@command
+    end
+
+    def self.command=(cmd)
+      @@command = cmd
+    end
+
+    def initialize
+      super()
+      @cond = new_cond
+      @servers = {}
+      @waiting = []
+      @queue = Thread::Queue.new
+      @thread = invoke_thread
+      @uri = nil
+    end
+    attr_accessor :uri
+
+    def service(name)
+      synchronize do
+        while true
+          server = @servers[name]
+          return server if server && server.alive? # server may be `false'
+          invoke_service(name)
+          @cond.wait
+        end
+      end
+    end
+
+    def regist(name, ro)
+      synchronize do
+        @servers[name] = ro
+        @cond.signal
+      end
+      self
+    end
+
+    def unregist(name)
+      synchronize do
+        @servers.delete(name)
+      end
+    end
+
+    private
+    def invoke_thread
+      Thread.new do
+        while name = @queue.pop
+          invoke_service_command(name, @@command[name])
+        end
+      end
+    end
+
+    def invoke_service(name)
+      @queue.push(name)
+    end
+
+    def invoke_service_command(name, command)
+      raise "invalid command. name: #{name}" unless command
+      synchronize do
+        return if @servers.include?(name)
+        @servers[name] = false
+      end
+      uri = @uri || DRb.uri
+      if command.respond_to? :to_ary
+        command = command.to_ary + [uri, name]
+        pid = spawn(*command)
+      else
+        pid = spawn("#{command} #{uri} #{name}")
+      end
+      th = Process.detach(pid)
+      th[:drb_service] = name
+      th
+    end
+  end
+end

data/lib/drb/gw.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: false
+require_relative 'drb'
+require 'monitor'
+
+module DRb
+
+  # Gateway id conversion forms a gateway between different DRb protocols or
+  # networks.
+  #
+  # The gateway needs to install this id conversion and create servers for
+  # each of the protocols or networks it will be a gateway between.  It then
+  # needs to create a server that attaches to each of these networks.  For
+  # example:
+  #
+  #   require 'drb/drb'
+  #   require 'drb/unix'
+  #   require 'drb/gw'
+  #
+  #   DRb.install_id_conv DRb::GWIdConv.new
+  #   gw = DRb::GW.new
+  #   s1 = DRb::DRbServer.new 'drbunix:/path/to/gateway', gw
+  #   s2 = DRb::DRbServer.new 'druby://example:10000', gw
+  #
+  #   s1.thread.join
+  #   s2.thread.join
+  #
+  # Each client must register services with the gateway, for example:
+  #
+  #   DRb.start_service 'drbunix:', nil # an anonymous server
+  #   gw = DRbObject.new nil, 'drbunix:/path/to/gateway'
+  #   gw[:unix] = some_service
+  #   DRb.thread.join
+
+  class GWIdConv < DRbIdConv
+    def to_obj(ref) # :nodoc:
+      if Array === ref && ref[0] == :DRbObject
+        return DRbObject.new_with(ref[1], ref[2])
+      end
+      super(ref)
+    end
+  end
+
+  # The GW provides a synchronized store for participants in the gateway to
+  # communicate.
+
+  class GW
+    include MonitorMixin
+
+    # Creates a new GW
+
+    def initialize
+      super()
+      @hash = {}
+    end
+
+    # Retrieves +key+ from the GW
+
+    def [](key)
+      synchronize do
+        @hash[key]
+      end
+    end
+
+    # Stores value +v+ at +key+ in the GW
+
+    def []=(key, v)
+      synchronize do
+        @hash[key] = v
+      end
+    end
+  end
+
+  class DRbObject # :nodoc:
+    def self._load(s)
+      uri, ref = Marshal.load(s)
+      if DRb.uri == uri
+        return ref ? DRb.to_obj(ref) : DRb.front
+      end
+
+      self.new_with(DRb.uri, [:DRbObject, uri, ref])
+    end
+
+    def _dump(lv)
+      if DRb.uri == @uri
+        if Array === @ref && @ref[0] == :DRbObject
+          Marshal.dump([@ref[1], @ref[2]])
+        else
+          Marshal.dump([@uri, @ref]) # ??
+        end
+      else
+        Marshal.dump([DRb.uri, [:DRbObject, @uri, @ref]])
+      end
+    end
+  end
+end
+
+=begin
+DRb.install_id_conv(DRb::GWIdConv.new)
+
+front = DRb::GW.new
+
+s1 = DRb::DRbServer.new('drbunix:/tmp/gw_b_a', front)
+s2 = DRb::DRbServer.new('drbunix:/tmp/gw_b_c', front)
+
+s1.thread.join
+s2.thread.join
+=end
+
+=begin
+# foo.rb
+
+require 'drb/drb'
+
+class Foo
+  include DRbUndumped
+  def initialize(name, peer=nil)
+    @name = name
+    @peer = peer
+  end
+
+  def ping(obj)
+    puts "#{@name}: ping: #{obj.inspect}"
+    @peer.ping(self) if @peer
+  end
+end
+=end
+
+=begin
+# gw_a.rb
+require 'drb/unix'
+require 'foo'
+
+obj = Foo.new('a')
+DRb.start_service("drbunix:/tmp/gw_a", obj)
+
+robj = DRbObject.new_with_uri('drbunix:/tmp/gw_b_a')
+robj[:a] = obj
+
+DRb.thread.join
+=end
+
+=begin
+# gw_c.rb
+require 'drb/unix'
+require 'foo'
+
+foo = Foo.new('c', nil)
+
+DRb.start_service("drbunix:/tmp/gw_c", nil)
+
+robj = DRbObject.new_with_uri("drbunix:/tmp/gw_b_c")
+
+puts "c->b"
+a = robj[:a]
+sleep 2
+
+a.ping(foo)
+
+DRb.thread.join
+=end
+

data/lib/drb/invokemethod.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: false
+# for ruby-1.8.0
+
+module DRb # :nodoc: all
+  class DRbServer
+    module InvokeMethod18Mixin
+      def block_yield(x)
+        if x.size == 1 && x[0].class == Array
+          x[0] = DRbArray.new(x[0])
+        end
+        @block.call(*x)
+      end
+
+      def perform_with_block
+        @obj.__send__(@msg_id, *@argv) do |*x|
+          jump_error = nil
+          begin
+            block_value = block_yield(x)
+          rescue LocalJumpError
+            jump_error = $!
+          end
+          if jump_error
+            case jump_error.reason
+            when :break
+              break(jump_error.exit_value)
+            else
+              raise jump_error
+            end
+          end
+          block_value
+        end
+      end
+    end
+  end
+end

data/lib/drb/observer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: false
+require 'observer'
+
+module DRb
+  # The Observable module extended to DRb.  See Observable for details.
+  module DRbObservable
+    include Observable
+
+    # Notifies observers of a change in state.  See also
+    # Observable#notify_observers
+    def notify_observers(*arg)
+      if defined? @observer_state and @observer_state
+        if defined? @observer_peers
+          @observer_peers.each do |observer, method|
+            begin
+              observer.send(method, *arg)
+            rescue
+              delete_observer(observer)
+            end
+          end
+        end
+        @observer_state = false
+      end
+    end
+  end
+end

data/lib/drb/ssl.rb

@@ -0,0 +1,344 @@
+# frozen_string_literal: false
+require 'socket'
+require 'openssl'
+require_relative 'drb'
+require 'singleton'
+
+module DRb
+
+  # The protocol for DRb over an SSL socket
+  #
+  # The URI for a DRb socket over SSL is:
+  # <code>drbssl://<host>:<port>?<option></code>.  The option is optional
+  class DRbSSLSocket < DRbTCPSocket
+
+    # SSLConfig handles the needed SSL information for establishing a
+    # DRbSSLSocket connection, including generating the X509 / RSA pair.
+    #
+    # An instance of this config can be passed to DRbSSLSocket.new,
+    # DRbSSLSocket.open and DRbSSLSocket.open_server
+    #
+    # See DRb::DRbSSLSocket::SSLConfig.new for more details
+    class SSLConfig
+
+      # Default values for a SSLConfig instance.
+      #
+      # See DRb::DRbSSLSocket::SSLConfig.new for more details
+      DEFAULT = {
+        :SSLCertificate       => nil,
+        :SSLPrivateKey        => nil,
+        :SSLClientCA          => nil,
+        :SSLCACertificatePath => nil,
+        :SSLCACertificateFile => nil,
+        :SSLTmpDhCallback     => nil,
+        :SSLVerifyMode        => ::OpenSSL::SSL::VERIFY_NONE,
+        :SSLVerifyDepth       => nil,
+        :SSLVerifyCallback    => nil,   # custom verification
+        :SSLCertificateStore  => nil,
+        # Must specify if you use auto generated certificate.
+        :SSLCertName          => nil,   # e.g. [["CN","fqdn.example.com"]]
+        :SSLCertComment       => "Generated by Ruby/OpenSSL"
+      }
+
+      # Create a new DRb::DRbSSLSocket::SSLConfig instance
+      #
+      # The DRb::DRbSSLSocket will take either a +config+ Hash or an instance
+      # of SSLConfig, and will setup the certificate for its session for the
+      # configuration. If want it to generate a generic certificate, the bare
+      # minimum is to provide the :SSLCertName
+      #
+      # === Config options
+      #
+      # From +config+ Hash:
+      #
+      # :SSLCertificate ::
+      #   An instance of OpenSSL::X509::Certificate.  If this is not provided,
+      #   then a generic X509 is generated, with a correspond :SSLPrivateKey
+      #
+      # :SSLPrivateKey ::
+      #   A private key instance, like OpenSSL::PKey::RSA.  This key must be
+      #   the key that signed the :SSLCertificate
+      #
+      # :SSLClientCA ::
+      #   An OpenSSL::X509::Certificate, or Array of certificates that will
+      #   used as ClientCAs in the SSL Context
+      #
+      # :SSLCACertificatePath ::
+      #   A path to the directory of CA certificates.  The certificates must
+      #   be in PEM format.
+      #
+      # :SSLCACertificateFile ::
+      #   A path to a CA certificate file, in PEM format.
+      #
+      # :SSLTmpDhCallback ::
+      #   A DH callback. See OpenSSL::SSL::SSLContext.tmp_dh_callback
+      #
+      # :SSLVerifyMode ::
+      #   This is the SSL verification mode.  See OpenSSL::SSL::VERIFY_* for
+      #   available modes.  The default is OpenSSL::SSL::VERIFY_NONE
+      #
+      # :SSLVerifyDepth ::
+      #   Number of CA certificates to walk, when verifying a certificate
+      #   chain.
+      #
+      # :SSLVerifyCallback ::
+      #   A callback to be used for additional verification.  See
+      #   OpenSSL::SSL::SSLContext.verify_callback
+      #
+      # :SSLCertificateStore ::
+      #   A OpenSSL::X509::Store used for verification of certificates
+      #
+      # :SSLCertName ::
+      #   Issuer name for the certificate.  This is required when generating
+      #   the certificate (if :SSLCertificate and :SSLPrivateKey were not
+      #   given).  The value of this is to be an Array of pairs:
+      #
+      #     [["C", "Raleigh"], ["ST","North Carolina"],
+      #      ["CN","fqdn.example.com"]]
+      #
+      #   See also OpenSSL::X509::Name
+      #
+      # :SSLCertComment ::
+      #   A comment to be used for generating the certificate.  The default is
+      #   "Generated by Ruby/OpenSSL"
+      #
+      #
+      # === Example
+      #
+      # These values can be added after the fact, like a Hash.
+      #
+      #   require 'drb/ssl'
+      #   c = DRb::DRbSSLSocket::SSLConfig.new {}
+      #   c[:SSLCertificate] =
+      #     OpenSSL::X509::Certificate.new(File.read('mycert.crt'))
+      #   c[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(File.read('mycert.key'))
+      #   c[:SSLVerifyMode] = OpenSSL::SSL::VERIFY_PEER
+      #   c[:SSLCACertificatePath] = "/etc/ssl/certs/"
+      #   c.setup_certificate
+      #
+      # or
+      #
+      #   require 'drb/ssl'
+      #   c = DRb::DRbSSLSocket::SSLConfig.new({
+      #           :SSLCertName => [["CN" => DRb::DRbSSLSocket.getservername]]
+      #           })
+      #   c.setup_certificate
+      #
+      def initialize(config)
+        @config  = config
+        @cert    = config[:SSLCertificate]
+        @pkey    = config[:SSLPrivateKey]
+        @ssl_ctx = nil
+      end
+
+      # A convenience method to access the values like a Hash
+      def [](key);
+        @config[key] || DEFAULT[key]
+      end
+
+      # Connect to IO +tcp+, with context of the current certificate
+      # configuration
+      def connect(tcp)
+        ssl = ::OpenSSL::SSL::SSLSocket.new(tcp, @ssl_ctx)
+        ssl.sync = true
+        ssl.connect
+        ssl
+      end
+
+      # Accept connection to IO +tcp+, with context of the current certificate
+      # configuration
+      def accept(tcp)
+        ssl = OpenSSL::SSL::SSLSocket.new(tcp, @ssl_ctx)
+        ssl.sync = true
+        ssl.accept
+        ssl
+      end
+
+      # Ensures that :SSLCertificate and :SSLPrivateKey have been provided
+      # or that a new certificate is generated with the other parameters
+      # provided.
+      def setup_certificate
+        if @cert && @pkey
+          return
+        end
+
+        rsa = OpenSSL::PKey::RSA.new(2048){|p, n|
+          next unless self[:verbose]
+          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 = 3
+        cert.serial = 0
+        name = OpenSSL::X509::Name.new(self[:SSLCertName])
+        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)
+        cert.extensions = [
+          ef.create_extension("basicConstraints","CA:FALSE"),
+          ef.create_extension("subjectKeyIdentifier", "hash") ]
+        ef.issuer_certificate = cert
+        cert.add_extension(ef.create_extension("authorityKeyIdentifier",
+                                               "keyid:always,issuer:always"))
+        if comment = self[:SSLCertComment]
+          cert.add_extension(ef.create_extension("nsComment", comment))
+        end
+        cert.sign(rsa, "SHA256")
+
+        @cert = cert
+        @pkey = rsa
+      end
+
+      # Establish the OpenSSL::SSL::SSLContext with the configuration
+      # parameters provided.
+      def setup_ssl_context
+        ctx = ::OpenSSL::SSL::SSLContext.new
+        ctx.cert            = @cert
+        ctx.key             = @pkey
+        ctx.client_ca       = self[:SSLClientCA]
+        ctx.ca_path         = self[:SSLCACertificatePath]
+        ctx.ca_file         = self[:SSLCACertificateFile]
+        ctx.tmp_dh_callback = self[:SSLTmpDhCallback]
+        ctx.verify_mode     = self[:SSLVerifyMode]
+        ctx.verify_depth    = self[:SSLVerifyDepth]
+        ctx.verify_callback = self[:SSLVerifyCallback]
+        ctx.cert_store      = self[:SSLCertificateStore]
+        @ssl_ctx = ctx
+      end
+    end
+
+    # Parse the dRuby +uri+ for an SSL connection.
+    #
+    # Expects drbssl://...
+    #
+    # Raises DRbBadScheme or DRbBadURI if +uri+ is not matching or malformed
+    def self.parse_uri(uri) # :nodoc:
+      if /\Adrbssl:\/\/(.*?):(\d+)(\?(.*))?\z/ =~ uri
+        host = $1
+        port = $2.to_i
+        option = $4
+        [host, port, option]
+      else
+        raise(DRbBadScheme, uri) unless uri.start_with?('drbssl:')
+        raise(DRbBadURI, 'can\'t parse uri:' + uri)
+      end
+    end
+
+    # Return an DRb::DRbSSLSocket instance as a client-side connection,
+    # with the SSL connected.  This is called from DRb::start_service or while
+    # connecting to a remote object:
+    #
+    #   DRb.start_service 'drbssl://localhost:0', front, config
+    #
+    # +uri+ is the URI we are connected to,
+    # <code>'drbssl://localhost:0'</code> above, +config+ is our
+    # configuration.  Either a Hash or DRb::DRbSSLSocket::SSLConfig
+    def self.open(uri, config)
+      host, port, = parse_uri(uri)
+      soc = TCPSocket.open(host, port)
+      ssl_conf = SSLConfig::new(config)
+      ssl_conf.setup_ssl_context
+      ssl = ssl_conf.connect(soc)
+      self.new(uri, ssl, ssl_conf, true)
+    end
+
+    # Returns a DRb::DRbSSLSocket instance as a server-side connection, with
+    # the SSL connected.  This is called from DRb::start_service or while
+    # connecting to a remote object:
+    #
+    #   DRb.start_service 'drbssl://localhost:0', front, config
+    #
+    # +uri+ is the URI we are connected to,
+    # <code>'drbssl://localhost:0'</code> above, +config+ is our
+    # configuration.  Either a Hash or DRb::DRbSSLSocket::SSLConfig
+    def self.open_server(uri, config)
+      uri = 'drbssl://:0' unless uri
+      host, port, = parse_uri(uri)
+      if host.size == 0
+        host = getservername
+        soc = open_server_inaddr_any(host, port)
+      else
+        soc = TCPServer.open(host, port)
+      end
+      port = soc.addr[1] if port == 0
+      @uri = "drbssl://#{host}:#{port}"
+
+      ssl_conf = SSLConfig.new(config)
+      ssl_conf.setup_certificate
+      ssl_conf.setup_ssl_context
+      self.new(@uri, soc, ssl_conf, false)
+    end
+
+    # This is a convenience method to parse +uri+ and separate out any
+    # additional options appended in the +uri+.
+    #
+    # Returns an option-less uri and the option => [uri,option]
+    #
+    # The +config+ is completely unused, so passing nil is sufficient.
+    def self.uri_option(uri, config) # :nodoc:
+      host, port, option = parse_uri(uri)
+      return "drbssl://#{host}:#{port}", option
+    end
+
+    # Create a DRb::DRbSSLSocket instance.
+    #
+    # +uri+ is the URI we are connected to.
+    # +soc+ is the tcp socket we are bound to.
+    # +config+ is our configuration. Either a Hash or SSLConfig
+    # +is_established+ is a boolean of whether +soc+ is currently established
+    #
+    # This is called automatically based on the DRb protocol.
+    def initialize(uri, soc, config, is_established)
+      @ssl = is_established ? soc : nil
+      super(uri, soc.to_io, config)
+    end
+
+    # Returns the SSL stream
+    def stream; @ssl; end # :nodoc:
+
+    # Closes the SSL stream before closing the dRuby connection.
+    def close # :nodoc:
+      if @ssl
+        @ssl.close
+        @ssl = nil
+      end
+      super
+    end
+
+    def accept # :nodoc:
+      begin
+      while true
+        soc = accept_or_shutdown
+        return nil unless soc
+        break if (@acl ? @acl.allow_socket?(soc) : true)
+        soc.close
+      end
+      begin
+        ssl = @config.accept(soc)
+      rescue Exception
+        soc.close
+        raise
+      end
+      self.class.new(uri, ssl, @config, true)
+      rescue OpenSSL::SSL::SSLError
+        warn("#{$!.message} (#{$!.class})", uplevel: 0) if @config[:verbose]
+        retry
+      end
+    end
+  end
+
+  DRbProtocol.add_protocol(DRbSSLSocket)
+end