/
sca-datamodel.bbclass
335 lines (279 loc) · 10.8 KB
/
sca-datamodel.bbclass
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
## SPDX-License-Identifier: BSD-2-Clause
## Copyright (c) 2019, Konrad Weihmann
inherit sca-helper
__SCA_DATAMODEL_STORAGE = "[]"
def sca_severity_transformation(d):
res = {}
for i in clean_split(d, "SCA_SEVERITY_TRANSFORM") + clean_split(d, "SCA_SEVERITY_TRANSFORM_EXTRA"):
if "=" not in i:
continue
k,v = i.split("=")
res[k] = v
return res
def sca_datamodel_bbfiles(d):
res = set()
for x in d.getVar("BBINCLUDED").split(" "):
if not os.path.exists(x):
continue
_name, _ext = os.path.splitext(x)
if _ext not in [".bb", ".inc", ".bbappend"]:
continue
# strip off layer paths
for y in d.getVar("BBLAYERS").split(" "):
if not y:
continue
if not y.endswith("/"):
y += "/"
x = x.replace(y, "", 1)
res.add(x.lstrip("/"))
return sorted(res)
sca_datamodel_bbfiles[vardepsexclude] += "BBINCLUDED BBLAYERS"
def sca_get_model_class(d, **kwargs):
__SevTrans = sca_severity_transformation(d)
class SCADataModel():
def __init__(self, d, *args, **kwargs):
self.__d = d
self.__File = ""
self.__BuildPath = ""
self.__Line = "1"
self.__Column = "1"
self.__Severity = ""
self.__Message = ""
self.__ID = ""
self.__PackageName = ""
self.__Tool = ""
self.__SevTrans = {}
self.__Scope = ""
self.__description = {}
self.__bbfiles = []
self.__overridepkgname = ""
self.__packagenames = [x for x in (self.__d.getVar("PACKAGES") or "").split(" ") if x]
for k,v in kwargs.items():
x = getattr(self, k)
if x is not None:
setattr(self, k, v)
@property
def File(self):
return self.__File
@File.setter
def File(self, value):
self.__File = value
self.__fixupPaths()
@property
def Scope(self):
return self.__Scope
@Scope.setter
def Scope(self, value):
self.__Scope = value
@property
def BuildPath(self):
return self.__BuildPath
@BuildPath.setter
def BuildPath(self, value):
self.__BuildPath = value
self.__fixupPaths()
@property
def Line(self):
return self.__Line
@Line.setter
def Line(self, value):
self.__Line = value
@property
def Column(self):
return self.__Column
@Column.setter
def Column(self, value):
self.__Column = value
@property
def Severity(self):
return self.__Severity
@Severity.setter
def Severity(self, value):
self.__Severity = value
self.__sev_transform()
@property
def Message(self):
return self.__Message
@Message.setter
def Message(self, value):
self.__Message = value
@property
def ID(self):
return self.__ID
@ID.setter
def ID(self, value):
self.__ID = value
self.__sev_transform()
@property
def PackageName(self):
return self.__overridepkgname or self.__PackageName
@PackageName.setter
def PackageName(self, value):
self.__PackageName = value
@property
def Tool(self):
return self.__Tool
@Tool.setter
def Tool(self, value):
self.__Tool = value
@property
def SevTrans(self):
return self.__SevTrans
@SevTrans.setter
def SevTrans(self, value):
self.__SevTrans = value
self.__sev_transform()
@property
def BBFiles(self):
return self.__bbfiles
@BBFiles.setter
def BBFiles(self, value):
self.__bbfiles = value
def AddDescription(self, basepath):
import json
_path = os.path.join(basepath, "{}.sca.description".format(self.__Tool.lower()))
if os.path.exists(_path):
with open(_path) as i:
self.__description = json.load(i)
self.__getScope()
def __getScope(self):
if self.__Scope:
return
if not self.__ID or not self.__description:
return
import re
_id = self.GetFormattedID()
for s in ["security", "functional", "compliance", "style"]:
if s not in self.__description["score"]:
continue
for f in self.__description["score"][s]:
if re.match(f, _id):
self.__Scope = s
break
if self.__Scope:
break
def __fixupPaths(self):
if self.__File:
if self.__BuildPath:
_needles = [self.__BuildPath, self.__BuildPath[1:]]
for n in _needles:
if self.__File.startswith(n):
self.__File = self.__File.replace(n, "", 1)
break
if self.__File.startswith(".") and not \
os.path.exists(os.path.join(self.__BuildPath, self.__File)):
self.__File = self.__File.lstrip(".")
_needles = [x for x in (self.__d.getVar("BBLAYERS") or "").split(" ") if x] + ["/"]
for n in _needles:
if self.__File.startswith(n):
self.__File = self.__File.replace(n, "", 1)
break
for pkg in self.__packagenames:
if self.__File.startswith(pkg + "/"):
self.__overridepkgname = pkg
self.__BuildPath = os.path.join(self.__BuildPath, pkg)
self.__File = self.__File.replace(pkg, "", 1).lstrip("/")
def __sev_transform(self):
import re
if self.__SevTrans and self.__ID and self.__Severity:
__id = self.GetFormattedID()
for k, v in self.__SevTrans.items():
if re.match(k, __id):
if self.__SevTrans != v:
self.__Severity = v
break
def GetPlainID(self):
tmp = self.__ID or ""
tool_prefix = [x for x in tmp.split(".") if x == self.__Tool or x.lower() == self.__Tool.lower()]
_id = [x for x in tmp.split(".") if x != self.__Tool]
if any(tool_prefix):
return "{}.{}".format(".".join(tool_prefix), "_".join(_id))
return "_".join(_id)
def GetFormattedMessage(self):
return "[Package:{} Tool:{}] {}".format(self.PackageName, self.__Tool, self.__Message)
def GetFormattedID(self):
res = self.GetPlainID()
if res.startswith("{}.{}".format(self.__Tool, self.__Tool)):
pass
elif res.startswith("{}".format(self.__Tool)):
res = "{}.{}".format(self.__Tool, res)
else:
res = "{}.{}.{}".format(self.__Tool, self.__Tool, res)
return res
def GetPath(self, exportPath=None):
self.__fixupPaths()
return os.path.join(exportPath or self.__BuildPath or "", self.__File)
def GetItemHash(self):
"""Returns MD5 hash of the item without absolute paths
"""
import hashlib
return hashlib.md5("{}{}{}{}{}{}{}{}{}".format(
self.Column,
self.File,
self.ID,
self.Line,
self.Message,
self.PackageName,
self.Scope,
self.Severity,
self.Tool
).encode('utf-8')).hexdigest()
def __repr__(self):
return "{}:{}:{} [{}]: {} ({}) :: {}".format(self.GetPath(), self.__Line, self.__Column, self.__Severity, self.__Message, self.GetFormattedID(), self.__Scope)
def __eq__(self, other):
return str(other) == str(self)
def __ne__(self, other):
return (not self.__eq__(other))
def __hash__(self):
return hash(self.__repr__())
@staticmethod
def FromDict(d, _in):
return SCADataModel(d, **_in)
@staticmethod
def FromList(d, _in):
return [SCADataModel.FromDict(d, x) for x in _in]
def ToDict(self):
return {k:getattr(self,k) for k in ["File", "BBFiles", "BuildPath", "Line", "Column", "Severity", "Message", "ID", "PackageName", "Tool", "Scope"] if getattr(self,k)}
x = SCADataModel(d, SevTrans=__SevTrans, BBFiles=sca_datamodel_bbfiles(d), **kwargs)
x.AddDescription(d.getVar("STAGING_DATADIR_NATIVE"))
return x
sca_get_model_class[vardepsexclude] += "BBLAYERS"
def __sca_model_to_list(d, list):
return [x.ToDict() for x in list]
def sca_get_datamodel(d, path):
import json
with open(path, "r") as o:
_m = sca_get_model_class(d)
return _m.FromList(d, json.load(o))
return []
def sca_add_model_class(d, item):
import json
_m = sca_get_model_class(d)
_t = _m.FromList(d, json.loads(d.getVar("__SCA_DATAMODEL_STORAGE", False)))
_t.append(item)
d.setVar("__SCA_DATAMODEL_STORAGE", json.dumps(__sca_model_to_list(d, _t)))
def sca_add_model_class_list(d, _list):
import json
_m = sca_get_model_class(d)
_t = _m.FromList(d, json.loads(d.getVar("__SCA_DATAMODEL_STORAGE", False)))
_t += _list
d.setVar("__SCA_DATAMODEL_STORAGE", json.dumps(__sca_model_to_list(d, _t)))
def __sca_unique_model(d):
import json
_m = sca_get_model_class(d)
_t = _m.FromList(d, json.loads(d.getVar("__SCA_DATAMODEL_STORAGE", False)))
_t = list(set(_t))
return __sca_model_to_list(d, _t)
def sca_save_model_to_file(d, model, path):
import json
with open(path, "w") as o:
if isinstance(model, list):
json.dump(__sca_model_to_list(d, model), o, indent=2, sort_keys=True)
else:
o.write(model)
def sca_save_model_to_string(d, model=None):
import json
if not model:
return json.dumps(__sca_unique_model(d))
else:
return json.dumps([x.ToDict() for x in model])