-
Notifications
You must be signed in to change notification settings - Fork 22
/
config.py
193 lines (164 loc) · 8.64 KB
/
config.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
import os
from appdirs import user_cache_dir, user_data_dir
# NVD CVE json feed url
NVD_URL = "https://nvd.nist.gov/feeds/json/cve/1.1/nvdcve-1.1-%(year)s.json.gz"
# NVD start year. 2018 is quicker. 2002 is quite detailed but slow
NVD_START_YEAR = os.getenv("NVD_START_YEAR", "2018")
try:
NVD_START_YEAR = int(NVD_START_YEAR)
except ValueError:
pass
# GitHub advisory feed url
GHA_URL = os.getenv("GITHUB_GRAPHQL_URL", "https://api.github.com/graphql")
# No of pages to download from GitHub during a full refresh
GHA_PAGES_COUNT = os.getenv("GITHUB_PAGE_COUNT", "2")
NPM_PAGES_COUNT = os.getenv("NPM_PAGE_COUNT", "2")
# DB file dir
DATA_DIR = os.getenv("VDB_HOME", user_data_dir("vdb"))
if not os.path.exists(DATA_DIR):
os.makedirs(DATA_DIR)
CACHE_DIR = os.getenv("VDB_CACHE", user_cache_dir("vdb"))
if not os.path.exists(CACHE_DIR):
os.makedirs(CACHE_DIR)
# Binary db file
VDB_BIN_FILE = os.path.join(DATA_DIR, "data.vdb6")
# Binary DB index file
VDB_BIN_INDEX = os.path.join(DATA_DIR, "data.index.vdb6")
# db metadata file
VDB_METADATA_FILE = os.path.join(DATA_DIR, "vdb.meta")
# NPM advisory url
NPM_SERVER = "https://registry.npmjs.org"
NPM_AUDIT_URL = NPM_SERVER + "/-/npm/v1/security/audits"
NPM_ADVISORIES_URL = NPM_SERVER + "/-/npm/v1/security/advisories"
NPM_APP_INFO = {"name": "appthreat-vdb", "version": "6.0.0"}
CVE_TPL = """
{"cve":{"data_type":"CVE","data_format":"MITRE","data_version":"4.0","CVE_data_meta":{"ID":"%(cve_id)s","ASSIGNER":"%(assigner)s"},"problemtype":{"problemtype_data":[{"description":[{"lang":"en","value":"%(cwe_id)s"}]}]},"references":{"reference_data": %(references)s},"description":{"description_data":[{"lang":"en","value":"%(description)s"}]}},"configurations":{"CVE_data_version":"4.0","nodes":[{"operator":"OR","cpe_match":[{"vulnerable":true,"cpe23Uri":"cpe:2.3:a:%(vendor)s:%(product)s:%(version)s:*:%(edition)s:*:*:*:*:*","versionStartExcluding":"%(version_start_excluding)s","versionEndExcluding":"%(version_end_excluding)s","versionStartIncluding":"%(version_start_including)s","versionEndIncluding":"%(version_end_including)s"}, {"vulnerable":false,"cpe23Uri":"cpe:2.3:a:%(vendor)s:%(product)s:%(fix_version_start_including)s:*:%(edition)s:*:*:*:*:*","versionStartExcluding":"%(fix_version_start_excluding)s","versionEndExcluding":"%(fix_version_end_excluding)s","versionStartIncluding":"%(fix_version_start_including)s","versionEndIncluding":"%(fix_version_end_including)s"}]}]},"impact":{"baseMetricV3":{"cvssV3":{"version":"3.1","vectorString":"%(vectorString)s","attackVector":"NETWORK","attackComplexity":"%(attackComplexity)s","privilegesRequired":"NONE","userInteraction":"%(userInteraction)s","scope":"UNCHANGED","confidentialityImpact":"%(severity)s","integrityImpact":"%(severity)s","availabilityImpact":"%(severity)s","baseScore":%(score).1f,"baseSeverity":"%(severity)s"},"exploitabilityScore":%(exploitabilityScore).1f,"impactScore":%(score).1f},"baseMetricV2":{"cvssV2":{"version":"2.0","vectorString":"AV:N/AC:M/Au:N/C:P/I:P/A:P","accessVector":"NETWORK","accessComplexity":"MEDIUM","authentication":"NONE","confidentialityImpact":"PARTIAL","integrityImpact":"PARTIAL","availabilityImpact":"PARTIAL","baseScore":%(score).1f},"severity":"%(severity)s","exploitabilityScore":%(exploitabilityScore).1f,"impactScore":%(score).1f,"acInsufInfo":false,"obtainAllPrivilege":false,"obtainUserPrivilege":false,"obtainOtherPrivilege":false,"userInteractionRequired":false}},"publishedDate":"%(publishedDate)s","lastModifiedDate":"%(lastModifiedDate)s"}
"""
osv_url_dict = {
"javascript": "https://osv-vulnerabilities.storage.googleapis.com/npm/all.zip",
"python": "https://osv-vulnerabilities.storage.googleapis.com/PyPI/all.zip",
"go": "https://osv-vulnerabilities.storage.googleapis.com/Go/all.zip",
"java": "https://osv-vulnerabilities.storage.googleapis.com/Maven/all.zip",
"rust": "https://osv-vulnerabilities.storage.googleapis.com/crates.io/all.zip",
"csharp": "https://osv-vulnerabilities.storage.googleapis.com/NuGet/all.zip",
"ruby": "https://osv-vulnerabilities.storage.googleapis.com/RubyGems/all.zip",
"dwf": "https://osv-vulnerabilities.storage.googleapis.com/DWF/all.zip",
"gsd": "https://osv-vulnerabilities.storage.googleapis.com/GSD/all.zip",
"hex": "https://osv-vulnerabilities.storage.googleapis.com/Hex/all.zip",
"packagist": "https://osv-vulnerabilities.storage.googleapis.com/Packagist/all.zip",
"pub": "https://osv-vulnerabilities.storage.googleapis.com/Pub/all.zip",
"uvi": "https://osv-vulnerabilities.storage.googleapis.com/UVI/all.zip",
"github": "https://osv-vulnerabilities.storage.googleapis.com/GitHub%20Actions/all.zip",
"cran": "https://osv-vulnerabilities.storage.googleapis.com/CRAN/all.zip",
"swift": "https://osv-vulnerabilities.storage.googleapis.com/SwiftURL/all.zip",
"git": "https://osv-vulnerabilities.storage.googleapis.com/GIT/all.zip",
}
# Support for disabling individual distro feeds
if os.getenv("VDB_IGNORE_ALMALINUX", "") not in ("true", "1"):
osv_url_dict["almalinux"] = "https://osv-vulnerabilities.storage.googleapis.com/AlmaLinux/all.zip"
if os.getenv("VDB_IGNORE_ALPINE", "") not in ("true", "1"):
osv_url_dict["alpine"] = "https://osv-vulnerabilities.storage.googleapis.com/Alpine/all.zip"
if os.getenv("VDB_IGNORE_DEBIAN", "") not in ("true", "1"):
osv_url_dict["debian"] = "https://osv-vulnerabilities.storage.googleapis.com/Debian/all.zip"
if os.getenv("VDB_IGNORE_ROCKYLINUX", "") not in ("true", "1"):
osv_url_dict["rockylinux"] = "https://osv-vulnerabilities.storage.googleapis.com/Rocky%20Linux/all.zip"
# These feeds introduce too much false positives
if os.getenv("OSV_INCLUDE_FUZZ"):
osv_url_dict["linux"] = (
"https://osv-vulnerabilities.storage.googleapis.com/Linux/all.zip"
)
osv_url_dict["oss-fuzz"] = (
"https://osv-vulnerabilities.storage.googleapis.com/OSS-Fuzz/all.zip"
)
osv_url_dict["android"] = (
"https://osv-vulnerabilities.storage.googleapis.com/Android/all.zip",
)
VULN_LIST_URL = "https://github.com/appthreat/vuln-list/archive/refs/heads/main.zip"
# Placeholder fix version to use to indicate max versions
PLACEHOLDER_FIX_VERSION = "99.99.9"
# Placeholder exclude version to use to indicate non-vulnerability
# This is highly important for debian where a specific distro may be non-vulnerable
# While CPEs are the correct method of representing the exclusion, this version hack is aimed to be a short workaround
PLACEHOLDER_EXCLUDE_VERSION = "88.88.8"
# How many CVEs should be packed and written to the db file as a unit
# A large value here requires a larger max_buffer_size. Else could lead to msgpack.exceptions.BufferFull exceptions during read
BATCH_WRITE_SIZE = 20
# Limits size of unpacked data
MAX_BUFFER_SIZE = 200 * 1024 * 1024 # 200 MiB
THREAT_TO_SEVERITY = {
"unspecified": "LOW",
"": "LOW",
"negligible": "LOW",
"low": "LOW",
"unimportant": "LOW",
"severity_low": "LOW",
"medium": "MEDIUM",
"severity_medium": "MEDIUM",
"moderate": "MEDIUM",
"severity_moderate": "MEDIUM",
"important": "HIGH",
"high": "HIGH",
"severity_important": "HIGH",
"critical": "CRITICAL",
"severity_critical": "CRITICAL",
}
VENDOR_TO_VERS_SCHEME = {
"almalinux": "rpm",
"rocky": "rpm",
"photon": "rpm",
"ubuntu": "deb",
"debian": "deb",
"suse": "rpm",
"redhat": "rpm",
"opensuse": "rpm",
"alpine": "apk",
"gentoo": "ebuild",
"amazon": "rpm",
"wolfi": "apk",
"chainguard": "apk",
}
OS_PKG_TYPES = (
"deb",
"apk",
"rpm",
"swid",
"alpm",
"docker",
"oci",
"container",
"qpkg",
"buildroot",
"coreos",
"ebuild",
)
# URL for the pre-compiled database
# ghcr.io/appthreat/vdbxz:v6 - Start year 2018
# ghcr.io/appthreat/vdbxz-10y:v6 - Start year 2018
VDB_DATABASE_URL = os.getenv(
"VDB_DATABASE_URL",
(
"ghcr.io/appthreat/vdbxz-10y:v6"
if os.getenv("USE_VDB_10Y", "") in ("true", "1")
else "ghcr.io/appthreat/vdbxz:v6"
),
)
# A smaller application vulnerabilities database
VDB_APP_ONLY_DATABASE_URL = os.getenv("VDB_APP_ONLY_DATABASE_URL", "ghcr.io/appthreat/vdbxz-app:v6")
# This variable can be used to include or exclude distro-specific data
# export VDB_IGNORE_ALMALINUX=true
# export VDB_INCLUDE_ALPINE=true
LINUX_DISTRO_VULN_LIST_PATHS = {
"almalinux": ["alma"],
"alpine": ["alpine", "alpine-unfixed"],
"amazon": ["amazon"],
"arch": ["arch-linux"],
"chainguard": ["chainguard"],
"opensuse": [f"cvrf{os.sep}suse{os.sep}opensuse"],
"suse": [f"cvrf{os.sep}suse{os.sep}suse"],
"debian": ["debian"],
"photon": ["photon"],
"redhat": ["redhat"],
"rocky": ["rocky"],
"ubuntu": ["ubuntu"],
"wolfi": ["wolfi"]
}