344
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, mandos, 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."""
356
for client in clients:
357
self.run_on_one_client(client)
359
class PrintCmd(Command):
360
"""Abstract class for commands printing client details"""
361
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
362
"Created", "Interval", "Host", "KeyID",
363
"Fingerprint", "CheckerRunning", "LastEnabled",
364
"ApprovalPending", "ApprovedByDefault",
365
"LastApprovalRequest", "ApprovalDelay",
366
"ApprovalDuration", "Checker", "ExtendedTimeout",
367
"Expires", "LastCheckerStatus")
368
def run(self, mandos, clients):
369
print(self.output(clients))
371
class PropertyCmd(Command):
372
"""Abstract class for Actions for setting one client property"""
373
def run_on_one_client(self, client):
374
"""Set the Client's D-Bus property"""
375
client.Set(client_interface, self.property, self.value_to_set,
376
dbus_interface=dbus.PROPERTIES_IFACE)
378
class ValueArgumentMixIn(object):
379
"""Mixin class for commands taking a value as argument"""
380
def __init__(self, value):
381
self.value_to_set = value
383
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
384
"""Mixin class for commands taking a value argument as
387
def value_to_set(self):
390
def value_to_set(self, value):
391
"""When setting, convert value to a datetime.timedelta"""
392
self._vts = string_to_delta(value).total_seconds() * 1000
394
# Actual (non-abstract) command classes
396
class PrintTableCmd(PrintCmd):
397
def __init__(self, verbose=False):
398
self.verbose = verbose
399
def output(self, clients):
401
keywords = self.all_keywords
403
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
404
return str(TableOfClients(clients.values(), keywords))
406
class DumpJSONCmd(PrintCmd):
407
def output(self, clients):
408
data = {client["Name"]:
409
{key: self.dbus_boolean_to_bool(client[key])
410
for key in self.all_keywords}
411
for client in clients.values()}
412
return json.dumps(data, indent=4, separators=(',', ': '))
414
def dbus_boolean_to_bool(value):
415
if isinstance(value, dbus.Boolean):
419
class IsEnabledCmd(Command):
420
def run_on_one_client(self, client):
421
if self.is_enabled(client):
424
def is_enabled(self, client):
425
return client.Get(client_interface, "Enabled",
426
dbus_interface=dbus.PROPERTIES_IFACE)
428
class RemoveCmd(Command):
429
def run_on_one_client(self, client):
430
self.mandos.RemoveClient(client.__dbus_object_path__)
432
class ApproveCmd(Command):
433
def run_on_one_client(self, client):
434
client.Approve(dbus.Boolean(True),
435
dbus_interface=client_interface)
437
class DenyCmd(Command):
438
def run_on_one_client(self, client):
439
client.Approve(dbus.Boolean(False),
440
dbus_interface=client_interface)
442
class EnableCmd(PropertyCmd):
444
value_to_set = dbus.Boolean(True)
446
class DisableCmd(PropertyCmd):
448
value_to_set = dbus.Boolean(False)
450
class BumpTimeoutCmd(PropertyCmd):
451
property = "LastCheckedOK"
454
class StartCheckerCmd(PropertyCmd):
455
property = "CheckerRunning"
456
value_to_set = dbus.Boolean(True)
458
class StopCheckerCmd(PropertyCmd):
459
property = "CheckerRunning"
460
value_to_set = dbus.Boolean(False)
462
class ApproveByDefaultCmd(PropertyCmd):
463
property = "ApprovedByDefault"
464
value_to_set = dbus.Boolean(True)
466
class DenyByDefaultCmd(PropertyCmd):
467
property = "ApprovedByDefault"
468
value_to_set = dbus.Boolean(False)
470
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
473
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
476
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
479
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
482
class SetExtendedTimeoutCmd(PropertyCmd,
483
MillisecondsValueArgumentMixIn):
484
property = "ExtendedTimeout"
486
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
487
property = "Interval"
489
class SetApprovalDelayCmd(PropertyCmd,
490
MillisecondsValueArgumentMixIn):
491
property = "ApprovalDelay"
493
class SetApprovalDurationCmd(PropertyCmd,
494
MillisecondsValueArgumentMixIn):
495
property = "ApprovalDuration"
347
497
def has_actions(options):
348
498
return any((options.enable,
376
528
help="Print all fields")
377
529
parser.add_argument("-j", "--dump-json", action="store_true",
378
530
help="Dump client data in JSON format")
379
parser.add_argument("-e", "--enable", action="store_true",
380
help="Enable client")
381
parser.add_argument("-d", "--disable", action="store_true",
382
help="disable client")
531
enable_disable = parser.add_mutually_exclusive_group()
532
enable_disable.add_argument("-e", "--enable", action="store_true",
533
help="Enable client")
534
enable_disable.add_argument("-d", "--disable",
536
help="disable client")
383
537
parser.add_argument("-b", "--bump-timeout", action="store_true",
384
538
help="Bump timeout for client")
385
parser.add_argument("--start-checker", action="store_true",
386
help="Start checker for client")
387
parser.add_argument("--stop-checker", action="store_true",
388
help="Stop checker for client")
539
start_stop_checker = parser.add_mutually_exclusive_group()
540
start_stop_checker.add_argument("--start-checker",
542
help="Start checker for client")
543
start_stop_checker.add_argument("--stop-checker",
545
help="Stop checker for client")
389
546
parser.add_argument("-V", "--is-enabled", action="store_true",
390
547
help="Check if client is enabled")
391
548
parser.add_argument("-r", "--remove", action="store_true",
398
555
help="Set extended timeout for client")
399
556
parser.add_argument("-i", "--interval",
400
557
help="Set checker interval for client")
401
parser.add_argument("--approve-by-default", action="store_true",
402
default=None, dest="approved_by_default",
403
help="Set client to be approved by default")
404
parser.add_argument("--deny-by-default", action="store_false",
405
dest="approved_by_default",
406
help="Set client to be denied by default")
558
approve_deny_default = parser.add_mutually_exclusive_group()
559
approve_deny_default.add_argument(
560
"--approve-by-default", action="store_true",
561
default=None, dest="approved_by_default",
562
help="Set client to be approved by default")
563
approve_deny_default.add_argument(
564
"--deny-by-default", action="store_false",
565
dest="approved_by_default",
566
help="Set client to be denied by default")
407
567
parser.add_argument("--approval-delay",
408
568
help="Set delay before client approve/deny")
409
569
parser.add_argument("--approval-duration",
412
572
parser.add_argument("-s", "--secret",
413
573
type=argparse.FileType(mode="rb"),
414
574
help="Set password blob (file) for client")
415
parser.add_argument("-A", "--approve", action="store_true",
416
help="Approve any current client request")
417
parser.add_argument("-D", "--deny", action="store_true",
418
help="Deny any current client request")
575
approve_deny = parser.add_mutually_exclusive_group()
576
approve_deny.add_argument(
577
"-A", "--approve", action="store_true",
578
help="Approve any current client request")
579
approve_deny.add_argument("-D", "--deny", action="store_true",
580
help="Deny any current client request")
419
581
parser.add_argument("--check", action="store_true",
420
582
help="Run self-test")
421
583
parser.add_argument("client", nargs="*", help="Client name")
422
options = parser.parse_args()
584
options = parser.parse_args(args=args)
424
586
if has_actions(options) and not (options.client or options.all):
425
587
parser.error("Options require clients names or --all.")
430
592
parser.error("--dump-json can only be used alone.")
431
593
if options.all and not has_actions(options):
432
594
parser.error("--all requires an action.")
595
if options.is_enabled and len(options.client) > 1:
596
parser.error("--is-enabled requires exactly one client")
600
if options.dump_json:
601
commands.append(DumpJSONCmd())
604
commands.append(EnableCmd())
607
commands.append(DisableCmd())
609
if options.bump_timeout:
610
commands.append(BumpTimeoutCmd(options.bump_timeout))
612
if options.start_checker:
613
commands.append(StartCheckerCmd())
615
if options.stop_checker:
616
commands.append(StopCheckerCmd())
618
if options.is_enabled:
619
commands.append(IsEnabledCmd())
622
commands.append(RemoveCmd())
624
if options.checker is not None:
625
commands.append(SetCheckerCmd())
627
if options.timeout is not None:
628
commands.append(SetTimeoutCmd(options.timeout))
630
if options.extended_timeout:
632
SetExtendedTimeoutCmd(options.extended_timeout))
634
if options.interval is not None:
635
command.append(SetIntervalCmd(options.interval))
637
if options.approved_by_default is not None:
638
if options.approved_by_default:
639
command.append(ApproveByDefaultCmd())
641
command.append(DenyByDefaultCmd())
643
if options.approval_delay is not None:
644
command.append(SetApprovalDelayCmd(options.approval_delay))
646
if options.approval_duration is not None:
648
SetApprovalDurationCmd(options.approval_duration))
650
if options.host is not None:
651
command.append(SetHostCmd(options.host))
653
if options.secret is not None:
654
command.append(SetSecretCmd(options.secret))
657
commands.append(ApproveCmd())
660
commands.append(DenyCmd())
662
# If no command option has been given, show table of clients,
663
# optionally verbosely
665
commands.append(PrintTableCmd(verbose=options.verbose))
667
return commands, options.client
671
commands, clientnames = commands_and_clients_from_options()
435
674
bus = dbus.SystemBus()
481
721
log.critical("Client not found on server: %r", name)
484
if not has_actions(options) and clients:
485
if options.verbose or options.dump_json:
486
keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
487
"Created", "Interval", "Host", "KeyID",
488
"Fingerprint", "CheckerRunning",
489
"LastEnabled", "ApprovalPending",
490
"ApprovedByDefault", "LastApprovalRequest",
491
"ApprovalDelay", "ApprovalDuration",
492
"Checker", "ExtendedTimeout", "Expires",
495
keywords = defaultkeywords
497
if options.dump_json:
498
json.dump({client["Name"]: {key:
500
if isinstance(client[key],
504
for client in clients.values()},
505
fp=sys.stdout, indent=4,
506
separators=(',', ': '))
509
print(TableOfClients(clients.values(), keywords))
511
# Process each client in the list by all selected options
512
for client in clients:
514
def set_client_prop(prop, value):
515
"""Set a Client D-Bus property"""
516
client.Set(client_interface, prop, value,
517
dbus_interface=dbus.PROPERTIES_IFACE)
519
def set_client_prop_ms(prop, value):
520
"""Set a Client D-Bus property, converted
521
from a string to milliseconds."""
522
set_client_prop(prop,
523
string_to_delta(value).total_seconds()
527
mandos_serv.RemoveClient(client.__dbus_object_path__)
529
set_client_prop("Enabled", dbus.Boolean(True))
531
set_client_prop("Enabled", dbus.Boolean(False))
532
if options.bump_timeout:
533
set_client_prop("LastCheckedOK", "")
534
if options.start_checker:
535
set_client_prop("CheckerRunning", dbus.Boolean(True))
536
if options.stop_checker:
537
set_client_prop("CheckerRunning", dbus.Boolean(False))
538
if options.is_enabled:
539
if client.Get(client_interface, "Enabled",
540
dbus_interface=dbus.PROPERTIES_IFACE):
544
if options.checker is not None:
545
set_client_prop("Checker", options.checker)
546
if options.host is not None:
547
set_client_prop("Host", options.host)
548
if options.interval is not None:
549
set_client_prop_ms("Interval", options.interval)
550
if options.approval_delay is not None:
551
set_client_prop_ms("ApprovalDelay",
552
options.approval_delay)
553
if options.approval_duration is not None:
554
set_client_prop_ms("ApprovalDuration",
555
options.approval_duration)
556
if options.timeout is not None:
557
set_client_prop_ms("Timeout", options.timeout)
558
if options.extended_timeout is not None:
559
set_client_prop_ms("ExtendedTimeout",
560
options.extended_timeout)
561
if options.secret is not None:
562
set_client_prop("Secret",
563
dbus.ByteArray(options.secret.read()))
564
if options.approved_by_default is not None:
565
set_client_prop("ApprovedByDefault",
567
.approved_by_default))
569
client.Approve(dbus.Boolean(True),
570
dbus_interface=client_interface)
572
client.Approve(dbus.Boolean(False),
573
dbus_interface=client_interface)
724
# Run all commands on clients
725
for command in commands:
726
command.run(mandos_serv, clients)
576
729
class Test_milliseconds_to_string(unittest.TestCase):
649
815
def test_short_header(self):
650
rows = TableOfClients(self.clients, self.keywords,
651
self.tablewords).rows()
656
self.assertEqual(rows, expected_rows)
816
text = str(TableOfClients(self.clients, self.keywords,
823
self.assertEqual(text, expected_text)
657
824
def test_booleans(self):
658
825
keywords = ["Bool", "NonDbusBoolean"]
659
rows = TableOfClients(self.clients, keywords,
660
self.tablewords).rows()
662
"A D-BUS Boolean A Non-D-BUS Boolean",
666
self.assertEqual(rows, expected_rows)
826
text = str(TableOfClients(self.clients, keywords,
829
A D-BUS Boolean A Non-D-BUS Boolean
833
self.assertEqual(text, expected_text)
667
834
def test_milliseconds_detection(self):
668
835
keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
669
836
"ApprovalDuration", "ExtendedTimeout"]
670
rows = TableOfClients(self.clients, keywords,
671
self.tablewords).rows()
837
text = str(TableOfClients(self.clients, keywords,
673
840
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
674
841
0 00:00:00 00:00:01 00:00:02 00:00:03 00:00:04
675
842
1 1T02:03:05 1T02:03:06 1T02:03:07 1T02:03:08 1T02:03:09
678
self.assertEqual(rows, expected_rows)
844
self.assertEqual(text, expected_text)
679
845
def test_empty_and_long_string_values(self):
680
846
keywords = ["String"]
681
rows = TableOfClients(self.clients, keywords,
682
self.tablewords).rows()
847
text = str(TableOfClients(self.clients, keywords,
686
852
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,
689
self.assertEqual(rows, expected_rows)
854
self.assertEqual(text, expected_text)