/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: 2012-06-22 23:33:56 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" option.

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