binp 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2eb04ce7bb1579b6b9cdc507a61047c368fe47e8acfdd6cd332a0091b67ae68
+  data.tar.gz: e3584dff37e2cc175bf0eaafd734f570e3b02de7d7b95c808759c35c5db4d68d
+SHA512:
+  metadata.gz: 8fb9db8a044b041637f1ce5dfce53dd1df57ee9053fe5f6ebc855b2d11bd57bc0270f490e6c4a370179fe16e47ff5ac8c3fe1e7fcf44651d45dc6053b9f6f581
+  data.tar.gz: e34bee00576187bc9e17d862c16af026c0a7c640b3391789912975da23b8aba0e8f77a329d6b0d73f4903fbcedd53e1e80005f89390224de5b035f240cc57ba0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/vendor/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in binp.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    binp (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.3.2)
+    power_assert (1.2.0)
+    rake (12.3.3)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    test-unit (3.3.6)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binp!
+  rake (~> 12.0)
+  simplecov
+  test-unit
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 mikoto2000
+
+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,88 @@
+# Binp - Binary Parser
+
+バイナリファイルからデータを抽出するツール。
+
+`offset`, `size` `type`, `endianness` を指定して、バイナリファイルのどこからどこまでをどのように解釈するかを指定できる。
+
+
+# 使い方
+
+以下内容のバイナリファイルをパースする場合について説明する。
+
+■ `example.bin`
+
+```
++----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+
+|  0 |  1 |  2 |  3 |  4 |  5 |  6 |  7 |  8 |  9 | 10 | 11 | 12 | 13 |    14 |
++----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+
+| 00 | 00 | 00 | 00 | 00 | 00 | 00 | 01 | 00 | 00 | 00 | 01 | 00 | 01 |    01 |
++---------------------------------------+-------------------+---------+-------+
+| UINT64                                | UINT32            |  UINT16 | UINT8 |
++---------------------------------------+-------------------+---------+-------+
+※ エンディアンはリトルエンディアン
+```
+
+以下のように、設定ファイルに `name`, `offset`, `size`, `type` を記述する。
+
+■ `setting.yaml`
+
+```yaml
+- name: UINT64_value
+  offset: 0
+  size: 8
+  type: UINT64
+  endianness: LITTLE
+- name: UINT32_value
+  offset: 8
+  size: 4
+  type: UINT32
+  endianness: LITTLE
+- name: UINT16_value
+  offset: 2
+  size: 2
+  type: UINT16
+  endianness: LITTLE
+- name: UINT8_value
+  offset: 14
+  size: 1
+  type: UINT8
+  endianness: LITTLE
+```
+
+`binary_parser.rb` に設定ファイルとバイナリファイルを指定して実行する。
+
+実行結果は以下のようになる。
+
+json 形式で出力されるので、 `jq` 等でよしなに pretty-print してください。
+
+```sh
+$ ruby binary_parser.rb -c setting.yaml example.bin | jq '.'
+[
+  {
+    "name": "UINT64_72057594037927936",
+    "offset": 0,
+    "size": 8,
+    "type": "UINT64",
+    "endianness": "LITTLE",
+    "value": 72057594037927940
+  },
+...(snip)
+  {
+    "name": "UINT8_value",
+    "offset": 14,
+    "size": 1,
+    "type": "UINT8",
+    "endianness": "LITTLE",
+    "value": 1
+  }
+]
+```
+
+# TODO:
+
+- [ ] : テーブル形式で表示
+- [ ] : 文字列型サポート
+    - [ ] : UTF8
+- [ ] : ビットフラグサポート
+- [ ] : type からの size 自動設定
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "binp"
+
+# 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 --path=vendor/bundle
+
+# Do any other automated setup that you need to do here

data/binp.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/binp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "binp"
+  spec.version       = Binp::VERSION
+  spec.authors       = ["mikoto2000"]
+  spec.email         = ["mikoto2000@gmail.com"]
+
+  spec.summary       = %q{binary file parser.}
+  spec.description   = %q{simple binary file parser.}
+  spec.homepage      = "https://github.com/mikoto2000/binp"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://rubygems.org/gems/binp"
+  spec.metadata["changelog_uri"] = "https://github.com/mikoto2000/binp/releases"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'simplecov'
+end

data/example/example_01.yaml

@@ -0,0 +1,67 @@
+# +----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+-------+
+# |  0 |  1 |  2 |  3 |  4 |  5 |  6 |  7 |  8 |  9 | 10 | 11 | 12 | 13 |    14 |    15 |
+# +----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+-------+
+# | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 01 | 00 | 00 | 00 | 01 | 00 | 01 |    FF |    88 |
+# +---------------------------------------+-------------------+---------+-------+-------+
+# | UINT64                                | UINT32            |  UINT16 | UINT8 | UINT8 |
+# +---------------------------------------+-------------------+---------+-------+-------+
+# 
+# +----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+-------+
+# | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |    30 |    31 |
+# +----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+-------+
+# | 01 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 01 | 00 | 00 | 00 | 01 | 00 |    88 |    FF |
+# +---------------------------------------+-------------------+---------+-------+-------+
+# | UINT64                                | UINT32            |  UINT16 | UINT8 | UINT8 |
+# +---------------------------------------+-------------------+---------+-------+-------+
+---
+- name: UINT64_72057594037927936
+  offset: 0
+  size: 8
+  type: UINT64
+  endianness: LITTLE
+- name: UINT32_16777216
+  offset: 8
+  size: 4
+  type: UINT32
+  endianness: LITTLE
+- name: UINT16_256
+  offset: 12
+  size: 2
+  type: UINT16
+  endianness: LITTLE
+- name: UINT8_255
+  offset: 14
+  size: 1
+  type: UINT8
+  endianness: LITTLE
+- name: UINT8_136
+  offset: 15
+  size: 1
+  type: UINT8
+  endianness: LITTLE
+- name: UINT64_72057594037927936
+  offset: 0
+  size: 8
+  type: UINT64
+  endianness: BIG
+- name: UINT32_16777216
+  offset: 8
+  size: 4
+  type: UINT32
+  endianness: BIG
+- name: UINT16_256
+  offset: 12
+  size: 2
+  type: UINT16
+  endianness: BIG
+- name: UINT8_255
+  offset: 14
+  size: 1
+  type: UINT8
+  endianness: BIG
+- name: UINT8_136
+  offset: 15
+  size: 1
+  type: UINT8
+  endianness: BIG
+

data/exe/binp

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/binp/cli/main.rb'
+
+if __FILE__ == $0
+  Main.run(ARGV)
+end
+

data/lib/binp.rb

@@ -0,0 +1,84 @@
+# encoding: UTF-8
+require "binp/version"
+
+class BinParser
+  def self.parse(uint8_array, config)
+    config.map { |e|
+      e['value'] = BinParserElement.get_value(uint8_array, e['offset'], e['size'], e['type'], e['endianness'])
+      e
+    }
+  end
+end
+
+class BinParserElement
+  attr_reader :name, :offset, :size, :endianness
+
+  def initialize(name, offset, size, endianness)
+    @name = name
+    @offset = offset
+    @size = size
+    @endianness = endianness
+  end
+
+  module Type
+    UINT8 = { name: 'UINT8', value: 'C' }
+    UINT16 = { name: 'UINT16', value: 'S' }
+    UINT32 = { name: 'UINT32', value: 'L' }
+    UINT64 = { name: 'UINT64', value: 'Q' }
+    INT8 = { name: 'INT8', value: 'c' }
+    INT16 = { name: 'INT16', value: 's' }
+    INT32 = { name: 'INT32', value: 'l' }
+    INT64 = { name: 'INT64', value: 'q' }
+    FLAGS = { name: 'FLAGS', value: 'C' }
+  end
+
+  module Endianness
+    BIG_ENDIAN = { name: 'BIG', value: '>' }
+    LITTLE_ENDIAN = { name: 'LITTLE', value: '<' }
+  end
+
+  # see: https://docs.ruby-lang.org/ja/latest/doc/pack_template.html
+  def self.calculate_unpack_template_string(type, endianness)
+
+    # ����ȏ���
+    case type
+    when BinParserElement::Type::UINT16
+      if endianness == BinParserElement::Endianness::BIG_ENDIAN
+        # �r�b�O�G���f�B�A���A�����Ȃ� 16 bit ����
+        return 'n'
+      else
+        # ���g���G���f�B�A���A�����Ȃ� 16 bit ����
+        return 'v'
+      end
+    when BinParserElement::Type::UINT32
+      if endianness == BinParserElement::Endianness::BIG_ENDIAN
+        # �r�b�O�G���f�B�A���A�������� 32 bit ����
+        return 'N'
+      else
+        # ���g���G���f�B�A���A�������� 32 bit ����
+        return 'V'
+      end
+    when BinParserElement::Type::UINT8
+      # �����Ȃ� 8 bit ����
+      return 'C'
+    when BinParserElement::Type::INT8
+      # �������� 8 bit ����
+      return 'c'
+    end
+
+    # ���̑�
+    type[:value] + endianness[:value]
+  end
+
+  def self.calculate_pack_template_string(size)
+    'C' * size
+  end
+
+  def self.get_value(uint8_array, offset, size, type, endianness)
+    target = uint8_array.slice(offset, size)
+    pack_template_string = calculate_pack_template_string(size)
+    unpack_template_string = calculate_unpack_template_string(type, endianness)
+    target.pack(pack_template_string).unpack(unpack_template_string)[0]
+  end
+end
+

data/lib/binp/cli/main.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+require 'json'
+require 'optparse'
+require 'yaml'
+
+require_relative '../../binp.rb'
+
+class Main
+  def self.run(argv)
+    # 引数パース
+    opts, argv = parse_option(argv)
+
+    # ファイル読み込み
+    config = read_config_file(opts[:config])
+    uint8_array = read_binary_file(argv[0])
+
+    # バイナリパース
+    raw_result = BinParser.parse(uint8_array, config)
+
+    # 出力用に加工して出力
+    puts raw_result.map { |e|
+      e['type'] = e['type'][:name]
+      e['endianness'] = e['endianness'][:name]
+      e
+    }.to_json.to_s
+  end
+
+  def self.parse_option(argv)
+    options = {}
+    op = OptionParser.new
+
+    op.on('-c VALUE', '--config VALUE', '設定ファイルパス') { |v| options[:config] = v }
+    op.parse!(argv)
+
+    [options, argv]
+  end
+
+  def self.read_config_file(config_file_path)
+    config = File.open(config_file_path, 'rb') { |f|
+      YAML.load_file(f)
+    }
+    config.each_with_index { |e, i|
+      type = BinParserElement::Type.constants.find { |type|
+        BinParserElement::Type.const_get(type)[:name] == e['type']
+      }
+
+      # YAML 記載の type に対応した Type オブジェクトに差し替える
+      if type
+        e['type'] = BinParserElement::Type.const_get(type)
+      else
+        STDERR.puts "#{i} 番目の type の値が不正です('#{e['type']}')。UINT8, UINT16, UINT32, UINT64, INT8, INT16, INT32 or INT64."
+        exit(1)
+      end
+
+      endianness = BinParserElement::Endianness.constants.find { |endianness|
+        BinParserElement::Endianness.const_get(endianness)[:name] == e['endianness']
+      }
+
+      # YAML 記載の endianness に対応した Endianness オブジェクトに差し替える
+      if endianness
+        e['endianness'] = BinParserElement::Endianness.const_get(endianness)
+      else
+        STDERR.puts "#{i} 番目の endianness の値が不正です('#{e['endianness']}')。LITTLE or BIG を指定してください。"
+        exit(1)
+      end
+    }
+
+    config
+  end
+
+  def self.read_binary_file(binary_file_path)
+    File.open(binary_file_path, 'rb') { |f|
+      f.each_byte.to_a
+    }
+  end
+end
+

data/lib/binp/version.rb

@@ -0,0 +1,3 @@
+module Binp
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: binp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- mikoto2000
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: simple binary file parser.
+email:
+- mikoto2000@gmail.com
+executables:
+- binp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- binp.gemspec
+- example/example_01.bin
+- example/example_01.yaml
+- exe/binp
+- lib/binp.rb
+- lib/binp/cli/main.rb
+- lib/binp/version.rb
+homepage: https://github.com/mikoto2000/binp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mikoto2000/binp
+  source_code_uri: https://rubygems.org/gems/binp
+  changelog_uri: https://github.com/mikoto2000/binp/releases
+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.1.2
+signing_key: 
+specification_version: 4
+summary: binary file parser.
+test_files: []