Class: Buby::ScanIssue

Inherits:
Object show all
Includes:
Java::Burp::IScanIssue
Defined in:
lib/buby/scan_issue.rb

Overview

This interface is used to retrieve details of Scanner issues. Extensions can obtain details of issues by registering an IScannerListener or by calling #getScanIssues. Extensions can also add custom Scanner issues by registering an IScannerCheck or calling #addScanIssue, and providing their own implementations of this interface

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash) ⇒ ScanIssue

Returns a new instance of ScanIssue.

Parameters:

  • hash (Hash) 


17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/buby/scan_issue.rb', line 17

def initialize hash
  @uri = hash[:uri].kind_of?(URI) ? hash[:uri] : hash[:uri].to_s
  @name = hash[:name]
  @type = hash[:type]
  @severity = hash[:severity]
  @confidence = hash[:confidence]
  @ibackground = hash[:ibackground]
  @rbackground = hash[:rbackground]
  @idetail = hash[:idetail]
  @rdetail = hash[:rdetail]
  @messages = hash[:messages]
  @service = hash[:service]
end

Instance Attribute Details

#confidence ⇒ Object

Returns the value of attribute confidence.



13
14
15
 
# File 'lib/buby/scan_issue.rb', line 13

def confidence
  @confidence
end

#ibackground ⇒ Object

Returns the value of attribute ibackground.



13
14
15
 
# File 'lib/buby/scan_issue.rb', line 13

def ibackground
  @ibackground
end

#idetail ⇒ Object

Returns the value of attribute idetail.



14
15
16
 
# File 'lib/buby/scan_issue.rb', line 14

def idetail
  @idetail
end

#messages ⇒ Object

Returns the value of attribute messages.



14
15
16
 
# File 'lib/buby/scan_issue.rb', line 14

def messages
  @messages
end

#name ⇒ Object

Returns the value of attribute name.



13
14
15
 
# File 'lib/buby/scan_issue.rb', line 13

def name
  @name
end

#rbackground ⇒ Object

Returns the value of attribute rbackground.



14
15
16
 
# File 'lib/buby/scan_issue.rb', line 14

def rbackground
  @rbackground
end

#rdetail ⇒ Object

Returns the value of attribute rdetail.



14
15
16
 
# File 'lib/buby/scan_issue.rb', line 14

def rdetail
  @rdetail
end

#service ⇒ Object

Returns the value of attribute service.



14
15
16
 
# File 'lib/buby/scan_issue.rb', line 14

def service
  @service
end

#severity ⇒ Object

Returns the value of attribute severity.



13
14
15
 
# File 'lib/buby/scan_issue.rb', line 13

def severity
  @severity
end

#type ⇒ Object

Returns the value of attribute type.



13
14
15
 
# File 'lib/buby/scan_issue.rb', line 13

def type
  @type
end

#uri ⇒ Object

Returns the value of attribute uri.



13
14
15
 
# File 'lib/buby/scan_issue.rb', line 13

def uri
  @uri
end

Instance Method Details

#getConfidence ⇒ String

This method returns the issue confidence level.

Returns:

  • (String) —

    The issue confidence level. Expected values are “Certain”, “Firm” or “Tentative”.



63
 
# File 'lib/buby/scan_issue.rb', line 63

def getConfidence; @confidence; end

#getHttpMessages ⇒ Object

Note:

The items in this array should be instances of IHttpRequestResponseWithMarkers if applicable, so that details of the relevant portions of the request and response messages are available.

This method returns the HTTP messages on the basis of which the issue was generated.

Returns:

  • The HTTP messages on the basis of which the issue was generated.



104
 
# File 'lib/buby/scan_issue.rb', line 104

def getHttpMessages; @messages; end

#getHttpService ⇒ Object

This method returns the HTTP service for which the issue was generated.

Returns:

  • The HTTP service for which the issue was generated.



110
 
# File 'lib/buby/scan_issue.rb', line 110

def getHttpService; @service; end

#getIssueBackground ⇒ String

This method returns a background description for this type of issue.

Returns:

  • (String) —

    A background description for this type of issue, or nil if none applies.



70
 
# File 'lib/buby/scan_issue.rb', line 70

def getIssueBackground; @ibackground; end

#getIssueDetail ⇒ String

This method returns detailed information about this specific instance of the issue.

Returns:

  • (String) —

    Detailed information about this specific instance of the issue, or nil if none applies.



86
 
# File 'lib/buby/scan_issue.rb', line 86

def getIssueDetail; @idetail; end

#getIssueName ⇒ String

This method returns the name of the issue type.

Returns:

  • (String) —

    The name of the issue type (e.g. “SQL injection”).



41
 
# File 'lib/buby/scan_issue.rb', line 41

def getIssueName; @name; end

#getIssueType ⇒ Fixnum

This method returns a numeric identifier of the issue type. See the Burp Scanner help documentation for a listing of all the issue types.

Returns:

  • (Fixnum) —

    A numeric identifier of the issue type.



48
 
# File 'lib/buby/scan_issue.rb', line 48

def getIssueType; @type; end

#getRemediationBackground ⇒ String

This method returns a background description of the remediation for this type of issue.

Returns:

  • (String) —

    A background description of the remediation for this type of issue, or nil if none applies.



78
 
# File 'lib/buby/scan_issue.rb', line 78

def getRemediationBackground; @rbackground; end

#getRemediationDetail ⇒ Object

This method returns detailed information about the remediation for this specific instance of the issue.

Returns:

  • Detailed information about the remediation for this specific instance of the issue, or nil if none applies.



94
 
# File 'lib/buby/scan_issue.rb', line 94

def getRemediationDetail; @rdetail; end

#getSeverity ⇒ String

This method returns the issue severity level.

Returns:

  • (String) —

    The issue severity level. Expected values are “High”, “Medium”, “Low”, “Information” or “False positive”.



56
 
# File 'lib/buby/scan_issue.rb', line 56

def getSeverity; @severity; end

#getUrl ⇒ Java::JavaNet::URL

This method returns the URL for which the issue was generated.

Returns:



35
 
# File 'lib/buby/scan_issue.rb', line 35

def getUrl; Java::JavaNet::URL.new @uri.to_s; end