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