ronin-code-asm 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afdbeb043e51ce8513e7d833b7c8a730ee0488e579bc71c17044137c6b60dbe9
+  data.tar.gz: 0fb69ebc839c8e1079122e5b962967b094d97fe48955e21ab09896b8f4c65fd3
+SHA512:
+  metadata.gz: f1dca72988f3754272eb3e43d63292ef8209b94cd472f357c703f5cc695a4361d79d0da51fcd589078177c2a42412fd00a838ed47542a5865c199e05dc086345
+  data.tar.gz: b4d1e207dd1bf4d47b88cab47423cd35610b66fb1f1580897acad9d961a2dfa9218e29e8a9564f89fe5e31cf8a18ee7d012c4f303e203aca1dc40c174253d14a

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+- 
+ChangeLog.md
+COPYING.txt

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+tab_width = 8
+trim_trailing_whitespace = true
+
+[{Gemfile,Rakefile,*.rb,*.gemspec,*.yml}]
+indent_style = space
+indent_size = 2

data/.github/workflows/ruby.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          # - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: |
+          sudo apt update -y && \
+          sudo apt install -y --no-install-recommends --no-install-suggests yasm
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,11 @@
+doc
+pkg
+vendor/cache
+Gemfile.lock
+.bundle
+.DS_Store
+.yardoc
+*.db
+*.log
+*.swp
+*~

data/.mailmap

@@ -0,0 +1 @@
+Postmodern <postmodern.mod3@gmail.com>	postmodern <postmodern.mod3@gmail.com>

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ronin ASM Documentation' --protected

data/COPYING.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/ChangeLog.md

@@ -0,0 +1,44 @@
+### 1.0.0 / 2023-XX-XX
+
+* Require `ruby` >= 3.0.0.
+* Renamed the gem to `ronin-code-asm`.
+* Require `ruby-yasm` ~> 0.3.
+* Added {Ronin::Code::ASM::OS.[]}.
+* Removed the `data_paths` gem dependency.
+
+### 0.2.0 / 2013-06-17
+
+* Require [Ruby] >= 1.9.1.
+* Added `Ronin::ASM::Syntax::ATT.emit_section` and
+  `Ronin::ASM::Syntax::Intel.emit_section`.
+* Added `Ronin::ASM::Syntax::ATT.emit_prologue` and
+  `Ronin::ASM::Syntax::Intel.emit_prologue`.
+* `Ronin::ASM::Instruction` now assumes Intel operand order:
+
+      mov eax, 0x41
+
+* `Ronin::ASM::Program#byte`, `Ronin::ASM::Program#word`, 
+  `Ronin::ASM::Program#dword` and `Ronin::ASM::Program#qword` methods can now
+  accept `Ronin::ASM::MemoryOperand`s.
+
+      mov bx, word(ebp+8)
+
+* `Ronin::ASM::Program#to_asm` now emits Intel syntax by default.
+* `Ronin::ASM::Program#assemble` now uses Intel syntax by default.
+* `Ronin::ASM::Syntax::ATT` emit `.code32` directive to forcibly enable 32-bit
+  mode for the x86 architecture. [YASM][yasm] apparently defaults to 16-bit
+  mode.
+* `Ronin::ASM::Syntax::Intel` emit `BITS 32` directive to forcibly enable
+  32-bit mode for the x86 architecture.
+
+### 0.1.0 / 2012-08-26
+
+* Initial release:
+  * Provides a Ruby DSL for writing Assembly programs.
+    * Supports X86 and AMD64 instruction sets.
+    * Supports ATT and Intel syntax.
+  * Uses [yasm] to assemble the programs.
+  * Supports assembling Shellcode.
+
+[Ruby]: http://www.ruby-lang.org
+[yasm]: http://yasm.tortall.net/

data/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'jruby-openssl',	'~> 0.7', platform: :jruby
+
+# gem 'ruby-yasm', '~> 0.3', github: 'postmodern/ruby-yasm',
+#                            branch: 'main'
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks',  '~> 0.1'
+
+  gem 'rspec',           '~> 3.0'
+  gem 'simplecov',       '~> 0.20'
+
+  gem 'kramdown',        '~> 2.3'
+  gem 'redcarpet',       platform: :mri
+  gem 'yard',            '~> 0.9'
+  gem 'yard-spellcheck', require: false
+
+  gem 'dead_end',        require: false
+  gem 'sord',            require: false
+  gem 'stackprof',       require: false
+end

data/README.md

@@ -0,0 +1,166 @@
+# ronin-code-asm
+
+[![CI](https://github.com/ronin-rb/ronin-code-asm/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-asm/actions/workflows/ruby.yml)
+[![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-code-asm.svg)](https://codeclimate.com/github/ronin-rb/ronin-asm)
+
+* [Source](https://github.com/ronin-rb/ronin-code-asm)
+* [Issues](https://github.com/ronin-rb/ronin-code-asm/issues)
+* [Documentation](https://ronin-rb.dev/docs/ronin-code-asm/frames)
+* [Discord](https://discord.gg/6WAb3PsVX9) |
+  [Twitter](https://twitter.com/ronin_rb) |
+  [Mastodon](https://infosec.exchange/@ronin_rb)
+
+## Description
+
+{Ronin::Code::ASM} is a Ruby DSL for crafting Assembly programs and Shellcode.
+
+## Features
+
+* Provides a Ruby DSL for writing Assembly programs.
+  * Supports X86 and AMD64 instruction sets.
+  * Supports ATT and Intel syntax.
+* Uses [yasm] to assemble the programs.
+* Supports assembling Shellcode.
+* Has 95% documentation coverage.
+* Has 99% test coverage.
+
+## Examples
+
+Create a program:
+
+```ruby
+asm = Ronin::Code::ASM.new do
+  push ebx
+  mov  eax, 0xc0ffee
+  pop  ebx
+  hlt
+end
+
+puts asm.to_asm
+# BITS 32
+# section .text
+# _start:
+#	push	ebx
+#	mov	eax,	WORD 0xc0ffee
+#	pop	ebx
+#	hlt
+
+puts asm.to_asm(:att)
+# .code32
+# .text
+# _start:
+#	pushl	%ebx
+#	movl	$0xc0ffee,      %eax
+#	popl	%ebx
+#	hlt
+```
+
+Create shellcode:
+
+```ruby
+shellcode = Ronin::Code::ASM::Shellcode.new(arch: :x86) do
+  xor   eax,  eax
+  push  eax
+  push  0x68732f2f
+  push  0x6e69622f
+  mov   ebx,  esp
+  push  eax
+  push  ebx
+  mov   ecx,  esp
+  xor   edx,  edx
+  mov   al,   0xb
+  int   0x80
+end
+
+shellcode.assemble
+# => "1\xC0Ph//shh/bin\x89\xDCPS\x89\xCC1\xD2\xB0\v\xCD\x80"
+```
+
+### Immediate Operands
+
+Immediate operands can be Integers or `nil`:
+
+```ruby
+mov eax, 0xff
+mov ebx, nil
+```
+
+The size of the operand can also be specified explicitly:
+
+```ruby
+push byte(0xff)
+push word(0xffff)
+push dword(0xffffffff)
+push qword(0xffffffffffffffff)
+```
+
+### Memory Operands
+
+Memory operands can be expressed as arithmetic on registers:
+
+```ruby
+mov ebx, esp+8
+mov ebx, esp-8
+mov ebx, esp+esi
+mov ebx, esp+(esi*4)
+```
+
+### Labels
+
+Labels can be expressed with blocks:
+
+```ruby
+_loop do
+  inc eax
+  cmp eax, 10
+  jl :_loop
+end
+```
+
+### Syscalls
+
+If the `:os` option is specified, then syscall numbers can be looked up via the 
+`syscalls` Hash:
+
+```ruby
+Ronin::Code::ASM.new(os: 'Linux') do
+  # ...
+  mov al, syscalls[:execve]
+  int 0x80
+end
+```
+
+## Requirements
+
+* [Ruby] >= 3.0.0
+* [yasm] >= 0.6.0
+* [ruby-yasm] ~> 0.3
+
+## Install
+
+```shell
+$ gem install ronin-code-asm
+```
+
+## License
+
+ronin-code-asm - A Ruby DSL for crafting Assembly programs and shellcode.
+
+Copyright (c) 2007-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+
+ronin-code-asm is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+ronin-code-asm is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with ronin-code-asm.  If not, see <https://www.gnu.org/licenses/>.
+
+[Ruby]: https://www.ruby-lang.org
+[yasm]: https://yasm.tortall.net/
+[ruby-yasm]: https://github.com/sophsec/ruby-yasm#readme

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new(sign: {checksum: true, pgp: true})
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+task :test    => :spec
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern    = %w[spec/program_spec.rb spec/shellcode_spec.rb]
+    t.rspec_opts = '--tag integration'
+  end
+end
+
+task :test => 'spec:integration'
+
+require 'yard'
+YARD::Rake::YardocTask.new