/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

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 22:17:55 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 321.
  • Revision ID: teddy@recompile.se-20140725221755-7bak9szduz53wwtq
INSTALL: Add org-mode setting to show all text when opening.

* INSTALL (STARTUP): New org-mode setting; set to "showall".

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