metasploit_data_models 0.24.4 → 0.24.5

data/lib/tasks/yard.rake

@@ -0,0 +1,33 @@
+# @note All options not specific to any given rake task should go in the .yardopts file so they are available to both
+#   the below rake tasks and when invoking `yard` from the command line
+
+if defined? YARD
+  namespace :yard do
+    YARD::Rake::YardocTask.new(:doc) do |t|
+      # --no-stats here as 'stats' task called after will print fuller stats
+      t.options = ['--no-stats']
+
+      t.after = Proc.new {
+        Rake::Task['yard:stats'].execute
+      }
+    end
+
+    # need environment so that yard templates can load ActiveRecord::Base subclasses for Entity-Relationship Diagrams
+    task :doc => :eager_load
+
+    desc "Shows stats for YARD Documentation including listing undocumented modules, classes, constants, and methods"
+    task :stats => :environment do
+      stats = YARD::CLI::Stats.new
+      stats.run('--compact', '--list-undoc')
+    end
+  end
+
+  # @todo Figure out how to just clone description from yard:doc
+  desc "Generate YARD documentation"
+  # allow calling namespace to as a task that goes to default task for namespace
+  task :yard => ['yard:doc']
+end
+
+task eager_load: :environment do
+  Rails.application.eager_load!
+end

data/metasploit_data_models.gemspec

@@ -29,13 +29,6 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.1'
 
   # ---- Dependencies ----
-  s.add_development_dependency 'metasploit-version', '~> 0.1.3'
-  # documentation
-  s.add_development_dependency 'metasploit-yard', '~> 1.0'
-  s.add_development_dependency 'yard-activerecord', '~> 0.0.14'
-  # embed ERDs on index, namespace Module and Class<ActiveRecord::Base> pages
-  s.add_development_dependency 'yard-metasploit-erd', '~> 0.1.0'
-
   s.add_development_dependency 'rake'
 
   # documentation
@@ -51,8 +44,8 @@ Gem::Specification.new do |s|
   # os fingerprinting
   s.add_runtime_dependency 'recog', '~> 1.0'
 
-  s.add_runtime_dependency 'metasploit-concern', '0.5.0'
-  s.add_runtime_dependency 'metasploit-model', '~> 0.30.0'
+  s.add_runtime_dependency 'metasploit-concern', '0.4.0'
+  s.add_runtime_dependency 'metasploit-model', '~> 0.29.0'
   s.add_runtime_dependency 'railties', '< 4.0.0'
 
   # arel-helpers: Useful tools to help construct database queries with ActiveRecord and Arel.

data/spec/app/models/mdm/api_key_spec.rb

@@ -1,3 +1,5 @@
-RSpec.describe Mdm::ApiKey, type: :model do
+require 'spec_helper'
+
+describe Mdm::ApiKey do
   it_should_behave_like 'Metasploit::Concern.run'
 end

data/spec/app/models/mdm/client_spec.rb

@@ -1,9 +1,11 @@
-RSpec.describe Mdm::Client, type: :model do
+require 'spec_helper'
+
+describe Mdm::Client do
 
   it_should_behave_like 'Metasploit::Concern.run'
 
   context 'associations' do
-    it { is_expected.to belong_to(:host).class_name('Mdm::Host') }
+    it { should belong_to(:host).class_name('Mdm::Host') }
   end
 
   context '#destroy' do
@@ -21,21 +23,21 @@ RSpec.describe Mdm::Client, type: :model do
   context 'factory' do
     it 'should be valid' do
       client = FactoryGirl.build(:mdm_client)
-      expect(client).to be_valid
+      client.should be_valid
     end
   end
 
   context 'database' do
     context 'columns' do
-      it { is_expected.to have_db_column(:host_id).of_type(:integer)}
-      it { is_expected.to have_db_column(:ua_string).of_type(:string).with_options(:null => false) }
-      it { is_expected.to have_db_column(:ua_name).of_type(:string) }
-      it { is_expected.to have_db_column(:ua_ver).of_type(:string) }
+      it { should have_db_column(:host_id).of_type(:integer)}
+      it { should have_db_column(:ua_string).of_type(:string).with_options(:null => false) }
+      it { should have_db_column(:ua_name).of_type(:string) }
+      it { should have_db_column(:ua_ver).of_type(:string) }
     end
 
     context 'timestamps' do
-      it { is_expected.to have_db_column(:created_at).of_type(:datetime) }
-      it { is_expected.to have_db_column(:updated_at).of_type(:datetime) }
+      it { should have_db_column(:created_at).of_type(:datetime) }
+      it { should have_db_column(:updated_at).of_type(:datetime) }
     end
 
   end

data/spec/app/models/mdm/cred_spec.rb

@@ -1,27 +1,29 @@
-RSpec.describe Mdm::Cred, type: :model do
+require 'spec_helper'
+
+describe Mdm::Cred do
   it_should_behave_like 'Metasploit::Concern.run'
 
   context "Associations" do
-    it { is_expected.to have_many(:task_creds).class_name('Mdm::TaskCred').dependent(:destroy) }
-    it { is_expected.to have_many(:tasks).class_name('Mdm::Task').through(:task_creds) }
-    it { is_expected.to belong_to(:service).class_name('Mdm::Service') }
+    it { should have_many(:task_creds).class_name('Mdm::TaskCred').dependent(:destroy) }
+    it { should have_many(:tasks).class_name('Mdm::Task').through(:task_creds) }
+    it { should belong_to(:service).class_name('Mdm::Service') }
   end
 
   context 'database' do
     context 'timestamps' do
-      it { is_expected.to have_db_column(:created_at).of_type(:datetime) }
-      it { is_expected.to have_db_column(:updated_at).of_type(:datetime) }
+      it { should have_db_column(:created_at).of_type(:datetime) }
+      it { should have_db_column(:updated_at).of_type(:datetime) }
     end
 
     context 'columns' do
-      it { is_expected.to have_db_column(:service_id).of_type(:integer).with_options(:null => false) }
-      it { is_expected.to have_db_column(:user).of_type(:string) }
-      it { is_expected.to have_db_column(:pass).of_type(:string) }
-      it { is_expected.to have_db_column(:active).of_type(:boolean).with_options(:default => true) }
-      it { is_expected.to have_db_column(:proof).of_type(:string) }
-      it { is_expected.to have_db_column(:ptype).of_type(:string) }
-      it { is_expected.to have_db_column(:source_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:source_type).of_type(:string) }
+      it { should have_db_column(:service_id).of_type(:integer).with_options(:null => false) }
+      it { should have_db_column(:user).of_type(:string) }
+      it { should have_db_column(:pass).of_type(:string) }
+      it { should have_db_column(:active).of_type(:boolean).with_options(:default => true) }
+      it { should have_db_column(:proof).of_type(:string) }
+      it { should have_db_column(:ptype).of_type(:string) }
+      it { should have_db_column(:source_id).of_type(:integer) }
+      it { should have_db_column(:source_type).of_type(:string) }
     end
   end
 
@@ -66,23 +68,25 @@ RSpec.describe Mdm::Cred, type: :model do
 
   context 'constants' do
     it 'should define the key_id regex' do
-      expect(described_class::KEY_ID_REGEX).to eq(/([0-9a-fA-F:]{47})/)
+      described_class::KEY_ID_REGEX.should == /([0-9a-fA-F:]{47})/
     end
 
     it 'should define ptypes to humanize' do
-      expect(described_class::PTYPES).to eq(
-                                             {
-                                                 'read/write password' => 'password_rw',
-                                                 'read-only password' => 'password_ro',
-                                                 'SMB hash' => 'smb_hash',
-                                                 'SSH private key' => 'ssh_key',
-                                                 'SSH public key' => 'ssh_pubkey'
-                                             }
-                                         )
+      described_class::PTYPES.should == {
+          'read/write password' => 'password_rw',
+          'read-only password' => 'password_ro',
+          'SMB hash' => 'smb_hash',
+          'SSH private key' => 'ssh_key',
+          'SSH public key' => 'ssh_pubkey'
+      }
     end
   end
 
   context 'methods' do
+    #
+    # lets
+    #
+
     let(:host) {
       FactoryGirl.create(
           :mdm_host,
@@ -130,47 +134,55 @@ RSpec.describe Mdm::Cred, type: :model do
       FactoryGirl.create(:mdm_workspace)
     }
 
+    #
+    # Callbacks
+    #
+
+    before(:all) do
+      Mdm::Workspace.any_instance.stub(:valid_ip_or_range? => true)
+    end
+
     context '#ptype_human' do
       it "should return 'read/write password' for 'password_rw'" do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => 'msfadmin', :ptype => 'password_rw')
-        expect(cred.ptype_human).to eq('read/write password')
+        cred.ptype_human.should == 'read/write password'
       end
 
       it "should return 'read-only password' for 'password_ro'" do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => 'msfadmin', :ptype => 'password_ro')
-        expect(cred.ptype_human).to eq('read-only password')
+        cred.ptype_human.should == 'read-only password'
       end
 
       it "should return 'SMB Hash' for 'smb_hash'" do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => 'msfadmin', :ptype => 'smb_hash')
-        expect(cred.ptype_human).to eq('SMB hash')
+        cred.ptype_human.should == 'SMB hash'
       end
 
       it "should return 'SSH private key' for 'ssh_key'" do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => 'msfadmin', :ptype => 'ssh_key')
-        expect(cred.ptype_human).to eq('SSH private key')
+        cred.ptype_human.should == 'SSH private key'
       end
 
       it "should return 'SSH public key' for 'ssh_pubkey'" do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => 'msfadmin', :ptype => 'ssh_pubkey')
-        expect(cred.ptype_human).to eq('SSH public key')
+        cred.ptype_human.should == 'SSH public key'
       end
     end
 
     context '#ssh_key_id' do
       it 'should return nil if not an ssh_key' do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => 'msfadmin', :ptype => 'password_rw')
-        expect(cred.ssh_key_id).to eq(nil)
+        cred.ssh_key_id.should == nil
       end
 
       it 'should return nil if proof does not contain the key id' do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => '/path/to/keyfile', :ptype => 'ssh_key', :proof => "no key here")
-        expect(cred.ssh_key_id).to eq(nil)
+        cred.ssh_key_id.should == nil
       end
 
       it 'should return the key id for an ssh_key' do
         cred = FactoryGirl.build(:mdm_cred, :user => 'msfadmin', :pass => '/path/to/keyfile', :ptype => 'ssh_key', :proof => "KEY=57:c3:11:5d:77:c5:63:90:33:2d:c5:c4:99:78:62:7a")
-        expect(cred.ssh_key_id).to eq('57:c3:11:5d:77:c5:63:90:33:2d:c5:c4:99:78:62:7a')
+        cred.ssh_key_id.should == '57:c3:11:5d:77:c5:63:90:33:2d:c5:c4:99:78:62:7a'
       end
 
     end
@@ -222,14 +234,14 @@ RSpec.describe Mdm::Cred, type: :model do
       it 'should behave the same for public keys as private keys' do
         pubkey2 = FactoryGirl.create(:mdm_cred, :service => service, :user => 'msfadmin', :pass => '/path/to/keyfile', :ptype => 'ssh_pubkey', :proof => "KEY=57:c3:11:5d:77:c5:63:90:33:2d:c5:c4:99:78:62:7a")
         pubkey3 = FactoryGirl.create(:mdm_cred, :service => service, :user => 'msfadmin', :pass => '/path/to/keyfile', :ptype => 'ssh_pubkey', :proof => "KEY=66:d4:22:6e:88:d6:74:A1:44:3e:d6:d5:AA:89:73:8b")
-        expect(pubkey2.ssh_key_matches?(ssh_pubkey)).to eq(true)
-        expect(pubkey2.ssh_key_matches?(pubkey3)).to eq(false)
+        pubkey2.ssh_key_matches?(ssh_pubkey).should == true
+        pubkey2.ssh_key_matches?(pubkey3).should == false
       end
 
       it 'should always return false for non ssh key creds' do
         cred2 = FactoryGirl.create(:mdm_cred, :service => other_service, :ptype => 'password', :user => 'msfadmin', :pass => 'msfadmin' )
         cred3 = FactoryGirl.create(:mdm_cred, :service => other_service, :ptype => 'password', :user => 'msfadmin', :pass => 'msfadmin' )
-        expect(cred2.ssh_key_matches?(cred3)).to eq(false)
+        cred2.ssh_key_matches?(cred3).should == false
       end
     end
 
@@ -259,11 +271,11 @@ RSpec.describe Mdm::Cred, type: :model do
       end
 
       it 'should return all ssh private keys with a matching id' do
-        expect(other_ssh_key.ssh_keys).to include(ssh_key)
+        other_ssh_key.ssh_keys.should include(ssh_key)
       end
 
       it 'should return all ssh public keys with a matching id' do
-        expect(other_ssh_key.ssh_keys).to include(ssh_pubkey)
+        other_ssh_key.ssh_keys.should include(ssh_pubkey)
       end
     end
 
@@ -293,11 +305,11 @@ RSpec.describe Mdm::Cred, type: :model do
       end
 
       it 'should return ssh private keys with matching ids' do
-        expect(other_ssh_key.ssh_private_keys).to include(ssh_key)
+        other_ssh_key.ssh_private_keys.should include(ssh_key)
       end
 
       it 'should not return ssh public keys with matching ids' do
-        expect(other_ssh_key.ssh_private_keys).not_to include(ssh_pubkey)
+        other_ssh_key.ssh_private_keys.should_not include(ssh_pubkey)
       end
     end
 
@@ -327,11 +339,11 @@ RSpec.describe Mdm::Cred, type: :model do
       end
 
       it 'should not return ssh private keys with matching ids' do
-        expect(other_ssh_key.ssh_public_keys).not_to include(ssh_key)
+        other_ssh_key.ssh_public_keys.should_not include(ssh_key)
       end
 
       it 'should return ssh public keys with matching ids' do
-        expect(other_ssh_key.ssh_public_keys).to include(ssh_pubkey)
+        other_ssh_key.ssh_public_keys.should include(ssh_pubkey)
       end
     end
   end
@@ -339,7 +351,7 @@ RSpec.describe Mdm::Cred, type: :model do
   context 'factory' do
     it 'should be valid' do
       cred = FactoryGirl.build(:mdm_cred)
-      expect(cred).to be_valid
+      cred.should be_valid
     end
   end
 

data/spec/app/models/mdm/event_spec.rb

@@ -1,25 +1,27 @@
-RSpec.describe Mdm::Event, type: :model do
+require 'spec_helper'
+
+describe Mdm::Event do
   it_should_behave_like 'Metasploit::Concern.run'
 
   context 'associations' do
-    it { is_expected.to belong_to(:host).class_name('Mdm::Host') }
-    it { is_expected.to belong_to(:workspace).class_name('Mdm::Workspace') }
+    it { should belong_to(:host).class_name('Mdm::Host') }
+    it { should belong_to(:workspace).class_name('Mdm::Workspace') }
   end
 
   context 'database' do
     context 'timestamps' do
-      it { is_expected.to have_db_column(:created_at).of_type(:datetime) }
-      it { is_expected.to have_db_column(:updated_at).of_type(:datetime) }
+      it { should have_db_column(:created_at).of_type(:datetime) }
+      it { should have_db_column(:updated_at).of_type(:datetime) }
     end
 
     context 'columns' do
-      it { is_expected.to have_db_column(:workspace_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:host_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:name).of_type(:string) }
-      it { is_expected.to have_db_column(:critical).of_type(:boolean) }
-      it { is_expected.to have_db_column(:seen).of_type(:boolean) }
-      it { is_expected.to have_db_column(:username).of_type(:string) }
-      it { is_expected.to have_db_column(:info).of_type(:text) }
+      it { should have_db_column(:workspace_id).of_type(:integer) }
+      it { should have_db_column(:host_id).of_type(:integer) }
+      it { should have_db_column(:name).of_type(:string) }
+      it { should have_db_column(:critical).of_type(:boolean) }
+      it { should have_db_column(:seen).of_type(:boolean) }
+      it { should have_db_column(:username).of_type(:string) }
+      it { should have_db_column(:info).of_type(:text) }
     end
   end
 
@@ -42,16 +44,16 @@ RSpec.describe Mdm::Event, type: :model do
         flagged_event = FactoryGirl.create(:mdm_event, :name => 'flagme', :critical => true, :seen => false)
         non_critical_event = FactoryGirl.create(:mdm_event, :name => 'dontflagmebro', :critical => false, :seen => false)
         flagged_set = Mdm::Event.flagged
-        expect(flagged_set).to include(flagged_event)
-        expect(flagged_set).not_to include(non_critical_event)
+        flagged_set.should include(flagged_event)
+        flagged_set.should_not include(non_critical_event)
       end
 
       it 'should exclude seen events' do
         flagged_event = FactoryGirl.create(:mdm_event, :name => 'flagme', :critical => true, :seen => false)
         non_critical_event = FactoryGirl.create(:mdm_event, :name => 'dontflagmebro', :critical => false, :seen => true)
         flagged_set = Mdm::Event.flagged
-        expect(flagged_set).to include(flagged_event)
-        expect(flagged_set).not_to include(non_critical_event)
+        flagged_set.should include(flagged_event)
+        flagged_set.should_not include(non_critical_event)
       end
     end
 
@@ -60,8 +62,8 @@ RSpec.describe Mdm::Event, type: :model do
         flagged_event = FactoryGirl.create(:mdm_event, :name => 'module_run')
         non_critical_event = FactoryGirl.create(:mdm_event, :name => 'dontflagmebro')
         flagged_set = Mdm::Event.module_run
-        expect(flagged_set).to include(flagged_event)
-        expect(flagged_set).not_to include(non_critical_event)
+        flagged_set.should include(flagged_event)
+        flagged_set.should_not include(non_critical_event)
       end
     end
   end
@@ -69,15 +71,15 @@ RSpec.describe Mdm::Event, type: :model do
   context 'validations' do
     it 'should require name' do
       unnamed_event = FactoryGirl.build(:mdm_event, :name => nil)
-      expect(unnamed_event).not_to be_valid
-      expect(unnamed_event.errors[:name]).to include("can't be blank")
+      unnamed_event.should_not be_valid
+      unnamed_event.errors[:name].should include("can't be blank")
     end
   end
 
   context 'factory' do
     it 'should be valid' do
       event = FactoryGirl.build(:mdm_event)
-      expect(event).to be_valid
+      event.should be_valid
     end
   end
 

data/spec/app/models/mdm/exploit_attempt_spec.rb

@@ -1,29 +1,31 @@
-RSpec.describe Mdm::ExploitAttempt, type: :model do
+require 'spec_helper'
+
+describe Mdm::ExploitAttempt do
   it_should_behave_like 'Metasploit::Concern.run'
 
   context 'associations' do
-    it { is_expected.to belong_to(:host).class_name('Mdm::Host') }
+    it { should belong_to(:host).class_name('Mdm::Host') }
   end
 
   context 'database' do
 
     context 'timestamps'do
-      it { is_expected.to have_db_column(:attempted_at).of_type(:datetime) }
+      it { should have_db_column(:attempted_at).of_type(:datetime) }
     end
 
     context 'columns' do
-      it { is_expected.to have_db_column(:host_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:service_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:vuln_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:exploited).of_type(:boolean) }
-      it { is_expected.to have_db_column(:fail_reason).of_type(:string) }
-      it { is_expected.to have_db_column(:username).of_type(:string) }
-      it { is_expected.to have_db_column(:module).of_type(:text) }
-      it { is_expected.to have_db_column(:session_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:loot_id).of_type(:integer) }
-      it { is_expected.to have_db_column(:port).of_type(:integer) }
-      it { is_expected.to have_db_column(:proto).of_type(:string) }
-      it { is_expected.to have_db_column(:fail_detail).of_type(:text) }
+      it { should have_db_column(:host_id).of_type(:integer) }
+      it { should have_db_column(:service_id).of_type(:integer) }
+      it { should have_db_column(:vuln_id).of_type(:integer) }
+      it { should have_db_column(:exploited).of_type(:boolean) }
+      it { should have_db_column(:fail_reason).of_type(:string) }
+      it { should have_db_column(:username).of_type(:string) }
+      it { should have_db_column(:module).of_type(:text) }
+      it { should have_db_column(:session_id).of_type(:integer) }
+      it { should have_db_column(:loot_id).of_type(:integer) }
+      it { should have_db_column(:port).of_type(:integer) }
+      it { should have_db_column(:proto).of_type(:string) }
+      it { should have_db_column(:fail_detail).of_type(:text) }
     end
   end
 
@@ -43,17 +45,17 @@ RSpec.describe Mdm::ExploitAttempt, type: :model do
   context 'validations' do
     it 'should only be valid with a host_id' do
       orphaned_attempt = FactoryGirl.build(:mdm_exploit_attempt, :host => nil)
-      expect(orphaned_attempt).not_to be_valid
-      expect(orphaned_attempt.errors[:host_id]).to include("can't be blank")
+      orphaned_attempt.should_not be_valid
+      orphaned_attempt.errors[:host_id].should include("can't be blank")
       propper_attempt = FactoryGirl.build(:mdm_exploit_attempt)
-      expect(propper_attempt).to be_valid
+      propper_attempt.should be_valid
     end
   end
 
   context 'factory' do
     it 'should be valid' do
       exploit_attempt = FactoryGirl.build(:mdm_exploit_attempt)
-      expect(exploit_attempt).to be_valid
+      exploit_attempt.should be_valid
     end
   end
 end