To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-ctl
- browse files at revision 237.7.606
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.606
- Committer: Teddy Hogeborn
- Date: 2019-03-12 20:29:54 UTC
- mto: This revision was merged to the branch mainline in revision 382.
- Revision ID: teddy@recompile.se-20190312202954-2us36c6j9u5avhm7
mandos-ctl: Refactor
* mandos-ctl (PrintCmd): Rename to "OutputCmd". All users changed.
* mandos-ctl (PrintCmd): Rename to "OutputCmd". All users changed.
- files modified:
- mandos-ctl
added
removed
mandos-ctl
79
79
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
80
80
81
81
82
def milliseconds_to_string(ms):
83
td = datetime.timedelta(0, 0, 0, ms)
84
return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
85
.format(days="{}T".format(td.days) if td.days else "",
86
hours=td.seconds // 3600,
87
minutes=(td.seconds % 3600) // 60,
88
seconds=td.seconds % 60))
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)
89
232
90
233
91
234
def rfc3339_duration_to_delta(duration):
218
361
return value
219
362
220
363
221
def string_to_delta(interval):
222
"""Parse a string and return a datetime.timedelta"""
223
224
try:
225
return rfc3339_duration_to_delta(interval)
226
except ValueError as e:
227
log.warning("%s - Parsing as pre-1.6.1 interval instead",
228
' '.join(e.args))
229
return parse_pre_1_6_1_interval(interval)
230
231
232
364
def parse_pre_1_6_1_interval(interval):
233
365
"""Parse an interval string as documented by Mandos before 1.6.1,
234
366
and return a datetime.timedelta
272
404
return value
273
405
274
406
275
## Classes for commands.
276
277
# Abstract classes first
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
278
523
class Command(object):
279
524
"""Abstract class for commands"""
280
525
def run(self, clients, bus=None, mandos=None):
288
533
client = bus.get_object(dbus_busname, clientpath)
289
534
self.run_on_one_client(client, properties)
290
535
291
class PrintCmd(Command):
292
"""Abstract class for commands printing client details"""
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"""
293
573
all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
294
574
"Created", "Interval", "Host", "KeyID",
295
575
"Fingerprint", "CheckerRunning", "LastEnabled",
302
582
def output(self, clients):
303
583
raise NotImplementedError()
304
584
305
class PropertyCmd(Command):
306
"""Abstract class for Actions for setting one client property"""
307
def run_on_one_client(self, client, properties):
308
"""Set the Client's D-Bus property"""
309
log.debug("D-Bus: %s:%s:%s.Set(%r, %r, %r)", dbus_busname,
310
client.__dbus_object_path__,
311
dbus.PROPERTIES_IFACE, client_dbus_interface,
312
self.propname, self.value_to_set
313
if not isinstance(self.value_to_set, dbus.Boolean)
314
else bool(self.value_to_set))
315
client.Set(client_dbus_interface, self.propname,
316
self.value_to_set,
317
dbus_interface=dbus.PROPERTIES_IFACE)
318
@property
319
def propname(self):
320
raise NotImplementedError()
321
322
class PropertyValueCmd(PropertyCmd):
323
"""Abstract class for PropertyCmd recieving a value as argument"""
324
def __init__(self, value):
325
self.value_to_set = value
326
327
class MillisecondsPropertyValueArgumentCmd(PropertyValueCmd):
328
"""Abstract class for PropertyValueCmd taking a value argument as
329
a datetime.timedelta() but should store it as milliseconds."""
330
@property
331
def value_to_set(self):
332
return self._vts
333
@value_to_set.setter
334
def value_to_set(self, value):
335
"""When setting, convert value from a datetime.timedelta"""
336
self._vts = int(round(value.total_seconds() * 1000))
337
338
# Actual (non-abstract) command classes
339
340
class PrintTableCmd(PrintCmd):
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):
341
601
def __init__(self, verbose=False):
342
602
self.verbose = verbose
343
603
344
604
def output(self, clients):
345
default_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
605
default_keywords = ("Name", "Enabled", "Timeout",
606
"LastCheckedOK")
346
607
keywords = default_keywords
347
608
if self.verbose:
348
609
keywords = self.all_keywords
405
666
def string_from_client(self, client, key):
406
667
return self.valuetostring(client[key], key)
407
668
408
@staticmethod
409
def valuetostring(value, keyword):
669
@classmethod
670
def valuetostring(cls, value, keyword):
410
671
if isinstance(value, dbus.Boolean):
411
672
return "Yes" if value else "No"
412
673
if keyword in ("Timeout", "Interval", "ApprovalDelay",
413
674
"ApprovalDuration", "ExtendedTimeout"):
414
return milliseconds_to_string(value)
675
return cls.milliseconds_to_string(value)
415
676
return str(value)
416
677
417
678
def header_line(self, format_string):
422
683
**{key: self.string_from_client(client, key)
423
684
for key in self.keywords})
424
685
425
426
427
class DumpJSONCmd(PrintCmd):
428
def output(self, clients):
429
data = {client["Name"]:
430
{key: self.dbus_boolean_to_bool(client[key])
431
for key in self.all_keywords}
432
for client in clients.values()}
433
return json.dumps(data, indent=4, separators=(',', ': '))
434
@staticmethod
435
def dbus_boolean_to_bool(value):
436
if isinstance(value, dbus.Boolean):
437
value = bool(value)
438
return value
439
440
class IsEnabledCmd(Command):
441
def run(self, clients, bus=None, mandos=None):
442
client, properties = next(iter(clients.items()))
443
if self.is_enabled(client, properties):
444
sys.exit(0)
445
sys.exit(1)
446
def is_enabled(self, client, properties):
447
return properties["Enabled"]
448
449
class RemoveCmd(Command):
450
def run_on_one_client(self, client, properties):
451
log.debug("D-Bus: %s:%s:%s.RemoveClient(%r)", dbus_busname,
452
server_dbus_path, server_dbus_interface,
453
str(client.__dbus_object_path__))
454
self.mandos.RemoveClient(client.__dbus_object_path__)
455
456
class ApproveCmd(Command):
457
def run_on_one_client(self, client, properties):
458
log.debug("D-Bus: %s:%s:%s.Approve(True)", dbus_busname,
459
client.__dbus_object_path__, client_dbus_interface)
460
client.Approve(dbus.Boolean(True),
461
dbus_interface=client_dbus_interface)
462
463
class DenyCmd(Command):
464
def run_on_one_client(self, client, properties):
465
log.debug("D-Bus: %s:%s:%s.Approve(False)", dbus_busname,
466
client.__dbus_object_path__, client_dbus_interface)
467
client.Approve(dbus.Boolean(False),
468
dbus_interface=client_dbus_interface)
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
469
714
470
715
class EnableCmd(PropertyCmd):
471
716
propname = "Enabled"
472
717
value_to_set = dbus.Boolean(True)
473
718
719
474
720
class DisableCmd(PropertyCmd):
475
721
propname = "Enabled"
476
722
value_to_set = dbus.Boolean(False)
477
723
724
478
725
class BumpTimeoutCmd(PropertyCmd):
479
726
propname = "LastCheckedOK"
480
727
value_to_set = ""
481
728
729
482
730
class StartCheckerCmd(PropertyCmd):
483
731
propname = "CheckerRunning"
484
732
value_to_set = dbus.Boolean(True)
485
733
734
486
735
class StopCheckerCmd(PropertyCmd):
487
736
propname = "CheckerRunning"
488
737
value_to_set = dbus.Boolean(False)
489
738
739
490
740
class ApproveByDefaultCmd(PropertyCmd):
491
741
propname = "ApprovedByDefault"
492
742
value_to_set = dbus.Boolean(True)
493
743
744
494
745
class DenyByDefaultCmd(PropertyCmd):
495
746
propname = "ApprovedByDefault"
496
747
value_to_set = dbus.Boolean(False)
497
748
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
498
756
class SetCheckerCmd(PropertyValueCmd):
499
757
propname = "Checker"
500
758
759
501
760
class SetHostCmd(PropertyValueCmd):
502
761
propname = "Host"
503
762
763
504
764
class SetSecretCmd(PropertyValueCmd):
505
765
propname = "Secret"
506
766
@property
512
772
self._vts = value.read()
513
773
value.close()
514
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
515
788
class SetTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
516
789
propname = "Timeout"
517
790
791
518
792
class SetExtendedTimeoutCmd(MillisecondsPropertyValueArgumentCmd):
519
793
propname = "ExtendedTimeout"
520
794
795
521
796
class SetIntervalCmd(MillisecondsPropertyValueArgumentCmd):
522
797
propname = "Interval"
523
798
799
524
800
class SetApprovalDelayCmd(MillisecondsPropertyValueArgumentCmd):
525
801
propname = "ApprovalDelay"
526
802
803
527
804
class SetApprovalDurationCmd(MillisecondsPropertyValueArgumentCmd):
528
805
propname = "ApprovalDuration"
529
806
530
def add_command_line_options(parser):
531
parser.add_argument("--version", action="version",
532
version="%(prog)s {}".format(version),
533
help="show version number and exit")
534
parser.add_argument("-a", "--all", action="store_true",
535
help="Select all clients")
536
parser.add_argument("-v", "--verbose", action="store_true",
537
help="Print all fields")
538
parser.add_argument("-j", "--dump-json", action="store_true",
539
help="Dump client data in JSON format")
540
enable_disable = parser.add_mutually_exclusive_group()
541
enable_disable.add_argument("-e", "--enable", action="store_true",
542
help="Enable client")
543
enable_disable.add_argument("-d", "--disable",
544
action="store_true",
545
help="disable client")
546
parser.add_argument("-b", "--bump-timeout", action="store_true",
547
help="Bump timeout for client")
548
start_stop_checker = parser.add_mutually_exclusive_group()
549
start_stop_checker.add_argument("--start-checker",
550
action="store_true",
551
help="Start checker for client")
552
start_stop_checker.add_argument("--stop-checker",
553
action="store_true",
554
help="Stop checker for client")
555
parser.add_argument("-V", "--is-enabled", action="store_true",
556
help="Check if client is enabled")
557
parser.add_argument("-r", "--remove", action="store_true",
558
help="Remove client")
559
parser.add_argument("-c", "--checker",
560
help="Set checker command for client")
561
parser.add_argument("-t", "--timeout", type=string_to_delta,
562
help="Set timeout for client")
563
parser.add_argument("--extended-timeout", type=string_to_delta,
564
help="Set extended timeout for client")
565
parser.add_argument("-i", "--interval", type=string_to_delta,
566
help="Set checker interval for client")
567
approve_deny_default = parser.add_mutually_exclusive_group()
568
approve_deny_default.add_argument(
569
"--approve-by-default", action="store_true",
570
default=None, dest="approved_by_default",
571
help="Set client to be approved by default")
572
approve_deny_default.add_argument(
573
"--deny-by-default", action="store_false",
574
dest="approved_by_default",
575
help="Set client to be denied by default")
576
parser.add_argument("--approval-delay", type=string_to_delta,
577
help="Set delay before client approve/deny")
578
parser.add_argument("--approval-duration", type=string_to_delta,
579
help="Set duration of one client approval")
580
parser.add_argument("-H", "--host", help="Set host for client")
581
parser.add_argument("-s", "--secret",
582
type=argparse.FileType(mode="rb"),
583
help="Set password blob (file) for client")
584
approve_deny = parser.add_mutually_exclusive_group()
585
approve_deny.add_argument(
586
"-A", "--approve", action="store_true",
587
help="Approve any current client request")
588
approve_deny.add_argument("-D", "--deny", action="store_true",
589
help="Deny any current client request")
590
parser.add_argument("--debug", action="store_true",
591
help="Debug mode (show D-Bus commands)")
592
parser.add_argument("--check", action="store_true",
593
help="Run self-test")
594
parser.add_argument("client", nargs="*", help="Client name")
595
596
597
def commands_from_options(options):
598
599
commands = []
600
601
if options.dump_json:
602
commands.append(DumpJSONCmd())
603
604
if options.enable:
605
commands.append(EnableCmd())
606
607
if options.disable:
608
commands.append(DisableCmd())
609
610
if options.bump_timeout:
611
commands.append(BumpTimeoutCmd())
612
613
if options.start_checker:
614
commands.append(StartCheckerCmd())
615
616
if options.stop_checker:
617
commands.append(StopCheckerCmd())
618
619
if options.is_enabled:
620
commands.append(IsEnabledCmd())
621
622
if options.checker is not None:
623
commands.append(SetCheckerCmd(options.checker))
624
625
if options.timeout is not None:
626
commands.append(SetTimeoutCmd(options.timeout))
627
628
if options.extended_timeout:
629
commands.append(
630
SetExtendedTimeoutCmd(options.extended_timeout))
631
632
if options.interval is not None:
633
commands.append(SetIntervalCmd(options.interval))
634
635
if options.approved_by_default is not None:
636
if options.approved_by_default:
637
commands.append(ApproveByDefaultCmd())
638
else:
639
commands.append(DenyByDefaultCmd())
640
641
if options.approval_delay is not None:
642
commands.append(SetApprovalDelayCmd(options.approval_delay))
643
644
if options.approval_duration is not None:
645
commands.append(
646
SetApprovalDurationCmd(options.approval_duration))
647
648
if options.host is not None:
649
commands.append(SetHostCmd(options.host))
650
651
if options.secret is not None:
652
commands.append(SetSecretCmd(options.secret))
653
654
if options.approve:
655
commands.append(ApproveCmd())
656
657
if options.deny:
658
commands.append(DenyCmd())
659
660
if options.remove:
661
commands.append(RemoveCmd())
662
663
# If no command option has been given, show table of clients,
664
# optionally verbosely
665
if not commands:
666
commands.append(PrintTableCmd(verbose=options.verbose))
667
668
return commands
669
670
671
def check_option_syntax(parser, options):
672
"""Apply additional restrictions on options, not expressible in
673
argparse"""
674
675
def has_actions(options):
676
return any((options.enable,
677
options.disable,
678
options.bump_timeout,
679
options.start_checker,
680
options.stop_checker,
681
options.is_enabled,
682
options.remove,
683
options.checker is not None,
684
options.timeout is not None,
685
options.extended_timeout is not None,
686
options.interval is not None,
687
options.approved_by_default is not None,
688
options.approval_delay is not None,
689
options.approval_duration is not None,
690
options.host is not None,
691
options.secret is not None,
692
options.approve,
693
options.deny))
694
695
if has_actions(options) and not (options.client or options.all):
696
parser.error("Options require clients names or --all.")
697
if options.verbose and has_actions(options):
698
parser.error("--verbose can only be used alone.")
699
if options.dump_json and (options.verbose
700
or has_actions(options)):
701
parser.error("--dump-json can only be used alone.")
702
if options.all and not has_actions(options):
703
parser.error("--all requires an action.")
704
if options.is_enabled and len(options.client) > 1:
705
parser.error("--is-enabled requires exactly one client")
706
if options.remove:
707
options.remove = False
708
if has_actions(options) and not options.deny:
709
parser.error("--remove can only be combined with --deny")
710
options.remove = True
711
712
713
def main():
714
parser = argparse.ArgumentParser()
715
716
add_command_line_options(parser)
717
718
options = parser.parse_args()
719
720
check_option_syntax(parser, options)
721
722
clientnames = options.client
723
724
if options.debug:
725
log.setLevel(logging.DEBUG)
726
727
try:
728
bus = dbus.SystemBus()
729
log.debug("D-Bus: Connect to: (busname=%r, path=%r)",
730
dbus_busname, server_dbus_path)
731
mandos_dbus_objc = bus.get_object(dbus_busname,
732
server_dbus_path)
733
except dbus.exceptions.DBusException:
734
log.critical("Could not connect to Mandos server")
735
sys.exit(1)
736
737
mandos_serv = dbus.Interface(mandos_dbus_objc,
738
dbus_interface=server_dbus_interface)
739
mandos_serv_object_manager = dbus.Interface(
740
mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
741
742
# Filter out log message from dbus module
743
dbus_logger = logging.getLogger("dbus.proxies")
744
class NullFilter(logging.Filter):
745
def filter(self, record):
746
return False
747
dbus_filter = NullFilter()
748
try:
749
dbus_logger.addFilter(dbus_filter)
750
log.debug("D-Bus: %s:%s:%s.GetManagedObjects()", dbus_busname,
751
server_dbus_path, dbus.OBJECT_MANAGER_IFACE)
752
mandos_clients = {path: ifs_and_props[client_dbus_interface]
753
for path, ifs_and_props in
754
mandos_serv_object_manager
755
.GetManagedObjects().items()
756
if client_dbus_interface in ifs_and_props}
757
except dbus.exceptions.DBusException as e:
758
log.critical("Failed to access Mandos server through D-Bus:"
759
"\n%s", e)
760
sys.exit(1)
761
finally:
762
# restore dbus logger
763
dbus_logger.removeFilter(dbus_filter)
764
765
# Compile dict of (clients: properties) to process
766
clients = {}
767
768
if not clientnames:
769
clients = {objpath: properties
770
for objpath, properties in mandos_clients.items()}
771
else:
772
for name in clientnames:
773
for objpath, properties in mandos_clients.items():
774
if properties["Name"] == name:
775
clients[objpath] = properties
776
break
777
else:
778
log.critical("Client not found on server: %r", name)
779
sys.exit(1)
780
781
# Run all commands on clients
782
commands = commands_from_options(options)
783
for command in commands:
784
command.run(clients, bus, mandos_serv)
785
807
786
808
787
class Test_milliseconds_to_string(unittest.TestCase):
788
def test_all(self):
789
self.assertEqual(milliseconds_to_string(93785000),
790
"1T02:03:05")
791
def test_no_days(self):
792
self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
793
def test_all_zero(self):
794
self.assertEqual(milliseconds_to_string(0), "00:00:00")
795
def test_no_fractional_seconds(self):
796
self.assertEqual(milliseconds_to_string(400), "00:00:00")
797
self.assertEqual(milliseconds_to_string(900), "00:00:00")
798
self.assertEqual(milliseconds_to_string(1900), "00:00:01")
799
800
809
class Test_string_to_delta(unittest.TestCase):
801
810
def test_handles_basic_rfc3339(self):
802
811
self.assertEqual(string_to_delta("PT0S"),
830
839
self.assertEqual(value, datetime.timedelta(0, 7200))
831
840
832
841
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
833
1172
class TestCmd(unittest.TestCase):
834
1173
"""Abstract class for tests of command classes"""
835
1174
def setUp(self):
898
1237
ApprovedByDefault=dbus.Boolean(False),
899
1238
LastApprovalRequest="2019-01-03T00:00:00",
900
1239
ApprovalDelay=30000,
901
ApprovalDuration=1000,
1240
ApprovalDuration=93785000,
902
1241
Checker=":",
903
1242
ExtendedTimeout=900000,
904
1243
Expires="2019-02-05T00:00:00",
921
1260
}[path]
922
1261
return Bus()
923
1262
924
class TestPrintTableCmd(TestCmd):
925
def test_normal(self):
926
output = PrintTableCmd().output(self.clients.values())
927
expected_output = """
928
Name Enabled Timeout Last Successful Check
929
foo Yes 00:05:00 2019-02-03T00:00:00
930
barbar Yes 00:05:00 2019-02-04T00:00:00
931
"""[1:-1]
932
self.assertEqual(output, expected_output)
933
def test_verbose(self):
934
output = PrintTableCmd(verbose=True).output(
935
self.clients.values())
936
expected_output = """
937
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
938
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
939
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
940
"""[1:-1]
941
self.assertEqual(output, expected_output)
942
def test_one_client(self):
943
output = PrintTableCmd().output(self.one_client.values())
944
expected_output = """
945
Name Enabled Timeout Last Successful Check
946
foo Yes 00:05:00 2019-02-03T00:00:00
947
"""[1:-1]
948
self.assertEqual(output, expected_output)
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
949
1319
950
1320
class TestDumpJSONCmd(TestCmd):
951
1321
def setUp(self):
992
1362
"ApprovedByDefault": False,
993
1363
"LastApprovalRequest": "2019-01-03T00:00:00",
994
1364
"ApprovalDelay": 30000,
995
"ApprovalDuration": 1000,
1365
"ApprovalDuration": 93785000,
996
1366
"Checker": ":",
997
1367
"ExtendedTimeout": 900000,
998
1368
"Expires": "2019-02-05T00:00:00",
1009
1379
expected_json = {"foo": self.expected_json["foo"]}
1010
1380
self.assertDictEqual(json_data, expected_json)
1011
1381
1012
class TestIsEnabledCmd(TestCmd):
1013
def test_is_enabled(self):
1014
self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
1015
for client, properties in self.clients.items()))
1016
def test_is_enabled_run_exits_successfully(self):
1017
with self.assertRaises(SystemExit) as e:
1018
IsEnabledCmd().run(self.one_client)
1019
if e.exception.code is not None:
1020
self.assertEqual(e.exception.code, 0)
1021
else:
1022
self.assertIsNone(e.exception.code)
1023
def test_is_enabled_run_exits_with_failure(self):
1024
self.client.attributes["Enabled"] = dbus.Boolean(False)
1025
with self.assertRaises(SystemExit) as e:
1026
IsEnabledCmd().run(self.one_client)
1027
if isinstance(e.exception.code, int):
1028
self.assertNotEqual(e.exception.code, 0)
1029
else:
1030
self.assertIsNotNone(e.exception.code)
1031
1032
class TestRemoveCmd(TestCmd):
1033
def test_remove(self):
1034
class MockMandos(object):
1035
def __init__(self):
1036
self.calls = []
1037
def RemoveClient(self, dbus_path):
1038
self.calls.append(("RemoveClient", (dbus_path,)))
1039
mandos = MockMandos()
1040
super(TestRemoveCmd, self).setUp()
1041
RemoveCmd().run(self.clients, self.bus, mandos)
1042
self.assertEqual(len(mandos.calls), 2)
1043
for clientpath in self.clients:
1044
self.assertIn(("RemoveClient", (clientpath,)),
1045
mandos.calls)
1046
1047
class TestApproveCmd(TestCmd):
1048
def test_approve(self):
1049
ApproveCmd().run(self.clients, self.bus)
1050
for clientpath in self.clients:
1051
client = self.bus.get_object(dbus_busname, clientpath)
1052
self.assertIn(("Approve", (True, client_dbus_interface)),
1053
client.calls)
1054
1055
class TestDenyCmd(TestCmd):
1056
def test_deny(self):
1057
DenyCmd().run(self.clients, self.bus)
1058
for clientpath in self.clients:
1059
client = self.bus.get_object(dbus_busname, clientpath)
1060
self.assertIn(("Approve", (False, client_dbus_interface)),
1061
client.calls)
1062
1063
class TestEnableCmd(TestCmd):
1064
def test_enable(self):
1065
for clientpath in self.clients:
1066
client = self.bus.get_object(dbus_busname, clientpath)
1067
client.attributes["Enabled"] = False
1068
1069
EnableCmd().run(self.clients, self.bus)
1070
1071
for clientpath in self.clients:
1072
client = self.bus.get_object(dbus_busname, clientpath)
1073
self.assertTrue(client.attributes["Enabled"])
1074
1075
class TestDisableCmd(TestCmd):
1076
def test_disable(self):
1077
DisableCmd().run(self.clients, self.bus)
1078
for clientpath in self.clients:
1079
client = self.bus.get_object(dbus_busname, clientpath)
1080
self.assertFalse(client.attributes["Enabled"])
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
1081
1494
1082
1495
class Unique(object):
1083
1496
"""Class for objects which exist only to be unique objects, since
1084
1497
unittest.mock.sentinel only exists in Python 3.3"""
1085
1498
1499
1086
1500
class TestPropertyCmd(TestCmd):
1087
1501
"""Abstract class for tests of PropertyCmd classes"""
1088
1502
def runTest(self):
1106
1520
def run_command(self, value, clients):
1107
1521
self.command().run(clients, self.bus)
1108
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
1544
1109
1545
class TestBumpTimeoutCmd(TestPropertyCmd):
1110
1546
command = BumpTimeoutCmd
1111
1547
propname = "LastCheckedOK"
1112
1548
values_to_set = [""]
1113
1549
1550
1114
1551
class TestStartCheckerCmd(TestPropertyCmd):
1115
1552
command = StartCheckerCmd
1116
1553
propname = "CheckerRunning"
1117
1554
values_to_set = [dbus.Boolean(True)]
1118
1555
1556
1119
1557
class TestStopCheckerCmd(TestPropertyCmd):
1120
1558
command = StopCheckerCmd
1121
1559
propname = "CheckerRunning"
1122
1560
values_to_set = [dbus.Boolean(False)]
1123
1561
1562
1124
1563
class TestApproveByDefaultCmd(TestPropertyCmd):
1125
1564
command = ApproveByDefaultCmd
1126
1565
propname = "ApprovedByDefault"
1127
1566
values_to_set = [dbus.Boolean(True)]
1128
1567
1568
1129
1569
class TestDenyByDefaultCmd(TestPropertyCmd):
1130
1570
command = DenyByDefaultCmd
1131
1571
propname = "ApprovedByDefault"
1132
1572
values_to_set = [dbus.Boolean(False)]
1133
1573
1574
1134
1575
class TestPropertyValueCmd(TestPropertyCmd):
1135
1576
"""Abstract class for tests of PropertyValueCmd classes"""
1136
1577
def runTest(self):
1140
1581
def run_command(self, value, clients):
1141
1582
self.command(value).run(clients, self.bus)
1142
1583
1584
1143
1585
class TestSetCheckerCmd(TestPropertyValueCmd):
1144
1586
command = SetCheckerCmd
1145
1587
propname = "Checker"
1146
1588
values_to_set = ["", ":", "fping -q -- %s"]
1147
1589
1590
1148
1591
class TestSetHostCmd(TestPropertyValueCmd):
1149
1592
command = SetHostCmd
1150
1593
propname = "Host"
1151
1594
values_to_set = ["192.0.2.3", "foo.example.org"]
1152
1595
1596
1153
1597
class TestSetSecretCmd(TestPropertyValueCmd):
1154
1598
command = SetSecretCmd
1155
1599
propname = "Secret"
1157
1601
io.BytesIO(b"secret\0xyzzy\nbar")]
1158
1602
values_to_get = [b"", b"secret\0xyzzy\nbar"]
1159
1603
1604
1160
1605
class TestSetTimeoutCmd(TestPropertyValueCmd):
1161
1606
command = SetTimeoutCmd
1162
1607
propname = "Timeout"
1167
1612
datetime.timedelta(weeks=52)]
1168
1613
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1169
1614
1615
1170
1616
class TestSetExtendedTimeoutCmd(TestPropertyValueCmd):
1171
1617
command = SetExtendedTimeoutCmd
1172
1618
propname = "ExtendedTimeout"
1177
1623
datetime.timedelta(weeks=52)]
1178
1624
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1179
1625
1626
1180
1627
class TestSetIntervalCmd(TestPropertyValueCmd):
1181
1628
command = SetIntervalCmd
1182
1629
propname = "Interval"
1187
1634
datetime.timedelta(weeks=52)]
1188
1635
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1189
1636
1637
1190
1638
class TestSetApprovalDelayCmd(TestPropertyValueCmd):
1191
1639
command = SetApprovalDelayCmd
1192
1640
propname = "ApprovalDelay"
1197
1645
datetime.timedelta(weeks=52)]
1198
1646
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1199
1647
1648
1200
1649
class TestSetApprovalDurationCmd(TestPropertyValueCmd):
1201
1650
command = SetApprovalDurationCmd
1202
1651
propname = "ApprovalDuration"
1207
1656
datetime.timedelta(weeks=52)]
1208
1657
values_to_get = [0, 300000, 1000, 604800000, 31449600000]
1209
1658
1210
class Test_command_from_options(unittest.TestCase):
1211
def setUp(self):
1212
self.parser = argparse.ArgumentParser()
1213
add_command_line_options(self.parser)
1214
def assert_command_from_args(self, args, command_cls, **cmd_attrs):
1215
"""Assert that parsing ARGS should result in an instance of
1216
COMMAND_CLS with (optionally) all supplied attributes (CMD_ATTRS)."""
1217
options = self.parser.parse_args(args)
1218
check_option_syntax(self.parser, options)
1219
commands = commands_from_options(options)
1220
self.assertEqual(len(commands), 1)
1221
command = commands[0]
1222
self.assertIsInstance(command, command_cls)
1223
for key, value in cmd_attrs.items():
1224
self.assertEqual(getattr(command, key), value)
1225
def test_print_table(self):
1226
self.assert_command_from_args([], PrintTableCmd,
1227
verbose=False)
1228
1229
def test_print_table_verbose(self):
1230
self.assert_command_from_args(["--verbose"], PrintTableCmd,
1231
verbose=True)
1232
1233
def test_print_table_verbose_short(self):
1234
self.assert_command_from_args(["-v"], PrintTableCmd,
1235
verbose=True)
1236
1237
def test_enable(self):
1238
self.assert_command_from_args(["--enable", "foo"], EnableCmd)
1239
1240
def test_enable_short(self):
1241
self.assert_command_from_args(["-e", "foo"], EnableCmd)
1242
1243
def test_disable(self):
1244
self.assert_command_from_args(["--disable", "foo"],
1245
DisableCmd)
1246
1247
def test_disable_short(self):
1248
self.assert_command_from_args(["-d", "foo"], DisableCmd)
1249
1250
def test_bump_timeout(self):
1251
self.assert_command_from_args(["--bump-timeout", "foo"],
1252
BumpTimeoutCmd)
1253
1254
def test_bump_timeout_short(self):
1255
self.assert_command_from_args(["-b", "foo"], BumpTimeoutCmd)
1256
1257
def test_start_checker(self):
1258
self.assert_command_from_args(["--start-checker", "foo"],
1259
StartCheckerCmd)
1260
1261
def test_stop_checker(self):
1262
self.assert_command_from_args(["--stop-checker", "foo"],
1263
StopCheckerCmd)
1264
1265
def test_remove(self):
1266
self.assert_command_from_args(["--remove", "foo"],
1267
RemoveCmd)
1268
1269
def test_remove_short(self):
1270
self.assert_command_from_args(["-r", "foo"], RemoveCmd)
1271
1272
def test_checker(self):
1273
self.assert_command_from_args(["--checker", ":", "foo"],
1274
SetCheckerCmd, value_to_set=":")
1275
1276
def test_checker_empty(self):
1277
self.assert_command_from_args(["--checker", "", "foo"],
1278
SetCheckerCmd, value_to_set="")
1279
1280
def test_checker_short(self):
1281
self.assert_command_from_args(["-c", ":", "foo"],
1282
SetCheckerCmd, value_to_set=":")
1283
1284
def test_timeout(self):
1285
self.assert_command_from_args(["--timeout", "PT5M", "foo"],
1286
SetTimeoutCmd,
1287
value_to_set=300000)
1288
1289
def test_timeout_short(self):
1290
self.assert_command_from_args(["-t", "PT5M", "foo"],
1291
SetTimeoutCmd,
1292
value_to_set=300000)
1293
1294
def test_extended_timeout(self):
1295
self.assert_command_from_args(["--extended-timeout", "PT15M",
1296
"foo"],
1297
SetExtendedTimeoutCmd,
1298
value_to_set=900000)
1299
1300
def test_interval(self):
1301
self.assert_command_from_args(["--interval", "PT2M", "foo"],
1302
SetIntervalCmd,
1303
value_to_set=120000)
1304
1305
def test_interval_short(self):
1306
self.assert_command_from_args(["-i", "PT2M", "foo"],
1307
SetIntervalCmd,
1308
value_to_set=120000)
1309
1310
def test_approve_by_default(self):
1311
self.assert_command_from_args(["--approve-by-default", "foo"],
1312
ApproveByDefaultCmd)
1313
1314
def test_deny_by_default(self):
1315
self.assert_command_from_args(["--deny-by-default", "foo"],
1316
DenyByDefaultCmd)
1317
1318
def test_approval_delay(self):
1319
self.assert_command_from_args(["--approval-delay", "PT30S",
1320
"foo"], SetApprovalDelayCmd,
1321
value_to_set=30000)
1322
1323
def test_approval_duration(self):
1324
self.assert_command_from_args(["--approval-duration", "PT1S",
1325
"foo"], SetApprovalDurationCmd,
1326
value_to_set=1000)
1327
1328
def test_host(self):
1329
self.assert_command_from_args(["--host", "foo.example.org",
1330
"foo"], SetHostCmd,
1331
value_to_set="foo.example.org")
1332
1333
def test_host_short(self):
1334
self.assert_command_from_args(["-H", "foo.example.org",
1335
"foo"], SetHostCmd,
1336
value_to_set="foo.example.org")
1337
1338
def test_secret_devnull(self):
1339
self.assert_command_from_args(["--secret", os.path.devnull,
1340
"foo"], SetSecretCmd,
1341
value_to_set=b"")
1342
1343
def test_secret_tempfile(self):
1344
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1345
value = b"secret\0xyzzy\nbar"
1346
f.write(value)
1347
f.seek(0)
1348
self.assert_command_from_args(["--secret", f.name,
1349
"foo"], SetSecretCmd,
1350
value_to_set=value)
1351
1352
def test_secret_devnull_short(self):
1353
self.assert_command_from_args(["-s", os.path.devnull, "foo"],
1354
SetSecretCmd, value_to_set=b"")
1355
1356
def test_secret_tempfile_short(self):
1357
with tempfile.NamedTemporaryFile(mode="r+b") as f:
1358
value = b"secret\0xyzzy\nbar"
1359
f.write(value)
1360
f.seek(0)
1361
self.assert_command_from_args(["-s", f.name, "foo"],
1362
SetSecretCmd,
1363
value_to_set=value)
1364
1365
def test_approve(self):
1366
self.assert_command_from_args(["--approve", "foo"],
1367
ApproveCmd)
1368
1369
def test_approve_short(self):
1370
self.assert_command_from_args(["-A", "foo"], ApproveCmd)
1371
1372
def test_deny(self):
1373
self.assert_command_from_args(["--deny", "foo"], DenyCmd)
1374
1375
def test_deny_short(self):
1376
self.assert_command_from_args(["-D", "foo"], DenyCmd)
1377
1378
def test_dump_json(self):
1379
self.assert_command_from_args(["--dump-json"], DumpJSONCmd)
1380
1381
def test_is_enabled(self):
1382
self.assert_command_from_args(["--is-enabled", "foo"],
1383
IsEnabledCmd)
1384
1385
def test_is_enabled_short(self):
1386
self.assert_command_from_args(["-V", "foo"], IsEnabledCmd)
1387
1388
def test_deny_before_remove(self):
1389
options = self.parser.parse_args(["--deny", "--remove", "foo"])
1390
check_option_syntax(self.parser, options)
1391
commands = commands_from_options(options)
1392
self.assertEqual(len(commands), 2)
1393
self.assertIsInstance(commands[0], DenyCmd)
1394
self.assertIsInstance(commands[1], RemoveCmd)
1395
1396
def test_deny_before_remove_reversed(self):
1397
options = self.parser.parse_args(["--remove", "--deny", "--all"])
1398
check_option_syntax(self.parser, options)
1399
commands = commands_from_options(options)
1400
self.assertEqual(len(commands), 2)
1401
self.assertIsInstance(commands[0], DenyCmd)
1402
self.assertIsInstance(commands[1], RemoveCmd)
1403
1404
1405
class Test_check_option_syntax(unittest.TestCase):
1406
# This mostly corresponds to the definition from has_actions() in
1407
# check_option_syntax()
1408
actions = {
1409
# The actual values set here are not that important, but we do
1410
# at least stick to the correct types, even though they are
1411
# never used
1412
"enable": True,
1413
"disable": True,
1414
"bump_timeout": True,
1415
"start_checker": True,
1416
"stop_checker": True,
1417
"is_enabled": True,
1418
"remove": True,
1419
"checker": "x",
1420
"timeout": datetime.timedelta(),
1421
"extended_timeout": datetime.timedelta(),
1422
"interval": datetime.timedelta(),
1423
"approved_by_default": True,
1424
"approval_delay": datetime.timedelta(),
1425
"approval_duration": datetime.timedelta(),
1426
"host": "x",
1427
"secret": io.BytesIO(b"x"),
1428
"approve": True,
1429
"deny": True,
1430
}
1431
1432
def setUp(self):
1433
self.parser = argparse.ArgumentParser()
1434
add_command_line_options(self.parser)
1435
1436
@contextlib.contextmanager
1437
def assertParseError(self):
1438
with self.assertRaises(SystemExit) as e:
1439
with self.temporarily_suppress_stderr():
1440
yield
1441
# Exit code from argparse is guaranteed to be "2". Reference:
1442
# https://docs.python.org/3/library/argparse.html#exiting-methods
1443
self.assertEqual(e.exception.code, 2)
1444
1445
@staticmethod
1446
@contextlib.contextmanager
1447
def temporarily_suppress_stderr():
1448
null = os.open(os.path.devnull, os.O_RDWR)
1449
stderrcopy = os.dup(sys.stderr.fileno())
1450
os.dup2(null, sys.stderr.fileno())
1451
os.close(null)
1452
try:
1453
yield
1454
finally:
1455
# restore stderr
1456
os.dup2(stderrcopy, sys.stderr.fileno())
1457
os.close(stderrcopy)
1458
1459
def check_option_syntax(self, options):
1460
check_option_syntax(self.parser, options)
1461
1462
def test_actions_requires_client_or_all(self):
1463
for action, value in self.actions.items():
1464
options = self.parser.parse_args()
1465
setattr(options, action, value)
1466
with self.assertParseError():
1467
self.check_option_syntax(options)
1468
1469
def test_actions_conflicts_with_verbose(self):
1470
for action, value in self.actions.items():
1471
options = self.parser.parse_args()
1472
setattr(options, action, value)
1473
options.verbose = True
1474
with self.assertParseError():
1475
self.check_option_syntax(options)
1476
1477
def test_dump_json_conflicts_with_verbose(self):
1478
options = self.parser.parse_args()
1479
options.dump_json = True
1480
options.verbose = True
1481
with self.assertParseError():
1482
self.check_option_syntax(options)
1483
1484
def test_dump_json_conflicts_with_action(self):
1485
for action, value in self.actions.items():
1486
options = self.parser.parse_args()
1487
setattr(options, action, value)
1488
options.dump_json = True
1489
with self.assertParseError():
1490
self.check_option_syntax(options)
1491
1492
def test_all_can_not_be_alone(self):
1493
options = self.parser.parse_args()
1494
options.all = True
1495
with self.assertParseError():
1496
self.check_option_syntax(options)
1497
1498
def test_all_is_ok_with_any_action(self):
1499
for action, value in self.actions.items():
1500
options = self.parser.parse_args()
1501
setattr(options, action, value)
1502
options.all = True
1503
self.check_option_syntax(options)
1504
1505
def test_is_enabled_fails_without_client(self):
1506
options = self.parser.parse_args()
1507
options.is_enabled = True
1508
with self.assertParseError():
1509
self.check_option_syntax(options)
1510
1511
def test_is_enabled_works_with_one_client(self):
1512
options = self.parser.parse_args()
1513
options.is_enabled = True
1514
options.client = ["foo"]
1515
self.check_option_syntax(options)
1516
1517
def test_is_enabled_fails_with_two_clients(self):
1518
options = self.parser.parse_args()
1519
options.is_enabled = True
1520
options.client = ["foo", "barbar"]
1521
with self.assertParseError():
1522
self.check_option_syntax(options)
1523
1524
def test_remove_can_only_be_combined_with_action_deny(self):
1525
for action, value in self.actions.items():
1526
if action in {"remove", "deny"}:
1527
continue
1528
options = self.parser.parse_args()
1529
setattr(options, action, value)
1530
options.all = True
1531
options.remove = True
1532
with self.assertParseError():
1533
self.check_option_syntax(options)
1534
1535
1659
1536
1660
1537
1661
def should_only_run_tests():
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0