Module: Metasploit::Credential::Creation
- Included in:
- Importer::Core, Importer::Pwdump, Migrator
- Defined in:
- lib/metasploit/credential/creation.rb
Overview
Instance Method Summary collapse
-
#active_db? ⇒ Boolean
Returns true if ActiveRecord has an active database connection, false otherwise.
-
#create_cracked_credential(opts = {}) ⇒ Object
This method takes a few simple parameters and creates a new username/password credential that was obtained by cracking a hash.
-
#create_credential(opts = {}) ⇒ NilClass, Metasploit::Credential::Core
This method is responsible for creation Core objects and all sub-objects that it is dependent upon.
- #create_credential_and_login(opts = {}) ⇒ Object
-
#create_credential_core(opts = {}) ⇒ NilClass, Metasploit::Credential::Core
This method is responsible for creating Core objects.
- #create_credential_login(opts = {}) ⇒ NilClass, Metasploit::Credential::Login
-
#create_credential_origin(opts = {}) ⇒ NilClass, ...
This method is responsible for creating the various Credential::Origin objects.
-
#create_credential_origin_cracked_password(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::CrackedPassword
This method is responsible for creating Origin::CrackedPassword objects.
-
#create_credential_origin_import(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Manual
This method is responsible for creating Origin::Import objects.
-
#create_credential_origin_manual(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Manual
This method is responsible for creating Origin::Manual objects.
-
#create_credential_origin_service(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Service
This method is responsible for creating Origin::Service objects.
-
#create_credential_origin_session(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Session
This method is responsible for creating Origin::Session objects.
-
#create_credential_private(opts = {}) ⇒ NilClass, ...
This method is responsible for the creation of Private objects.
-
#create_credential_public(opts = {}) ⇒ NilClass, Metasploit::Credential::Public
This method is responsible for the creation of Public objects.
-
#create_credential_realm(opts = {}) ⇒ NilClass, Metasploit::Credential::Realm
This method is responsible for creating the Realm objects that may be required.
-
#create_credential_service(opts = {}) ⇒ NilClass, Mdm::Service
This method is responsible for creating a barebones ‘Mdm::Service` object for use by Credential object creation.
-
#invalidate_login(opts = {}) ⇒ void
This method checks to see if a Login exists for a given set of details.
Instance Method Details
#active_db? ⇒ Boolean
Returns true if ActiveRecord has an active database connection, false otherwise.
8 9 10 |
# File 'lib/metasploit/credential/creation.rb', line 8 def active_db? ActiveRecord::Base.connected? end |
#create_cracked_credential(opts = {}) ⇒ Object
This method takes a few simple parameters and creates a new username/password credential that was obtained by cracking a hash. It reuses the relevant components form the originating Metasploit::Credential::Core and builds new Login objects based on the ones attached to the originating Metasploit::Credential::Core
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/metasploit/credential/creation.rb', line 21 def create_cracked_credential(opts={}) return nil unless active_db? if self.respond_to?(:[]) and self[:task] opts[:task_id] ||= self[:task].record.id end username = opts.fetch(:username) password = opts.fetch(:password) core_id = opts.fetch(:core_id) private = nil public = nil old_core = nil old_realm_id = nil retry_transaction do private = Metasploit::Credential::Password.where(data: password).first_or_create! public = Metasploit::Credential::Public.where(username: username).first_or_create! old_core = Metasploit::Credential::Core.find(core_id) old_realm_id = old_core.realm.id if old_core.realm end core = nil retry_transaction do core = Metasploit::Credential::Core.where(public_id: public.id, private_id: private.id, realm_id: old_realm_id, workspace_id: old_core.workspace_id).first_or_initialize if core.origin_id.nil? origin = Metasploit::Credential::Origin::CrackedPassword.where(metasploit_credential_core_id: core_id).first_or_create! core.origin = origin end if opts[:task_id] core.tasks << Mdm::Task.find(opts[:task_id]) end core.save! end old_core.logins.each do |login| service_id = login.service_id new_login = Metasploit::Credential::Login.where(core_id: core.id, service_id: service_id).first_or_initialize if new_login.status.blank? new_login.status = Metasploit::Model::Login::Status::UNTRIED end new_login.save! end core end |
#create_credential(opts = {}) ⇒ NilClass, Metasploit::Credential::Core
This method is responsible for creation Metasploit::Credential::Core objects and all sub-objects that it is dependent upon.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/metasploit/credential/creation.rb', line 107 def create_credential(opts={}) return nil unless active_db? if self.respond_to?(:[]) and self[:task] opts[:task_id] ||= self[:task].record.id end if opts[:origin] origin = opts[:origin] else origin = create_credential_origin(opts) end core_opts = { origin: origin, workspace_id: opts.fetch(:workspace_id) } if opts.has_key?(:realm_key) && opts.has_key?(:realm_value) core_opts[:realm] = create_credential_realm(opts) end if opts.has_key?(:private_type) && opts.has_key?(:private_data) core_opts[:private] = create_credential_private(opts) end if opts.has_key?(:username) core_opts[:public] = create_credential_public(opts) end if opts.has_key?(:task_id) core_opts[:task_id] = opts[:task_id] end create_credential_core(core_opts) end |
#create_credential_and_login(opts = {}) ⇒ Object
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/metasploit/credential/creation.rb', line 193 def create_credential_and_login(opts={}) return nil unless active_db? if self.respond_to?(:[]) and self[:task] opts[:task_id] ||= self[:task].record.id end core = opts.fetch(:core, create_credential(opts)) access_level = opts.fetch(:access_level, nil) last_attempted_at = opts.fetch(:last_attempted_at, nil) status = opts.fetch(:status, Metasploit::Model::Login::Status::UNTRIED) login_object = nil retry_transaction do service_object = create_credential_service(opts) login_object = Metasploit::Credential::Login.where(core_id: core.id, service_id: service_object.id).first_or_initialize if opts[:task_id] login_object.tasks << Mdm::Task.find(opts[:task_id]) end login_object.access_level = access_level if access_level login_object.last_attempted_at = last_attempted_at if last_attempted_at if status == Metasploit::Model::Login::Status::UNTRIED if login_object.last_attempted_at.nil? login_object.status = status end else login_object.status = status end login_object.save! end login_object end |
#create_credential_core(opts = {}) ⇒ NilClass, Metasploit::Credential::Core
This method is responsible for creating Metasploit::Credential::Core objects.
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/metasploit/credential/creation.rb', line 239 def create_credential_core(opts={}) return nil unless active_db? if self.respond_to?(:[]) and self[:task] opts[:task_id] ||= self[:task].record.id end origin = opts.fetch(:origin) workspace_id = opts.fetch(:workspace_id) private_id = opts[:private].try(:id) public_id = opts[:public].try(:id) realm_id = opts[:realm].try(:id) core = nil retry_transaction do core = Metasploit::Credential::Core.where(private_id: private_id, public_id: public_id, realm_id: realm_id, workspace_id: workspace_id).first_or_initialize if core.origin_id.nil? core.origin = origin end if opts[:task_id] core.tasks << Mdm::Task.find(opts[:task_id]) end core.save! end core end |
#create_credential_login(opts = {}) ⇒ NilClass, Metasploit::Credential::Login
This method is responsible for creating a Login object which ties a Metasploit::Credential::Core to the ‘Mdm::Service` it is a valid credential for.
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/metasploit/credential/creation.rb', line 285 def create_credential_login(opts={}) return nil unless active_db? if self.respond_to?(:[]) and self[:task] opts[:task_id] ||= self[:task].record.id end core = opts.fetch(:core) access_level = opts.fetch(:access_level, nil) last_attempted_at = opts.fetch(:last_attempted_at, nil) status = opts.fetch(:status, Metasploit::Model::Login::Status::UNTRIED) login_object = nil retry_transaction do service_object = create_credential_service(opts) login_object = Metasploit::Credential::Login.where(core_id: core.id, service_id: service_object.id).first_or_initialize if opts[:task_id] login_object.tasks << Mdm::Task.find(opts[:task_id]) end login_object.access_level = access_level if access_level login_object.last_attempted_at = last_attempted_at if last_attempted_at if status == Metasploit::Model::Login::Status::UNTRIED if login_object.last_attempted_at.nil? login_object.status = status end else login_object.status = status end login_object.save! end login_object end |
#create_credential_origin(opts = {}) ⇒ NilClass, ...
This method is responsible for creating the various Credential::Origin objects. It takes a key for the Origin type and delegates to the correct sub-method.
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 |
# File 'lib/metasploit/credential/creation.rb', line 343 def create_credential_origin(opts={}) return nil unless active_db? case opts[:origin_type] when :cracked_password create_credential_origin_cracked_password(opts) when :import create_credential_origin_import(opts) when :manual create_credential_origin_manual(opts) when :service create_credential_origin_service(opts) when :session create_credential_origin_session(opts) else raise ArgumentError, "Unknown Origin Type #{opts[:origin_type]}" end end |
#create_credential_origin_cracked_password(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::CrackedPassword
This method is responsible for creating Origin::CrackedPassword objects. These are the origins that show that a password Credential was obtained by cracking a hash Credential that previously existed in the database.
368 369 370 371 372 373 374 375 |
# File 'lib/metasploit/credential/creation.rb', line 368 def create_credential_origin_cracked_password(opts={}) return nil unless active_db? originating_core_id = opts.fetch(:originating_core_id) retry_transaction do Metasploit::Credential::Origin::CrackedPassword.where(metasploit_credential_core_id: originating_core_id ).first_or_create! end end |
#create_credential_origin_import(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Manual
This method is responsible for creating Origin::Import objects.
383 384 385 386 387 388 389 390 |
# File 'lib/metasploit/credential/creation.rb', line 383 def create_credential_origin_import(opts={}) return nil unless active_db? filename = opts.fetch(:filename) retry_transaction do Metasploit::Credential::Origin::Import.where(filename: filename).first_or_create! end end |
#create_credential_origin_manual(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Manual
This method is responsible for creating Origin::Manual objects.
398 399 400 401 402 403 404 405 |
# File 'lib/metasploit/credential/creation.rb', line 398 def create_credential_origin_manual(opts={}) return nil unless active_db? user_id = opts.fetch(:user_id) retry_transaction do Metasploit::Credential::Origin::Manual.where(user_id: user_id).first_or_create! end end |
#create_credential_origin_service(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Service
This method is responsible for creating Origin::Service objects. If there is not a matching ‘Mdm::Host` it will create it. If there is not a matching `Mdm::Service` it will create that too.
419 420 421 422 423 424 425 426 427 428 429 |
# File 'lib/metasploit/credential/creation.rb', line 419 def create_credential_origin_service(opts={}) return nil unless active_db? module_fullname = opts.fetch(:module_fullname) service_object = create_credential_service(opts) retry_transaction do Metasploit::Credential::Origin::Service.where(service_id: service_object.id, module_full_name: module_fullname).first_or_create! end end |
#create_credential_origin_session(opts = {}) ⇒ NilClass, Metasploit::Credential::Origin::Session
This method is responsible for creating Origin::Session objects.
438 439 440 441 442 443 444 445 446 |
# File 'lib/metasploit/credential/creation.rb', line 438 def create_credential_origin_session(opts={}) return nil unless active_db? session_id = opts.fetch(:session_id) post_reference_name = opts.fetch(:post_reference_name) retry_transaction do Metasploit::Credential::Origin::Session.where(session_id: session_id, post_reference_name: post_reference_name).first_or_create! end end |
#create_credential_private(opts = {}) ⇒ NilClass, ...
This method is responsible for the creation of Private objects. It will create the correct subclass based on the type.
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/metasploit/credential/creation.rb', line 461 def create_credential_private(opts={}) return nil unless active_db? private_data = opts.fetch(:private_data) private_type = opts.fetch(:private_type) private_object = nil retry_transaction do if private_data.blank? private_object = Metasploit::Credential::BlankPassword.where(data:'').first_or_create else case private_type when :password private_object = Metasploit::Credential::Password.where(data: private_data).first_or_create when :ssh_key private_object = Metasploit::Credential::SSHKey.where(data: private_data).first_or_create when :ntlm_hash private_object = Metasploit::Credential::NTLMHash.where(data: private_data).first_or_create private_object.jtr_format = 'nt,lm' when :postgres_md5 private_object = Metasploit::Credential::PostgresMD5.where(data: private_data).first_or_create private_object.jtr_format = 'raw-md5,postgres' when :nonreplayable_hash private_object = Metasploit::Credential::NonreplayableHash.where(data: private_data).first_or_create if opts[:jtr_format].present? private_object.jtr_format = opts[:jtr_format] end else raise ArgumentError, "Invalid Private type: #{private_type}" end end private_object.save! end private_object end |
#create_credential_public(opts = {}) ⇒ NilClass, Metasploit::Credential::Public
This method is responsible for the creation of Public objects.
503 504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/metasploit/credential/creation.rb', line 503 def create_credential_public(opts={}) return nil unless active_db? username = opts.fetch(:username) retry_transaction do if username.blank? Metasploit::Credential::BlankUsername.where(username:'').first_or_create! else Metasploit::Credential::Username.where(username: username).first_or_create! end end end |
#create_credential_realm(opts = {}) ⇒ NilClass, Metasploit::Credential::Realm
This method is responsible for creating the Realm objects that may be required.
524 525 526 527 528 529 530 531 532 |
# File 'lib/metasploit/credential/creation.rb', line 524 def create_credential_realm(opts={}) return nil unless active_db? realm_key = opts.fetch(:realm_key) realm_value = opts.fetch(:realm_value) retry_transaction do Metasploit::Credential::Realm.where(key: realm_key, value: realm_value).first_or_create! end end |
#create_credential_service(opts = {}) ⇒ NilClass, Mdm::Service
This method is responsible for creating a barebones ‘Mdm::Service` object for use by Credential object creation.
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 |
# File 'lib/metasploit/credential/creation.rb', line 547 def create_credential_service(opts={}) return nil unless active_db? address = opts.fetch(:address) port = opts.fetch(:port) service_name = opts.fetch(:service_name) protocol = opts.fetch(:protocol) workspace_id = opts.fetch(:workspace_id) host_object = Mdm::Host.where(address: address, workspace_id: workspace_id).first_or_create service_object = Mdm::Service.where(host_id: host_object.id, port: port, proto: protocol).first_or_initialize service_object.name = service_name service_object.state = "open" service_object.save! service_object end |
#invalidate_login(opts = {}) ⇒ void
This method returns an undefined value.
This method checks to see if a Login exists for a given set of details. If it does exists, we then appropriately set the status to one of our failure statuses.
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 |
# File 'lib/metasploit/credential/creation.rb', line 577 def invalidate_login(opts = {}) return nil unless active_db? address = opts.fetch(:address) port = opts.fetch(:port) protocol = opts.fetch(:protocol) public = opts.fetch(:username, nil) private = opts.fetch(:private_data, nil) realm_key = opts.fetch(:realm_key, nil) realm_value = opts.fetch(:realm_value, nil) status = opts.fetch(:status) pub_obj = Metasploit::Credential::Public.where(username: public).first.try(:id) priv_obj = Metasploit::Credential::Private.where(data: private).first.try(:id) realm_obj = Metasploit::Credential::Realm.where(key: realm_key, value: realm_value).first.try(:id) core = Metasploit::Credential::Core.where(public_id: pub_obj, private_id: priv_obj, realm_id: realm_obj).first # Do nothing else if we have no matching core. Otherwise look for a Login. if core.present? login = core.logins.joins(service: :host).where(services: { port: port, proto: protocol } ).where( hosts: {address: address}).readonly(false).first if login.present? login.status = status login.last_attempted_at = DateTime.now login.save! end end end |