Class: Metasploit::Framework::PrivateCredentialCollection

Inherits:
Object
  • Object
show all
Defined in:
lib/metasploit/framework/credential_collection.rb

Direct Known Subclasses

CredentialCollection

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ PrivateCredentialCollection

Returns a new instance of PrivateCredentialCollection.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :nil_passwords (Boolean) —

    See #nil_passwords

  • :blank_passwords (Boolean) —

    See #blank_passwords

  • :pass_file (String) —

    See #pass_file

  • :password (String) —

    See #password

  • :prepended_creds (Array<Credential>) — default: [] —

    See #prepended_creds

  • :user_as_pass (Boolean) —

    See #user_as_pass

  • :user_file (String) —

    See #user_file

  • :username (String) —

    See #username

  • :userpass_file (String) —

    See #userpass_file

  • :usernames_only (String) —

    See #usernames_only



57
58
59
60
61
62
63
64
 
# File 'lib/metasploit/framework/credential_collection.rb', line 57

def initialize(opts = {})
  opts.each do |attribute, value|
    public_send("#{attribute}=", value)
  end
  self.prepended_creds     ||= []
  self.additional_privates ||= []
  self.filter = nil
end

Instance Attribute Details

#additional_privates ⇒ Array<String>

Additional private values that should be tried

Returns:

  • (Array<String>) 


9
10
11
 
# File 'lib/metasploit/framework/credential_collection.rb', line 9

def additional_privates
  @additional_privates
end

#blank_passwords ⇒ Boolean

Whether each username should be tried with a blank password

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/metasploit/framework/credential_collection.rb', line 14

def blank_passwords
  @blank_passwords
end

#filter ⇒ Object

A block that can be used to filter credential objects



45
46
47
 
# File 'lib/metasploit/framework/credential_collection.rb', line 45

def filter
  @filter
end

#nil_passwords ⇒ Boolean

Whether each username should be tried with a nil password

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/metasploit/framework/credential_collection.rb', line 19

def nil_passwords
  @nil_passwords
end

#pass_file ⇒ String

Path to a file containing passwords, one per line

Returns:

  • (String) 


24
25
26
 
# File 'lib/metasploit/framework/credential_collection.rb', line 24

def pass_file
  @pass_file
end

#password ⇒ String

The password that should be tried

Returns:

  • (String) 


29
30
31
 
# File 'lib/metasploit/framework/credential_collection.rb', line 29

def password
  @password
end

#prepended_creds ⇒ Array<Credential>

List of credentials to be tried before any others

Returns:

See Also:



36
37
38
 
# File 'lib/metasploit/framework/credential_collection.rb', line 36

def prepended_creds
  @prepended_creds
end

#realm ⇒ String

The authentication realm associated with this password

Returns:

  • (String) 


41
42
43
 
# File 'lib/metasploit/framework/credential_collection.rb', line 41

def realm
  @realm
end

Instance Method Details

#add_private(private_str = '') ⇒ void

This method returns an undefined value.

Adds a string as an additional private credential to be combined in the collection.

Parameters:

  • private_str (String) (defaults to: '') —

    The string to use as a private credential



71
72
73
 
# File 'lib/metasploit/framework/credential_collection.rb', line 71

def add_private(private_str='')
  additional_privates << private_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 Credential objects, yielding them one at a time

Yield Parameters:



90
91
92
93
94
95
96
 
# File 'lib/metasploit/framework/credential_collection.rb', line 90

def each_filtered
  each_unfiltered do |credential|
    next unless self.filter.nil? || self.filter.call(credential)

    yield credential
  end
end

#each_unfiltered {|credential| ... } ⇒ void

This method returns an undefined value.

Combines all the provided credential sources into a stream of Credential objects, yielding them one at a time

Yield Parameters:



103
104
105
106
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
 
# File 'lib/metasploit/framework/credential_collection.rb', line 103

def each_unfiltered
  if pass_file.present?
    pass_fd = File.open(pass_file, 'r:binary')
  end

  prepended_creds.each { |c| yield c }

  if password.present?
    yield Metasploit::Framework::Credential.new(private: password, realm: realm, private_type: private_type(password))
  end
  if blank_passwords
    yield Metasploit::Framework::Credential.new(private: "", realm: realm, private_type: :password)
  end
  if nil_passwords
    yield Metasploit::Framework::Credential.new(private: nil, 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(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(private: add_private, realm: realm, private_type: private_type(add_private))
  end

ensure
  pass_fd.close if pass_fd && !pass_fd.closed?
end

#empty? ⇒ Boolean

Returns true when #each will have no results to iterate

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/metasploit/framework/credential_collection.rb', line 137

def empty?
  prepended_creds.empty? && !has_privates?
end

#filtered? ⇒ Boolean

Returns true when a filter is defined

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/metasploit/framework/credential_collection.rb', line 144

def filtered?
  !self.filter.nil?
end

#has_privates? ⇒ Boolean

Returns true when there are any private values set

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/metasploit/framework/credential_collection.rb', line 151

def has_privates?
  password.present? || pass_file.present? || !additional_privates.empty? || blank_passwords || nil_passwords
end

#prepend_cred(cred) ⇒ self

Add credentials that will be yielded by #each

Parameters:

Returns:

  • (self)

See Also:



80
81
82
83
 
# File 'lib/metasploit/framework/credential_collection.rb', line 80

def prepend_cred(cred)
  prepended_creds.unshift cred
  self
end

#private_type(private) ⇒ Symbol (protected)

Analyze a private value to determine its type by checking it against a known list of regular expressions

Parameters:

  • private (String) —

    The string to analyze

Returns:

  • (Symbol) 


163
164
165
166
167
168
169
170
171
 
# File 'lib/metasploit/framework/credential_collection.rb', line 163

def private_type(private)
  if private =~ /[0-9a-f]{32}:[0-9a-f]{32}/
    :ntlm_hash
  elsif private =~ /^md5([a-f0-9]{32})$/
    :postgres_md5
  else
    :password
  end
end