/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-17 02:45:02 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 319.
  • Revision ID: teddy@recompile.se-20140717024502-yg5ysk05lx8275k9
Update non-package install instructions.

* INSTALL: Update package names, URLs and versions.  Remove discussion
           of adjusting network device name.  Adjust minimum reboot
           time to reflect new default timeout value.

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