/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-ctl

* mandos: White space and other misc. format fixes only.

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-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
 
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
13
11
# the Free Software Foundation, either version 3 of the License, or
14
12
# (at your option) any later version.
15
13
#
16
 
#     Mandos is distributed in the hope that it will be useful, but
17
 
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
18
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
17
#     GNU General Public License for more details.
20
 
#
 
18
# 
21
19
# You should have received a copy of the GNU General Public License
22
 
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
23
 
#
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
24
23
# Contact the authors at <mandos@recompile.se>.
25
 
#
 
24
# 
26
25
 
27
26
from __future__ import (division, absolute_import, print_function,
28
27
                        unicode_literals)
29
28
 
30
 
try:
31
 
    from future_builtins import *
32
 
except ImportError:
33
 
    pass
34
 
 
35
29
import sys
 
30
import dbus
36
31
import argparse
37
32
import locale
38
33
import datetime
39
34
import re
40
35
import os
41
 
import collections
42
 
import json
43
 
 
44
 
import dbus
45
 
 
46
 
if sys.version_info.major == 2:
47
 
    str = unicode
48
36
 
49
37
locale.setlocale(locale.LC_ALL, "")
50
38
 
58
46
    "Interval": "Interval",
59
47
    "Host": "Host",
60
48
    "Fingerprint": "Fingerprint",
61
 
    "KeyID": "Key ID",
62
49
    "CheckerRunning": "Check Is Running",
63
50
    "LastEnabled": "Last Enabled",
64
51
    "ApprovalPending": "Approval Is Pending",
66
53
    "ApprovalDelay": "Approval Delay",
67
54
    "ApprovalDuration": "Approval Duration",
68
55
    "Checker": "Checker",
69
 
    "ExtendedTimeout": "Extended Timeout",
70
 
    "Expires": "Expires",
71
 
    "LastCheckerStatus": "Last Checker Status",
72
 
}
 
56
    "ExtendedTimeout" : "Extended Timeout"
 
57
    }
73
58
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
74
59
domain = "se.recompile"
75
60
busname = domain + ".Mandos"
76
61
server_path = "/"
77
62
server_interface = domain + ".Mandos"
78
63
client_interface = domain + ".Mandos.Client"
79
 
version = "1.8.2"
80
 
 
81
 
 
82
 
try:
83
 
    dbus.OBJECT_MANAGER_IFACE
84
 
except AttributeError:
85
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
86
 
 
 
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))
87
71
 
88
72
def milliseconds_to_string(ms):
89
73
    td = datetime.timedelta(0, 0, 0, ms)
90
74
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
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
 
 
 
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
                    ))
195
80
 
196
81
def string_to_delta(interval):
197
82
    """Parse a string and return a datetime.timedelta
198
 
 
199
 
    >>> string_to_delta('7d')
 
83
    
 
84
    >>> string_to_delta("7d")
200
85
    datetime.timedelta(7)
201
 
    >>> string_to_delta('60s')
 
86
    >>> string_to_delta("60s")
202
87
    datetime.timedelta(0, 60)
203
 
    >>> string_to_delta('60m')
 
88
    >>> string_to_delta("60m")
204
89
    datetime.timedelta(0, 3600)
205
 
    >>> string_to_delta('24h')
 
90
    >>> string_to_delta("24h")
206
91
    datetime.timedelta(1)
207
 
    >>> string_to_delta('1w')
 
92
    >>> string_to_delta("1w")
208
93
    datetime.timedelta(7)
209
 
    >>> string_to_delta('5m 30s')
 
94
    >>> string_to_delta("5m 30s")
210
95
    datetime.timedelta(0, 330)
211
96
    """
212
 
 
213
 
    try:
214
 
        return rfc3339_duration_to_delta(interval)
215
 
    except ValueError:
216
 
        pass
217
 
 
218
97
    value = datetime.timedelta(0)
219
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
220
 
 
 
98
    regexp = re.compile("(\d+)([dsmhw]?)")
 
99
    
221
100
    for num, suffix in regexp.findall(interval):
222
101
        if suffix == "d":
223
102
            value += datetime.timedelta(int(num))
233
112
            value += datetime.timedelta(0, 0, 0, int(num))
234
113
    return value
235
114
 
236
 
 
237
115
def print_clients(clients, keywords):
238
116
    def valuetostring(value, keyword):
239
117
        if type(value) is dbus.Boolean:
241
119
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
242
120
                       "ApprovalDuration", "ExtendedTimeout"):
243
121
            return milliseconds_to_string(value)
244
 
        return str(value)
245
 
 
 
122
        return unicode(value)
 
123
    
246
124
    # Create format string to print table rows
247
125
    format_string = " ".join("{{{key}:{width}}}".format(
248
 
        width=max(len(tablewords[key]),
249
 
                  max(len(valuetostring(client[key], key))
250
 
                      for client in clients)),
251
 
        key=key)
252
 
                             for key in keywords)
 
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)
253
132
    # Print header line
254
133
    print(format_string.format(**tablewords))
255
134
    for client in clients:
256
 
        print(format_string
257
 
              .format(**{key: valuetostring(client[key], key)
258
 
                         for key in keywords}))
259
 
 
 
135
        print(format_string.format(**dict((key,
 
136
                                           valuetostring(client[key],
 
137
                                                         key))
 
138
                                          for key in keywords)))
260
139
 
261
140
def has_actions(options):
262
141
    return any((options.enable,
278
157
                options.approve,
279
158
                options.deny))
280
159
 
281
 
 
282
160
def main():
283
161
    parser = argparse.ArgumentParser()
284
162
    parser.add_argument("--version", action="version",
285
 
                        version="%(prog)s {}".format(version),
 
163
                        version = "%(prog)s {0}".format(version),
286
164
                        help="show version number and exit")
287
165
    parser.add_argument("-a", "--all", action="store_true",
288
166
                        help="Select all clients")
289
167
    parser.add_argument("-v", "--verbose", action="store_true",
290
168
                        help="Print all fields")
291
 
    parser.add_argument("-j", "--dump-json", action="store_true",
292
 
                        help="Dump client data in JSON format")
293
169
    parser.add_argument("-e", "--enable", action="store_true",
294
170
                        help="Enable client")
295
171
    parser.add_argument("-d", "--disable", action="store_true",
323
199
    parser.add_argument("--approval-duration",
324
200
                        help="Set duration of one client approval")
325
201
    parser.add_argument("-H", "--host", help="Set host for client")
326
 
    parser.add_argument("-s", "--secret",
327
 
                        type=argparse.FileType(mode="rb"),
 
202
    parser.add_argument("-s", "--secret", type=file,
328
203
                        help="Set password blob (file) for client")
329
204
    parser.add_argument("-A", "--approve", action="store_true",
330
205
                        help="Approve any current client request")
331
206
    parser.add_argument("-D", "--deny", action="store_true",
332
207
                        help="Deny any current client request")
333
 
    parser.add_argument("--check", action="store_true",
334
 
                        help="Run self-test")
335
208
    parser.add_argument("client", nargs="*", help="Client name")
336
209
    options = parser.parse_args()
337
 
 
 
210
    
338
211
    if has_actions(options) and not (options.client or options.all):
339
212
        parser.error("Options require clients names or --all.")
340
213
    if options.verbose and has_actions(options):
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.")
 
214
        parser.error("--verbose can only be used alone or with"
 
215
                     " --all.")
345
216
    if options.all and not has_actions(options):
346
217
        parser.error("--all requires an action.")
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
 
 
 
218
    
353
219
    try:
354
220
        bus = dbus.SystemBus()
355
221
        mandos_dbus_objc = bus.get_object(busname, server_path)
356
222
    except dbus.exceptions.DBusException:
357
 
        print("Could not connect to Mandos server", file=sys.stderr)
 
223
        print("Could not connect to Mandos server",
 
224
              file=sys.stderr)
358
225
        sys.exit(1)
359
 
 
 
226
    
360
227
    mandos_serv = dbus.Interface(mandos_dbus_objc,
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
 
228
                                 dbus_interface = server_interface)
 
229
    
 
230
    #block stderr since dbus library prints to stderr
366
231
    null = os.open(os.path.devnull, os.O_RDWR)
367
232
    stderrcopy = os.dup(sys.stderr.fileno())
368
233
    os.dup2(null, sys.stderr.fileno())
369
234
    os.close(null)
370
235
    try:
371
236
        try:
372
 
            mandos_clients = {path: ifs_and_props[client_interface]
373
 
                              for path, ifs_and_props in
374
 
                              mandos_serv_object_manager
375
 
                              .GetManagedObjects().items()
376
 
                              if client_interface in ifs_and_props}
 
237
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
377
238
        finally:
378
 
            # restore stderr
 
239
            #restore stderr
379
240
            os.dup2(stderrcopy, sys.stderr.fileno())
380
241
            os.close(stderrcopy)
381
 
    except dbus.exceptions.DBusException as e:
382
 
        print("Access denied: "
383
 
              "Accessing mandos server through D-Bus: {}".format(e),
 
242
    except dbus.exceptions.DBusException:
 
243
        print("Access denied: Accessing mandos server through dbus.",
384
244
              file=sys.stderr)
385
245
        sys.exit(1)
386
 
 
 
246
    
387
247
    # Compile dict of (clients: properties) to process
388
 
    clients = {}
389
 
 
 
248
    clients={}
 
249
    
390
250
    if options.all or not options.client:
391
 
        clients = {bus.get_object(busname, path): properties
392
 
                   for path, properties in mandos_clients.items()}
 
251
        clients = dict((bus.get_object(busname, path), properties)
 
252
                       for path, properties in
 
253
                       mandos_clients.iteritems())
393
254
    else:
394
255
        for name in options.client:
395
 
            for path, client in mandos_clients.items():
 
256
            for path, client in mandos_clients.iteritems():
396
257
                if client["Name"] == name:
397
258
                    client_objc = bus.get_object(busname, path)
398
259
                    clients[client_objc] = client
399
260
                    break
400
261
            else:
401
 
                print("Client not found on server: {!r}"
 
262
                print("Client not found on server: {0!r}"
402
263
                      .format(name), file=sys.stderr)
403
264
                sys.exit(1)
404
 
 
 
265
    
405
266
    if not has_actions(options) and clients:
406
 
        if options.verbose or options.dump_json:
407
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
408
 
                        "Created", "Interval", "Host", "KeyID",
409
 
                        "Fingerprint", "CheckerRunning",
 
267
        if options.verbose:
 
268
            keywords = ("Name", "Enabled", "Timeout",
 
269
                        "LastCheckedOK", "Created", "Interval",
 
270
                        "Host", "Fingerprint", "CheckerRunning",
410
271
                        "LastEnabled", "ApprovalPending",
411
 
                        "ApprovedByDefault", "LastApprovalRequest",
412
 
                        "ApprovalDelay", "ApprovalDuration",
413
 
                        "Checker", "ExtendedTimeout", "Expires",
414
 
                        "LastCheckerStatus")
 
272
                        "ApprovedByDefault",
 
273
                        "LastApprovalRequest", "ApprovalDelay",
 
274
                        "ApprovalDuration", "Checker",
 
275
                        "ExtendedTimeout")
415
276
        else:
416
277
            keywords = defaultkeywords
417
 
 
418
 
        if options.dump_json:
419
 
            json.dump({client["Name"]: {key:
420
 
                                        bool(client[key])
421
 
                                        if isinstance(client[key],
422
 
                                                      dbus.Boolean)
423
 
                                        else client[key]
424
 
                                        for key in keywords}
425
 
                       for client in clients.values()},
426
 
                      fp=sys.stdout, indent=4,
427
 
                      separators=(',', ': '))
428
 
            print()
429
 
        else:
430
 
            print_clients(clients.values(), keywords)
 
278
        
 
279
        print_clients(clients.values(), keywords)
431
280
    else:
432
281
        # Process each client in the list by all selected options
433
282
        for client in clients:
434
 
 
435
283
            def set_client_prop(prop, value):
436
284
                """Set a Client D-Bus property"""
437
285
                client.Set(client_interface, prop, value,
438
286
                           dbus_interface=dbus.PROPERTIES_IFACE)
439
 
 
440
287
            def set_client_prop_ms(prop, value):
441
288
                """Set a Client D-Bus property, converted
442
289
                from a string to milliseconds."""
443
290
                set_client_prop(prop,
444
 
                                string_to_delta(value).total_seconds()
445
 
                                * 1000)
446
 
 
 
291
                                timedelta_to_milliseconds
 
292
                                (string_to_delta(value)))
447
293
            if options.remove:
448
294
                mandos_serv.RemoveClient(client.__dbus_object_path__)
449
295
            if options.enable:
457
303
            if options.stop_checker:
458
304
                set_client_prop("CheckerRunning", dbus.Boolean(False))
459
305
            if options.is_enabled:
460
 
                if client.Get(client_interface, "Enabled",
461
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
462
 
                    sys.exit(0)
463
 
                else:
464
 
                    sys.exit(1)
 
306
                sys.exit(0 if client.Get(client_interface,
 
307
                                         "Enabled",
 
308
                                         dbus_interface=
 
309
                                         dbus.PROPERTIES_IFACE)
 
310
                         else 1)
465
311
            if options.checker is not None:
466
312
                set_client_prop("Checker", options.checker)
467
313
            if options.host is not None:
493
339
                client.Approve(dbus.Boolean(False),
494
340
                               dbus_interface=client_interface)
495
341
 
496
 
 
497
342
if __name__ == "__main__":
498
343
    main()