/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-11 05:15:24 UTC
  • Revision ID: teddy@recompile.se-20190211051524-yxvuh6xj86ag3xqk
Fix Debian watch file

* debian/watch: Make the ".orig" suffix non-optional; otherwise uscan
  thinks that ".orig" is part of the version number.

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