/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: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

Show diffs side-by-side

added added

removed removed

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