sping 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74faa9103509651e47d2f098c22b66fae80ca1ba0b71b132aa636d26bf1e0f04
-  data.tar.gz: 9ae6b44c52ded9e1999eb3fe467216b6d640747d11a8b69f4eed864efeb30a03
+  metadata.gz: 9f7679b3fb31d07d034182114e576f3e272ef8223954f592bb30a98378b98fd5
+  data.tar.gz: b8d21d6a58ffb3c57481cc421d61f8fc25da32646fb8d5ae160829017d01fb14
 SHA512:
-  metadata.gz: c08fcd7358309abe6a7f67044bbf267f31cba483786dc387b78ef14e8ce32801b067bd2ca8e2a545e141d3ffe843d004a4427d1a91cba1cbdd8d154679344653
-  data.tar.gz: 56ea68be301c25d116657775aabf26a9fb9fdf41cf2224ff9dcd72be1b897f20b076e9d0f4a1154ec777c53f20eeff173ded69985c993c99169198290f66a092
+  metadata.gz: a6a2c6897ead8f7371b2f1a83719c1a8f2c07d44957a9c302bc548855d25671858435fe0d6e8162e14737e065f6bbcede37defd2ea21e23561d19e7f8d5ef63f
+  data.tar.gz: 2618e70abea52acc38364f7fb431dafa12a4d48ad8f07665f93ac76e316784e6a2f8f5d2b463a55053da88b10f46dc23adf16846abb1a4b1d4677eb9eef09e7f

data/lib/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# sharable_constant_value: literal
+
+module SPing
+  class SPingError < StandardError; end
+
+  class SessionManagerError < SPingError; end
+  class OutOfSessions < SessionManagerError; end
+
+  class SessionError < SPingError; end
+  class TCPHandshakeError < SessionError; end
+
+  class PeerError < SPingError; end
+  class InvalidPacketError < PeerError; end
+  class InvalidMessageError < InvalidPacketError; end
+  class UnknownPacketError < InvalidPacketError; end
+  class SignalizedError < PeerError; end
+  class UnknownVersionError < PeerError; end
+  class UnknownSessionError < PeerError; end
+end

data/lib/last_acks.rb

@@ -1,34 +1,36 @@
 # frozen_string_literal: true
 # sharable_constant_value: literal
 
-class LastAcks
-  attr_reader :size
+module SPing
+  class LastAcks
+    attr_reader :size
 
-  def initialize(size = 32)
-    @size = size
-    @acks = []
-    @acks_mutex = Mutex.new
+    def initialize(size = 32)
+      @size = size
+      @acks = []
+      @acks_mutex = Mutex.new
 
-    @size.times do |index|
-      @acks[index] = {
-        'R' => 0,
-        'U' => Time.at(0),
-        'X' => Time.at(0)
-      }
+      @size.times do |index|
+        @acks[index] = {
+          'R' => 0,
+          'U' => Time.at(0),
+          'X' => Time.at(0)
+        }
+      end
     end
-  end
 
-  def acks
-    @acks_mutex.synchronize do
-      return @acks.dup
+    def acks
+      @acks_mutex.synchronize do
+        return @acks.dup
+      end
     end
-  end
 
-  def add_ack(ack)
-    @acks_mutex.synchronize do
-      @acks << ack
+    def add_ack(ack)
+      @acks_mutex.synchronize do
+        @acks << ack
 
-      @acks.shift if @acks.length > @size
+        @acks.shift if @acks.length > @size
+      end
     end
   end
 end

data/lib/session.rb

@@ -2,8 +2,7 @@
 # sharable_constant_value: literal
 
 module SPing
-  class SessionError < StandardError; end
-  class TCPHandshakeError < SessionError; end
+  require_relative 'errors'
 
   class Session
     attr_reader :created, :last_rx, :madebyme
@@ -24,7 +23,7 @@ module SPing
       @tcp_handshake_complete = false
       @udp_handshake_complete = false
 
-      @last_acks = LastAcks.new
+      @last_acks = SPing::LastAcks.new
     end
 
     def do_tcp_handshake1(socket, session_id)
@@ -157,15 +156,34 @@ module SPing
     end
 
     def handle_ping(packet, rxtime, peeraddr)
-      if packet['E'] != 0
-        $logger.error "Package displays an error message: #{packet['E']} Processing aborted."
-        return
+      if !(packet.keys - %w[M Y E I T A S]).empty? ||
+         # M, Y are already checked in handle_packet from session manager
+         !packet['E'].is_a?(Integer) ||
+         !packet['I'].is_a?(Integer) ||
+         !packet['T'].is_a?(Time) ||
+         !packet['A'].is_a?(Array)
+        raise InvalidPacketError, 'The peer has sent an invalid message. The ping packet is incorrectly coded.'
       end
 
+      raise SignalizedError, "Package displays an error message: #{packet['E']} Processing aborted." if packet['E'] != 0
+
       id = packet['I']
       txtime = packet['T']
       remote_last_acks = packet['A']
 
+      if remote_last_acks.length != 32
+        raise InvalidMessageError, 'The peer has sent an invalid message. It does not contain any 32-Acks.'
+      end
+
+      remote_last_acks.each do |block_ack|
+        if !(block_ack.keys - %w[R U X]).empty? ||
+           !block_ack['R'].is_a?(Integer) ||
+           !block_ack['U'].is_a?(Time) ||
+           !block_ack['X'].is_a?(Time)
+          raise InvalidMessageError, 'The peer has sent an invalid message. An Ack is formatted invalid.'
+        end
+      end
+
       ack = {
         'R' => id,
         'U' => txtime,

data/lib/session_manager.rb

@@ -2,8 +2,7 @@
 # sharable_constant_value: literal
 
 module SPing
-  class SessionManagerError < StandardError; end
-  class OutOfSessions < SessionManagerError; end
+  require_relative 'errors'
 
   class SessionManager
     require 'socket'
@@ -187,12 +186,20 @@ module SPing
       peerport = buf[1][1]
       $logger.debug "Packet received from #{peeraddr} port #{peerport}."
 
-      packet = MessagePack.unpack(buf[0])
+      packet = MessagePack.unpack(buf[0]).to_h
+
+      if !packet.key?('M') ||
+         !packet.key?('Y') ||
+         !packet.key?('S') ||
+         !packet['M'].is_a?(Integer) ||
+         !packet['Y'].is_a?(Integer) ||
+         !packet['S'].is_a?(Integer)
+        raise InvalidMessageError, 'The peer has sent an invalid message. The packet is incorrectly coded.'
+      end
 
       # Check whether the Magic Number is the correct one.
       if packet['M'] != 11_181
-        $logger.warn 'Package contains incorrect magic number. Processing is canceled.'
-        return
+        raise UnknownPacketError, 'Package contains incorrect magic number. Processing is canceled.'
       end
 
       type = packet['Y'].chr
@@ -202,52 +209,55 @@ module SPing
       when 't'
         handle_ping packet, rxtime, peeraddr, peerport
       else
-        $logger.warn "Package is of unknown type: #{type}"
+        raise UnknownPacketError, "Package is of unknown type: #{type}"
       end
+    rescue MessagePack::MalformedFormatError => e
+      $logger.error "Packet cannot be decoded: #{e.message}"
+    rescue PeerError => e
+      $logger.error "Perr error: #{e.message}"
     end
 
     def handle_udp_handshake(packet, peeraddr, peerport)
+      if !(packet.keys - %w[M Y V S]).empty? ||
+         # M, Y are already checked in handle_packet from session manager
+         !packet['V'].is_a?(Integer)
+        raise InvalidMessageError, 'The peer has sent an invalid message. The handshake packet is incorrectly coded.'
+      end
+
       session_id = packet['S']
       session = @sessions[session_id]
-      if session
-        if packet['V'] != 3
-          $logger.warn "UDP handshake uses an unsupported version: #{packet['V']}"
-          return
-        end
-
-        session.set_endpoint peeraddr, peerport
-
-        unless session.madebyme
-          # If the session was not started by me, the other peer expects a
-          # confirmation of the handshake in which the same is sent back.
-          $logger.debug "Send UDP Handshake back for session id #{session_id}."
-          session.send_udp_handshake
-        end
+      raise UnknownSessionError, 'UDP handshake received for uninitiated session.' unless session
+      raise UnknownVersionError, "UDP handshake uses an unsupported version: #{packet['V']}" if packet['V'] != 3
 
-        if session.udp_handshake_complete
-          $logger.warn 'UDP handshake is received, although a previous one was already successful.'
-          return
-        end
+      session.set_endpoint peeraddr, peerport
 
-        session.udp_handshake_recived
-        $logger.info "UDP handshake for session ID #{session_id} was successful."
+      unless session.madebyme
+        # If the session was not started by me, the other peer expects a
+        # confirmation of the handshake in which the same is sent back.
+        $logger.debug "Send UDP Handshake back for session id #{session_id}."
+        session.send_udp_handshake
+      end
 
-        session.start_pinger
-      else
-        $logger.warn 'UDP handshake received for uninitiated session.'
+      if session.udp_handshake_complete
+        $logger.warn 'UDP handshake is received, although a previous one was already successful.'
         return
       end
+
+      session.udp_handshake_recived
+      $logger.info "UDP handshake for session ID #{session_id} was successful."
+
+      session.start_pinger
     end
 
     def handle_ping(packet, rxtime, peeraddr, peerport)
       session_id = packet['S']
       session = @sessions[session_id]
-      if session&.tcp_handshake_complete && session&.udp_handshake_complete
-        session.set_endpoint peeraddr, peerport
-        session.handle_ping packet, rxtime, peeraddr
-      else
-        $logger.warn "Ping packet received for non-initiated session id #{session_id}."
+      unless session&.tcp_handshake_complete && session&.udp_handshake_complete
+        raise UnknownSessionError, "Ping packet received for non-initiated session id #{session_id}."
       end
+
+      session.set_endpoint peeraddr, peerport
+      session.handle_ping packet, rxtime, peeraddr
     end
 
     def handle_client(client)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sping
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Marek Küthe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2023-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -43,6 +43,7 @@ files:
 - LICENSE
 - README.md
 - bin/sping
+- lib/errors.rb
 - lib/last_acks.rb
 - lib/session.rb
 - lib/session_manager.rb
@@ -68,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Reimplementation of sping in Ruby.