-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathclasses.py
530 lines (449 loc) · 14.8 KB
/
classes.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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
import json
from dataclasses import dataclass, field
from typing import Dict, List, TypedDict, Any, Optional
from socketdev.fullscans import FullScanMetadata, SocketArtifact, SocketArtifactLink, DiffType, SocketManifestReference, SocketScore, SocketAlert
__all__ = [
"Report",
"Score",
"Package",
"Issue",
"YamlFile",
"Alert",
"FullScan",
"Repository",
"Diff",
"Purl",
"Comment"
]
class Report:
"""Represents a Socket Security scan report for a repository."""
branch: str
commit: str
id: str
pull_requests: list
url: str
repo: str
processed: bool
owner: str
created_at: str
sbom: list
def __init__(self, **kwargs):
self.sbom = []
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
if not hasattr(self, "processed"):
self.processed = False
if hasattr(self, "pull_requests"):
if self.pull_requests is not None:
self.pull_requests = json.loads(str(self.pull_requests))
def __str__(self):
return json.dumps(self.__dict__)
class Score:
"""
Represents Socket Security scores for a package or repository.
All scores are normalized to 0-100 range, converting from 0-1 if needed.
"""
supplyChain: float
quality: float
maintenance: float
license: float
overall: float
vulnerability: float
def __init__(self, **kwargs):
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
for score_name in self.__dict__:
score = getattr(self, score_name)
if score <= 1:
score = score * 100
setattr(self, score_name, score)
def __str__(self):
return json.dumps(self.__dict__)
def to_dict(self) -> dict:
"""
Convert Score object to dictionary with default values.
Returns:
Dictionary containing all score values, defaulting to 0 if not set
"""
return {
"supplyChain": self.supplyChain if hasattr(self, "supplyChain") else 0,
"quality": self.quality if hasattr(self, "quality") else 0,
"maintenance": self.maintenance if hasattr(self, "maintenance") else 0,
"license": self.license if hasattr(self, "license") else 0,
"overall": self.overall if hasattr(self, "overall") else 0,
"vulnerability": self.vulnerability if hasattr(self, "vulnerability") else 0
}
class AlertCounts(TypedDict):
"""Type definition for counting alerts by severity level."""
critical: int
high: int
middle: int
low: int
@dataclass(kw_only=True)
class Package(SocketArtifactLink):
"""
Represents a package detected in a Socket Security scan.
Inherits from SocketArtifactLink to maintain connection to dependency tree.
Adds additional fields for package-specific information.
"""
# Common properties from both artifact types
id: str
name: str
version: str
type: str
score: SocketScore
alerts: List[SocketAlert]
author: List[str] = field(default_factory=list)
size: Optional[int] = None
license: Optional[str] = None
namespace: Optional[str] = None
# Package-specific fields
license_text: str = ""
purl: str = ""
transitives: int = 0
url: str = ""
# Artifact-specific fields
licenseDetails: Optional[list] = None
@classmethod
def from_socket_artifact(cls, data: dict) -> "Package":
"""
Create a Package from a SocketArtifact dictionary.
Args:
data: Dictionary containing SocketArtifact data
Returns:
New Package instance
"""
purl = f"{data['type']}/"
namespace = data.get("namespace")
if namespace:
purl += f"{namespace}@"
purl += f"{data['name']}@{data['version']}"
base_url = "https://socket.dev"
url = f"{base_url}/{data['type']}/package/{namespace or ''}{data['name']}/overview/{data['version']}"
return cls(
id=data["id"],
name=data["name"],
version=data["version"],
type=data["type"],
score=data["score"],
alerts=data["alerts"],
author=data.get("author", []),
size=data.get("size"),
license=data.get("license"),
topLevelAncestors=data["topLevelAncestors"],
direct=data.get("direct", False),
manifestFiles=data.get("manifestFiles", []),
dependencies=data.get("dependencies"),
artifact=data.get("artifact"),
purl=purl,
url=url,
namespace=namespace
)
@classmethod
def from_diff_artifact(cls, data: dict) -> "Package":
"""
Create a Package from a DiffArtifact dictionary.
Args:
data: Dictionary containing DiffArtifact data
Returns:
New Package instance
Raises:
ValueError: If reference data cannot be found in DiffArtifact
"""
ref = None
if data["diffType"] in ["added", "updated"] and data.get("head"):
ref = data["head"][0]
elif data["diffType"] in ["removed", "replaced"] and data.get("base"):
ref = data["base"][0]
if not ref:
raise ValueError("Could not find reference data in DiffArtifact")
return cls(
id=data["id"],
name=data["name"],
version=data["version"],
type=data["type"],
score=data["score"],
alerts=data["alerts"],
author=data.get("author", []),
size=data.get("size"),
license=data.get("license"),
topLevelAncestors=ref["topLevelAncestors"],
direct=ref.get("direct", False),
manifestFiles=ref.get("manifestFiles", []),
dependencies=ref.get("dependencies"),
artifact=ref.get("artifact"),
namespace=data.get('namespace', None)
)
class Issue:
pkg_type: str
pkg_name: str
pkg_version: str
category: str
type: str
severity: str
pkg_id: str
props: dict
key: str
error: bool
warn: bool
ignore: bool
monitor: bool
description: str
title: str
emoji: str
next_step_title: str
suggestion: str
introduced_by: list
manifests: str
url: str
purl: str
def __init__(self, **kwargs):
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
if hasattr(self, "created_at"):
self.created_at = self.created_at.strip(" (Coordinated Universal Time)")
if not hasattr(self, "manifests"):
self.manifests = ""
if not hasattr(self, "suggestion"):
self.suggestion = ""
if not hasattr(self, "introduced_by"):
self.introduced_by = []
else:
for item in self.introduced_by:
pkg, manifest = item
self.manifests += f"{manifest};"
self.manifests = self.manifests.rstrip(";")
if not hasattr(self, "error"):
self.error = False
if not hasattr(self, "warn"):
self.warn = False
if not hasattr(self, "monitor"):
self.monitor = False
if not hasattr(self, "ignore"):
self.ignore = False
def __str__(self):
return json.dumps(self.__dict__)
def __eq__(self, other):
return self.__dict__ == other.__dict__
def __ne__(self, other):
return self.__dict__ != other.__dict__
class YamlFile:
"""
Represents a YAML configuration file with associated alerts.
Stores metadata about the file and any security alerts found during scanning.
"""
path: str
name: str
team: list
module: list
production: bool
pii: bool
alerts: dict
error_ids: list
def __init__(self, **kwargs):
self.alerts = {}
self.error_ids = []
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
def __str__(self):
alerts = {}
for issue_key in self.alerts:
issue: Issue
issue = self.alerts[issue_key]["issue"]
manifests = self.alerts[issue_key]["manifests"]
new_alert = {
"issue": json.loads(str(issue)),
"manifests": manifests
}
alerts[issue_key] = new_alert
dump_object = self
dump_object.alerts = alerts
return json.dumps(dump_object.__dict__)
class Alert:
"""Represents a security alert with its type, severity, and associated properties."""
key: str
type: str
severity: str
category: str
props: dict
def __init__(self, **kwargs):
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
if not hasattr(self, "props"):
self.props = {}
def __str__(self):
return json.dumps(self.__dict__)
class FullScan(FullScanMetadata):
"""
Represents a complete Socket Security scan of a repository.
Inherits from FullScanMetadata and adds fields for SBOM artifacts and package data.
"""
sbom_artifacts: list[SocketArtifact]
packages: dict[str, Package]
def __init__(self, **kwargs):
super().__init__(**kwargs)
if not hasattr(self, "sbom_artifacts"):
self.sbom_artifacts = []
if not hasattr(self, "packages"):
self.packages = {}
def __str__(self):
return json.dumps(self.__dict__)
class Repository:
"""Represents a source code repository with its metadata and scan results."""
id: str
created_at: str
updated_at: str
head_full_scan_id: str
name: str
description: str
homepage: str
visibility: str
archived: bool
default_branch: str
def __init__(self, **kwargs):
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
def __str__(self):
return json.dumps(self.__dict__)
class Purl:
"""
Represents a Package URL (PURL) with extended metadata.
Includes package identification, authorship, and dependency information.
"""
id: str
name: str
version: str
ecosystem: str
direct: bool
author: list
size: int
transitives: int
introduced_by: list
capabilities: List[str]
is_new: bool
author_url: str
url: str
purl: str
def __init__(self, **kwargs):
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
if not hasattr(self, "introduced_by"):
self.new_packages = []
if not hasattr(self, "capabilities"):
self.capabilities = []
if not hasattr(self, "is_new"):
self.is_new = False
self.author_url = Purl.generate_author_data(self.author, self.ecosystem)
@staticmethod
def generate_author_data(authors: list, ecosystem: str) -> str:
"""
Creates markdown-formatted links to author profiles.
Args:
authors: List of author names
ecosystem: Package ecosystem (npm, pypi, etc.)
Returns:
Comma-separated string of markdown links to author profiles
"""
authors_str = ""
for author in authors:
author_url = f"https://socket.dev/{ecosystem}/user/{author}"
authors_str += f"[{author}]({author_url}),"
authors_str = authors_str.rstrip(",")
return authors_str
def __str__(self):
return json.dumps(self.__dict__)
def to_dict(self) -> dict:
"""
Convert Purl object to a dictionary representation.
Returns:
Dictionary containing all Purl attributes
"""
return {
"id": self.id,
"name": self.name,
"version": self.version,
"ecosystem": self.ecosystem,
"direct": self.direct,
"author": self.author,
"size": self.size,
"transitives": self.transitives,
"introduced_by": self.introduced_by,
"capabilities": self.capabilities,
"is_new": self.is_new,
"author_url": self.author_url,
"url": self.url,
"purl": self.purl
}
class Diff:
"""
Represents differences between two Socket Security scans.
Tracks changes in packages, capabilities, and security alerts between scans.
"""
new_packages: list[Purl]
new_capabilities: Dict[str, List[str]]
removed_packages: list[Purl]
new_alerts: list[Issue]
id: str
sbom: str
packages: dict[str, Package]
report_url: str
diff_url: str
def __init__(self, **kwargs):
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
if not hasattr(self, "new_packages"):
self.new_packages = []
if not hasattr(self, "removed_packages"):
self.removed_packages = []
if not hasattr(self, "new_alerts"):
self.new_alerts = []
if not hasattr(self, "new_capabilities"):
self.new_capabilities = {}
def __str__(self):
return json.dumps(self.__dict__)
def to_dict(self) -> dict:
"""
Convert Diff object to a dictionary representation.
Returns:
Dictionary containing all Diff attributes with nested objects converted
"""
return {
"new_packages": [p.to_dict() for p in self.new_packages],
"new_capabilities": self.new_capabilities,
"removed_packages": [p.to_dict() for p in self.removed_packages],
"new_alerts": [alert.__dict__ for alert in self.new_alerts],
"id": self.id,
"sbom": self.sbom if hasattr(self, "sbom") else [],
"packages": {k: v.to_dict() for k, v in self.packages.items()} if hasattr(self, "packages") else {},
"report_url": self.report_url if hasattr(self, "report_url") else None,
"diff_url": self.diff_url if hasattr(self, "diff_url") else None
}
class Comment:
"""Represents a GitHub comment with its metadata and content."""
url: str
html_url: str
issue_url: str
id: int
node_id: str
user: dict
created_at: str
updated_at: str
author_association: str
body: str
body_list: list
reactions: dict
performed_via_github_app: dict
def __init__(self, **kwargs):
if kwargs:
for key, value in kwargs.items():
setattr(self, key, value)
def __str__(self):
return json.dumps(self.__dict__)