311
334
return milliseconds_to_string(value)
312
335
return str(value)
315
# Create format string to format table rows
316
format_string = " ".join("{{{key}:{width}}}".format(
317
width=max(len(self.tablewords[key]),
318
max(len(self.valuetostring(client[key], key))
319
for client in self.clients)),
321
for key in self.keywords)
322
# Start with header line
323
rows = [format_string.format(**self.tablewords)]
324
for client in self.clients:
325
rows.append(format_string
326
.format(**{key: self.valuetostring(client[key], key)
327
for key in self.keywords}))
337
def header_line(self, format_string):
338
return format_string.format(**self.tablewords)
340
def client_line(self, client, format_string):
341
return format_string.format(
342
**{key: self.string_from_client(client, key)
343
for key in self.keywords})
346
## Classes for commands.
348
# Abstract classes first
349
class Command(object):
350
"""Abstract class for commands"""
351
def run(self, clients):
352
"""Normal commands should implement run_on_one_client(), but
353
commands which want to operate on all clients at the same time
354
can override this run() method instead."""
355
for client in clients:
356
self.run_on_one_client(client)
358
class PrintCmd(Command):
359
"""Abstract class for commands printing client details"""
360
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
361
"Created", "Interval", "Host", "KeyID",
362
"Fingerprint", "CheckerRunning", "LastEnabled",
363
"ApprovalPending", "ApprovedByDefault",
364
"LastApprovalRequest", "ApprovalDelay",
365
"ApprovalDuration", "Checker", "ExtendedTimeout",
366
"Expires", "LastCheckerStatus")
367
def run(self, clients):
368
print(self.output(clients))
370
class PropertyCmd(Command):
371
"""Abstract class for Actions for setting one client property"""
372
def run_on_one_client(self, client):
373
"""Set the Client's D-Bus property"""
374
client.Set(client_interface, self.property, self.value_to_set,
375
dbus_interface=dbus.PROPERTIES_IFACE)
377
class ValueArgumentMixIn(object):
378
"""Mixin class for commands taking a value as argument"""
379
def __init__(self, value):
380
self.value_to_set = value
382
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
383
"""Mixin class for commands taking a value argument as
386
def value_to_set(self):
389
def value_to_set(self, value):
390
"""When setting, convert value to a datetime.timedelta"""
391
self._vts = string_to_delta(value).total_seconds() * 1000
393
# Actual (non-abstract) command classes
395
class PrintTableCmd(PrintCmd):
396
def __init__(self, verbose=False):
397
self.verbose = verbose
398
def output(self, clients):
400
keywords = self.all_keywords
402
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
403
return str(TableOfClients(clients.values(), keywords))
405
class DumpJSONCmd(PrintCmd):
406
def output(self, clients):
407
data = {client["Name"]:
408
{key: self.dbus_boolean_to_bool(client[key])
409
for key in self.all_keywords}
410
for client in clients.values()}
411
return json.dumps(data, indent=4, separators=(',', ': '))
413
def dbus_boolean_to_bool(value):
414
if isinstance(value, dbus.Boolean):
418
class IsEnabledCmd(Command):
419
def run_on_one_client(self, client):
420
if self.is_enabled(client):
423
def is_enabled(self, client):
424
return client.Get(client_interface, "Enabled",
425
dbus_interface=dbus.PROPERTIES_IFACE)
427
class RemoveCmd(Command):
428
def __init__(self, mandos):
430
def run_on_one_client(self, client):
431
self.mandos.RemoveClient(client.__dbus_object_path__)
433
class ApproveCmd(Command):
434
def run_on_one_client(self, client):
435
client.Approve(dbus.Boolean(True),
436
dbus_interface=client_interface)
438
class DenyCmd(Command):
439
def run_on_one_client(self, client):
440
client.Approve(dbus.Boolean(False),
441
dbus_interface=client_interface)
443
class EnableCmd(PropertyCmd):
445
value_to_set = dbus.Boolean(True)
447
class DisableCmd(PropertyCmd):
449
value_to_set = dbus.Boolean(False)
451
class BumpTimeoutCmd(PropertyCmd):
452
property = "LastCheckedOK"
455
class StartCheckerCmd(PropertyCmd):
456
property = "CheckerRunning"
457
value_to_set = dbus.Boolean(True)
459
class StopCheckerCmd(PropertyCmd):
460
property = "CheckerRunning"
461
value_to_set = dbus.Boolean(False)
463
class ApproveByDefaultCmd(PropertyCmd):
464
property = "ApprovedByDefault"
465
value_to_set = dbus.Boolean(True)
467
class DenyByDefaultCmd(PropertyCmd):
468
property = "ApprovedByDefault"
469
value_to_set = dbus.Boolean(False)
471
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
474
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
477
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
480
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
483
class SetExtendedTimeoutCmd(PropertyCmd,
484
MillisecondsValueArgumentMixIn):
485
property = "ExtendedTimeout"
487
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
488
property = "Interval"
490
class SetApprovalDelayCmd(PropertyCmd,
491
MillisecondsValueArgumentMixIn):
492
property = "ApprovalDelay"
494
class SetApprovalDurationCmd(PropertyCmd,
495
MillisecondsValueArgumentMixIn):
496
property = "ApprovalDuration"
331
498
def has_actions(options):
332
499
return any((options.enable,
360
527
help="Print all fields")
361
528
parser.add_argument("-j", "--dump-json", action="store_true",
362
529
help="Dump client data in JSON format")
363
parser.add_argument("-e", "--enable", action="store_true",
364
help="Enable client")
365
parser.add_argument("-d", "--disable", action="store_true",
366
help="disable client")
530
enable_disable = parser.add_mutually_exclusive_group()
531
enable_disable.add_argument("-e", "--enable", action="store_true",
532
help="Enable client")
533
enable_disable.add_argument("-d", "--disable",
535
help="disable client")
367
536
parser.add_argument("-b", "--bump-timeout", action="store_true",
368
537
help="Bump timeout for client")
369
parser.add_argument("--start-checker", action="store_true",
370
help="Start checker for client")
371
parser.add_argument("--stop-checker", action="store_true",
372
help="Stop checker for client")
538
start_stop_checker = parser.add_mutually_exclusive_group()
539
start_stop_checker.add_argument("--start-checker",
541
help="Start checker for client")
542
start_stop_checker.add_argument("--stop-checker",
544
help="Stop checker for client")
373
545
parser.add_argument("-V", "--is-enabled", action="store_true",
374
546
help="Check if client is enabled")
375
547
parser.add_argument("-r", "--remove", action="store_true",
382
554
help="Set extended timeout for client")
383
555
parser.add_argument("-i", "--interval",
384
556
help="Set checker interval for client")
385
parser.add_argument("--approve-by-default", action="store_true",
386
default=None, dest="approved_by_default",
387
help="Set client to be approved by default")
388
parser.add_argument("--deny-by-default", action="store_false",
389
dest="approved_by_default",
390
help="Set client to be denied by default")
557
approve_deny_default = parser.add_mutually_exclusive_group()
558
approve_deny_default.add_argument(
559
"--approve-by-default", action="store_true",
560
default=None, dest="approved_by_default",
561
help="Set client to be approved by default")
562
approve_deny_default.add_argument(
563
"--deny-by-default", action="store_false",
564
dest="approved_by_default",
565
help="Set client to be denied by default")
391
566
parser.add_argument("--approval-delay",
392
567
help="Set delay before client approve/deny")
393
568
parser.add_argument("--approval-duration",
427
606
mandos_serv_object_manager = dbus.Interface(
428
607
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
611
if options.dump_json:
612
commands.append(DumpJSONCmd())
615
commands.append(EnableCmd())
618
commands.append(DisableCmd())
620
if options.bump_timeout:
621
commands.append(BumpTimeoutCmd(options.bump_timeout))
623
if options.start_checker:
624
commands.append(StartCheckerCmd())
626
if options.stop_checker:
627
commands.append(StopCheckerCmd())
629
if options.is_enabled:
630
commands.append(IsEnabledCmd())
633
commands.append(RemoveCmd(mandos_serv))
635
if options.checker is not None:
636
commands.append(SetCheckerCmd())
638
if options.timeout is not None:
639
commands.append(SetTimeoutCmd(options.timeout))
641
if options.extended_timeout:
643
SetExtendedTimeoutCmd(options.extended_timeout))
645
if options.interval is not None:
646
command.append(SetIntervalCmd(options.interval))
648
if options.approved_by_default is not None:
649
if options.approved_by_default:
650
command.append(ApproveByDefaultCmd())
652
command.append(DenyByDefaultCmd())
654
if options.approval_delay is not None:
655
command.append(SetApprovalDelayCmd(options.approval_delay))
657
if options.approval_duration is not None:
659
SetApprovalDurationCmd(options.approval_duration))
661
if options.host is not None:
662
command.append(SetHostCmd(options.host))
664
if options.secret is not None:
665
command.append(SetSecretCmd(options.secret))
668
commands.append(ApproveCmd())
671
commands.append(DenyCmd())
673
# If no command option has been given, show table of clients,
674
# optionally verbosely
676
commands.append(PrintTableCmd(verbose=options.verbose))
430
678
# block stderr since dbus library prints to stderr
431
679
null = os.open(os.path.devnull, os.O_RDWR)
432
680
stderrcopy = os.dup(sys.stderr.fileno())
465
713
log.critical("Client not found on server: %r", name)
468
if not has_actions(options) and clients:
469
if options.verbose or options.dump_json:
470
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
471
"Created", "Interval", "Host", "KeyID",
472
"Fingerprint", "CheckerRunning",
473
"LastEnabled", "ApprovalPending",
474
"ApprovedByDefault", "LastApprovalRequest",
475
"ApprovalDelay", "ApprovalDuration",
476
"Checker", "ExtendedTimeout", "Expires",
479
keywords = defaultkeywords
481
if options.dump_json:
482
json.dump({client["Name"]: {key:
484
if isinstance(client[key],
488
for client in clients.values()},
489
fp=sys.stdout, indent=4,
490
separators=(',', ': '))
493
print_clients(clients.values(), keywords)
495
# Process each client in the list by all selected options
496
for client in clients:
498
def set_client_prop(prop, value):
499
"""Set a Client D-Bus property"""
500
client.Set(client_interface, prop, value,
501
dbus_interface=dbus.PROPERTIES_IFACE)
503
def set_client_prop_ms(prop, value):
504
"""Set a Client D-Bus property, converted
505
from a string to milliseconds."""
506
set_client_prop(prop,
507
string_to_delta(value).total_seconds()
511
mandos_serv.RemoveClient(client.__dbus_object_path__)
513
set_client_prop("Enabled", dbus.Boolean(True))
515
set_client_prop("Enabled", dbus.Boolean(False))
516
if options.bump_timeout:
517
set_client_prop("LastCheckedOK", "")
518
if options.start_checker:
519
set_client_prop("CheckerRunning", dbus.Boolean(True))
520
if options.stop_checker:
521
set_client_prop("CheckerRunning", dbus.Boolean(False))
522
if options.is_enabled:
523
if client.Get(client_interface, "Enabled",
524
dbus_interface=dbus.PROPERTIES_IFACE):
528
if options.checker is not None:
529
set_client_prop("Checker", options.checker)
530
if options.host is not None:
531
set_client_prop("Host", options.host)
532
if options.interval is not None:
533
set_client_prop_ms("Interval", options.interval)
534
if options.approval_delay is not None:
535
set_client_prop_ms("ApprovalDelay",
536
options.approval_delay)
537
if options.approval_duration is not None:
538
set_client_prop_ms("ApprovalDuration",
539
options.approval_duration)
540
if options.timeout is not None:
541
set_client_prop_ms("Timeout", options.timeout)
542
if options.extended_timeout is not None:
543
set_client_prop_ms("ExtendedTimeout",
544
options.extended_timeout)
545
if options.secret is not None:
546
set_client_prop("Secret",
547
dbus.ByteArray(options.secret.read()))
548
if options.approved_by_default is not None:
549
set_client_prop("ApprovedByDefault",
551
.approved_by_default))
553
client.Approve(dbus.Boolean(True),
554
dbus_interface=client_interface)
556
client.Approve(dbus.Boolean(False),
557
dbus_interface=client_interface)
716
# Run all commands on clients
717
for command in commands:
560
721
class Test_milliseconds_to_string(unittest.TestCase):
633
794
def test_short_header(self):
634
rows = TableOfClients(self.clients, self.keywords,
635
self.tablewords).rows()
640
self.assertEqual(rows, expected_rows)
795
text = str(TableOfClients(self.clients, self.keywords,
802
self.assertEqual(text, expected_text)
641
803
def test_booleans(self):
642
804
keywords = ["Bool", "NonDbusBoolean"]
643
rows = TableOfClients(self.clients, keywords,
644
self.tablewords).rows()
646
"A D-BUS Boolean A Non-D-BUS Boolean",
650
self.assertEqual(rows, expected_rows)
805
text = str(TableOfClients(self.clients, keywords,
808
A D-BUS Boolean A Non-D-BUS Boolean
812
self.assertEqual(text, expected_text)
651
813
def test_milliseconds_detection(self):
652
814
keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
653
815
"ApprovalDuration", "ExtendedTimeout"]
654
rows = TableOfClients(self.clients, keywords,
655
self.tablewords).rows()
816
text = str(TableOfClients(self.clients, keywords,
657
819
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
658
820
0 00:00:00 00:00:01 00:00:02 00:00:03 00:00:04
659
821
1 1T02:03:05 1T02:03:06 1T02:03:07 1T02:03:08 1T02:03:09
662
self.assertEqual(rows, expected_rows)
823
self.assertEqual(text, expected_text)
663
824
def test_empty_and_long_string_values(self):
664
825
keywords = ["String"]
665
rows = TableOfClients(self.clients, keywords,
666
self.tablewords).rows()
826
text = str(TableOfClients(self.clients, keywords,
670
831
A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,
673
self.assertEqual(rows, expected_rows)
833
self.assertEqual(text, expected_text)