2 # -*- coding: utf-8 -*-
3 ##############################################################################
4 # Copyright (c) 2017 Luke Hinds <lhinds@redhat.com>, Red Hat
6 # All rights reserved. This program and the accompanying materials
7 # are made available under the terms of the Apache License, Version 2.0
8 # which accompanies this distribution, and is available at
9 # http://www.apache.org/licenses/LICENSE-2.0
10 ##############################################################################
13 Accepts the --patchset argument and iterates through each line of the
14 patchset file to perform various checks such as if the file is a binary, or
15 contains a blacklisted string. If any violations are found, the script
16 exits with code 1 and logs the violation(s) found.
19 from __future__ import division, print_function, absolute_import
20 from binaryornot.check import is_binary
23 import six.moves.configparser
27 from . import get_lists
29 logger = logging.getLogger(__name__)
30 config = six.moves.configparser.RawConfigParser()
31 config.read('anteater.conf')
32 reports_dir = config.get('config', 'reports_dir')
34 hasher = hashlib.sha256()
37 def prepare_patchset(project, patchset):
38 """ Create black/white lists and default / project waivers
39 and iterates over patchset file """
41 # Get Various Lists / Project Waivers
42 lists = get_lists.GetLists()
43 # Get binary white list
44 binary_list = lists.binary_list(project)
46 # Get file name black list and project waivers
47 file_audit_list, file_audit_project_list = lists.file_audit_list(project)
49 # Get file content black list and project waivers
50 master_list, ignore_list = lists.file_content_list(project)
52 # Get File Ignore Lists
53 file_ignore = lists.file_ignore()
56 licence_ext = lists.licence_extensions()
57 licence_ignore = lists.licence_ignore()
59 # Open patch set to get file list
61 fo = open(patchset, 'r')
62 lines = fo.readlines()
64 logger.error('%s does not exist', patchset)
68 patch_file = line.strip('\n')
69 # Perform binary and file / content checks
70 scan_patch(project, patch_file, binary_list,
71 file_audit_list, file_audit_project_list,
72 master_list, ignore_list, licence_ext,
73 file_ignore, licence_ignore)
75 # Process each file in patch set using waivers generated above
76 # Process final result
80 def scan_patch(project, patch_file, binary_list, file_audit_list,
81 file_audit_project_list, master_list,
82 ignore_list, licence_ext, file_ignore, licence_ignore):
83 """ Scan actions for each commited file in patch set """
85 if is_binary(patch_file):
86 hashlist = get_lists.GetLists()
87 binary_hash = hashlist.binary_hash(project, patch_file)
88 if not binary_list.search(patch_file):
89 with open(patch_file, 'rb') as afile:
92 if hasher.hexdigest() in binary_hash:
93 logger.info('Found matching file hash for file: %s',
96 logger.error('Non Whitelisted Binary file: %s',
98 logger.error('Submit patch with the following hash: %s',
101 with open(reports_dir + "binaries-" + project + ".log", "a") \
103 gate_report.write('Non Whitelisted Binary file: {0}\n'.
105 gate_report.write('Submit patch with the following hash: {0}\n'.
106 format(hasher.hexdigest()))
109 # Check file names / extensions
110 if file_audit_list.search(patch_file) and not \
111 file_audit_project_list.search(patch_file):
112 match = file_audit_list.search(patch_file)
113 logger.error('Blacklisted file: %s', patch_file)
114 logger.error('Matched String: %s', match.group())
116 with open(reports_dir + "file-names_" + project + ".log", "a") \
118 gate_report.write('Blacklisted file: {0}\n'.
120 gate_report.write('Matched String: {0}'.
121 format(match.group()))
123 # Open file to check for blacklisted content
125 fo = open(patch_file, 'r')
126 lines = fo.readlines()
131 if file_exists and not patch_file.endswith(tuple(file_ignore)):
133 for key, value in master_list.iteritems():
134 regex = value['regex']
136 if re.search(regex, line) and not re.search(
138 logger.error('File contains violation: %s', patch_file)
139 logger.error('Flagged Content: %s', line.rstrip())
140 logger.error('Matched Regular Exp: %s', regex)
141 logger.error('Rationale: %s', desc.rstrip())
143 with open(reports_dir + "contents_" + project + ".log",
145 gate_report.write('File contains violation: {0}\n'.
147 gate_report.write('Flagged Content: {0}'.
149 gate_report.write('Matched Regular Exp: {0}\n'.
151 gate_report.write('Rationale: {0}\n'.
152 format(desc.rstrip()))
154 licence_check(project, licence_ext, licence_ignore, patch_file)
157 def licence_check(project, licence_ext,
158 licence_ignore, patch_file):
159 """ Performs licence checks """
161 if patch_file.endswith(tuple(licence_ext)) \
162 and patch_file not in licence_ignore:
163 fo = open(patch_file, 'r')
165 # Note: Hardcoded use of 'copyright' & 'spdx' is the result
166 # of a decision made at 2017 plugfest to limit searches to
167 # just these two strings.
168 patterns = ['copyright', 'spdx',
169 'http://creativecommons.org/licenses/by/4.0']
170 if any(i in content.lower() for i in patterns):
171 logger.info('Contains needed Licence string: %s', patch_file)
173 logger.error('Licence header missing in file: %s', patch_file)
175 with open(reports_dir + "licence-" + project + ".log", "a") \
177 gate_report.write('Licence header missing in file: {0}\n'.
181 def process_failure():
182 """ If any scan operations register a failure, sys.exit(1) is called
183 to allow jjb to register a failure"""
185 logger.error('Please visit: https://wiki.opnfv.org/x/5oey')