6cb63dbbd8
This patch adds a unit test and also Replaces report() with __str__ so it just returns a string rather than printing to stdout. Coverage goes from 44% to 100%. Change-Id: I23af0e09415651a2caaf82f327d3106ff5db65ad
308 lines
11 KiB
Python
308 lines
11 KiB
Python
# -*- coding:utf-8 -*-
|
|
#
|
|
# Copyright 2014 Hewlett-Packard Development Company, L.P.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import fnmatch
|
|
import logging
|
|
import os
|
|
import sys
|
|
|
|
from bandit.core import constants as constants
|
|
from bandit.core import meta_ast as b_meta_ast
|
|
from bandit.core import node_visitor as b_node_visitor
|
|
from bandit.core import result_store as b_result_store
|
|
from bandit.core import test_set as b_test_set
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class BanditManager():
|
|
|
|
scope = []
|
|
|
|
def __init__(self, config, agg_type, debug=False, verbose=False,
|
|
profile_name=None):
|
|
'''Get logger, config, AST handler, and result store ready
|
|
|
|
:param config: config options object
|
|
:type config: bandit.core.BanditConfig
|
|
:param agg_type: aggregation type
|
|
:param debug: Whether to show debug messsages or not
|
|
:param verbose: Whether to show verbose output
|
|
:param profile_name: Optional name of profile to use (from cmd line)
|
|
:return:
|
|
'''
|
|
self.debug = debug
|
|
self.verbose = verbose
|
|
self.b_conf = config
|
|
self.files_list = []
|
|
self.excluded_files = []
|
|
self.b_ma = b_meta_ast.BanditMetaAst()
|
|
self.b_rs = b_result_store.BanditResultStore(self.b_conf, agg_type,
|
|
verbose)
|
|
|
|
# if the profile name was specified, try to find it in the config
|
|
if profile_name:
|
|
if profile_name in self.b_conf.config['profiles']:
|
|
profile = self.b_conf.config['profiles'][profile_name]
|
|
logger.debug(
|
|
"read in profile '%s': %s",
|
|
profile_name, profile
|
|
)
|
|
else:
|
|
logger.error('unable to find profile (%s) in config file: %s',
|
|
profile_name, self.b_conf.config_file)
|
|
sys.exit(2)
|
|
else:
|
|
profile = None
|
|
|
|
self.b_ts = b_test_set.BanditTestSet(config=self.b_conf,
|
|
profile=profile)
|
|
|
|
# set the increment of after how many files to show progress
|
|
self.progress = self.b_conf.get_setting('progress')
|
|
self.scores = []
|
|
|
|
@property
|
|
def has_tests(self):
|
|
return self.b_ts.has_tests
|
|
|
|
@property
|
|
def get_resultstore(self):
|
|
return self.b_rs
|
|
|
|
def results_count(self, sev_filter=None, conf_filter=None):
|
|
'''Return the count of results
|
|
|
|
:param sev_filter: Severity level to filter lower
|
|
:param conf_filter: Confidence level to filter
|
|
:return: Number of results in the set
|
|
'''
|
|
count = 0
|
|
|
|
rank = constants.RANKING
|
|
|
|
for issue_file in self.b_rs.resstore:
|
|
for issue in self.b_rs.resstore[issue_file]:
|
|
|
|
if (sev_filter and
|
|
rank.index(issue['issue_severity']) < sev_filter):
|
|
# don't count if this doesn't match filter requirement
|
|
continue
|
|
|
|
if (conf_filter and
|
|
rank.index(issue['issue_confidence']) < conf_filter):
|
|
continue
|
|
|
|
count += 1
|
|
|
|
return count
|
|
|
|
def output_results(self, lines, sev_level, conf_level, output_filename,
|
|
output_format):
|
|
'''Outputs results from the result store
|
|
|
|
:param lines: How many surrounding lines to show per result
|
|
:param sev_level: Which severity levels to show (LOW, MEDIUM, HIGH)
|
|
:param conf_level: Which confidence levels to show (LOW, MEDIUM, HIGH)
|
|
:param output_filename: File to store results
|
|
:param output_format: output format, 'csv', 'json', 'txt', or 'xml'
|
|
:return: -
|
|
'''
|
|
|
|
self.b_rs.report(
|
|
self.files_list, self.scores,
|
|
excluded_files=self.excluded_files, lines=lines,
|
|
sev_level=sev_level, conf_level=conf_level,
|
|
output_filename=output_filename, output_format=output_format
|
|
)
|
|
|
|
def discover_files(self, targets, recursive=False):
|
|
'''Add tests directly and from a directory to the test set
|
|
|
|
:param scope: The command line list of files and directories
|
|
:param recursive: True/False - whether to add all files from dirs
|
|
:return:
|
|
'''
|
|
# We'll mantain a list of files which are added, and ones which have
|
|
# been explicitly excluded
|
|
files_list = set()
|
|
excluded_files = set()
|
|
|
|
excluded_path_strings = self.b_conf.get_option('exclude_dirs') or []
|
|
included_globs = self.b_conf.get_option('include') or ['*.py']
|
|
|
|
# build list of files we will analyze
|
|
for fname in targets:
|
|
# if this is a directory and recursive is set, find all files
|
|
if os.path.isdir(fname):
|
|
if recursive:
|
|
new_files, newly_excluded = _get_files_from_dir(
|
|
fname,
|
|
included_globs=included_globs,
|
|
excluded_path_strings=excluded_path_strings
|
|
)
|
|
files_list.update(new_files)
|
|
excluded_files.update(newly_excluded)
|
|
else:
|
|
logger.warn("Skipping directory (%s), use -r flag to "
|
|
"scan contents", fname)
|
|
|
|
else:
|
|
# if the user explicitly mentions a file on command line,
|
|
# we'll scan it, regardless of whether it's in the included
|
|
# file types list
|
|
if _is_file_included(fname, included_globs,
|
|
excluded_path_strings,
|
|
enforce_glob=False):
|
|
files_list.add(fname)
|
|
else:
|
|
excluded_files.add(fname)
|
|
|
|
self.files_list = sorted(files_list)
|
|
self.excluded_files = sorted(excluded_files)
|
|
|
|
def check_output_destination(self, output_filename):
|
|
# case where file already exists
|
|
if os.path.isfile(output_filename):
|
|
return 'File already exists'
|
|
else:
|
|
# case where specified destination is a directory
|
|
if os.path.isdir(output_filename):
|
|
return 'Specified destination is a directory'
|
|
# case where specified destination is not writable
|
|
try:
|
|
open(output_filename, 'w').close()
|
|
except IOError:
|
|
return 'Specified destination is not writable'
|
|
return True
|
|
|
|
def run_tests(self):
|
|
'''Runs through all files in the scope
|
|
|
|
:return: -
|
|
'''
|
|
# display progress, if number of files warrants it
|
|
if len(self.files_list) > self.progress:
|
|
sys.stdout.write("%s [" % len(self.files_list))
|
|
|
|
# if we have problems with a file, we'll remove it from the files_list
|
|
# and add it to the skipped list instead
|
|
new_files_list = list(self.files_list)
|
|
|
|
for count, fname in enumerate(self.files_list):
|
|
logger.debug("working on file : %s", fname)
|
|
|
|
if len(self.files_list) > self.progress:
|
|
# is it time to update the progress indicator?
|
|
if count % self.progress == 0:
|
|
sys.stdout.write("%s.. " % count)
|
|
sys.stdout.flush()
|
|
try:
|
|
with open(fname, 'rU') as fdata:
|
|
try:
|
|
# parse the current file
|
|
score = self._execute_ast_visitor(
|
|
fname, fdata, self.b_ma,
|
|
self.b_rs, self.b_ts
|
|
)
|
|
self.scores.append(score)
|
|
except KeyboardInterrupt as e:
|
|
sys.exit(2)
|
|
except IOError as e:
|
|
self.b_rs.skip(fname, e.strerror)
|
|
new_files_list.remove(fname)
|
|
except SyntaxError as e:
|
|
self.b_rs.skip(fname,
|
|
"syntax error while parsing AST from file")
|
|
new_files_list.remove(fname)
|
|
|
|
if len(self.files_list) > self.progress:
|
|
sys.stdout.write("]\n")
|
|
sys.stdout.flush()
|
|
|
|
# reflect any files which may have been skipped
|
|
self.files_list = new_files_list
|
|
|
|
def _execute_ast_visitor(self, fname, fdata, b_ma, b_rs, b_ts):
|
|
'''Execute AST parse on each file
|
|
|
|
:param fname: The name of the file being parsed
|
|
:param fdata: The file data of the file being parsed
|
|
:param b_ma: The class Meta AST instance
|
|
:param b_rs: The class result store instance
|
|
:param b_ts: The class test set instance
|
|
:return: The accumulated test score
|
|
'''
|
|
score = []
|
|
if fdata is not None:
|
|
res = b_node_visitor.BanditNodeVisitor(
|
|
fname, self.b_conf, b_ma, b_rs, b_ts, self.debug
|
|
)
|
|
score = res.process(fdata)
|
|
return score
|
|
|
|
|
|
def _get_files_from_dir(files_dir, included_globs='*.py',
|
|
excluded_path_strings=None):
|
|
if not excluded_path_strings:
|
|
excluded_path_strings = []
|
|
|
|
files_list = set()
|
|
excluded_files = set()
|
|
|
|
for root, subdirs, files in os.walk(files_dir):
|
|
for filename in files:
|
|
path = os.path.join(root, filename)
|
|
if _is_file_included(path, included_globs, excluded_path_strings):
|
|
files_list.add(path)
|
|
else:
|
|
excluded_files.add(path)
|
|
|
|
return files_list, excluded_files
|
|
|
|
|
|
def _is_file_included(path, included_globs, excluded_path_strings,
|
|
enforce_glob=True):
|
|
'''Determine if a file should be included based on filename
|
|
|
|
This utility function determines if a file should be included based
|
|
on the file name, a list of parsed extensions, excluded paths, and a flag
|
|
specifying whether extensions should be enforced.
|
|
|
|
:param path: Full path of file to check
|
|
:param parsed_extensions: List of parsed extensions
|
|
:param excluded_paths: List of paths from which we should not include files
|
|
:param enforce_glob: Can set to false to bypass extension check
|
|
:return: Boolean indicating whether a file should be included
|
|
'''
|
|
return_value = False
|
|
|
|
# if this is matches a glob of files we look at, and it isn't in an
|
|
# excluded path
|
|
if _matches_glob_list(path, included_globs) or not enforce_glob:
|
|
if not any(x in path for x in excluded_path_strings):
|
|
return_value = True
|
|
|
|
return return_value
|
|
|
|
|
|
def _matches_glob_list(filename, glob_list):
|
|
for glob in glob_list:
|
|
if fnmatch.fnmatch(filename, glob):
|
|
return True
|
|
return False
|