simple_ping 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88ca1bd08781db9e2ba867c8599767be9163b272b0045adb5fd612a2f79d4ab9
-  data.tar.gz: db299c8b1bedca36d463a483c37ddc5799411461910296e940f520938d0a9e1d
+  metadata.gz: c99b16f604de38384de5e722a9493406a59ccf56891d68a6abc99e91b42673c9
+  data.tar.gz: b06fd1a5ffaeaec507a8236ff475e78def4af9c5e6ad32e17831bfcac8af58eb
 SHA512:
-  metadata.gz: 2433fe0679a8de4a99d90ecda60446590f4eb0dacb590f91efba668ea1e1631da652bd99d47a8abf39508406a770c7b680d87cd90874b53da4c21393e78ee2c0
-  data.tar.gz: 06dd89c9f9026672e3439e0d59e66304714aa3ada3803681a6ed7c279885faa2fff13492e79f41f454d6996c91b040b455c707563bf1cb3a88e55aa24c6e8d5c
+  metadata.gz: 73fec53bfc6bc75af1a583726413ec13f9d135f9d7e7e43f9ea9c5987bbf8e39a1a0f266d2d89f1326f5a8bf46dec9c361aa56fc66431b212a75b424f6c62043
+  data.tar.gz: ec5f43516e4ce018ca5e5228ed56380ffbe120e636f789ddbe39146a05095062676d660a5632e5c2653f0ffd7fd4415a07beca0b71aa0abc7a878e3c58152330

data/.gitignore

@@ -13,3 +13,7 @@
 test2.rb
 test.rb
 Gemfile.lock
+simple_ping.code-workspace
+sample_run.rb
+Steepfile
+.gitignore

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/README.md

@@ -1,10 +1,13 @@
 # Overview
-A Simpe Ping Client for Ruby.
+A Simpe Ping(ICMP) Client for Ruby.
+https://rubygems.org/gems/simple_ping
 
 # How to use
 ※ Need root privileges to run.
 
-```
+```ruby
+require "simple_ping"
+
 ping_client = SimplePing::Client.new(src_ip_addr: "192.168.1.100")
 ping_client.exec(dest_ip_addr: "192.168.1.101")
 ```
@@ -16,5 +19,18 @@ ping_client.exec(dest_ip_addr: "192.168.1.101")
 - Does not support retries
 - Confirmed the operation with Ruby 2.7.1
 
+
+# What you can do
+
+- Return the success or failure of the ping (ICMP) result with true/false
+- Destination is IP address
+
+# What you can not do now
+
+- Addressing by FQDN
+- Retry
+- Customized transmission data (ID specification, data section specification, etc.)
+- Etc., etc
+
 # License
 MIT

data/lib/simple_ping/client.rb

@@ -40,19 +40,17 @@ class SimplePing::Client
     # Receive
     begin
       Timeout.timeout(TIMEOUT_TIME) do
-        loop do
-          mesg, _ = socket.recvfrom(1500)
-          icmp_reply = SimplePing::RecvMessage.new(mesg).to_icmp
+        mesg, _ = socket.recvfrom(1500)
+        icmp_reply = SimplePing::RecvMessage.new(mesg).to_icmp
 
-          if icmp.successful_reply?(icmp_reply)
-            return true
-          elsif icmp_reply.is_type_destination_unreachable?
-            logger.warn { "Destination Unreachable!!" }
-            return false
-          elsif icmp_reply.is_type_redirect?
-            logger.warn { "Redirect Required!!" }
-            return false
-          end
+        if icmp.successful_reply?(icmp_reply)
+          true
+        elsif icmp_reply.is_type_destination_unreachable?
+          logger.warn { "Destination Unreachable!!" }
+          false
+        elsif icmp_reply.is_type_redirect?
+          logger.warn { "Redirect Required!!" }
+          false
         end
       end
     rescue Timeout::Error => e

data/lib/simple_ping/icmp.rb

@@ -64,7 +64,7 @@ class SimplePing::ICMP
       @seq_number.to_s(2).rjust(16, "0")
 
     data_byte_arr = bynary_data.scan(/.{1,8}/)
-    data_byte_arr.map! { |byte| byte.to_i(2).chr }
+    data_byte_arr.map! { |byte| byte.to_i(2).chr } # TO ASCII
     data_byte_arr.join + @data
   end
 

data/lib/simple_ping/version.rb

@@ -1,3 +1,3 @@
 module SimplePing
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/sig/simple_ping.rbs

@@ -0,0 +1,94 @@
+module SimplePing
+end
+
+class SimplePing::Client
+  public
+
+  def exec: (dest_ip_addr: untyped, ?data: untyped) -> untyped
+
+  private
+
+  def initialize: (src_ip_addr: String, ?log_level: Integer) -> void
+
+  def logger: () -> untyped
+
+  def socket: () -> untyped
+end
+
+SimplePing::Client::TIMEOUT_TIME: Integer
+
+class SimplePing::ICMP
+  public
+
+  def data: () -> untyped
+
+  def data=: (untyped) -> untyped
+
+  def id: () -> untyped
+
+  def id=: (untyped) -> untyped
+
+  def is_type_destination_unreachable?: () -> untyped
+
+  def is_type_echo?: () -> untyped
+
+  def is_type_echo_reply?: () -> untyped
+
+  def is_type_redirect?: () -> untyped
+
+  def seq_number: () -> untyped
+
+  def seq_number=: (untyped) -> untyped
+
+  def successful_reply?: (untyped icmp) -> untyped
+
+  def to_trans_data: () -> untyped
+
+  def type: () -> untyped
+
+  def type=: (untyped) -> untyped
+
+  private
+
+  def carry_up: (untyped num) -> untyped
+
+  def checksum: () -> untyped
+
+  def gen_data: () -> untyped
+
+  def gen_id: () -> untyped
+
+  def gen_seq_number: () -> untyped
+
+  def initialize: (type: untyped, ?code: untyped, ?id: untyped, ?seq_number: untyped, ?data: untyped) -> untyped
+end
+
+SimplePing::ICMP::TYPE_ICMP_DESTINATION_UNREACHABLE: Integer
+
+SimplePing::ICMP::TYPE_ICMP_ECHO_REPLY: Integer
+
+SimplePing::ICMP::TYPE_ICMP_ECHO_REQUEST: Integer
+
+SimplePing::ICMP::TYPE_ICMP_REDIRECT: Integer
+
+class SimplePing::RecvMessage
+  public
+
+  def code: () -> untyped
+
+  def data: () -> untyped
+
+  def id: () -> untyped
+
+  def seq_number: () -> untyped
+
+  def to_icmp: () -> untyped
+
+  def type: () -> untyped
+
+  private
+
+  def initialize: (untyped mesg) -> untyped
+end
+
+SimplePing::VERSION: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_ping
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Akira Kure
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -69,14 +70,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- client.rb
-- icmp.rb
 - lib/simple_ping.rb
 - lib/simple_ping/client.rb
 - lib/simple_ping/icmp.rb
 - lib/simple_ping/recv_message.rb
 - lib/simple_ping/version.rb
-- recv_message.rb
+- sig/simple_ping.rbs
 - simple_ping.gemspec
 homepage: https://github.com/kuredev/simple_ping
 licenses:
@@ -84,7 +83,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/kuredev/simple_ping
   source_code_uri: https://github.com/kuredev/simple_ping
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,8 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Simpe Ping Client for Ruby.
 test_files: []

data/client.rb

@@ -1,91 +0,0 @@
-require "logger"
-require "socket"
-require "timeout"
-require_relative "recv_message"
-require_relative "icmp"
-
-# Simple Ping (ICMP) client
-# Root privilege required to run
-# ex)
-#   require_relative "./simple_ping/client"
-#
-#   client = SimplePing::Client.new(src_ip_addr: "192.168.1.100")
-#   client.exec(dest_ip_addr: "192.168.1.101") # => true or false
-module SimplePing
-  class Client
-    # Wait time for ICMP Reply
-    TIMEOUT_TIME = 10
-
-    # constructor
-    #
-    # @param src_ip_addr [String] IP address of the interface to send ping,  ex: "192.168.1.100"
-    def initialize(src_ip_addr:, log_level: Logger::INFO)
-      @src_ip_addr = src_ip_addr
-      @log_level = log_level
-    end
-
-    # Execute ping(ICMP).
-    # Basically, it returns Boolean depending on the result.
-    # Exception may be thrown due to unexpected error etc.
-    #
-    # @param dest_ip_addr [String] IP address of destination to send ping, ex: "192.168.1.101"
-    # @param data         [String] ICMP Datagram, ex: "abc"
-    # @return             [Boolean]
-    def exec(dest_ip_addr:, data: nil)
-      # Transmission
-      icmp = ICMP.new(type: ICMP::TYPE_ICMP_ECHO_REQUEST, data: data)
-      sockaddr = Socket.sockaddr_in(nil, dest_ip_addr)
-      trans_data = icmp.to_trans_data
-      socket.send(trans_data, 0, sockaddr)
-
-      # Receive
-      begin
-        Timeout.timeout(TIMEOUT_TIME) do
-          loop do
-            mesg, _ = socket.recvfrom(1500)
-            icmp_reply = RecvMessage.new(mesg).to_icmp
-
-            if icmp.successful_reply?(icmp_reply)
-              return true
-            elsif icmp_reply.is_type_destination_unreachable?
-              logger.warn { "Destination Unreachable!!" }
-              return false
-            elsif icmp_reply.is_type_redirect?
-              logger.warn { "Redirect Required!!" }
-              return false
-            end
-          end
-        end
-      rescue Timeout::Error => e
-        logger.warn { "Timeout Occurred! #{e}" }
-        false
-      end
-    end
-
-    private
-
-    # @return [Logger]
-    def logger
-      @logger ||= begin
-        logger = Logger.new(STDOUT)
-        logger.level = @log_level
-        logger
-      end
-    end
-
-    # Socket instance
-    #
-    # @return [Socket]
-    def socket
-      @socket ||= begin
-        socket = Socket.open(
-          Socket::AF_INET,      # IPv4
-          Socket::SOCK_RAW,     # RAW Socket
-          Socket::IPPROTO_ICMP  # ICMP
-        )
-        socket.bind(Socket.sockaddr_in(nil, @src_ip_addr))
-        socket
-      end
-    end
-  end
-end

data/icmp.rb

@@ -1,132 +0,0 @@
-module SimplePing
-  class ICMP
-    attr_accessor :id, :seq_number, :data, :type
-
-    # ICMP TYPES
-    TYPE_ICMP_ECHO_REPLY = 0x00
-    TYPE_ICMP_DESTINATION_UNREACHABLE = 0x03
-    TYPE_ICMP_REDIRECT = 0x05
-    TYPE_ICMP_ECHO_REQUEST = 0x08
-
-    # constructor
-    #
-    # @param code       [Integer] 0x01
-    # @param type       [Integer] 0x01
-    # @param id         [Integer] 0x01
-    # @param seq_number [Integer] 0x01
-    # @param data        [String] 0x01
-    def initialize(type:, code: 0, id: nil, seq_number: nil, data: nil)
-      @type = type
-      @code = code
-      @id = id || gen_id
-      @seq_number = seq_number || gen_seq_number
-      @data = data || gen_data
-      @checksum = checksum
-    end
-
-    # @return [Boolean]
-    def is_type_redirect?
-      @type == TYPE_ICMP_REDIRECT
-    end
-
-    # @return [Boolean]
-    def is_type_echo?
-      @type == TYPE_ICMP_ECHO_REPLY || @type == TYPE_ICMP_ECHO_REQUEST
-    end
-
-    # @return [Boolean]
-    def is_type_echo_reply?
-      @type == TYPE_ICMP_ECHO_REPLY
-    end
-
-    # @return [Boolean]
-    def is_type_destination_unreachable?
-      @type == TYPE_ICMP_DESTINATION_UNREACHABLE
-    end
-
-    # Whether the argument ICMP is a reply of this ICMP
-    #
-    # @param [ICMP]
-    # @return [Boolean]
-    def successful_reply?(icmp)
-      icmp.id == @id && icmp.seq_number == @seq_number && icmp.is_type_echo_reply?
-    end
-
-    # Return the data format for sending with the Socket::send method
-    #
-    # @return [String]
-    def to_trans_data
-      bynary_data =
-        @type.to_s(2).rjust(8, "0") +
-        @code.to_s(2).rjust(8, "0") +
-        @checksum.to_s(2).rjust(16, "0") +
-        @id.to_s(2).rjust(16, "0") +
-        @seq_number.to_s(2).rjust(16, "0")
-
-      data_byte_arr = bynary_data.scan(/.{1,8}/)
-      data_byte_arr.map! { |byte| byte.to_i(2).chr }
-      data_byte_arr.join + @data
-    end
-
-    private
-
-    # Calculate carry in 16bit
-    # memo: https://qiita.com/kure/items/fa7e665c2259375d9a81
-    #
-    # @param num [String] ex: "11001100110100011"
-    # @return [Integer]
-    def carry_up(num)
-      carry_up_num = num.length - 16
-      original_value = num[carry_up_num, 16]
-      carry_up_value = num[0, carry_up_num]
-      sum = original_value.to_i(2) + carry_up_value&.to_i(2)
-      sum ^ 0xffff
-    end
-
-    # return checksum value
-    # Calculate 1's complement sum for each 16 bits
-    # memo: https://qiita.com/kure/items/fa7e665c2259375d9a81
-    #
-    # @return [Integer]
-    def checksum
-      # Divide into 16 bits
-      # ex: ["pi", "ng"]
-      data_arr = @data.scan(/.{1,2}/)
-      # Calculate each ASCII code
-      # ex: [28777, 28263]
-      data_arr_int = data_arr.map do |data|
-        (data.bytes[0] << 8) + (data.bytes[1].nil? ? 0 : data.bytes[1])
-      end
-      data_sum = data_arr_int.sum
-
-      sum_with_16bit = (@type << 8 + @code) + @id + @seq_number + data_sum
-
-      # calculate carry
-      carry_up(sum_with_16bit.to_s(2).rjust(16, "0"))
-    end
-
-    # generate data
-    #
-    # TODO: random
-    # @return [String]
-    def gen_data
-      "abcd"
-    end
-
-    # generate ID
-    #
-    # TODO: random
-    # @return [Integer]
-    def gen_id
-      0x01
-    end
-
-    # generate sequence number
-    #
-    # TODO: random
-    # @return [Integer]
-    def gen_seq_number
-      0x00af
-    end
-  end
-end

data/recv_message.rb

@@ -1,60 +0,0 @@
-module SimplePing
-  # Class that stores the received message
-  # Implements a method to retrieve the ICMP header
-  class RecvMessage
-    # Code
-    #
-    # @return [Integer]
-    def code
-      @mesg[21].bytes[0]
-    end
-
-    # ID
-    #
-    # @return [Integer]
-    def id
-      (@mesg[24].bytes[0] << 8) + @mesg[25].bytes[0]
-    end
-
-    # constructor
-    #
-    # @param [String] mesg
-    def initialize(mesg)
-      @mesg = mesg
-    end
-
-    # Data
-    #
-    # @return [String]
-    def data
-      @mesg[28, @mesg.length.to_i - 28]
-    end
-
-    # sequence numebr
-    #
-    # @return [Integer]
-    def seq_number
-      (@mesg[26].bytes[0] << 8) + @mesg[27].bytes[0]
-    end
-
-    # create icmp object
-    #
-    # @return [SimplePing::ICMP]
-    def to_icmp
-      icmp = ICMP.new(code: code, type: type)
-      if icmp.is_type_echo?
-        icmp.id = id
-        icmp.seq_number = seq_number
-        icmp.data = data
-      end
-      icmp
-    end
-
-    # Type
-    #
-    # @return [Integer]
-    def type
-      @mesg[20].bytes[0]
-    end
-  end
-end