forked from trufflesecurity/trufflehog
/
test_all.py
148 lines (133 loc) · 8.2 KB
/
test_all.py
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
import unittest
import os
import sys
import json
import io
import re
from collections import namedtuple
from truffleHog import truffleHog
try:
from mock import patch
from mock import MagicMock
except:
from unittest.mock import patch
from unittest.mock import MagicMock
class TestStringMethods(unittest.TestCase):
def test_shannon(self):
random_stringB64 = "ZWVTjPQSdhwRgl204Hc51YCsritMIzn8B=/p9UyeX7xu6KkAGqfm3FJ+oObLDNEva"
random_stringHex = "b3A0a1FDfe86dcCE945B72"
self.assertGreater(truffleHog.shannon_entropy(random_stringB64, truffleHog.BASE64_CHARS), 4.5)
self.assertGreater(truffleHog.shannon_entropy(random_stringHex, truffleHog.HEX_CHARS), 3)
def test_cloning(self):
project_path = truffleHog.clone_git_repo("https://github.com/dxa4481/truffleHog.git")
license_file = os.path.join(project_path, "LICENSE")
self.assertTrue(os.path.isfile(license_file))
def test_unicode_expection(self):
try:
truffleHog.find_strings("https://github.com/dxa4481/tst.git")
except UnicodeEncodeError:
self.fail("Unicode print error")
def test_return_correct_commit_hash(self):
# Start at commit 202564cf776b402800a4aab8bb14fa4624888475, which
# is immediately followed by a secret inserting commit:
# https://github.com/dxa4481/truffleHog/commit/d15627104d07846ac2914a976e8e347a663bbd9b
since_commit = '202564cf776b402800a4aab8bb14fa4624888475'
commit_w_secret = 'd15627104d07846ac2914a976e8e347a663bbd9b'
cross_valdiating_commit_w_secret_comment = 'Oh no a secret file'
json_result = ''
if sys.version_info >= (3,):
tmp_stdout = io.StringIO()
else:
tmp_stdout = io.BytesIO()
bak_stdout = sys.stdout
# Redirect STDOUT, run scan and re-establish STDOUT
sys.stdout = tmp_stdout
try:
truffleHog.find_strings("https://github.com/dxa4481/truffleHog.git",
since_commit=since_commit, printJson=True, surpress_output=False)
finally:
sys.stdout = bak_stdout
json_result_list = tmp_stdout.getvalue().split('\n')
results = [json.loads(r) for r in json_result_list if bool(r.strip())]
filtered_results = list(filter(lambda r: r['commitHash'] == commit_w_secret and r['branch'] == 'origin/master', results))
self.assertEqual(1, len(filtered_results))
self.assertEqual(commit_w_secret, filtered_results[0]['commitHash'])
# Additionally, we cross-validate the commit comment matches the expected comment
self.assertEqual(cross_valdiating_commit_w_secret_comment, filtered_results[0]['commit'].strip())
@patch('truffleHog.truffleHog.clone_git_repo')
@patch('truffleHog.truffleHog.Repo')
@patch('shutil.rmtree')
def test_branch(self, rmtree_mock, repo_const_mock, clone_git_repo):
repo = MagicMock()
repo_const_mock.return_value = repo
truffleHog.find_strings("test_repo", branch="testbranch")
repo.remotes.origin.fetch.assert_called_once_with("testbranch")
def test_path_included(self):
Blob = namedtuple('Blob', ('a_path', 'b_path'))
blobs = {
'file-root-dir': Blob('file', 'file'),
'file-sub-dir': Blob('sub-dir/file', 'sub-dir/file'),
'new-file-root-dir': Blob(None, 'new-file'),
'new-file-sub-dir': Blob(None, 'sub-dir/new-file'),
'deleted-file-root-dir': Blob('deleted-file', None),
'deleted-file-sub-dir': Blob('sub-dir/deleted-file', None),
'renamed-file-root-dir': Blob('file', 'renamed-file'),
'renamed-file-sub-dir': Blob('sub-dir/file', 'sub-dir/renamed-file'),
'moved-file-root-dir-to-sub-dir': Blob('moved-file', 'sub-dir/moved-file'),
'moved-file-sub-dir-to-root-dir': Blob('sub-dir/moved-file', 'moved-file'),
'moved-file-sub-dir-to-sub-dir': Blob('sub-dir/moved-file', 'moved/moved-file'),
}
src_paths = set(blob.a_path for blob in blobs.values() if blob.a_path is not None)
dest_paths = set(blob.b_path for blob in blobs.values() if blob.b_path is not None)
all_paths = src_paths.union(dest_paths)
all_paths_patterns = [re.compile(re.escape(p)) for p in all_paths]
overlap_patterns = [re.compile(r'sub-dir/.*'), re.compile(r'moved/'), re.compile(r'[^/]*file$')]
sub_dirs_patterns = [re.compile(r'.+/.+')]
deleted_paths_patterns = [re.compile(r'(.*/)?deleted-file$')]
for name, blob in blobs.items():
self.assertTrue(truffleHog.path_included(blob),
'{} should be included by default'.format(blob))
self.assertTrue(truffleHog.path_included(blob, include_patterns=all_paths_patterns),
'{} should be included with include_patterns: {}'.format(blob, all_paths_patterns))
self.assertFalse(truffleHog.path_included(blob, exclude_patterns=all_paths_patterns),
'{} should be excluded with exclude_patterns: {}'.format(blob, all_paths_patterns))
self.assertFalse(truffleHog.path_included(blob,
include_patterns=all_paths_patterns,
exclude_patterns=all_paths_patterns),
'{} should be excluded with overlapping patterns: \n\tinclude: {}\n\texclude: {}'.format(
blob, all_paths_patterns, all_paths_patterns))
self.assertFalse(truffleHog.path_included(blob,
include_patterns=overlap_patterns,
exclude_patterns=all_paths_patterns),
'{} should be excluded with overlapping patterns: \n\tinclude: {}\n\texclude: {}'.format(
blob, overlap_patterns, all_paths_patterns))
self.assertFalse(truffleHog.path_included(blob,
include_patterns=all_paths_patterns,
exclude_patterns=overlap_patterns),
'{} should be excluded with overlapping patterns: \n\tinclude: {}\n\texclude: {}'.format(
blob, all_paths_patterns, overlap_patterns))
path = blob.b_path if blob.b_path else blob.a_path
if '/' in path:
self.assertTrue(truffleHog.path_included(blob, include_patterns=sub_dirs_patterns),
'{}: inclusion should include sub directory paths: {}'.format(blob, sub_dirs_patterns))
self.assertFalse(truffleHog.path_included(blob, exclude_patterns=sub_dirs_patterns),
'{}: exclusion should exclude sub directory paths: {}'.format(blob, sub_dirs_patterns))
else:
self.assertFalse(truffleHog.path_included(blob, include_patterns=sub_dirs_patterns),
'{}: inclusion should exclude root directory paths: {}'.format(blob, sub_dirs_patterns))
self.assertTrue(truffleHog.path_included(blob, exclude_patterns=sub_dirs_patterns),
'{}: exclusion should include root directory paths: {}'.format(blob, sub_dirs_patterns))
if name.startswith('deleted-file-'):
self.assertTrue(truffleHog.path_included(blob, include_patterns=deleted_paths_patterns),
'{}: inclusion should match deleted paths: {}'.format(blob, deleted_paths_patterns))
self.assertFalse(truffleHog.path_included(blob, exclude_patterns=deleted_paths_patterns),
'{}: exclusion should match deleted paths: {}'.format(blob, deleted_paths_patterns))
@patch('truffleHog.truffleHog.clone_git_repo')
@patch('truffleHog.truffleHog.Repo')
@patch('shutil.rmtree')
def test_repo_path(self, rmtree_mock, repo_const_mock, clone_git_repo):
truffleHog.find_strings("test_repo", repo_path="test/path/")
rmtree_mock.assert_not_called()
clone_git_repo.assert_not_called()
if __name__ == '__main__':
unittest.main()