ffi-udis86 0.1.0

data/lib/udis86/version.rb

@@ -0,0 +1,6 @@
+module FFI
+  module UDis86
+    # udis86-ffi version
+    VERSION = '0.1.0'
+  end
+end

data/spec/helpers/files.rb

@@ -0,0 +1,11 @@
+require 'udis86/ud'
+
+require 'spec_helper'
+
+module Helpers
+  FILES_DIR = File.expand_path(File.join(File.dirname(__FILE__),'files'))
+
+  def ud_file(name,&block)
+    UD.open(File.join(FILES_DIR,name.to_s),&block)
+  end
+end

data/spec/helpers/files/operands_index_scale

@@ -0,0 +1 @@
+�D

data/spec/helpers/files/operands_index_scale.s

@@ -0,0 +1,2 @@
+_start:
+	movl	(%esp,%eax,2),%ebx

data/spec/helpers/files/operands_memory

@@ -0,0 +1 @@
+�$

data/spec/helpers/files/operands_memory.s

@@ -0,0 +1,2 @@
+_start:
+	movl	(%esp),%eax

data/spec/helpers/files/operands_offset

@@ -0,0 +1 @@
+�\$

data/spec/helpers/files/operands_offset.s

@@ -0,0 +1,2 @@
+_start:
+	movl	0x10(%esp),%ebx

data/spec/helpers/files/operands_simple.s

@@ -0,0 +1,2 @@
+_start:
+	movl	$0x10,%eax

data/spec/helpers/files/simple

@@ -0,0 +1 @@
+���

data/spec/helpers/files/simple.s

@@ -0,0 +1,4 @@
+_start:
+	nop
+	nop
+	ret

data/spec/helpers/operands.rb

@@ -0,0 +1,14 @@
+require 'udis86/ud'
+
+require 'spec_helper'
+require 'helpers/files'
+
+module Helpers
+  def ud_operands(name)
+    ud_file(name) do |ud|
+      ud.next_insn
+
+      return ud.operands
+    end
+  end
+end

data/spec/operand_spec.rb

@@ -0,0 +1,72 @@
+require 'udis86/operand'
+require 'udis86/ud'
+
+require 'spec_helper'
+require 'helpers/operands'
+
+describe Operand do
+  include Helpers
+
+  it "should provide the type of the operand" do
+    operands = ud_operands('operands_simple')
+
+    operands[0].type.should == :ud_op_reg
+    operands[1].type.should == :ud_op_imm
+  end
+
+  it "should provide the size of the operand" do
+    operands = ud_operands('operands_simple')
+
+    operands[1].size.should == 32
+  end
+
+  it "should provide the value of the operand" do
+    operands = ud_operands('operands_simple')
+
+    operands[1].value.signed_byte.should == 0x10
+    operands[1].value.unsigned_byte.should == 0x10
+  end
+
+  it "should specify value as nil for register operands" do
+    operands = ud_operands('operands_simple')
+
+    operands[0].value.should be_nil
+  end
+
+  it "should provide the base of memory operands" do
+    operands = ud_operands('operands_memory')
+
+    operands[1].type.should == :ud_op_mem
+    operands[1][:base].should == :ud_r_esp
+    operands[1].base.should == :esp
+  end
+
+  it "should provide the index of memory operands" do
+    operands = ud_operands('operands_index_scale')
+
+    operands[1].type.should == :ud_op_mem
+    operands[1][:index].should == :ud_r_eax
+    operands[1].index.should == :eax
+  end
+
+  it "should provide the offset of memory operands" do
+    operands = ud_operands('operands_offset')
+
+    operands[1].type.should == :ud_op_mem
+    operands[1].offset.byte.should == 0x10
+  end
+
+  it "should provide the scale of memory operands" do
+    operands = ud_operands('operands_index_scale')
+
+    operands[1].type.should == :ud_op_mem
+    operands[1].scale.should == 2
+  end
+
+  it "should provide the register name for register operands" do
+    operands = ud_operands('operands_simple')
+
+    operands[0][:base].should == :ud_r_eax
+    operands[0].reg.should == :eax
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+gem 'rspec', '>=1.3.0'
+require 'spec'
+
+require 'udis86/version'
+
+include FFI
+include FFI::UDis86

data/spec/ud_spec.rb

@@ -0,0 +1,195 @@
+require 'udis86/ud'
+
+require 'spec_helper'
+require 'helpers/files'
+
+describe UD do
+  include Helpers
+
+  describe "create" do
+    it "should accept a :mode option" do
+      ud = UD.create(:mode => 16)
+      ud.mode.should == 16
+    end
+
+    it "should accept a :syntax option" do
+      lambda {
+        UD.create(:syntax => :att)
+      }.should_not raise_error(ArgumentError)
+    end
+
+    it "should accept a :vendor option" do
+      ud = UD.create(:vendor => :amd)
+      ud.vendor.should == :amd
+    end
+
+    it "should accept a :pc option" do
+      ud = UD.create(:pc => 0x400000)
+      ud.pc.should == 0x400000
+    end
+
+    it "should accept a :buffer option" do
+      ud = UD.create(:buffer => "\x90\x90\x90")
+      ud.input_buffer.should == "\x90\x90\x90"
+    end
+
+    it "should accept a block as an input callback" do
+      bytes = [0x80, -1]
+
+      ud = UD.create { |ud| bytes.shift }
+
+      ud.next_insn.should == 1
+      ud.to_hex.should == '80'
+
+      ud.next_insn.should == 0
+    end
+  end
+
+  describe "open" do
+    it "should be able to open files" do
+      UD.open(File.join(Helpers::FILES_DIR,'simple')) do |ud|
+        ud.next_insn.should == 1
+        ud.to_hex.should == '90'
+
+        ud.next_insn.should == 1
+        ud.to_hex.should == '90'
+
+        ud.next_insn.should == 1
+        ud.to_hex.should == 'c3'
+
+        ud.next_insn.should == 0
+      end
+    end
+  end
+
+  describe "disassember" do
+    before(:each) do
+      File.open(File.join(Helpers::FILES_DIR,'simple'),'rb') do |file|
+        @string = file.read
+        @ud = UD.create(:buffer => @string)
+      end
+    end
+
+    it "should allow setting the mode" do
+      @ud.mode = 64
+
+      @ud.mode.should == 64
+    end
+
+    it "should allow setting the syntax" do
+      lambda {
+        @ud.syntax = :att
+      }.should_not raise_error(RuntimeError)
+    end
+
+    it "should allow setting the vendor" do
+      @ud.vendor = :amd
+
+      @ud.vendor.should == :amd
+    end
+
+    it "should allow setting the program counter (PC)" do
+      @ud.pc = 0x400000
+
+      @ud.pc.should == 0x400000
+    end
+
+    it "should provide read access to the input buffer" do
+      @ud.input_buffer.should == @string
+    end
+
+    it "should allow setting the input buffer" do
+      new_input = "\xc3"
+
+      @ud.input_buffer = new_input
+      @ud.input_buffer.should == new_input
+    end
+
+    it "should allow setting an input callback" do
+      bytes = [0x90, 0xc3]
+
+      @ud.input_callback do |ud|
+        bytes.shift || -1
+      end
+
+      @ud.next_insn.should == 1
+      @ud.to_asm.should == 'nop '
+
+      @ud.next_insn.should == 1
+      @ud.to_asm.should == 'ret '
+
+      @ud.next_insn.should == 0
+    end
+
+    it "should allow the skipping of input bytes" do
+      @ud.skip(2)
+
+      @ud.next_insn
+      @ud.to_asm.should == 'ret '
+    end
+
+    it "should get the next instruction" do
+      @ud.next_insn.should == 1
+      @ud.to_asm.should == 'nop '
+
+      @ud.next_insn.should == 1
+      @ud.to_asm.should == 'nop '
+
+      @ud.next_insn.should == 1
+      @ud.to_asm.should == 'ret '
+
+      @ud.next_insn.should == 0
+    end
+
+    it "should specify the instruction length" do
+      @ud.next_insn.should == 1
+      @ud.insn_length.should == 1
+    end
+
+    it "should specify the instruction offset" do
+      @ud.next_insn.should == 1
+      @ud.next_insn.should == 1
+
+      @ud.insn_offset.should == 1
+    end
+
+    it "should provide a pointer to the instruction bytes" do
+      @ud.next_insn.should == 1
+
+      @ud.insn_ptr.get_string(0).should == "\x90"
+    end
+
+    it "should provide hex form of the bytes" do
+      @ud.next_insn.should == 1
+      @ud.to_hex.should == '90'
+    end
+
+    it "should provide the mnemonic code of the disassembled instructions" do
+      @ud.next_insn.should == 1
+      @ud.mnemonic_code.should == :ud_inop
+    end
+
+    it "should provide the mnemonic of the disassembled instructions" do
+      @ud.next_insn.should == 1
+      @ud.mnemonic.should == :nop
+    end
+
+    it "should provide the assembly form of the disassembled instructions" do
+      @ud.next_insn.should == 1
+      @ud.to_asm.should == 'nop '
+    end
+
+    it "should provide the disassembled operands of the instruction" do
+      @ud.next_insn.should == 1
+      @ud.operands.should == []
+    end
+
+    it "should disassemble every byte" do
+      ops = ['nop ', 'nop ', 'ret ']
+
+      @ud.disassemble do |ud|
+        ud.to_asm.should == ops.shift
+      end
+    end
+  end
+end

data/spec/udis86_spec.rb

@@ -0,0 +1,25 @@
+require 'udis86/version'
+
+require 'spec_helper'
+
+describe UDis86 do
+  it "should have a VERSION constant" do
+    UDis86.const_defined?('VERSION').should == true
+  end
+
+  describe "types" do
+    it "should define syntices" do
+      SYNTAX[:att].should == :ud_translate_att
+      SYNTAX[:intel].should == :ud_translate_intel
+    end
+
+    it "should define mappings from :ud_type to register names" do
+      ud_type = UDis86.enum_type(:ud_type)
+
+      UDis86::REGS.each do |type,name|
+        :"ud_r_#{name}".should == type
+        ud_type[ud_type[type]].should == type
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-udis86
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+description: Ruby FFI bindings for udis86, a x86 and x86-64 disassembler.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files: 
+- .gitignore
+- .specopts
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ffi-udis86.gemspec
+- lib/udis86.rb
+- lib/udis86/ffi.rb
+- lib/udis86/operand.rb
+- lib/udis86/operand_pointer.rb
+- lib/udis86/operand_value.rb
+- lib/udis86/types.rb
+- lib/udis86/ud.rb
+- lib/udis86/version.rb
+- spec/helpers/files.rb
+- spec/helpers/files/operands_index_scale
+- spec/helpers/files/operands_index_scale.s
+- spec/helpers/files/operands_memory
+- spec/helpers/files/operands_memory.s
+- spec/helpers/files/operands_offset
+- spec/helpers/files/operands_offset.s
+- spec/helpers/files/operands_simple
+- spec/helpers/files/operands_simple.s
+- spec/helpers/files/simple
+- spec/helpers/files/simple.s
+- spec/helpers/operands.rb
+- spec/operand_spec.rb
+- spec/spec_helper.rb
+- spec/ud_spec.rb
+- spec/udis86_spec.rb
+has_rdoc: yard
+homepage: http://github.com/sophsec/ffi-udis86
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby FFI bindings for udis86, a x86 and x86-64 disassembler.
+test_files: 
+- spec/spec_helper.rb
+- spec/udis86_spec.rb
+- spec/ud_spec.rb
+- spec/helpers/files.rb
+- spec/helpers/operands.rb
+- spec/operand_spec.rb