ronin-db-activerecord 0.1.0.beta1

data/spec/model/importable_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'ronin/db/model/importable'
+
+describe Ronin::DB::Model::Importable do
+  class TestModelImportable < ActiveRecord::Base
+    include Ronin::DB::Model::Importable
+
+    self.table_name = 'test_model_importable'
+
+    def self.lookup(value)
+      find_by(value: value)
+    end
+
+    def self.import(value)
+      create(value: value)
+    end
+  end
+
+  class TestModelImportableWithoutMethods < ActiveRecord::Base
+    include Ronin::DB::Model::Importable
+
+    self.table_name = 'test_model_importable'
+  end
+
+  let(:model) { TestModelImportable }
+
+  before(:all) do
+    ActiveRecord::Base.connection.create_table :test_model_importable do |t|
+      t.string :value
+
+      t.index :value, unique: true
+    end
+  end
+
+  let(:value) { "foo" }
+
+  describe ".lookup" do
+    subject { model }
+
+    context "when not defined in the model class" do
+      let(:model) { TestModelImportableWithoutMethods }
+
+      it "must raise NotImplementedError" do
+        expect {
+          subject.lookup(value)
+        }.to raise_error(NotImplementedError,"#{model} did not define a self.lookup method")
+      end
+    end
+  end
+
+  describe ".import" do
+    subject { model }
+
+    context "when not defined in the model class" do
+      let(:model) { TestModelImportableWithoutMethods }
+
+      it "must raise NotImplementedError" do
+        expect {
+          subject.import(value)
+        }.to raise_error(NotImplementedError,"#{model} did not define a self.import method")
+      end
+    end
+  end
+
+  describe ".find_or_import" do
+    subject { model }
+
+    context "when a record with the matching value already exists" do
+      before do
+        model.create(value: 'other value1')
+        model.create(value: value)
+        model.create(value: 'other value2')
+      end
+
+      it "must query and return the existing record for the value" do
+        record = subject.find_or_import(value)
+
+        expect(record).to be_kind_of(model)
+        expect(record).to be_persisted
+        expect(record.value).to eq(value)
+        expect(record).to eq(model.all[1])
+      end
+
+      after { model.destroy_all }
+    end
+
+    context "when a record with the matching value does not already exists" do
+      before do
+        model.create(value: 'other value1')
+        model.create(value: 'other value2')
+      end
+
+      it "must create and return a new record for the value" do
+        record = subject.find_or_import(value)
+
+        expect(record).to be_kind_of(model)
+        expect(record).to be_persisted
+        expect(record.value).to eq(value)
+        expect(record).to eq(model.last)
+      end
+
+      after { model.destroy_all }
+    end
+  end
+end

data/spec/models_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe 'ronin/db/models' do
+  it "must load all models" do
+    expect(require 'ronin/db/models').to eq(true)
+  end
+end
+
+describe 'Ronin::DB::Models'do
+  before(:all) { require 'ronin/db/models' }
+
+  subject { Ronin::DB::Models }
+
+  describe "ALL" do
+    subject { super()::ALL }
+
+    it { expect(subject).to include(Ronin::DB::Arch) }
+    it { expect(subject).to include(Ronin::DB::Credential) }
+    it { expect(subject).to include(Ronin::DB::EmailAddress) }
+    it { expect(subject).to include(Ronin::DB::HostName) }
+    it { expect(subject).to include(Ronin::DB::HostNameIPAddress) }
+    it { expect(subject).to include(Ronin::DB::IPAddress) }
+    it { expect(subject).to include(Ronin::DB::IPAddressMACAddress) }
+    it { expect(subject).to include(Ronin::DB::MACAddress) }
+    it { expect(subject).to include(Ronin::DB::OS) }
+    it { expect(subject).to include(Ronin::DB::OSGuess) }
+    it { expect(subject).to include(Ronin::DB::OpenPort) }
+    it { expect(subject).to include(Ronin::DB::Organization) }
+    it { expect(subject).to include(Ronin::DB::Password) }
+    it { expect(subject).to include(Ronin::DB::Port) }
+    it { expect(subject).to include(Ronin::DB::Service) }
+    it { expect(subject).to include(Ronin::DB::ServiceCredential) }
+    it { expect(subject).to include(Ronin::DB::Software) }
+    it { expect(subject).to include(Ronin::DB::URLQueryParamName) }
+    it { expect(subject).to include(Ronin::DB::URLQueryParam) }
+    it { expect(subject).to include(Ronin::DB::URLScheme) }
+    it { expect(subject).to include(Ronin::DB::URL) }
+    it { expect(subject).to include(Ronin::DB::UserName) }
+    it { expect(subject).to include(Ronin::DB::SoftwareVendor) }
+    it { expect(subject).to include(Ronin::DB::WebCredential) }
+    it { expect(subject).to include(Ronin::DB::ASN) }
+    it { expect(subject).to include(Ronin::DB::HTTPQueryParamName) }
+    it { expect(subject).to include(Ronin::DB::HTTPQueryParam) }
+    it { expect(subject).to include(Ronin::DB::HTTPHeaderName) }
+    it { expect(subject).to include(Ronin::DB::HTTPRequestHeader) }
+    it { expect(subject).to include(Ronin::DB::HTTPResponseHeader) }
+    it { expect(subject).to include(Ronin::DB::HTTPRequest) }
+    it { expect(subject).to include(Ronin::DB::HTTPResponse) }
+  end
+
+  describe ".connect" do
+    it "must call #connection on all MODELS" do
+      subject::ALL.each do |model|
+        expect(model).to receive(:connection)
+      end
+
+      subject.connect
+    end
+  end
+end

data/spec/open_port_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'ronin/db/open_port'
+
+describe Ronin::DB::OpenPort do
+  it "must use the 'ronin_open_ports' table" do
+    expect(described_class.table_name).to eq('ronin_open_ports')
+  end
+
+  let(:port_number)   { 443  }
+  let(:port_protocol) { :tcp }
+  let(:port) do
+    Ronin::DB::Port.new(protocol: port_protocol, number: port_number)
+  end
+
+  let(:address)    { '127.0.0.1' }
+  let(:ip_address) { Ronin::DB::IPAddress.new(address: address) }
+
+  describe "validations" do
+    describe "ip_address" do
+      it "must require an ip_address" do
+        open_port = described_class.new(port: port)
+        expect(open_port).to_not be_valid
+        expect(open_port.errors[:ip_address]).to eq(
+          ["must exist"]
+        )
+
+        open_port = described_class.new(ip_address: ip_address, port: port)
+        expect(open_port).to be_valid
+      end
+    end
+
+    describe "port" do
+      it "must require an ip_address" do
+        open_port = described_class.new(ip_address: ip_address)
+        expect(open_port).to_not be_valid
+        expect(open_port.errors[:port]).to eq(
+          ["must exist"]
+        )
+
+        open_port = described_class.new(ip_address: ip_address, port: port)
+        expect(open_port).to be_valid
+      end
+    end
+  end
+
+  subject { described_class.new(ip_address: ip_address, port: port) }
+
+  describe "#address" do
+    it "must return the IP address String associated with the open port" do
+      expect(subject.address).to eq(address)
+    end
+  end
+
+  describe "#number" do
+    it "must return the port number associated with the open port" do
+      expect(subject.number).to eq(port_number)
+    end
+  end
+
+  describe "#to_i" do
+    it "must return the port number associated with the open port" do
+      expect(subject.to_i).to eq(port_number)
+    end
+  end
+
+  describe "#to_s" do
+    it "must return the port protocol/number associated with the open port" do
+      expect(subject.to_s).to eq("#{port_number}/#{port_protocol}")
+    end
+
+    context "when #service is also set" do
+      let(:service_name) { 'Apache' }
+      let(:service)      { Ronin::DB::Service.new(name: service_name) }
+
+      subject do
+        described_class.new(
+          ip_address: ip_address,
+          port:       port,
+          service:    service
+        )
+      end
+      it "must return the port number and service name" do
+        expect(subject.to_s).to eq("#{port_number}/#{port_protocol} (#{service_name})")
+      end
+    end
+  end
+end

data/spec/organization_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'ronin/db/organization'
+
+describe Ronin::DB::Organization do
+  it "must use the 'ronin_organizations' table" do
+    expect(described_class.table_name).to eq('ronin_organizations')
+  end
+
+  let(:name) { 'ACEM, Corp.' }
+end

data/spec/os_guess_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'ronin/db/os_guess'
+
+describe Ronin::DB::OSGuess do
+  it "must use the 'ronin_os_guesses' table" do
+    expect(described_class.table_name).to eq('ronin_os_guesses')
+  end
+
+  let(:address)    { '127.0.0.1' }
+  let(:ip_address) { Ronin::DB::IPAddress.new(address: address) }
+
+  let(:os_name)    { 'Windows' }
+  let(:os_version) { '10'      }
+  let(:os)         { Ronin::DB::OS.new(name: os_name, version: os_version) }
+
+  describe "validations" do
+    describe "ip_address" do
+      it "must require an ip_address" do
+        os_guess = described_class.new(os: os)
+        expect(os_guess).to_not be_valid
+        expect(os_guess.errors[:ip_address]).to eq(
+          ["must exist"]
+        )
+
+        os_guess = described_class.new(os: os, ip_address: ip_address)
+        expect(os_guess).to be_valid
+      end
+    end
+
+    describe "os" do
+      it "must require an os" do
+        os_guess = described_class.new(ip_address: ip_address)
+        expect(os_guess).to_not be_valid
+        expect(os_guess.errors[:os]).to eq(
+          ["must exist"]
+        )
+
+        os_guess = described_class.new(os: os, ip_address: ip_address)
+        expect(os_guess).to be_valid
+      end
+    end
+  end
+end

data/spec/os_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+require 'ronin/db/os'
+
+describe Ronin::DB::OS do
+  it "must use the 'ronin_oses' table" do
+    expect(described_class.table_name).to eq('ronin_oses')
+  end
+
+  let(:name)    { 'Linux'  }
+  let(:version) { '2.6.11' }
+
+  subject { described_class.new(name: name, version: version) }
+
+  describe "validations" do
+    describe "name" do
+      it "should require a name" do
+        os = described_class.new(version: version)
+        expect(os).not_to be_valid
+
+        os = described_class.new(name: name, version: version)
+        expect(os).to be_valid
+      end
+    end
+
+    describe "version" do
+      it "should require a version" do
+        os = described_class.new(name: name)
+        expect(os).not_to be_valid
+
+        os = described_class.new(name: name, version: version)
+        expect(os).to be_valid
+      end
+    end
+  end
+
+  describe ".linux" do
+    let(:name) { 'Linux' }
+
+    it "must find or create a new Linux OS" do
+      os = described_class.linux(version)
+
+      expect(os.name).to eq(name)
+      expect(os.flavor).to eq('linux')
+      expect(os.version).to eq(version)
+    end
+  end
+
+  describe ".freebsd" do
+    let(:name) { 'FreeBSD' }
+
+    it "must find or create a new FreeBSD OS" do
+      os = described_class.freebsd(version)
+
+      expect(os.name).to eq(name)
+      expect(os.flavor).to eq('bsd')
+      expect(os.version).to eq(version)
+    end
+  end
+
+  describe ".openbsd" do
+    let(:name) { 'OpenBSD' }
+
+    it "must find or create a new OpenBSD OS" do
+      os = described_class.openbsd(version)
+
+      expect(os.name).to eq(name)
+      expect(os.flavor).to eq('bsd')
+      expect(os.version).to eq(version)
+    end
+  end
+
+  describe ".netbsd" do
+    let(:name) { 'NetBSD' }
+
+    it "must find or create a new NetBSD OS" do
+      os = described_class.netbsd(version)
+
+      expect(os.name).to eq(name)
+      expect(os.flavor).to eq('bsd')
+      expect(os.version).to eq(version)
+    end
+  end
+
+  describe ".macos" do
+    let(:name) { 'macOS' }
+
+    it "must find or create a new macOS OS" do
+      os = described_class.macos(version)
+
+      expect(os.name).to eq(name)
+      expect(os.flavor).to eq('bsd')
+      expect(os.version).to eq(version)
+    end
+  end
+
+  describe ".windows" do
+    let(:name) { 'Windows' }
+
+    it "must find or create a new Windows OS" do
+      os = described_class.windows(version)
+
+      expect(os.version).to eq(version)
+    end
+  end
+
+  describe "#recent_ip_address" do
+  end
+
+  describe "#to_s" do
+    it "must return the OS name and version" do
+      expect(subject.to_s).to eq("#{name} #{version}")
+    end
+  end
+end

data/spec/password_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'ronin/db/password'
+
+describe Ronin::DB::Password do
+  it "must use the 'ronin_passwords' table" do
+    expect(described_class.table_name).to eq('ronin_passwords')
+  end
+
+  let(:plain_text) { 'secret' }
+
+  subject { described_class.new(plain_text: plain_text) }
+
+  describe "validations" do
+    it "should require a clear-text password" do
+      pass = described_class.new
+      expect(pass).not_to be_valid
+
+      pass.plain_text = plain_text
+      expect(pass).to be_valid
+    end
+  end
+
+  describe ".lookup" do
+    before do
+      described_class.create(plain_text: 'other_password1')
+      described_class.create(plain_text: plain_text)
+      described_class.create(plain_text: 'other_pasword2')
+    end
+
+    it "must query the #{described_class} with the matching plain text password" do
+      password = described_class.lookup(plain_text)
+
+      expect(password).to be_kind_of(described_class)
+      expect(password.plain_text).to eq(plain_text)
+    end
+
+    after { described_class.destroy_all }
+  end
+
+  describe ".import" do
+    subject { described_class.import(plain_text) }
+
+    it "must import the given password" do
+      expect(subject.id).to_not be(nil)
+      expect(subject.plain_text).to eq(plain_text)
+    end
+
+    after { described_class.destroy_all }
+  end
+
+  describe "#digest" do
+    let(:salt) { 'foo' }
+
+    it "should calculate the digest of the password" do
+      digest = subject.digest(:sha1)
+      
+      expect(digest).to eq(Digest::SHA1.hexdigest(plain_text))
+    end
+
+    it "should calculate the digest of the password and prepended salt" do
+      digest = subject.digest(:sha1, prepend_salt: salt)
+      
+      expect(digest).to eq(Digest::SHA1.hexdigest(salt + plain_text))
+    end
+
+    it "should calculate the digest of the password and appended salt" do
+      digest = subject.digest(:sha1, append_salt: salt)
+      
+      expect(digest).to eq(Digest::SHA1.hexdigest(plain_text + salt))
+    end
+  end
+
+  describe "#count" do
+  end
+
+  describe "#to_s" do
+    it "should return the plain text password" do
+      expect(subject.to_s).to eq(plain_text)
+    end
+  end
+end

data/spec/port_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'ronin/db/port'
+
+describe Ronin::DB::Port do
+  it "must use the 'ronin_ports' table" do
+    expect(described_class.table_name).to eq('ronin_ports')
+  end
+
+  let(:protocol) { 'tcp' }
+  let(:number)   { 80    }
+
+  subject do
+    described_class.new(protocol: protocol, number: number)
+  end
+
+  describe "validations" do
+    context "when not given a port number" do
+      subject { described_class.new(protocol: protocol) }
+
+      it "must require a port number" do
+        expect(subject).not_to be_valid
+      end
+    end
+
+    context "when given an unknown protocol" do
+      let(:protocol) { 'foo' }
+
+      it "must only allow 'tcp' and 'udp' as protocols" do
+        expect {
+          described_class.new(protocol: protocol, number: number)
+        }.to raise_error(ArgumentError,"'#{protocol}' is not a valid protocol")
+      end
+    end
+
+    context "when a duplicate protocol/port-number pairs is saved" do
+      before { subject.save }
+
+      it "must only allow saving unique protocol/port-number pairs" do
+        port = described_class.new(protocol: protocol, number: number)
+
+        expect(port).not_to be_valid
+      end
+
+      after { subject.destroy }
+    end
+  end
+
+  describe ".lookup" do
+    before do
+      described_class.create(number: 1111)
+      described_class.create(number: number)
+      described_class.create(number: 2222)
+    end
+
+    it "must query the #{described_class} with the matching port number" do
+      port = described_class.lookup(number)
+
+      expect(port).to be_kind_of(described_class)
+      expect(port.number).to eq(number)
+    end
+
+    after { described_class.destroy_all }
+  end
+
+  describe ".import" do
+    context "when given an Integer" do
+      subject { described_class.import(number) }
+
+      it "must import the port number and set #number" do
+        expect(subject).to be_kind_of(described_class)
+        expect(subject.id).to_not be(nil)
+        expect(subject.number).to eq(number)
+      end
+    end
+
+    context "when given a String" do
+      let(:string) { number.to_s }
+
+      subject { described_class.import(string) }
+
+      it "must parse and import the port number and set #number" do
+        expect(subject).to be_kind_of(described_class)
+        expect(subject.id).to_not be(nil)
+        expect(subject.number).to eq(number)
+      end
+    end
+
+    after { described_class.destroy_all }
+  end
+
+  describe "#to_i" do
+    it "must be convertable to an Integer" do
+      expect(subject.to_i).to eq(number)
+    end
+  end
+
+  describe "#to_s" do
+    it "must include the number and protocol" do
+      expect(subject.to_s).to eq("#{number}/#{protocol}")
+    end
+  end
+end

data/spec/schema_migration_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'ronin/db/schema_migration'
+
+describe Ronin::DB::SchemaMigration do
+  it "must use the 'ronin_schema_migrations' table" do
+    expect(described_class.table_name).to eq('ronin_schema_migrations')
+  end
+end

data/spec/service_credential_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'ronin/db/service_credential'
+
+describe Ronin::DB::ServiceCredential do
+  it "must use the 'ronin_service_credentials' table" do
+    expect(described_class.table_name).to eq('ronin_service_credentials')
+  end
+
+  let(:user)        { 'admin' }
+  let(:user_name)   { Ronin::DB::UserName.new(name: user) }
+  let(:password)    { Ronin::DB::Password.new(plain_text: 'secret') }
+  let(:credential) do
+    Ronin::DB::Credential.new(
+      user_name: user_name,
+      password:  password
+    )
+  end
+
+  let(:port_number) { 22 }
+  let(:ip_address)  { Ronin::DB::IPAddress.new(address: '1.2.3.4') }
+  let(:port)        { Ronin::DB::Port.new(number: port_number) }
+  let(:open_port) do
+    Ronin::DB::OpenPort.new(
+      port:       port,
+      ip_address: ip_address
+    )
+  end
+
+  subject do
+    described_class.new(
+      credential: credential,
+      open_port:  open_port
+    )
+  end
+
+  describe "#to_s" do
+    it "must return the username:password and ip:port values in the String" do
+      expect(subject.to_s).to eq(
+        "#{user_name}:#{password} (#{open_port})"
+      )
+    end
+  end
+end

data/spec/service_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'ronin/db/service'
+
+describe Ronin::DB::Service do
+  it "must use the 'ronin_services' table" do
+    expect(described_class.table_name).to eq('ronin_services')
+  end
+
+  let(:name) { 'Apache' }
+
+  describe "validations" do
+    describe "name" do
+      it "must require a name" do
+        service = described_class.new
+        expect(service).to_not be_valid
+        expect(service.errors[:name]).to eq(
+          ["can't be blank"]
+        )
+
+        service = described_class.new(name: name)
+        expect(service).to be_valid
+      end
+
+      it "must require a unique name" do
+        described_class.create(name: name)
+
+        service = described_class.new(name: name)
+        expect(service).not_to be_valid
+        expect(service.errors[:name]).to eq(
+          ["has already been taken"]
+        )
+
+        described_class.destroy_all
+      end
+    end
+  end
+
+  subject { described_class.new(name: name) }
+end