-
-
Notifications
You must be signed in to change notification settings - Fork 94
/
utils.py
459 lines (412 loc) · 14.6 KB
/
utils.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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
import ast
import json
import os
import re
import shutil
from collections import defaultdict
from datetime import datetime
from importlib.metadata import distribution
from typing import Any, Dict, List
from jinja2 import Environment
from vdb.lib import db as db_lib
from vdb.lib.utils import version_compare
from depscan.lib import config, normalize
lic_symbol_regex = re.compile(r"[(),]")
def filter_ignored_dirs(dirs):
"""
Method to filter directory list to remove ignored directories
:param dirs: Directories to ignore
:return: Filtered directory list
"""
[
dirs.remove(d)
for d in list(dirs)
if d.lower() in config.ignore_directories or d.startswith(".")
]
return dirs
def find_python_reqfiles(path):
"""
Method to find python requirements files
:param path: Project directory
:return: List of python requirement files
"""
result = []
req_files = [
"requirements.txt",
"Pipfile",
"poetry.lock",
"Pipfile.lock",
"conda.yml",
"pyproject.toml",
]
for root, dirs, files in os.walk(path):
filter_ignored_dirs(dirs)
for name in req_files:
if name in files:
result.append(os.path.join(root, name))
return result
def find_files(src, src_ext_name, quick=False, filter_dirs=True):
"""
Method to find files with given extension
:param src: source directory to search
:param src_ext_name: type of source file
:param quick: only return first match found
:param filter_dirs: filter out ignored directories
"""
result = []
for root, dirs, files in os.walk(src):
if filter_dirs:
filter_ignored_dirs(dirs)
for file in files:
if file == src_ext_name or file.endswith(src_ext_name):
result.append(os.path.join(root, file))
if quick:
return result
return result
def is_binary_string(content):
"""
Method to check if the given content is a binary string
"""
textchars = bytearray(
{7, 8, 9, 10, 12, 13, 27} | set(range(0x20, 0x100)) - {0x7F}
)
return bool(content.translate(None, textchars))
def is_exe(src):
"""
Detect if the source is a binary file
:param src: Source path
:return True if binary file. False otherwise.
"""
if os.path.isfile(src):
try:
return is_binary_string(open(src, "rb").read(1024))
except Exception:
return False
return False
def detect_project_type(src_dir):
"""Detect project type by looking for certain files
:param src_dir: Source directory
:return List of detected types
"""
# container image support
if (
"docker.io" in src_dir
or "quay.io" in src_dir
or ":latest" in src_dir
or "@sha256" in src_dir
or src_dir.endswith(".tar")
or src_dir.endswith(".tar.gz")
):
return ["docker"]
# Check if the source is an exe file. Assume go for all binaries for now
if is_exe(src_dir):
return ["go", "binary"]
project_types = []
if find_python_reqfiles(src_dir) or find_files(src_dir, ".py", quick=True):
project_types.append("python")
if find_files(src_dir, "pom.xml", quick=True) or find_files(
src_dir, ".gradle", quick=True
):
project_types.append("java")
if find_files(src_dir, ".gradle.kts", quick=True):
project_types.append("kotlin")
if find_files(src_dir, "build.sbt", quick=True):
project_types.append("scala")
if (
find_files(src_dir, "package.json", quick=True)
or find_files(src_dir, "yarn.lock", quick=True)
or find_files(src_dir, "rush.json", quick=True)
):
project_types.append("nodejs")
if find_files(src_dir, "go.sum", quick=True) or find_files(
src_dir, "Gopkg.lock", quick=True
):
project_types.append("go")
if find_files(src_dir, "Cargo.lock", quick=True):
project_types.append("rust")
if find_files(src_dir, "composer.json", quick=True):
project_types.append("php")
if find_files(src_dir, ".csproj", quick=True):
project_types.append("dotnet")
if find_files(src_dir, "Gemfile", quick=True) or find_files(
src_dir, "Gemfile.lock", quick=True
):
project_types.append("ruby")
if find_files(src_dir, "deps.edn", quick=True) or find_files(
src_dir, "project.clj", quick=True
):
project_types.append("clojure")
if find_files(src_dir, "conan.lock", quick=True) or find_files(
src_dir, "conanfile.txt", quick=True
):
project_types.append("cpp")
if find_files(src_dir, "pubspec.lock", quick=True) or find_files(
src_dir, "pubspec.yaml", quick=True
):
project_types.append("dart")
if find_files(src_dir, "cabal.project.freeze", quick=True):
project_types.append("haskell")
if find_files(src_dir, "mix.lock", quick=True):
project_types.append("elixir")
if find_files(
os.path.join(src_dir, ".github", "workflows"),
".yml",
quick=True,
filter_dirs=False,
):
project_types.append("github")
# jars
if "java" not in project_types and find_files(src_dir, ".jar", quick=True):
project_types.append("jar")
# Jenkins plugins or plain old jars
if "java" not in project_types and find_files(src_dir, ".hpi", quick=True):
project_types.append("jenkins")
if find_files(src_dir, ".yml", quick=True) or find_files(
src_dir, ".yaml", quick=True
):
project_types.append("yaml-manifest")
return project_types
def get_pkg_vendor_name(pkg):
"""
Method to extract vendor and name information from package. If vendor
information is not available package url is used to extract the package
registry provider such as pypi, maven
:param pkg: a dictionary representing a package
:return: vendor and name as a tuple
"""
vendor = pkg.get("vendor")
if not vendor:
purl = pkg.get("purl")
if purl:
purl_parts = purl.split("/")
if purl_parts:
vendor = purl_parts[0].replace("pkg:", "")
else:
vendor = ""
name = pkg.get("name")
return vendor, name
def search_pkgs(db, project_type: str | None, pkg_list: List[Dict[str, Any]]):
"""
Method to search packages in our vulnerability database
:param db: DB instance
:param project_type: Project type
:param pkg_list: List of packages to search
:returns: raw_results, pkg_aliases, purl_aliases
"""
expanded_list = []
# The challenge we have is to broaden our search and create several
# variations of the package and vendor names to perform a broad search.
# We then have to map the results back to the original package names and
# package urls.
pkg_aliases = defaultdict(list)
purl_aliases = {}
for pkg in pkg_list:
variations = normalize.create_pkg_variations(pkg)
if variations:
expanded_list += variations
vendor, name = get_pkg_vendor_name(pkg)
version = pkg.get("version")
if pkg.get("purl"):
ppurl = pkg.get("purl")
purl_aliases[pkg.get("purl")] = pkg.get("purl")
purl_aliases[f"{vendor.lower()}:{name.lower()}:{version}"] = ppurl
if ppurl.startswith("pkg:npm"):
purl_aliases[f"npm:{vendor.lower()}/{name.lower()}:{version}"] = ppurl
if not purl_aliases.get(f"{vendor.lower()}:{name.lower()}"):
purl_aliases[f"{vendor.lower()}:{name.lower()}"] = ppurl
if variations:
for vari in variations:
vari_full_pkg = f"""{vari.get("vendor")}:{vari.get("name")}"""
pkg_aliases[
f"{vendor.lower()}:{name.lower()}:{version}"
].append(vari_full_pkg)
if pkg.get("purl"):
purl_aliases[f"{vari_full_pkg.lower()}:{version}"] = pkg.get("purl")
quick_res = db_lib.bulk_index_search(expanded_list)
raw_results = db_lib.pkg_bulk_search(db, quick_res)
raw_results = normalize.dedup(project_type, raw_results)
pkg_aliases = normalize.dealias_packages(
raw_results,
pkg_aliases=pkg_aliases,
purl_aliases=purl_aliases,
)
return raw_results, pkg_aliases, purl_aliases
def get_pkgs_by_scope(pkg_list):
"""
Method to return the packages by scope as defined in CycloneDX spec -
required, optional and excluded
:param pkg_list: List of packages
:return: Dictionary of packages categorized by scope if available. Empty if
no scope information is available
"""
scoped_pkgs = {}
for pkg in pkg_list:
if pkg.get("scope"):
vendor, name = get_pkg_vendor_name(pkg)
scope = pkg.get("scope").lower()
if pkg.get("purl"):
scoped_pkgs.setdefault(scope, []).append(pkg.get("purl"))
else:
scoped_pkgs.setdefault(scope, []).append(f"{vendor}:{name}")
return scoped_pkgs
def get_scope_from_imports(project_type, pkg_list, all_imports):
"""
Method to compute the packages scope defined in CycloneDX spec - required,
optional and excluded
:param project_type: Project type
:param pkg_list: List of packages
:param all_imports: List of imports detected
:return: Dictionary of packages categorized by scope if available. Empty if
no scope information is available
"""
scoped_pkgs = {}
if not pkg_list or not all_imports:
return scoped_pkgs
for pkg in pkg_list:
scope = "optional"
vendor, name = get_pkg_vendor_name(pkg)
if name in all_imports or name.lower().replace("py", "") in all_imports:
scope = "required"
if pkg.get("purl"):
scoped_pkgs.setdefault(scope, []).append(pkg.get("purl"))
else:
scoped_pkgs.setdefault(scope, []).append(f"{vendor}:{name}")
scoped_pkgs[scope].append(f"{project_type}:{name.lower()}")
return scoped_pkgs
def cleanup_license_string(license_str):
"""
Method to clean up license string by removing problematic symbols and
making certain keywords consistent
:param license_str: String to clean up
:return: Cleaned up version
"""
if not license_str:
license_str = ""
license_str = (
license_str.replace(" / ", " OR ")
.replace("/", " OR ")
.replace(" & ", " OR ")
.replace("&", " OR ")
)
license_str = lic_symbol_regex.sub("", license_str)
return license_str.upper()
def max_version(version_list):
"""
Method to return the highest version from the list
:param version_list: single version string or set of versions
:return: max version
"""
if isinstance(version_list, str):
return version_list
if isinstance(version_list, set):
version_list = list(version_list)
if len(version_list) == 1:
return version_list[0]
min_ver = "0"
max_ver = version_list[0]
for i, vl in enumerate(version_list):
if not vl:
continue
if not version_compare(vl, min_ver, max_ver):
max_ver = vl
return max_ver
def get_all_imports(src_dir):
"""
Method to collect all package imports from a python file
No longer required since cdxgen does python analysis already
"""
import_list = set()
py_files = find_files(src_dir, ".py")
if not py_files:
return import_list
for afile in py_files:
with open(os.path.join(afile), "rb", encoding="utf-8") as f:
content = f.read()
parsed = ast.parse(content)
for node in ast.walk(parsed):
if isinstance(node, ast.Import):
for name in node.names:
pkg = name.name.split(".")[0]
import_list.add(pkg)
import_list.add(pkg.lower().replace("py", ""))
elif isinstance(node, ast.ImportFrom):
if node.level > 0:
continue
if getattr(node, "module"):
if node.module:
pkg = node.module.split(".")[0]
import_list.add(pkg)
import_list.add(pkg.lower().replace("py", ""))
return import_list
def get_version():
"""
Returns the version of depscan
"""
return distribution("owasp-depscan").version
def export_pdf(
html_file,
pdf_file,
title="DepScan Analysis",
footer=f'Report generated by OWASP dep-scan at {datetime.now().strftime("%B %d, %Y %H:%M")}',
):
"""
Method to export html as pdf using pdfkit
"""
pdf_options = {
"page-size": "A2",
"margin-top": "0.5in",
"margin-right": "0.25in",
"margin-bottom": "0.5in",
"margin-left": "0.25in",
"encoding": "UTF-8",
"outline": None,
"title": title,
"footer-right": footer,
"minimum-font-size": "12",
"disable-smart-shrinking": "",
}
if shutil.which("wkhtmltopdf"):
try:
import pdfkit
if not pdf_file and html_file:
pdf_file = html_file.replace(".html", ".pdf")
if os.path.exists(html_file):
pdfkit.from_file(html_file, pdf_file, options=pdf_options)
except Exception:
pass
def render_template_report(
vdr_file,
bom_file,
pkg_vulnerabilities,
pkg_group_rows,
summary,
template_file,
result_file,
):
"""
Render the given vdr_file (falling back to bom_file if no vdr was written)
and summary dict using the template_file with Jinja, rendered output is written
to named result_file in reports directory.
"""
if vdr_file and os.path.isfile(vdr_file):
with open(vdr_file, "r", encoding="utf-8") as f:
bom = json.load(f)
else:
with open(bom_file, "r", encoding="utf-8") as f:
bom = json.load(f)
with open(template_file, "r", encoding="utf-8") as tmpl_file:
template = tmpl_file.read()
jinja_env = Environment(autoescape=False)
jinja_tmpl = jinja_env.from_string(template)
report_result = jinja_tmpl.render(
metadata=bom.get("metadata", None),
vulnerabilities=bom.get("vulnerabilities", None),
components=bom.get("components", None),
dependencies=bom.get("dependencies", None),
services=bom.get("services", None),
summary=summary,
pkg_vulnerabilities=pkg_vulnerabilities,
pkg_group_rows=pkg_group_rows,
)
with open(result_file, "w", encoding="utf-8") as outfile:
outfile.write(report_result)