crabstone 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140a7d4cf44612a3205d95039371d243db5f7eabf5cc218eaafd6ac30a348846
-  data.tar.gz: 13bda9437d26890e825cfea3f661c12a50673fffc9710333fc04b025a5f0059c
+  metadata.gz: 564490cdd38cff5e73eaa7f63fef9f19e27a58d543574de8755da50e63386405
+  data.tar.gz: 0edfc299b230a22c16a0adc5d3d7b3c2387fc6a623deade64a823386efa54eb7
 SHA512:
-  metadata.gz: bdb675faa5efd7eb608ac44d21b8b39e8e3cdbf3592a72df42ac4364b956c1c43463200cf5381556ccd532b3ed20e884a0505eb62d558a12e82156ba26135218
-  data.tar.gz: a38739c9b5a190673b29b1ccc0defcc27cbdf0d4a08fccc45822a3d3ae9bf80447c9ef5647167d1421cc5ab09300cbc0aaab9b43ed8e16b42f28746687cf6287
+  metadata.gz: a68f0c7bb08c664288d682c547aa1b4eecad2d21db754df5ce17e402b86c09d551e2956c0490c987af8b2fac34f05f3d4bcb300736080231b032523353c3b1fd
+  data.tar.gz: 91b153b4e6f7e134d4055cc18896ea0c1401dcd2f93bd9cbecfe5e52963cde49aa3af1c349e128089202c3ec5c940a520057bbd93f8ba5105e6cbafe7c58e813

data/README.md

@@ -1,7 +1,13 @@
+[![Gem Version](https://badge.fury.io/rb/crabstone.svg)](https://badge.fury.io/rb/crabstone)
+[![Build Status](https://travis-ci.org/david942j/crabstone.svg?branch=master)](https://travis-ci.org/david942j/crabstone)
+[![Issue Count](https://codeclimate.com/github/david942j/crabstone/badges/issue_count.svg)](https://codeclimate.com/github/david942j/crabstone)
+[![Test Coverage](https://codeclimate.com/github/david942j/crabstone/badges/coverage.svg)](https://codeclimate.com/github/david942j/crabstone/coverage)
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+
 crabstone
 ====
 
-Current library support: 4.0.1
+Current library support: Capstone 3 \& 4
 ----
 
 ( FROM THE CAPSTONE README )
@@ -12,22 +18,31 @@ disasm engine for binary analysis and reversing in the security community.
 Created by Nguyen Anh Quynh, then developed and maintained by a small community,
 Capstone offers some unparalleled features:
 
-- Support multiple hardware architectures: ARM, ARM64 (aka ARMv8), Mips, X86, Sparc & SystemZ.
+- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Ethereum VM, M68K,
+  Mips, MOS65XX, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore and X86 (including X86_64).
 
 - Having clean/simple/lightweight/intuitive architecture-neutral API.
 
 - Provide details on disassembled instruction (called “decomposer” by others).
 
 - Provide semantics of the disassembled instruction, such as list of implicit
-     registers read & written.
+  registers read & written.
 
-- Implemented in pure C language, with lightweight wrappers for C++, Python,
-     Ruby, OCaml, C#, Java and Go available.
+- Implemented in pure C language, with lightweight bindings for D, Clojure, F#,
+  Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python,
+  Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala
+  ready either in main code, or provided externally by the community.
 
-- Native support for Windows & *nix platforms (MacOSX, Linux & *BSD confirmed).
+- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
+  Linux, \*BSD, Solaris, etc.
 
 - Thread-safe by design.
 
+- Special support for embedding into firmware or OS kernel.
+
+- High performance & suitable for malware analysis (capable of handling various
+  X86 malware tricks).
+
 - Distributed under the open source BSD license.
 
 To install:
@@ -80,7 +95,7 @@ If you feel like chipping in, especially with better tests or examples, or (plea
 
 
 	Library Author: Nguyen Anh Quynh
-	Binding Authors: Nguyen Anh Quynh, Tan Sheng Di, Ben Nagy
+	Binding Authors: Nguyen Anh Quynh, Tan Sheng Di, Ben Nagy, david942j
 	License: BSD style - details in the LICENSE file
 	(c) 2013 COSEINC. All Rights Reserved.
 

data/lib/crabstone/arch.rb

@@ -4,7 +4,7 @@ require 'crabstone/constants'
 require 'crabstone/cs_version'
 
 # require all files under 'crabstone/arch/<cs_major_version>'
-Dir.glob(File.join(__dir__, 'arch', Crabstone.cs_major_version.to_s, '*.rb')).each do |f|
+Dir.glob(File.join(__dir__, 'arch', Crabstone.cs_major_version.to_s, '*.rb')).sort.each do |f|
   require f
 end
 

data/lib/crabstone/arch/register.rb

@@ -8,11 +8,9 @@ module Crabstone
     # @param [Integer, String, Symbol] reg
     # @return [Integer]
     def register(reg)
-      if reg.is_a?(Integer)
-        value?(reg) ? reg : invalid
-      else
-        dict[reg.to_s.upcase] || invalid
-      end
+      return reg if value?(reg)
+
+      dict[reg.to_s.upcase] || invalid
     end
 
     private

data/lib/crabstone/cs_version.rb

@@ -2,6 +2,7 @@
 
 require 'ffi'
 
+require 'crabstone/constants'
 require 'crabstone/version'
 
 module Crabstone
@@ -25,18 +26,25 @@ module Crabstone
   # @return [Integer]
   #   Returns the major version of Capstone.
   def cs_major_version
-    return @cs_major_version if defined?(@cs_major_version)
+    cs_version.first
+  end
+
+  # @return [(Integer, Integer)]
+  def cs_version
+    return @cs_version if defined?(@cs_version)
 
     maj = FFI::MemoryPointer.new(:int)
     min = FFI::MemoryPointer.new(:int)
     Binding.cs_version(maj, min)
-    @cs_major_version = maj.read_int
+    @cs_version = [maj.read_int, min.read_int]
   end
 
   # Checks the cs_major is less or equal to Crabstone::VERSION.
   def version_compatitable!
     @version_compatitable ||=
-      cs_major_version <= Crabstone::VERSION.split('.').first.to_i && cs_major_version >= 3
+      cs_major_version <= Crabstone::BINDING_MAJ && cs_major_version >= 3
+    maj, min = cs_version
+    raise "FATAL: Crabstone v#{VERSION} doesn't support binding Capstone v#{maj}.#{min}" unless @version_compatitable
   end
 
   # @private

data/lib/crabstone/disassembler.rb

@@ -3,9 +3,9 @@
 require 'ffi'
 
 require 'crabstone/binding'
+require 'crabstone/cs_version'
 require 'crabstone/error'
 require 'crabstone/instruction'
-require 'crabstone/version'
 
 module Crabstone
   class Disassembler
@@ -28,9 +28,6 @@ module Crabstone
     attr_reader :arch, :mode, :csh, :syntax, :decomposer
 
     def initialize(arch, mode)
-      maj, min = version
-      raise "FATAL: Crabstone v#{VERSION} doesn't support binding Capstone v#{maj}.#{min}" if maj > BINDING_MAJ
-
       @arch = arch
       @mode = mode
       @p_csh = FFI::MemoryPointer.new(:ulong_long)
@@ -61,10 +58,7 @@ module Crabstone
     end
 
     def version
-      maj = FFI::MemoryPointer.new(:int)
-      min = FFI::MemoryPointer.new(:int)
-      Binding.cs_version(maj, min)
-      [maj.read_int, min.read_int]
+      Crabstone.cs_version
     end
 
     def diet?
@@ -147,7 +141,7 @@ module Crabstone
     end
 
     def safe
-      yield.tap { |res| Crabstone.raise_errno(res) unless res.zero? }
+      yield.tap { |res| Crabstone::Error.raise_errno!(res) unless res.zero? }
     end
   end
 end

data/lib/crabstone/instruction.rb

@@ -122,26 +122,21 @@ module Crabstone
     # members that have special handling for detail mode or diet mode are
     # handled above. The rest is dynamically dispatched below.
     def method_missing(meth, *args)
-      if raw_insn.members.include?(meth)
-        # Dispatch to toplevel Instruction class ( this file )
-        raw_insn[meth]
-      else
-        # Nothing else is available without details.
-        unless detailed?
-          raise(
-            NoMethodError,
-            "Either CS_DETAIL is off, or #{self.class} doesn't implement #{meth}"
-          )
-        end
-        # Dispatch to the architecture specific Instruction ( in arch/ )
-        if @arch_insn.respond_to?(meth)
-          @arch_insn.__send__(meth, *args)
-        elsif @arch_insn.members.include?(meth)
-          @arch_insn[meth]
-        else
-          super
-        end
+      # Dispatch to toplevel Instruction class ( this file )
+      return raw_insn[meth] if raw_insn.members.include?(meth)
+
+      # Nothing else is available without details.
+      unless detailed?
+        raise(
+          NoMethodError,
+          "Either CS_DETAIL is off, or #{self.class} doesn't implement #{meth}"
+        )
       end
+      # Dispatch to the architecture specific Instruction ( in arch/ )
+      return @arch_insn.__send__(meth, *args) if @arch_insn.respond_to?(meth)
+      return @arch_insn[meth] if @arch_insn.members.include?(meth)
+
+      super
     end
 
     def respond_to_missing?(meth, include_private = true)

data/lib/crabstone/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crabstone
-  VERSION = '4.0.0'
+  VERSION = '4.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crabstone
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.2
 platform: ruby
 authors:
 - Ben Nagy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -31,56 +31,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.63'
+        version: '0.84'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.63'
+        version: '0.84'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: versionomy
   requirement: !ruby/object:Gem::Requirement
@@ -95,13 +95,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
-description: |2+
-
+description: |2
     Capstone is a disassembly engine written by Nguyen Anh Quynh, available here
-    https://github.com/aquynh/capstone. This is the Ruby FFI binding. We test
-    against MRI 2.0.0,  2.1.0 and JRuby 1.7.8. AFAIK it works with rubinius
-    2.2.1.
-
+    https://github.com/aquynh/capstone. This is the Ruby FFI binding.
 email:
 - crabstone@ben.iagu.net
 - david942j@gmail.com
@@ -174,7 +170,12 @@ files:
 homepage: https://github.com/david942j/crabstone
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/david942j/crabstone/issues
+  changelog_uri: https://github.com/david942j/crabstone/blob/master/CHANGES.md
+  documentation_uri: https://www.rubydoc.info/gems/crabstone
+  homepage_uri: https://github.com/david942j/crabstone
+  source_code_uri: https://github.com/david942j/crabstone
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -190,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby FFI bindings for the capstone disassembly engine