/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-03 14:21:15 UTC
  • Revision ID: teddy@recompile.se-20190303142115-qdbpaz17ms5cq7y5
mandos-ctl: Refactor

* mandos-ctl (main): Move argument parsing into separate function.
  (commands_and_clients_from_options): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
3
 
# 
 
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
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
# 
6
 
# Copyright © 2008-2014 Teddy Hogeborn
7
 
# Copyright © 2008-2014 Björn Påhlsson
8
 
# 
9
 
# This program is free software: you can redistribute it and/or modify
10
 
# it under the terms of the GNU General Public License as published by
 
5
#
 
6
# Copyright © 2008-2019 Teddy Hogeborn
 
7
# Copyright © 2008-2019 Björn Påhlsson
 
8
#
 
9
# This file is part of Mandos.
 
10
#
 
11
# Mandos is free software: you can redistribute it and/or modify it
 
12
# under the terms of the GNU General Public License as published by
11
13
# the Free Software Foundation, either version 3 of the License, or
12
14
# (at your option) any later version.
13
15
#
14
 
#     This program is distributed in the hope that it will be useful,
15
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     Mandos is distributed in the hope that it will be useful, but
 
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
16
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
19
#     GNU General Public License for more details.
18
 
# 
 
20
#
19
21
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see
21
 
# <http://www.gnu.org/licenses/>.
22
 
# 
 
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
23
#
23
24
# Contact the authors at <mandos@recompile.se>.
24
 
# 
 
25
#
25
26
 
26
27
from __future__ import (division, absolute_import, print_function,
27
28
                        unicode_literals)
38
39
import re
39
40
import os
40
41
import collections
41
 
import doctest
 
42
import json
 
43
import unittest
 
44
import logging
42
45
 
43
46
import dbus
44
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
 
45
59
if sys.version_info.major == 2:
46
60
    str = unicode
47
61
 
48
62
locale.setlocale(locale.LC_ALL, "")
49
63
 
50
 
tablewords = {
51
 
    "Name": "Name",
52
 
    "Enabled": "Enabled",
53
 
    "Timeout": "Timeout",
54
 
    "LastCheckedOK": "Last Successful Check",
55
 
    "LastApprovalRequest": "Last Approval Request",
56
 
    "Created": "Created",
57
 
    "Interval": "Interval",
58
 
    "Host": "Host",
59
 
    "Fingerprint": "Fingerprint",
60
 
    "CheckerRunning": "Check Is Running",
61
 
    "LastEnabled": "Last Enabled",
62
 
    "ApprovalPending": "Approval Is Pending",
63
 
    "ApprovedByDefault": "Approved By Default",
64
 
    "ApprovalDelay": "Approval Delay",
65
 
    "ApprovalDuration": "Approval Duration",
66
 
    "Checker": "Checker",
67
 
    "ExtendedTimeout" : "Extended Timeout"
68
 
    }
69
 
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
70
64
domain = "se.recompile"
71
65
busname = domain + ".Mandos"
72
66
server_path = "/"
73
67
server_interface = domain + ".Mandos"
74
68
client_interface = domain + ".Mandos.Client"
75
 
version = "1.6.9"
 
69
version = "1.8.3"
 
70
 
 
71
 
 
72
try:
 
73
    dbus.OBJECT_MANAGER_IFACE
 
74
except AttributeError:
 
75
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
76
 
76
77
 
77
78
def milliseconds_to_string(ms):
78
79
    td = datetime.timedelta(0, 0, 0, ms)
79
80
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{}T".format(td.days) if td.days else "",
81
 
                    hours = td.seconds // 3600,
82
 
                    minutes = (td.seconds % 3600) // 60,
83
 
                    seconds = td.seconds % 60,
84
 
                    ))
 
81
            .format(days="{}T".format(td.days) if td.days else "",
 
82
                    hours=td.seconds // 3600,
 
83
                    minutes=(td.seconds % 3600) // 60,
 
84
                    seconds=td.seconds % 60))
85
85
 
86
86
 
87
87
def rfc3339_duration_to_delta(duration):
88
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
89
 
    
 
89
 
90
90
    >>> rfc3339_duration_to_delta("P7D")
91
91
    datetime.timedelta(7)
92
92
    >>> rfc3339_duration_to_delta("PT60S")
93
93
    datetime.timedelta(0, 60)
94
94
    >>> rfc3339_duration_to_delta("PT60M")
95
95
    datetime.timedelta(0, 3600)
 
96
    >>> rfc3339_duration_to_delta("P60M")
 
97
    datetime.timedelta(1680)
96
98
    >>> rfc3339_duration_to_delta("PT24H")
97
99
    datetime.timedelta(1)
98
100
    >>> rfc3339_duration_to_delta("P1W")
101
103
    datetime.timedelta(0, 330)
102
104
    >>> rfc3339_duration_to_delta("P1DT3M20S")
103
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'
104
135
    """
105
 
    
 
136
 
106
137
    # Parsing an RFC 3339 duration with regular expressions is not
107
138
    # possible - there would have to be multiple places for the same
108
139
    # values, like seconds.  The current code, while more esoteric, is
109
140
    # cleaner without depending on a parsing library.  If Python had a
110
141
    # built-in library for parsing we would use it, but we'd like to
111
142
    # avoid excessive use of external libraries.
112
 
    
 
143
 
113
144
    # New type for defining tokens, syntax, and semantics all-in-one
114
 
    Token = collections.namedtuple("Token",
115
 
                                   ("regexp", # To match token; if
116
 
                                              # "value" is not None,
117
 
                                              # must have a "group"
118
 
                                              # containing digits
119
 
                                    "value",  # datetime.timedelta or
120
 
                                              # None
121
 
                                    "followers")) # Tokens valid after
122
 
                                                  # this token
 
145
    Token = collections.namedtuple("Token", (
 
146
        "regexp",  # To match token; if "value" is not None, must have
 
147
                   # a "group" containing digits
 
148
        "value",   # datetime.timedelta or None
 
149
        "followers"))           # Tokens valid after this token
123
150
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
151
    # the "duration" ABNF definition in RFC 3339, Appendix A.
125
152
    token_end = Token(re.compile(r"$"), None, frozenset())
126
153
    token_second = Token(re.compile(r"(\d+)S"),
127
154
                         datetime.timedelta(seconds=1),
128
 
                         frozenset((token_end,)))
 
155
                         frozenset((token_end, )))
129
156
    token_minute = Token(re.compile(r"(\d+)M"),
130
157
                         datetime.timedelta(minutes=1),
131
158
                         frozenset((token_second, token_end)))
147
174
                       frozenset((token_month, token_end)))
148
175
    token_week = Token(re.compile(r"(\d+)W"),
149
176
                       datetime.timedelta(weeks=1),
150
 
                       frozenset((token_end,)))
 
177
                       frozenset((token_end, )))
151
178
    token_duration = Token(re.compile(r"P"), None,
152
179
                           frozenset((token_year, token_month,
153
180
                                      token_day, token_time,
154
181
                                      token_week)))
155
 
    # Define starting values
156
 
    value = datetime.timedelta() # Value so far
 
182
    # Define starting values:
 
183
    # Value so far
 
184
    value = datetime.timedelta()
157
185
    found_token = None
158
 
    followers = frozenset((token_duration,)) # Following valid tokens
159
 
    s = duration                # String left to parse
 
186
    # Following valid tokens
 
187
    followers = frozenset((token_duration, ))
 
188
    # String left to parse
 
189
    s = duration
160
190
    # Loop until end token is found
161
191
    while found_token is not token_end:
162
192
        # Search for any currently valid tokens
178
208
                break
179
209
        else:
180
210
            # No currently valid tokens were found
181
 
            raise ValueError("Invalid RFC 3339 duration")
 
211
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
212
                             .format(duration))
182
213
    # End token found
183
214
    return value
184
215
 
185
216
 
186
217
def string_to_delta(interval):
187
 
    """Parse a string and return a datetime.timedelta
188
 
    
189
 
    >>> string_to_delta("7d")
190
 
    datetime.timedelta(7)
191
 
    >>> string_to_delta("60s")
192
 
    datetime.timedelta(0, 60)
193
 
    >>> string_to_delta("60m")
194
 
    datetime.timedelta(0, 3600)
195
 
    >>> string_to_delta("24h")
196
 
    datetime.timedelta(1)
197
 
    >>> string_to_delta("1w")
198
 
    datetime.timedelta(7)
199
 
    >>> string_to_delta("5m 30s")
200
 
    datetime.timedelta(0, 330)
201
 
    """
202
 
    
 
218
    """Parse a string and return a datetime.timedelta"""
 
219
 
203
220
    try:
204
221
        return rfc3339_duration_to_delta(interval)
205
 
    except ValueError:
206
 
        pass
207
 
    
 
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
    """
 
251
 
208
252
    value = datetime.timedelta(0)
209
253
    regexp = re.compile(r"(\d+)([dsmhw]?)")
210
 
    
 
254
 
211
255
    for num, suffix in regexp.findall(interval):
212
256
        if suffix == "d":
213
257
            value += datetime.timedelta(int(num))
223
267
            value += datetime.timedelta(0, 0, 0, int(num))
224
268
    return value
225
269
 
226
 
def print_clients(clients, keywords):
 
270
 
 
271
class TableOfClients(object):
 
272
    tableheaders = {
 
273
        "Name": "Name",
 
274
        "Enabled": "Enabled",
 
275
        "Timeout": "Timeout",
 
276
        "LastCheckedOK": "Last Successful Check",
 
277
        "LastApprovalRequest": "Last Approval Request",
 
278
        "Created": "Created",
 
279
        "Interval": "Interval",
 
280
        "Host": "Host",
 
281
        "Fingerprint": "Fingerprint",
 
282
        "KeyID": "Key ID",
 
283
        "CheckerRunning": "Check Is Running",
 
284
        "LastEnabled": "Last Enabled",
 
285
        "ApprovalPending": "Approval Is Pending",
 
286
        "ApprovedByDefault": "Approved By Default",
 
287
        "ApprovalDelay": "Approval Delay",
 
288
        "ApprovalDuration": "Approval Duration",
 
289
        "Checker": "Checker",
 
290
        "ExtendedTimeout": "Extended Timeout",
 
291
        "Expires": "Expires",
 
292
        "LastCheckerStatus": "Last Checker Status",
 
293
    }
 
294
 
 
295
    def __init__(self, clients, keywords, tableheaders=None):
 
296
        self.clients = clients
 
297
        self.keywords = keywords
 
298
        if tableheaders is not None:
 
299
            self.tableheaders = tableheaders
 
300
 
 
301
    def __str__(self):
 
302
        return "\n".join(self.rows())
 
303
 
 
304
    if sys.version_info.major == 2:
 
305
        __unicode__ = __str__
 
306
        def __str__(self):
 
307
            return str(self).encode(locale.getpreferredencoding())
 
308
 
 
309
    def rows(self):
 
310
        format_string = self.row_formatting_string()
 
311
        rows = [self.header_line(format_string)]
 
312
        rows.extend(self.client_line(client, format_string)
 
313
                    for client in self.clients)
 
314
        return rows
 
315
 
 
316
    def row_formatting_string(self):
 
317
        "Format string used to format table rows"
 
318
        return " ".join("{{{key}:{width}}}".format(
 
319
            width=max(len(self.tableheaders[key]),
 
320
                      *(len(self.string_from_client(client, key))
 
321
                        for client in self.clients)),
 
322
            key=key)
 
323
                        for key in self.keywords)
 
324
 
 
325
    def string_from_client(self, client, key):
 
326
        return self.valuetostring(client[key], key)
 
327
 
 
328
    @staticmethod
227
329
    def valuetostring(value, keyword):
228
 
        if type(value) is dbus.Boolean:
 
330
        if isinstance(value, dbus.Boolean):
229
331
            return "Yes" if value else "No"
230
332
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
231
333
                       "ApprovalDuration", "ExtendedTimeout"):
232
334
            return milliseconds_to_string(value)
233
335
        return str(value)
234
 
    
235
 
    # Create format string to print table rows
236
 
    format_string = " ".join("{{{key}:{width}}}".format(
237
 
            width = max(len(tablewords[key]),
238
 
                        max(len(valuetostring(client[key],
239
 
                                              key))
240
 
                            for client in
241
 
                            clients)),
242
 
            key = key) for key in keywords)
243
 
    # Print header line
244
 
    print(format_string.format(**tablewords))
245
 
    for client in clients:
246
 
        print(format_string.format(**{ key:
247
 
                                           valuetostring(client[key],
248
 
                                                         key)
249
 
                                       for key in keywords }))
 
336
 
 
337
    def header_line(self, format_string):
 
338
        return format_string.format(**self.tableheaders)
 
339
 
 
340
    def client_line(self, client, format_string):
 
341
        return format_string.format(
 
342
            **{key: self.string_from_client(client, key)
 
343
               for key in self.keywords})
 
344
 
 
345
 
 
346
## Classes for commands.
 
347
 
 
348
# Abstract classes first
 
349
class Command(object):
 
350
    """Abstract class for commands"""
 
351
    def run(self, mandos, clients):
 
352
        """Normal commands should implement run_on_one_client(), but
 
353
        commands which want to operate on all clients at the same time
 
354
        can override this run() method instead."""
 
355
        self.mandos = mandos
 
356
        for client in clients:
 
357
            self.run_on_one_client(client)
 
358
 
 
359
class PrintCmd(Command):
 
360
    """Abstract class for commands printing client details"""
 
361
    all_keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
362
                    "Created", "Interval", "Host", "KeyID",
 
363
                    "Fingerprint", "CheckerRunning", "LastEnabled",
 
364
                    "ApprovalPending", "ApprovedByDefault",
 
365
                    "LastApprovalRequest", "ApprovalDelay",
 
366
                    "ApprovalDuration", "Checker", "ExtendedTimeout",
 
367
                    "Expires", "LastCheckerStatus")
 
368
    def run(self, mandos, clients):
 
369
        print(self.output(clients))
 
370
 
 
371
class PropertyCmd(Command):
 
372
    """Abstract class for Actions for setting one client property"""
 
373
    def run_on_one_client(self, client):
 
374
        """Set the Client's D-Bus property"""
 
375
        client.Set(client_interface, self.property, self.value_to_set,
 
376
                   dbus_interface=dbus.PROPERTIES_IFACE)
 
377
 
 
378
class ValueArgumentMixIn(object):
 
379
    """Mixin class for commands taking a value as argument"""
 
380
    def __init__(self, value):
 
381
        self.value_to_set = value
 
382
 
 
383
class MillisecondsValueArgumentMixIn(ValueArgumentMixIn):
 
384
    """Mixin class for commands taking a value argument as
 
385
    milliseconds."""
 
386
    @property
 
387
    def value_to_set(self):
 
388
        return self._vts
 
389
    @value_to_set.setter
 
390
    def value_to_set(self, value):
 
391
        """When setting, convert value to a datetime.timedelta"""
 
392
        self._vts = string_to_delta(value).total_seconds() * 1000
 
393
 
 
394
# Actual (non-abstract) command classes
 
395
 
 
396
class PrintTableCmd(PrintCmd):
 
397
    def __init__(self, verbose=False):
 
398
        self.verbose = verbose
 
399
    def output(self, clients):
 
400
        if self.verbose:
 
401
            keywords = self.all_keywords
 
402
        else:
 
403
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
 
404
        return str(TableOfClients(clients.values(), keywords))
 
405
 
 
406
class DumpJSONCmd(PrintCmd):
 
407
    def output(self, clients):
 
408
        data = {client["Name"]:
 
409
                {key: self.dbus_boolean_to_bool(client[key])
 
410
                 for key in self.all_keywords}
 
411
                for client in clients.values()}
 
412
        return json.dumps(data, indent=4, separators=(',', ': '))
 
413
    @staticmethod
 
414
    def dbus_boolean_to_bool(value):
 
415
        if isinstance(value, dbus.Boolean):
 
416
            value = bool(value)
 
417
        return value
 
418
 
 
419
class IsEnabledCmd(Command):
 
420
    def run_on_one_client(self, client):
 
421
        if self.is_enabled(client):
 
422
            sys.exit(0)
 
423
        sys.exit(1)
 
424
    def is_enabled(self, client):
 
425
        return client.Get(client_interface, "Enabled",
 
426
                          dbus_interface=dbus.PROPERTIES_IFACE)
 
427
 
 
428
class RemoveCmd(Command):
 
429
    def run_on_one_client(self, client):
 
430
        self.mandos.RemoveClient(client.__dbus_object_path__)
 
431
 
 
432
class ApproveCmd(Command):
 
433
    def run_on_one_client(self, client):
 
434
        client.Approve(dbus.Boolean(True),
 
435
                       dbus_interface=client_interface)
 
436
 
 
437
class DenyCmd(Command):
 
438
    def run_on_one_client(self, client):
 
439
        client.Approve(dbus.Boolean(False),
 
440
                       dbus_interface=client_interface)
 
441
 
 
442
class EnableCmd(PropertyCmd):
 
443
    property = "Enabled"
 
444
    value_to_set = dbus.Boolean(True)
 
445
 
 
446
class DisableCmd(PropertyCmd):
 
447
    property = "Enabled"
 
448
    value_to_set = dbus.Boolean(False)
 
449
 
 
450
class BumpTimeoutCmd(PropertyCmd):
 
451
    property = "LastCheckedOK"
 
452
    value_to_set = ""
 
453
 
 
454
class StartCheckerCmd(PropertyCmd):
 
455
    property = "CheckerRunning"
 
456
    value_to_set = dbus.Boolean(True)
 
457
 
 
458
class StopCheckerCmd(PropertyCmd):
 
459
    property = "CheckerRunning"
 
460
    value_to_set = dbus.Boolean(False)
 
461
 
 
462
class ApproveByDefaultCmd(PropertyCmd):
 
463
    property = "ApprovedByDefault"
 
464
    value_to_set = dbus.Boolean(True)
 
465
 
 
466
class DenyByDefaultCmd(PropertyCmd):
 
467
    property = "ApprovedByDefault"
 
468
    value_to_set = dbus.Boolean(False)
 
469
 
 
470
class SetCheckerCmd(PropertyCmd, ValueArgumentMixIn):
 
471
    property = "Checker"
 
472
 
 
473
class SetHostCmd(PropertyCmd, ValueArgumentMixIn):
 
474
    property = "Host"
 
475
 
 
476
class SetSecretCmd(PropertyCmd, ValueArgumentMixIn):
 
477
    property = "Secret"
 
478
 
 
479
class SetTimeoutCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
480
    property = "Timeout"
 
481
 
 
482
class SetExtendedTimeoutCmd(PropertyCmd,
 
483
                            MillisecondsValueArgumentMixIn):
 
484
    property = "ExtendedTimeout"
 
485
 
 
486
class SetIntervalCmd(PropertyCmd, MillisecondsValueArgumentMixIn):
 
487
    property = "Interval"
 
488
 
 
489
class SetApprovalDelayCmd(PropertyCmd,
 
490
                          MillisecondsValueArgumentMixIn):
 
491
    property = "ApprovalDelay"
 
492
 
 
493
class SetApprovalDurationCmd(PropertyCmd,
 
494
                             MillisecondsValueArgumentMixIn):
 
495
    property = "ApprovalDuration"
250
496
 
251
497
def has_actions(options):
252
498
    return any((options.enable,
268
514
                options.approve,
269
515
                options.deny))
270
516
 
271
 
def main():
 
517
 
 
518
def commands_and_clients_from_options():
272
519
    parser = argparse.ArgumentParser()
273
520
    parser.add_argument("--version", action="version",
274
 
                        version = "%(prog)s {}".format(version),
 
521
                        version="%(prog)s {}".format(version),
275
522
                        help="show version number and exit")
276
523
    parser.add_argument("-a", "--all", action="store_true",
277
524
                        help="Select all clients")
278
525
    parser.add_argument("-v", "--verbose", action="store_true",
279
526
                        help="Print all fields")
280
 
    parser.add_argument("-e", "--enable", action="store_true",
281
 
                        help="Enable client")
282
 
    parser.add_argument("-d", "--disable", action="store_true",
283
 
                        help="disable client")
 
527
    parser.add_argument("-j", "--dump-json", action="store_true",
 
528
                        help="Dump client data in JSON format")
 
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")
284
535
    parser.add_argument("-b", "--bump-timeout", action="store_true",
285
536
                        help="Bump timeout for client")
286
 
    parser.add_argument("--start-checker", action="store_true",
287
 
                        help="Start checker for client")
288
 
    parser.add_argument("--stop-checker", action="store_true",
289
 
                        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")
290
544
    parser.add_argument("-V", "--is-enabled", action="store_true",
291
545
                        help="Check if client is enabled")
292
546
    parser.add_argument("-r", "--remove", action="store_true",
299
553
                        help="Set extended timeout for client")
300
554
    parser.add_argument("-i", "--interval",
301
555
                        help="Set checker interval for client")
302
 
    parser.add_argument("--approve-by-default", action="store_true",
303
 
                        default=None, dest="approved_by_default",
304
 
                        help="Set client to be approved by default")
305
 
    parser.add_argument("--deny-by-default", action="store_false",
306
 
                        dest="approved_by_default",
307
 
                        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")
308
565
    parser.add_argument("--approval-delay",
309
566
                        help="Set delay before client approve/deny")
310
567
    parser.add_argument("--approval-duration",
313
570
    parser.add_argument("-s", "--secret",
314
571
                        type=argparse.FileType(mode="rb"),
315
572
                        help="Set password blob (file) for client")
316
 
    parser.add_argument("-A", "--approve", action="store_true",
317
 
                        help="Approve any current client request")
318
 
    parser.add_argument("-D", "--deny", action="store_true",
319
 
                        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")
320
579
    parser.add_argument("--check", action="store_true",
321
580
                        help="Run self-test")
322
581
    parser.add_argument("client", nargs="*", help="Client name")
323
582
    options = parser.parse_args()
324
 
    
 
583
 
325
584
    if has_actions(options) and not (options.client or options.all):
326
585
        parser.error("Options require clients names or --all.")
327
586
    if options.verbose and has_actions(options):
328
 
        parser.error("--verbose can only be used alone or with"
329
 
                     " --all.")
 
587
        parser.error("--verbose can only be used alone.")
 
588
    if options.dump_json and (options.verbose
 
589
                              or has_actions(options)):
 
590
        parser.error("--dump-json can only be used alone.")
330
591
    if options.all and not has_actions(options):
331
592
        parser.error("--all requires an action.")
332
 
 
333
 
    if options.check:
334
 
        fail_count, test_count = doctest.testmod()
335
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
336
 
    
 
593
    if options.is_enabled and len(options.client) > 1:
 
594
            parser.error("--is-enabled requires exactly one client")
 
595
 
 
596
    commands = []
 
597
 
 
598
    if options.dump_json:
 
599
        commands.append(DumpJSONCmd())
 
600
 
 
601
    if options.enable:
 
602
        commands.append(EnableCmd())
 
603
 
 
604
    if options.disable:
 
605
        commands.append(DisableCmd())
 
606
 
 
607
    if options.bump_timeout:
 
608
        commands.append(BumpTimeoutCmd(options.bump_timeout))
 
609
 
 
610
    if options.start_checker:
 
611
        commands.append(StartCheckerCmd())
 
612
 
 
613
    if options.stop_checker:
 
614
        commands.append(StopCheckerCmd())
 
615
 
 
616
    if options.is_enabled:
 
617
        commands.append(IsEnabledCmd())
 
618
 
 
619
    if options.remove:
 
620
        commands.append(RemoveCmd())
 
621
 
 
622
    if options.checker is not None:
 
623
        commands.append(SetCheckerCmd())
 
624
 
 
625
    if options.timeout is not None:
 
626
        commands.append(SetTimeoutCmd(options.timeout))
 
627
 
 
628
    if options.extended_timeout:
 
629
        commands.append(
 
630
            SetExtendedTimeoutCmd(options.extended_timeout))
 
631
 
 
632
    if options.interval is not None:
 
633
        command.append(SetIntervalCmd(options.interval))
 
634
 
 
635
    if options.approved_by_default is not None:
 
636
        if options.approved_by_default:
 
637
            command.append(ApproveByDefaultCmd())
 
638
        else:
 
639
            command.append(DenyByDefaultCmd())
 
640
 
 
641
    if options.approval_delay is not None:
 
642
        command.append(SetApprovalDelayCmd(options.approval_delay))
 
643
 
 
644
    if options.approval_duration is not None:
 
645
        command.append(
 
646
            SetApprovalDurationCmd(options.approval_duration))
 
647
 
 
648
    if options.host is not None:
 
649
        command.append(SetHostCmd(options.host))
 
650
 
 
651
    if options.secret is not None:
 
652
        command.append(SetSecretCmd(options.secret))
 
653
 
 
654
    if options.approve:
 
655
        commands.append(ApproveCmd())
 
656
 
 
657
    if options.deny:
 
658
        commands.append(DenyCmd())
 
659
 
 
660
    # If no command option has been given, show table of clients,
 
661
    # optionally verbosely
 
662
    if not commands:
 
663
        commands.append(PrintTableCmd(verbose=options.verbose))
 
664
 
 
665
    return commands, options.client
 
666
 
 
667
 
 
668
def main():
 
669
    commands, clientnames = commands_and_clients_from_options()
 
670
 
337
671
    try:
338
672
        bus = dbus.SystemBus()
339
673
        mandos_dbus_objc = bus.get_object(busname, server_path)
340
674
    except dbus.exceptions.DBusException:
341
 
        print("Could not connect to Mandos server",
342
 
              file=sys.stderr)
 
675
        log.critical("Could not connect to Mandos server")
343
676
        sys.exit(1)
344
 
    
 
677
 
345
678
    mandos_serv = dbus.Interface(mandos_dbus_objc,
346
 
                                 dbus_interface = server_interface)
347
 
    
348
 
    #block stderr since dbus library prints to stderr
349
 
    null = os.open(os.path.devnull, os.O_RDWR)
350
 
    stderrcopy = os.dup(sys.stderr.fileno())
351
 
    os.dup2(null, sys.stderr.fileno())
352
 
    os.close(null)
 
679
                                 dbus_interface=server_interface)
 
680
    mandos_serv_object_manager = dbus.Interface(
 
681
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
682
 
 
683
    # Filter out log message from dbus module
 
684
    dbus_logger = logging.getLogger("dbus.proxies")
 
685
    class NullFilter(logging.Filter):
 
686
        def filter(self, record):
 
687
            return False
 
688
    dbus_filter = NullFilter()
 
689
    dbus_logger.addFilter(dbus_filter)
353
690
    try:
354
691
        try:
355
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
692
            mandos_clients = {path: ifs_and_props[client_interface]
 
693
                              for path, ifs_and_props in
 
694
                              mandos_serv_object_manager
 
695
                              .GetManagedObjects().items()
 
696
                              if client_interface in ifs_and_props}
356
697
        finally:
357
 
            #restore stderr
358
 
            os.dup2(stderrcopy, sys.stderr.fileno())
359
 
            os.close(stderrcopy)
360
 
    except dbus.exceptions.DBusException:
361
 
        print("Access denied: Accessing mandos server through dbus.",
362
 
              file=sys.stderr)
 
698
            # restore dbus logger
 
699
            dbus_logger.removeFilter(dbus_filter)
 
700
    except dbus.exceptions.DBusException as e:
 
701
        log.critical("Failed to access Mandos server through D-Bus:"
 
702
                     "\n%s", e)
363
703
        sys.exit(1)
364
 
    
 
704
 
365
705
    # Compile dict of (clients: properties) to process
366
 
    clients={}
367
 
    
368
 
    if options.all or not options.client:
369
 
        clients = { bus.get_object(busname, path): properties
370
 
                    for path, properties in mandos_clients.items() }
 
706
    clients = {}
 
707
 
 
708
    if not clientnames:
 
709
        clients = {bus.get_object(busname, path): properties
 
710
                   for path, properties in mandos_clients.items()}
371
711
    else:
372
 
        for name in options.client:
 
712
        for name in clientnames:
373
713
            for path, client in mandos_clients.items():
374
714
                if client["Name"] == name:
375
715
                    client_objc = bus.get_object(busname, path)
376
716
                    clients[client_objc] = client
377
717
                    break
378
718
            else:
379
 
                print("Client not found on server: {!r}"
380
 
                      .format(name), file=sys.stderr)
 
719
                log.critical("Client not found on server: %r", name)
381
720
                sys.exit(1)
382
 
    
383
 
    if not has_actions(options) and clients:
384
 
        if options.verbose:
385
 
            keywords = ("Name", "Enabled", "Timeout",
386
 
                        "LastCheckedOK", "Created", "Interval",
387
 
                        "Host", "Fingerprint", "CheckerRunning",
388
 
                        "LastEnabled", "ApprovalPending",
389
 
                        "ApprovedByDefault",
390
 
                        "LastApprovalRequest", "ApprovalDelay",
391
 
                        "ApprovalDuration", "Checker",
392
 
                        "ExtendedTimeout")
 
721
 
 
722
    # Run all commands on clients
 
723
    for command in commands:
 
724
        command.run(mandos_serv, clients)
 
725
 
 
726
 
 
727
class Test_milliseconds_to_string(unittest.TestCase):
 
728
    def test_all(self):
 
729
        self.assertEqual(milliseconds_to_string(93785000),
 
730
                         "1T02:03:05")
 
731
    def test_no_days(self):
 
732
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
 
733
    def test_all_zero(self):
 
734
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
 
735
    def test_no_fractional_seconds(self):
 
736
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
 
737
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
 
738
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
 
739
 
 
740
class Test_string_to_delta(unittest.TestCase):
 
741
    def test_handles_basic_rfc3339(self):
 
742
        self.assertEqual(string_to_delta("PT2H"),
 
743
                         datetime.timedelta(0, 7200))
 
744
    def test_falls_back_to_pre_1_6_1_with_warning(self):
 
745
        # assertLogs only exists in Python 3.4
 
746
        if hasattr(self, "assertLogs"):
 
747
            with self.assertLogs(log, logging.WARNING):
 
748
                value = string_to_delta("2h")
393
749
        else:
394
 
            keywords = defaultkeywords
395
 
        
396
 
        print_clients(clients.values(), keywords)
397
 
    else:
398
 
        # Process each client in the list by all selected options
399
 
        for client in clients:
400
 
            def set_client_prop(prop, value):
401
 
                """Set a Client D-Bus property"""
402
 
                client.Set(client_interface, prop, value,
403
 
                           dbus_interface=dbus.PROPERTIES_IFACE)
404
 
            def set_client_prop_ms(prop, value):
405
 
                """Set a Client D-Bus property, converted
406
 
                from a string to milliseconds."""
407
 
                set_client_prop(prop,
408
 
                                string_to_delta(value).total_seconds()
409
 
                                * 1000)
410
 
            if options.remove:
411
 
                mandos_serv.RemoveClient(client.__dbus_object_path__)
412
 
            if options.enable:
413
 
                set_client_prop("Enabled", dbus.Boolean(True))
414
 
            if options.disable:
415
 
                set_client_prop("Enabled", dbus.Boolean(False))
416
 
            if options.bump_timeout:
417
 
                set_client_prop("LastCheckedOK", "")
418
 
            if options.start_checker:
419
 
                set_client_prop("CheckerRunning", dbus.Boolean(True))
420
 
            if options.stop_checker:
421
 
                set_client_prop("CheckerRunning", dbus.Boolean(False))
422
 
            if options.is_enabled:
423
 
                sys.exit(0 if client.Get(client_interface,
424
 
                                         "Enabled",
425
 
                                         dbus_interface=
426
 
                                         dbus.PROPERTIES_IFACE)
427
 
                         else 1)
428
 
            if options.checker is not None:
429
 
                set_client_prop("Checker", options.checker)
430
 
            if options.host is not None:
431
 
                set_client_prop("Host", options.host)
432
 
            if options.interval is not None:
433
 
                set_client_prop_ms("Interval", options.interval)
434
 
            if options.approval_delay is not None:
435
 
                set_client_prop_ms("ApprovalDelay",
436
 
                                   options.approval_delay)
437
 
            if options.approval_duration is not None:
438
 
                set_client_prop_ms("ApprovalDuration",
439
 
                                   options.approval_duration)
440
 
            if options.timeout is not None:
441
 
                set_client_prop_ms("Timeout", options.timeout)
442
 
            if options.extended_timeout is not None:
443
 
                set_client_prop_ms("ExtendedTimeout",
444
 
                                   options.extended_timeout)
445
 
            if options.secret is not None:
446
 
                set_client_prop("Secret",
447
 
                                dbus.ByteArray(options.secret.read()))
448
 
            if options.approved_by_default is not None:
449
 
                set_client_prop("ApprovedByDefault",
450
 
                                dbus.Boolean(options
451
 
                                             .approved_by_default))
452
 
            if options.approve:
453
 
                client.Approve(dbus.Boolean(True),
454
 
                               dbus_interface=client_interface)
455
 
            elif options.deny:
456
 
                client.Approve(dbus.Boolean(False),
457
 
                               dbus_interface=client_interface)
 
750
            class WarningFilter(logging.Filter):
 
751
                """Don't show, but record the presence of, warnings"""
 
752
                def filter(self, record):
 
753
                    is_warning = record.levelno >= logging.WARNING
 
754
                    self.found = is_warning or getattr(self, "found",
 
755
                                                       False)
 
756
                    return not is_warning
 
757
            warning_filter = WarningFilter()
 
758
            log.addFilter(warning_filter)
 
759
            try:
 
760
                value = string_to_delta("2h")
 
761
            finally:
 
762
                log.removeFilter(warning_filter)
 
763
            self.assertTrue(getattr(warning_filter, "found", False))
 
764
        self.assertEqual(value, datetime.timedelta(0, 7200))
 
765
 
 
766
class Test_TableOfClients(unittest.TestCase):
 
767
    def setUp(self):
 
768
        self.tableheaders = {
 
769
            "Attr1": "X",
 
770
            "AttrTwo": "Yy",
 
771
            "AttrThree": "Zzz",
 
772
            "Bool": "A D-BUS Boolean",
 
773
            "NonDbusBoolean": "A Non-D-BUS Boolean",
 
774
            "Integer": "An Integer",
 
775
            "Timeout": "Timedelta 1",
 
776
            "Interval": "Timedelta 2",
 
777
            "ApprovalDelay": "Timedelta 3",
 
778
            "ApprovalDuration": "Timedelta 4",
 
779
            "ExtendedTimeout": "Timedelta 5",
 
780
            "String": "A String",
 
781
        }
 
782
        self.keywords = ["Attr1", "AttrTwo"]
 
783
        self.clients = [
 
784
            {
 
785
                "Attr1": "x1",
 
786
                "AttrTwo": "y1",
 
787
                "AttrThree": "z1",
 
788
                "Bool": dbus.Boolean(False),
 
789
                "NonDbusBoolean": False,
 
790
                "Integer": 0,
 
791
                "Timeout": 0,
 
792
                "Interval": 1000,
 
793
                "ApprovalDelay": 2000,
 
794
                "ApprovalDuration": 3000,
 
795
                "ExtendedTimeout": 4000,
 
796
                "String": "",
 
797
            },
 
798
            {
 
799
                "Attr1": "x2",
 
800
                "AttrTwo": "y2",
 
801
                "AttrThree": "z2",
 
802
                "Bool": dbus.Boolean(True),
 
803
                "NonDbusBoolean": True,
 
804
                "Integer": 1,
 
805
                "Timeout": 93785000,
 
806
                "Interval": 93786000,
 
807
                "ApprovalDelay": 93787000,
 
808
                "ApprovalDuration": 93788000,
 
809
                "ExtendedTimeout": 93789000,
 
810
                "String": "A huge string which will not fit," * 10,
 
811
            },
 
812
        ]
 
813
    def test_short_header(self):
 
814
        text = str(TableOfClients(self.clients, self.keywords,
 
815
                                  self.tableheaders))
 
816
        expected_text = """
 
817
X  Yy
 
818
x1 y1
 
819
x2 y2
 
820
"""[1:-1]
 
821
        self.assertEqual(text, expected_text)
 
822
    def test_booleans(self):
 
823
        keywords = ["Bool", "NonDbusBoolean"]
 
824
        text = str(TableOfClients(self.clients, keywords,
 
825
                                  self.tableheaders))
 
826
        expected_text = """
 
827
A D-BUS Boolean A Non-D-BUS Boolean
 
828
No              False              
 
829
Yes             True               
 
830
"""[1:-1]
 
831
        self.assertEqual(text, expected_text)
 
832
    def test_milliseconds_detection(self):
 
833
        keywords = ["Integer", "Timeout", "Interval", "ApprovalDelay",
 
834
                    "ApprovalDuration", "ExtendedTimeout"]
 
835
        text = str(TableOfClients(self.clients, keywords,
 
836
                                  self.tableheaders))
 
837
        expected_text = """
 
838
An Integer Timedelta 1 Timedelta 2 Timedelta 3 Timedelta 4 Timedelta 5
 
839
0          00:00:00    00:00:01    00:00:02    00:00:03    00:00:04   
 
840
1          1T02:03:05  1T02:03:06  1T02:03:07  1T02:03:08  1T02:03:09 
 
841
"""[1:-1]
 
842
        self.assertEqual(text, expected_text)
 
843
    def test_empty_and_long_string_values(self):
 
844
        keywords = ["String"]
 
845
        text = str(TableOfClients(self.clients, keywords,
 
846
                                  self.tableheaders))
 
847
        expected_text = """
 
848
A String                                                                                                                                                                                                                                                                                                                                  
 
849
                                                                                                                                                                                                                                                                                                                                          
 
850
A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,A huge string which will not fit,
 
851
"""[1:-1]
 
852
        self.assertEqual(text, expected_text)
 
853
 
 
854
 
 
855
 
 
856
def should_only_run_tests():
 
857
    parser = argparse.ArgumentParser(add_help=False)
 
858
    parser.add_argument("--check", action='store_true')
 
859
    args, unknown_args = parser.parse_known_args()
 
860
    run_tests = args.check
 
861
    if run_tests:
 
862
        # Remove --check argument from sys.argv
 
863
        sys.argv[1:] = unknown_args
 
864
    return run_tests
 
865
 
 
866
# Add all tests from doctest strings
 
867
def load_tests(loader, tests, none):
 
868
    import doctest
 
869
    tests.addTests(doctest.DocTestSuite())
 
870
    return tests
458
871
 
459
872
if __name__ == "__main__":
460
 
    main()
 
873
    if should_only_run_tests():
 
874
        # Call using ./tdd-python-script --check [--verbose]
 
875
        unittest.main()
 
876
    else:
 
877
        main()