ronin-payloads 0.1.0.beta1 → 0.1.0

data/spec/encoders/xml_encoder_spec.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/encoders/xml_encoder'
-
-describe Ronin::Payloads::Encoders::XMLEncoder do
-  it "must inherit from Ronin::Payloads::Encoders::Encoder" do
-    expect(described_class).to be < Ronin::Payloads::Encoders::Encoder
-  end
-end

data/spec/encoders_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/encoders'
-require 'ronin/payloads/root'
-
-describe Ronin::Payloads::Encoders do
-  it "must include Ronin::Core::ClassRegistry" do
-    expect(subject).to include(Ronin::Core::ClassRegistry)
-  end
-
-  it "must include Ronin::Repos::ClassDir" do
-    expect(subject).to include(Ronin::Repos::ClassDir)
-  end
-
-  it "must set .class_dir to 'ronin/payloads/encoders/builtin'" do
-    expect(subject.class_dir).to eq(
-      File.join(
-        Ronin::Payloads::ROOT, 'lib', 'ronin', 'payloads', 'encoders', 'builtin'
-      )
-    )
-  end
-
-  it "must set .repo_class_dir to 'encoders'" do
-    expect(subject.repo_class_dir).to eq('encoders')
-  end
-end

data/spec/go_payload_spec.rb

@@ -1,56 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/go_payload'
-
-describe Ronin::Payloads::GoPayload do
-  it "must inherit from Ronin::Payloads::BinaryPayload" do
-    expect(described_class.superclass).to be(Ronin::Payloads::BinaryPayload)
-  end
-
-  describe "#compile" do
-    let(:source_files) { %w[foo.go bar.go baz.go] }
-
-    it "must call system with `go build` and source files" do
-      expect(subject).to receive(:system).with(
-        'go', 'build', *source_files
-      ).and_return(true)
-
-      subject.compile(*source_files)
-    end
-
-    context "when the output: keyword is given" do
-      let(:output) { 'output' } 
-
-      it "must call system with 'go build', the output, and source files" do
-        expect(subject).to receive(:system).with(
-          'go', 'build','-o', output, *source_files
-        ).and_return(true)
-
-        subject.compile(*source_files, output: output)
-      end
-    end
-
-    context "when system() returns false" do
-      let(:source_file) { 'foo.go' }
-
-      it do
-        allow(subject).to receive(:system).and_return(false)
-
-        expect {
-          subject.compile(source_file)
-        }.to raise_error(Ronin::Payloads::BuildFailed,"go command failed: go build #{source_file}")
-      end
-    end
-
-    context "when system() returns nil" do
-      let(:source_file) { 'foo.go' }
-
-      it do
-        allow(subject).to receive(:system).and_return(nil)
-
-        expect {
-          subject.compile(source_file)
-        }.to raise_error(Ronin::Payloads::BuildFailed,"go command not installed")
-      end
-    end
-  end
-end

data/spec/helpers/encoders.rb

@@ -1,9 +0,0 @@
-require 'ronin/encoders/encoder'
-
-module Helpers
-  ENCODERS_DIR = File.expand_path(File.join(File.dirname(__FILE__),'scripts','encoders'))
-
-  def load_encoder(name,base=Ronin::Encoders::Encoder)
-    base.load_object(File.join(ENCODERS_DIR,"#{name}.rb"))
-  end
-end

data/spec/helpers/payloads.rb

@@ -1,9 +0,0 @@
-require 'ronin/payloads/payload'
-
-module Helpers
-  PAYLOADS_DIR = File.expand_path(File.join(File.dirname(__FILE__),'scripts','payloads'))
-
-  def load_payload(name,base=Ronin::Payloads::Payload)
-    base.load_object(File.join(PAYLOADS_DIR,"#{name}.rb"))
-  end
-end

data/spec/helpers/scripts/payloads/simple.rb

@@ -1,22 +0,0 @@
-require 'ronin/payloads/payload'
-
-Ronin::Payloads::Payload.object do
-  parameter :custom,
-            :type => Symbol,
-            :default => :func,
-            :description => 'Custom value to use in building the payload'
-
-  cache do
-    self.name = 'simple'
-
-    author :name => 'Anonymous', :email => 'anonymous@example.com'
-  end
-
-  build do
-    @raw_payload = "code.#{@custom}"
-  end
-
-  def some_method
-    :some_result
-  end
-end

data/spec/html_payload_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/html_payload'
-
-describe Ronin::Payloads::HTMLPayload do
-  describe ".encoder_class" do
-    subject { described_class }
-
-    it do
-      expect(subject.encoder_class).to be(Ronin::Payloads::Encoders::HTMLEncoder)
-    end
-  end
-end

data/spec/java_payload_spec.rb

@@ -1,97 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/java_payload'
-
-describe Ronin::Payloads::JavaPayload do
-  it "must inherit from Ronin::Payloads::Payload" do
-    expect(described_class).to be < Ronin::Payloads::Payload
-  end
-
-  describe ".javac" do
-    subject { described_class }
-
-    context "when ENV['JAVAC'] is set" do
-      let(:javac) { '/path/to/javac' }
-
-      before { ENV['JAVAC'] = javac }
-
-      it "must return ENV['JAVAC']" do
-        expect(subject.javac).to eq(javac)
-      end
-    end
-
-    context "when ENV['JAVAC'] is not set" do
-      before(:all) do
-        @javac = ENV['JAVAC']
-        ENV.delete('JAVAC')
-      end
-
-      it "must return 'javac'" do
-        expect(subject.javac).to eq('javac')
-      end
-
-      after(:all) do
-        ENV['JAVAC'] = @javac if @javac
-      end
-    end
-  end
-
-  describe "params" do
-    subject { described_class }
-
-    it "must define a :javac param" do
-      expect(subject.params[:javac]).to_not be_nil
-    end
-
-    it "must default the :javac param to #{described_class}.javac" do
-      expect(subject.params[:javac].default_value).to eq(subject.javac)
-    end
-  end
-
-  describe "#compile" do
-    let(:source_files) { %w[foo.java bar.java baz.java] }
-
-    it "must call system with params[:javac] and additional arguments" do
-      expect(subject).to receive(:system).with(
-        subject.params[:javac], *source_files
-      ).and_return(true)
-
-      subject.compile(*source_files)
-    end
-
-    context "when the dest_dir: keyword argument is given" do
-      let(:dest_dir) { '/path/to/dest/dir' }
-
-      it "must pass the `-d` option to the `javac` command" do
-        expect(subject).to receive(:system).with(
-          subject.params[:javac], '-d', dest_dir, *source_files
-        ).and_return(true)
-
-        subject.compile(*source_files, dest_dir: dest_dir)
-      end
-    end
-
-    context "when system() returns false" do
-      let(:source_file) { 'Foo.java' }
-
-      it do
-        allow(subject).to receive(:system).and_return(false)
-
-        expect {
-          subject.compile(source_file)
-        }.to raise_error(Ronin::Payloads::BuildFailed,"javac command failed: #{subject.params[:javac]} #{source_file}")
-      end
-    end
-
-    context "when system() returns nil" do
-      let(:source_file) { 'Foo.java' }
-
-      it do
-        allow(subject).to receive(:system).and_return(nil)
-
-        expect {
-          subject.compile(source_file)
-        }.to raise_error(Ronin::Payloads::BuildFailed,"javac command not installed")
-      end
-    end
-  end
-end

data/spec/javascript_payload_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/javascript_payload'
-
-describe Ronin::Payloads::JavaScriptPayload do
-  describe ".encoder_class" do
-    subject { described_class }
-
-    it do
-      expect(subject.encoder_class).to be(Ronin::Payloads::Encoders::JavaScriptEncoder)
-    end
-  end
-end

data/spec/jsp_payload_spec.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/jsp_payload'
-
-describe Ronin::Payloads::JSPPayload do
-  it "must inherit from Ronin::Payloads::Payload" do
-    expect(described_class).to be < Ronin::Payloads::Payload
-  end
-end

data/spec/metadata/arch_spec.rb

@@ -1,82 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/metadata/arch'
-
-describe Ronin::Payloads::Metadata::Arch do
-  module TestMetadataArch
-    class WithNoArchSet
-      include Ronin::Payloads::Metadata::Arch
-    end
-
-    class WithArchSet
-      include Ronin::Payloads::Metadata::Arch
-
-      arch :x86_64
-    end
-
-    class InheritsItsArch < WithArchSet
-      include Ronin::Payloads::Metadata::Arch
-    end
-
-    class OverridesItsInheritedArch < WithArchSet
-      include Ronin::Payloads::Metadata::Arch
-
-      arch :armbe
-    end
-  end
-
-  describe ".arch" do
-    subject { test_class }
-
-    context "and when arch is not set in the class" do
-      let(:test_class) { TestMetadataArch::WithNoArchSet }
-
-      it "must default to nil" do
-        expect(subject.arch).to be(nil)
-      end
-    end
-
-    context "and when arch is set in the class" do
-      let(:test_class) { TestMetadataArch::WithArchSet }
-
-      it "must return the set arch" do
-        expect(subject.arch).to eq(:x86_64)
-      end
-    end
-
-    context "but when the arch was set in the superclass" do
-      let(:test_class) { TestMetadataArch::InheritsItsArch }
-
-      it "must return the arch set in the superclass" do
-        expect(subject.arch).to eq(:x86_64)
-      end
-
-      context "but the arch is overridden in the sub-class" do
-        let(:test_class) { TestMetadataArch::OverridesItsInheritedArch }
-
-        it "must return the arch set in the sub-class" do
-          expect(subject.arch).to eq(:armbe)
-        end
-      end
-    end
-  end
-
-  describe "#arch" do
-    subject { test_class.new }
-
-    context "when the Payload class has .arch set" do
-      let(:test_class) { TestMetadataArch::WithArchSet }
-
-      it "must return the Payload class'es .arch" do
-        expect(subject.arch).to eq(test_class.arch)
-      end
-    end
-
-    context "when the Payload class does not have .arch set" do
-      let(:test_class) { TestMetadataArch::WithNoArchSet }
-
-      it "must return nil" do
-        expect(subject.arch).to be(nil)
-      end
-    end
-  end
-end

data/spec/metadata/os_spec.rb

@@ -1,164 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/metadata/os'
-
-describe Ronin::Payloads::Metadata::OS do
-  module TestMetadataOS
-    class WithNoOSSet
-      include Ronin::Payloads::Metadata::OS
-    end
-
-    class WithOSSet
-      include Ronin::Payloads::Metadata::OS
-
-      os :linux
-    end
-
-    class InheritsItsOS < WithOSSet
-      include Ronin::Payloads::Metadata::OS
-    end
-
-    class OverridesItsInheritedOS < WithOSSet
-      include Ronin::Payloads::Metadata::OS
-
-      os :macos
-    end
-
-    class WithNoOSVersionSet
-      include Ronin::Payloads::Metadata::OS
-
-      os :linux
-    end
-
-    class WithOSVersionSet
-      include Ronin::Payloads::Metadata::OS
-
-      os :linux
-      os_version '5.x'
-    end
-
-    class InheritsItsOSVersion < WithOSVersionSet
-      include Ronin::Payloads::Metadata::OS
-    end
-
-    class OverridesItsInheritedOSVersion < WithOSVersionSet
-      include Ronin::Payloads::Metadata::OS
-
-      os :macos
-      os_version '13'
-    end
-  end
-
-  describe ".os" do
-    subject { test_class }
-
-    context "and when os is not set in the class" do
-      let(:test_class) { TestMetadataOS::WithNoOSSet }
-
-      it "must default to nil" do
-        expect(subject.os).to be(nil)
-      end
-    end
-
-    context "and when os is set in the class" do
-      let(:test_class) { TestMetadataOS::WithOSSet }
-
-      it "must return the set os" do
-        expect(subject.os).to eq(:linux)
-      end
-    end
-
-    context "but when the os was set in the superclass" do
-      let(:test_class) { TestMetadataOS::InheritsItsOS }
-
-      it "must return the os set in the superclass" do
-        expect(subject.os).to eq(:linux)
-      end
-
-      context "but the os is overridden in the sub-class" do
-        let(:test_class) { TestMetadataOS::OverridesItsInheritedOS }
-
-        it "must return the os set in the sub-class" do
-          expect(subject.os).to eq(:macos)
-        end
-      end
-    end
-  end
-
-  describe ".os_version" do
-    subject { test_class }
-
-    context "and when os is not set in the class" do
-      let(:test_class) { TestMetadataOS::WithNoOSVersionSet }
-
-      it "must default to nil" do
-        expect(subject.os_version).to be(nil)
-      end
-    end
-
-    context "and when os_version is set in the class" do
-      let(:test_class) { TestMetadataOS::WithOSVersionSet }
-
-      it "must return the set os_version" do
-        expect(subject.os_version).to eq('5.x')
-      end
-    end
-
-    context "but when the os was set in the superclass" do
-      let(:test_class) { TestMetadataOS::InheritsItsOSVersion }
-
-      it "must return the os_version set in the superclass" do
-        expect(subject.os_version).to eq('5.x')
-      end
-
-      context "but the os is overridden in the sub-class" do
-        let(:test_class) do
-          TestMetadataOS::OverridesItsInheritedOSVersion
-        end
-
-        it "must return the os_version set in the sub-class" do
-          expect(subject.os_version).to eq('13')
-        end
-      end
-    end
-  end
-
-  describe "#os" do
-    subject { test_class.new }
-
-    context "when the Payload class has .os set" do
-      let(:test_class) { TestMetadataOS::WithOSSet }
-
-      it "must return the Payload classes .os" do
-        expect(subject.os).to eq(test_class.os)
-      end
-    end
-
-    context "when the Payload class does not have .os set" do
-      let(:test_class) { TestMetadataOS::WithNoOSSet }
-
-      it "must return nil" do
-        expect(subject.os).to be(nil)
-      end
-    end
-  end
-
-  describe "#os_version" do
-    subject { test_class.new }
-
-    context "when the Payload class has .os_version set" do
-      let(:test_class) { TestMetadataOS::WithOSVersionSet }
-
-      it "must return the Payload classes .os_version" do
-        expect(subject.os_version).to eq(test_class.os_version)
-      end
-    end
-
-    context "when the Payload class does not have .os_version set" do
-      let(:test_class) { TestMetadataOS::WithNoOSVersionSet }
-
-      it "must return nil" do
-        expect(subject.os_version).to be(nil)
-      end
-    end
-  end
-end

data/spec/mixins/binary_spec.rb

@@ -1,129 +0,0 @@
-require 'spec_helper'
-require 'ronin/payloads/mixins/binary'
-
-require 'ronin/payloads/payload'
-require 'ronin/payloads/metadata/arch'
-require 'ronin/payloads/metadata/os'
-
-describe Ronin::Payloads::Mixins::Binary do
-  module TestBinaryMixin
-    class PayloadWithArchSet < Ronin::Payloads::Payload
-      include Ronin::Payloads::Metadata::Arch
-      include Ronin::Payloads::Mixins::Binary
-
-      arch :x86
-    end
-
-    class PayloadWithoutArch < Ronin::Payloads::Payload
-      include Ronin::Payloads::Mixins::Binary
-    end
-
-    class PayloadWithoutArchSet < Ronin::Payloads::Payload
-      include Ronin::Payloads::Metadata::Arch
-      include Ronin::Payloads::Mixins::Binary
-    end
-
-    class PayloadWithArchSetButWithoutOSSet < Ronin::Payloads::Payload
-      include Ronin::Payloads::Metadata::Arch
-      include Ronin::Payloads::Metadata::OS
-      include Ronin::Payloads::Mixins::Binary
-
-      arch :x86
-    end
-
-    class PayloadWithArchAndOSSet < Ronin::Payloads::Payload
-      include Ronin::Payloads::Metadata::Arch
-      include Ronin::Payloads::Metadata::OS
-      include Ronin::Payloads::Mixins::Binary
-
-      arch :x86
-      os :linux
-    end
-  end
-
-  subject { payload_class.new }
-
-  describe "#perform_validate" do
-    context "when the payload class does not define an #arch method" do
-      let(:payload_class) { TestBinaryMixin::PayloadWithoutArch }
-
-      it do
-        expect {
-          subject.perform_validate
-        }.to raise_error(Ronin::Payloads::ValidationError,"payload #{payload_class} did not include Ronin::Payloads::Metadata::Arch")
-      end
-    end
-
-    context "when the payload class's #arch method returns nil" do
-      let(:payload_class) { TestBinaryMixin::PayloadWithoutArchSet }
-
-      it do
-        expect {
-          subject.perform_validate
-        }.to raise_error(Ronin::Payloads::ValidationError,"payload #{payload_class} did not include define an architecture")
-      end
-    end
-
-    context "when the payload class defines an architecture" do
-      let(:payload_class) { TestBinaryMixin::PayloadWithArchSet }
-
-      it do
-        expect {
-          subject.perform_validate
-        }.to_not raise_error
-      end
-    end
-  end
-
-  describe "#platform" do
-    context "when #arch returns nil" do
-      let(:payload_class) { TestBinaryMixin::PayloadWithoutArchSet }
-
-      it "must return Ronin::Support::Binary::CTypes" do
-        expect(subject.platform).to be(Ronin::Support::Binary::CTypes)
-      end
-    end
-
-    context "when #arch returns a architecture name" do
-      let(:payload_class) { TestBinaryMixin::PayloadWithArchSet }
-
-      it "must return the according Ronin::Support::Binary::CTypes::Arch:: module" do
-        expect(subject.platform).to be(Ronin::Support::Binary::CTypes::Arch::X86)
-      end
-
-      context "and when #os is defined" do
-        context "and it returns an OS name" do
-          let(:payload_class) do
-            TestBinaryMixin::PayloadWithArchAndOSSet
-          end
-
-          it "must return the according Ronin::Support::Binary::CTypes::OS object with the according Ronin::Support::Binary::CTypes::Arch:: module inside it" do
-            expect(subject.platform).to be_kind_of(Ronin::Support::Binary::CTypes::OS::Linux)
-            expect(subject.platform.types).to be(Ronin::Support::Binary::CTypes::Arch::X86)
-          end
-        end
-
-        context "but it returns nil" do
-          let(:payload_class) do
-            TestBinaryMixin::PayloadWithArchSetButWithoutOSSet
-          end
-
-          it "must still return the according Ronin::Support::Binary::CTypes::Arch:: module" do
-            expect(subject.platform).to be(Ronin::Support::Binary::CTypes::Arch::X86)
-          end
-        end
-      end
-    end
-  end
-
-  describe "#pack" do
-    let(:payload_class) { TestBinaryMixin::PayloadWithArchSet }
-
-    let(:type)  { :uint32    }
-    let(:value) { 0x12345678 }
-
-    it "must pack the value using the type from #platform" do
-      expect(subject.pack(type,value)).to eq("\x78\x56\x34\x12".b)
-    end
-  end
-end