Class: Scanny::Checks::Check

Inherits:

Object

• Object
• Scanny::Checks::Check

Defined in:

lib/scanny/checks/check.rb

Direct Known Subclasses

AccessControlCheck, BackticksCheck, BeforeFiltersCheck, CSRFCheck, DenialOfServiceCheck, FileOpenCheck, FrameworksCheck, HTTPBasicAuthCheck, HTTPRedirectCheck, HTTPRequestCheck, HTTPUsageCheck, HttpHeader::HeaderInjectionCheck, InformationLeakCheck, InputFilteringCheck, InsecureMethod::EvalMethodCheck, InsecureMethod::MarshalCheck, InsecureMethod::SystemMethodCheck, MassAssignmentCheck, RandomNumbersCheck, RedirectWithParamsCheck, RegexpCheck, ResetSessionCheck, SSL::VerifyCheck, SSL::VerifyPeerCheck, Session::AccessToSessionCheck, Session::SessionSecureCheck, SetRailsEnvCheck, SetSecretCheck, SetSessionKeyCheck, ShellExpandingMethodsCheck, SkipBeforeFiltersCheck, Sql::SqlCheck, SystemTools::GpgUsageCheck, SystemTools::SudoCheck, SystemTools::TarCheck, SystemTools::TarCommandsCheck, SystemTools::UnzipCheck, TempFileOpenCheck, UserFindCheck, ValidatesCheck, VerifyMethodCheck, XssFlashCheck, XssLoggerCheck, XssMarkCheck, XssSendCheck

Instance Method Summary

• #compiled_pattern ⇒ Object
• #issue(impact, message, options = {}) ⇒ Object
• #pattern ⇒ String

  Pattern used to find relevant nodes.

• #strict? ⇒ Boolean
• #visit(file, node) ⇒ Object

Instance Method Details

#compiled_pattern ⇒ Object

# File 'lib/scanny/checks/check.rb', line 28

def compiled_pattern
  @compiled_pattern ||= Machete::Parser.new.parse(pattern)
end

#issue(impact, message, options = {}) ⇒ Object

# File 'lib/scanny/checks/check.rb', line 20

def issue(impact, message, options = {})
  @issues << Issue.new(@file, @line, impact, message, options[:cwe])
end

#pattern ⇒ String

Returns pattern used to find relevant nodes. It must respect Machete’s syntax.

Returns:

• (String) —

  pattern used to find relevant nodes. It must respect Machete’s syntax.

# File 'lib/scanny/checks/check.rb', line 15

def pattern
  raise "The Check class requires its childrens to provide an "\
        "implementation of the 'pattern' method."
end

#strict? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/scanny/checks/check.rb', line 24

def strict?
  false
end

#visit(file, node) ⇒ Object

# File 'lib/scanny/checks/check.rb', line 4

def visit(file, node)
  @file = file
  @line = node.line
  @issues = []

  check(node)

  @issues
end