-
Notifications
You must be signed in to change notification settings - Fork 4
/
device.py
404 lines (363 loc) · 18.4 KB
/
device.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
#!/usr/bin/python3
# Cisco Cyber Vision V4.x and V5.0.x
# Device Management
# Version 1.3 - 2023-01-09
import argparse
from collections import defaultdict
import csv
import os
import json
import cvconfig
import api
def main():
parser = argparse.ArgumentParser(prog="device.py",
description="Device Management")
# Options parsing
parser.add_argument("--token", dest="token", help="Use this token")
parser.add_argument("--center-ip", dest="center_ip",
help="Specified the center FQDN or IPv4 address"
" (default:'cybervision')")
parser.add_argument("--center-port", dest="center_port",
help="Specified the center port (default: %d)"%cvconfig.center_port,
default=cvconfig.center_port)
parser.add_argument("--proxy", dest="proxy",
help="Specified the proxy to use (default: %s)"%cvconfig.proxy,
default=cvconfig.proxy)
parser.add_argument("--encoding", dest="csv_encoding",
help="CSV file encoding, default is %s" % cvconfig.csv_encoding)
parser.add_argument("--delimiter", dest="csv_delimiter",
help="CSV file delimiter, default is %s" % cvconfig.csv_delimiter)
parser.add_argument("--filename", dest="filename", help="Use this filename", default="devices.csv")
# Main Command Parsing
command_group = parser.add_mutually_exclusive_group()
command_group.add_argument("--export",
help="Export all devices into a CSV file\n",
action="store_true", default=False, dest="command_export")
command_group.add_argument("--update",
help="Update existing groups with devices from a CSV file\n",
action="store_true", default=False, dest="command_update")
command_group.add_argument("--unknown-vendors",
help="Get the list of unknown vendords\n",
action="store_true", default=False, dest="command_vendors")
args = parser.parse_args()
# Handle Cybervision configuration
token = set_conf(args.token, cvconfig.token)
center_ip = set_conf(args.center_ip, cvconfig.center_ip)
center_port = set_conf(args.center_port, cvconfig.center_port)
proxy = set_conf(args.proxy, cvconfig.proxy)
csv_encoding = set_conf(args.csv_encoding, cvconfig.csv_encoding)
csv_delimiter = set_conf(args.csv_delimiter, cvconfig.csv_delimiter)
if not token or not center_ip:
print("TOKEN and CENTER_IP are mandatory, check cvconfig.py or us --token/--center-ip")
if args.command_export:
return device_export(center_ip, center_port, token, proxy, args.filename,csv_delimiter, csv_encoding)
elif args.command_update:
return device_update(center_ip, center_port, token, proxy, args.filename, csv_delimiter, csv_encoding)
elif args.command_vendors:
return get_unkown_vendors(center_ip, center_port, token, proxy)
parser.print_help()
def set_conf(arg,conf):
if arg and arg != conf:
return arg
return conf
def build_device_row(session,row,d):
try:
row['device-id'] = d['id']
row['device-mac'] = d['mac']
row['device-ip'] = d['ip']
row['device-name'] = d['originalLabel']
row['device-custom-name'] = d['customLabel']
row['device-tags'] = "-".join(sorted(t['label'] for t in d['tags']))
row['device-riskscore'] = d['riskScore']
row['device-network'] = d.get('situation')
row['device-isdevice'] = d['isDevice']
# Normalized Properties
if 'normalizedProperties' in d:
for p in d['normalizedProperties']:
if p['key'] == "fw-version":
row['device-fw-version'] = p['value']
elif p['key'] == "hw-version":
row['device-hw-version'] = p['value']
elif p['key'] == "model-name":
row['device-model-name'] = p['value']
elif p['key'] == "model-ref":
row['device-model-ref'] = p['value']
# Group Properties
if 'group' in d and d['group']:
row['group-name'] = d['group']['label']
row['group-color'] = d['group']['color']
row['group-industrial-impact'] = d['group'].get('criticalness')
except KeyError as e:
print("KeyError: {} for device {}".format(e, row['device-id']))
except Exception as e: print(e)
def build_device_riskscore(session,row,d):
# RiskScore
if 'riskScore' in d and d['riskScore']:
risk_score = int(d['riskScore'])
else:
return
try:
if risk_score > 0:
risk = api.get_route(session, f"/api/3.0/devices/{d['id']}/riskScore")
if not risk:
return
row['device-riskscore-current'] = d['riskScore']
if 'bestAchievableScore' in d:
row['device-riskscore-best-achievable'] = d['bestAchievableScore']
# Device Type
if risk['deviceTypeRisk']['score'] > 0:
row['device-riskscore-devicetype-matching'] = risk['deviceTypeRisk']['device']['deviceType']
row['device-riskscore-devicetype-distribution'] = risk['deviceTypeRisk']['score']
row['device-riskscore-devicetype-details'] = risk['deviceTypeRisk'].get('riskScoreDescription')
# Activity
if risk['activitiesRisk']['score'] > 0:
row['device-riskscore-activities-matching'] = risk['activitiesRisk']['matchingTag']['label']
row['device-riskscore-activities-distribution'] = risk['activitiesRisk']['score']
row['device-riskscore-activities-details'] = risk['activitiesRisk']['matchingTag'].get('riskScoreDescription')
# Group
if risk['groupRisk']['score'] > 0:
row['device-riskscore-groupimpact-matching'] = risk['groupRisk']['label']
row['device-riskscore-groupimpact-distribution'] = risk['groupRisk']['score']
row['device-riskscore-groupimpact-details'] = risk['groupRisk']['description']
row['device-riskscore-groupimpact-criticalness'] = risk['groupRisk'].get('criticalness')
# Vulnerabilities
if risk['vulnerabilitiesRisk']['mostImpactingVulnerability']:
row['device-riskscore-vulnerabilities-cve'] = risk['vulnerabilitiesRisk']['mostImpactingVulnerability']['cve']
row['device-riskscore-vulnerabilities-distribution'] = risk['vulnerabilitiesRisk']['score']
row['device-riskscore-vulnerabilities-details'] = risk['vulnerabilitiesRisk']['mostImpactingVulnerability']
except KeyError as e:
print("KeyError: {} for device {}".format(e, row['device-id']))
except Exception as e:
print(e)
def get_vendor_name (device):
if 'normalizedProperties' in device:
for p in device['normalizedProperties']:
if p['key'] == "vendor-name":
return p['value']
return ''
def get_unkown_vendors(center_ip, center_port, token, proxy):
with api.APISession(center_ip, center_port, token, proxy) as session:
# hack to get all devices via 'All data' preset, should be removed later
components = api.get_route(session, '/api/3.0/components')
unknown_vendors = {}
for c in components:
if c['icon'] == 'library/default.svg':
vendor = get_vendor_name(c)
if not vendor in unknown_vendors:
unknown_vendors[vendor] = c['mac'][0:8]
print(json.dumps(unknown_vendors,sort_keys=True, indent=4))
return
def write_devices(filename,csv_encoding,csv_delimiter,devices,session):
with open(filename, 'w', encoding=csv_encoding) as csvfile:
fieldnames = ['device-id','device-mac','device-ip','device-name','device-custom-name','device-tags','device-riskscore',
'group-name','group-color','group-industrial-impact',
'device-network','device-fw-version','device-hw-version','device-model-name','device-model-ref',
'device-riskscore-current','device-riskscore-best-achievable','device-isdevice',
'device-riskscore-devicetype-matching','device-riskscore-devicetype-distribution','device-riskscore-devicetype-distribution','device-riskscore-devicetype-details',
'device-riskscore-activities-matching','device-riskscore-activities-distribution','device-riskscore-activities-distribution','device-riskscore-activities-details',
'device-riskscore-groupimpact-matching','device-riskscore-groupimpact-distribution','device-riskscore-groupimpact-distribution','device-riskscore-groupimpact-details','device-riskscore-groupimpact-criticalness',
'device-riskscore-vulnerabilities-cve','','device-riskscore-vulnerabilities-matching','device-riskscore-vulnerabilities-distribution','device-riskscore-vulnerabilities-details',
]
writer = csv.DictWriter(csvfile, fieldnames=fieldnames, delimiter=csv_delimiter)
writer.writeheader()
for d in devices:
row = {}
build_device_row(session,row,d)
build_device_riskscore(session,row,d)
writer.writerow(row)
print(f"LOG: Exported {len(devices)} into '{filename}'")
#write simple device CSV for groupping script
def write_devices_group(filename,csv_encoding,csv_delimiter,devices,session):
with open(filename, 'w', encoding=csv_encoding) as csvfile:
fieldnames = ['device-id','device-mac','device-ip','device-name','device-custom-name','device-tags','device-riskscore',
'group-name','group-color','group-industrial-impact',
'device-network','device-fw-version','device-hw-version','device-model-name','device-model-ref',
'device-riskscore-current','device-riskscore-best-achievable','device-isdevice',
]
writer = csv.DictWriter(csvfile, fieldnames=fieldnames, delimiter=csv_delimiter)
writer.writeheader()
for d in devices:
row = {}
build_device_row(session,row,d)
writer.writerow(row)
print(f"LOG: Exported {len(devices)} into '{filename}'")
#
# Vulnerabiltiies
#
def build_device_vulns(session,d):
vulns = []
# We are keeping vuln in a separate list
if d['vulnerabilitiesCount'] > 0:
try:
if d['isDevice']:
vulns = api.get_route(session, f"/api/3.0/devices/{d['id']}/vulnerabilities")
else:
vulns = api.get_route(session, f"/api/3.0/components/{d['id']}/vulnerabilities")
except Exception as e: print(e)
return vulns
def write_vulns(filename,csv_encoding,csv_delimiter,session,devices):
filename_vulns = os.path.splitext(filename)[0]+"-vulns.csv"
with open(filename_vulns, 'w', encoding=csv_encoding) as csvfile:
fieldnames = ['device-id','device-mac','device-ip','device-name','device-custom-name',
'CVE','CVSS','CVSS-temporal','CVSS-vector-string','CVE-description','CVE-solution']
writer = csv.DictWriter(csvfile, fieldnames=fieldnames, delimiter=csv_delimiter)
writer.writeheader()
count = 0
for d in devices:
vulnerabilities = build_device_vulns(session,d)
for vuln in vulnerabilities:
row = {}
build_vulns_row(row,vuln,d)
writer.writerow(row)
count = count+1
print(f"LOG: Exported {count} into '{filename_vulns}'")
def build_vulns_row(row,vuln,d):
row['device-id'] = d['id']
row['device-mac'] = d['mac']
row['device-ip'] = d['ip']
row['device-name'] = d['originalLabel']
row['device-custom-name'] = d['customLabel']
row['CVE'] = vuln['cve']
row['CVSS'] = vuln.get('CVSS')
row['CVSS-temporal'] = vuln.get('CVSS_temporal')
row['CVSS-vector-string'] = vuln.get('CVSS_vector_string')
row['CVE-description'] = "{} {}".format(vuln.get('full_description'), vuln.get('summary'))
row['CVE-solution'] = vuln['solution']
#
# Credentials
#
def build_device_credentials(session,d):
creds = []
try:
if d['isDevice']:
creds = api.get_route(session, f"/api/3.0/devices/{d['id']}/credentials")
else:
creds = api.get_route(session, f"/api/3.0/components/{d['id']}/credentials")
except Exception as e: print(e)
return creds
def write_credentials(filename,csv_encoding,csv_delimiter,session,devices):
filename_creds = os.path.splitext(filename)[0]+"-creds.csv"
with open(filename_creds, 'w', encoding=csv_encoding) as csvfile:
fieldnames = ['device-id','device-mac','device-ip','device-name','device-custom-name','credential-username', 'credential-algorithm', 'credential-password', 'credential-protocol']
writer = csv.DictWriter(csvfile, fieldnames=fieldnames, delimiter=csv_delimiter)
writer.writeheader()
count = 0
for d in devices:
credentials = build_device_credentials(session,d)
for cred in credentials:
row = {}
build_cred_row(row,cred,d)
writer.writerow(row)
count = count+1
print(f"LOG: Exported {count} into '{filename_creds}'")
def build_cred_row(row,cred,d):
row['device-id'] = d['id']
row['device-mac'] = d['mac']
row['device-ip'] = d['ip']
row['device-name'] = d['originalLabel']
row['device-custom-name'] = d['customLabel']
row['credential-protocol'] = cred['protocol']
if 'username' in cred: row['credential-username'] = cred['username']
else: row['credential-username'] = "EMPTY_USERNAME"
if 'password' in cred:
if cred['password']:
row['credential-password'] = cred['password']
else:
row['credential-password'] = "EMPTY_PASSWORD"
else:
row['credential-password'] = "EMPTY_PASSWORD"
row['credential-algorithm'] = cred['algo']
#
# Main Functions
#
def device_export_lib(session):
# hack to get all devices via 'All data' preset, should be removed later
presets = api.get_route(session, '/api/3.0/presets')
all_id = 0
for p in presets:
if p['label'] == 'All data':
all_id = p['id']
break
route = f"/api/3.0/presets/{all_id}/visualisations/networknode-list"
return api.get_route(session, route)
def device_export(center_ip, center_port, token, proxy, filename,csv_delimiter, csv_encoding):
with api.APISession(center_ip, center_port, token, proxy) as session:
devices = device_export_lib(session)
# Loop to build devices, credentials, vulns list
write_devices(filename,csv_encoding,csv_delimiter,devices,session)
# If needed store vulns in another file
write_vulns(filename,csv_encoding,csv_delimiter,session,devices)
# If needed store credentials in another file
write_credentials(filename,csv_encoding,csv_delimiter,session,devices)
def device_export_group(center_ip, center_port, token, proxy, filename,csv_delimiter, csv_encoding):
with api.APISession(center_ip, center_port, token, proxy) as session:
devices = device_export_lib(session)
# Loop to build devices, credentials, vulns list
write_devices_group(filename,csv_encoding,csv_delimiter,devices,session)
def device_update(center_ip, center_port, token, proxy, filename,csv_delimiter, csv_encoding):
with open(filename, 'r') as csvfile:
with api.APISession(center_ip, center_port, token, proxy) as session:
reader = csv.DictReader(csvfile, delimiter=csv_delimiter)
device_update_lib(session, reader)
def device_update_lib(session, reader):
# get all groups to match their name and find their ids
route = "/api/3.0/groups"
groups = api.get_route(session, route)
group_dict = defaultdict()
groups_update_comp = {}
groups_update_device = {}
for g in groups:
group_dict[g['label']] = g
groups_update_comp[g['label']] = []
groups_update_device[g['label']] = []
for row in reader:
# devices or component
path = "devices"
if row['device-isdevice'].upper() == 'FALSE':
path = "components"
if 'group-name' in row and row['group-name']:
if not row['group-name'] in group_dict:
print(f"ERR: Device '{row['device-name']}' - Group '{row['group-name']}' does not exist ")
else:
if path == "components":
groups_update_comp[row['group-name']].append(row['device-id'])
elif path == "devices":
groups_update_device[row['group-name']].append(row['device-id'])
if 'device-custom-name' in row and row['device-custom-name']:
custom_name = row['device-custom-name']
print(f"LOG: Device '{row['device-name']}' - setting custom name '{row['device-custom-name']}'")
route = f"/api/3.0/{path}/{row['device-id']}/label"
json = {
"name": row['device-custom-name'],
}
ret = api.post_route(session, route, json)
if ret.status_code != 200:
print(f"ERROR: Calling [POST] {route} got error code {ret.status_code}")
for g, ids in groups_update_comp.items():
if len(ids) > 0:
print(f"LOG: Update Group '{g}' - with {len(ids)} components")
group = group_dict[g]
route = f"/api/3.0/groups/{group['id']}"
json = {
"op": "add",
"path": f"/components",
"value": ids,
}
ret = api.patch_route(session, route, json)
if ret.status_code != 200:
print(f"ERROR: Calling [PATCH] {route} got error code {ret.status_code}")
for g, ids in groups_update_device.items():
if len(ids) > 0:
print(f"LOG: Update Group '{g}' - with {len(ids)} devices")
group = group_dict[g]
route = f"/api/3.0/groups/{group['id']}"
json = {
"op": "add",
"path": f"/devices",
"value": ids,
}
ret = api.patch_route(session, route, json)
if ret.status_code != 200:
print(f"ERROR: Calling [PATCH] {route} got error code {ret.status_code}")
if __name__ == "__main__":
main()