To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 1030
- compare with another revision
- download diff
- download tarball
- view history from revision 1030
- Committer: Teddy Hogeborn
- Date: 2019-03-06 22:07:48 UTC
- Revision ID: teddy@recompile.se-20190306220748-wfxlbmehw0mny8mn
mandos-ctl: Fix bugs
* mandos-ctl (SetSecretCommand): Argument is file object, not string.
(commands_from_options): Fix "command" to "commands" throughout. Add
option argument to SetCheckerCmd().
(TestSetSecretCmd): Set file objects, not byte strings.
* mandos-ctl (SetSecretCommand): Argument is file object, not string.
(commands_from_options): Fix "command" to "commands" throughout. Add
option argument to SetCheckerCmd().
(TestSetSecretCmd): Set file objects, not byte strings.
- files modified:
- mandos-ctl
added
removed
mandos-ctl
43
43
import unittest
44
44
import logging
45
45
import io
46
import tempfile
47
import contextlib
48
46
49
47
import dbus
50
48
64
62
65
63
locale.setlocale(locale.LC_ALL, "")
66
64
67
dbus_busname_domain = "se.recompile"
68
dbus_busname = dbus_busname_domain + ".Mandos"
69
server_dbus_path = "/"
70
server_dbus_interface = dbus_busname_domain + ".Mandos"
71
client_dbus_interface = dbus_busname_domain + ".Mandos.Client"
72
del dbus_busname_domain
65
domain = "se.recompile"
66
busname = domain + ".Mandos"
67
server_path = "/"
68
server_interface = domain + ".Mandos"
69
client_interface = domain + ".Mandos.Client"
73
70
version = "1.8.3"
74
71
75
72
79
76
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
77
81
78
82
def main():
83
parser = argparse.ArgumentParser()
84
85
add_command_line_options(parser)
86
87
options = parser.parse_args()
88
89
check_option_syntax(parser, options)
90
91
clientnames = options.client
92
93
if options.debug:
94
log.setLevel(logging.DEBUG)
95
96
try:
97
bus = dbus.SystemBus()
98
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
99
dbus_busname, server_dbus_path)
100
mandos_dbus_objc = bus.get_object(dbus_busname,
101
server_dbus_path)
102
except dbus.exceptions.DBusException:
103
log.critical("Could not connect to Mandos server")
104
sys.exit(1)
105
106
mandos_serv = dbus.Interface(mandos_dbus_objc,
107
dbus_interface=server_dbus_interface)
108
mandos_serv_object_manager = dbus.Interface(
109
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
110
111
# Filter out log message from dbus module
112
dbus_logger = logging.getLogger("dbus.proxies")
113
class NullFilter(logging.Filter):
114
def filter(self, record):
115
return False
116
dbus_filter = NullFilter()
117
try:
118
dbus_logger.addFilter(dbus_filter)
119
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
120
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
121
mandos_clients = {path: ifs_and_props[client_dbus_interface]
122
for path, ifs_and_props in
123
mandos_serv_object_manager
124
.GetManagedObjects().items()
125
if client_dbus_interface in ifs_and_props}
126
except dbus.exceptions.DBusException as e:
127
log.critical("Failed to access Mandos server through D-Bus:"
128
"\n%s", e)
129
sys.exit(1)
130
finally:
131
# restore dbus logger
132
dbus_logger.removeFilter(dbus_filter)
133
134
# Compile dict of (clients: properties) to process
135
clients = {}
136
137
if not clientnames:
138
clients = {objpath: properties
139
for objpath, properties in mandos_clients.items()}
140
else:
141
for name in clientnames:
142
for objpath, properties in mandos_clients.items():
143
if properties["Name"] == name:
144
clients[objpath] = properties
145
break
146
else:
147
log.critical("Client not found on server: %r", name)
148
sys.exit(1)
149
150
# Run all commands on clients
151
commands = commands_from_options(options)
152
for command in commands:
153
command.run(clients, bus, mandos_serv)
154
155
156
def add_command_line_options(parser):
157
parser.add_argument("--version", action="version",
158
version="%(prog)s {}".format(version),
159
help="show version number and exit")
160
parser.add_argument("-a", "--all", action="store_true",
161
help="Select all clients")
162
parser.add_argument("-v", "--verbose", action="store_true",
163
help="Print all fields")
164
parser.add_argument("-j", "--dump-json", action="store_true",
165
help="Dump client data in JSON format")
166
enable_disable = parser.add_mutually_exclusive_group()
167
enable_disable.add_argument("-e", "--enable", action="store_true",
168
help="Enable client")
169
enable_disable.add_argument("-d", "--disable",
170
action="store_true",
171
help="disable client")
172
parser.add_argument("-b", "--bump-timeout", action="store_true",
173
help="Bump timeout for client")
174
start_stop_checker = parser.add_mutually_exclusive_group()
175
start_stop_checker.add_argument("--start-checker",
176
action="store_true",
177
help="Start checker for client")
178
start_stop_checker.add_argument("--stop-checker",
179
action="store_true",
180
help="Stop checker for client")
181
parser.add_argument("-V", "--is-enabled", action="store_true",
182
help="Check if client is enabled")
183
parser.add_argument("-r", "--remove", action="store_true",
184
help="Remove client")
185
parser.add_argument("-c", "--checker",
186
help="Set checker command for client")
187
parser.add_argument("-t", "--timeout", type=string_to_delta,
188
help="Set timeout for client")
189
parser.add_argument("--extended-timeout", type=string_to_delta,
190
help="Set extended timeout for client")
191
parser.add_argument("-i", "--interval", type=string_to_delta,
192
help="Set checker interval for client")
193
approve_deny_default = parser.add_mutually_exclusive_group()
194
approve_deny_default.add_argument(
195
"--approve-by-default", action="store_true",
196
default=None, dest="approved_by_default",
197
help="Set client to be approved by default")
198
approve_deny_default.add_argument(
199
"--deny-by-default", action="store_false",
200
dest="approved_by_default",
201
help="Set client to be denied by default")
202
parser.add_argument("--approval-delay", type=string_to_delta,
203
help="Set delay before client approve/deny")
204
parser.add_argument("--approval-duration", type=string_to_delta,
205
help="Set duration of one client approval")
206
parser.add_argument("-H", "--host", help="Set host for client")
207
parser.add_argument("-s", "--secret",
208
type=argparse.FileType(mode="rb"),
209
help="Set password blob (file) for client")
210
approve_deny = parser.add_mutually_exclusive_group()
211
approve_deny.add_argument(
212
"-A", "--approve", action="store_true",
213
help="Approve any current client request")
214
approve_deny.add_argument("-D", "--deny", action="store_true",
215
help="Deny any current client request")
216
parser.add_argument("--debug", action="store_true",
217
help="Debug mode (show D-Bus commands)")
218
parser.add_argument("--check", action="store_true",
219
help="Run self-test")
220
parser.add_argument("client", nargs="*", help="Client name")
221
222
223
def string_to_delta(interval):
224
"""Parse a string and return a datetime.timedelta"""
225
226
try:
227
return rfc3339_duration_to_delta(interval)
228
except ValueError as e:
229
log.warning("%s - Parsing as pre-1.6.1 interval instead",
230
' '.join(e.args))
231
return parse_pre_1_6_1_interval(interval)
79
def milliseconds_to_string(ms):
80
td = datetime.timedelta(0, 0, 0, ms)
81
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
82
.format(days="{}T".format(td.days) if td.days else "",
83
hours=td.seconds // 3600,
84
minutes=(td.seconds % 3600) // 60,
85
seconds=td.seconds % 60))
232
86
233
87
234
88
def rfc3339_duration_to_delta(duration):
361
215
return value
362
216
363
217
218
def string_to_delta(interval):
219
"""Parse a string and return a datetime.timedelta"""
220
221
try:
222
return rfc3339_duration_to_delta(interval)
223
except ValueError as e:
224
log.warning("%s - Parsing as pre-1.6.1 interval instead",
225
' '.join(e.args))
226
return parse_pre_1_6_1_interval(interval)
227
228
364
229
def parse_pre_1_6_1_interval(interval):
365
230
"""Parse an interval string as documented by Mandos before 1.6.1,
366
231
and return a datetime.timedelta
404
269
return value
405
270
406
271
407
def check_option_syntax(parser, options):
408
"""Apply additional restrictions on options, not expressible in
409
argparse"""
410
411
def has_actions(options):
412
return any((options.enable,
413
options.disable,
414
options.bump_timeout,
415
options.start_checker,
416
options.stop_checker,
417
options.is_enabled,
418
options.remove,
419
options.checker is not None,
420
options.timeout is not None,
421
options.extended_timeout is not None,
422
options.interval is not None,
423
options.approved_by_default is not None,
424
options.approval_delay is not None,
425
options.approval_duration is not None,
426
options.host is not None,
427
options.secret is not None,
428
options.approve,
429
options.deny))
430
431
if has_actions(options) and not (options.client or options.all):
432
parser.error("Options require clients names or --all.")
433
if options.verbose and has_actions(options):
434
parser.error("--verbose can only be used alone.")
435
if options.dump_json and (options.verbose
436
or has_actions(options)):
437
parser.error("--dump-json can only be used alone.")
438
if options.all and not has_actions(options):
439
parser.error("--all requires an action.")
440
if options.is_enabled and len(options.client) > 1:
441
parser.error("--is-enabled requires exactly one client")
442
if options.remove:
443
options.remove = False
444
if has_actions(options) and not options.deny:
445
parser.error("--remove can only be combined with --deny")
446
options.remove = True
447
448
449
def commands_from_options(options):
450
451
commands = []
452
453
if options.is_enabled:
454
commands.append(IsEnabledCmd())
455
456
if options.approve:
457
commands.append(ApproveCmd())
458
459
if options.deny:
460
commands.append(DenyCmd())
461
462
if options.remove:
463
commands.append(RemoveCmd())
464
465
if options.dump_json:
466
commands.append(DumpJSONCmd())
467
468
if options.enable:
469
commands.append(EnableCmd())
470
471
if options.disable:
472
commands.append(DisableCmd())
473
474
if options.bump_timeout:
475
commands.append(BumpTimeoutCmd())
476
477
if options.start_checker:
478
commands.append(StartCheckerCmd())
479
480
if options.stop_checker:
481
commands.append(StopCheckerCmd())
482
483
if options.approved_by_default is not None:
484
if options.approved_by_default:
485
commands.append(ApproveByDefaultCmd())
486
else:
487
commands.append(DenyByDefaultCmd())
488
489
if options.checker is not None:
490
commands.append(SetCheckerCmd(options.checker))
491
492
if options.host is not None:
493
commands.append(SetHostCmd(options.host))
494
495
if options.secret is not None:
496
commands.append(SetSecretCmd(options.secret))
497
498
if options.timeout is not None:
499
commands.append(SetTimeoutCmd(options.timeout))
500
501
if options.extended_timeout:
502
commands.append(
503
SetExtendedTimeoutCmd(options.extended_timeout))
504
505
if options.interval is not None:
506
commands.append(SetIntervalCmd(options.interval))
507
508
if options.approval_delay is not None:
509
commands.append(SetApprovalDelayCmd(options.approval_delay))
510
511
if options.approval_duration is not None:
512
commands.append(
513
SetApprovalDurationCmd(options.approval_duration))
514
515
# If no command option has been given, show table of clients,
516
# optionally verbosely
517
if not commands:
518
commands.append(PrintTableCmd(verbose=options.verbose))
519
520
return commands
521
522
272
## Classes for commands.
273
274
# Abstract classes first
523
275
class Command(object):
524
276
"""Abstract class for commands"""
525
def run(self, clients, bus=None, mandos=None):
277
def run(self, mandos, clients):
526
278
"""Normal commands should implement run_on_one_client(), but
527
279
commands which want to operate on all clients at the same time
528
280
can override this run() method instead."""
529
281
self.mandos = mandos
530
for clientpath, properties in clients.items():
531
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
532
dbus_busname, str(clientpath))
533
client = bus.get_object(dbus_busname, clientpath)
282
for client, properties in clients.items():
534
283
self.run_on_one_client(client, properties)
535
284
536
537
class IsEnabledCmd(Command):
538
def run(self, clients, bus=None, mandos=None):
539
client, properties = next(iter(clients.items()))
540
if self.is_enabled(client, properties):
541
sys.exit(0)
542
sys.exit(1)
543
def is_enabled(self, client, properties):
544
return properties["Enabled"]
545
546
547
class ApproveCmd(Command):
548
def run_on_one_client(self, client, properties):
549
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
550
client.__dbus_object_path__, client_dbus_interface)
551
client.Approve(dbus.Boolean(True),
552
dbus_interface=client_dbus_interface)
553
554
555
class DenyCmd(Command):
556
def run_on_one_client(self, client, properties):
557
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
558
client.__dbus_object_path__, client_dbus_interface)
559
client.Approve(dbus.Boolean(False),
560
dbus_interface=client_dbus_interface)
561
562
563
class RemoveCmd(Command):
564
def run_on_one_client(self, client, properties):
565
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
566
server_dbus_path, server_dbus_interface,
567
str(client.__dbus_object_path__))
568
self.mandos.RemoveClient(client.__dbus_object_path__)
569
570
571
class OutputCmd(Command):
572
"""Abstract class for commands outputting client details"""
285
class PrintCmd(Command):
286
"""Abstract class for commands printing client details"""
573
287
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
574
288
"Created", "Interval", "Host", "KeyID",
575
289
"Fingerprint", "CheckerRunning", "LastEnabled",
577
291
"LastApprovalRequest", "ApprovalDelay",
578
292
"ApprovalDuration", "Checker", "ExtendedTimeout",
579
293
"Expires", "LastCheckerStatus")
580
def run(self, clients, bus=None, mandos=None):
581
print(self.output(clients.values()))
582
def output(self, clients):
583
raise NotImplementedError()
584
585
586
class DumpJSONCmd(OutputCmd):
587
def output(self, clients):
588
data = {client["Name"]:
589
{key: self.dbus_boolean_to_bool(client[key])
590
for key in self.all_keywords}
591
for client in clients.values()}
592
return json.dumps(data, indent=4, separators=(',', ': '))
593
@staticmethod
594
def dbus_boolean_to_bool(value):
595
if isinstance(value, dbus.Boolean):
596
value = bool(value)
597
return value
598
599
600
class PrintTableCmd(OutputCmd):
294
def run(self, mandos, clients):
295
print(self.output(clients))
296
297
class PropertyCmd(Command):
298
"""Abstract class for Actions for setting one client property"""
299
def run_on_one_client(self, client, properties):
300
"""Set the Client's D-Bus property"""
301
client.Set(client_interface, self.property, self.value_to_set,
302
dbus_interface=dbus.PROPERTIES_IFACE)
303
304
class ValueArgumentMixIn(object):
305
"""Mixin class for commands taking a value as argument"""
306
def __init__(self, value):
307
self.value_to_set = value
308
309
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
310
"""Mixin class for commands taking a value argument as
311
milliseconds."""
312
@property
313
def value_to_set(self):
314
return self._vts
315
@value_to_set.setter
316
def value_to_set(self, value):
317
"""When setting, convert value to a datetime.timedelta"""
318
self._vts = string_to_delta(value).total_seconds() * 1000
319
320
# Actual (non-abstract) command classes
321
322
class PrintTableCmd(PrintCmd):
601
323
def __init__(self, verbose=False):
602
324
self.verbose = verbose
603
325
604
326
def output(self, clients):
605
default_keywords = ("Name", "Enabled", "Timeout",
606
"LastCheckedOK")
327
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
607
328
keywords = default_keywords
608
329
if self.verbose:
609
330
keywords = self.all_keywords
610
return str(self.TableOfClients(clients, keywords))
331
return str(self.TableOfClients(clients.values(), keywords))
611
332
612
333
class TableOfClients(object):
613
334
tableheaders = {
666
387
def string_from_client(self, client, key):
667
388
return self.valuetostring(client[key], key)
668
389
669
@classmethod
670
def valuetostring(cls, value, keyword):
390
@staticmethod
391
def valuetostring(value, keyword):
671
392
if isinstance(value, dbus.Boolean):
672
393
return "Yes" if value else "No"
673
394
if keyword in ("Timeout", "Interval", "ApprovalDelay",
674
395
"ApprovalDuration", "ExtendedTimeout"):
675
return cls.milliseconds_to_string(value)
396
return milliseconds_to_string(value)
676
397
return str(value)
677
398
678
399
def header_line(self, format_string):
683
404
**{key: self.string_from_client(client, key)
684
405
for key in self.keywords})
685
406
686
@staticmethod
687
def milliseconds_to_string(ms):
688
td = datetime.timedelta(0, 0, 0, ms)
689
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
690
.format(days="{}T".format(td.days)
691
if td.days else "",
692
hours=td.seconds // 3600,
693
minutes=(td.seconds % 3600) // 60,
694
seconds=td.seconds % 60))
695
696
697
class PropertyCmd(Command):
698
"""Abstract class for Actions for setting one client property"""
699
def run_on_one_client(self, client, properties):
700
"""Set the Client's D-Bus property"""
701
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
702
client.__dbus_object_path__,
703
dbus.PROPERTIES_IFACE, client_dbus_interface,
704
self.propname, self.value_to_set
705
if not isinstance(self.value_to_set, dbus.Boolean)
706
else bool(self.value_to_set))
707
client.Set(client_dbus_interface, self.propname,
708
self.value_to_set,
709
dbus_interface=dbus.PROPERTIES_IFACE)
710
@property
711
def propname(self):
712
raise NotImplementedError()
713
407
408
409
class DumpJSONCmd(PrintCmd):
410
def output(self, clients):
411
data = {client["Name"]:
412
{key: self.dbus_boolean_to_bool(client[key])
413
for key in self.all_keywords}
414
for client in clients.values()}
415
return json.dumps(data, indent=4, separators=(',', ': '))
416
@staticmethod
417
def dbus_boolean_to_bool(value):
418
if isinstance(value, dbus.Boolean):
419
value = bool(value)
420
return value
421
422
class IsEnabledCmd(Command):
423
def run_on_one_client(self, client, properties):
424
if self.is_enabled(client, properties):
425
sys.exit(0)
426
sys.exit(1)
427
def is_enabled(self, client, properties):
428
return bool(properties["Enabled"])
429
430
class RemoveCmd(Command):
431
def run_on_one_client(self, client, properties):
432
self.mandos.RemoveClient(client.__dbus_object_path__)
433
434
class ApproveCmd(Command):
435
def run_on_one_client(self, client, properties):
436
client.Approve(dbus.Boolean(True),
437
dbus_interface=client_interface)
438
439
class DenyCmd(Command):
440
def run_on_one_client(self, client, properties):
441
client.Approve(dbus.Boolean(False),
442
dbus_interface=client_interface)
714
443
715
444
class EnableCmd(PropertyCmd):
716
propname = "Enabled"
445
property = "Enabled"
717
446
value_to_set = dbus.Boolean(True)
718
447
719
720
448
class DisableCmd(PropertyCmd):
721
propname = "Enabled"
449
property = "Enabled"
722
450
value_to_set = dbus.Boolean(False)
723
451
724
725
452
class BumpTimeoutCmd(PropertyCmd):
726
propname = "LastCheckedOK"
453
property = "LastCheckedOK"
727
454
value_to_set = ""
728
455
729
730
456
class StartCheckerCmd(PropertyCmd):
731
propname = "CheckerRunning"
457
property = "CheckerRunning"
732
458
value_to_set = dbus.Boolean(True)
733
459
734
735
460
class StopCheckerCmd(PropertyCmd):
736
propname = "CheckerRunning"
461
property = "CheckerRunning"
737
462
value_to_set = dbus.Boolean(False)
738
463
739
740
464
class ApproveByDefaultCmd(PropertyCmd):
741
propname = "ApprovedByDefault"
465
property = "ApprovedByDefault"
742
466
value_to_set = dbus.Boolean(True)
743
467
744
745
468
class DenyByDefaultCmd(PropertyCmd):
746
propname = "ApprovedByDefault"
469
property = "ApprovedByDefault"
747
470
value_to_set = dbus.Boolean(False)
748
471
749
750
class PropertyValueCmd(PropertyCmd):
751
"""Abstract class for PropertyCmd recieving a value as argument"""
752
def __init__(self, value):
753
self.value_to_set = value
754
755
756
class SetCheckerCmd(PropertyValueCmd):
757
propname = "Checker"
758
759
760
class SetHostCmd(PropertyValueCmd):
761
propname = "Host"
762
763
764
class SetSecretCmd(PropertyValueCmd):
765
propname = "Secret"
472
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
473
property = "Checker"
474
475
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
476
property = "Host"
477
478
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
766
479
@property
767
480
def value_to_set(self):
768
481
return self._vts
771
484
"""When setting, read data from supplied file object"""
772
485
self._vts = value.read()
773
486
value.close()
774
775
776
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
777
"""Abstract class for PropertyValueCmd taking a value argument as
778
a datetime.timedelta() but should store it as milliseconds."""
779
@property
780
def value_to_set(self):
781
return self._vts
782
@value_to_set.setter
783
def value_to_set(self, value):
784
"""When setting, convert value from a datetime.timedelta"""
785
self._vts = int(round(value.total_seconds() * 1000))
786
787
788
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
789
propname = "Timeout"
790
791
792
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
793
propname = "ExtendedTimeout"
794
795
796
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
797
propname = "Interval"
798
799
800
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
801
propname = "ApprovalDelay"
802
803
804
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
805
propname = "ApprovalDuration"
806
487
property = "Secret"
488
489
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
490
property = "Timeout"
491
492
class SetExtendedTimeoutCmd(PropertyCmd,
493
MillisecondsValueArgumentMixIn):
494
property = "ExtendedTimeout"
495
496
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
497
property = "Interval"
498
499
class SetApprovalDelayCmd(PropertyCmd,
500
MillisecondsValueArgumentMixIn):
501
property = "ApprovalDelay"
502
503
class SetApprovalDurationCmd(PropertyCmd,
504
MillisecondsValueArgumentMixIn):
505
property = "ApprovalDuration"
506
507
def has_actions(options):
508
return any((options.enable,
509
options.disable,
510
options.bump_timeout,
511
options.start_checker,
512
options.stop_checker,
513
options.is_enabled,
514
options.remove,
515
options.checker is not None,
516
options.timeout is not None,
517
options.extended_timeout is not None,
518
options.interval is not None,
519
options.approved_by_default is not None,
520
options.approval_delay is not None,
521
options.approval_duration is not None,
522
options.host is not None,
523
options.secret is not None,
524
options.approve,
525
options.deny))
526
527
def add_command_line_options(parser):
528
parser.add_argument("--version", action="version",
529
version="%(prog)s {}".format(version),
530
help="show version number and exit")
531
parser.add_argument("-a", "--all", action="store_true",
532
help="Select all clients")
533
parser.add_argument("-v", "--verbose", action="store_true",
534
help="Print all fields")
535
parser.add_argument("-j", "--dump-json", action="store_true",
536
help="Dump client data in JSON format")
537
enable_disable = parser.add_mutually_exclusive_group()
538
enable_disable.add_argument("-e", "--enable", action="store_true",
539
help="Enable client")
540
enable_disable.add_argument("-d", "--disable",
541
action="store_true",
542
help="disable client")
543
parser.add_argument("-b", "--bump-timeout", action="store_true",
544
help="Bump timeout for client")
545
start_stop_checker = parser.add_mutually_exclusive_group()
546
start_stop_checker.add_argument("--start-checker",
547
action="store_true",
548
help="Start checker for client")
549
start_stop_checker.add_argument("--stop-checker",
550
action="store_true",
551
help="Stop checker for client")
552
parser.add_argument("-V", "--is-enabled", action="store_true",
553
help="Check if client is enabled")
554
parser.add_argument("-r", "--remove", action="store_true",
555
help="Remove client")
556
parser.add_argument("-c", "--checker",
557
help="Set checker command for client")
558
parser.add_argument("-t", "--timeout",
559
help="Set timeout for client")
560
parser.add_argument("--extended-timeout",
561
help="Set extended timeout for client")
562
parser.add_argument("-i", "--interval",
563
help="Set checker interval for client")
564
approve_deny_default = parser.add_mutually_exclusive_group()
565
approve_deny_default.add_argument(
566
"--approve-by-default", action="store_true",
567
default=None, dest="approved_by_default",
568
help="Set client to be approved by default")
569
approve_deny_default.add_argument(
570
"--deny-by-default", action="store_false",
571
dest="approved_by_default",
572
help="Set client to be denied by default")
573
parser.add_argument("--approval-delay",
574
help="Set delay before client approve/deny")
575
parser.add_argument("--approval-duration",
576
help="Set duration of one client approval")
577
parser.add_argument("-H", "--host", help="Set host for client")
578
parser.add_argument("-s", "--secret",
579
type=argparse.FileType(mode="rb"),
580
help="Set password blob (file) for client")
581
approve_deny = parser.add_mutually_exclusive_group()
582
approve_deny.add_argument(
583
"-A", "--approve", action="store_true",
584
help="Approve any current client request")
585
approve_deny.add_argument("-D", "--deny", action="store_true",
586
help="Deny any current client request")
587
parser.add_argument("--check", action="store_true",
588
help="Run self-test")
589
parser.add_argument("client", nargs="*", help="Client name")
590
591
592
def commands_from_options(options):
593
594
commands = []
595
596
if options.dump_json:
597
commands.append(DumpJSONCmd())
598
599
if options.enable:
600
commands.append(EnableCmd())
601
602
if options.disable:
603
commands.append(DisableCmd())
604
605
if options.bump_timeout:
606
commands.append(BumpTimeoutCmd())
607
608
if options.start_checker:
609
commands.append(StartCheckerCmd())
610
611
if options.stop_checker:
612
commands.append(StopCheckerCmd())
613
614
if options.is_enabled:
615
commands.append(IsEnabledCmd())
616
617
if options.remove:
618
commands.append(RemoveCmd())
619
620
if options.checker is not None:
621
commands.append(SetCheckerCmd(options.checker))
622
623
if options.timeout is not None:
624
commands.append(SetTimeoutCmd(options.timeout))
625
626
if options.extended_timeout:
627
commands.append(
628
SetExtendedTimeoutCmd(options.extended_timeout))
629
630
if options.interval is not None:
631
commands.append(SetIntervalCmd(options.interval))
632
633
if options.approved_by_default is not None:
634
if options.approved_by_default:
635
commands.append(ApproveByDefaultCmd())
636
else:
637
commands.append(DenyByDefaultCmd())
638
639
if options.approval_delay is not None:
640
commands.append(SetApprovalDelayCmd(options.approval_delay))
641
642
if options.approval_duration is not None:
643
commands.append(
644
SetApprovalDurationCmd(options.approval_duration))
645
646
if options.host is not None:
647
commands.append(SetHostCmd(options.host))
648
649
if options.secret is not None:
650
commands.append(SetSecretCmd(options.secret))
651
652
if options.approve:
653
commands.append(ApproveCmd())
654
655
if options.deny:
656
commands.append(DenyCmd())
657
658
# If no command option has been given, show table of clients,
659
# optionally verbosely
660
if not commands:
661
commands.append(PrintTableCmd(verbose=options.verbose))
662
663
return commands
664
665
666
def main():
667
parser = argparse.ArgumentParser()
668
669
add_command_line_options(parser)
670
671
options = parser.parse_args()
672
673
if has_actions(options) and not (options.client or options.all):
674
parser.error("Options require clients names or --all.")
675
if options.verbose and has_actions(options):
676
parser.error("--verbose can only be used alone.")
677
if options.dump_json and (options.verbose
678
or has_actions(options)):
679
parser.error("--dump-json can only be used alone.")
680
if options.all and not has_actions(options):
681
parser.error("--all requires an action.")
682
if options.is_enabled and len(options.client) > 1:
683
parser.error("--is-enabled requires exactly one client")
684
685
clientnames = options.client
686
687
try:
688
bus = dbus.SystemBus()
689
mandos_dbus_objc = bus.get_object(busname, server_path)
690
except dbus.exceptions.DBusException:
691
log.critical("Could not connect to Mandos server")
692
sys.exit(1)
693
694
mandos_serv = dbus.Interface(mandos_dbus_objc,
695
dbus_interface=server_interface)
696
mandos_serv_object_manager = dbus.Interface(
697
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
698
699
# Filter out log message from dbus module
700
dbus_logger = logging.getLogger("dbus.proxies")
701
class NullFilter(logging.Filter):
702
def filter(self, record):
703
return False
704
dbus_filter = NullFilter()
705
try:
706
dbus_logger.addFilter(dbus_filter)
707
mandos_clients = {path: ifs_and_props[client_interface]
708
for path, ifs_and_props in
709
mandos_serv_object_manager
710
.GetManagedObjects().items()
711
if client_interface in ifs_and_props}
712
except dbus.exceptions.DBusException as e:
713
log.critical("Failed to access Mandos server through D-Bus:"
714
"\n%s", e)
715
sys.exit(1)
716
finally:
717
# restore dbus logger
718
dbus_logger.removeFilter(dbus_filter)
719
720
# Compile dict of (clients: properties) to process
721
clients = {}
722
723
if not clientnames:
724
clients = {bus.get_object(busname, path): properties
725
for path, properties in mandos_clients.items()}
726
else:
727
for name in clientnames:
728
for path, client in mandos_clients.items():
729
if client["Name"] == name:
730
client_objc = bus.get_object(busname, path)
731
clients[client_objc] = client
732
break
733
else:
734
log.critical("Client not found on server: %r", name)
735
sys.exit(1)
736
737
# Run all commands on clients
738
commands = commands_from_options(options)
739
for command in commands:
740
command.run(mandos_serv, clients)
807
741
808
742
743
class Test_milliseconds_to_string(unittest.TestCase):
744
def test_all(self):
745
self.assertEqual(milliseconds_to_string(93785000),
746
"1T02:03:05")
747
def test_no_days(self):
748
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
749
def test_all_zero(self):
750
self.assertEqual(milliseconds_to_string(0), "00:00:00")
751
def test_no_fractional_seconds(self):
752
self.assertEqual(milliseconds_to_string(400), "00:00:00")
753
self.assertEqual(milliseconds_to_string(900), "00:00:00")
754
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
755
809
756
class Test_string_to_delta(unittest.TestCase):
810
757
def test_handles_basic_rfc3339(self):
811
758
self.assertEqual(string_to_delta("PT0S"),
839
786
self.assertEqual(value, datetime.timedelta(0, 7200))
840
787
841
788
842
class Test_check_option_syntax(unittest.TestCase):
843
# This mostly corresponds to the definition from has_actions() in
844
# check_option_syntax()
845
actions = {
846
# The actual values set here are not that important, but we do
847
# at least stick to the correct types, even though they are
848
# never used
849
"enable": True,
850
"disable": True,
851
"bump_timeout": True,
852
"start_checker": True,
853
"stop_checker": True,
854
"is_enabled": True,
855
"remove": True,
856
"checker": "x",
857
"timeout": datetime.timedelta(),
858
"extended_timeout": datetime.timedelta(),
859
"interval": datetime.timedelta(),
860
"approved_by_default": True,
861
"approval_delay": datetime.timedelta(),
862
"approval_duration": datetime.timedelta(),
863
"host": "x",
864
"secret": io.BytesIO(b"x"),
865
"approve": True,
866
"deny": True,
867
}
868
869
def setUp(self):
870
self.parser = argparse.ArgumentParser()
871
add_command_line_options(self.parser)
872
873
@contextlib.contextmanager
874
def assertParseError(self):
875
with self.assertRaises(SystemExit) as e:
876
with self.temporarily_suppress_stderr():
877
yield
878
# Exit code from argparse is guaranteed to be "2". Reference:
879
# https://docs.python.org/3/library
880
# /argparse.html#exiting-methods
881
self.assertEqual(e.exception.code, 2)
882
883
@staticmethod
884
@contextlib.contextmanager
885
def temporarily_suppress_stderr():
886
null = os.open(os.path.devnull, os.O_RDWR)
887
stderrcopy = os.dup(sys.stderr.fileno())
888
os.dup2(null, sys.stderr.fileno())
889
os.close(null)
890
try:
891
yield
892
finally:
893
# restore stderr
894
os.dup2(stderrcopy, sys.stderr.fileno())
895
os.close(stderrcopy)
896
897
def check_option_syntax(self, options):
898
check_option_syntax(self.parser, options)
899
900
def test_actions_requires_client_or_all(self):
901
for action, value in self.actions.items():
902
options = self.parser.parse_args()
903
setattr(options, action, value)
904
with self.assertParseError():
905
self.check_option_syntax(options)
906
907
def test_actions_conflicts_with_verbose(self):
908
for action, value in self.actions.items():
909
options = self.parser.parse_args()
910
setattr(options, action, value)
911
options.verbose = True
912
with self.assertParseError():
913
self.check_option_syntax(options)
914
915
def test_dump_json_conflicts_with_verbose(self):
916
options = self.parser.parse_args()
917
options.dump_json = True
918
options.verbose = True
919
with self.assertParseError():
920
self.check_option_syntax(options)
921
922
def test_dump_json_conflicts_with_action(self):
923
for action, value in self.actions.items():
924
options = self.parser.parse_args()
925
setattr(options, action, value)
926
options.dump_json = True
927
with self.assertParseError():
928
self.check_option_syntax(options)
929
930
def test_all_can_not_be_alone(self):
931
options = self.parser.parse_args()
932
options.all = True
933
with self.assertParseError():
934
self.check_option_syntax(options)
935
936
def test_all_is_ok_with_any_action(self):
937
for action, value in self.actions.items():
938
options = self.parser.parse_args()
939
setattr(options, action, value)
940
options.all = True
941
self.check_option_syntax(options)
942
943
def test_is_enabled_fails_without_client(self):
944
options = self.parser.parse_args()
945
options.is_enabled = True
946
with self.assertParseError():
947
self.check_option_syntax(options)
948
949
def test_is_enabled_works_with_one_client(self):
950
options = self.parser.parse_args()
951
options.is_enabled = True
952
options.client = ["foo"]
953
self.check_option_syntax(options)
954
955
def test_is_enabled_fails_with_two_clients(self):
956
options = self.parser.parse_args()
957
options.is_enabled = True
958
options.client = ["foo", "barbar"]
959
with self.assertParseError():
960
self.check_option_syntax(options)
961
962
def test_remove_can_only_be_combined_with_action_deny(self):
963
for action, value in self.actions.items():
964
if action in {"remove", "deny"}:
965
continue
966
options = self.parser.parse_args()
967
setattr(options, action, value)
968
options.all = True
969
options.remove = True
970
with self.assertParseError():
971
self.check_option_syntax(options)
972
973
974
class Test_command_from_options(unittest.TestCase):
975
def setUp(self):
976
self.parser = argparse.ArgumentParser()
977
add_command_line_options(self.parser)
978
def assert_command_from_args(self, args, command_cls,
979
**cmd_attrs):
980
"""Assert that parsing ARGS should result in an instance of
981
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
982
options = self.parser.parse_args(args)
983
check_option_syntax(self.parser, options)
984
commands = commands_from_options(options)
985
self.assertEqual(len(commands), 1)
986
command = commands[0]
987
self.assertIsInstance(command, command_cls)
988
for key, value in cmd_attrs.items():
989
self.assertEqual(getattr(command, key), value)
990
def test_print_table(self):
991
self.assert_command_from_args([], PrintTableCmd,
992
verbose=False)
993
994
def test_print_table_verbose(self):
995
self.assert_command_from_args(["--verbose"], PrintTableCmd,
996
verbose=True)
997
998
def test_print_table_verbose_short(self):
999
self.assert_command_from_args(["-v"], PrintTableCmd,
1000
verbose=True)
1001
1002
def test_enable(self):
1003
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1004
1005
def test_enable_short(self):
1006
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1007
1008
def test_disable(self):
1009
self.assert_command_from_args(["--disable", "foo"],
1010
DisableCmd)
1011
1012
def test_disable_short(self):
1013
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1014
1015
def test_bump_timeout(self):
1016
self.assert_command_from_args(["--bump-timeout", "foo"],
1017
BumpTimeoutCmd)
1018
1019
def test_bump_timeout_short(self):
1020
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1021
1022
def test_start_checker(self):
1023
self.assert_command_from_args(["--start-checker", "foo"],
1024
StartCheckerCmd)
1025
1026
def test_stop_checker(self):
1027
self.assert_command_from_args(["--stop-checker", "foo"],
1028
StopCheckerCmd)
1029
1030
def test_remove(self):
1031
self.assert_command_from_args(["--remove", "foo"],
1032
RemoveCmd)
1033
1034
def test_remove_short(self):
1035
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1036
1037
def test_checker(self):
1038
self.assert_command_from_args(["--checker", ":", "foo"],
1039
SetCheckerCmd, value_to_set=":")
1040
1041
def test_checker_empty(self):
1042
self.assert_command_from_args(["--checker", "", "foo"],
1043
SetCheckerCmd, value_to_set="")
1044
1045
def test_checker_short(self):
1046
self.assert_command_from_args(["-c", ":", "foo"],
1047
SetCheckerCmd, value_to_set=":")
1048
1049
def test_timeout(self):
1050
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1051
SetTimeoutCmd,
1052
value_to_set=300000)
1053
1054
def test_timeout_short(self):
1055
self.assert_command_from_args(["-t", "PT5M", "foo"],
1056
SetTimeoutCmd,
1057
value_to_set=300000)
1058
1059
def test_extended_timeout(self):
1060
self.assert_command_from_args(["--extended-timeout", "PT15M",
1061
"foo"],
1062
SetExtendedTimeoutCmd,
1063
value_to_set=900000)
1064
1065
def test_interval(self):
1066
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1067
SetIntervalCmd,
1068
value_to_set=120000)
1069
1070
def test_interval_short(self):
1071
self.assert_command_from_args(["-i", "PT2M", "foo"],
1072
SetIntervalCmd,
1073
value_to_set=120000)
1074
1075
def test_approve_by_default(self):
1076
self.assert_command_from_args(["--approve-by-default", "foo"],
1077
ApproveByDefaultCmd)
1078
1079
def test_deny_by_default(self):
1080
self.assert_command_from_args(["--deny-by-default", "foo"],
1081
DenyByDefaultCmd)
1082
1083
def test_approval_delay(self):
1084
self.assert_command_from_args(["--approval-delay", "PT30S",
1085
"foo"], SetApprovalDelayCmd,
1086
value_to_set=30000)
1087
1088
def test_approval_duration(self):
1089
self.assert_command_from_args(["--approval-duration", "PT1S",
1090
"foo"], SetApprovalDurationCmd,
1091
value_to_set=1000)
1092
1093
def test_host(self):
1094
self.assert_command_from_args(["--host", "foo.example.org",
1095
"foo"], SetHostCmd,
1096
value_to_set="foo.example.org")
1097
1098
def test_host_short(self):
1099
self.assert_command_from_args(["-H", "foo.example.org",
1100
"foo"], SetHostCmd,
1101
value_to_set="foo.example.org")
1102
1103
def test_secret_devnull(self):
1104
self.assert_command_from_args(["--secret", os.path.devnull,
1105
"foo"], SetSecretCmd,
1106
value_to_set=b"")
1107
1108
def test_secret_tempfile(self):
1109
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1110
value = b"secret\0xyzzy\nbar"
1111
f.write(value)
1112
f.seek(0)
1113
self.assert_command_from_args(["--secret", f.name,
1114
"foo"], SetSecretCmd,
1115
value_to_set=value)
1116
1117
def test_secret_devnull_short(self):
1118
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1119
SetSecretCmd, value_to_set=b"")
1120
1121
def test_secret_tempfile_short(self):
1122
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1123
value = b"secret\0xyzzy\nbar"
1124
f.write(value)
1125
f.seek(0)
1126
self.assert_command_from_args(["-s", f.name, "foo"],
1127
SetSecretCmd,
1128
value_to_set=value)
1129
1130
def test_approve(self):
1131
self.assert_command_from_args(["--approve", "foo"],
1132
ApproveCmd)
1133
1134
def test_approve_short(self):
1135
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1136
1137
def test_deny(self):
1138
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1139
1140
def test_deny_short(self):
1141
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1142
1143
def test_dump_json(self):
1144
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1145
1146
def test_is_enabled(self):
1147
self.assert_command_from_args(["--is-enabled", "foo"],
1148
IsEnabledCmd)
1149
1150
def test_is_enabled_short(self):
1151
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1152
1153
def test_deny_before_remove(self):
1154
options = self.parser.parse_args(["--deny", "--remove",
1155
"foo"])
1156
check_option_syntax(self.parser, options)
1157
commands = commands_from_options(options)
1158
self.assertEqual(len(commands), 2)
1159
self.assertIsInstance(commands[0], DenyCmd)
1160
self.assertIsInstance(commands[1], RemoveCmd)
1161
1162
def test_deny_before_remove_reversed(self):
1163
options = self.parser.parse_args(["--remove", "--deny",
1164
"--all"])
1165
check_option_syntax(self.parser, options)
1166
commands = commands_from_options(options)
1167
self.assertEqual(len(commands), 2)
1168
self.assertIsInstance(commands[0], DenyCmd)
1169
self.assertIsInstance(commands[1], RemoveCmd)
1170
1171
1172
789
class TestCmd(unittest.TestCase):
1173
790
"""Abstract class for tests of command classes"""
1174
791
def setUp(self):
1175
792
testcase = self
1176
793
class MockClient(object):
1177
794
def __init__(self, name, **attributes):
1178
self.__dbus_object_path__ = "/clients/{}".format(name)
795
self.__dbus_object_path__ = "objpath_{}".format(name)
1179
796
self.attributes = attributes
1180
797
self.attributes["Name"] = name
1181
798
self.calls = []
1182
def Set(self, interface, propname, value, dbus_interface):
1183
testcase.assertEqual(interface, client_dbus_interface)
1184
testcase.assertEqual(dbus_interface,
1185
dbus.PROPERTIES_IFACE)
1186
self.attributes[propname] = value
1187
def Get(self, interface, propname, dbus_interface):
1188
testcase.assertEqual(interface, client_dbus_interface)
1189
testcase.assertEqual(dbus_interface,
1190
dbus.PROPERTIES_IFACE)
1191
return self.attributes[propname]
799
def Set(self, interface, property, value, dbus_interface):
800
testcase.assertEqual(interface, client_interface)
801
testcase.assertEqual(dbus_interface,
802
dbus.PROPERTIES_IFACE)
803
self.attributes[property] = value
804
def Get(self, interface, property, dbus_interface):
805
testcase.assertEqual(interface, client_interface)
806
testcase.assertEqual(dbus_interface,
807
dbus.PROPERTIES_IFACE)
808
return self.attributes[property]
1192
809
def Approve(self, approve, dbus_interface):
1193
testcase.assertEqual(dbus_interface,
1194
client_dbus_interface)
810
testcase.assertEqual(dbus_interface, client_interface)
1195
811
self.calls.append(("Approve", (approve,
1196
812
dbus_interface)))
1197
813
self.client = MockClient(
1237
853
ApprovedByDefault=dbus.Boolean(False),
1238
854
LastApprovalRequest="2019-01-03T00:00:00",
1239
855
ApprovalDelay=30000,
1240
ApprovalDuration=93785000,
856
ApprovalDuration=1000,
1241
857
Checker=":",
1242
858
ExtendedTimeout=900000,
1243
859
Expires="2019-02-05T00:00:00",
1244
860
LastCheckerStatus=-2)
1245
861
self.clients = collections.OrderedDict(
1246
862
[
1247
("/clients/foo", self.client.attributes),
1248
("/clients/barbar", self.other_client.attributes),
863
(self.client, self.client.attributes),
864
(self.other_client, self.other_client.attributes),
1249
865
])
1250
self.one_client = {"/clients/foo": self.client.attributes}
1251
@property
1252
def bus(self):
1253
class Bus(object):
1254
@staticmethod
1255
def get_object(client_bus_name, path):
1256
self.assertEqual(client_bus_name, dbus_busname)
1257
return {
1258
"/clients/foo": self.client,
1259
"/clients/barbar": self.other_client,
1260
}[path]
1261
return Bus()
1262
1263
1264
class TestIsEnabledCmd(TestCmd):
1265
def test_is_enabled(self):
1266
self.assertTrue(all(IsEnabledCmd().is_enabled(client,
1267
properties)
1268
for client, properties
1269
in self.clients.items()))
1270
def test_is_enabled_run_exits_successfully(self):
1271
with self.assertRaises(SystemExit) as e:
1272
IsEnabledCmd().run(self.one_client)
1273
if e.exception.code is not None:
1274
self.assertEqual(e.exception.code, 0)
1275
else:
1276
self.assertIsNone(e.exception.code)
1277
def test_is_enabled_run_exits_with_failure(self):
1278
self.client.attributes["Enabled"] = dbus.Boolean(False)
1279
with self.assertRaises(SystemExit) as e:
1280
IsEnabledCmd().run(self.one_client)
1281
if isinstance(e.exception.code, int):
1282
self.assertNotEqual(e.exception.code, 0)
1283
else:
1284
self.assertIsNotNone(e.exception.code)
1285
1286
1287
class TestApproveCmd(TestCmd):
1288
def test_approve(self):
1289
ApproveCmd().run(self.clients, self.bus)
1290
for clientpath in self.clients:
1291
client = self.bus.get_object(dbus_busname, clientpath)
1292
self.assertIn(("Approve", (True, client_dbus_interface)),
1293
client.calls)
1294
1295
1296
class TestDenyCmd(TestCmd):
1297
def test_deny(self):
1298
DenyCmd().run(self.clients, self.bus)
1299
for clientpath in self.clients:
1300
client = self.bus.get_object(dbus_busname, clientpath)
1301
self.assertIn(("Approve", (False, client_dbus_interface)),
1302
client.calls)
1303
1304
class TestRemoveCmd(TestCmd):
1305
def test_remove(self):
1306
class MockMandos(object):
1307
def __init__(self):
1308
self.calls = []
1309
def RemoveClient(self, dbus_path):
1310
self.calls.append(("RemoveClient", (dbus_path,)))
1311
mandos = MockMandos()
1312
super(TestRemoveCmd, self).setUp()
1313
RemoveCmd().run(self.clients, self.bus, mandos)
1314
self.assertEqual(len(mandos.calls), 2)
1315
for clientpath in self.clients:
1316
self.assertIn(("RemoveClient", (clientpath,)),
1317
mandos.calls)
1318
866
self.one_client = {self.client: self.client.attributes}
867
868
class TestPrintTableCmd(TestCmd):
869
def test_normal(self):
870
output = PrintTableCmd().output(self.clients)
871
expected_output = """
872
Name Enabled Timeout Last Successful Check
873
foo Yes 00:05:00 2019-02-03T00:00:00
874
barbar Yes 00:05:00 2019-02-04T00:00:00
875
"""[1:-1]
876
self.assertEqual(output, expected_output)
877
def test_verbose(self):
878
output = PrintTableCmd(verbose=True).output(self.clients)
879
expected_output = """
880
Name Enabled Timeout Last Successful Check Created Interval Host Key ID Fingerprint Check Is Running Last Enabled Approval Is Pending Approved By Default Last Approval Request Approval Delay Approval Duration Checker Extended Timeout Expires Last Checker Status
881
foo Yes 00:05:00 2019-02-03T00:00:00 2019-01-02T00:00:00 00:02:00 foo.example.org 92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8ea90a27cddb12 778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 No 2019-01-03T00:00:00 No Yes 00:00:00 00:00:01 fping -q -- %(host)s 00:15:00 2019-02-04T00:00:00 0
882
barbar Yes 00:05:00 2019-02-04T00:00:00 2019-01-03T00:00:00 00:02:00 192.0.2.3 0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e46c2b020f441c 3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 Yes 2019-01-04T00:00:00 No No 2019-01-03T00:00:00 00:00:30 00:00:01 : 00:15:00 2019-02-05T00:00:00 -2
883
"""[1:-1]
884
self.assertEqual(output, expected_output)
885
def test_one_client(self):
886
output = PrintTableCmd().output(self.one_client)
887
expected_output = """
888
Name Enabled Timeout Last Successful Check
889
foo Yes 00:05:00 2019-02-03T00:00:00
890
"""[1:-1]
891
self.assertEqual(output, expected_output)
1319
892
1320
893
class TestDumpJSONCmd(TestCmd):
1321
894
def setUp(self):
1362
935
"ApprovedByDefault": False,
1363
936
"LastApprovalRequest": "2019-01-03T00:00:00",
1364
937
"ApprovalDelay": 30000,
1365
"ApprovalDuration": 93785000,
938
"ApprovalDuration": 1000,
1366
939
"Checker": ":",
1367
940
"ExtendedTimeout": 900000,
1368
941
"Expires": "2019-02-05T00:00:00",
1379
952
expected_json = {"foo": self.expected_json["foo"]}
1380
953
self.assertDictEqual(json_data, expected_json)
1381
954
1382
1383
class TestPrintTableCmd(TestCmd):
1384
def test_normal(self):
1385
output = PrintTableCmd().output(self.clients.values())
1386
expected_output = "\n".join((
1387
"Name Enabled Timeout Last Successful Check",
1388
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1389
"barbar Yes 00:05:00 2019-02-04T00:00:00 ",
1390
))
1391
self.assertEqual(output, expected_output)
1392
def test_verbose(self):
1393
output = PrintTableCmd(verbose=True).output(
1394
self.clients.values())
1395
columns = (
1396
(
1397
"Name ",
1398
"foo ",
1399
"barbar ",
1400
),(
1401
"Enabled ",
1402
"Yes ",
1403
"Yes ",
1404
),(
1405
"Timeout ",
1406
"00:05:00 ",
1407
"00:05:00 ",
1408
),(
1409
"Last Successful Check ",
1410
"2019-02-03T00:00:00 ",
1411
"2019-02-04T00:00:00 ",
1412
),(
1413
"Created ",
1414
"2019-01-02T00:00:00 ",
1415
"2019-01-03T00:00:00 ",
1416
),(
1417
"Interval ",
1418
"00:02:00 ",
1419
"00:02:00 ",
1420
),(
1421
"Host ",
1422
"foo.example.org ",
1423
"192.0.2.3 ",
1424
),(
1425
("Key ID "
1426
" "),
1427
("92ed150794387c03ce684574b1139a6594a34f895daaaf09fd8"
1428
"ea90a27cddb12 "),
1429
("0558568eedd67d622f5c83b35a115f796ab612cff5ad227247e"
1430
"46c2b020f441c "),
1431
),(
1432
"Fingerprint ",
1433
"778827225BA7DE539C5A7CFA59CFF7CDBD9A5920 ",
1434
"3E393AEAEFB84C7E89E2F547B3A107558FCA3A27 ",
1435
),(
1436
"Check Is Running ",
1437
"No ",
1438
"Yes ",
1439
),(
1440
"Last Enabled ",
1441
"2019-01-03T00:00:00 ",
1442
"2019-01-04T00:00:00 ",
1443
),(
1444
"Approval Is Pending ",
1445
"No ",
1446
"No ",
1447
),(
1448
"Approved By Default ",
1449
"Yes ",
1450
"No ",
1451
),(
1452
"Last Approval Request ",
1453
" ",
1454
"2019-01-03T00:00:00 ",
1455
),(
1456
"Approval Delay ",
1457
"00:00:00 ",
1458
"00:00:30 ",
1459
),(
1460
"Approval Duration ",
1461
"00:00:01 ",
1462
"1T02:03:05 ",
1463
),(
1464
"Checker ",
1465
"fping -q -- %(host)s ",
1466
": ",
1467
),(
1468
"Extended Timeout ",
1469
"00:15:00 ",
1470
"00:15:00 ",
1471
),(
1472
"Expires ",
1473
"2019-02-04T00:00:00 ",
1474
"2019-02-05T00:00:00 ",
1475
),(
1476
"Last Checker Status",
1477
"0 ",
1478
"-2 ",
1479
)
1480
)
1481
num_lines = max(len(rows) for rows in columns)
1482
expected_output = "\n".join("".join(rows[line]
1483
for rows in columns)
1484
for line in range(num_lines))
1485
self.assertEqual(output, expected_output)
1486
def test_one_client(self):
1487
output = PrintTableCmd().output(self.one_client.values())
1488
expected_output = "\n".join((
1489
"Name Enabled Timeout Last Successful Check",
1490
"foo Yes 00:05:00 2019-02-03T00:00:00 ",
1491
))
1492
self.assertEqual(output, expected_output)
1493
955
class TestIsEnabledCmd(TestCmd):
956
def test_is_enabled(self):
957
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
958
for client, properties in self.clients.items()))
959
def test_is_enabled_run_exits_successfully(self):
960
with self.assertRaises(SystemExit) as e:
961
IsEnabledCmd().run(None, self.one_client)
962
if e.exception.code is not None:
963
self.assertEqual(e.exception.code, 0)
964
else:
965
self.assertIsNone(e.exception.code)
966
def test_is_enabled_run_exits_with_failure(self):
967
self.client.attributes["Enabled"] = dbus.Boolean(False)
968
with self.assertRaises(SystemExit) as e:
969
IsEnabledCmd().run(None, self.one_client)
970
if isinstance(e.exception.code, int):
971
self.assertNotEqual(e.exception.code, 0)
972
else:
973
self.assertIsNotNone(e.exception.code)
974
975
class TestRemoveCmd(TestCmd):
976
def test_remove(self):
977
class MockMandos(object):
978
def __init__(self):
979
self.calls = []
980
def RemoveClient(self, dbus_path):
981
self.calls.append(("RemoveClient", (dbus_path,)))
982
mandos = MockMandos()
983
super(TestRemoveCmd, self).setUp()
984
RemoveCmd().run(mandos, self.clients)
985
self.assertEqual(len(mandos.calls), 2)
986
for client in self.clients:
987
self.assertIn(("RemoveClient",
988
(client.__dbus_object_path__,)),
989
mandos.calls)
990
991
class TestApproveCmd(TestCmd):
992
def test_approve(self):
993
ApproveCmd().run(None, self.clients)
994
for client in self.clients:
995
self.assertIn(("Approve", (True, client_interface)),
996
client.calls)
997
998
class TestDenyCmd(TestCmd):
999
def test_deny(self):
1000
DenyCmd().run(None, self.clients)
1001
for client in self.clients:
1002
self.assertIn(("Approve", (False, client_interface)),
1003
client.calls)
1004
1005
class TestEnableCmd(TestCmd):
1006
def test_enable(self):
1007
for client in self.clients:
1008
client.attributes["Enabled"] = False
1009
1010
EnableCmd().run(None, self.clients)
1011
1012
for client in self.clients:
1013
self.assertTrue(client.attributes["Enabled"])
1014
1015
class TestDisableCmd(TestCmd):
1016
def test_disable(self):
1017
DisableCmd().run(None, self.clients)
1018
1019
for client in self.clients:
1020
self.assertFalse(client.attributes["Enabled"])
1494
1021
1495
1022
class Unique(object):
1496
1023
"""Class for objects which exist only to be unique objects, since
1497
1024
unittest.mock.sentinel only exists in Python 3.3"""
1498
1025
1499
1500
1026
class TestPropertyCmd(TestCmd):
1501
1027
"""Abstract class for tests of PropertyCmd classes"""
1502
1028
def runTest(self):
1506
1032
self.values_to_set)
1507
1033
for value_to_set, value_to_get in zip(self.values_to_set,
1508
1034
values_to_get):
1509
for clientpath in self.clients:
1510
client = self.bus.get_object(dbus_busname, clientpath)
1511
old_value = client.attributes[self.propname]
1035
for client in self.clients:
1036
old_value = client.attributes[self.property]
1512
1037
self.assertNotIsInstance(old_value, Unique)
1513
client.attributes[self.propname] = Unique()
1038
client.attributes[self.property] = Unique()
1514
1039
self.run_command(value_to_set, self.clients)
1515
for clientpath in self.clients:
1516
client = self.bus.get_object(dbus_busname, clientpath)
1517
value = client.attributes[self.propname]
1040
for client in self.clients:
1041
value = client.attributes[self.property]
1518
1042
self.assertNotIsInstance(value, Unique)
1519
1043
self.assertEqual(value, value_to_get)
1520
1044
def run_command(self, value, clients):
1521
self.command().run(clients, self.bus)
1522
1523
1524
class TestEnableCmd(TestCmd):
1525
def test_enable(self):
1526
for clientpath in self.clients:
1527
client = self.bus.get_object(dbus_busname, clientpath)
1528
client.attributes["Enabled"] = False
1529
1530
EnableCmd().run(self.clients, self.bus)
1531
1532
for clientpath in self.clients:
1533
client = self.bus.get_object(dbus_busname, clientpath)
1534
self.assertTrue(client.attributes["Enabled"])
1535
1536
1537
class TestDisableCmd(TestCmd):
1538
def test_disable(self):
1539
DisableCmd().run(self.clients, self.bus)
1540
for clientpath in self.clients:
1541
client = self.bus.get_object(dbus_busname, clientpath)
1542
self.assertFalse(client.attributes["Enabled"])
1543
1045
self.command().run(None, clients)
1544
1046
1545
1047
class TestBumpTimeoutCmd(TestPropertyCmd):
1546
1048
command = BumpTimeoutCmd
1547
propname = "LastCheckedOK"
1049
property = "LastCheckedOK"
1548
1050
values_to_set = [""]
1549
1051
1550
1551
1052
class TestStartCheckerCmd(TestPropertyCmd):
1552
1053
command = StartCheckerCmd
1553
propname = "CheckerRunning"
1054
property = "CheckerRunning"
1554
1055
values_to_set = [dbus.Boolean(True)]
1555
1056
1556
1557
1057
class TestStopCheckerCmd(TestPropertyCmd):
1558
1058
command = StopCheckerCmd
1559
propname = "CheckerRunning"
1059
property = "CheckerRunning"
1560
1060
values_to_set = [dbus.Boolean(False)]
1561
1061
1562
1563
1062
class TestApproveByDefaultCmd(TestPropertyCmd):
1564
1063
command = ApproveByDefaultCmd
1565
propname = "ApprovedByDefault"
1064
property = "ApprovedByDefault"
1566
1065
values_to_set = [dbus.Boolean(True)]
1567
1066
1568
1569
1067
class TestDenyByDefaultCmd(TestPropertyCmd):
1570
1068
command = DenyByDefaultCmd
1571
propname = "ApprovedByDefault"
1069
property = "ApprovedByDefault"
1572
1070
values_to_set = [dbus.Boolean(False)]
1573
1071
1574
1575
class TestPropertyValueCmd(TestPropertyCmd):
1576
"""Abstract class for tests of PropertyValueCmd classes"""
1072
class TestValueArgumentPropertyCmd(TestPropertyCmd):
1073
"""Abstract class for tests of PropertyCmd classes using the
1074
ValueArgumentMixIn"""
1577
1075
def runTest(self):
1578
if type(self) is TestPropertyValueCmd:
1076
if type(self) is TestValueArgumentPropertyCmd:
1579
1077
return
1580
return super(TestPropertyValueCmd, self).runTest()
1078
return super(TestValueArgumentPropertyCmd, self).runTest()
1581
1079
def run_command(self, value, clients):
1582
self.command(value).run(clients, self.bus)
1583
1584
1585
class TestSetCheckerCmd(TestPropertyValueCmd):
1080
self.command(value).run(None, clients)
1081
1082
class TestSetCheckerCmd(TestValueArgumentPropertyCmd):
1586
1083
command = SetCheckerCmd
1587
propname = "Checker"
1084
property = "Checker"
1588
1085
values_to_set = ["", ":", "fping -q -- %s"]
1589
1086
1590
1591
class TestSetHostCmd(TestPropertyValueCmd):
1087
class TestSetHostCmd(TestValueArgumentPropertyCmd):
1592
1088
command = SetHostCmd
1593
propname = "Host"
1089
property = "Host"
1594
1090
values_to_set = ["192.0.2.3", "foo.example.org"]
1595
1091
1596
1597
class TestSetSecretCmd(TestPropertyValueCmd):
1092
class TestSetSecretCmd(TestValueArgumentPropertyCmd):
1598
1093
command = SetSecretCmd
1599
propname = "Secret"
1600
values_to_set = [io.BytesIO(b""),
1094
property = "Secret"
1095
values_to_set = [open("/dev/null", "rb"),
1601
1096
io.BytesIO(b"secret\0xyzzy\nbar")]
1602
1097
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1603
1098
1604
1605
class TestSetTimeoutCmd(TestPropertyValueCmd):
1099
class TestSetTimeoutCmd(TestValueArgumentPropertyCmd):
1606
1100
command = SetTimeoutCmd
1607
propname = "Timeout"
1608
values_to_set = [datetime.timedelta(),
1609
datetime.timedelta(minutes=5),
1610
datetime.timedelta(seconds=1),
1611
datetime.timedelta(weeks=1),
1612
datetime.timedelta(weeks=52)]
1613
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1614
1615
1616
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1101
property = "Timeout"
1102
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1103
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1104
1105
class TestSetExtendedTimeoutCmd(TestValueArgumentPropertyCmd):
1617
1106
command = SetExtendedTimeoutCmd
1618
propname = "ExtendedTimeout"
1619
values_to_set = [datetime.timedelta(),
1620
datetime.timedelta(minutes=5),
1621
datetime.timedelta(seconds=1),
1622
datetime.timedelta(weeks=1),
1623
datetime.timedelta(weeks=52)]
1624
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1625
1626
1627
class TestSetIntervalCmd(TestPropertyValueCmd):
1107
property = "ExtendedTimeout"
1108
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1109
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1110
1111
class TestSetIntervalCmd(TestValueArgumentPropertyCmd):
1628
1112
command = SetIntervalCmd
1629
propname = "Interval"
1630
values_to_set = [datetime.timedelta(),
1631
datetime.timedelta(minutes=5),
1632
datetime.timedelta(seconds=1),
1633
datetime.timedelta(weeks=1),
1634
datetime.timedelta(weeks=52)]
1635
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1636
1637
1638
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1113
property = "Interval"
1114
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1115
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1116
1117
class TestSetApprovalDelayCmd(TestValueArgumentPropertyCmd):
1639
1118
command = SetApprovalDelayCmd
1640
propname = "ApprovalDelay"
1641
values_to_set = [datetime.timedelta(),
1642
datetime.timedelta(minutes=5),
1643
datetime.timedelta(seconds=1),
1644
datetime.timedelta(weeks=1),
1645
datetime.timedelta(weeks=52)]
1646
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1647
1648
1649
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1119
property = "ApprovalDelay"
1120
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1121
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1122
1123
class TestSetApprovalDurationCmd(TestValueArgumentPropertyCmd):
1650
1124
command = SetApprovalDurationCmd
1651
propname = "ApprovalDuration"
1652
values_to_set = [datetime.timedelta(),
1653
datetime.timedelta(minutes=5),
1654
datetime.timedelta(seconds=1),
1655
datetime.timedelta(weeks=1),
1656
datetime.timedelta(weeks=52)]
1657
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1125
property = "ApprovalDuration"
1126
values_to_set = ["P0D", "PT5M", "PT1S", "PT120S", "P1Y"]
1127
values_to_get = [0, 300000, 1000, 120000, 31449600000]
1128
1129
class TestOptions(unittest.TestCase):
1130
def setUp(self):
1131
self.parser = argparse.ArgumentParser()
1132
add_command_line_options(self.parser)
1133
def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1134
"""Assert that parsing ARGS should result in an instance of
1135
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1136
options = self.parser.parse_args(args)
1137
commands = commands_from_options(options)
1138
self.assertEqual(len(commands), 1)
1139
command = commands[0]
1140
self.assertIsInstance(command, command_cls)
1141
for key, value in cmd_attrs.items():
1142
self.assertEqual(getattr(command, key), value)
1143
def test_default_is_show_table(self):
1144
self.assert_command_from_args([], PrintTableCmd,
1145
verbose=False)
1146
def test_show_table_verbose(self):
1147
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1148
verbose=True)
1149
def test_enable(self):
1150
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1151
def test_disable(self):
1152
self.assert_command_from_args(["--disable", "foo"],
1153
DisableCmd)
1658
1154
1659
1155
1660
1156
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0