/mandos/trunk

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

  • Committer: Teddy Hogeborn
  • Date: 2018-04-01 19:31:31 UTC
  • Revision ID: teddy@recompile.se-20180401193131-w8but5r9ryne9et4
Print a boolean more readably in error message output

* plugins.d/mandos-client.c (pgp_packet_decrypt): If decryption fails,
  print wrong_key_usage as "Yes" or "No", not a number.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8; after-save-hook: (lambda () (let ((command (if (and (boundp 'tramp-file-name-structure) (string-match (car tramp-file-name-structure) (buffer-file-name))) (tramp-file-name-localname (tramp-dissect-file-name (buffer-file-name))) (buffer-file-name)))) (if (= (shell-command (format "%s --check" (shell-quote-argument command)) "*Test*") 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w)) (kill-buffer "*Test*")) (display-buffer "*Test*")))); -*-
 
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
6
 
# Copyright © 2008-2019 Teddy Hogeborn
7
 
# Copyright © 2008-2019 Björn Påhlsson
 
6
# Copyright © 2008-2018 Teddy Hogeborn
 
7
# Copyright © 2008-2018 Björn Påhlsson
8
8
#
9
9
# This file is part of Mandos.
10
10
#
40
40
import os
41
41
import collections
42
42
import json
43
 
import unittest
44
 
import logging
45
43
 
46
44
import dbus
47
45
 
48
 
# Show warnings by default
49
 
if not sys.warnoptions:
50
 
    import warnings
51
 
    warnings.simplefilter("default")
52
 
 
53
 
log = logging.getLogger(sys.argv[0])
54
 
logging.basicConfig(level="INFO", # Show info level messages
55
 
                    format="%(message)s") # Show basic log messages
56
 
 
57
 
logging.captureWarnings(True)   # Show warnings via the logging system
58
 
 
59
46
if sys.version_info.major == 2:
60
47
    str = unicode
61
48
 
62
49
locale.setlocale(locale.LC_ALL, "")
63
50
 
 
51
tablewords = {
 
52
    "Name": "Name",
 
53
    "Enabled": "Enabled",
 
54
    "Timeout": "Timeout",
 
55
    "LastCheckedOK": "Last Successful Check",
 
56
    "LastApprovalRequest": "Last Approval Request",
 
57
    "Created": "Created",
 
58
    "Interval": "Interval",
 
59
    "Host": "Host",
 
60
    "Fingerprint": "Fingerprint",
 
61
    "CheckerRunning": "Check Is Running",
 
62
    "LastEnabled": "Last Enabled",
 
63
    "ApprovalPending": "Approval Is Pending",
 
64
    "ApprovedByDefault": "Approved By Default",
 
65
    "ApprovalDelay": "Approval Delay",
 
66
    "ApprovalDuration": "Approval Duration",
 
67
    "Checker": "Checker",
 
68
    "ExtendedTimeout": "Extended Timeout",
 
69
    "Expires": "Expires",
 
70
    "LastCheckerStatus": "Last Checker Status",
 
71
}
 
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
73
domain = "se.recompile"
65
74
busname = domain + ".Mandos"
66
75
server_path = "/"
67
76
server_interface = domain + ".Mandos"
68
77
client_interface = domain + ".Mandos.Client"
69
 
version = "1.8.3"
 
78
version = "1.7.19"
70
79
 
71
80
 
72
81
try:
93
102
    datetime.timedelta(0, 60)
94
103
    >>> rfc3339_duration_to_delta("PT60M")
95
104
    datetime.timedelta(0, 3600)
96
 
    >>> rfc3339_duration_to_delta("P60M")
97
 
    datetime.timedelta(1680)
98
105
    >>> rfc3339_duration_to_delta("PT24H")
99
106
    datetime.timedelta(1)
100
107
    >>> rfc3339_duration_to_delta("P1W")
103
110
    datetime.timedelta(0, 330)
104
111
    >>> rfc3339_duration_to_delta("P1DT3M20S")
105
112
    datetime.timedelta(1, 200)
106
 
    >>> # Can not be empty:
107
 
    >>> rfc3339_duration_to_delta("")
108
 
    Traceback (most recent call last):
109
 
    ...
110
 
    ValueError: Invalid RFC 3339 duration: u''
111
 
    >>> # Must start with "P":
112
 
    >>> rfc3339_duration_to_delta("1D")
113
 
    Traceback (most recent call last):
114
 
    ...
115
 
    ValueError: Invalid RFC 3339 duration: u'1D'
116
 
    >>> # Must use correct order
117
 
    >>> rfc3339_duration_to_delta("PT1S2M")
118
 
    Traceback (most recent call last):
119
 
    ...
120
 
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
121
 
    >>> # Time needs time marker
122
 
    >>> rfc3339_duration_to_delta("P1H2S")
123
 
    Traceback (most recent call last):
124
 
    ...
125
 
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
126
 
    >>> # Weeks can not be combined with anything else
127
 
    >>> rfc3339_duration_to_delta("P1D2W")
128
 
    Traceback (most recent call last):
129
 
    ...
130
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
131
 
    >>> rfc3339_duration_to_delta("P2W2H")
132
 
    Traceback (most recent call last):
133
 
    ...
134
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
135
113
    """
136
114
 
137
115
    # Parsing an RFC 3339 duration with regular expressions is not
215
193
 
216
194
 
217
195
def string_to_delta(interval):
218
 
    """Parse a string and return a datetime.timedelta"""
 
196
    """Parse a string and return a datetime.timedelta
 
197
 
 
198
    >>> string_to_delta('7d')
 
199
    datetime.timedelta(7)
 
200
    >>> string_to_delta('60s')
 
201
    datetime.timedelta(0, 60)
 
202
    >>> string_to_delta('60m')
 
203
    datetime.timedelta(0, 3600)
 
204
    >>> string_to_delta('24h')
 
205
    datetime.timedelta(1)
 
206
    >>> string_to_delta('1w')
 
207
    datetime.timedelta(7)
 
208
    >>> string_to_delta('5m 30s')
 
209
    datetime.timedelta(0, 330)
 
210
    """
219
211
 
220
212
    try:
221
213
        return rfc3339_duration_to_delta(interval)
222
 
    except ValueError as e:
223
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
224
 
                    ' '.join(e.args))
225
 
    return parse_pre_1_6_1_interval(interval)
226
 
 
227
 
 
228
 
def parse_pre_1_6_1_interval(interval):
229
 
    """Parse an interval string as documented by Mandos before 1.6.1,
230
 
    and return a datetime.timedelta
231
 
 
232
 
    >>> parse_pre_1_6_1_interval('7d')
233
 
    datetime.timedelta(7)
234
 
    >>> parse_pre_1_6_1_interval('60s')
235
 
    datetime.timedelta(0, 60)
236
 
    >>> parse_pre_1_6_1_interval('60m')
237
 
    datetime.timedelta(0, 3600)
238
 
    >>> parse_pre_1_6_1_interval('24h')
239
 
    datetime.timedelta(1)
240
 
    >>> parse_pre_1_6_1_interval('1w')
241
 
    datetime.timedelta(7)
242
 
    >>> parse_pre_1_6_1_interval('5m 30s')
243
 
    datetime.timedelta(0, 330)
244
 
    >>> parse_pre_1_6_1_interval('')
245
 
    datetime.timedelta(0)
246
 
    >>> # Ignore unknown characters, allow any order and repetitions
247
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
248
 
    datetime.timedelta(2, 480, 18000)
249
 
 
250
 
    """
 
214
    except ValueError:
 
215
        pass
251
216
 
252
217
    value = datetime.timedelta(0)
253
218
    regexp = re.compile(r"(\d+)([dsmhw]?)")
268
233
    return value
269
234
 
270
235
 
271
 
## Classes for commands.
272
 
 
273
 
# Abstract classes first
274
 
class Command(object):
275
 
    """Abstract class for commands"""
276
 
    def run(self, mandos, clients):
277
 
        """Normal commands should implement run_on_one_client(), but
278
 
        commands which want to operate on all clients at the same time
279
 
        can override this run() method instead."""
280
 
        self.mandos = mandos
281
 
        for client in clients:
282
 
            self.run_on_one_client(client)
283
 
 
284
 
class PrintCmd(Command):
285
 
    """Abstract class for commands printing client details"""
286
 
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
287
 
                    "Created", "Interval", "Host", "KeyID",
288
 
                    "Fingerprint", "CheckerRunning", "LastEnabled",
289
 
                    "ApprovalPending", "ApprovedByDefault",
290
 
                    "LastApprovalRequest", "ApprovalDelay",
291
 
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
292
 
                    "Expires", "LastCheckerStatus")
293
 
    def run(self, mandos, clients):
294
 
        print(self.output(clients))
295
 
 
296
 
class PropertyCmd(Command):
297
 
    """Abstract class for Actions for setting one client property"""
298
 
    def run_on_one_client(self, client):
299
 
        """Set the Client's D-Bus property"""
300
 
        client.Set(client_interface, self.property, self.value_to_set,
301
 
                   dbus_interface=dbus.PROPERTIES_IFACE)
302
 
 
303
 
class ValueArgumentMixIn(object):
304
 
    """Mixin class for commands taking a value as argument"""
305
 
    def __init__(self, value):
306
 
        self.value_to_set = value
307
 
 
308
 
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
309
 
    """Mixin class for commands taking a value argument as
310
 
    milliseconds."""
311
 
    @property
312
 
    def value_to_set(self):
313
 
        return self._vts
314
 
    @value_to_set.setter
315
 
    def value_to_set(self, value):
316
 
        """When setting, convert value to a datetime.timedelta"""
317
 
        self._vts = string_to_delta(value).total_seconds() * 1000
318
 
 
319
 
# Actual (non-abstract) command classes
320
 
 
321
 
class PrintTableCmd(PrintCmd):
322
 
    def __init__(self, verbose=False):
323
 
        self.verbose = verbose
324
 
 
325
 
    def output(self, clients):
326
 
        if self.verbose:
327
 
            keywords = self.all_keywords
328
 
        else:
329
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
330
 
        return str(self.TableOfClients(clients.values(), keywords))
331
 
 
332
 
    class TableOfClients(object):
333
 
        tableheaders = {
334
 
            "Name": "Name",
335
 
            "Enabled": "Enabled",
336
 
            "Timeout": "Timeout",
337
 
            "LastCheckedOK": "Last Successful Check",
338
 
            "LastApprovalRequest": "Last Approval Request",
339
 
            "Created": "Created",
340
 
            "Interval": "Interval",
341
 
            "Host": "Host",
342
 
            "Fingerprint": "Fingerprint",
343
 
            "KeyID": "Key ID",
344
 
            "CheckerRunning": "Check Is Running",
345
 
            "LastEnabled": "Last Enabled",
346
 
            "ApprovalPending": "Approval Is Pending",
347
 
            "ApprovedByDefault": "Approved By Default",
348
 
            "ApprovalDelay": "Approval Delay",
349
 
            "ApprovalDuration": "Approval Duration",
350
 
            "Checker": "Checker",
351
 
            "ExtendedTimeout": "Extended Timeout",
352
 
            "Expires": "Expires",
353
 
            "LastCheckerStatus": "Last Checker Status",
354
 
        }
355
 
 
356
 
        def __init__(self, clients, keywords, tableheaders=None):
357
 
            self.clients = clients
358
 
            self.keywords = keywords
359
 
            if tableheaders is not None:
360
 
                self.tableheaders = tableheaders
361
 
 
362
 
        def __str__(self):
363
 
            return "\n".join(self.rows())
364
 
 
365
 
        if sys.version_info.major == 2:
366
 
            __unicode__ = __str__
367
 
            def __str__(self):
368
 
                return str(self).encode(locale.getpreferredencoding())
369
 
 
370
 
        def rows(self):
371
 
            format_string = self.row_formatting_string()
372
 
            rows = [self.header_line(format_string)]
373
 
            rows.extend(self.client_line(client, format_string)
374
 
                        for client in self.clients)
375
 
            return rows
376
 
 
377
 
        def row_formatting_string(self):
378
 
            "Format string used to format table rows"
379
 
            return " ".join("{{{key}:{width}}}".format(
380
 
                width=max(len(self.tableheaders[key]),
381
 
                          *(len(self.string_from_client(client, key))
382
 
                            for client in self.clients)),
383
 
                key=key)
384
 
                            for key in self.keywords)
385
 
 
386
 
        def string_from_client(self, client, key):
387
 
            return self.valuetostring(client[key], key)
388
 
 
389
 
        @staticmethod
390
 
        def valuetostring(value, keyword):
391
 
            if isinstance(value, dbus.Boolean):
392
 
                return "Yes" if value else "No"
393
 
            if keyword in ("Timeout", "Interval", "ApprovalDelay",
394
 
                           "ApprovalDuration", "ExtendedTimeout"):
395
 
                return milliseconds_to_string(value)
396
 
            return str(value)
397
 
 
398
 
        def header_line(self, format_string):
399
 
            return format_string.format(**self.tableheaders)
400
 
 
401
 
        def client_line(self, client, format_string):
402
 
            return format_string.format(
403
 
                **{key: self.string_from_client(client, key)
404
 
                   for key in self.keywords})
405
 
 
406
 
 
407
 
 
408
 
class DumpJSONCmd(PrintCmd):
409
 
    def output(self, clients):
410
 
        data = {client["Name"]:
411
 
                {key: self.dbus_boolean_to_bool(client[key])
412
 
                 for key in self.all_keywords}
413
 
                for client in clients.values()}
414
 
        return json.dumps(data, indent=4, separators=(',', ': '))
415
 
    @staticmethod
416
 
    def dbus_boolean_to_bool(value):
417
 
        if isinstance(value, dbus.Boolean):
418
 
            value = bool(value)
419
 
        return value
420
 
 
421
 
class IsEnabledCmd(Command):
422
 
    def run_on_one_client(self, client):
423
 
        if self.is_enabled(client):
424
 
            sys.exit(0)
425
 
        sys.exit(1)
426
 
    def is_enabled(self, client):
427
 
        return client.Get(client_interface, "Enabled",
428
 
                          dbus_interface=dbus.PROPERTIES_IFACE)
429
 
 
430
 
class RemoveCmd(Command):
431
 
    def run_on_one_client(self, client):
432
 
        self.mandos.RemoveClient(client.__dbus_object_path__)
433
 
 
434
 
class ApproveCmd(Command):
435
 
    def run_on_one_client(self, client):
436
 
        client.Approve(dbus.Boolean(True),
437
 
                       dbus_interface=client_interface)
438
 
 
439
 
class DenyCmd(Command):
440
 
    def run_on_one_client(self, client):
441
 
        client.Approve(dbus.Boolean(False),
442
 
                       dbus_interface=client_interface)
443
 
 
444
 
class EnableCmd(PropertyCmd):
445
 
    property = "Enabled"
446
 
    value_to_set = dbus.Boolean(True)
447
 
 
448
 
class DisableCmd(PropertyCmd):
449
 
    property = "Enabled"
450
 
    value_to_set = dbus.Boolean(False)
451
 
 
452
 
class BumpTimeoutCmd(PropertyCmd):
453
 
    property = "LastCheckedOK"
454
 
    value_to_set = ""
455
 
 
456
 
class StartCheckerCmd(PropertyCmd):
457
 
    property = "CheckerRunning"
458
 
    value_to_set = dbus.Boolean(True)
459
 
 
460
 
class StopCheckerCmd(PropertyCmd):
461
 
    property = "CheckerRunning"
462
 
    value_to_set = dbus.Boolean(False)
463
 
 
464
 
class ApproveByDefaultCmd(PropertyCmd):
465
 
    property = "ApprovedByDefault"
466
 
    value_to_set = dbus.Boolean(True)
467
 
 
468
 
class DenyByDefaultCmd(PropertyCmd):
469
 
    property = "ApprovedByDefault"
470
 
    value_to_set = dbus.Boolean(False)
471
 
 
472
 
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
473
 
    property = "Checker"
474
 
 
475
 
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
476
 
    property = "Host"
477
 
 
478
 
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
479
 
    property = "Secret"
480
 
 
481
 
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
482
 
    property = "Timeout"
483
 
 
484
 
class SetExtendedTimeoutCmd(PropertyCmd,
485
 
                            MillisecondsValueArgumentMixIn):
486
 
    property = "ExtendedTimeout"
487
 
 
488
 
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
489
 
    property = "Interval"
490
 
 
491
 
class SetApprovalDelayCmd(PropertyCmd,
492
 
                          MillisecondsValueArgumentMixIn):
493
 
    property = "ApprovalDelay"
494
 
 
495
 
class SetApprovalDurationCmd(PropertyCmd,
496
 
                             MillisecondsValueArgumentMixIn):
497
 
    property = "ApprovalDuration"
 
236
def print_clients(clients, keywords):
 
237
    def valuetostring(value, keyword):
 
238
        if type(value) is dbus.Boolean:
 
239
            return "Yes" if value else "No"
 
240
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
241
                       "ApprovalDuration", "ExtendedTimeout"):
 
242
            return milliseconds_to_string(value)
 
243
        return str(value)
 
244
 
 
245
    # Create format string to print table rows
 
246
    format_string = " ".join("{{{key}:{width}}}".format(
 
247
        width=max(len(tablewords[key]),
 
248
                  max(len(valuetostring(client[key], key))
 
249
                      for client in clients)),
 
250
        key=key)
 
251
                             for key in keywords)
 
252
    # Print header line
 
253
    print(format_string.format(**tablewords))
 
254
    for client in clients:
 
255
        print(format_string
 
256
              .format(**{key: valuetostring(client[key], key)
 
257
                         for key in keywords}))
 
258
 
498
259
 
499
260
def has_actions(options):
500
261
    return any((options.enable,
517
278
                options.deny))
518
279
 
519
280
 
520
 
def commands_and_clients_from_options(args=None):
521
 
    if args is None:
522
 
        args=sys.argv[1:]
 
281
def main():
523
282
    parser = argparse.ArgumentParser()
524
283
    parser.add_argument("--version", action="version",
525
284
                        version="%(prog)s {}".format(version),
530
289
                        help="Print all fields")
531
290
    parser.add_argument("-j", "--dump-json", action="store_true",
532
291
                        help="Dump client data in JSON format")
533
 
    enable_disable = parser.add_mutually_exclusive_group()
534
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
535
 
                                help="Enable client")
536
 
    enable_disable.add_argument("-d", "--disable",
537
 
                                action="store_true",
538
 
                                help="disable client")
 
292
    parser.add_argument("-e", "--enable", action="store_true",
 
293
                        help="Enable client")
 
294
    parser.add_argument("-d", "--disable", action="store_true",
 
295
                        help="disable client")
539
296
    parser.add_argument("-b", "--bump-timeout", action="store_true",
540
297
                        help="Bump timeout for client")
541
 
    start_stop_checker = parser.add_mutually_exclusive_group()
542
 
    start_stop_checker.add_argument("--start-checker",
543
 
                                    action="store_true",
544
 
                                    help="Start checker for client")
545
 
    start_stop_checker.add_argument("--stop-checker",
546
 
                                    action="store_true",
547
 
                                    help="Stop checker for client")
 
298
    parser.add_argument("--start-checker", action="store_true",
 
299
                        help="Start checker for client")
 
300
    parser.add_argument("--stop-checker", action="store_true",
 
301
                        help="Stop checker for client")
548
302
    parser.add_argument("-V", "--is-enabled", action="store_true",
549
303
                        help="Check if client is enabled")
550
304
    parser.add_argument("-r", "--remove", action="store_true",
557
311
                        help="Set extended timeout for client")
558
312
    parser.add_argument("-i", "--interval",
559
313
                        help="Set checker interval for client")
560
 
    approve_deny_default = parser.add_mutually_exclusive_group()
561
 
    approve_deny_default.add_argument(
562
 
        "--approve-by-default", action="store_true",
563
 
        default=None, dest="approved_by_default",
564
 
        help="Set client to be approved by default")
565
 
    approve_deny_default.add_argument(
566
 
        "--deny-by-default", action="store_false",
567
 
        dest="approved_by_default",
568
 
        help="Set client to be denied by default")
 
314
    parser.add_argument("--approve-by-default", action="store_true",
 
315
                        default=None, dest="approved_by_default",
 
316
                        help="Set client to be approved by default")
 
317
    parser.add_argument("--deny-by-default", action="store_false",
 
318
                        dest="approved_by_default",
 
319
                        help="Set client to be denied by default")
569
320
    parser.add_argument("--approval-delay",
570
321
                        help="Set delay before client approve/deny")
571
322
    parser.add_argument("--approval-duration",
574
325
    parser.add_argument("-s", "--secret",
575
326
                        type=argparse.FileType(mode="rb"),
576
327
                        help="Set password blob (file) for client")
577
 
    approve_deny = parser.add_mutually_exclusive_group()
578
 
    approve_deny.add_argument(
579
 
        "-A", "--approve", action="store_true",
580
 
        help="Approve any current client request")
581
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
582
 
                              help="Deny any current client request")
 
328
    parser.add_argument("-A", "--approve", action="store_true",
 
329
                        help="Approve any current client request")
 
330
    parser.add_argument("-D", "--deny", action="store_true",
 
331
                        help="Deny any current client request")
583
332
    parser.add_argument("--check", action="store_true",
584
333
                        help="Run self-test")
585
334
    parser.add_argument("client", nargs="*", help="Client name")
586
 
    options = parser.parse_args(args=args)
 
335
    options = parser.parse_args()
587
336
 
588
337
    if has_actions(options) and not (options.client or options.all):
589
338
        parser.error("Options require clients names or --all.")
594
343
        parser.error("--dump-json can only be used alone.")
595
344
    if options.all and not has_actions(options):
596
345
        parser.error("--all requires an action.")
597
 
    if options.is_enabled and len(options.client) > 1:
598
 
            parser.error("--is-enabled requires exactly one client")
599
 
 
600
 
    commands = []
601
 
 
602
 
    if options.dump_json:
603
 
        commands.append(DumpJSONCmd())
604
 
 
605
 
    if options.enable:
606
 
        commands.append(EnableCmd())
607
 
 
608
 
    if options.disable:
609
 
        commands.append(DisableCmd())
610
 
 
611
 
    if options.bump_timeout:
612
 
        commands.append(BumpTimeoutCmd(options.bump_timeout))
613
 
 
614
 
    if options.start_checker:
615
 
        commands.append(StartCheckerCmd())
616
 
 
617
 
    if options.stop_checker:
618
 
        commands.append(StopCheckerCmd())
619
 
 
620
 
    if options.is_enabled:
621
 
        commands.append(IsEnabledCmd())
622
 
 
623
 
    if options.remove:
624
 
        commands.append(RemoveCmd())
625
 
 
626
 
    if options.checker is not None:
627
 
        commands.append(SetCheckerCmd())
628
 
 
629
 
    if options.timeout is not None:
630
 
        commands.append(SetTimeoutCmd(options.timeout))
631
 
 
632
 
    if options.extended_timeout:
633
 
        commands.append(
634
 
            SetExtendedTimeoutCmd(options.extended_timeout))
635
 
 
636
 
    if options.interval is not None:
637
 
        command.append(SetIntervalCmd(options.interval))
638
 
 
639
 
    if options.approved_by_default is not None:
640
 
        if options.approved_by_default:
641
 
            command.append(ApproveByDefaultCmd())
642
 
        else:
643
 
            command.append(DenyByDefaultCmd())
644
 
 
645
 
    if options.approval_delay is not None:
646
 
        command.append(SetApprovalDelayCmd(options.approval_delay))
647
 
 
648
 
    if options.approval_duration is not None:
649
 
        command.append(
650
 
            SetApprovalDurationCmd(options.approval_duration))
651
 
 
652
 
    if options.host is not None:
653
 
        command.append(SetHostCmd(options.host))
654
 
 
655
 
    if options.secret is not None:
656
 
        command.append(SetSecretCmd(options.secret))
657
 
 
658
 
    if options.approve:
659
 
        commands.append(ApproveCmd())
660
 
 
661
 
    if options.deny:
662
 
        commands.append(DenyCmd())
663
 
 
664
 
    # If no command option has been given, show table of clients,
665
 
    # optionally verbosely
666
 
    if not commands:
667
 
        commands.append(PrintTableCmd(verbose=options.verbose))
668
 
 
669
 
    return commands, options.client
670
 
 
671
 
 
672
 
def main():
673
 
    commands, clientnames = commands_and_clients_from_options()
 
346
 
 
347
    if options.check:
 
348
        import doctest
 
349
        fail_count, test_count = doctest.testmod()
 
350
        sys.exit(os.EX_OK if fail_count == 0 else 1)
674
351
 
675
352
    try:
676
353
        bus = dbus.SystemBus()
677
354
        mandos_dbus_objc = bus.get_object(busname, server_path)
678
355
    except dbus.exceptions.DBusException:
679
 
        log.critical("Could not connect to Mandos server")
 
356
        print("Could not connect to Mandos server", file=sys.stderr)
680
357
        sys.exit(1)
681
358
 
682
359
    mandos_serv = dbus.Interface(mandos_dbus_objc,
684
361
    mandos_serv_object_manager = dbus.Interface(
685
362
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
686
363
 
687
 
    # Filter out log message from dbus module
688
 
    dbus_logger = logging.getLogger("dbus.proxies")
689
 
    class NullFilter(logging.Filter):
690
 
        def filter(self, record):
691
 
            return False
692
 
    dbus_filter = NullFilter()
693
 
    dbus_logger.addFilter(dbus_filter)
 
364
    # block stderr since dbus library prints to stderr
 
365
    null = os.open(os.path.devnull, os.O_RDWR)
 
366
    stderrcopy = os.dup(sys.stderr.fileno())
 
367
    os.dup2(null, sys.stderr.fileno())
 
368
    os.close(null)
694
369
    try:
695
370
        try:
696
371
            mandos_clients = {path: ifs_and_props[client_interface]
699
374
                              .GetManagedObjects().items()
700
375
                              if client_interface in ifs_and_props}
701
376
        finally:
702
 
            # restore dbus logger
703
 
            dbus_logger.removeFilter(dbus_filter)
 
377
            # restore stderr
 
378
            os.dup2(stderrcopy, sys.stderr.fileno())
 
379
            os.close(stderrcopy)
704
380
    except dbus.exceptions.DBusException as e:
705
 
        log.critical("Failed to access Mandos server through D-Bus:"
706
 
                     "\n%s", e)
 
381
        print("Access denied: "
 
382
              "Accessing mandos server through D-Bus: {}".format(e),
 
383
              file=sys.stderr)
707
384
        sys.exit(1)
708
385
 
709
386
    # Compile dict of (clients: properties) to process
710
387
    clients = {}
711
388
 
712
 
    if not clientnames:
 
389
    if options.all or not options.client:
713
390
        clients = {bus.get_object(busname, path): properties
714
391
                   for path, properties in mandos_clients.items()}
715
392
    else:
716
 
        for name in clientnames:
 
393
        for name in options.client:
717
394
            for path, client in mandos_clients.items():
718
395
                if client["Name"] == name:
719
396
                    client_objc = bus.get_object(busname, path)
720
397
                    clients[client_objc] = client
721
398
                    break
722
399
            else:
723
 
                log.critical("Client not found on server: %r", name)
 
400
                print("Client not found on server: {!r}"
 
401
                      .format(name), file=sys.stderr)
724
402
                sys.exit(1)
725
403
 
726
 
    # Run all commands on clients
727
 
    for command in commands:
728
 
        command.run(mandos_serv, clients)
729
 
 
730
 
 
731
 
class Test_milliseconds_to_string(unittest.TestCase):
732
 
    def test_all(self):
733
 
        self.assertEqual(milliseconds_to_string(93785000),
734
 
                         "1T02:03:05")
735
 
    def test_no_days(self):
736
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
737
 
    def test_all_zero(self):
738
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
739
 
    def test_no_fractional_seconds(self):
740
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
741
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
742
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
743
 
 
744
 
class Test_string_to_delta(unittest.TestCase):
745
 
    def test_handles_basic_rfc3339(self):
746
 
        self.assertEqual(string_to_delta("PT2H"),
747
 
                         datetime.timedelta(0, 7200))
748
 
    def test_falls_back_to_pre_1_6_1_with_warning(self):
749
 
        # assertLogs only exists in Python 3.4
750
 
        if hasattr(self, "assertLogs"):
751
 
            with self.assertLogs(log, logging.WARNING):
752
 
                value = string_to_delta("2h")
753
 
        else:
754
 
            class WarningFilter(logging.Filter):
755
 
                """Don't show, but record the presence of, warnings"""
756
 
                def filter(self, record):
757
 
                    is_warning = record.levelno >= logging.WARNING
758
 
                    self.found = is_warning or getattr(self, "found",
759
 
                                                       False)
760
 
                    return not is_warning
761
 
            warning_filter = WarningFilter()
762
 
            log.addFilter(warning_filter)
763
 
            try:
764
 
                value = string_to_delta("2h")
765
 
            finally:
766
 
                log.removeFilter(warning_filter)
767
 
            self.assertTrue(getattr(warning_filter, "found", False))
768
 
        self.assertEqual(value, datetime.timedelta(0, 7200))
769
 
 
770
 
 
771
 
class TestCmd(unittest.TestCase):
772
 
    """Abstract class for tests of command classes"""
773
 
    def setUp(self):
774
 
        testcase = self
775
 
        class MockClient(object):
776
 
            def __init__(self, name, **attributes):
777
 
                self.__dbus_object_path__ = "objpath_{}".format(name)
778
 
                self.attributes = attributes
779
 
                self.attributes["Name"] = name
780
 
                self.calls = []
781
 
            def Set(self, interface, property, value, dbus_interface):
782
 
                testcase.assertEqual(interface, client_interface)
783
 
                testcase.assertEqual(dbus_interface,
784
 
                                     dbus.PROPERTIES_IFACE)
785
 
                self.attributes[property] = value
786
 
                self.calls.append(("Set", (interface, property, value,
787
 
                                           dbus_interface)))
788
 
            def Get(self, interface, property, dbus_interface):
789
 
                testcase.assertEqual(interface, client_interface)
790
 
                testcase.assertEqual(dbus_interface,
791
 
                                     dbus.PROPERTIES_IFACE)
792
 
                self.calls.append(("Get", (interface, property,
793
 
                                           dbus_interface)))
794
 
                return self.attributes[property]
795
 
            def __getitem__(self, key):
796
 
                return self.attributes[key]
797
 
            def __setitem__(self, key, value):
798
 
                self.attributes[key] = value
799
 
        self.clients = collections.OrderedDict([
800
 
            ("foo",
801
 
             MockClient(
802
 
                 "foo",
803
 
                 KeyID=("92ed150794387c03ce684574b1139a65"
804
 
                        "94a34f895daaaf09fd8ea90a27cddb12"),
805
 
                 Secret=b"secret",
806
 
                 Host="foo.example.org",
807
 
                 Enabled=dbus.Boolean(True),
808
 
                 Timeout=300000,
809
 
                 LastCheckedOK="2019-02-03T00:00:00",
810
 
                 Created="2019-01-02T00:00:00",
811
 
                 Interval=120000,
812
 
                 Fingerprint=("778827225BA7DE539C5A"
813
 
                              "7CFA59CFF7CDBD9A5920"),
814
 
                 CheckerRunning=dbus.Boolean(False),
815
 
                 LastEnabled="2019-01-03T00:00:00",
816
 
                 ApprovalPending=dbus.Boolean(False),
817
 
                 ApprovedByDefault=dbus.Boolean(True),
818
 
                 LastApprovalRequest="",
819
 
                 ApprovalDelay=0,
820
 
                 ApprovalDuration=1000,
821
 
                 Checker="fping -q -- %(host)s",
822
 
                 ExtendedTimeout=900000,
823
 
                 Expires="2019-02-04T00:00:00",
824
 
                 LastCheckerStatus=0)),
825
 
            ("barbar",
826
 
             MockClient(
827
 
                 "barbar",
828
 
                 KeyID=("0558568eedd67d622f5c83b35a115f79"
829
 
                        "6ab612cff5ad227247e46c2b020f441c"),
830
 
                 Secret=b"secretbar",
831
 
                 Host="192.0.2.3",
832
 
                 Enabled=dbus.Boolean(True),
833
 
                 Timeout=300000,
834
 
                 LastCheckedOK="2019-02-04T00:00:00",
835
 
                 Created="2019-01-03T00:00:00",
836
 
                 Interval=120000,
837
 
                 Fingerprint=("3E393AEAEFB84C7E89E2"
838
 
                              "F547B3A107558FCA3A27"),
839
 
                 CheckerRunning=dbus.Boolean(True),
840
 
                 LastEnabled="2019-01-04T00:00:00",
841
 
                 ApprovalPending=dbus.Boolean(False),
842
 
                 ApprovedByDefault=dbus.Boolean(False),
843
 
                 LastApprovalRequest="2019-01-03T00:00:00",
844
 
                 ApprovalDelay=30000,
845
 
                 ApprovalDuration=1000,
846
 
                 Checker=":",
847
 
                 ExtendedTimeout=900000,
848
 
                 Expires="2019-02-05T00:00:00",
849
 
                 LastCheckerStatus=-2)),
850
 
            ])
851
 
 
852
 
class TestPrintTableCmd(TestCmd):
853
 
    def test_normal(self):
854
 
        output = PrintTableCmd().output(self.clients)
855
 
        expected_output = """
856
 
Name   Enabled Timeout  Last Successful Check
857
 
foo    Yes     00:05:00 2019-02-03T00:00:00  
858
 
barbar Yes     00:05:00 2019-02-04T00:00:00  
859
 
"""[1:-1]
860
 
        self.assertEqual(output, expected_output)
861
 
    def test_verbose(self):
862
 
        output = PrintTableCmd(verbose=True).output(self.clients)
863
 
        expected_output = """
864
 
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
865
 
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                  
866
 
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                 
867
 
"""[1:-1]
868
 
        self.assertEqual(output, expected_output)
869
 
    def test_one_client(self):
870
 
        output = PrintTableCmd().output({"foo": self.clients["foo"]})
871
 
        expected_output = """
872
 
Name Enabled Timeout  Last Successful Check
873
 
foo  Yes     00:05:00 2019-02-03T00:00:00  
874
 
"""[1:-1]
875
 
        self.assertEqual(output, expected_output)
876
 
 
877
 
class TestDumpJSONCmd(TestCmd):
878
 
    def setUp(self):
879
 
        self.expected_json = {
880
 
            "foo": {
881
 
                "Name": "foo",
882
 
                "KeyID": ("92ed150794387c03ce684574b1139a65"
883
 
                          "94a34f895daaaf09fd8ea90a27cddb12"),
884
 
                "Host": "foo.example.org",
885
 
                "Enabled": True,
886
 
                "Timeout": 300000,
887
 
                "LastCheckedOK": "2019-02-03T00:00:00",
888
 
                "Created": "2019-01-02T00:00:00",
889
 
                "Interval": 120000,
890
 
                "Fingerprint": ("778827225BA7DE539C5A"
891
 
                                "7CFA59CFF7CDBD9A5920"),
892
 
                "CheckerRunning": False,
893
 
                "LastEnabled": "2019-01-03T00:00:00",
894
 
                "ApprovalPending": False,
895
 
                "ApprovedByDefault": True,
896
 
                "LastApprovalRequest": "",
897
 
                "ApprovalDelay": 0,
898
 
                "ApprovalDuration": 1000,
899
 
                "Checker": "fping -q -- %(host)s",
900
 
                "ExtendedTimeout": 900000,
901
 
                "Expires": "2019-02-04T00:00:00",
902
 
                "LastCheckerStatus": 0,
903
 
            },
904
 
            "barbar": {
905
 
                "Name": "barbar",
906
 
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
907
 
                          "6ab612cff5ad227247e46c2b020f441c"),
908
 
                "Host": "192.0.2.3",
909
 
                "Enabled": True,
910
 
                "Timeout": 300000,
911
 
                "LastCheckedOK": "2019-02-04T00:00:00",
912
 
                "Created": "2019-01-03T00:00:00",
913
 
                "Interval": 120000,
914
 
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
915
 
                                "F547B3A107558FCA3A27"),
916
 
                "CheckerRunning": True,
917
 
                "LastEnabled": "2019-01-04T00:00:00",
918
 
                "ApprovalPending": False,
919
 
                "ApprovedByDefault": False,
920
 
                "LastApprovalRequest": "2019-01-03T00:00:00",
921
 
                "ApprovalDelay": 30000,
922
 
                "ApprovalDuration": 1000,
923
 
                "Checker": ":",
924
 
                "ExtendedTimeout": 900000,
925
 
                "Expires": "2019-02-05T00:00:00",
926
 
                "LastCheckerStatus": -2,
927
 
            },
928
 
        }
929
 
        return super(TestDumpJSONCmd, self).setUp()
930
 
    def test_normal(self):
931
 
        json_data = json.loads(DumpJSONCmd().output(self.clients))
932
 
        self.assertDictEqual(json_data, self.expected_json)
933
 
    def test_one_client(self):
934
 
        clients = {"foo": self.clients["foo"]}
935
 
        json_data = json.loads(DumpJSONCmd().output(clients))
936
 
        expected_json = {"foo": self.expected_json["foo"]}
937
 
        self.assertDictEqual(json_data, expected_json)
938
 
 
939
 
class TestIsEnabledCmd(TestCmd):
940
 
    def test_is_enabled(self):
941
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client)
942
 
                            for client in self.clients.values()))
943
 
    def test_is_enabled_does_get_attribute(self):
944
 
        client = self.clients["foo"]
945
 
        self.assertTrue(IsEnabledCmd().is_enabled(client))
946
 
        self.assertListEqual(client.calls,
947
 
                             [("Get",
948
 
                               ("se.recompile.Mandos.Client",
949
 
                                "Enabled",
950
 
                                "org.freedesktop.DBus.Properties"))])
951
 
    def test_is_enabled_run_exits_successfully(self):
952
 
        client = self.clients["foo"]
953
 
        with self.assertRaises(SystemExit) as e:
954
 
            IsEnabledCmd().run_on_one_client(client)
955
 
        if e.exception.code is not None:
956
 
            self.assertEqual(e.exception.code, 0)
957
 
        else:
958
 
            self.assertIsNone(e.exception.code)
959
 
    def test_is_enabled_run_exits_with_failure(self):
960
 
        client = self.clients["foo"]
961
 
        client["Enabled"] = dbus.Boolean(False)
962
 
        with self.assertRaises(SystemExit) as e:
963
 
            IsEnabledCmd().run_on_one_client(client)
964
 
        if isinstance(e.exception.code, int):
965
 
            self.assertNotEqual(e.exception.code, 0)
966
 
        else:
967
 
            self.assertIsNotNone(e.exception.code)
968
 
 
969
 
 
970
 
 
971
 
def should_only_run_tests():
972
 
    parser = argparse.ArgumentParser(add_help=False)
973
 
    parser.add_argument("--check", action='store_true')
974
 
    args, unknown_args = parser.parse_known_args()
975
 
    run_tests = args.check
976
 
    if run_tests:
977
 
        # Remove --check argument from sys.argv
978
 
        sys.argv[1:] = unknown_args
979
 
    return run_tests
980
 
 
981
 
# Add all tests from doctest strings
982
 
def load_tests(loader, tests, none):
983
 
    import doctest
984
 
    tests.addTests(doctest.DocTestSuite())
985
 
    return tests
 
404
    if not has_actions(options) and clients:
 
405
        if options.verbose or options.dump_json:
 
406
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
407
                        "Created", "Interval", "Host", "Fingerprint",
 
408
                        "CheckerRunning", "LastEnabled",
 
409
                        "ApprovalPending", "ApprovedByDefault",
 
410
                        "LastApprovalRequest", "ApprovalDelay",
 
411
                        "ApprovalDuration", "Checker",
 
412
                        "ExtendedTimeout", "Expires",
 
413
                        "LastCheckerStatus")
 
414
        else:
 
415
            keywords = defaultkeywords
 
416
 
 
417
        if options.dump_json:
 
418
            json.dump({client["Name"]: {key:
 
419
                                        bool(client[key])
 
420
                                        if isinstance(client[key],
 
421
                                                      dbus.Boolean)
 
422
                                        else client[key]
 
423
                                        for key in keywords}
 
424
                       for client in clients.values()},
 
425
                      fp=sys.stdout, indent=4,
 
426
                      separators=(',', ': '))
 
427
            print()
 
428
        else:
 
429
            print_clients(clients.values(), keywords)
 
430
    else:
 
431
        # Process each client in the list by all selected options
 
432
        for client in clients:
 
433
 
 
434
            def set_client_prop(prop, value):
 
435
                """Set a Client D-Bus property"""
 
436
                client.Set(client_interface, prop, value,
 
437
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
438
 
 
439
            def set_client_prop_ms(prop, value):
 
440
                """Set a Client D-Bus property, converted
 
441
                from a string to milliseconds."""
 
442
                set_client_prop(prop,
 
443
                                string_to_delta(value).total_seconds()
 
444
                                * 1000)
 
445
 
 
446
            if options.remove:
 
447
                mandos_serv.RemoveClient(client.__dbus_object_path__)
 
448
            if options.enable:
 
449
                set_client_prop("Enabled", dbus.Boolean(True))
 
450
            if options.disable:
 
451
                set_client_prop("Enabled", dbus.Boolean(False))
 
452
            if options.bump_timeout:
 
453
                set_client_prop("LastCheckedOK", "")
 
454
            if options.start_checker:
 
455
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
456
            if options.stop_checker:
 
457
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
458
            if options.is_enabled:
 
459
                if client.Get(client_interface, "Enabled",
 
460
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
461
                    sys.exit(0)
 
462
                else:
 
463
                    sys.exit(1)
 
464
            if options.checker is not None:
 
465
                set_client_prop("Checker", options.checker)
 
466
            if options.host is not None:
 
467
                set_client_prop("Host", options.host)
 
468
            if options.interval is not None:
 
469
                set_client_prop_ms("Interval", options.interval)
 
470
            if options.approval_delay is not None:
 
471
                set_client_prop_ms("ApprovalDelay",
 
472
                                   options.approval_delay)
 
473
            if options.approval_duration is not None:
 
474
                set_client_prop_ms("ApprovalDuration",
 
475
                                   options.approval_duration)
 
476
            if options.timeout is not None:
 
477
                set_client_prop_ms("Timeout", options.timeout)
 
478
            if options.extended_timeout is not None:
 
479
                set_client_prop_ms("ExtendedTimeout",
 
480
                                   options.extended_timeout)
 
481
            if options.secret is not None:
 
482
                set_client_prop("Secret",
 
483
                                dbus.ByteArray(options.secret.read()))
 
484
            if options.approved_by_default is not None:
 
485
                set_client_prop("ApprovedByDefault",
 
486
                                dbus.Boolean(options
 
487
                                             .approved_by_default))
 
488
            if options.approve:
 
489
                client.Approve(dbus.Boolean(True),
 
490
                               dbus_interface=client_interface)
 
491
            elif options.deny:
 
492
                client.Approve(dbus.Boolean(False),
 
493
                               dbus_interface=client_interface)
 
494
 
986
495
 
987
496
if __name__ == "__main__":
988
 
    if should_only_run_tests():
989
 
        # Call using ./tdd-python-script --check [--verbose]
990
 
        unittest.main()
991
 
    else:
992
 
        main()
 
497
    main()