ronin-asm 0.1.0

data/spec/shellcode_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'ronin/asm/shellcode'
+
+describe ASM::Shellcode do
+  describe "#assemble", :yasm => true do
+    subject do
+      described_class.new do
+        xor   eax,  eax
+        push  eax
+        push  0x68732f2f
+        push  0x6e69622f
+        mov   esp,  ebx
+        push  eax
+        push  ebx
+        mov   esp,  ecx
+        xor   edx,  edx
+        mov   0xb,  al
+        int   0x80
+      end
+    end
+
+    let(:shellcode) { "f1\xC0fPfh//shfh/binf\x89\xE3fPfSf\x89\xE1f1\xD2\xB0\v\xCD\x80" }
+
+    it "assemble down to raw machine code" do
+      subject.assemble.should == shellcode
+    end
+
+    context "with :syntax => :intel" do
+      it "assemble down to raw machine code" do
+        subject.assemble(:syntax => :intel).should == shellcode
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'ronin/asm/version'
+
+include Ronin
+include Ronin::ASM
+
+RSpec.configure do |specs|
+  specs.treat_symbols_as_metadata_keys_with_true_values = true
+  specs.filter_run_excluding :yasm
+end

data/spec/syntax/att_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+require 'ronin/asm/syntax/att'
+require 'ronin/asm/register'
+require 'ronin/asm/immediate_operand'
+require 'ronin/asm/memory_operand'
+require 'ronin/asm/instruction'
+require 'ronin/asm/program'
+
+describe ASM::Syntax::ATT do
+  subject { described_class }
+
+  describe "emit_register" do
+    let(:register) { Register.new(:eax, 4) }
+
+    it "should prepend a '%' to the register name" do
+      subject.emit_register(register).should == "%eax"
+    end
+  end
+
+  describe "emit_immediate_operand" do
+    let(:operand) { ImmediateOperand.new(255, 1) }
+
+    it "should prepend a '$' to the immediate" do
+      subject.emit_immediate_operand(operand).should == "$0xff"
+    end
+  end
+
+  describe "emit_memory_operand" do
+    let(:register) { Register.new(:eax, 4)   }
+    let(:operand)  { MemoryOperand.new(register) }
+
+    it "should enclose the memory in parenthesis" do
+      subject.emit_memory_operand(operand).should == "(%eax)"
+    end
+
+    context "with an offset" do
+      let(:offset)  { 255 }
+      let(:operand) { MemoryOperand.new(register,offset) }
+
+      it "should prepend the offset as an integer" do
+        subject.emit_memory_operand(operand).should == "0xff(%eax)"
+      end
+
+      context "when 0" do
+        let(:operand) { MemoryOperand.new(register,0) }
+
+        it "should omit the offset" do
+          subject.emit_memory_operand(operand).should == "(%eax)"
+        end
+      end
+    end
+
+    context "with an index" do
+      let(:index)   { Register.new(:esi, 4) }
+      let(:operand) { MemoryOperand.new(register,0,index) }
+
+      it "should include the index argument" do
+        subject.emit_memory_operand(operand).should == "(%eax,%esi)"
+      end
+
+      context "with a scale" do
+        let(:scale)   { 4 }
+        let(:operand) { MemoryOperand.new(register,0,index,scale) }
+
+        it "should prepend the scale argument as a decimal" do
+          subject.emit_memory_operand(operand).should == "(%eax,%esi,#{scale})"
+        end
+      end
+    end
+  end
+
+  describe "emit_instruction" do
+    context "with no operands" do
+      let(:instruction) { Instruction.new(:ret, []) }
+
+      it "should emit the instruction name" do
+        subject.emit_instruction(instruction).should == 'ret'
+      end
+    end
+
+    context "with one operand" do
+      context "with width of 1" do
+        let(:immediate)   { ImmediateOperand.new(0x80, 1) }
+        let(:instruction) { Instruction.new(:int, [immediate]) }
+
+        it "should not append a size specifier to the instruction name" do
+          subject.emit_instruction(instruction).should == "int\t$0x80"
+        end
+      end
+    end
+
+    context "with multiple operands" do
+      let(:register)    { Register.new(:eax, 4) }
+      let(:immediate)   { ImmediateOperand.new(0xff, 1)  }
+      let(:instruction) { Instruction.new(:mov, [immediate, register]) }
+
+      it "should add a size specifier to the instruction name" do
+        subject.emit_instruction(instruction).should =~ /^movl/
+      end
+
+      it "should emit the operands" do
+        subject.emit_instruction(instruction).should == "movl\t$0xff,\t%eax"
+      end
+    end
+  end
+
+  describe "emit_program" do
+    let(:program) do
+      Program.new do
+        mov 0xff, eax
+        ret
+      end
+    end
+
+    it "should output the _start label and the program" do
+      asm = subject.emit_program(program)
+
+      asm.should == [
+        "_start:",
+        "\tmovl\t$0xff,\t%eax",
+        "\tret",
+        ""
+      ].join($/)
+    end
+
+    context "when emitting labels" do
+      let(:program) do
+        Program.new do
+          mov 0, eax
+
+          _loop do
+            inc eax
+            cmp eax, 10
+            jl  :_loop
+          end
+
+          ret
+        end
+      end
+
+      it "should emit both labels and instructions" do
+        subject.emit_program(program).should == [
+          "_start:",
+          "\tmovl\t$0x0,\t%eax",
+          "_loop:",
+          "\tincl\t%eax",
+          "\tcmpl\t%eax,\t$0xa",
+          "\tjl\t_loop",
+          "\tret",
+          ""
+        ].join($/)
+      end
+    end
+
+    context "when the program arch is :amd64" do
+      let(:program) do
+        Program.new(:arch => :amd64) do
+          push rax
+          push rbx
+          mov 0xff, rax
+          ret
+        end
+      end
+
+      it "should include start with the '.code64' directive" do
+        subject.emit_program(program).should =~ /^\.code64$/
+      end
+    end
+  end
+end

data/spec/syntax/common_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+require 'ronin/asm/syntax/common'
+
+describe ASM::Syntax::Common do
+  subject { described_class }
+
+  describe "emit_keyword" do
+    let(:name) { :_start }
+
+    it "should convert a keyword to a String" do
+      subject.emit_keyword(name).should == name.to_s
+    end
+  end
+
+  describe "emit_integer" do
+    let(:integer)     { 255    }
+    let(:hexadecimal) { "0xff" }
+
+    it "should convert it into a hexadecimal value" do
+      subject.emit_integer(integer).should == hexadecimal
+    end
+
+    context "when given a negative number" do
+      let(:negative)    { -255    }
+      let(:hexadecimal) { "-0xff" }
+
+      it "should convert it into a hexadecimal value" do
+        subject.emit_integer(negative).should == hexadecimal
+      end
+    end
+  end
+
+  describe "emit_label" do
+    let(:name)  { :_start   }
+    let(:label) { '_start:' }
+
+    it "should append a ':' to the name" do
+      subject.emit_label(name).should == label
+    end
+  end
+end

data/spec/syntax/intel_spec.rb

@@ -0,0 +1,156 @@
+require 'spec_helper'
+
+require 'ronin/asm/syntax/intel'
+require 'ronin/asm/register'
+require 'ronin/asm/immediate_operand'
+require 'ronin/asm/memory_operand'
+require 'ronin/asm/instruction'
+require 'ronin/asm/program'
+
+describe ASM::Syntax::Intel do
+  subject { described_class }
+
+  describe "emit_register" do
+    let(:register) { Register.new(:eax, 4) }
+
+    it "should return the register name" do
+      subject.emit_register(register).should == "eax"
+    end
+  end
+
+  describe "emit_immediate_operand" do
+    let(:operand) { ImmediateOperand.new(255, 1) }
+
+    it "should prepend a size specifier" do
+      subject.emit_immediate_operand(operand).should == "BYTE 0xff"
+    end
+  end
+
+  describe "emit_memory_operand" do
+    let(:register) { Register.new(:eax, 4)   }
+    let(:operand)  { MemoryOperand.new(register) }
+
+    it "should enclose the memory in brackets" do
+      subject.emit_memory_operand(operand).should == "[eax]"
+    end
+
+    context "with an offset" do
+      let(:offset)  { 255 }
+      let(:operand) { MemoryOperand.new(register,offset) }
+
+      it "should add the offset to the base" do
+        subject.emit_memory_operand(operand).should == "[eax+0xff]"
+      end
+
+      context "when 0" do
+        let(:operand) { MemoryOperand.new(register,0) }
+
+        it "should omit the offset" do
+          subject.emit_memory_operand(operand).should == "[eax]"
+        end
+      end
+    end
+
+    context "with an index" do
+      let(:index)   { Register.new(:esi, 4) }
+      let(:operand) { MemoryOperand.new(register,0,index) }
+
+      it "should add the index to the base" do
+        subject.emit_memory_operand(operand).should == "[eax+esi]"
+      end
+
+      context "with a scale" do
+        let(:scale)   { 4 }
+        let(:operand) { MemoryOperand.new(register,0,index,scale) }
+
+        it "should multiple the index by the scale" do
+          subject.emit_memory_operand(operand).should == "[eax+esi*0x4]"
+        end
+      end
+    end
+  end
+
+  describe "emit_instruction" do
+    context "with no operands" do
+      let(:instruction) { Instruction.new(:ret, []) }
+
+      it "should emit the instruction name" do
+        subject.emit_instruction(instruction).should == 'ret'
+      end
+    end
+
+    context "with multiple operands" do
+      let(:register)    { Register.new(:eax, 4) }
+      let(:immediate)   { ImmediateOperand.new(0xff, 1)  }
+      let(:instruction) { Instruction.new(:mov, [immediate, register]) }
+
+      it "should emit the operands" do
+        subject.emit_instruction(instruction).should == "mov\teax,\tBYTE 0xff"
+      end
+    end
+  end
+
+  describe "emit_program" do
+    let(:program) do
+      Program.new do
+        mov 0xff, eax
+        ret
+      end
+    end
+
+    it "should output the _start label and the program" do
+      asm = subject.emit_program(program)
+
+      asm.should == [
+        "_start:",
+        "\tmov\teax,\tBYTE 0xff",
+        "\tret",
+        ""
+      ].join($/)
+    end
+
+    context "when emitting labels" do
+      let(:program) do
+        Program.new do
+          mov 0, eax
+
+          _loop do
+            inc eax
+            cmp eax, 10
+            jl  :_loop
+          end
+
+          ret
+        end
+      end
+
+      it "should emit both labels and instructions" do
+        subject.emit_program(program).should == [
+          "_start:",
+          "\tmov\teax,\tBYTE 0x0",
+          "_loop:",
+          "\tinc\teax",
+          "\tcmp\tBYTE 0xa,\teax",
+          "\tjl\t_loop",
+          "\tret",
+          ""
+        ].join($/)
+      end
+    end
+
+    context "when the program arch is :amd64" do
+      let(:program) do
+        Program.new(:arch => :amd64) do
+          push rax
+          push rbx
+          mov 0xff, rax
+          ret
+        end
+      end
+
+      it "should include start with the '.code64' directive" do
+        subject.emit_program(program).should =~ /^BITS 64$/
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: ronin-asm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: data_paths
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: ruby-yasm
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: ronin-asm is a Ruby DSL for crafting Assmebly programs and Shellcode.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- COPYING.txt
+- ChangeLog.md
+- README.md
+files:
+- .document
+- .gemtest
+- .gitignore
+- .rspec
+- .yardopts
+- COPYING.txt
+- ChangeLog.md
+- Gemfile
+- README.md
+- Rakefile
+- data/ronin/asm/freebsd/amd64/syscalls.yml
+- data/ronin/asm/freebsd/x86/syscalls.yml
+- data/ronin/asm/linux/amd64/syscalls.yml
+- data/ronin/asm/linux/x86/syscalls.yml
+- data/ronin/gen/asm/source_file.s.erb
+- gemspec.yml
+- lib/ronin/asm.rb
+- lib/ronin/asm/archs.rb
+- lib/ronin/asm/archs/amd64.rb
+- lib/ronin/asm/archs/x86.rb
+- lib/ronin/asm/asm.rb
+- lib/ronin/asm/config.rb
+- lib/ronin/asm/immediate_operand.rb
+- lib/ronin/asm/instruction.rb
+- lib/ronin/asm/memory_operand.rb
+- lib/ronin/asm/os.rb
+- lib/ronin/asm/os/freebsd.rb
+- lib/ronin/asm/os/linux.rb
+- lib/ronin/asm/os/os.rb
+- lib/ronin/asm/program.rb
+- lib/ronin/asm/register.rb
+- lib/ronin/asm/shellcode.rb
+- lib/ronin/asm/syntax.rb
+- lib/ronin/asm/syntax/att.rb
+- lib/ronin/asm/syntax/common.rb
+- lib/ronin/asm/syntax/intel.rb
+- lib/ronin/asm/version.rb
+- ronin-asm.gemspec
+- spec/asm_spec.rb
+- spec/helpers/database.rb
+- spec/immediate_operand_spec.rb
+- spec/instruction_spec.rb
+- spec/memory_operand_spec.rb
+- spec/program_spec.rb
+- spec/register_spec.rb
+- spec/shellcode_spec.rb
+- spec/spec_helper.rb
+- spec/syntax/att_spec.rb
+- spec/syntax/common_spec.rb
+- spec/syntax/intel_spec.rb
+homepage: https://github.com/ronin-ruby/ronin-asm#readme
+licenses:
+- GPL-3
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- yasm >= 0.6.0
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby DSL for crafting Assembly programs and Shellcode.
+test_files: []