/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-ctl
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
# 
 
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
 
# 
6
 
# Copyright © 2008-2012 Teddy Hogeborn
7
 
# Copyright © 2008-2012 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-2018 Teddy Hogeborn
 
7
# Copyright © 2008-2018 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)
28
29
 
 
30
try:
 
31
    from future_builtins import *
 
32
except ImportError:
 
33
    pass
 
34
 
29
35
import sys
30
 
import dbus
31
36
import argparse
32
37
import locale
33
38
import datetime
34
39
import re
35
40
import os
 
41
import collections
 
42
import json
 
43
 
 
44
import dbus
 
45
 
 
46
if sys.version_info.major == 2:
 
47
    str = unicode
36
48
 
37
49
locale.setlocale(locale.LC_ALL, "")
38
50
 
46
58
    "Interval": "Interval",
47
59
    "Host": "Host",
48
60
    "Fingerprint": "Fingerprint",
 
61
    "KeyID": "Key ID",
49
62
    "CheckerRunning": "Check Is Running",
50
63
    "LastEnabled": "Last Enabled",
51
64
    "ApprovalPending": "Approval Is Pending",
53
66
    "ApprovalDelay": "Approval Delay",
54
67
    "ApprovalDuration": "Approval Duration",
55
68
    "Checker": "Checker",
56
 
    "ExtendedTimeout" : "Extended Timeout"
57
 
    }
 
69
    "ExtendedTimeout": "Extended Timeout",
 
70
    "Expires": "Expires",
 
71
    "LastCheckerStatus": "Last Checker Status",
 
72
}
58
73
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
59
74
domain = "se.recompile"
60
75
busname = domain + ".Mandos"
61
76
server_path = "/"
62
77
server_interface = domain + ".Mandos"
63
78
client_interface = domain + ".Mandos.Client"
64
 
version = "1.5.3"
65
 
 
66
 
def timedelta_to_milliseconds(td):
67
 
    """Convert a datetime.timedelta object to milliseconds"""
68
 
    return ((td.days * 24 * 60 * 60 * 1000)
69
 
            + (td.seconds * 1000)
70
 
            + (td.microseconds // 1000))
 
79
version = "1.7.20"
 
80
 
 
81
 
 
82
try:
 
83
    dbus.OBJECT_MANAGER_IFACE
 
84
except AttributeError:
 
85
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
86
 
71
87
 
72
88
def milliseconds_to_string(ms):
73
89
    td = datetime.timedelta(0, 0, 0, ms)
74
90
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
75
 
            .format(days = "{0}T".format(td.days) if td.days else "",
76
 
                    hours = td.seconds // 3600,
77
 
                    minutes = (td.seconds % 3600) // 60,
78
 
                    seconds = td.seconds % 60,
79
 
                    ))
 
91
            .format(days="{}T".format(td.days) if td.days else "",
 
92
                    hours=td.seconds // 3600,
 
93
                    minutes=(td.seconds % 3600) // 60,
 
94
                    seconds=td.seconds % 60))
 
95
 
 
96
 
 
97
def rfc3339_duration_to_delta(duration):
 
98
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
99
 
 
100
    >>> rfc3339_duration_to_delta("P7D")
 
101
    datetime.timedelta(7)
 
102
    >>> rfc3339_duration_to_delta("PT60S")
 
103
    datetime.timedelta(0, 60)
 
104
    >>> rfc3339_duration_to_delta("PT60M")
 
105
    datetime.timedelta(0, 3600)
 
106
    >>> rfc3339_duration_to_delta("PT24H")
 
107
    datetime.timedelta(1)
 
108
    >>> rfc3339_duration_to_delta("P1W")
 
109
    datetime.timedelta(7)
 
110
    >>> rfc3339_duration_to_delta("PT5M30S")
 
111
    datetime.timedelta(0, 330)
 
112
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
113
    datetime.timedelta(1, 200)
 
114
    """
 
115
 
 
116
    # Parsing an RFC 3339 duration with regular expressions is not
 
117
    # possible - there would have to be multiple places for the same
 
118
    # values, like seconds.  The current code, while more esoteric, is
 
119
    # cleaner without depending on a parsing library.  If Python had a
 
120
    # built-in library for parsing we would use it, but we'd like to
 
121
    # avoid excessive use of external libraries.
 
122
 
 
123
    # New type for defining tokens, syntax, and semantics all-in-one
 
124
    Token = collections.namedtuple("Token", (
 
125
        "regexp",  # To match token; if "value" is not None, must have
 
126
                   # a "group" containing digits
 
127
        "value",   # datetime.timedelta or None
 
128
        "followers"))           # Tokens valid after this token
 
129
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
130
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
131
    token_end = Token(re.compile(r"$"), None, frozenset())
 
132
    token_second = Token(re.compile(r"(\d+)S"),
 
133
                         datetime.timedelta(seconds=1),
 
134
                         frozenset((token_end, )))
 
135
    token_minute = Token(re.compile(r"(\d+)M"),
 
136
                         datetime.timedelta(minutes=1),
 
137
                         frozenset((token_second, token_end)))
 
138
    token_hour = Token(re.compile(r"(\d+)H"),
 
139
                       datetime.timedelta(hours=1),
 
140
                       frozenset((token_minute, token_end)))
 
141
    token_time = Token(re.compile(r"T"),
 
142
                       None,
 
143
                       frozenset((token_hour, token_minute,
 
144
                                  token_second)))
 
145
    token_day = Token(re.compile(r"(\d+)D"),
 
146
                      datetime.timedelta(days=1),
 
147
                      frozenset((token_time, token_end)))
 
148
    token_month = Token(re.compile(r"(\d+)M"),
 
149
                        datetime.timedelta(weeks=4),
 
150
                        frozenset((token_day, token_end)))
 
151
    token_year = Token(re.compile(r"(\d+)Y"),
 
152
                       datetime.timedelta(weeks=52),
 
153
                       frozenset((token_month, token_end)))
 
154
    token_week = Token(re.compile(r"(\d+)W"),
 
155
                       datetime.timedelta(weeks=1),
 
156
                       frozenset((token_end, )))
 
157
    token_duration = Token(re.compile(r"P"), None,
 
158
                           frozenset((token_year, token_month,
 
159
                                      token_day, token_time,
 
160
                                      token_week)))
 
161
    # Define starting values:
 
162
    # Value so far
 
163
    value = datetime.timedelta()
 
164
    found_token = None
 
165
    # Following valid tokens
 
166
    followers = frozenset((token_duration, ))
 
167
    # String left to parse
 
168
    s = duration
 
169
    # Loop until end token is found
 
170
    while found_token is not token_end:
 
171
        # Search for any currently valid tokens
 
172
        for token in followers:
 
173
            match = token.regexp.match(s)
 
174
            if match is not None:
 
175
                # Token found
 
176
                if token.value is not None:
 
177
                    # Value found, parse digits
 
178
                    factor = int(match.group(1), 10)
 
179
                    # Add to value so far
 
180
                    value += factor * token.value
 
181
                # Strip token from string
 
182
                s = token.regexp.sub("", s, 1)
 
183
                # Go to found token
 
184
                found_token = token
 
185
                # Set valid next tokens
 
186
                followers = found_token.followers
 
187
                break
 
188
        else:
 
189
            # No currently valid tokens were found
 
190
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
191
                             .format(duration))
 
192
    # End token found
 
193
    return value
 
194
 
80
195
 
81
196
def string_to_delta(interval):
82
197
    """Parse a string and return a datetime.timedelta
83
 
    
84
 
    >>> string_to_delta("7d")
 
198
 
 
199
    >>> string_to_delta('7d')
85
200
    datetime.timedelta(7)
86
 
    >>> string_to_delta("60s")
 
201
    >>> string_to_delta('60s')
87
202
    datetime.timedelta(0, 60)
88
 
    >>> string_to_delta("60m")
 
203
    >>> string_to_delta('60m')
89
204
    datetime.timedelta(0, 3600)
90
 
    >>> string_to_delta("24h")
 
205
    >>> string_to_delta('24h')
91
206
    datetime.timedelta(1)
92
 
    >>> string_to_delta("1w")
 
207
    >>> string_to_delta('1w')
93
208
    datetime.timedelta(7)
94
 
    >>> string_to_delta("5m 30s")
 
209
    >>> string_to_delta('5m 30s')
95
210
    datetime.timedelta(0, 330)
96
211
    """
 
212
 
 
213
    try:
 
214
        return rfc3339_duration_to_delta(interval)
 
215
    except ValueError:
 
216
        pass
 
217
 
97
218
    value = datetime.timedelta(0)
98
 
    regexp = re.compile("(\d+)([dsmhw]?)")
99
 
    
 
219
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
220
 
100
221
    for num, suffix in regexp.findall(interval):
101
222
        if suffix == "d":
102
223
            value += datetime.timedelta(int(num))
112
233
            value += datetime.timedelta(0, 0, 0, int(num))
113
234
    return value
114
235
 
 
236
 
115
237
def print_clients(clients, keywords):
116
238
    def valuetostring(value, keyword):
117
239
        if type(value) is dbus.Boolean:
119
241
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
120
242
                       "ApprovalDuration", "ExtendedTimeout"):
121
243
            return milliseconds_to_string(value)
122
 
        return unicode(value)
123
 
    
 
244
        return str(value)
 
245
 
124
246
    # Create format string to print table rows
125
247
    format_string = " ".join("{{{key}:{width}}}".format(
126
 
            width = max(len(tablewords[key]),
127
 
                        max(len(valuetostring(client[key],
128
 
                                              key))
129
 
                            for client in
130
 
                            clients)),
131
 
            key = key) for key in keywords)
 
248
        width=max(len(tablewords[key]),
 
249
                  max(len(valuetostring(client[key], key))
 
250
                      for client in clients)),
 
251
        key=key)
 
252
                             for key in keywords)
132
253
    # Print header line
133
254
    print(format_string.format(**tablewords))
134
255
    for client in clients:
135
 
        print(format_string.format(**dict((key,
136
 
                                           valuetostring(client[key],
137
 
                                                         key))
138
 
                                          for key in keywords)))
 
256
        print(format_string
 
257
              .format(**{key: valuetostring(client[key], key)
 
258
                         for key in keywords}))
 
259
 
139
260
 
140
261
def has_actions(options):
141
262
    return any((options.enable,
157
278
                options.approve,
158
279
                options.deny))
159
280
 
 
281
 
160
282
def main():
161
283
    parser = argparse.ArgumentParser()
162
284
    parser.add_argument("--version", action="version",
163
 
                        version = "%(prog)s {0}".format(version),
 
285
                        version="%(prog)s {}".format(version),
164
286
                        help="show version number and exit")
165
287
    parser.add_argument("-a", "--all", action="store_true",
166
288
                        help="Select all clients")
167
289
    parser.add_argument("-v", "--verbose", action="store_true",
168
290
                        help="Print all fields")
 
291
    parser.add_argument("-j", "--dump-json", action="store_true",
 
292
                        help="Dump client data in JSON format")
169
293
    parser.add_argument("-e", "--enable", action="store_true",
170
294
                        help="Enable client")
171
295
    parser.add_argument("-d", "--disable", action="store_true",
199
323
    parser.add_argument("--approval-duration",
200
324
                        help="Set duration of one client approval")
201
325
    parser.add_argument("-H", "--host", help="Set host for client")
202
 
    parser.add_argument("-s", "--secret", type=file,
 
326
    parser.add_argument("-s", "--secret",
 
327
                        type=argparse.FileType(mode="rb"),
203
328
                        help="Set password blob (file) for client")
204
329
    parser.add_argument("-A", "--approve", action="store_true",
205
330
                        help="Approve any current client request")
206
331
    parser.add_argument("-D", "--deny", action="store_true",
207
332
                        help="Deny any current client request")
 
333
    parser.add_argument("--check", action="store_true",
 
334
                        help="Run self-test")
208
335
    parser.add_argument("client", nargs="*", help="Client name")
209
336
    options = parser.parse_args()
210
 
    
 
337
 
211
338
    if has_actions(options) and not (options.client or options.all):
212
339
        parser.error("Options require clients names or --all.")
213
340
    if options.verbose and has_actions(options):
214
 
        parser.error("--verbose can only be used alone or with"
215
 
                     " --all.")
 
341
        parser.error("--verbose can only be used alone.")
 
342
    if options.dump_json and (options.verbose
 
343
                              or has_actions(options)):
 
344
        parser.error("--dump-json can only be used alone.")
216
345
    if options.all and not has_actions(options):
217
346
        parser.error("--all requires an action.")
218
 
    
 
347
 
 
348
    if options.check:
 
349
        import doctest
 
350
        fail_count, test_count = doctest.testmod()
 
351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
352
 
219
353
    try:
220
354
        bus = dbus.SystemBus()
221
355
        mandos_dbus_objc = bus.get_object(busname, server_path)
222
356
    except dbus.exceptions.DBusException:
223
 
        print("Could not connect to Mandos server",
224
 
              file=sys.stderr)
 
357
        print("Could not connect to Mandos server", file=sys.stderr)
225
358
        sys.exit(1)
226
 
    
 
359
 
227
360
    mandos_serv = dbus.Interface(mandos_dbus_objc,
228
 
                                 dbus_interface = server_interface)
229
 
    
230
 
    #block stderr since dbus library prints to stderr
 
361
                                 dbus_interface=server_interface)
 
362
    mandos_serv_object_manager = dbus.Interface(
 
363
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
 
364
 
 
365
    # block stderr since dbus library prints to stderr
231
366
    null = os.open(os.path.devnull, os.O_RDWR)
232
367
    stderrcopy = os.dup(sys.stderr.fileno())
233
368
    os.dup2(null, sys.stderr.fileno())
234
369
    os.close(null)
235
370
    try:
236
371
        try:
237
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
372
            mandos_clients = {path: ifs_and_props[client_interface]
 
373
                              for path, ifs_and_props in
 
374
                              mandos_serv_object_manager
 
375
                              .GetManagedObjects().items()
 
376
                              if client_interface in ifs_and_props}
238
377
        finally:
239
 
            #restore stderr
 
378
            # restore stderr
240
379
            os.dup2(stderrcopy, sys.stderr.fileno())
241
380
            os.close(stderrcopy)
242
 
    except dbus.exceptions.DBusException:
243
 
        print("Access denied: Accessing mandos server through dbus.",
 
381
    except dbus.exceptions.DBusException as e:
 
382
        print("Access denied: "
 
383
              "Accessing mandos server through D-Bus: {}".format(e),
244
384
              file=sys.stderr)
245
385
        sys.exit(1)
246
 
    
 
386
 
247
387
    # Compile dict of (clients: properties) to process
248
 
    clients={}
249
 
    
 
388
    clients = {}
 
389
 
250
390
    if options.all or not options.client:
251
 
        clients = dict((bus.get_object(busname, path), properties)
252
 
                       for path, properties in
253
 
                       mandos_clients.iteritems())
 
391
        clients = {bus.get_object(busname, path): properties
 
392
                   for path, properties in mandos_clients.items()}
254
393
    else:
255
394
        for name in options.client:
256
 
            for path, client in mandos_clients.iteritems():
 
395
            for path, client in mandos_clients.items():
257
396
                if client["Name"] == name:
258
397
                    client_objc = bus.get_object(busname, path)
259
398
                    clients[client_objc] = client
260
399
                    break
261
400
            else:
262
 
                print("Client not found on server: {0!r}"
 
401
                print("Client not found on server: {!r}"
263
402
                      .format(name), file=sys.stderr)
264
403
                sys.exit(1)
265
 
    
 
404
 
266
405
    if not has_actions(options) and clients:
267
 
        if options.verbose:
268
 
            keywords = ("Name", "Enabled", "Timeout",
269
 
                        "LastCheckedOK", "Created", "Interval",
270
 
                        "Host", "Fingerprint", "CheckerRunning",
 
406
        if options.verbose or options.dump_json:
 
407
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
408
                        "Created", "Interval", "Host", "KeyID",
 
409
                        "Fingerprint", "CheckerRunning",
271
410
                        "LastEnabled", "ApprovalPending",
272
 
                        "ApprovedByDefault",
273
 
                        "LastApprovalRequest", "ApprovalDelay",
274
 
                        "ApprovalDuration", "Checker",
275
 
                        "ExtendedTimeout")
 
411
                        "ApprovedByDefault", "LastApprovalRequest",
 
412
                        "ApprovalDelay", "ApprovalDuration",
 
413
                        "Checker", "ExtendedTimeout", "Expires",
 
414
                        "LastCheckerStatus")
276
415
        else:
277
416
            keywords = defaultkeywords
278
 
        
279
 
        print_clients(clients.values(), keywords)
 
417
 
 
418
        if options.dump_json:
 
419
            json.dump({client["Name"]: {key:
 
420
                                        bool(client[key])
 
421
                                        if isinstance(client[key],
 
422
                                                      dbus.Boolean)
 
423
                                        else client[key]
 
424
                                        for key in keywords}
 
425
                       for client in clients.values()},
 
426
                      fp=sys.stdout, indent=4,
 
427
                      separators=(',', ': '))
 
428
            print()
 
429
        else:
 
430
            print_clients(clients.values(), keywords)
280
431
    else:
281
432
        # Process each client in the list by all selected options
282
433
        for client in clients:
 
434
 
283
435
            def set_client_prop(prop, value):
284
436
                """Set a Client D-Bus property"""
285
437
                client.Set(client_interface, prop, value,
286
438
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
439
 
287
440
            def set_client_prop_ms(prop, value):
288
441
                """Set a Client D-Bus property, converted
289
442
                from a string to milliseconds."""
290
443
                set_client_prop(prop,
291
 
                                timedelta_to_milliseconds
292
 
                                (string_to_delta(value)))
 
444
                                string_to_delta(value).total_seconds()
 
445
                                * 1000)
 
446
 
293
447
            if options.remove:
294
448
                mandos_serv.RemoveClient(client.__dbus_object_path__)
295
449
            if options.enable:
303
457
            if options.stop_checker:
304
458
                set_client_prop("CheckerRunning", dbus.Boolean(False))
305
459
            if options.is_enabled:
306
 
                sys.exit(0 if client.Get(client_interface,
307
 
                                         "Enabled",
308
 
                                         dbus_interface=
309
 
                                         dbus.PROPERTIES_IFACE)
310
 
                         else 1)
 
460
                if client.Get(client_interface, "Enabled",
 
461
                              dbus_interface=dbus.PROPERTIES_IFACE):
 
462
                    sys.exit(0)
 
463
                else:
 
464
                    sys.exit(1)
311
465
            if options.checker is not None:
312
466
                set_client_prop("Checker", options.checker)
313
467
            if options.host is not None:
339
493
                client.Approve(dbus.Boolean(False),
340
494
                               dbus_interface=client_interface)
341
495
 
 
496
 
342
497
if __name__ == "__main__":
343
498
    main()