/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-03-04 18:43:22 UTC
  • Revision ID: teddy@recompile.se-20190304184322-6tumlykqh57t5nvs
mandos-ctl: Add test for RemoveCmd

* mandos-ctl (TestRemoveCmd): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
 
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*")))); -*-
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
6
 
# Copyright © 2008-2018 Teddy Hogeborn
7
 
# Copyright © 2008-2018 Björn Påhlsson
 
6
# Copyright © 2008-2019 Teddy Hogeborn
 
7
# Copyright © 2008-2019 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
43
45
 
44
46
import dbus
45
47
 
 
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
 
46
59
if sys.version_info.major == 2:
47
60
    str = unicode
48
61
 
49
62
locale.setlocale(locale.LC_ALL, "")
50
63
 
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")
73
64
domain = "se.recompile"
74
65
busname = domain + ".Mandos"
75
66
server_path = "/"
76
67
server_interface = domain + ".Mandos"
77
68
client_interface = domain + ".Mandos.Client"
78
 
version = "1.7.19"
 
69
version = "1.8.3"
79
70
 
80
71
 
81
72
try:
102
93
    datetime.timedelta(0, 60)
103
94
    >>> rfc3339_duration_to_delta("PT60M")
104
95
    datetime.timedelta(0, 3600)
 
96
    >>> rfc3339_duration_to_delta("P60M")
 
97
    datetime.timedelta(1680)
105
98
    >>> rfc3339_duration_to_delta("PT24H")
106
99
    datetime.timedelta(1)
107
100
    >>> rfc3339_duration_to_delta("P1W")
110
103
    datetime.timedelta(0, 330)
111
104
    >>> rfc3339_duration_to_delta("P1DT3M20S")
112
105
    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'
113
135
    """
114
136
 
115
137
    # Parsing an RFC 3339 duration with regular expressions is not
193
215
 
194
216
 
195
217
def string_to_delta(interval):
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
 
    """
 
218
    """Parse a string and return a datetime.timedelta"""
211
219
 
212
220
    try:
213
221
        return rfc3339_duration_to_delta(interval)
214
 
    except ValueError:
215
 
        pass
 
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
    """
216
251
 
217
252
    value = datetime.timedelta(0)
218
253
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
268
    return value
234
269
 
235
270
 
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
 
 
 
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"
259
498
 
260
499
def has_actions(options):
261
500
    return any((options.enable,
277
516
                options.approve,
278
517
                options.deny))
279
518
 
280
 
 
281
 
def main():
282
 
    parser = argparse.ArgumentParser()
 
519
def add_command_line_options(parser):
283
520
    parser.add_argument("--version", action="version",
284
521
                        version="%(prog)s {}".format(version),
285
522
                        help="show version number and exit")
289
526
                        help="Print all fields")
290
527
    parser.add_argument("-j", "--dump-json", action="store_true",
291
528
                        help="Dump client data in JSON format")
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")
 
529
    enable_disable = parser.add_mutually_exclusive_group()
 
530
    enable_disable.add_argument("-e", "--enable", action="store_true",
 
531
                                help="Enable client")
 
532
    enable_disable.add_argument("-d", "--disable",
 
533
                                action="store_true",
 
534
                                help="disable client")
296
535
    parser.add_argument("-b", "--bump-timeout", action="store_true",
297
536
                        help="Bump timeout 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")
 
537
    start_stop_checker = parser.add_mutually_exclusive_group()
 
538
    start_stop_checker.add_argument("--start-checker",
 
539
                                    action="store_true",
 
540
                                    help="Start checker for client")
 
541
    start_stop_checker.add_argument("--stop-checker",
 
542
                                    action="store_true",
 
543
                                    help="Stop checker for client")
302
544
    parser.add_argument("-V", "--is-enabled", action="store_true",
303
545
                        help="Check if client is enabled")
304
546
    parser.add_argument("-r", "--remove", action="store_true",
311
553
                        help="Set extended timeout for client")
312
554
    parser.add_argument("-i", "--interval",
313
555
                        help="Set checker interval for client")
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")
 
556
    approve_deny_default = parser.add_mutually_exclusive_group()
 
557
    approve_deny_default.add_argument(
 
558
        "--approve-by-default", action="store_true",
 
559
        default=None, dest="approved_by_default",
 
560
        help="Set client to be approved by default")
 
561
    approve_deny_default.add_argument(
 
562
        "--deny-by-default", action="store_false",
 
563
        dest="approved_by_default",
 
564
        help="Set client to be denied by default")
320
565
    parser.add_argument("--approval-delay",
321
566
                        help="Set delay before client approve/deny")
322
567
    parser.add_argument("--approval-duration",
325
570
    parser.add_argument("-s", "--secret",
326
571
                        type=argparse.FileType(mode="rb"),
327
572
                        help="Set password blob (file) for client")
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")
 
573
    approve_deny = parser.add_mutually_exclusive_group()
 
574
    approve_deny.add_argument(
 
575
        "-A", "--approve", action="store_true",
 
576
        help="Approve any current client request")
 
577
    approve_deny.add_argument("-D", "--deny", action="store_true",
 
578
                              help="Deny any current client request")
332
579
    parser.add_argument("--check", action="store_true",
333
580
                        help="Run self-test")
334
581
    parser.add_argument("client", nargs="*", help="Client name")
 
582
 
 
583
 
 
584
def commands_and_clients_from_options(options):
 
585
 
 
586
    commands = []
 
587
 
 
588
    if options.dump_json:
 
589
        commands.append(DumpJSONCmd())
 
590
 
 
591
    if options.enable:
 
592
        commands.append(EnableCmd())
 
593
 
 
594
    if options.disable:
 
595
        commands.append(DisableCmd())
 
596
 
 
597
    if options.bump_timeout:
 
598
        commands.append(BumpTimeoutCmd(options.bump_timeout))
 
599
 
 
600
    if options.start_checker:
 
601
        commands.append(StartCheckerCmd())
 
602
 
 
603
    if options.stop_checker:
 
604
        commands.append(StopCheckerCmd())
 
605
 
 
606
    if options.is_enabled:
 
607
        commands.append(IsEnabledCmd())
 
608
 
 
609
    if options.remove:
 
610
        commands.append(RemoveCmd())
 
611
 
 
612
    if options.checker is not None:
 
613
        commands.append(SetCheckerCmd())
 
614
 
 
615
    if options.timeout is not None:
 
616
        commands.append(SetTimeoutCmd(options.timeout))
 
617
 
 
618
    if options.extended_timeout:
 
619
        commands.append(
 
620
            SetExtendedTimeoutCmd(options.extended_timeout))
 
621
 
 
622
    if options.interval is not None:
 
623
        command.append(SetIntervalCmd(options.interval))
 
624
 
 
625
    if options.approved_by_default is not None:
 
626
        if options.approved_by_default:
 
627
            command.append(ApproveByDefaultCmd())
 
628
        else:
 
629
            command.append(DenyByDefaultCmd())
 
630
 
 
631
    if options.approval_delay is not None:
 
632
        command.append(SetApprovalDelayCmd(options.approval_delay))
 
633
 
 
634
    if options.approval_duration is not None:
 
635
        command.append(
 
636
            SetApprovalDurationCmd(options.approval_duration))
 
637
 
 
638
    if options.host is not None:
 
639
        command.append(SetHostCmd(options.host))
 
640
 
 
641
    if options.secret is not None:
 
642
        command.append(SetSecretCmd(options.secret))
 
643
 
 
644
    if options.approve:
 
645
        commands.append(ApproveCmd())
 
646
 
 
647
    if options.deny:
 
648
        commands.append(DenyCmd())
 
649
 
 
650
    # If no command option has been given, show table of clients,
 
651
    # optionally verbosely
 
652
    if not commands:
 
653
        commands.append(PrintTableCmd(verbose=options.verbose))
 
654
 
 
655
    return commands, options.client
 
656
 
 
657
 
 
658
def main():
 
659
    parser = argparse.ArgumentParser()
 
660
 
 
661
    add_command_line_options(parser)
 
662
 
335
663
    options = parser.parse_args()
336
664
 
337
665
    if has_actions(options) and not (options.client or options.all):
343
671
        parser.error("--dump-json can only be used alone.")
344
672
    if options.all and not has_actions(options):
345
673
        parser.error("--all requires an action.")
 
674
    if options.is_enabled and len(options.client) > 1:
 
675
        parser.error("--is-enabled requires exactly one client")
346
676
 
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)
 
677
    commands, clientnames = commands_and_clients_from_options(options)
351
678
 
352
679
    try:
353
680
        bus = dbus.SystemBus()
354
681
        mandos_dbus_objc = bus.get_object(busname, server_path)
355
682
    except dbus.exceptions.DBusException:
356
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
683
        log.critical("Could not connect to Mandos server")
357
684
        sys.exit(1)
358
685
 
359
686
    mandos_serv = dbus.Interface(mandos_dbus_objc,
361
688
    mandos_serv_object_manager = dbus.Interface(
362
689
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
363
690
 
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)
 
691
    # Filter out log message from dbus module
 
692
    dbus_logger = logging.getLogger("dbus.proxies")
 
693
    class NullFilter(logging.Filter):
 
694
        def filter(self, record):
 
695
            return False
 
696
    dbus_filter = NullFilter()
369
697
    try:
370
 
        try:
371
 
            mandos_clients = {path: ifs_and_props[client_interface]
372
 
                              for path, ifs_and_props in
373
 
                              mandos_serv_object_manager
374
 
                              .GetManagedObjects().items()
375
 
                              if client_interface in ifs_and_props}
376
 
        finally:
377
 
            # restore stderr
378
 
            os.dup2(stderrcopy, sys.stderr.fileno())
379
 
            os.close(stderrcopy)
 
698
        dbus_logger.addFilter(dbus_filter)
 
699
        mandos_clients = {path: ifs_and_props[client_interface]
 
700
                          for path, ifs_and_props in
 
701
                          mandos_serv_object_manager
 
702
                          .GetManagedObjects().items()
 
703
                          if client_interface in ifs_and_props}
380
704
    except dbus.exceptions.DBusException as e:
381
 
        print("Access denied: "
382
 
              "Accessing mandos server through D-Bus: {}".format(e),
383
 
              file=sys.stderr)
 
705
        log.critical("Failed to access Mandos server through D-Bus:"
 
706
                     "\n%s", e)
384
707
        sys.exit(1)
 
708
    finally:
 
709
        # restore dbus logger
 
710
        dbus_logger.removeFilter(dbus_filter)
385
711
 
386
712
    # Compile dict of (clients: properties) to process
387
713
    clients = {}
388
714
 
389
 
    if options.all or not options.client:
 
715
    if not clientnames:
390
716
        clients = {bus.get_object(busname, path): properties
391
717
                   for path, properties in mandos_clients.items()}
392
718
    else:
393
 
        for name in options.client:
 
719
        for name in clientnames:
394
720
            for path, client in mandos_clients.items():
395
721
                if client["Name"] == name:
396
722
                    client_objc = bus.get_object(busname, path)
397
723
                    clients[client_objc] = client
398
724
                    break
399
725
            else:
400
 
                print("Client not found on server: {!r}"
401
 
                      .format(name), file=sys.stderr)
 
726
                log.critical("Client not found on server: %r", name)
402
727
                sys.exit(1)
403
728
 
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
 
 
 
729
    # Run all commands on clients
 
730
    for command in commands:
 
731
        command.run(mandos_serv, clients)
 
732
 
 
733
 
 
734
class Test_milliseconds_to_string(unittest.TestCase):
 
735
    def test_all(self):
 
736
        self.assertEqual(milliseconds_to_string(93785000),
 
737
                         "1T02:03:05")
 
738
    def test_no_days(self):
 
739
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
740
    def test_all_zero(self):
 
741
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
742
    def test_no_fractional_seconds(self):
 
743
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
744
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
745
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
746
 
 
747
class Test_string_to_delta(unittest.TestCase):
 
748
    def test_handles_basic_rfc3339(self):
 
749
        self.assertEqual(string_to_delta("PT2H"),
 
750
                         datetime.timedelta(0, 7200))
 
751
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
752
        # assertLogs only exists in Python 3.4
 
753
        if hasattr(self, "assertLogs"):
 
754
            with self.assertLogs(log, logging.WARNING):
 
755
                value = string_to_delta("2h")
 
756
        else:
 
757
            class WarningFilter(logging.Filter):
 
758
                """Don't show, but record the presence of, warnings"""
 
759
                def filter(self, record):
 
760
                    is_warning = record.levelno >= logging.WARNING
 
761
                    self.found = is_warning or getattr(self, "found",
 
762
                                                       False)
 
763
                    return not is_warning
 
764
            warning_filter = WarningFilter()
 
765
            log.addFilter(warning_filter)
 
766
            try:
 
767
                value = string_to_delta("2h")
 
768
            finally:
 
769
                log.removeFilter(warning_filter)
 
770
            self.assertTrue(getattr(warning_filter, "found", False))
 
771
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
772
 
 
773
 
 
774
class TestCmd(unittest.TestCase):
 
775
    """Abstract class for tests of command classes"""
 
776
    def setUp(self):
 
777
        testcase = self
 
778
        class MockClient(object):
 
779
            def __init__(self, name, **attributes):
 
780
                self.__dbus_object_path__ = "objpath_{}".format(name)
 
781
                self.attributes = attributes
 
782
                self.attributes["Name"] = name
 
783
                self.calls = []
 
784
            def Set(self, interface, property, value, dbus_interface):
 
785
                testcase.assertEqual(interface, client_interface)
 
786
                testcase.assertEqual(dbus_interface,
 
787
                                     dbus.PROPERTIES_IFACE)
 
788
                self.attributes[property] = value
 
789
                self.calls.append(("Set", (interface, property, value,
 
790
                                           dbus_interface)))
 
791
            def Get(self, interface, property, dbus_interface):
 
792
                testcase.assertEqual(interface, client_interface)
 
793
                testcase.assertEqual(dbus_interface,
 
794
                                     dbus.PROPERTIES_IFACE)
 
795
                self.calls.append(("Get", (interface, property,
 
796
                                           dbus_interface)))
 
797
                return self.attributes[property]
 
798
            def __getitem__(self, key):
 
799
                return self.attributes[key]
 
800
            def __setitem__(self, key, value):
 
801
                self.attributes[key] = value
 
802
        self.clients = collections.OrderedDict([
 
803
            ("foo",
 
804
             MockClient(
 
805
                 "foo",
 
806
                 KeyID=("92ed150794387c03ce684574b1139a65"
 
807
                        "94a34f895daaaf09fd8ea90a27cddb12"),
 
808
                 Secret=b"secret",
 
809
                 Host="foo.example.org",
 
810
                 Enabled=dbus.Boolean(True),
 
811
                 Timeout=300000,
 
812
                 LastCheckedOK="2019-02-03T00:00:00",
 
813
                 Created="2019-01-02T00:00:00",
 
814
                 Interval=120000,
 
815
                 Fingerprint=("778827225BA7DE539C5A"
 
816
                              "7CFA59CFF7CDBD9A5920"),
 
817
                 CheckerRunning=dbus.Boolean(False),
 
818
                 LastEnabled="2019-01-03T00:00:00",
 
819
                 ApprovalPending=dbus.Boolean(False),
 
820
                 ApprovedByDefault=dbus.Boolean(True),
 
821
                 LastApprovalRequest="",
 
822
                 ApprovalDelay=0,
 
823
                 ApprovalDuration=1000,
 
824
                 Checker="fping -q -- %(host)s",
 
825
                 ExtendedTimeout=900000,
 
826
                 Expires="2019-02-04T00:00:00",
 
827
                 LastCheckerStatus=0)),
 
828
            ("barbar",
 
829
             MockClient(
 
830
                 "barbar",
 
831
                 KeyID=("0558568eedd67d622f5c83b35a115f79"
 
832
                        "6ab612cff5ad227247e46c2b020f441c"),
 
833
                 Secret=b"secretbar",
 
834
                 Host="192.0.2.3",
 
835
                 Enabled=dbus.Boolean(True),
 
836
                 Timeout=300000,
 
837
                 LastCheckedOK="2019-02-04T00:00:00",
 
838
                 Created="2019-01-03T00:00:00",
 
839
                 Interval=120000,
 
840
                 Fingerprint=("3E393AEAEFB84C7E89E2"
 
841
                              "F547B3A107558FCA3A27"),
 
842
                 CheckerRunning=dbus.Boolean(True),
 
843
                 LastEnabled="2019-01-04T00:00:00",
 
844
                 ApprovalPending=dbus.Boolean(False),
 
845
                 ApprovedByDefault=dbus.Boolean(False),
 
846
                 LastApprovalRequest="2019-01-03T00:00:00",
 
847
                 ApprovalDelay=30000,
 
848
                 ApprovalDuration=1000,
 
849
                 Checker=":",
 
850
                 ExtendedTimeout=900000,
 
851
                 Expires="2019-02-05T00:00:00",
 
852
                 LastCheckerStatus=-2)),
 
853
            ])
 
854
 
 
855
class TestPrintTableCmd(TestCmd):
 
856
    def test_normal(self):
 
857
        output = PrintTableCmd().output(self.clients)
 
858
        expected_output = """
 
859
Name   Enabled Timeout  Last Successful Check
 
860
foo    Yes     00:05:00 2019-02-03T00:00:00  
 
861
barbar Yes     00:05:00 2019-02-04T00:00:00  
 
862
"""[1:-1]
 
863
        self.assertEqual(output, expected_output)
 
864
    def test_verbose(self):
 
865
        output = PrintTableCmd(verbose=True).output(self.clients)
 
866
        expected_output = """
 
867
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
 
868
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                  
 
869
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                 
 
870
"""[1:-1]
 
871
        self.assertEqual(output, expected_output)
 
872
    def test_one_client(self):
 
873
        output = PrintTableCmd().output({"foo": self.clients["foo"]})
 
874
        expected_output = """
 
875
Name Enabled Timeout  Last Successful Check
 
876
foo  Yes     00:05:00 2019-02-03T00:00:00  
 
877
"""[1:-1]
 
878
        self.assertEqual(output, expected_output)
 
879
 
 
880
class TestDumpJSONCmd(TestCmd):
 
881
    def setUp(self):
 
882
        self.expected_json = {
 
883
            "foo": {
 
884
                "Name": "foo",
 
885
                "KeyID": ("92ed150794387c03ce684574b1139a65"
 
886
                          "94a34f895daaaf09fd8ea90a27cddb12"),
 
887
                "Host": "foo.example.org",
 
888
                "Enabled": True,
 
889
                "Timeout": 300000,
 
890
                "LastCheckedOK": "2019-02-03T00:00:00",
 
891
                "Created": "2019-01-02T00:00:00",
 
892
                "Interval": 120000,
 
893
                "Fingerprint": ("778827225BA7DE539C5A"
 
894
                                "7CFA59CFF7CDBD9A5920"),
 
895
                "CheckerRunning": False,
 
896
                "LastEnabled": "2019-01-03T00:00:00",
 
897
                "ApprovalPending": False,
 
898
                "ApprovedByDefault": True,
 
899
                "LastApprovalRequest": "",
 
900
                "ApprovalDelay": 0,
 
901
                "ApprovalDuration": 1000,
 
902
                "Checker": "fping -q -- %(host)s",
 
903
                "ExtendedTimeout": 900000,
 
904
                "Expires": "2019-02-04T00:00:00",
 
905
                "LastCheckerStatus": 0,
 
906
            },
 
907
            "barbar": {
 
908
                "Name": "barbar",
 
909
                "KeyID": ("0558568eedd67d622f5c83b35a115f79"
 
910
                          "6ab612cff5ad227247e46c2b020f441c"),
 
911
                "Host": "192.0.2.3",
 
912
                "Enabled": True,
 
913
                "Timeout": 300000,
 
914
                "LastCheckedOK": "2019-02-04T00:00:00",
 
915
                "Created": "2019-01-03T00:00:00",
 
916
                "Interval": 120000,
 
917
                "Fingerprint": ("3E393AEAEFB84C7E89E2"
 
918
                                "F547B3A107558FCA3A27"),
 
919
                "CheckerRunning": True,
 
920
                "LastEnabled": "2019-01-04T00:00:00",
 
921
                "ApprovalPending": False,
 
922
                "ApprovedByDefault": False,
 
923
                "LastApprovalRequest": "2019-01-03T00:00:00",
 
924
                "ApprovalDelay": 30000,
 
925
                "ApprovalDuration": 1000,
 
926
                "Checker": ":",
 
927
                "ExtendedTimeout": 900000,
 
928
                "Expires": "2019-02-05T00:00:00",
 
929
                "LastCheckerStatus": -2,
 
930
            },
 
931
        }
 
932
        return super(TestDumpJSONCmd, self).setUp()
 
933
    def test_normal(self):
 
934
        json_data = json.loads(DumpJSONCmd().output(self.clients))
 
935
        self.assertDictEqual(json_data, self.expected_json)
 
936
    def test_one_client(self):
 
937
        clients = {"foo": self.clients["foo"]}
 
938
        json_data = json.loads(DumpJSONCmd().output(clients))
 
939
        expected_json = {"foo": self.expected_json["foo"]}
 
940
        self.assertDictEqual(json_data, expected_json)
 
941
 
 
942
class TestIsEnabledCmd(TestCmd):
 
943
    def test_is_enabled(self):
 
944
        self.assertTrue(all(IsEnabledCmd().is_enabled(client)
 
945
                            for client in self.clients.values()))
 
946
    def test_is_enabled_does_get_attribute(self):
 
947
        client = self.clients["foo"]
 
948
        self.assertTrue(IsEnabledCmd().is_enabled(client))
 
949
        self.assertListEqual(client.calls,
 
950
                             [("Get",
 
951
                               ("se.recompile.Mandos.Client",
 
952
                                "Enabled",
 
953
                                "org.freedesktop.DBus.Properties"))])
 
954
    def test_is_enabled_run_exits_successfully(self):
 
955
        client = self.clients["foo"]
 
956
        with self.assertRaises(SystemExit) as e:
 
957
            IsEnabledCmd().run(None, [client])
 
958
        if e.exception.code is not None:
 
959
            self.assertEqual(e.exception.code, 0)
 
960
        else:
 
961
            self.assertIsNone(e.exception.code)
 
962
    def test_is_enabled_run_exits_with_failure(self):
 
963
        client = self.clients["foo"]
 
964
        client["Enabled"] = dbus.Boolean(False)
 
965
        with self.assertRaises(SystemExit) as e:
 
966
            IsEnabledCmd().run(None, [client])
 
967
        if isinstance(e.exception.code, int):
 
968
            self.assertNotEqual(e.exception.code, 0)
 
969
        else:
 
970
            self.assertIsNotNone(e.exception.code)
 
971
 
 
972
 
 
973
class TestRemoveCmd(TestCmd):
 
974
    def test_remove(self):
 
975
        client = self.clients["foo"]
 
976
        class MockMandos(object):
 
977
            def __init__(self):
 
978
                self.calls = []
 
979
            def RemoveClient(self, dbus_path):
 
980
                self.calls.append(("RemoveClient", (dbus_path,)))
 
981
        mandos = MockMandos()
 
982
        RemoveCmd().run(mandos, [client])
 
983
        self.assertEqual(len(mandos.calls), 1)
 
984
        self.assertListEqual(mandos.calls,
 
985
                             [("RemoveClient",
 
986
                               (client.__dbus_object_path__,))])
 
987
 
 
988
 
 
989
 
 
990
def should_only_run_tests():
 
991
    parser = argparse.ArgumentParser(add_help=False)
 
992
    parser.add_argument("--check", action='store_true')
 
993
    args, unknown_args = parser.parse_known_args()
 
994
    run_tests = args.check
 
995
    if run_tests:
 
996
        # Remove --check argument from sys.argv
 
997
        sys.argv[1:] = unknown_args
 
998
    return run_tests
 
999
 
 
1000
# Add all tests from doctest strings
 
1001
def load_tests(loader, tests, none):
 
1002
    import doctest
 
1003
    tests.addTests(doctest.DocTestSuite())
 
1004
    return tests
495
1005
 
496
1006
if __name__ == "__main__":
497
 
    main()
 
1007
    if should_only_run_tests():
 
1008
        # Call using ./tdd-python-script --check [--verbose]
 
1009
        unittest.main()
 
1010
    else:
 
1011
        main()