crabstone 3.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acf2c718e307944c7535140d1048d7bff42e35d3
-  data.tar.gz: 60877a5b5d2cbc318431ae9c6019dcdd24e6b75b
+SHA256:
+  metadata.gz: aa7db8d4574680563c5d764ba18f89a8e9a4a1782d63e5cc4183d8c23b6e46e4
+  data.tar.gz: ef92564c3c75cc1efe08b87a962b963256cb1f6f1aab2e06f60ba31e1aa38a4d
 SHA512:
-  metadata.gz: 5fc96a476ee596c02d0c60805e27348503aba244a910c3aa4fc8596590c1e9c337a5a8cebd9cb9df8551352f95d07b3d6f957b578b0f4620b25d3a5f6fb734ac
-  data.tar.gz: 4821da92a28077e91a03759c8cf986d4b7bd68ff56df30f2d760189d50a0af1f0b6e216a7cca62134b01dbe7647261d8b8319bf2048e96a5cfb6b16a9eeba319
+  metadata.gz: 67d59e8f780525172b86ac58b05c8f91a49818fd2cf5b2df79461d507663c80fd48e205b561df4dbe31f1a2cfa764a2cd5debe1f652dd16ee0e3cb24d2455a3b
+  data.tar.gz: fcfa5c85c21dd8ee39d2d22fee4d5233e240ee0785acc1c8e645277b4bef96aa160537e66a2c8979536f391639891f76850dac448116e08b6ce9c689f4529aca

data/CHANGES.md

@@ -1,23 +1,54 @@
-## 0.0.1
-* Alpha release.
+## 4.0.4
+* Ensured Ruby version support 2.6 ~ 3.1
+* [Diff from previous release](https://github.com/david942j/crabstone/compare/v4.0.3...v4.0.4)
 
-## 0.0.2
-* Update tests, add syntax sugar
+## 4.0.3
+* Fixed Instruction class redefinition ([#12](https://github.com/david942j/crabstone/pull/12))
+* [Diff from previous release](https://github.com/david942j/crabstone/compare/v4.0.2...v4.0.3)
 
-## 0.0.3
-* Refactoring and cosmetics
+## 4.0.2
+* Supported binding Capstone 4.0.2
+* Raised errors when the version of libcapstone is not supported
+* Internal refactors and code cleanup
+* [Diff from previous release](https://github.com/david942j/crabstone/compare/4.0.0...v4.0.2)
 
-## 0.0.4
-* Verify MIPS support, tests, slight API changes
+## 4.0.0
+* Supported *both* Capstone 3.x and 4.x.
+* Supported 4 new architectures: M68K, M680X, TMS320C64x, and EVM.
+* Added `cs_regs_access` API (wrapped as `Instruction#regs_access` in Crabstone).
+* Changed some internal constants and methods.
+* Fixed tons of bugs.
+* For more details, see https://github.com/david942j/crabstone/pull/2
 
-## 0.0.5
-* API changes including cs_errno.
+## 3.0.3-rc1
+* Internal binding updates, updated some test specs.
 
-## 0.0.6
-* Final set of API changes before public beta.
+## 3.0
+* See https://github.com/aquynh/capstone/wiki/ChangeLog-since-3.0-rc3
+* Shouldn't be breaking, most changes are internal.
 
-## 1.0.0
-* Move to new github repo
+## 3.0rc3
+* Generic groups ( CS_GRP_JUMP, CS_GRP_CALL etc)
+* Mips 32R6 + MICRO
+* Many constant changes
+* PPC CRX operand
+* X86: added prefixed symbols
+* THIS IS A BREAKING CHANGE ( even from rc1 )
+
+## 3.0rc1
+* Update for C side changes
+* Add support for Xcore
+* ARM, ARM64 and X86 passing, rest waiting for upstream
+
+## 2.2.0
+* Add support for Sparc and SystemZ
+
+## 2.1rc1
+* Many constant changes
+* disasm CAN now return an Array, with a slightly scary built-in finalizer
+
+## 2.0.1
+* Update X86 constants
 
 ## 2.0.0
 * Add PPC support
@@ -25,37 +56,23 @@
 * disasm can now ONLY be used with a block ( hopefully fix later )
 * THIS IS A BREAKING CHANGE
 
-## 2.0.1
-* Update X86 constants
-
-## 2.1rc1
-* Many constant changes
-* disasm CAN now return an Array, with a slightly scary built-in finalizer
+## 1.0.0
+* Move to new github repo
 
-## 2.1.0
-* Full compliance with 2.1 API
-* Better error handling for diet mode
-* Internally change cs_close() signature, so closed handles can't be used
+## 0.0.6
+* Final set of API changes before public beta.
 
-## 2.2.0
-* Add support for Sparc and SystemZ
+## 0.0.5
+* API changes including cs_errno.
 
-## 3.0rc1
-* Update for C side changes
-* Add support for Xcore
-* ARM, ARM64 and X86 passing, rest waiting for upstream
+## 0.0.4
+* Verify MIPS support, tests, slight API changes
 
-## 3.0rc3
-* Generic groups ( CS_GRP_JUMP, CS_GRP_CALL etc)
-* Mips 32R6 + MICRO
-* Many constant changes
-* PPC CRX operand
-* X86: added prefixed symbols
-* THIS IS A BREAKING CHANGE ( even from rc1 )
+## 0.0.3
+* Refactoring and cosmetics
 
-## 3.0
-* See https://github.com/aquynh/capstone/wiki/ChangeLog-since-3.0-rc3
-* Shouldn't be breaking, most changes are internal.
+## 0.0.2
+* Update tests, add syntax sugar
 
-## 3.0.3-rc1
-* Internal binding updates, updated some test specs.
+## 0.0.1
+* Alpha release.

data/README.md

@@ -1,12 +1,13 @@
+[![Gem Version](https://badge.fury.io/rb/crabstone.svg)](https://badge.fury.io/rb/crabstone)
+[![Build Status](https://github.com/david942j/crabstone/workflows/build/badge.svg)](https://github.com/david942j/crabstone/actions)
+[![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
 ====
 
-STATUS
-===
-
-Hopefully working.
-
-Current Library binding: 3.0.3-rc1
+Current library support: Capstone 3 \& 4
 ----
 
 ( FROM THE CAPSTONE README )
@@ -17,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:
@@ -41,55 +51,43 @@ To install:
 First install the capstone library from either https://github.com/aquynh/capstone
 or http://www.capstone-engine.org
 
-Then (until we publish a gem) clone the repo, then do this:
+Then:
 
 ```bash
-gem build crabstone.gemspec
-gem install crabstone-3.0.3.gem
-rake test
+gem install crabstone
 ```
 
 To write code:
 ----
 
-Check the tests for more examples. Here is "Hello World":
+Check the tests in [Capstone](https://github.com/aquynh/capstone) for more examples. Here is "Hello World":
 ```ruby
+
 require 'crabstone'
 include Crabstone
-
-arm = (
-  "\xED\xFF\xFF\xEB\x04\xe0\x2d\xe5\x00\x00\x00\x00\xe0\x83\x22" <<
+arm =
+  "\xED\xFF\xFF\xEB\x04\xe0\x2d\xe5\x00\x00\x00\x00\xe0\x83\x22" \
   "\xe5\xf1\x02\x03\x0e\x00\x00\xa0\xe3\x02\x30\xc1\xe7\x00\x00\x53\xe3"
-)
 
 begin
-  
   cs = Disassembler.new(ARCH_ARM, MODE_ARM)
-  puts "Hello from Capstone v #{cs.version.join('.')}!"
-  puts "Disasm:"
+  puts "Hello from Capstone v#{cs.version.join('.')}!"
+  puts 'Disasm:'
 
   begin
-    cs.disasm(arm, 0x1000).each {|i|
-      printf("0x%x:\t%s\t\t%s\n",i.address, i.mnemonic, i.op_str)
-    }
-  rescue
-    fail "Disassembly error: #{$!}"
+    cs.disasm(arm, 0x1000).each do |i|
+      printf("0x%x:\t%s\t\t%s\n", i.address, i.mnemonic, i.op_str)
+    end
+  rescue StandardError => e
+    raise "Disassembly error: #{e.message}"
   ensure
     cs.close
   end
-
-rescue
-  fail "Unable to open engine: #{$!}"
+rescue StandardError => e
+  raise "Unable to open engine: #{e.message}"
 end
 ```
 
-Interpreter Support:
-----
-
-I test with JRuby >= 1.7.8, MRI >= 2.0.0. If it doesn't work with any of those
-it's a bug. If it doesn't work with like Rubinius or REE or 1.8 or whatever then
-"patches welcome". ( AFAIK it does, actually, work with rbx )
-
 Contributing:
 ----
 
@@ -97,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/{arch → crabstone/arch/3}/arm.rb

@@ -1,15 +1,14 @@
-# Library by Nguyen Anh Quynh
-# Original binding by Nguyen Anh Quynh and Tan Sheng Di
-# Additional binding work by Ben Nagy
-# (c) 2013 COSEINC. All Rights Reserved.
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
 
 require 'ffi'
 
+require 'crabstone/arch/extension'
 require_relative 'arm_const'
 
 module Crabstone
   module ARM
-
     class OperandShift < FFI::Struct
       layout(
         :type, :uint,
@@ -17,7 +16,7 @@ module Crabstone
       )
     end
 
-    class MemoryOperand < FFI::Struct
+    class OperandMemory < FFI::Struct
       layout(
         :base, :uint,
         :index, :uint,
@@ -29,9 +28,9 @@ module Crabstone
     class OperandValue < FFI::Union
       layout(
         :reg, :uint,
-        :imm, :int32,
+        :imm, :int,
         :fp, :double,
-        :mem, MemoryOperand,
+        :mem, OperandMemory,
         :setend, :int
       )
     end
@@ -45,29 +44,29 @@ module Crabstone
         :subtracted, :bool
       )
 
-      def value
-        case self[:type]
-        when *[OP_REG, OP_SYSREG]
-          self[:value][:reg]
-        when *[OP_IMM, OP_CIMM, OP_PIMM]
-          self[:value][:imm]
-        when OP_MEM
-          self[:value][:mem]
-        when OP_FP
-          self[:value][:fp]
-        when OP_SETEND
-          self[:value][:setend]
-        else
-          nil
-        end
-      end
+      include Crabstone::Extension::Operand
 
       def reg?
-        [OP_REG, OP_SYSREG].include? self[:type]
+        [
+          OP_REG,
+          OP_SYSREG
+        ].include?(self[:type])
       end
 
       def imm?
-        [OP_IMM, OP_CIMM, OP_PIMM].include? self[:type]
+        [
+          OP_IMM,
+          OP_CIMM,
+          OP_PIMM
+        ].include?(self[:type])
+      end
+
+      def mem?
+        self[:type] == OP_MEM
+      end
+
+      def fp?
+        self[:type] == OP_FP
       end
 
       def cimm?
@@ -78,30 +77,13 @@ module Crabstone
         self[:type] == OP_PIMM
       end
 
-      def mem?
-        self[:type] == OP_MEM
-      end
-
-      def fp?
-        self[:type] == OP_FP
+      def setend?
+        self[:type] == OP_SETEND
       end
 
       def sysreg?
         self[:type] == OP_SYSREG
       end
-
-      def valid?
-        [
-          OP_MEM,
-          OP_IMM,
-          OP_CIMM,
-          OP_PIMM,
-          OP_FP,
-          OP_REG,
-          OP_SYSREG,
-          OP_SETEND
-        ].include? self[:type]
-      end
     end
 
     class Instruction < FFI::Struct
@@ -119,10 +101,7 @@ module Crabstone
         :operands, [Operand, 36]
       )
 
-      def operands
-        self[:operands].take_while {|op| op[:type].nonzero?}
-      end
-
+      include Crabstone::Extension::Instruction
     end
   end
 end

data/lib/crabstone/arch/3/arm64.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# THIS FILE WAS AUTO-GENERATED -- DO NOT EDIT!
+
+require 'ffi'
+
+require 'crabstone/arch/extension'
+require_relative 'arm64_const'
+
+module Crabstone
+  module ARM64
+    class OperandShift < FFI::Struct
+      layout(
+        :type, :uint,
+        :value, :uint
+      )
+    end
+
+    class OperandMemory < FFI::Struct
+      layout(
+        :base, :uint,
+        :index, :uint,
+        :disp, :int
+      )
+    end
+
+    class OperandValue < FFI::Union
+      layout(
+        :reg, :uint,
+        :imm, :long,
+        :fp, :double,
+        :mem, OperandMemory,
+        :pstate, :int,
+        :sys, :uint,
+        :prefetch, :int,
+        :barrier, :int
+      )
+    end
+
+    class Operand < FFI::Struct
+      layout(
+        :vector_index, :int,
+        :vas, :int,
+        :vess, :int,
+        :shift, OperandShift,
+        :ext, :uint,
+        :type, :uint,
+        :value, OperandValue
+      )
+      def shift?
+        self[:shift][:type] != SFT_INVALID
+      end
+
+      def ext?
+        self[:ext] != EXT_INVALID
+      end
+
+      include Crabstone::Extension::Operand
+
+      def reg?
+        [
+          OP_REG,
+          OP_REG_MRS,
+          OP_REG_MSR
+        ].include?(self[:type])
+      end
+
+      def imm?
+        [
+          OP_IMM,
+          OP_CIMM
+        ].include?(self[:type])
+      end
+
+      def mem?
+        self[:type] == OP_MEM
+      end
+
+      def fp?
+        self[:type] == OP_FP
+      end
+
+      def cimm?
+        self[:type] == OP_CIMM
+      end
+
+      def reg_mrs?
+        self[:type] == OP_REG_MRS
+      end
+
+      def reg_msr?
+        self[:type] == OP_REG_MSR
+      end
+
+      def pstate?
+        self[:type] == OP_PSTATE
+      end
+
+      def sys?
+        self[:type] == OP_SYS
+      end
+
+      def prefetch?
+        self[:type] == OP_PREFETCH
+      end
+
+      def barrier?
+        self[:type] == OP_BARRIER
+      end
+    end
+
+    class Instruction < FFI::Struct
+      layout(
+        :cc, :uint,
+        :update_flags, :bool,
+        :writeback, :bool,
+        :op_count, :uint8,
+        :operands, [Operand, 8]
+      )
+
+      include Crabstone::Extension::Instruction
+    end
+  end
+end