Class: Mdm::Workspace

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/mdm/workspace.rb

Overview

Workspace to separate different collections of #hosts. Can be used to separate pentests against different networks or different clients as reports are normally generated against all records in a workspace.

Constant Summary collapse

DEFAULT =

CONSTANTS

'default'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#boundary ⇒ String

Comma separated list of IP ranges (in various formats) and IP addresses that users of this workspace are allowed to interact with if #limit_to_network is true.

Returns:

  • (String) 



# File 'app/models/mdm/workspace.rb', line 82

#created_at ⇒ DateTime

When this workspace was created.

Returns:

  • (DateTime) 



# File 'app/models/mdm/workspace.rb', line 104

#description ⇒ String

Long description (beyond #name) that explains the purpose of this workspace.

Returns:

  • (String) 



# File 'app/models/mdm/workspace.rb', line 88

#limit_to_network ⇒ false, true

Whether #boundary is respected.

Returns:

  • (false) —

    do not limit interactions to #boundary.

  • (true) —

    limit interactions to #boundary.




# File 'app/models/mdm/workspace.rb', line 93

#name ⇒ String

Name of this workspace.

Returns:

  • (String) 



# File 'app/models/mdm/workspace.rb', line 99

#updated_at ⇒ DateTime

The last time this workspace was updated.

Returns:

  • (DateTime) 



# File 'app/models/mdm/workspace.rb', line 109

Class Method Details

.default ⇒ Mdm::Workspace

Returns default Mdm::Workspace.

Returns:



177
178
179
 
# File 'app/models/mdm/workspace.rb', line 177

def self.default
  where(name: DEFAULT).first_or_create
end

Instance Method Details

#allow_actions_on?(ips) ⇒ true, false

If #limit_to_network is disabled, this will always return true. Otherwise, return true only if all of the given IPs are within the project boundaries.

Parameters:

  • ips (String) —

    IP range(s)

Returns:

  • (true) —

    if actions on ips are allowed.

  • (false) —

    if actions are not allowed on ips.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'app/models/mdm/workspace.rb', line 138

def allow_actions_on?(ips)
  return true unless limit_to_network
  return true unless boundary
  return true if boundary.empty?
  boundaries = Shellwords.split(boundary)
  return true if boundaries.empty? # It's okay if there is no boundary range after all
  given_range = Rex::Socket::RangeWalker.new(ips)
  return false unless given_range # Can't do things to nonexistant IPs
  allowed = false
  boundaries.each do |boundary_range|
    ok_range = Rex::Socket::RangeWalker.new(boundary)
    allowed  = true if ok_range.include_range? given_range
  end
  return allowed
end

#boundary_must_be_ip_range ⇒ void

This method returns an undefined value.

Validates that #boundary is a valid IP address or IP address range.



157
158
159
 
# File 'app/models/mdm/workspace.rb', line 157

def boundary_must_be_ip_range
  errors.add(:boundary, "must be a valid IP range") unless valid_ip_or_range?(boundary)
end

#creds ⇒ ActiveRecord::Relation<Mdm::Cred>

Deprecated.

Use Mdm::Workspace#credential_cores when Metasploit::Credential::Engine is installed to get Metasploit::Credential::Cores. Use Mdm::Service#logins when Metasploit::Credential::Engine is installed to get Metasploit::Credential::Logins.

Returns:



166
167
168
169
170
171
172
 
# File 'app/models/mdm/workspace.rb', line 166

def creds
  Mdm::Cred.find(
    :all,
    :include    => {:service => :host},
    :conditions => ["hosts.workspace_id = ?", self.id]
  )
end

#default? ⇒ true, false

Whether this is the default workspace.

Returns:

  • (true) —

    if this is the default workspace.

  • (false) —

    if this is not the default workspace.



185
186
187
 
# File 'app/models/mdm/workspace.rb', line 185

def default?
  name == DEFAULT
end

#each_cred {|cred| ... } ⇒ void

Deprecated.

Use workspace.credential_cores.each when Metasploit::Credential::Engine is installed to enumerate Metasploit::Credential::Cores. Use service.logins.each when Metasploit::Credential::Engine is installed to enumerate Metasploit::Credential::Logins.

This method returns an undefined value.

Enumerates each element of #creds.

Yields:

  • (cred)

Yield Parameters:

  • cred (Mdm::Cred) —

    Cred associated with a host or a service in this workspace.

Yield Returns:

  • (void) 


199
200
201
202
203
 
# File 'app/models/mdm/workspace.rb', line 199

def each_cred(&block)
  creds.each do |cred|
    block.call(cred)
  end
end

#each_host_tag {|tag| ... } ⇒ void

This method returns an undefined value.

Enumerates each element of #host_tags.

Yields:

  • (tag)

Yield Parameters:

Yield Returns:

  • (void) 


211
212
213
214
215
 
# File 'app/models/mdm/workspace.rb', line 211

def each_host_tag(&block)
  host_tags.each do |host_tag|
    block.call(host_tag)
  end
end

#host_tags ⇒ ActiveRecord::Relation<Mdm::Tag>

Tags on #hosts.

Returns:



220
221
222
223
224
225
226
 
# File 'app/models/mdm/workspace.rb', line 220

def host_tags
  Mdm::Tag.find(
    :all,
    :include    => :hosts,
    :conditions => ["hosts.workspace_id = ?", self.id]
  )
end

#unique_web_forms ⇒ ActiveRecord::Relation<Mdm::WebForm>

Web forms on #web_sites.

Returns:



291
292
293
294
295
296
297
298
299
300
301
 
# File 'app/models/mdm/workspace.rb', line 291

def unique_web_forms
  query = <<-EOQ
        SELECT DISTINCT web_forms.web_site_id, web_forms.path, web_forms.method, web_forms.query
          FROM hosts, services, web_sites, web_forms
          WHERE hosts.workspace_id = #{id} AND
          services.host_id = hosts.id AND
          web_sites.service_id = services.id AND
          web_forms.web_site_id = web_sites.id
  EOQ
  Mdm::WebForm.find_by_sql(query)
end

#web_forms ⇒ ActiveRecord::Relation<Mdm::WebForm>

Web forms found on #web_sites.

Returns:



231
232
233
234
235
236
237
238
239
240
241
 
# File 'app/models/mdm/workspace.rb', line 231

def web_forms
  query = <<-EOQ
        SELECT DISTINCT web_forms.*
        FROM hosts, services, web_sites, web_forms
        WHERE hosts.workspace_id = #{id} AND
          services.host_id = hosts.id AND
          web_sites.service_id = services.id AND
          web_forms.web_site_id = web_sites.id
  EOQ
  Mdm::WebForm.find_by_sql(query)
end

#web_pages ⇒ ActiveRecord::Relation<Mdm::WebPage>

Web pages found on #web_sites.

Returns:



247
248
249
250
251
252
253
254
255
256
257
 
# File 'app/models/mdm/workspace.rb', line 247

def web_pages
  query = <<-EOQ
        SELECT DISTINCT web_pages.*
          FROM hosts, services, web_sites, web_pages
          WHERE hosts.workspace_id = #{id} AND
          services.host_id = hosts.id AND
          web_sites.service_id = services.id AND
          web_pages.web_site_id = web_sites.id
  EOQ
  Mdm::WebPage.find_by_sql(query)
end

#web_sites ⇒ ActiveRecord::Relation<Mdm::WebSite>

Web sites running on #services.

Returns:



262
263
264
265
266
267
268
269
270
271
 
# File 'app/models/mdm/workspace.rb', line 262

def web_sites
  query = <<-EOQ
        SELECT DISTINCT web_sites.*
          FROM hosts, services, web_sites
          WHERE hosts.workspace_id = #{id} AND
          services.host_id = hosts.id AND
          web_sites.service_id = services.id
  EOQ
  Mdm::WebSite.find_by_sql(query)
end

#web_unique_forms(addrs = nil) ⇒ Array<Mdm::WebForm>

#unique_web_forms hosted on addrs.

Parameters:

  • addrs (Array<IPAddr, String>) (defaults to: nil) —

    Host#address for the Service#host for the Mdm::WebSite#service for the Mdm::WebForm#web_site.

Returns:



308
309
310
311
312
313
314
 
# File 'app/models/mdm/workspace.rb', line 308

def web_unique_forms(addrs=nil)
  forms = unique_web_forms
  if addrs
    forms.reject! { |f| not addrs.include?(f.web_site.service.host.address) }
  end
  forms
end

#web_vulns ⇒ ActiveRecord::Relation<Mdm::WebVuln>

Web vulnerability found on #web_sites.

Returns:



276
277
278
279
280
281
282
283
284
285
286
 
# File 'app/models/mdm/workspace.rb', line 276

def web_vulns
  query = <<-EOQ
        SELECT DISTINCT web_vulns.*
        FROM hosts, services, web_sites, web_vulns
          WHERE hosts.workspace_id = #{id} AND
          services.host_id = hosts.id AND
          web_sites.service_id = services.id AND
          web_vulns.web_site_id = web_sites.id
  EOQ
  Mdm::WebVuln.find_by_sql(query)
end