1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
# Copyright 2019 Google LLC
#
# 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.
"""Uses bisection to determine which commit a bug was introduced and fixed.
This module takes a high and a low commit SHA, a repo name, and a bug.
The module bisects the high and low commit SHA searching for the location
where the bug was introduced. It also looks for where the bug was fixed.
This is done with the following steps:
NOTE: NEEDS TO BE RUN FROM THE OSS-Fuzz HOME directory
Typical usage example:
python3 infra/bisector.py
--commit_old 1e403e9259a1abedf108ab86f711ba52c907226d
--commit_new f79be4f2330f4b89ea2f42e1c44ca998c59a0c0f
--fuzz_target rules_fuzzer
--project_name yara
--testcase infra/yara_testcase
--sanitizer address
"""
import argparse
from dataclasses import dataclass
import os
import tempfile
import build_specified_commit
import helper
import repo_manager
@dataclass
class BuildData():
"""List of data requried for bisection of errors in OSS-Fuzz projects.
Attributes:
project_name: The name of the OSS-Fuzz project that is being checked
engine: The fuzzing engine to be used
sanitizer: The fuzzing sanitizer to be used
architecture: The system architecture being fuzzed
"""
project_name: str
engine: str
sanitizer: str
architecture: str
def main():
"""Finds the commit SHA where an error was initally introduced."""
parser = argparse.ArgumentParser(
description='git bisection for finding introduction of bugs')
parser.add_argument(
'--project_name',
help='The name of the project where the bug occured',
required=True)
parser.add_argument(
'--commit_new',
help='The newest commit SHA to be bisected',
required=True)
parser.add_argument(
'--commit_old',
help='The oldest commit SHA to be bisected',
required=True)
parser.add_argument(
'--fuzz_target', help='the name of the fuzzer to be built', required=True)
parser.add_argument(
'--testcase', help='the testcase to be reproduced', required=True)
parser.add_argument('--engine', default='libfuzzer')
parser.add_argument(
'--sanitizer',
default='address',
help='the default is "address"; "dataflow" for "dataflow" engine')
parser.add_argument('--architecture', default='x86_64')
args = parser.parse_args()
build_data = BuildData(args.project_name, args.engine, args.sanitizer,
args.architecture)
if os.getcwd() != os.path.dirname(
os.path.dirname(os.path.realpath(__file__))):
print("Error: bisector.py needs to be run from the OSS-Fuzz home directory")
return 1
error_sha = bisect(args.commit_old, args.commit_new, args.testcase,
args.fuzz_target, build_data)
if not error_sha:
print('No error was found in commit range %s:%s' %
(args.commit_old, args.commit_new))
return 1
print('Error was introduced at commit %s' % error_sha)
return 0
def bisect(commit_old, commit_new, testcase, fuzz_target, build_data):
"""From a commit range, this function caluclates which introduced a
specific error from a fuzz testcase.
Args:
commit_old: The oldest commit in the error regression range
commit_new: The newest commit in the error regression range
testcase: The file path of the test case that triggers the error
fuzz_target: The name of the fuzzer to be tested
build_data: a class holding all of the input parameters for bisection
Returns:
The commit SHA that introduced the error or None
"""
local_store_path = tempfile.mkdtemp()
repo_url = build_specified_commit.infer_main_repo(build_data.project_name,
local_store_path,
commit_old)
bisect_repo_manager = repo_manager.RepoManager(repo_url, local_store_path)
commit_list = bisect_repo_manager.get_commit_list(commit_old, commit_new)
build_specified_commit.build_fuzzer_from_commit(
build_data.project_name, commit_list[0], bisect_repo_manager.repo_dir,
build_data.engine, build_data.sanitizer, build_data.architecture,
bisect_repo_manager)
error_code = helper.reproduce_impl(build_data.project_name, fuzz_target,
False, [], [], testcase)
old_idx = len(commit_list) - 1
new_idx = 0
if len(commit_list) == 1:
if not error_code:
return None
return commit_list[0]
while old_idx - new_idx != 1:
curr_idx = (old_idx + new_idx) // 2
build_specified_commit.build_fuzzer_from_commit(
build_data.project_name, commit_list[curr_idx],
bisect_repo_manager.repo_dir, build_data.engine, build_data.sanitizer,
build_data.architecture, bisect_repo_manager)
error_exists = (
helper.reproduce_impl(build_data.project_name, fuzz_target, False, [],
[], testcase) == error_code)
if error_exists == error_code:
new_idx = curr_idx
else:
old_idx = curr_idx
return commit_list[new_idx]
if __name__ == '__main__':
main()
|
