ciri-p2p 0.1.0

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.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 P2P
+    module RLPX
+
+      class Cap
+        include Ciri::RLP::Serializable
+
+        schema(
+            name: RLP::Bytes,
+            version: Integer
+        )
+      end
+
+      # handle protocol handshake
+      class ProtocolHandshake
+        include Ciri::RLP::Serializable
+
+        schema(
+            version: Integer,
+            name: RLP::Bytes,
+            caps: [Cap],
+            listen_port: Integer,
+            id: RLP::Bytes
+        )
+        default_data(listen_port: 0)
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.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 P2P
+    module RLPX
+      # RLPX protocol code
+      module Code
+        HANDSHAKE = 0x00
+        DISCONNECT = 0x01
+        PING = 0x02
+        PONG = 0x03
+      end
+
+      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: RLP::Bytes,
+            initiator_pubkey: RLP::Bytes,
+            nonce: RLP::Bytes,
+            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: RLP::Bytes,
+            nonce: RLP::Bytes,
+            version: Integer
+        )
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.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 P2P
+    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/p2p/server.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.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 'async'
+require 'async/io'
+require 'async/io/tcp_socket'
+require 'forwardable'
+require 'ciri/utils/logger'
+require_relative 'rlpx/connection'
+require_relative 'rlpx/protocol_handshake'
+require_relative 'errors'
+require_relative 'peer'
+require_relative 'network_state'
+require_relative 'dialer'
+require_relative 'discovery/service'
+require_relative 'dial_scheduler'
+
+module Ciri
+  module P2P
+
+    # P2P Server
+    # maintain connection, node discovery, rlpx handshake
+    class Server
+      include Utils::Logger
+      include RLPX
+      extend Forwardable
+
+      DEFAULT_MAX_PENDING_PEERS = 50
+      DEFAULT_DIAL_RATIO = 3
+
+      attr_reader :handshake, :dial_scheduler, :dialer, :local_address, :tcp_port
+      
+      def_delegators :@network_state, :disconnect_all
+
+      def initialize(private_key:, protocols:, bootnodes: [],
+                     node_name: 'Ciri', host: '127.0.0.1',
+                     tcp_port: 33033, udp_port: 33033,
+                     max_outgoing: 10, max_incoming:10,
+                     ping_interval_secs: 15,
+                     discovery_interval_secs: 15,
+                     dial_outgoing_interval_secs: 25)
+        @private_key = private_key
+        @node_name = node_name
+        # prepare handshake information
+        @local_node_id = NodeID.new(@private_key)
+        caps = protocols.map do |protocol|
+          Cap.new(name: protocol.name, version: protocol.version)
+        end
+        @handshake = ProtocolHandshake.new(version: BASE_PROTOCOL_VERSION, name: @node_name, id: @local_node_id.id, caps: caps)
+        @host = host
+        @tcp_port = tcp_port
+        @udp_port = udp_port
+        @dialer = Dialer.new(private_key: private_key, handshake: @handshake)
+        @peer_store = PeerStore.new
+        @network_state = NetworkState.new(
+          protocols: protocols,
+          peer_store: @peer_store,
+          local_node_id: @local_node_id,
+          max_incoming: max_incoming,
+          max_outgoing: max_outgoing,
+          ping_interval_secs: ping_interval_secs)
+        @bootnodes = bootnodes
+        @discovery_interval_secs = discovery_interval_secs
+        @dial_outgoing_interval_secs = dial_outgoing_interval_secs
+      end
+
+      def udp_port
+        @discovery_service&.udp_port || @udp_port
+      end
+
+      def to_node
+        address = Address.new(ip: @host, tcp_port: tcp_port, udp_port: udp_port)
+        Node.new(node_id: @local_node_id, addresses: [address])
+      end
+
+      # return reactor to wait
+      def run
+        # setup bootnodes
+        @bootnodes.each do |node|
+          @peer_store.add_bootnode(node)
+        end
+
+        # start server and services
+        Async::Reactor.run do |task|
+          # initialize protocols
+          @network_state.initialize_protocols
+          # wait sub tasks
+          task.async do
+            task.async do
+              # Wait for server started listen
+              # we use listened port to start DiscoveryService to allow 0 port
+              task.sleep(0.5) until @local_address
+
+              # start discovery service
+              @discovery_service = Discovery::Service.new(
+                peer_store: @peer_store,
+                private_key: @private_key,
+                host: @host, udp_port: @udp_port, tcp_port: @tcp_port,
+                discovery_interval_secs: @discovery_interval_secs)
+              task.async { @discovery_service.run }
+
+              # start dial outgoing nodes
+              @dial_scheduler = DialScheduler.new(
+                @network_state,
+                @dialer,
+                dial_outgoing_interval_secs: @dial_outgoing_interval_secs)
+              task.async {@dial_scheduler.run}
+            end
+            task.async {start_listen}
+          end.wait
+        end
+      end
+
+      # start listen and accept clients
+      def start_listen(task: Async::Task.current)
+        endpoint = Async::IO::Endpoint.tcp(@host, @tcp_port)
+        endpoint.bind do |socket|
+          @local_address = socket.local_address
+          info("start accept connections -- listen on #{@local_address.getnameinfo.join(":")}")
+          # update tcp_port if it is 0
+          if @tcp_port.zero?
+            @tcp_port = @local_address.ip_port
+          end
+          socket.listen(Socket::SOMAXCONN)
+          loop do
+            client, addrinfo = socket.accept
+            c = Connection.new(client)
+            c.encryption_handshake!(private_key: @private_key)
+            remote_handshake = c.protocol_handshake!(handshake)
+            @network_state.new_peer_connected(c, remote_handshake, way_for_connection: Peer::INCOMING)
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/ciri/p2p/version.rb

@@ -0,0 +1,5 @@
+module Ciri
+  module P2p
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: ciri-p2p
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jjy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ciri-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: ciri-rlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: ciri-crypto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: ciri-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.3
+- !ruby/object:Gem::Dependency
+  name: async-io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.5
+- !ruby/object:Gem::Dependency
+  name: snappy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ciri-p2p is a DevP2P implementation, we also seek to implement LibP2P
+  components upon ciri-p2p codebase in the future.
+email:
+- jjyruby@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".vscode/launch.json"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bundle
+- bin/console
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/rspec
+- bin/setup
+- ciri-p2p.gemspec
+- lib/ciri/p2p.rb
+- lib/ciri/p2p/address.rb
+- lib/ciri/p2p/dial_scheduler.rb
+- lib/ciri/p2p/dialer.rb
+- lib/ciri/p2p/discovery/protocol.rb
+- lib/ciri/p2p/discovery/service.rb
+- lib/ciri/p2p/errors.rb
+- lib/ciri/p2p/kad.rb
+- lib/ciri/p2p/network_state.rb
+- lib/ciri/p2p/node.rb
+- lib/ciri/p2p/peer.rb
+- lib/ciri/p2p/peer_store.rb
+- lib/ciri/p2p/protocol.rb
+- lib/ciri/p2p/protocol_context.rb
+- lib/ciri/p2p/protocol_io.rb
+- lib/ciri/p2p/rlpx.rb
+- lib/ciri/p2p/rlpx/connection.rb
+- lib/ciri/p2p/rlpx/encryption_handshake.rb
+- lib/ciri/p2p/rlpx/errors.rb
+- lib/ciri/p2p/rlpx/frame_io.rb
+- lib/ciri/p2p/rlpx/message.rb
+- lib/ciri/p2p/rlpx/protocol_handshake.rb
+- lib/ciri/p2p/rlpx/protocol_messages.rb
+- lib/ciri/p2p/rlpx/secrets.rb
+- lib/ciri/p2p/server.rb
+- lib/ciri/p2p/version.rb
+homepage: https://github.com/ciri-ethereum/ciri-p2p
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: P2P network implementation for Ciri Ethereum.
+test_files: []