-
Notifications
You must be signed in to change notification settings - Fork 178
Expand file tree
/
Copy pathparser.js
More file actions
283 lines (270 loc) · 8.98 KB
/
parser.js
File metadata and controls
283 lines (270 loc) · 8.98 KB
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
// SPDX-FileCopyrightText: the secureCodeBox authors
//
// SPDX-License-Identifier: Apache-2.0
const templates = {
del: {
critical: {
kex: {
name: "Insecure SSH KEX Algorithms",
description: "Discouraged SSH key exchange algorithms in use",
mitigation: "Remove these KEX algorithms",
},
key: {
name: "Insecure SSH Key Algorithms",
description: "Discouraged SSH key algorithms in use",
mitigation: "Remove these key algorithms",
},
mac: {
name: "Insecure SSH MAC Algorithms",
description:
"Discouraged SSH message authentication code algorithms in use",
mitigation: "Remove these MAC algorithms",
},
enc: {
name: "Insecure SSH Encryption Algorithms",
description: "Discouraged SSH Encryption algorithms are in use",
mitigation: "Remove these encryption algorithms",
},
},
warning: {
kex: {
name: "Insecure SSH KEX Algorithms",
description: "Discouraged SSH key exchange algorithms in use",
mitigation: "Remove these KEX algorithms",
},
key: {
name: "Insecure SSH Key Algorithms",
description: "Discouraged SSH key algorithms in use",
mitigation: "Remove these key algorithms",
},
mac: {
name: "Insecure SSH MAC Algorithms",
description:
"Discouraged SSH message authentication code algorithms in use",
mitigation: "Remove these MAC algorithms",
},
enc: {
name: "Insecure SSH Encryption Algorithms",
description: "Discouraged SSH Encryption algorithms are in use",
mitigation: "Remove these encryption algorithms",
},
},
},
chg: {
critical: {
kex: {
name: "SSH KEX Algorithms must be changed",
description: "Weak SSH key exchange algorithms in use",
mitigation: "Change these KEX algorithms",
},
key: {
name: "SSH Key Algorithms must be changed",
description: "Weak SSH key algorithms in use",
mitigation: "Change these key algorithms",
},
mac: {
name: "SSH MAC Algorithms must be changed",
description: "Weak SSH message authentication code algorithms in use",
mitigation: "Change these MAC algorithms",
},
enc: {
name: "SSH Encryption Algorithms must be changed",
description: "Weak SSH encryption algorithms in use",
mitigation: "Change these encryption algorithms",
},
},
warning: {
kex: {
name: "SSH KEX Algorithms must be changed",
description: "Weak SSH key exchange algorithms in use",
mitigation: "Change these KEX algorithms",
},
key: {
name: "SSH Key Algorithms must be changed",
description: "Weak SSH key algorithms in use",
mitigation: "Change these key algorithms",
},
mac: {
name: "SSH MAC Algorithms must be changed",
description: "Weak SSH message authentication code algorithms in use",
mitigation: "Change these MAC algorithms",
},
enc: {
name: "SSH Encryption Algorithms must be changed",
description: "Weak SSH encryption algorithms in use",
mitigation: "Change these encryption algorithms",
},
},
},
add: {
informational: {
kex: {
name: "SSH KEX Algorithms must be added",
description: "SSH key exchange algorithms missing",
mitigation: "Add these KEX algorithms",
},
key: {
name: "SSH Key Algorithms must be added",
description: "SSH key algorithms missing",
mitigation: "Add these key algorithms",
},
mac: {
name: "SSH MAC Algorithms must be added",
description: "SSH message authentication code algorithms missing",
mitigation: "Add these MAC algorithms",
},
enc: {
name: "SSH Encryption Algorithms must be added",
description: "SSH encryption algorithms missing",
mitigation: "Add these encryption algorithms",
},
},
critical: {
kex: {
name: "SSH KEX Algorithms must be added",
description: "SSH key exchange algorithms missing",
mitigation: "Add these KEX algorithms",
},
key: {
name: "SSH Key Algorithms must be added",
description: "SSH key algorithms missing",
mitigation: "Add these key algorithms",
},
mac: {
name: "SSH MAC Algorithms must be added",
description: "SSH message authentication code algorithms missing",
mitigation: "Add these MAC algorithms",
},
enc: {
name: "SSH Encryption Algorithms must be added",
description: "SSH encryption algorithms missing",
mitigation: "Add these encryption algorithms",
},
},
warning: {
kex: {
name: "SSH KEX Algorithms must be added",
description: "SSH key exchange algorithms missing",
mitigation: "Add these KEX algorithms",
},
key: {
name: "SSH Key Algorithms must be added",
description: "SSH key algorithms missing",
mitigation: "Add these key algorithms",
},
mac: {
name: "SSH MAC Algorithms must be added",
description: "SSH message authentication code algorithms missing",
mitigation: "Add these MAC algorithms",
},
enc: {
name: "SSH Encryption Algorithms must be added",
description: "SSH encryption algorithms missing",
mitigation: "Add these encryption algorithms",
},
},
},
};
/**
* Transforms recommendations from the ssh-audit scanner into SSH Policy Violation Findings
* @param {String} recommendationSeverityLevel
* @param {{}} value
*/
function transformRecommendationToFinding(
recommendationSeverityLevel,
value,
destination,
) {
// SSH audit has critical and warnings as recommendations.
// These are HIGH and MEDIUM severities, respectively
const policyViolationFindings = [];
let severity = "LOW";
if (recommendationSeverityLevel == "critical") severity = "HIGH";
if (recommendationSeverityLevel == "warning") severity = "MEDIUM";
const findingTemplate = null;
// recommendationAction = del/chg/add
Object.entries(value).map(([recommendationAction, algorithms]) => {
//algorithmType = kex/ key/ mac, , algorithmNames = {name+note}
Object.entries(algorithms).map(([algorithmType, algorithmData]) => {
const algorithmNames = Object.entries(algorithmData).map(
([keyNames, content]) => Object.values(content),
);
const findingTemplate =
templates[recommendationAction][recommendationSeverityLevel][
algorithmType
] || null;
if (findingTemplate != null && typeof findingTemplate != "undefined") {
findingTemplate["severity"] = severity;
findingTemplate["category"] = "SSH Policy Violation";
findingTemplate["location"] = destination;
findingTemplate["attributes"] = {};
findingTemplate["attributes"]["algorithms"] = algorithmNames.flatMap(
([algName, note]) =>
note == "" ? algName : `${algName} (Note: ${note})`,
);
policyViolationFindings.push(findingTemplate);
}
});
});
return policyViolationFindings;
}
function isIPaddress(target) {
if (/^(?!0)(?!.*\.$)((1?\d?\d|25[0-5]|2[0-4]\d)(\.|$)){4}$/.test(target))
return true;
else return false;
}
/**
*
* Parses the raw results from the ssh-audit scanner into Findings
*/
export async function parse(fileContent) {
if (!fileContent) {
return [];
}
const report = JSON.parse(fileContent);
if (!report || !report.target) {
return [];
}
const destination = report.target.split(":");
const location = "ssh://" + destination[0];
let ipAddress = null;
let hostname = null;
if (isIPaddress(destination[0])) {
ipAddress = destination[0]
} else {
hostname = destination[0]
}
const recommendationsArray = Object.entries(report.recommendations);
const policyViolationFindings = recommendationsArray.flatMap(
([recommendationSeverityLevel, value]) =>
transformRecommendationToFinding(
recommendationSeverityLevel,
value,
location,
),
);
// informational findings
const serviceFinding = {
name: "SSH Service",
description: "Information about Used SSH Algorithms",
category: "SSH Service",
osi_layer: "APPLICATION",
severity: "INFORMATIONAL",
location: location,
port: destination[1] || null,
attributes: {
hostname: hostname || null,
ip_address: ipAddress || null,
server_banner: report.banner?.raw || null,
ssh_version: report.banner?.protocol || null,
ssh_lib_cpe: report.banner?.software,
key_algorithms: report.key,
encryption_algorithms: report.enc,
mac_algorithms: report.mac,
compression_algorithms: report.compression,
key_exchange_algorithms: report.kex,
fingerprints: report.fingerprints,
},
};
return [serviceFinding, ...policyViolationFindings];
}