metasploit_data_models 0.15.2 → 0.16.0

data/Gemfile

@@ -24,4 +24,6 @@ group :test do
   # need rspec-rails >= 2.12.0 as 2.12.0 adds support for redefining named subject in nested context that uses the
   # named subject from the outer context without causing a stack overflow.
   gem 'rspec-rails', '>= 2.12.0'
+  # used for building markup for webpage factories
+  gem 'builder'
 end

data/app/models/mdm/client.rb

@@ -2,7 +2,6 @@ class Mdm::Client < ActiveRecord::Base
   #
   # Relations
   #
-  belongs_to :campaign, :class_name => 'Mdm::Campaign'
   belongs_to :host, :class_name => 'Mdm::Host'
 
   ActiveSupport.run_load_hooks(:mdm_client, self)

data/app/models/mdm/cred.rb

@@ -60,7 +60,7 @@ class Mdm::Cred < ActiveRecord::Base
       when "ssh_pubkey"
         matches = self.ssh_public_keys
       else
-        false
+        return false
     end
     matches.include?(self) and matches.include?(other_cred)
   end

data/app/models/mdm/exploited_host.rb

@@ -5,7 +5,6 @@ class Mdm::ExploitedHost < ActiveRecord::Base
 
   belongs_to :host, :class_name => 'Mdm::Host'
   belongs_to :service, :class_name => 'Mdm::Service'
-  belongs_to :workspace, :class_name => 'Mdm::Workspace'
 
   ActiveSupport.run_load_hooks(:mdm_exploited_host, self)
 end

data/app/models/mdm/listener.rb

@@ -17,7 +17,8 @@ class Mdm::Listener < ActiveRecord::Base
   #
 
   validates :address, :ip_format => true, :presence => true
-  validates :port, :presence => true
+  validates :port, :presence => true, :numericality => { :only_integer => true }, :inclusion => {:in => 1..65535}
+
 
   ActiveSupport.run_load_hooks(:mdm_listener, self)
 end

data/app/models/mdm/nexpose_console.rb

@@ -9,10 +9,10 @@ class Mdm::NexposeConsole < ActiveRecord::Base
   # Validations
   #
 
-  validates :address, :presence => true
+  validates :address, :ip_format => true, :presence => true
   validates :name, :presence => true
   validates :password, :presence => true
-  validates :port, :inclusion => {:in => 1..65535}
+  validates :port, :numericality => { :only_integer => true }, :inclusion => {:in => 1..65535}
   validates :username, :presence => true
 
   ActiveSupport.run_load_hooks(:mdm_nexpose_console, self)

data/app/models/mdm/session.rb

@@ -123,7 +123,11 @@ class Mdm::Session < ActiveRecord::Base
   # @return [true] if {#platform} is some version of Windows and {#stype} is `'shell'`.
   # @return [false] otherwise.
   def upgradeable?
-    (self.platform =~ /win/ and self.stype == 'shell')
+    if (self.platform =~ /win/i and self.stype == 'shell')
+      return true
+    else
+      return false
+    end
   end
 
   private

data/app/models/mdm/workspace.rb

@@ -18,7 +18,6 @@ class Mdm::Workspace < ActiveRecord::Base
   has_many :creds, :through => :services, :class_name => 'Mdm::Cred'
   has_many :events, :class_name => 'Mdm::Event'
   has_many :hosts, :dependent => :destroy, :class_name => 'Mdm::Host'
-  has_many :imported_creds, :dependent => :destroy, :class_name => 'Mdm::ImportedCred'
   has_many :listeners, :dependent => :destroy, :class_name => 'Mdm::Listener'
   has_many :notes, :class_name => 'Mdm::Note'
   belongs_to :owner, :class_name => 'Mdm::User', :foreign_key => 'owner_id'

data/db/migrate/20130525015035_remove_campaign_id_from_clients.rb

@@ -0,0 +1,9 @@
+class RemoveCampaignIdFromClients < ActiveRecord::Migration
+  def up
+    remove_column :clients, :campaign_id
+  end
+
+  def down
+    remove_column :clients, :campaign_id, :integer
+  end
+end

data/db/migrate/20130525212420_drop_table_imported_creds.rb

@@ -0,0 +1,14 @@
+class DropTableImportedCreds < ActiveRecord::Migration
+  def up
+    drop_table :imported_creds
+  end
+
+  def down
+    create_table :imported_creds do |t|
+      t.integer   :workspace_id, :null => false, :default => 1
+      t.string    :user, :limit  => 512
+      t.string    :pass, :limit  => 512
+      t.string    :ptype, :limit  => 16, :default => "password"
+    end
+  end
+end

data/db/migrate/20130531144949_making_host_tags_a_real_ar_model.rb

@@ -0,0 +1,6 @@
+class MakingHostTagsARealArModel < ActiveRecord::Migration
+  def change
+    add_column :hosts_tags, :id, :primary_key
+  end
+
+end

data/lib/mdm/host/operating_system_normalization.rb

@@ -742,11 +742,11 @@ module Mdm::Host::OperatingSystemNormalization
         case data[:os]
           when /Windows/
             ret.update(parse_windows_os_str(data[:os]))
-          when /Linux ([^[:space:]]*) ([^[:space:]]*) .* (\(.*\))/
+          when /Linux (\d+\.\d+\.\d+\S*)\s* \((\w*)\)/
             ret[:os_name] = "Linux"
-            ret[:name]    = $1
-            ret[:os_sp]   = $2
-            ret[:arch]    = get_arch_from_string($3)
+            ret[:name]    = data[:name]
+            ret[:os_sp]   = $1
+            ret[:arch]    = get_arch_from_string($2)
           else
             ret[:os_name] = data[:os]
         end

data/lib/metasploit_data_models/version.rb

@@ -4,5 +4,5 @@ module MetasploitDataModels
   # metasploit-framework/data/sql/migrate to db/migrate in this project, not all models have specs that verify the
   # migrations (with have_db_column and have_db_index) and certain models may not be shared between metasploit-framework
   # and pro, so models may be removed in the future.  Because of the unstable API the version should remain below 1.0.0
-  VERSION = '0.15.2'
+  VERSION = '0.16.0'
 end

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

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Mdm::Client do
+
+  context 'associations' do
+    it { should belong_to(:host).class_name('Mdm::Host') }
+  end
+
+  context '#destroy' do
+    it 'should successfully destroy the object' do
+      client = FactoryGirl.create(:mdm_client, :ua_string => 'user-agent')
+      expect {
+        client.destroy
+      }.to_not raise_error
+      expect {
+        client.reload
+      }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  context 'factory' do
+    it 'should be valid' do
+      client = FactoryGirl.build(:mdm_client)
+      client.should be_valid
+    end
+  end
+
+  context 'database' do
+    context 'columns' do
+      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 { should have_db_column(:created_at).of_type(:datetime) }
+      it { should have_db_column(:updated_at).of_type(:datetime) }
+    end
+
+  end
+
+end

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

@@ -8,6 +8,217 @@ describe Mdm::Cred do
     it { should belong_to(:service).class_name('Mdm::Service') }
   end
 
+  context 'database' do
+    context 'timestamps' do
+      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 { 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
+
+  context '#destroy' do
+    it 'should successfully destroy the object and all dependent objects' do
+      cred = FactoryGirl.create(:mdm_cred)
+      task_cred = FactoryGirl.create(:mdm_task_cred, :cred => cred)
+      expect {
+        cred.destroy
+      }.to_not raise_error
+      expect {
+        cred.reload
+      }.to raise_error(ActiveRecord::RecordNotFound)
+      expect {
+        task_cred.reload
+      }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  context 'callbacks' do
+    context 'after_create' do
+      it 'should increment cred_count on the host' do
+        host = FactoryGirl.create(:mdm_host)
+        svc = FactoryGirl.create(:mdm_service, :host => host)
+        expect {
+          FactoryGirl.create(:mdm_cred, :service => svc)
+        }.to change{ Mdm::Host.find(host.id).cred_count}.by(1)
+      end
+    end
+
+    context 'after_destroy' do
+      it 'should decrement cred_count on the host' do
+        host = FactoryGirl.create(:mdm_host)
+        svc = FactoryGirl.create(:mdm_service, :host => host)
+        cred =FactoryGirl.create(:mdm_cred, :service => svc)
+        expect {
+          cred.destroy
+        }.to change{ Mdm::Host.find(host.id).cred_count}.by(-1)
+      end
+    end
+  end
+
+  context 'constants' do
+    it 'should define the key_id regex' do
+      described_class::KEY_ID_REGEX.should == /([0-9a-fA-F:]{47})/
+    end
+
+    it 'should define ptypes to humanize' do
+      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
+    before(:all) do
+      Mdm::Workspace.any_instance.stub(:valid_ip_or_range? => true)
+      workspace =  FactoryGirl.create(:mdm_workspace)
+      host = FactoryGirl.create(:mdm_host, :workspace => workspace)
+      @svc1 = FactoryGirl.create(:mdm_service, :host => host)
+      @svc2 = FactoryGirl.create(:mdm_service, :host => host)
+      @cred1 = FactoryGirl.create(:mdm_cred, :service => @svc1, :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")
+      @pubkey = FactoryGirl.create(:mdm_cred, :service => @svc1, :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")
+    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')
+        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')
+        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')
+        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')
+        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')
+        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')
+        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")
+        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")
+        cred.ssh_key_id.should == '57:c3:11:5d:77:c5:63:90:33:2d:c5:c4:99:78:62:7a'
+      end
+
+    end
+
+    context '#ssh_key_matches?' do
+      it 'should return true if the ssh_keys match' do
+        cred2 = FactoryGirl.create(:mdm_cred, :service => @svc2, :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")
+        cred2.ssh_key_matches?(@cred1).should == true
+      end
+
+      it 'should return false if passed something other than a cred' do
+        @cred1.ssh_key_matches?(@svc1).should == false
+      end
+
+      it 'should return false if the ptypes do not match' do
+        cred2 = FactoryGirl.create(:mdm_cred, :service => @svc2, :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")
+        cred2.ssh_key_matches?(@cred1).should == false
+      end
+
+      it 'should return false if the key ids do not match' do
+        cred2 = FactoryGirl.create(:mdm_cred, :service => @svc2, :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")
+        cred2.ssh_key_matches?(@cred1).should == false
+      end
+
+      it 'should behave the same for public keys as private keys' do
+        pubkey2 = FactoryGirl.create(:mdm_cred, :service => @svc1, :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 => @svc1, :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")
+        pubkey2.ssh_key_matches?(@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 => @svc2, :ptype => 'password', :user => 'msfadmin', :pass => 'msfadmin' )
+        cred3 = FactoryGirl.create(:mdm_cred, :service => @svc2, :ptype => 'password', :user => 'msfadmin', :pass => 'msfadmin' )
+        cred2.ssh_key_matches?(cred3).should == false
+      end
+    end
+
+    context '#ssh_keys' do
+      before(:all) do
+        @cred2 = FactoryGirl.create(:mdm_cred, :service => @svc2, :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")
+      end
+      it 'should return all ssh private keys with a matching id' do
+        @cred2.ssh_keys.should include(@cred1)
+      end
+
+      it 'should return all ssh public keys with a matching id' do
+        @cred2.ssh_keys.should include(@pubkey)
+      end
+    end
+
+    context '#ssh_private_keys' do
+      before(:all) do
+        @cred2 = FactoryGirl.create(:mdm_cred, :service => @svc2, :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")
+      end
+
+      it 'should return ssh private keys with matching ids' do
+        @cred2.ssh_private_keys.should include(@cred1)
+      end
+
+      it 'should not return ssh public keys with matching ids' do
+        @cred2.ssh_private_keys.should_not include(@pubkey)
+      end
+    end
+
+    context '#ssh_public_keys' do
+      before(:all) do
+        @cred2 = FactoryGirl.create(:mdm_cred, :service => @svc2, :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")
+      end
+
+      it 'should not return ssh private keys with matching ids' do
+        @cred2.ssh_public_keys.should_not include(@cred1)
+      end
+
+      it 'should return ssh public keys with matching ids' do
+        @cred2.ssh_public_keys.should include(@pubkey)
+      end
+    end
+
+  end
+
+  context 'factory' do
+    it 'should be valid' do
+      cred = FactoryGirl.build(:mdm_cred)
+      cred.should be_valid
+    end
+  end
 
 end

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

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Mdm::Event do
+
+  context 'associations' do
+    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 { should have_db_column(:created_at).of_type(:datetime) }
+      it { should have_db_column(:updated_at).of_type(:datetime) }
+    end
+
+    context 'columns' do
+      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
+
+  context '#destroy' do
+    it 'should successfully destroy the object and all dependent objects' do
+      event = FactoryGirl.create(:mdm_event)
+      expect {
+        event.destroy
+      }.to_not raise_error
+      expect {
+        event.reload
+      }.to raise_error(ActiveRecord::RecordNotFound)
+
+    end
+  end
+
+  context 'scopes' do
+    context 'flagged' do
+      it 'should exclude non-critical 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 => false)
+        flagged_set = Mdm::Event.flagged
+        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
+        flagged_set.should include(flagged_event)
+        flagged_set.should_not include(non_critical_event)
+      end
+    end
+
+    context 'module_run' do
+      it 'should only return module_run events' 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
+        flagged_set.should include(flagged_event)
+        flagged_set.should_not include(non_critical_event)
+      end
+    end
+  end
+
+  context 'validations' do
+    it 'should require name' do
+      unnamed_event = FactoryGirl.build(:mdm_event, :name => nil)
+      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)
+      event.should be_valid
+    end
+  end
+
+end