simple_capture 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8ab97c1d77026f80dc16f0e798a730078d52f9323b9038769c5d60c2385a1a3
+  data.tar.gz: 6fc14246c88e07be902c1dae27ec8ac268f6db4d6d144b414f5902f0ff0d1170
+SHA512:
+  metadata.gz: c600259cbe23284c1ba1e27eac9430da64c841c4c0879b850ca8f7c092df0e711aec3335dc3fd827ed206c5df1b16b94c8bb9994a571ee9f32b0c669bec69ebf
+  data.tar.gz: 94b33abf943b6a48c13e23e1cc4423171427f15e001e384c8d279903429c3bb70ae03cb48b5ba2ecac63ac84fd0ffdf0058a4f55dedd3af06faf1d4e6a259bbf

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+simple_capture.code-workspace

data/.ruby-version

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Akira kure
+
+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.

data/README.md

@@ -0,0 +1,14 @@
+# SimpleCapture
+
+Packet capture tool made only with Ruby
+
+## Installation
+
+## Usage
+
+
+## Development
+
+
+## Contributing
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simple_capture"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_capture.rb

@@ -0,0 +1,11 @@
+require_relative "simple_capture/version"
+require_relative "simple_capture/capture"
+require_relative "simple_capture/packet"
+require_relative "simple_capture/string"
+require_relative "simple_capture/recv_message"
+require_relative "simple_capture/header/ehter_header"
+require_relative "simple_capture/header/ipv4_header"
+require_relative "simple_capture/header/icmp_header"
+
+module SimpleCapture
+end

data/lib/simple_capture/capture.rb

@@ -0,0 +1,92 @@
+require "socket"
+
+module SimpleCapture
+  class Capture
+    SOL_PACKET            = 0x0107 # bits/socket.h
+    IFINDEX_SIZE          = 0x0004 # sizeof(ifreq.ifr_ifindex) on 64bit
+    IFREQ_SIZE            = 0x0028 # sizeof(ifreq) on 64bit
+    SIOCGIFINDEX          = 0x8933 # bits/ioctls.h
+    PACKET_MR_PROMISC     = 0x0001 # netpacket/packet.h
+    PACKET_MREQ_SIZE      = 0x0010 # sizeof(packet_mreq) on 64bit
+    PACKET_ADD_MEMBERSHIP = 0x0001 # netpacket/packet.h
+    ETH_P_ALL             = 768    # htons(ETH_P_ALL), linux/if_ether.h
+
+    # @param [String] interface_name
+    def initialize(interface_name)
+      @interface_name = interface_name
+    end
+
+    # Run Capture
+    def run
+      socket = generate_socket(@interface_name)
+      cap_loop(socket)
+    end
+
+    private
+
+    def cap_loop(socket)
+      while true
+        mesg, _ = socket.recvfrom(1500)
+        packet = RecvMessageHandler.new(mesg).to_packet
+        packet.dump
+      end
+    end
+
+    def bind_if(socket, interface_name)
+      index_str = mr_ifindex(interface_name)
+
+      eth_p_all_hbo = [ ETH_P_ALL ].pack('S').unpack('S>').first
+      sll = [ Socket::AF_PACKET, eth_p_all_hbo, index_str ].pack('SS>a16')
+      socket.bind(sll)
+    end
+
+    # @return [Integer]
+    def if_name_to_index(if_name)
+      Socket.getifaddrs.find do |ifaddr|
+        ifaddr.name == if_name
+      end&.ifindex
+    end
+
+    def generate_socket(interface_name)
+      socket = Socket.new(Socket::AF_PACKET, Socket::SOCK_RAW, ETH_P_ALL)
+      bind_if(socket, interface_name)
+      socket_promiscuous(socket, interface_name)
+      socket
+    end
+
+    def mr_ifindex(if_name)
+      [[if_name_to_index(if_name)].pack("c")].pack("a4")
+    end
+
+    def mr_type
+      [PACKET_MR_PROMISC].pack("S")
+    end
+
+    def mr_alen
+      [0].pack("S")
+    end
+
+    def mr_address
+      [0].pack("C")*8
+    end
+
+    #
+    # https://linuxjm.osdn.jp/html/LDP_man-pages/man7/packet.7.html
+    # struct packet_mreq {
+    #  int            mr_ifindex; 4Byte
+    #  unsigned short mr_type; 2Byte
+    #  unsigned short mr_alen; 2Byte
+    #  unsigned char  mr_address[8]; 1Byte * 8
+    #};
+    #
+    # @param [String]
+    # @return [String]
+    def mreq(interface)
+      mr_ifindex(interface) + mr_type + mr_alen + mr_address
+    end
+
+    def socket_promiscuous(socket, interface_name)
+      socket.setsockopt(SOL_PACKET, PACKET_ADD_MEMBERSHIP, mreq(interface_name))
+    end
+  end
+end

data/lib/simple_capture/header/ehter_header.rb

@@ -0,0 +1,70 @@
+module SimpleCapture
+  class EtherHeader
+    IPv4 = 0x0800
+
+    attr_reader :dst_mac_address, :src_mac_address, :type
+
+    # @param [Array<Integer>] [10, 46, ...]
+    def initialize(bytes: nil)
+      # support 14Byte EhterHeader only now.
+      raise ArgumentError, "bytes's size must be 10Byte" unless bytes.size == 14
+
+      convert_bytes_to_headers(bytes) unless bytes.nil?
+    end
+
+    # @return [Boolean]
+    def upper_layer_protocol_ipv4?
+      type_hex = type.map { |byte| byte.to_s(16).rjust(2, "0") }
+      type_hex.join.to_i(16) == IPv4
+    end
+
+    # Print Header Info
+    def dump
+      puts "■ether header------------------------------".red
+      print_dst_mac_address
+      print_src_mac_address
+      print_type
+    end
+
+    private
+
+    def convert_bytes_to_headers(bytes)
+      @dst_mac_address = bytes[0..5]
+      @src_mac_address = bytes[6..11]
+      @type = bytes[12..13]
+    end
+
+    def print_dst_mac_address
+      hex_dst_mac_address = dst_mac_address.map { |byte| byte.to_s(16) }
+
+      puts "dst_mac_address = #{hex_dst_mac_address[0]}:\
+#{hex_dst_mac_address[1]}:\
+#{hex_dst_mac_address[2]}:\
+#{hex_dst_mac_address[3]}:\
+#{hex_dst_mac_address[4]}:\
+#{hex_dst_mac_address[5]}"
+    end
+
+    def print_src_mac_address
+      hex_src_mac_address = src_mac_address.map { |byte| byte.to_s(16) }
+
+      puts "src_mac_address = #{hex_src_mac_address[0]}:\
+#{hex_src_mac_address[1]}:\
+#{hex_src_mac_address[2]}:\
+#{hex_src_mac_address[3]}:\
+#{hex_src_mac_address[4]}:\
+#{hex_src_mac_address[5]}"
+    end
+
+    def print_type
+      type_hex = type.map { |byte| byte.to_s(16).rjust(2, "0") }
+      type_hex_int = type_hex.join.to_i(16) # ["08", "00"]
+      protocol_display = if type_hex_int == IPv4
+                           "IPv4"
+                         else
+                           "[UnKnown Protocol]"
+                         end
+      puts "protocol = #{protocol_display}"
+    end
+  end
+end

data/lib/simple_capture/header/icmp_header.rb

@@ -0,0 +1,76 @@
+module SimpleCapture
+  class ICMPHeader
+    attr_reader :type, :code, :checksum, :id, :seq_number, :data
+
+    # @param [Array<Integer>] [10, 46, ...]
+    def initialize(bytes: nil)
+      convert_bytes_to_header(bytes) unless bytes.nil?
+    end
+
+    def dump
+      puts "■icmp--------------------------------------".blue
+      print_checksum
+      print_code
+      print_type
+      print_id
+      print_seqnumber
+      print_data
+    end
+
+    private
+
+    def print_checksum
+      puts "checksum = 0x#{combine_2bits_in_hex(checksum).to_s(16)}"
+    end
+
+    def print_code
+      puts "code = #{code}"
+    end
+
+    def print_data
+      puts "data = "
+      data.each_slice(10) do |data10|
+        data10.each { |data_| print "0x#{data_.to_s(16)} " }
+        puts "\n"
+      end
+    end
+
+    def print_id
+      if id
+        puts "id = 0x#{combine_2bits_in_hex(id).to_s(16)}"
+      end
+    end
+
+    def print_seqnumber
+      if seq_number
+        puts "seq_number = 0x#{combine_2bits_in_hex(seq_number).to_s(16)}"
+      end
+    end
+
+    def print_type
+      puts "type = #{type}"
+    end
+
+    # Combine 2 bits of numbers in hexadecimal
+    #
+    # @param [Array<Integer>] [0d80, 0d30]
+    # @return [Integer] 0x501e... 0d80 -> 0x50, 0d30 -> 0x1e
+    def combine_2bits_in_hex(bytes)
+      (bytes[0].to_s(16) + bytes[1].to_s(16)).to_i(16)
+    end
+
+    def convert_bytes_to_header(bytes)
+      @type = bytes[0]
+      @code = bytes[1]
+      @checksum = bytes[2..3]
+
+      if @type == 0 || 8
+        @id = bytes[4..5]
+        @seq_number = bytes[6..7]
+        @data = bytes[8..(bytes.size-1)]
+      else
+        @data = bytes[4..(bytes.size-1)]
+      end
+    end
+  end
+end

data/lib/simple_capture/header/ipv4_header.rb

@@ -0,0 +1,117 @@
+module SimpleCapture
+  class IPv4Header
+    ICMP = 1
+
+    attr_reader :version, :ihl, :type_of_service, :length, :id, :flags, :offset, :ttl,
+                :checksum, :src_addr, :dst_addr, :protocol
+
+    # @param [Array<Integer>] 各バイトの数値の配列、[10, 46, ...]
+    def initialize(bytes: nil)
+      # support 20Byte IPHeader only now.
+      raise ArgumentError, "bytes's size must be 20Byte" unless bytes.size == 20
+
+      convert_bytes_to_header(bytes) unless bytes.nil?
+    end
+
+    def dump
+      puts "■ipv4--------------------------------------".yellow
+      print_version
+      print_ihl
+      print_type_of_service
+      print_length
+      print_id
+      print_flags
+      print_offset
+      print_ttl
+      print_protocol
+      print_checksum
+      print_src_addr
+      print_dst_addr
+    end
+
+    def upper_layer_protocol_icmp?
+      protocol == ICMP
+    end
+
+    private
+
+    # Combine 2 bits of numbers in hexadecimal
+    #
+    # @param [Array<Integer>] [0d80, 0d30]
+    # @return [Integer] 0x501e... 0d80 -> 0x50, 0d30 -> 0x1e
+    def combine_2bits_in_hex(bytes)
+      bytes_hex = bytes.map { |byte| byte.to_s(16).rjust(2, "0") }
+      bytes_hex.join.to_i(16)
+
+      # (bytes[0].to_s(16) + bytes[1].to_s(16)).to_i(16)
+    end
+
+    def convert_bytes_to_header(bytes)
+      @version = bytes[0][4, 4]
+      @ihl = bytes[0][0, 4]
+      @type_of_service = bytes[1]
+      @length = bytes[2..3]
+      @id = bytes[4..5]
+      bytes67 = combine_2bits_in_hex(bytes[6..7])
+      @flags = bytes67[0, 3]
+      @offset = bytes67[3, 13]
+      @ttl = bytes[8]
+      @protocol = bytes[9]
+      @checksum = bytes[10..11]
+      @src_addr = bytes[12..15]
+      @dst_addr = bytes[16..19]
+    end
+
+    def print_checksum
+      puts "checksum = 0x#{combine_2bits_in_hex(checksum).to_s(16)}"
+    end
+
+    def print_dst_addr
+      puts "dst_addr = #{dst_addr}"
+    end
+
+    def print_flags
+      puts "flags = #{flags}"
+    end
+
+    def print_id
+      puts "id = 0x#{combine_2bits_in_hex(id).to_s(16)}\n"
+    end
+
+    def print_ihl
+      puts "ihl = #{ihl}"
+    end
+
+    def print_length
+      puts "length = 0x#{combine_2bits_in_hex(length).to_s(16)}"
+    end
+
+    def print_offset
+      puts "offset = #{offset}"
+    end
+
+    def print_protocol
+      if protocol == ICMP
+        puts "protocol = ICMP"
+      else
+        puts "protocol = [UnKnown Protocol]"
+      end
+    end
+
+    def print_src_addr
+      puts "src_addr = #{src_addr}"
+    end
+
+    def print_type_of_service
+      puts "type_of_service = #{type_of_service}"
+    end
+
+    def print_ttl
+      puts "ttl = #{ttl}"
+    end
+
+    def print_version
+      puts "version = #{version}"
+    end
+  end
+end

data/lib/simple_capture/packet.rb

@@ -0,0 +1,18 @@
+module SimpleCapture
+  class Packet
+
+    # @param [Array] headers
+    def initialize(headers)
+      @headers = headers
+    end
+
+    def dump
+      puts "\n■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■".green
+      puts "Display Packet".green
+      puts "■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■".green
+      @headers.each do |header|
+        header.dump
+      end
+    end
+  end
+end

data/lib/simple_capture/recv_message.rb

@@ -0,0 +1,25 @@
+module SimpleCapture
+  class RecvMessageHandler
+    def initialize(mesg)
+      @mesg = mesg
+    end
+
+    # @return [Packet]
+    def to_packet
+      headers = []
+      ether = SimpleCapture::EtherHeader.new(bytes: @mesg.bytes[0..13])
+      headers.push(ether)
+
+      if ether.upper_layer_protocol_ipv4?
+        ip = SimpleCapture::IPv4Header.new(bytes: @mesg.bytes[14..33])
+        headers.push(ip)
+        if ip.upper_layer_protocol_icmp?
+          icmp =  SimpleCapture::ICMPHeader.new(bytes: @mesg.bytes[34..(@mesg.bytes.size-1)])
+          headers.push(icmp)
+        end
+      end
+      SimpleCapture::Packet.new(headers)
+    end
+  end
+end
+

data/lib/simple_capture/string.rb

@@ -0,0 +1,25 @@
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def pink
+    colorize(35)
+  end
+end

data/lib/simple_capture/version.rb

@@ -0,0 +1,3 @@
+module SimpleCapture
+  VERSION = "0.1.0"
+end

data/sample_run.rb

@@ -0,0 +1,4 @@
+require_relative "lib/simple_capture"
+
+cap = SimpleCapture::Capture.new("eth1")
+cap.run

data/simple_capture.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/simple_capture/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_capture"
+  spec.version       = SimpleCapture::VERSION
+  spec.authors       = ["Akira Kure"]
+  spec.email         = ["kuredev@gmail.com"]
+
+  spec.summary       = "Packet capture tool made only with Ruby."
+  spec.description   = "Packet capture tool made only with Ruby."
+  spec.homepage      = "https://github.com/kuredev/simple_capture"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kuredev/simple_capture"
+  spec.metadata["changelog_uri"] = "https://github.com/kuredev/simple_capture"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: simple_capture
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Kure
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-22 00:00:00.000000000 Z
+dependencies: []
+description: Packet capture tool made only with Ruby.
+email:
+- kuredev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_capture.rb
+- lib/simple_capture/capture.rb
+- lib/simple_capture/header/ehter_header.rb
+- lib/simple_capture/header/icmp_header.rb
+- lib/simple_capture/header/ipv4_header.rb
+- lib/simple_capture/packet.rb
+- lib/simple_capture/recv_message.rb
+- lib/simple_capture/string.rb
+- lib/simple_capture/version.rb
+- sample_run.rb
+- simple_capture.gemspec
+homepage: https://github.com/kuredev/simple_capture
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kuredev/simple_capture
+  source_code_uri: https://github.com/kuredev/simple_capture
+  changelog_uri: https://github.com/kuredev/simple_capture
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Packet capture tool made only with Ruby.
+test_files: []