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