/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: 2019-02-09 23:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

* clients.conf: Change "/etc/mandos" to "/etc/keys/mandos" where
                appropriate
* mandos-keygen.xml: - '' -

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
    "KeyID": "Key ID",
 
62
    "CheckerRunning": "Check Is Running",
 
63
    "LastEnabled": "Last Enabled",
 
64
    "ApprovalPending": "Approval Is Pending",
 
65
    "ApprovedByDefault": "Approved By Default",
 
66
    "ApprovalDelay": "Approval Delay",
 
67
    "ApprovalDuration": "Approval Duration",
 
68
    "Checker": "Checker",
 
69
    "ExtendedTimeout": "Extended Timeout",
 
70
    "Expires": "Expires",
 
71
    "LastCheckerStatus": "Last Checker Status",
 
72
}
 
73
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
74
domain = "se.recompile"
65
75
busname = domain + ".Mandos"
66
76
server_path = "/"
67
77
server_interface = domain + ".Mandos"
68
78
client_interface = domain + ".Mandos.Client"
69
 
version = "1.8.3"
 
79
version = "1.7.20"
70
80
 
71
81
 
72
82
try:
93
103
    datetime.timedelta(0, 60)
94
104
    >>> rfc3339_duration_to_delta("PT60M")
95
105
    datetime.timedelta(0, 3600)
96
 
    >>> rfc3339_duration_to_delta("P60M")
97
 
    datetime.timedelta(1680)
98
106
    >>> rfc3339_duration_to_delta("PT24H")
99
107
    datetime.timedelta(1)
100
108
    >>> rfc3339_duration_to_delta("P1W")
103
111
    datetime.timedelta(0, 330)
104
112
    >>> rfc3339_duration_to_delta("P1DT3M20S")
105
113
    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
114
    """
136
115
 
137
116
    # Parsing an RFC 3339 duration with regular expressions is not
215
194
 
216
195
 
217
196
def string_to_delta(interval):
218
 
    """Parse a string and return a datetime.timedelta"""
 
197
    """Parse a string and return a datetime.timedelta
 
198
 
 
199
    >>> string_to_delta('7d')
 
200
    datetime.timedelta(7)
 
201
    >>> string_to_delta('60s')
 
202
    datetime.timedelta(0, 60)
 
203
    >>> string_to_delta('60m')
 
204
    datetime.timedelta(0, 3600)
 
205
    >>> string_to_delta('24h')
 
206
    datetime.timedelta(1)
 
207
    >>> string_to_delta('1w')
 
208
    datetime.timedelta(7)
 
209
    >>> string_to_delta('5m 30s')
 
210
    datetime.timedelta(0, 330)
 
211
    """
219
212
 
220
213
    try:
221
214
        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
 
    """
 
215
    except ValueError:
 
216
        pass
251
217
 
252
218
    value = datetime.timedelta(0)
253
219
    regexp = re.compile(r"(\d+)([dsmhw]?)")
268
234
    return value
269
235
 
270
236
 
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, properties in clients.items():
282
 
            self.run_on_one_client(client, properties)
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, properties):
299
 
        """Set the Client's D-Bus property"""
300
 
        client.Set(client_interface, self.property, self.value_to_set,
301
 
                   dbus_interface=dbus.PROPERTIES_IFACE)
302
 
 
303
 
class ValueArgumentMixIn(object):
304
 
    """Mixin class for commands taking a value as argument"""
305
 
    def __init__(self, value):
306
 
        self.value_to_set = value
307
 
 
308
 
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
309
 
    """Mixin class for commands taking a value argument as
310
 
    milliseconds."""
311
 
    @property
312
 
    def value_to_set(self):
313
 
        return self._vts
314
 
    @value_to_set.setter
315
 
    def value_to_set(self, value):
316
 
        """When setting, convert value to a datetime.timedelta"""
317
 
        self._vts = string_to_delta(value).total_seconds() * 1000
318
 
 
319
 
# Actual (non-abstract) command classes
320
 
 
321
 
class PrintTableCmd(PrintCmd):
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, properties):
423
 
        if self.is_enabled(client, properties):
424
 
            sys.exit(0)
425
 
        sys.exit(1)
426
 
    def is_enabled(self, client, properties):
427
 
        return bool(properties["Enabled"])
428
 
 
429
 
class RemoveCmd(Command):
430
 
    def run_on_one_client(self, client, properties):
431
 
        self.mandos.RemoveClient(client.__dbus_object_path__)
432
 
 
433
 
class ApproveCmd(Command):
434
 
    def run_on_one_client(self, client, properties):
435
 
        client.Approve(dbus.Boolean(True),
436
 
                       dbus_interface=client_interface)
437
 
 
438
 
class DenyCmd(Command):
439
 
    def run_on_one_client(self, client, properties):
440
 
        client.Approve(dbus.Boolean(False),
441
 
                       dbus_interface=client_interface)
442
 
 
443
 
class EnableCmd(PropertyCmd):
444
 
    property = "Enabled"
445
 
    value_to_set = dbus.Boolean(True)
446
 
 
447
 
class DisableCmd(PropertyCmd):
448
 
    property = "Enabled"
449
 
    value_to_set = dbus.Boolean(False)
450
 
 
451
 
class BumpTimeoutCmd(PropertyCmd):
452
 
    property = "LastCheckedOK"
453
 
    value_to_set = ""
454
 
 
455
 
class StartCheckerCmd(PropertyCmd):
456
 
    property = "CheckerRunning"
457
 
    value_to_set = dbus.Boolean(True)
458
 
 
459
 
class StopCheckerCmd(PropertyCmd):
460
 
    property = "CheckerRunning"
461
 
    value_to_set = dbus.Boolean(False)
462
 
 
463
 
class ApproveByDefaultCmd(PropertyCmd):
464
 
    property = "ApprovedByDefault"
465
 
    value_to_set = dbus.Boolean(True)
466
 
 
467
 
class DenyByDefaultCmd(PropertyCmd):
468
 
    property = "ApprovedByDefault"
469
 
    value_to_set = dbus.Boolean(False)
470
 
 
471
 
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
472
 
    property = "Checker"
473
 
 
474
 
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
475
 
    property = "Host"
476
 
 
477
 
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
478
 
    property = "Secret"
479
 
 
480
 
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
481
 
    property = "Timeout"
482
 
 
483
 
class SetExtendedTimeoutCmd(PropertyCmd,
484
 
                            MillisecondsValueArgumentMixIn):
485
 
    property = "ExtendedTimeout"
486
 
 
487
 
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
488
 
    property = "Interval"
489
 
 
490
 
class SetApprovalDelayCmd(PropertyCmd,
491
 
                          MillisecondsValueArgumentMixIn):
492
 
    property = "ApprovalDelay"
493
 
 
494
 
class SetApprovalDurationCmd(PropertyCmd,
495
 
                             MillisecondsValueArgumentMixIn):
496
 
    property = "ApprovalDuration"
 
237
def print_clients(clients, keywords):
 
238
    def valuetostring(value, keyword):
 
239
        if type(value) is dbus.Boolean:
 
240
            return "Yes" if value else "No"
 
241
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
242
                       "ApprovalDuration", "ExtendedTimeout"):
 
243
            return milliseconds_to_string(value)
 
244
        return str(value)
 
245
 
 
246
    # Create format string to print table rows
 
247
    format_string = " ".join("{{{key}:{width}}}".format(
 
248
        width=max(len(tablewords[key]),
 
249
                  max(len(valuetostring(client[key], key))
 
250
                      for client in clients)),
 
251
        key=key)
 
252
                             for key in keywords)
 
253
    # Print header line
 
254
    print(format_string.format(**tablewords))
 
255
    for client in clients:
 
256
        print(format_string
 
257
              .format(**{key: valuetostring(client[key], key)
 
258
                         for key in keywords}))
 
259
 
497
260
 
498
261
def has_actions(options):
499
262
    return any((options.enable,
515
278
                options.approve,
516
279
                options.deny))
517
280
 
518
 
def add_command_line_options(parser):
 
281
 
 
282
def main():
 
283
    parser = argparse.ArgumentParser()
519
284
    parser.add_argument("--version", action="version",
520
285
                        version="%(prog)s {}".format(version),
521
286
                        help="show version number and exit")
525
290
                        help="Print all fields")
526
291
    parser.add_argument("-j", "--dump-json", action="store_true",
527
292
                        help="Dump client data in JSON format")
528
 
    enable_disable = parser.add_mutually_exclusive_group()
529
 
    enable_disable.add_argument("-e", "--enable", action="store_true",
530
 
                                help="Enable client")
531
 
    enable_disable.add_argument("-d", "--disable",
532
 
                                action="store_true",
533
 
                                help="disable client")
 
293
    parser.add_argument("-e", "--enable", action="store_true",
 
294
                        help="Enable client")
 
295
    parser.add_argument("-d", "--disable", action="store_true",
 
296
                        help="disable client")
534
297
    parser.add_argument("-b", "--bump-timeout", action="store_true",
535
298
                        help="Bump timeout for client")
536
 
    start_stop_checker = parser.add_mutually_exclusive_group()
537
 
    start_stop_checker.add_argument("--start-checker",
538
 
                                    action="store_true",
539
 
                                    help="Start checker for client")
540
 
    start_stop_checker.add_argument("--stop-checker",
541
 
                                    action="store_true",
542
 
                                    help="Stop checker for client")
 
299
    parser.add_argument("--start-checker", action="store_true",
 
300
                        help="Start checker for client")
 
301
    parser.add_argument("--stop-checker", action="store_true",
 
302
                        help="Stop checker for client")
543
303
    parser.add_argument("-V", "--is-enabled", action="store_true",
544
304
                        help="Check if client is enabled")
545
305
    parser.add_argument("-r", "--remove", action="store_true",
552
312
                        help="Set extended timeout for client")
553
313
    parser.add_argument("-i", "--interval",
554
314
                        help="Set checker interval for client")
555
 
    approve_deny_default = parser.add_mutually_exclusive_group()
556
 
    approve_deny_default.add_argument(
557
 
        "--approve-by-default", action="store_true",
558
 
        default=None, dest="approved_by_default",
559
 
        help="Set client to be approved by default")
560
 
    approve_deny_default.add_argument(
561
 
        "--deny-by-default", action="store_false",
562
 
        dest="approved_by_default",
563
 
        help="Set client to be denied by default")
 
315
    parser.add_argument("--approve-by-default", action="store_true",
 
316
                        default=None, dest="approved_by_default",
 
317
                        help="Set client to be approved by default")
 
318
    parser.add_argument("--deny-by-default", action="store_false",
 
319
                        dest="approved_by_default",
 
320
                        help="Set client to be denied by default")
564
321
    parser.add_argument("--approval-delay",
565
322
                        help="Set delay before client approve/deny")
566
323
    parser.add_argument("--approval-duration",
569
326
    parser.add_argument("-s", "--secret",
570
327
                        type=argparse.FileType(mode="rb"),
571
328
                        help="Set password blob (file) for client")
572
 
    approve_deny = parser.add_mutually_exclusive_group()
573
 
    approve_deny.add_argument(
574
 
        "-A", "--approve", action="store_true",
575
 
        help="Approve any current client request")
576
 
    approve_deny.add_argument("-D", "--deny", action="store_true",
577
 
                              help="Deny any current client request")
 
329
    parser.add_argument("-A", "--approve", action="store_true",
 
330
                        help="Approve any current client request")
 
331
    parser.add_argument("-D", "--deny", action="store_true",
 
332
                        help="Deny any current client request")
578
333
    parser.add_argument("--check", action="store_true",
579
334
                        help="Run self-test")
580
335
    parser.add_argument("client", nargs="*", help="Client name")
581
 
 
582
 
 
583
 
def commands_and_clients_from_options(options):
584
 
 
585
 
    commands = []
586
 
 
587
 
    if options.dump_json:
588
 
        commands.append(DumpJSONCmd())
589
 
 
590
 
    if options.enable:
591
 
        commands.append(EnableCmd())
592
 
 
593
 
    if options.disable:
594
 
        commands.append(DisableCmd())
595
 
 
596
 
    if options.bump_timeout:
597
 
        commands.append(BumpTimeoutCmd(options.bump_timeout))
598
 
 
599
 
    if options.start_checker:
600
 
        commands.append(StartCheckerCmd())
601
 
 
602
 
    if options.stop_checker:
603
 
        commands.append(StopCheckerCmd())
604
 
 
605
 
    if options.is_enabled:
606
 
        commands.append(IsEnabledCmd())
607
 
 
608
 
    if options.remove:
609
 
        commands.append(RemoveCmd())
610
 
 
611
 
    if options.checker is not None:
612
 
        commands.append(SetCheckerCmd())
613
 
 
614
 
    if options.timeout is not None:
615
 
        commands.append(SetTimeoutCmd(options.timeout))
616
 
 
617
 
    if options.extended_timeout:
618
 
        commands.append(
619
 
            SetExtendedTimeoutCmd(options.extended_timeout))
620
 
 
621
 
    if options.interval is not None:
622
 
        command.append(SetIntervalCmd(options.interval))
623
 
 
624
 
    if options.approved_by_default is not None:
625
 
        if options.approved_by_default:
626
 
            command.append(ApproveByDefaultCmd())
627
 
        else:
628
 
            command.append(DenyByDefaultCmd())
629
 
 
630
 
    if options.approval_delay is not None:
631
 
        command.append(SetApprovalDelayCmd(options.approval_delay))
632
 
 
633
 
    if options.approval_duration is not None:
634
 
        command.append(
635
 
            SetApprovalDurationCmd(options.approval_duration))
636
 
 
637
 
    if options.host is not None:
638
 
        command.append(SetHostCmd(options.host))
639
 
 
640
 
    if options.secret is not None:
641
 
        command.append(SetSecretCmd(options.secret))
642
 
 
643
 
    if options.approve:
644
 
        commands.append(ApproveCmd())
645
 
 
646
 
    if options.deny:
647
 
        commands.append(DenyCmd())
648
 
 
649
 
    # If no command option has been given, show table of clients,
650
 
    # optionally verbosely
651
 
    if not commands:
652
 
        commands.append(PrintTableCmd(verbose=options.verbose))
653
 
 
654
 
    return commands, options.client
655
 
 
656
 
 
657
 
def main():
658
 
    parser = argparse.ArgumentParser()
659
 
 
660
 
    add_command_line_options(parser)
661
 
 
662
336
    options = parser.parse_args()
663
337
 
664
338
    if has_actions(options) and not (options.client or options.all):
670
344
        parser.error("--dump-json can only be used alone.")
671
345
    if options.all and not has_actions(options):
672
346
        parser.error("--all requires an action.")
673
 
    if options.is_enabled and len(options.client) > 1:
674
 
        parser.error("--is-enabled requires exactly one client")
675
347
 
676
 
    commands, clientnames = commands_and_clients_from_options(options)
 
348
    if options.check:
 
349
        import doctest
 
350
        fail_count, test_count = doctest.testmod()
 
351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
677
352
 
678
353
    try:
679
354
        bus = dbus.SystemBus()
680
355
        mandos_dbus_objc = bus.get_object(busname, server_path)
681
356
    except dbus.exceptions.DBusException:
682
 
        log.critical("Could not connect to Mandos server")
 
357
        print("Could not connect to Mandos server", file=sys.stderr)
683
358
        sys.exit(1)
684
359
 
685
360
    mandos_serv = dbus.Interface(mandos_dbus_objc,
687
362
    mandos_serv_object_manager = dbus.Interface(
688
363
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
689
364
 
690
 
    # Filter out log message from dbus module
691
 
    dbus_logger = logging.getLogger("dbus.proxies")
692
 
    class NullFilter(logging.Filter):
693
 
        def filter(self, record):
694
 
            return False
695
 
    dbus_filter = NullFilter()
 
365
    # block stderr since dbus library prints to stderr
 
366
    null = os.open(os.path.devnull, os.O_RDWR)
 
367
    stderrcopy = os.dup(sys.stderr.fileno())
 
368
    os.dup2(null, sys.stderr.fileno())
 
369
    os.close(null)
696
370
    try:
697
 
        dbus_logger.addFilter(dbus_filter)
698
 
        mandos_clients = {path: ifs_and_props[client_interface]
699
 
                          for path, ifs_and_props in
700
 
                          mandos_serv_object_manager
701
 
                          .GetManagedObjects().items()
702
 
                          if client_interface in ifs_and_props}
 
371
        try:
 
372
            mandos_clients = {path: ifs_and_props[client_interface]
 
373
                              for path, ifs_and_props in
 
374
                              mandos_serv_object_manager
 
375
                              .GetManagedObjects().items()
 
376
                              if client_interface in ifs_and_props}
 
377
        finally:
 
378
            # restore stderr
 
379
            os.dup2(stderrcopy, sys.stderr.fileno())
 
380
            os.close(stderrcopy)
703
381
    except dbus.exceptions.DBusException as e:
704
 
        log.critical("Failed to access Mandos server through D-Bus:"
705
 
                     "\n%s", e)
 
382
        print("Access denied: "
 
383
              "Accessing mandos server through D-Bus: {}".format(e),
 
384
              file=sys.stderr)
706
385
        sys.exit(1)
707
 
    finally:
708
 
        # restore dbus logger
709
 
        dbus_logger.removeFilter(dbus_filter)
710
386
 
711
387
    # Compile dict of (clients: properties) to process
712
388
    clients = {}
713
389
 
714
 
    if not clientnames:
 
390
    if options.all or not options.client:
715
391
        clients = {bus.get_object(busname, path): properties
716
392
                   for path, properties in mandos_clients.items()}
717
393
    else:
718
 
        for name in clientnames:
 
394
        for name in options.client:
719
395
            for path, client in mandos_clients.items():
720
396
                if client["Name"] == name:
721
397
                    client_objc = bus.get_object(busname, path)
722
398
                    clients[client_objc] = client
723
399
                    break
724
400
            else:
725
 
                log.critical("Client not found on server: %r", name)
 
401
                print("Client not found on server: {!r}"
 
402
                      .format(name), file=sys.stderr)
726
403
                sys.exit(1)
727
404
 
728
 
    # Run all commands on clients
729
 
    for command in commands:
730
 
        command.run(mandos_serv, clients)
731
 
 
732
 
 
733
 
class Test_milliseconds_to_string(unittest.TestCase):
734
 
    def test_all(self):
735
 
        self.assertEqual(milliseconds_to_string(93785000),
736
 
                         "1T02:03:05")
737
 
    def test_no_days(self):
738
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
739
 
    def test_all_zero(self):
740
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
741
 
    def test_no_fractional_seconds(self):
742
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
743
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
744
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
745
 
 
746
 
class Test_string_to_delta(unittest.TestCase):
747
 
    def test_handles_basic_rfc3339(self):
748
 
        self.assertEqual(string_to_delta("PT2H"),
749
 
                         datetime.timedelta(0, 7200))
750
 
    def test_falls_back_to_pre_1_6_1_with_warning(self):
751
 
        # assertLogs only exists in Python 3.4
752
 
        if hasattr(self, "assertLogs"):
753
 
            with self.assertLogs(log, logging.WARNING):
754
 
                value = string_to_delta("2h")
755
 
        else:
756
 
            class WarningFilter(logging.Filter):
757
 
                """Don't show, but record the presence of, warnings"""
758
 
                def filter(self, record):
759
 
                    is_warning = record.levelno >= logging.WARNING
760
 
                    self.found = is_warning or getattr(self, "found",
761
 
                                                       False)
762
 
                    return not is_warning
763
 
            warning_filter = WarningFilter()
764
 
            log.addFilter(warning_filter)
765
 
            try:
766
 
                value = string_to_delta("2h")
767
 
            finally:
768
 
                log.removeFilter(warning_filter)
769
 
            self.assertTrue(getattr(warning_filter, "found", False))
770
 
        self.assertEqual(value, datetime.timedelta(0, 7200))
771
 
 
772
 
 
773
 
class TestCmd(unittest.TestCase):
774
 
    """Abstract class for tests of command classes"""
775
 
    def setUp(self):
776
 
        testcase = self
777
 
        class MockClient(object):
778
 
            def __init__(self, name, **attributes):
779
 
                self.__dbus_object_path__ = "objpath_{}".format(name)
780
 
                self.attributes = attributes
781
 
                self.attributes["Name"] = name
782
 
                self.calls = []
783
 
            def Set(self, interface, property, value, dbus_interface):
784
 
                testcase.assertEqual(interface, client_interface)
785
 
                testcase.assertEqual(dbus_interface,
786
 
                                     dbus.PROPERTIES_IFACE)
787
 
                self.attributes[property] = value
788
 
                self.calls.append(("Set", (interface, property, value,
789
 
                                           dbus_interface)))
790
 
            def Get(self, interface, property, dbus_interface):
791
 
                testcase.assertEqual(interface, client_interface)
792
 
                testcase.assertEqual(dbus_interface,
793
 
                                     dbus.PROPERTIES_IFACE)
794
 
                self.calls.append(("Get", (interface, property,
795
 
                                           dbus_interface)))
796
 
                return self.attributes[property]
797
 
            def Approve(self, approve, dbus_interface):
798
 
                testcase.assertEqual(dbus_interface, client_interface)
799
 
                self.calls.append(("Approve", (approve,
800
 
                                               dbus_interface)))
801
 
        self.client = 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
 
        self.other_client = MockClient(
826
 
            "barbar",
827
 
            KeyID=("0558568eedd67d622f5c83b35a115f79"
828
 
                   "6ab612cff5ad227247e46c2b020f441c"),
829
 
            Secret=b"secretbar",
830
 
            Host="192.0.2.3",
831
 
            Enabled=dbus.Boolean(True),
832
 
            Timeout=300000,
833
 
            LastCheckedOK="2019-02-04T00:00:00",
834
 
            Created="2019-01-03T00:00:00",
835
 
            Interval=120000,
836
 
            Fingerprint=("3E393AEAEFB84C7E89E2"
837
 
                         "F547B3A107558FCA3A27"),
838
 
            CheckerRunning=dbus.Boolean(True),
839
 
            LastEnabled="2019-01-04T00:00:00",
840
 
            ApprovalPending=dbus.Boolean(False),
841
 
            ApprovedByDefault=dbus.Boolean(False),
842
 
            LastApprovalRequest="2019-01-03T00:00:00",
843
 
            ApprovalDelay=30000,
844
 
            ApprovalDuration=1000,
845
 
            Checker=":",
846
 
            ExtendedTimeout=900000,
847
 
            Expires="2019-02-05T00:00:00",
848
 
            LastCheckerStatus=-2)
849
 
        self.clients =  collections.OrderedDict(
850
 
            [
851
 
                (self.client, self.client.attributes),
852
 
                (self.other_client, self.other_client.attributes),
853
 
            ])
854
 
        self.one_client = {self.client: self.client.attributes}
855
 
 
856
 
class TestPrintTableCmd(TestCmd):
857
 
    def test_normal(self):
858
 
        output = PrintTableCmd().output(self.clients)
859
 
        expected_output = """
860
 
Name   Enabled Timeout  Last Successful Check
861
 
foo    Yes     00:05:00 2019-02-03T00:00:00  
862
 
barbar Yes     00:05:00 2019-02-04T00:00:00  
863
 
"""[1:-1]
864
 
        self.assertEqual(output, expected_output)
865
 
    def test_verbose(self):
866
 
        output = PrintTableCmd(verbose=True).output(self.clients)
867
 
        expected_output = """
868
 
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
869
 
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                  
870
 
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                 
871
 
"""[1:-1]
872
 
        self.assertEqual(output, expected_output)
873
 
    def test_one_client(self):
874
 
        output = PrintTableCmd().output(self.one_client)
875
 
        expected_output = """
876
 
Name Enabled Timeout  Last Successful Check
877
 
foo  Yes     00:05:00 2019-02-03T00:00:00  
878
 
"""[1:-1]
879
 
        self.assertEqual(output, expected_output)
880
 
 
881
 
class TestDumpJSONCmd(TestCmd):
882
 
    def setUp(self):
883
 
        self.expected_json = {
884
 
            "foo": {
885
 
                "Name": "foo",
886
 
                "KeyID": ("92ed150794387c03ce684574b1139a65"
887
 
                          "94a34f895daaaf09fd8ea90a27cddb12"),
888
 
                "Host": "foo.example.org",
889
 
                "Enabled": True,
890
 
                "Timeout": 300000,
891
 
                "LastCheckedOK": "2019-02-03T00:00:00",
892
 
                "Created": "2019-01-02T00:00:00",
893
 
                "Interval": 120000,
894
 
                "Fingerprint": ("778827225BA7DE539C5A"
895
 
                                "7CFA59CFF7CDBD9A5920"),
896
 
                "CheckerRunning": False,
897
 
                "LastEnabled": "2019-01-03T00:00:00",
898
 
                "ApprovalPending": False,
899
 
                "ApprovedByDefault": True,
900
 
                "LastApprovalRequest": "",
901
 
                "ApprovalDelay": 0,
902
 
                "ApprovalDuration": 1000,
903
 
                "Checker": "fping -q -- %(host)s",
904
 
                "ExtendedTimeout": 900000,
905
 
                "Expires": "2019-02-04T00:00:00",
906
 
                "LastCheckerStatus": 0,
907
 
            },
908
 
            "barbar": {
909
 
                "Name": "barbar",
910
 
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
911
 
                          "6ab612cff5ad227247e46c2b020f441c"),
912
 
                "Host": "192.0.2.3",
913
 
                "Enabled": True,
914
 
                "Timeout": 300000,
915
 
                "LastCheckedOK": "2019-02-04T00:00:00",
916
 
                "Created": "2019-01-03T00:00:00",
917
 
                "Interval": 120000,
918
 
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
919
 
                                "F547B3A107558FCA3A27"),
920
 
                "CheckerRunning": True,
921
 
                "LastEnabled": "2019-01-04T00:00:00",
922
 
                "ApprovalPending": False,
923
 
                "ApprovedByDefault": False,
924
 
                "LastApprovalRequest": "2019-01-03T00:00:00",
925
 
                "ApprovalDelay": 30000,
926
 
                "ApprovalDuration": 1000,
927
 
                "Checker": ":",
928
 
                "ExtendedTimeout": 900000,
929
 
                "Expires": "2019-02-05T00:00:00",
930
 
                "LastCheckerStatus": -2,
931
 
            },
932
 
        }
933
 
        return super(TestDumpJSONCmd, self).setUp()
934
 
    def test_normal(self):
935
 
        json_data = json.loads(DumpJSONCmd().output(self.clients))
936
 
        self.assertDictEqual(json_data, self.expected_json)
937
 
    def test_one_client(self):
938
 
        clients = self.one_client
939
 
        json_data = json.loads(DumpJSONCmd().output(clients))
940
 
        expected_json = {"foo": self.expected_json["foo"]}
941
 
        self.assertDictEqual(json_data, expected_json)
942
 
 
943
 
class TestIsEnabledCmd(TestCmd):
944
 
    def test_is_enabled(self):
945
 
        self.assertTrue(all(IsEnabledCmd().is_enabled(client, properties)
946
 
                            for client, properties in self.clients.items()))
947
 
    def test_is_enabled_run_exits_successfully(self):
948
 
        with self.assertRaises(SystemExit) as e:
949
 
            IsEnabledCmd().run(None, self.one_client)
950
 
        if e.exception.code is not None:
951
 
            self.assertEqual(e.exception.code, 0)
952
 
        else:
953
 
            self.assertIsNone(e.exception.code)
954
 
    def test_is_enabled_run_exits_with_failure(self):
955
 
        self.client.attributes["Enabled"] = dbus.Boolean(False)
956
 
        with self.assertRaises(SystemExit) as e:
957
 
            IsEnabledCmd().run(None, self.one_client)
958
 
        if isinstance(e.exception.code, int):
959
 
            self.assertNotEqual(e.exception.code, 0)
960
 
        else:
961
 
            self.assertIsNotNone(e.exception.code)
962
 
 
963
 
class TestRemoveCmd(TestCmd):
964
 
    def test_remove(self):
965
 
        class MockMandos(object):
966
 
            def __init__(self):
967
 
                self.calls = []
968
 
            def RemoveClient(self, dbus_path):
969
 
                self.calls.append(("RemoveClient", (dbus_path,)))
970
 
        mandos = MockMandos()
971
 
        super(TestRemoveCmd, self).setUp()
972
 
        RemoveCmd().run(mandos, self.clients)
973
 
        self.assertEqual(len(mandos.calls), 2)
974
 
        for client in self.clients:
975
 
            self.assertIn(("RemoveClient",
976
 
                           (client.__dbus_object_path__,)),
977
 
                          mandos.calls)
978
 
 
979
 
class TestApproveCmd(TestCmd):
980
 
    def test_approve(self):
981
 
        ApproveCmd().run(None, self.clients)
982
 
        for client in self.clients:
983
 
            self.assertIn(("Approve", (True, client_interface)),
984
 
                          client.calls)
985
 
 
986
 
class TestDenyCmd(TestCmd):
987
 
    def test_deny(self):
988
 
        DenyCmd().run(None, self.clients)
989
 
        for client in self.clients:
990
 
            self.assertIn(("Approve", (False, client_interface)),
991
 
                          client.calls)
992
 
 
993
 
class TestEnableCmd(TestCmd):
994
 
    def test_enable(self):
995
 
        for client in self.clients:
996
 
            client.attributes["Enabled"] = False
997
 
 
998
 
        EnableCmd().run(None, self.clients)
999
 
 
1000
 
        for client in self.clients:
1001
 
            self.assertTrue(client.attributes["Enabled"])
1002
 
 
1003
 
class TestDisableCmd(TestCmd):
1004
 
    def test_disable(self):
1005
 
        DisableCmd().run(None, self.clients)
1006
 
 
1007
 
        for client in self.clients:
1008
 
            self.assertFalse(client.attributes["Enabled"])
1009
 
 
1010
 
 
1011
 
 
1012
 
def should_only_run_tests():
1013
 
    parser = argparse.ArgumentParser(add_help=False)
1014
 
    parser.add_argument("--check", action='store_true')
1015
 
    args, unknown_args = parser.parse_known_args()
1016
 
    run_tests = args.check
1017
 
    if run_tests:
1018
 
        # Remove --check argument from sys.argv
1019
 
        sys.argv[1:] = unknown_args
1020
 
    return run_tests
1021
 
 
1022
 
# Add all tests from doctest strings
1023
 
def load_tests(loader, tests, none):
1024
 
    import doctest
1025
 
    tests.addTests(doctest.DocTestSuite())
1026
 
    return tests
 
405
    if not has_actions(options) and clients:
 
406
        if options.verbose or options.dump_json:
 
407
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
408
                        "Created", "Interval", "Host", "KeyID",
 
409
                        "Fingerprint", "CheckerRunning",
 
410
                        "LastEnabled", "ApprovalPending",
 
411
                        "ApprovedByDefault", "LastApprovalRequest",
 
412
                        "ApprovalDelay", "ApprovalDuration",
 
413
                        "Checker", "ExtendedTimeout", "Expires",
 
414
                        "LastCheckerStatus")
 
415
        else:
 
416
            keywords = defaultkeywords
 
417
 
 
418
        if options.dump_json:
 
419
            json.dump({client["Name"]: {key:
 
420
                                        bool(client[key])
 
421
                                        if isinstance(client[key],
 
422
                                                      dbus.Boolean)
 
423
                                        else client[key]
 
424
                                        for key in keywords}
 
425
                       for client in clients.values()},
 
426
                      fp=sys.stdout, indent=4,
 
427
                      separators=(',', ': '))
 
428
            print()
 
429
        else:
 
430
            print_clients(clients.values(), keywords)
 
431
    else:
 
432
        # Process each client in the list by all selected options
 
433
        for client in clients:
 
434
 
 
435
            def set_client_prop(prop, value):
 
436
                """Set a Client D-Bus property"""
 
437
                client.Set(client_interface, prop, value,
 
438
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
439
 
 
440
            def set_client_prop_ms(prop, value):
 
441
                """Set a Client D-Bus property, converted
 
442
                from a string to milliseconds."""
 
443
                set_client_prop(prop,
 
444
                                string_to_delta(value).total_seconds()
 
445
                                * 1000)
 
446
 
 
447
            if options.remove:
 
448
                mandos_serv.RemoveClient(client.__dbus_object_path__)
 
449
            if options.enable:
 
450
                set_client_prop("Enabled", dbus.Boolean(True))
 
451
            if options.disable:
 
452
                set_client_prop("Enabled", dbus.Boolean(False))
 
453
            if options.bump_timeout:
 
454
                set_client_prop("LastCheckedOK", "")
 
455
            if options.start_checker:
 
456
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
457
            if options.stop_checker:
 
458
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
459
            if options.is_enabled:
 
460
                if client.Get(client_interface, "Enabled",
 
461
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
462
                    sys.exit(0)
 
463
                else:
 
464
                    sys.exit(1)
 
465
            if options.checker is not None:
 
466
                set_client_prop("Checker", options.checker)
 
467
            if options.host is not None:
 
468
                set_client_prop("Host", options.host)
 
469
            if options.interval is not None:
 
470
                set_client_prop_ms("Interval", options.interval)
 
471
            if options.approval_delay is not None:
 
472
                set_client_prop_ms("ApprovalDelay",
 
473
                                   options.approval_delay)
 
474
            if options.approval_duration is not None:
 
475
                set_client_prop_ms("ApprovalDuration",
 
476
                                   options.approval_duration)
 
477
            if options.timeout is not None:
 
478
                set_client_prop_ms("Timeout", options.timeout)
 
479
            if options.extended_timeout is not None:
 
480
                set_client_prop_ms("ExtendedTimeout",
 
481
                                   options.extended_timeout)
 
482
            if options.secret is not None:
 
483
                set_client_prop("Secret",
 
484
                                dbus.ByteArray(options.secret.read()))
 
485
            if options.approved_by_default is not None:
 
486
                set_client_prop("ApprovedByDefault",
 
487
                                dbus.Boolean(options
 
488
                                             .approved_by_default))
 
489
            if options.approve:
 
490
                client.Approve(dbus.Boolean(True),
 
491
                               dbus_interface=client_interface)
 
492
            elif options.deny:
 
493
                client.Approve(dbus.Boolean(False),
 
494
                               dbus_interface=client_interface)
 
495
 
1027
496
 
1028
497
if __name__ == "__main__":
1029
 
    if should_only_run_tests():
1030
 
        # Call using ./tdd-python-script --check [--verbose]
1031
 
        unittest.main()
1032
 
    else:
1033
 
        main()
 
498
    main()