ciri 0.0.0

data/lib/ciri/devp2p/rlpx/message.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'ciri/rlp/serializable'
+
+module Ciri
+  module DevP2P
+    module RLPX
+
+      # RLPX message
+      class Message
+        include Ciri::RLP::Serializable
+
+        schema [
+                 {code: Integer},
+                 {size: Integer},
+                 :payload,
+                 :received_at
+               ]
+        default_data(received_at: nil)
+      end
+
+    end
+  end
+end

data/lib/ciri/devp2p/rlpx/node.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'ciri/key'
+
+module Ciri
+  module DevP2P
+    module RLPX
+
+      # present node id
+      class NodeID
+
+        class << self
+          def from_raw_id(raw_id)
+            NodeID.new(Ciri::Key.new(raw_public_key: "\x04".b + raw_id))
+          end
+        end
+
+        attr_reader :public_key
+
+        alias key public_key
+
+        def initialize(public_key)
+          unless public_key.is_a?(Ciri::Key)
+            raise TypeError.new("expect Ciri::Key but get #{public_key.class}")
+          end
+          @public_key = public_key
+        end
+
+        def id
+          @id ||= key.raw_public_key[1..-1]
+        end
+
+        def == (other)
+          self.class == other.class && id == other.id
+        end
+      end
+
+      class Node
+        attr_reader :node_id, :ip, :udp_port, :tcp_port, :added_at
+
+        def initialize(node_id:, ip:, udp_port:, tcp_port:, added_at: nil)
+          @node_id = node_id
+          @ip = ip
+          @udp_port = udp_port
+          @tcp_port = tcp_port
+          @added_at = added_at
+        end
+
+        def == (other)
+          self.class == other.class && node_id == other.node_id
+        end
+      end
+
+    end
+  end
+end

data/lib/ciri/devp2p/rlpx/protocol_handshake.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'ciri/rlp/serializable'
+
+module Ciri
+  module DevP2P
+    module RLPX
+
+      class Cap
+        include Ciri::RLP::Serializable
+
+        schema [
+                 :name,
+                 {version: Integer}
+               ]
+      end
+
+      # handle protocol handshake
+      class ProtocolHandshake
+        include Ciri::RLP::Serializable
+
+        schema [
+                 {version: Integer},
+                 :name,
+                 {caps: [Cap]},
+                 {listen_port: Integer},
+                 :id
+               ]
+        default_data(listen_port: 0)
+      end
+
+    end
+  end
+end

data/lib/ciri/devp2p/rlpx/protocol_messages.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'ciri/key'
+require 'ciri/rlp/serializable'
+
+module Ciri
+  module DevP2P
+    module RLPX
+      MESSAGES = {
+        handshake: 0x00,
+        discover: 0x01,
+        ping: 0x02,
+        pong: 0x03
+      }.freeze
+
+      BASE_PROTOCOL_VERSION = 5
+      BASE_PROTOCOL_LENGTH = 16
+      BASE_PROTOCOL_MAX_MSG_SIZE = 2 * 1024
+      SNAPPY_PROTOCOL_VERSION = 5
+
+      ### messages
+
+      class AuthMsgV4
+        include Ciri::RLP::Serializable
+
+        schema [
+                 :signature,
+                 :initiator_pubkey,
+                 :nonce,
+                 {version: Integer}
+               ]
+
+        # keep this field let client known how to format(plain or eip8)
+        attr_accessor :got_plain
+      end
+
+      class AuthRespV4
+        include Ciri::RLP::Serializable
+
+        schema [
+                 :random_pubkey,
+                 :nonce,
+                 {version: Integer}
+               ]
+      end
+    end
+  end
+end

data/lib/ciri/devp2p/rlpx/secrets.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+module Ciri
+  module DevP2P
+    module RLPX
+
+      # class used to store rplx protocol secrets
+      class Secrets
+        attr_reader :remote_id, :aes, :mac
+        attr_accessor :egress_mac, :ingress_mac
+
+        def initialize(remote_id: nil, aes:, mac:)
+          @remote_id = remote_id
+          @aes = aes
+          @mac = mac
+        end
+
+        def ==(other)
+          self.class == other.class &&
+            remote_id == other.remote &&
+            aes == other.aes &&
+            mac == other.mac
+        end
+      end
+
+    end
+  end
+end

data/lib/ciri/devp2p/server.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'concurrent'
+require 'forwardable'
+require_relative 'rlpx/connection'
+require_relative 'rlpx/protocol_handshake'
+require_relative 'peer'
+require_relative 'actor'
+
+module Ciri
+  module DevP2P
+
+    # DevP2P Server
+    # maintain connection, node discovery, rlpx handshake and protocols
+    class Server
+      include RLPX
+
+      MAX_ACTIVE_DIAL_TASKS = 16
+      DEFAULT_MAX_PENDING_PEERS = 50
+      DEFAULT_DIAL_RATIO = 3
+
+      class Error < StandardError
+      end
+      class UselessPeerError < Error
+      end
+
+      attr_reader :handshake, :dial, :scheduler, :protocol_manage, :protocols
+      attr_accessor :logger, :bootstrap_nodes
+
+      def initialize(private_key:, protocol_manage:, executor:)
+        @private_key = private_key
+        @name = 'ciri'
+        @scheduler = Scheduler.new(self, executor: executor)
+        @protocol_manage = protocol_manage
+        @protocols = protocol_manage.protocols
+      end
+
+      def start
+        #TODO start dialer, discovery nodes and connect to them
+        #TODO listen udp, for discovery protocol
+
+        server_node_id = NodeID.new(@private_key)
+        caps = [Cap.new(name: 'eth', version: 63)]
+        @handshake = ProtocolHandshake.new(version: BASE_PROTOCOL_VERSION, name: @name, id: server_node_id.id, caps: caps)
+        # start listen tcp
+        @dial = Dial.new(self)
+        @protocol_manage.executor ||= @scheduler.executor
+        @protocol_manage.start
+        @scheduler.start
+      end
+
+      def setup_connection(node)
+        socket = TCPSocket.new(node.ip, node.tcp_port)
+        c = Connection.new(socket)
+        c.encryption_handshake!(private_key: @private_key, node_id: node.node_id)
+        remote_handshake = c.protocol_handshake!(handshake)
+        scheduler << [:add_peer, c, remote_handshake]
+      end
+
+      def protocol_handshake_checks(handshake)
+        if !protocols.empty? && count_matching_protocols(protocols, handshake.caps) == 0
+          raise UselessPeerError.new('discovery useless peer')
+        end
+      end
+
+      def count_matching_protocols(protocols, caps)
+        #TODO implement this
+        1
+      end
+
+      # scheduler task
+      class Task
+        attr_reader :name
+
+        def initialize(name:, &blk)
+          @name = name
+          @blk = blk
+        end
+
+        def call(*args)
+          @blk.call(*args)
+        end
+      end
+
+      # Discovery and dial new nodes
+      class Dial
+        def initialize(server)
+          @server = server
+          @cache = []
+        end
+
+        # return new tasks to find peers
+        def find_peer_tasks(running_count, peers, now)
+          node = @server.bootstrap_nodes[0]
+          return [] if @cache.include?(node)
+          @cache << node
+          [Task.new(name: 'find peer') {
+            @server.setup_connection(node)
+          }]
+        end
+      end
+
+      class Scheduler
+        include Actor
+
+        extend Forwardable
+
+        attr_reader :server
+        def_delegators :server, :logger
+
+        def initialize(server, executor:)
+          @server = server
+          @queued_tasks = []
+          @running_tasks = []
+          @peers = {}
+          # init actor
+          super(executor: executor)
+        end
+
+        # called by actor loop
+        def loop_callback
+          schedule_tasks
+          yield(wait_message: false)
+        end
+
+        def start_tasks(tasks)
+          tasks = tasks.dup
+          while @running_tasks.size < MAX_ACTIVE_DIAL_TASKS
+            break unless (task = tasks.pop)
+            executor.post(task) do |task|
+              task.call
+              self << [:task_done, task]
+            end
+            @running_tasks << task
+          end
+          tasks
+        end
+
+        # invoke tasks, and prepare search peer tasks
+        def schedule_tasks
+          @queued_tasks = start_tasks(@queued_tasks)
+          if @queued_tasks.size < MAX_ACTIVE_DIAL_TASKS
+            tasks = server.dial.find_peer_tasks(@running_tasks.size + @queued_tasks.size, @peers, Time.now)
+            @queued_tasks += tasks
+          end
+        end
+
+        private
+        def add_peer(connection, handshake)
+          server.protocol_handshake_checks(handshake)
+          peer = Peer.new(connection, handshake, server.protocols)
+          # set actor executor
+          peer.executor = executor
+          @peers[peer.node_id] = peer
+          # run peer logic
+          # do sub protocol handshake...
+          executor.post {
+            peer.start
+
+            exit_error = nil
+            begin
+              peer.wait
+            rescue StandardError => e
+              exit_error = e
+            end
+            # remove peer
+            self << [:remove_peer, peer, exit_error]
+          }
+          logger.debug("add peer: #{peer}")
+        end
+
+        def remove_peer(peer, *args)
+          error, * = args
+          logger.debug("remove peer: #{peer}, error: #{error}")
+        end
+
+        def task_done(task, *args)
+          logger.debug("task done: #{task.name}")
+        end
+
+      end
+
+    end
+  end
+end