Class: Metasploit::Framework::CredentialCollection
- Inherits:
-
PrivateCredentialCollection
- Object
- PrivateCredentialCollection
- Metasploit::Framework::CredentialCollection
- Defined in:
- lib/metasploit/framework/credential_collection.rb
Instance Attribute Summary collapse
-
#additional_publics ⇒ Array<String>
Additional public values that should be tried.
-
#anonymous_login ⇒ Boolean
Whether to attempt an anonymous login (blank user/pass).
-
#password_spray ⇒ Boolean
Whether password spray is enabled.
-
#user_as_pass ⇒ Boolean
Whether each username should be tried as a password for that user.
-
#user_file ⇒ String
Path to a file containing usernames, one per line.
-
#username ⇒ String
The username that should be tried.
-
#userpass_file ⇒ String
Path to a file containing usernames and passwords separated by a space, one pair per line.
Attributes inherited from PrivateCredentialCollection
#additional_privates, #blank_passwords, #filter, #nil_passwords, #pass_file, #password, #prepended_creds, #realm
Instance Method Summary collapse
-
#add_public(public_str = '') ⇒ void
Adds a string as an additional public credential to be combined in the collection.
-
#each_filtered {|credential| ... } ⇒ void
(also: #each)
Combines all the provided credential sources into a stream of Credential objects, yielding them one at a time.
-
#each_unfiltered_password_first {|credential| ... } ⇒ void
When password spraying is enabled, do first passwords then usernames i.e.
-
#each_unfiltered_username_first {|credential| ... } ⇒ void
When password spraying is not enabled, do first usernames then passwords i.e.
-
#empty? ⇒ Boolean
Returns true when #each will have no results to iterate.
-
#has_privates? ⇒ Boolean
Returns true when there are any private values set.
-
#has_users? ⇒ Boolean
Returns true when there are any user values set.
-
#initialize(opts = {}) ⇒ CredentialCollection
constructor
A new instance of CredentialCollection.
Methods inherited from PrivateCredentialCollection
#add_private, #each_unfiltered, #filtered?, #prepend_cred, #private_type
Constructor Details
#initialize(opts = {}) ⇒ CredentialCollection
Returns a new instance of CredentialCollection.
223 224 225 226 |
# File 'lib/metasploit/framework/credential_collection.rb', line 223 def initialize(opts = {}) super self.additional_publics ||= [] end |
Instance Attribute Details
#additional_publics ⇒ Array<String>
Additional public values that should be tried
187 188 189 |
# File 'lib/metasploit/framework/credential_collection.rb', line 187 def additional_publics @additional_publics end |
#anonymous_login ⇒ Boolean
Whether to attempt an anonymous login (blank user/pass)
213 214 215 |
# File 'lib/metasploit/framework/credential_collection.rb', line 213 def anonymous_login @anonymous_login end |
#password_spray ⇒ Boolean
Whether password spray is enabled. When true, each password is tried against each username first. Otherwise the default bruteforce logic will attempt all passwords against the first user, before continuing to the next user
181 182 183 |
# File 'lib/metasploit/framework/credential_collection.rb', line 181 def password_spray @password_spray end |
#user_as_pass ⇒ Boolean
Whether each username should be tried as a password for that user
192 193 194 |
# File 'lib/metasploit/framework/credential_collection.rb', line 192 def user_as_pass @user_as_pass end |
#user_file ⇒ String
Path to a file containing usernames, one per line
197 198 199 |
# File 'lib/metasploit/framework/credential_collection.rb', line 197 def user_file @user_file end |
#username ⇒ String
The username that should be tried
202 203 204 |
# File 'lib/metasploit/framework/credential_collection.rb', line 202 def username @username end |
#userpass_file ⇒ String
Path to a file containing usernames and passwords separated by a space, one pair per line
208 209 210 |
# File 'lib/metasploit/framework/credential_collection.rb', line 208 def userpass_file @userpass_file end |
Instance Method Details
#add_public(public_str = '') ⇒ void
This method returns an undefined value.
Adds a string as an additional public credential to be combined in the collection.
233 234 235 |
# File 'lib/metasploit/framework/credential_collection.rb', line 233 def add_public(public_str='') additional_publics << public_str end |
#each_filtered {|credential| ... } ⇒ void Also known as: each
This method returns an undefined value.
Combines all the provided credential sources into a stream of Metasploit::Framework::Credential objects, yielding them one at a time
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/metasploit/framework/credential_collection.rb', line 242 def each_filtered if password_spray each_unfiltered_password_first do |credential| next unless self.filter.nil? || self.filter.call(credential) yield credential end else each_unfiltered_username_first do |credential| next unless self.filter.nil? || self.filter.call(credential) yield credential end end end |
#each_unfiltered_password_first {|credential| ... } ⇒ void
This method returns an undefined value.
When password spraying is enabled, do first passwords then usernames
i.e.
username1:password1
username2:password1
username3:password1
…
username1:password2
username2:password2
username3:password2
…
272 273 274 275 276 277 278 279 280 281 282 283 284 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 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/metasploit/framework/credential_collection.rb', line 272 def each_unfiltered_password_first if user_file.present? user_fd = File.open(user_file, 'r:binary') end prepended_creds.each { |c| yield c } if anonymous_login yield Metasploit::Framework::Credential.new(public: '', private: '', realm: realm, private_type: :password) end if password.present? if nil_passwords yield Metasploit::Framework::Credential.new(public: username, private: nil, realm: realm, private_type: :password) end if username.present? yield Metasploit::Framework::Credential.new(public: username, private: password, realm: realm, private_type: private_type(password)) end if user_as_pass yield Metasploit::Framework::Credential.new(public: username, private: username, realm: realm, private_type: :password) end if blank_passwords yield Metasploit::Framework::Credential.new(public: username, private: "", realm: realm, private_type: :password) end if user_fd user_fd.each_line do |user_from_file| user_from_file.chomp! yield Metasploit::Framework::Credential.new(public: user_from_file, private: password, realm: realm, private_type: private_type(password)) end user_fd.seek(0) end end if pass_file.present? File.open(pass_file, 'r:binary') do |pass_fd| pass_fd.each_line do |pass_from_file| pass_from_file.chomp! if username.present? yield Metasploit::Framework::Credential.new(public: username, private: pass_from_file, realm: realm, private_type: :password) end if user_as_pass yield Metasploit::Framework::Credential.new(public: pass_from_file, private: pass_from_file, realm: realm, private_type: :password) end next unless user_fd user_fd.each_line do |user_from_file| user_from_file.chomp! yield Metasploit::Framework::Credential.new(public: user_from_file, private: pass_from_file, realm: realm, private_type: private_type(pass_from_file)) end user_fd.seek(0) end end end if userpass_file.present? File.open(userpass_file, 'r:binary') do |userpass_fd| userpass_fd.each_line do |line| user, pass = line.split(" ", 2) if pass.blank? pass = '' else pass.chomp! end yield Metasploit::Framework::Credential.new(public: user, private: pass, realm: realm) end end end additional_privates.each do |add_private| if username.present? yield Metasploit::Framework::Credential.new(public: username, private: add_private, realm: realm, private_type: private_type(add_private)) end user_fd.each_line do |user_from_file| user_from_file.chomp! yield Metasploit::Framework::Credential.new(public: user_from_file, private: add_private, realm: realm, private_type: private_type(add_private)) end user_fd.seek(0) end additional_publics.each do |add_public| if password.present? yield Metasploit::Framework::Credential.new(public: add_public, private: password, realm: realm, private_type: private_type(password) ) end if user_as_pass yield Metasploit::Framework::Credential.new(public: add_public, private: user_from_file, realm: realm, private_type: :password) end if blank_passwords yield Metasploit::Framework::Credential.new(public: add_public, private: "", realm: realm, private_type: :password) end if nil_passwords yield Metasploit::Framework::Credential.new(public: add_public, private: nil, realm: realm, private_type: :password) end if user_fd user_fd.each_line do |user_from_file| user_from_file.chomp! yield Metasploit::Framework::Credential.new(public: add_public, private: user_from_file, realm: realm, private_type: private_type(user_from_file)) end user_fd.seek(0) end additional_privates.each do |add_private| yield Metasploit::Framework::Credential.new(public: add_public, private: add_private, realm: realm, private_type: private_type(add_private)) end end ensure user_fd.close if user_fd && !user_fd.closed? end |
#each_unfiltered_username_first {|credential| ... } ⇒ void
This method returns an undefined value.
When password spraying is not enabled, do first usernames then passwords
i.e.
username1:password1
username1:password2
username1:password3
…
username2:password1
username2:password2
username2:password3
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 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 |
# File 'lib/metasploit/framework/credential_collection.rb', line 390 def each_unfiltered_username_first if pass_file.present? pass_fd = File.open(pass_file, 'r:binary') end prepended_creds.each { |c| yield c } if anonymous_login yield Metasploit::Framework::Credential.new(public: '', private: '', realm: realm, private_type: :password) end if username.present? if nil_passwords yield Metasploit::Framework::Credential.new(public: username, private: nil, realm: realm, private_type: :password) end if password.present? yield Metasploit::Framework::Credential.new(public: username, private: password, realm: realm, private_type: private_type(password)) end if user_as_pass yield Metasploit::Framework::Credential.new(public: username, private: username, realm: realm, private_type: :password) end if blank_passwords yield Metasploit::Framework::Credential.new(public: username, private: "", realm: realm, private_type: :password) end if pass_fd pass_fd.each_line do |pass_from_file| pass_from_file.chomp! yield Metasploit::Framework::Credential.new(public: username, private: pass_from_file, realm: realm, private_type: private_type(pass_from_file)) end pass_fd.seek(0) end additional_privates.each do |add_private| yield Metasploit::Framework::Credential.new(public: username, private: add_private, realm: realm, private_type: private_type(add_private)) end end if user_file.present? File.open(user_file, 'r:binary') do |user_fd| user_fd.each_line do |user_from_file| user_from_file.chomp! if nil_passwords yield Metasploit::Framework::Credential.new(public: user_from_file, private: nil, realm: realm, private_type: :password) end if password.present? yield Metasploit::Framework::Credential.new(public: user_from_file, private: password, realm: realm, private_type: private_type(password) ) end if user_as_pass yield Metasploit::Framework::Credential.new(public: user_from_file, private: user_from_file, realm: realm, private_type: :password) end if blank_passwords yield Metasploit::Framework::Credential.new(public: user_from_file, private: "", realm: realm, private_type: :password) end if pass_fd pass_fd.each_line do |pass_from_file| pass_from_file.chomp! yield Metasploit::Framework::Credential.new(public: user_from_file, private: pass_from_file, realm: realm, private_type: private_type(pass_from_file)) end pass_fd.seek(0) end additional_privates.each do |add_private| yield Metasploit::Framework::Credential.new(public: user_from_file, private: add_private, realm: realm, private_type: private_type(add_private)) end end end end if userpass_file.present? File.open(userpass_file, 'r:binary') do |userpass_fd| userpass_fd.each_line do |line| user, pass = line.split(" ", 2) if pass.blank? pass = '' else pass.chomp! end yield Metasploit::Framework::Credential.new(public: user, private: pass, realm: realm) end end end additional_publics.each do |add_public| if password.present? yield Metasploit::Framework::Credential.new(public: add_public, private: password, realm: realm, private_type: private_type(password) ) end if user_as_pass yield Metasploit::Framework::Credential.new(public: add_public, private: user_from_file, realm: realm, private_type: :password) end if blank_passwords yield Metasploit::Framework::Credential.new(public: add_public, private: "", realm: realm, private_type: :password) end if pass_fd pass_fd.each_line do |pass_from_file| pass_from_file.chomp! yield Metasploit::Framework::Credential.new(public: add_public, private: pass_from_file, realm: realm, private_type: private_type(pass_from_file)) end pass_fd.seek(0) end additional_privates.each do |add_private| yield Metasploit::Framework::Credential.new(public: add_public, private: add_private, realm: realm, private_type: private_type(add_private)) end end ensure pass_fd.close if pass_fd && !pass_fd.closed? end |
#empty? ⇒ Boolean
Returns true when #each will have no results to iterate
498 499 500 |
# File 'lib/metasploit/framework/credential_collection.rb', line 498 def empty? prepended_creds.empty? && !has_users? && !anonymous_login || (has_users? && !has_privates?) end |
#has_privates? ⇒ Boolean
Returns true when there are any private values set
512 513 514 |
# File 'lib/metasploit/framework/credential_collection.rb', line 512 def has_privates? super || userpass_file.present? || user_as_pass end |
#has_users? ⇒ Boolean
Returns true when there are any user values set
505 506 507 |
# File 'lib/metasploit/framework/credential_collection.rb', line 505 def has_users? username.present? || user_file.present? || userpass_file.present? || !additional_publics.empty? end |