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