metasploit-credential 6.0.4 → 6.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97884e997f5fe9428e4fc79f0b4a9e4a4e51a06363b372a2fa1affa0dffba6d5
-  data.tar.gz: 37e4b1a543e249e7facb0c6570efd104d4bf347922636b561aecb78bab0602a8
+  metadata.gz: c890cd98fc73ff6cbd909ded7207646f534477a4308f60f1e7dc09231cd29d88
+  data.tar.gz: 62fd27bcb61c852fb705cb89a0848771f6c4ae64b6a3c76202228ea6d2037969
 SHA512:
-  metadata.gz: 23da300c2d52cd12a8aeb398010b21d2542ab4f88f59946fabde21efbb3554c30f36b32839961abef13c43528324ddacc807d68872cc9df3bbf2e47d31c66905
-  data.tar.gz: 90f93c7bd036e2f6b328dca97707d5e85bd40a257cb6f7dba928d0d6fd983cd295e38b3052cb6aae271c37bd730e4b5c36e71feed1e1dc561bb0b163c207d098
+  metadata.gz: 06bf39bbda84fc40c4f25085a39e4f27211a50246879fbe3b50f034c502a9b6fcf7cebbe9292912a4bfc42f8804837a45e8cbc332253b5f3fc5b122983f6b23e
+  data.tar.gz: d361ca8222849ab597accea494fef812339b971537bcd9cdbc3259eb19271a57f31cd1773c8338282211bf43569ee507888eb09f7326799b9ec6d66140bc50cd

data/app/models/metasploit/credential/krb_enc_key.rb

@@ -73,7 +73,8 @@ class Metasploit::Credential::KrbEncKey < Metasploit::Credential::PasswordHash
   # Callbacks
   #
 
-  before_validation :normalize_data
+  serialize :data, Metasploit::Credential::CaseInsensitiveSerializer
+  validates_uniqueness_of :data, :case_sensitive => false
 
   #
   # Validations
@@ -162,15 +163,6 @@ class Metasploit::Credential::KrbEncKey < Metasploit::Credential::PasswordHash
     }
   end
 
-  # Normalizes {#data} by making it all lowercase so that the unique validation and index on
-  # ({Metasploit::Credential::Private#type}, {#data}) catches collision in a case-insensitive manner without the need
-  # to use case-insensitive comparisons.
-  def normalize_data
-    if data
-      self.data = data.downcase
-    end
-  end
-
   # Validates that {#data} is in the expected data format
   def data_format
     unless DATA_REGEXP.match(data)

data/app/models/metasploit/credential/ntlm_hash.rb

@@ -55,15 +55,18 @@ class Metasploit::Credential::NTLMHash < Metasploit::Credential::ReplayableHash
   #   @return [String] `'<LAN Manager hex digest>:<NT LAN Manager hex digest>'`
 
   #
-  # Callbacks
+  # Serializers
   #
 
-  before_validation :normalize_data
+  # Hash results are always downcased when stored in the database
+  # This serializer allows for ORM to search in a case-insensitive
+  serialize :data, Metasploit::Credential::CaseInsensitiveSerializer
 
   #
   # Validations
   #
 
+  validates_uniqueness_of :data, :case_sensitive => false
   validate :data_format
 
   #
@@ -130,15 +133,6 @@ class Metasploit::Credential::NTLMHash < Metasploit::Credential::ReplayableHash
 
   private
 
-  # Normalizes {#data} by making it all lowercase so that the unique validation and index on
-  # ({Metasploit::Credential::Private#type}, {#data}) catches collision in a case-insensitive manner without the need
-  # to use case-insensitive comparisons.
-  def normalize_data
-    if data
-      self.data = data.downcase
-    end
-  end
-
   # Validates that {#data} is in the NTLM data format of <LAN Manager hex digest>:<NT LAN Manager hex digest>. Both hex
   # digests are 32 lowercase hexadecimal characters.
   def data_format

data/app/models/metasploit/credential/postgres_md5.rb

@@ -13,7 +13,8 @@ class Metasploit::Credential::PostgresMD5 < Metasploit::Credential::ReplayableHa
   # Callbacks
   #
 
-  before_validation :normalize_data
+  serialize :data, Metasploit::Credential::CaseInsensitiveSerializer
+  validates_uniqueness_of :data, :case_sensitive => false
 
   #
   # Validations
@@ -23,15 +24,6 @@ class Metasploit::Credential::PostgresMD5 < Metasploit::Credential::ReplayableHa
 
   private
 
-  # Normalizes {#data} by making it all lowercase so that the unique validation and index on
-  # ({Metasploit::Credential::Private#type}, {#data}) catches collision in a case-insensitive manner without the need
-  # to use case-insensitive comparisons.
-  def normalize_data
-    if data
-      self.data = data.downcase
-    end
-  end
-
   def data_format
     unless DATA_REGEXP.match(data)
       errors.add(:data, 'is not in Postgres MD5 Hash format')

data/lib/metasploit/credential/case_insensitive_serializer.rb

@@ -0,0 +1,9 @@
+class Metasploit::Credential::CaseInsensitiveSerializer
+    def self.load(value)
+        value
+    end
+
+    def self.dump(value)
+        value.downcase
+    end
+end

data/lib/metasploit/credential/importer/core.rb

@@ -116,7 +116,6 @@ class Metasploit::Credential::Importer::Core
         private_class = row['private_type'].present? ? row['private_type'].constantize : ''
         private_data  = row['private_data'].present? ? row['private_data'] : ''
 
-
         if realms[realm_value].nil?
           realms[realm_value]  = Metasploit::Credential::Realm.where(key: realm_key, value: realm_value).first_or_create
         end
@@ -210,7 +209,7 @@ class Metasploit::Credential::Importer::Core
         if private_data.strip == BLANK_TOKEN
           private_object_for_row = Metasploit::Credential::BlankPassword.first_or_create
         else
-          private_object_for_row = @private_credential_type.constantize.where(data: row['private_data']).first_or_create
+          private_object_for_row = @private_credential_type.constantize.where(data: private_data).first_or_create
         end
 
         # need to check private_object_for_row.valid? to raise a user facing message if any cred had invalid private

data/lib/metasploit/credential/version.rb

@@ -3,7 +3,7 @@
 module Metasploit
   module Credential
     # VERSION is managed by GemRelease
-    VERSION = '6.0.4'
+    VERSION = '6.0.5'
 
     # @return [String]
     #

data/lib/metasploit/credential.rb

@@ -28,6 +28,7 @@ module Metasploit
 
     autoload :BlankPassword
     autoload :BlankUsername
+    autoload :CaseInsensitiveSerializer
     autoload :Core
     autoload :CoreValidations
     autoload :Creation

data/spec/dummy/config/database.yml

@@ -1,6 +1,6 @@
 development: &pgsql
   adapter: postgresql
-  database: metasploit-credential_development3
+  database: metasploit-credential_development2
   username: msf
   password: pass123
   host: localhost
@@ -10,4 +10,4 @@ development: &pgsql
   min_messages: warning
 test:
   <<: *pgsql
-  database: metasploit-credential_test3
+  database: metasploit-credential_test2

data/spec/lib/metasploit/credential/creation_spec.rb

@@ -178,6 +178,37 @@ RSpec.describe Metasploit::Credential::Creation do
         end
       end
     end
+    context 'deletion and creation' do
+      let(:private_data) { 'md5ac4bbe016b808c3c0b816981f240dcae' }
+      let(:private_data_upcase) { private_data.upcase }
+      let(:credential_data) {{
+        workspace_id: workspace.id,
+        user_id: user.id,
+        origin_type: :manual,
+        username: 'admin',
+        private_data: private_data,
+        private_type: :postgres_md5
+      }}
+      it 'creates a private cred' do
+        expect{ test_object.create_credential(credential_data) }.to change{ Metasploit::Credential::PostgresMD5.count }.by(1)
+      end
+      let(:credential_data_upcase) {{
+        workspace_id: workspace.id,
+        user_id: user.id,
+        origin_type: :manual,
+        username: 'admin',
+        private_data: private_data_upcase,
+        private_type: :postgres_md5
+      }}
+      it 'allows for the recreation of core with case insensitive private credentials set to different case' do
+        expect{ test_object.create_credential(credential_data) }.to change{ Metasploit::Credential::PostgresMD5.count }.by(1)
+        expect{ Metasploit::Credential::Core.first.destroy }.to change{ Metasploit::Credential::Core.count }.by(-1)
+        expect( Metasploit::Credential::PostgresMD5.count ).to eq(1)
+        expect( Metasploit::Credential::Core.count ).to eq(0)
+        expect{ test_object.create_credential(credential_data_upcase) }.to change{ Metasploit::Credential::Core.count }.by(1)
+        expect( Metasploit::Credential::PostgresMD5.count ).to eq(1)
+      end
+    end
   end
 
   context '#create_credential_and_login' do

data/spec/models/metasploit/credential/krb_enc_key_spec.rb

@@ -148,4 +148,30 @@ RSpec.describe Metasploit::Credential::KrbEncKey, type: :model do
       end
     end
   end
+
+  context 'serialization' do
+    context '#first_or_create' do
+      let(:data) { 'msf_krbenckey:23:e22e04519aa757d12f1219c4f31252f4:' }
+      let(:upcase_data) {data.upcase}
+
+      context 'creates a new instance that stores case-insensitive value' do
+        it 'creates case insensitive data' do
+          expect{ Metasploit::Credential::KrbEncKey.where(data: data).first_or_create }.to change{Metasploit::Credential::KrbEncKey.count}.by(1)
+          expect{ Metasploit::Credential::KrbEncKey.where(data: upcase_data).first_or_create }.not_to change{Metasploit::Credential::KrbEncKey.count}
+        end
+      end
+
+      context 'finds an existing case insensitive match' do
+        let(:krb_enc_key) do
+          FactoryBot.build(
+              :metasploit_credential_krb_enc_key,
+              data: upcase_data
+          )
+        end
+        it 'successfully looks up credential in case insensitive way' do
+          expect( krb_enc_key.data ).to eq(data)
+        end
+      end
+    end
+  end
 end

data/spec/models/metasploit/credential/ntlm_hash_spec.rb

@@ -397,5 +397,29 @@ RSpec.describe Metasploit::Credential::NTLMHash, type: :model do
     end
   end
 
+  context 'serialization' do
+    context '#first_or_create' do
+      let(:data) { 'aad3b435b51404eeaad3b435b51404ee:4dc0249ad90ab626362050195893c788' }
+      let(:upcase_data) {data.upcase}
+
+      context 'creates a new instance that stores case-insensitive value' do
+        it 'creates case insensitive data' do
+          expect{ Metasploit::Credential::NTLMHash.where(data: data).first_or_create }.to change{Metasploit::Credential::NTLMHash.count}.by(1)
+          expect{ Metasploit::Credential::NTLMHash.where(data: upcase_data).first_or_create }.not_to change{Metasploit::Credential::NTLMHash.count}
+        end
+      end
 
+      context 'finds an existing case insensitive match' do
+        let(:ntlm_hash) do
+          FactoryBot.build(
+              :metasploit_credential_ntlm_hash,
+              data: upcase_data
+          )
+        end
+        it 'successfully looks up credential in case insensitive way' do
+          expect( ntlm_hash.data ).to eq(data)
+        end
+      end
+    end
+  end
 end

data/spec/models/metasploit/credential/postgres_md5_spec.rb

@@ -119,4 +119,30 @@ RSpec.describe Metasploit::Credential::PostgresMD5, type: :model do
     end
   end
 
+  context 'serialization' do
+    context '#first_or_create' do
+      let(:data) { "md5#{SecureRandom.hex(16)}" }
+      let(:upcase_data) {data.upcase}
+
+      context 'creates a new instance that stores case-insensitive value' do
+        it 'creates case insensitive data' do
+          expect{ Metasploit::Credential::PostgresMD5.where(data: data).first_or_create }.to change{Metasploit::Credential::PostgresMD5.count}.by(1)
+          expect{ Metasploit::Credential::PostgresMD5.where(data: upcase_data).first_or_create }.not_to change{Metasploit::Credential::PostgresMD5.count}
+        end
+      end
+
+      context 'finds an existing case insensitive match' do
+        let(:postgres_md5) do
+          FactoryBot.build(
+            :metasploit_credential_postgres_md5,
+            data: upcase_data
+          )
+        end
+
+        it 'successfully looks up credential in case insensitive way' do
+          expect( postgres_md5.data ).to eq(data)
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-credential
 version: !ruby/object:Gem::Version
-  version: 6.0.4
+  version: 6.0.5
 platform: ruby
 authors:
 - Metasploit Hackers
@@ -93,7 +93,7 @@ cert_chain:
   EknWpNgVhohbot1lfVAMmIhdtOVaRVcQQixWPwprDj/ydB8ryDMDosIMcw+fkoXU
   9GJsSaSRRYQ9UUkVL27b64okU8D48m8=
   -----END CERTIFICATE-----
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metasploit-concern
@@ -291,6 +291,7 @@ files:
 - db/migrate/20161107203710_create_index_on_private_data_and_type_for_ssh_key.rb
 - db/migrate/20221209005658_create_index_on_private_data_and_type_for_pkcs12.rb
 - lib/metasploit/credential.rb
+- lib/metasploit/credential/case_insensitive_serializer.rb
 - lib/metasploit/credential/core_validations.rb
 - lib/metasploit/credential/creation.rb
 - lib/metasploit/credential/engine.rb