Repository navigation
Expand file tree
/
Copy pathgoad.py
More file actions
529 lines (460 loc) · 21.3 KB
/
Copy pathgoad.py
File metadata and controls
529 lines (460 loc) · 21.3 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
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
import cmd
import argparse
import sys
import time
from goad.config import Config
from goad.log import Log
from goad.exceptions import JumpBoxInitFailed
from goad.menu import print_menu, print_logo
from goad.infos import *
class Goad(cmd.Cmd):
def __init__(self, args):
super().__init__()
# get the arguments
self.args = args
# prepare config, read configuration file and merge with args
config = Config()
config.merge_config(args)
# prepare lab controller to manage labs
# import lab manager after the loading of the dependencies to allow disabling some provider and provisioning method
from goad.lab_manager import LabManager
self.lab_manager = LabManager().init(config, args)
if args.task == '' or args.task is None:
Log.info('Start Loading default instance')
# load instance marked as default only if no args are provided
self.lab_manager.load_default_instance()
self.welcome()
# set current lab and provider
self.refresh_prompt()
def welcome(self):
Log.info('lab instances :')
# show instances tables
self.lab_manager.lab_instances.show_instances(current_instance_id=self.lab_manager.get_current_instance_id())
# show current configuration
# self.lab_manager.show_settings()
def refresh_prompt(self):
if self.lab_manager.get_current_instance_id() == '':
self.prompt = f"\n{self.lab_manager.inline_settings()} > "
else:
self.prompt = f"\n{self.lab_manager.inline_settings()} ({self.lab_manager.get_current_instance_id()}) > "
def default(self, line):
print()
def do_help(self, arg):
print_menu(self.lab_manager)
def do_exit(self, arg):
print('bye')
return True
# main commands
def do_check(self, arg=''):
self.lab_manager.check()
def do_status(self, arg=''):
if self.lab_manager.get_current_instance():
self.lab_manager.get_current_instance().provider.status()
def do_install(self, arg=''):
self.do_create()
def do_start(self, arg=''):
if self.lab_manager.get_current_instance_provider():
self.lab_manager.get_current_instance_provider().start()
def do_start_vm(self, arg):
if arg == '':
Log.error('missing virtual machine name')
Log.info('start_vm <vm>')
else:
self.lab_manager.get_current_instance_provider().start_vm(arg)
def do_stop(self, arg=''):
if self.lab_manager.get_current_instance_provider():
self.lab_manager.get_current_instance_provider().stop()
def do_stop_vm(self, arg):
if arg == '':
Log.error('missing virtual machine name')
Log.info('stop_vm <vm>')
else:
self.lab_manager.get_current_instance_provider().stop_vm(arg)
def do_destroy(self, arg=''):
if self.lab_manager.get_current_instance_provider():
self.lab_manager.get_current_instance_provider().destroy()
def do_destroy_vm(self, arg):
if arg == '':
Log.error('missing virtual machine name')
Log.info('destroy_vm <vm>')
else:
self.lab_manager.get_current_instance_provider().destroy_vm(arg)
def do_snapshot(self, arg=''):
self.do_stop()
if self.lab_manager.get_current_instance_provider():
self.lab_manager.get_current_instance_provider().snapshot()
self.do_start()
def do_reset(self, arg=''):
self.do_stop()
if self.lab_manager.get_current_instance_provider():
self.lab_manager.get_current_instance_provider().reset()
self.do_start()
def do_provide(self, arg=''):
result = self.lab_manager.get_current_instance_provider().install()
if result:
self.lab_manager.get_current_instance().set_status(PROVIDED)
# if ip range change after provisioning
if self.lab_manager.get_current_instance_provider().update_ip_range:
Log.info('Update IP range')
new_range = self.lab_manager.get_current_instance_provider().get_ip_range()
if new_range is not None:
Log.info(f'new range : {new_range}')
self.lab_manager.get_current_instance().update_ip_range(new_range)
Log.info(f'reload instance')
# reload instance
instance_id = self.lab_manager.get_current_instance_id()
self.do_load(instance_id)
self.refresh_prompt()
def do_provision(self, arg):
if arg == '':
Log.error('missing playbook argument')
Log.info('provision <playbook>')
else:
start = time.time()
# run playbook
self.lab_manager.get_current_instance_provisioner().run(arg)
time_provision = time.ctime(time.time() - start)[11:19]
Log.info(f'Provisioned with {arg} in {time_provision}')
def do_provision_lab(self, arg=''):
start = time.time()
provision_result = self.lab_manager.get_current_instance_provisioner().run()
if provision_result:
self.lab_manager.get_current_instance().set_status(READY)
time_provision = time.ctime(time.time() - start)[11:19]
Log.info(f'Lab successfully provisioned in {time_provision}')
return provision_result
def do_provision_lab_from(self, arg):
start = time.time()
provision_result = self.lab_manager.get_current_instance_provisioner().run_from(arg)
if provision_result:
self.lab_manager.get_current_instance().set_status(READY)
time_provision = time.ctime(time.time() - start)[11:19]
Log.info(f'Provisioned from {arg} in {time_provision}')
def do_sync_source_jumpbox(self, arg=''):
if self.lab_manager.get_current_instance_provisioner().use_jumpbox:
self.lab_manager.get_current_instance_provisioner().sync_source_jumpbox()
def do_prepare_jumpbox(self, arg=''):
if self.lab_manager.get_current_instance_provisioner().use_jumpbox:
jumpbox_ip = self.lab_manager.get_current_instance_provider().get_jumpbox_ip(self.lab_manager.get_ip_range())
if jumpbox_ip is not None:
self.lab_manager.get_current_instance_provisioner().prepare_jumpbox(jumpbox_ip)
else:
Log.error('cannot find jumpbox ip')
def do_config(self, arg):
self.lab_manager.show_settings()
def do_ssh_jumpbox(self, arg):
if self.lab_manager.get_current_instance_provisioner().use_jumpbox:
try:
jump_box = self.lab_manager.get_current_instance_provisioner().jumpbox
jump_box.ssh()
except JumpBoxInitFailed as e:
Log.error('Jumpbox retrieve connection info failed, abort')
else:
Log.error('No jump box for this provider')
def do_ssh_jumpbox_proxy(self, arg):
if self.lab_manager.get_current_instance_provisioner().use_jumpbox:
try:
jump_box = self.lab_manager.get_current_instance_provisioner().jumpbox
if arg.isnumeric() and 1024 < int(arg) <= 65535:
jump_box.ssh_proxy(arg)
else:
Log.error(f'Port value invalid : {arg}')
except JumpBoxInitFailed as e:
Log.error('Jumpbox retrieve connection info failed, abort')
else:
Log.error('No jump box for this provider')
# configuration
def do_set_lab(self, arg):
"""
Change/Set the lab to use
:param arg: lab name
:return: void
"""
if arg == '':
Log.error('missing lab argument')
Log.info('set_lab <lab>')
else:
try:
self.lab_manager.set_lab(arg)
self.refresh_prompt()
except ValueError as err:
Log.error(err.args[0])
Log.info('Available labs :')
for lab in self.lab_manager.labs:
Log.info(f' - {lab}')
def complete_set_lab(self, text, line, begidx, endidx):
options = self.lab_manager.get_labs_options()
if not text:
completions = options
else:
completions = [option for option in options if option.startswith(text)]
return completions
def do_set_provider(self, arg):
"""
Change/Set the provider to use
:param arg: provider name
:return: void
"""
if arg == '':
Log.error('missing provider argument')
Log.info(f'set_provider <provider> (allowed values : {",".join(ALLOWED_PROVIDERS)})')
else:
try:
self.lab_manager.set_provider(arg)
self.refresh_prompt()
except ValueError as err:
Log.error(err.args[0])
def complete_set_provider(self, text, line, begidx, endidx):
options = self.lab_manager.get_provider_options()
if not text:
completions = options
else:
completions = [option for option in options if option.startswith(text)]
return completions
def do_set_provisioning_method(self, arg):
if arg == '':
Log.error('missing provisioner argument')
Log.info(f'set_provisioner <provisioner> (allowed values : {",".join(ALLOWED_PROVISIONER)})')
else:
try:
self.lab_manager.set_provisioner(arg)
self.refresh_prompt()
except ValueError as err:
Log.error(err.args[0])
def complete_set_provisioning_method(self, text, line, begidx, endidx):
options = self.lab_manager.provisioning_method_options()
if not text:
completions = options
else:
completions = [option for option in options if option.startswith(text)]
return completions
def do_set_ip_range(self, arg):
if arg == '':
Log.error('missing ip_start argument')
Log.info(f'set_ip_start <ip_start>')
else:
self.lab_manager.set_ip_range(arg)
self.refresh_prompt()
def do_set_extensions(self, arg):
if arg == '':
Log.error('missing extensions arguments')
Log.info(f'set_extensions <extension1> <extension2> ...')
else:
extensions_name = arg.split(' ')
self.lab_manager.set_extensions(extensions_name)
self.refresh_prompt()
def do_list_extensions(self, arg):
if self.lab_manager.get_current_instance_lab() is not None:
self.lab_manager.get_current_instance_lab().show_extensions()
else:
self.lab_manager.get_lab(self.lab_manager.get_current_lab_name()).show_extensions()
def do_install_extension(self, arg):
if arg == '':
Log.error('missing extension argument')
Log.info(f'provision_extension <extension>')
else:
Log.info('start install extension')
if self.lab_manager.current_instance is not None:
extension_name = arg
extension = self.lab_manager.get_current_instance_lab().get_extension(extension_name)
if extension is not None:
# enable and create files
self.lab_manager.get_current_instance().enable_extension(extension_name)
# # start lab with extensions files (vagrant up / terraform plan)
self.lab_manager.get_current_instance_provider().install()
# # provision extension
self.do_provision_extension(extension_name)
else:
Log.error(f'extension {extension_name} not found abort')
else:
Log.error('Install extension can only be run from an instance')
def do_provision_extension(self, arg):
if arg == '':
Log.error('missing extension argument')
Log.info(f'provision_extension <extension>')
else:
extension_name = arg
start = time.time()
current_instance_extensions_name = self.lab_manager.get_current_instance().extensions
if extension_name in current_instance_extensions_name:
self.do_sync_source_jumpbox()
extension = self.lab_manager.get_current_instance_lab().get_extension(extension_name)
provision_result = self.lab_manager.get_current_instance_provisioner().run_extension(extension, current_instance_extensions_name)
if provision_result:
time_provision = time.ctime(time.time() - start)[11:19]
Log.info(f'Provision extension done in {time_provision}')
else:
Log.error(f'extension {extension_name} not enabled in instance abort')
def do_labs(self, arg):
show_labs_providers_table(self.lab_manager.get_labs())
def do_show_list_providers(self, arg):
show_labs_providers_list(self.lab_manager.get_labs())
def do_update_instance_files(self, arg):
self.lab_manager.update_instance_files()
def do_create(self, arg=''):
if self.lab_manager.get_current_instance() is not None:
self.do_install_instance()
else:
Log.success('Current Settings')
self.lab_manager.current_settings.show()
print()
if Utils.confirm('Create lab with theses settings ? (y/N)'):
Log.info('Create instance folder')
self.lab_manager.create_instance()
Log.info('Launch providing')
self.do_provide()
if self.lab_manager.get_current_instance().get_status() == PROVIDED:
Log.info('Prepare jumpbox if needed')
self.do_prepare_jumpbox()
Log.info('Launch provisioning')
provision_result = self.do_provision_lab()
if provision_result:
for extension_name in self.lab_manager.current_settings.extensions_name:
Log.info(f'Start installation of extension : {extension_name}')
self.do_install_extension(extension_name)
self.refresh_prompt()
else:
Log.error('Providing error stop')
def do_install_instance(self, arg=''):
Log.info('Launch providing')
self.do_provide()
if self.lab_manager.get_current_instance().get_status() == PROVIDED:
Log.info('Prepare jumpbox if needed')
self.do_prepare_jumpbox()
Log.info('Launch provisioning')
provision_result = self.do_provision_lab()
if provision_result:
for extension_name in self.lab_manager.current_settings.extensions_name:
Log.info(f'Start installation of extension : {extension_name}')
self.do_install_extension(extension_name)
self.refresh_prompt()
else:
Log.error('Providing error stop')
def do_create_empty(self, arg=''):
Log.info('Create instance folder')
self.lab_manager.create_instance()
def do_set_as_default(self, arg):
self.lab_manager.set_as_default_instance()
# load alias
def do_use(self, arg):
self.do_load(arg)
def complete_use(self, text, line, begidx, endidx):
return self.complete_load(text, line, begidx, endidx)
# load alias
def do_cd(self, arg):
if arg == '..':
self.do_unload()
else:
self.do_load(arg)
def complete_cd(self, text, line, begidx, endidx):
return self.complete_load(text, line, begidx, endidx)
def do_load(self, arg):
if arg == '':
Log.error('missing instance id argument')
Log.info(f'use_instance <instance_id>')
else:
self.lab_manager.load_instance(arg)
if self.lab_manager.current_instance is not None:
self.lab_manager.lab_instances.show_instances(current_instance_id=self.lab_manager.get_current_instance_id(), filter_instance_id=self.lab_manager.get_current_instance_id())
self.refresh_prompt()
def complete_load(self, text, line, begidx, endidx):
options = self.lab_manager.get_instance_options()
if not text:
completions = options
else:
completions = [option for option in options if option.startswith(text)]
return completions
def do_unload(self, arg=''):
if self.lab_manager.get_current_instance_id() is not None:
self.lab_manager.unload_instance()
self.refresh_prompt()
def do_delete(self, arg):
if self.lab_manager.get_current_instance_id() is not None:
deleted = self.lab_manager.delete_instance()
if deleted:
self.refresh_prompt()
def do_disable_vagrant(self, arg):
start = time.time()
provision_result = self.lab_manager.get_current_instance_provisioner().run_disable_vagrant(disable_vagrant=True)
if provision_result:
time_provision = time.ctime(time.time() - start)[11:19]
Log.info(f'Disable vagrant done in {time_provision}')
Log.info(f'Please restart the lab to avoid administrator NT hash in lsass')
def do_enable_vagrant(self, arg):
start = time.time()
provision_result = self.lab_manager.get_current_instance_provisioner().run_disable_vagrant(disable_vagrant=False)
if provision_result:
time_provision = time.ctime(time.time() - start)[11:19]
Log.info(f'Enable vagrant done in {time_provision}')
# alias to list
def do_ls(self, arg=''):
self.do_list(arg)
def do_list(self, arg=''):
self.lab_manager.lab_instances.show_instances(current_instance_id=self.lab_manager.get_current_instance_id())
def parse_args():
task_help = 'tasks available : (install/start/stop/restart/destroy/status/show)'
parser = argparse.ArgumentParser(prog='goad.py',
description='Description : goad lab management console.',
epilog=show_help(), formatter_class=argparse.RawDescriptionHelpFormatter)
parser.add_argument("-t", "--task", help=f"{task_help}", required=False)
parser.add_argument("-l", "--lab", help="lab to use (default: GOAD)", default='GOAD', required=False)
parser.add_argument("-p", "--provider", help="provider to use (default: vmware)", default='vmware', required=False)
parser.add_argument("-ip", "--ip_range", help="ip range to use (default: 192.168.56)", default='', required=False)
parser.add_argument("-m", "--method", help="deploy method to use (default: local)", default='local', required=False)
parser.add_argument("-i", "--instance", help="use a specific instance (use default if not selected)", required=False)
parser.add_argument("-e", "--extensions", help="extensions to use", action='append', required=False)
parser.add_argument("-a", "--ansible_only", help="run only provisioning (ansible) on instance (-i) (for task install only)", required=False)
parser.add_argument("-r", "--run_playbook", help="run only one ansible playbook on instance (-i) (for task install only)", required=False)
parser.add_argument("-d", "--disable_dependencies", help="disable_dependencies", action='append', required=False)
a
6837
rgs = parser.parse_args()
return args
def show_help():
return '''
Example :
- Install GOAD on virtualbox : python3 goad.py -t install -l GOAD -p virtualbox
- Launch GOAD interactive console : python3 goad.py
'''
if __name__ == '__main__':
print_logo()
args = parse_args()
goad = Goad(args)
if args is None or args.task is None:
goad.cmdloop()
else:
if args.instance is not None:
goad.do_load(args.instance)
if args.run_playbook is not None or args.ansible_only is not None:
if args.instance is None:
Log.error('Instance must be selected (-i) to use --run_playbook (-r) or --ansible_only (-a)')
sys.exit(1)
# Command line args like the old goad.sh commands
if args.task is not None:
if args.task == 'install':
if args.instance is not None:
if args.run_playbook is not None:
goad.do_provision(args.run_playbook)
elif args.ansible_only:
goad.do_provision_lab()
else:
goad.do_install_instance()
else:
goad.do_install()
elif args.task == 'check':
goad.do_check()
elif args.task == 'start':
goad.do_start()
elif args.task == 'stop':
goad.do_stop()
elif args.task == 'restart':
goad.do_stop()
goad.do_start()
elif args.task == 'destroy':
goad.do_destroy()
elif args.task == 'status':
goad.do_status()
elif args.task == 'snapshot':
goad.do_snapshot()
elif args.task == 'reset':
goad.do_reset()
elif args.task == 'show':
pass