/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: 2015-07-07 15:49:49 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150707154949-vbuj4pc6wf3o1vgz
mandos.service: Use Type=dbus (implicitly).

mandos.service ([Service]/Type): Removed.
               ([Service]/BusName): Uncommented; set to
                                    "se.recompile.Mandos".

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-2015 Teddy Hogeborn
 
7
# Copyright © 2008-2015 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
 
# Show warnings by default
49
 
if not sys.warnoptions:
50
 
    import warnings
51
 
    warnings.simplefilter("default")
52
 
 
53
 
log = logging.getLogger(sys.argv[0])
54
 
logging.basicConfig(level="INFO", # Show info level messages
55
 
                    format="%(message)s") # Show basic log messages
56
 
 
57
 
logging.captureWarnings(True)   # Show warnings via the logging system
58
 
 
59
45
if sys.version_info.major == 2:
60
46
    str = unicode
61
47
 
71
57
    "Interval": "Interval",
72
58
    "Host": "Host",
73
59
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
60
    "CheckerRunning": "Check Is Running",
76
61
    "LastEnabled": "Last Enabled",
77
62
    "ApprovalPending": "Approval Is Pending",
79
64
    "ApprovalDelay": "Approval Delay",
80
65
    "ApprovalDuration": "Approval Duration",
81
66
    "Checker": "Checker",
82
 
    "ExtendedTimeout": "Extended Timeout",
83
 
    "Expires": "Expires",
84
 
    "LastCheckerStatus": "Last Checker Status",
 
67
    "ExtendedTimeout": "Extended Timeout"
85
68
}
86
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
70
domain = "se.recompile"
89
72
server_path = "/"
90
73
server_interface = domain + ".Mandos"
91
74
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
93
 
 
94
 
 
95
 
try:
96
 
    dbus.OBJECT_MANAGER_IFACE
97
 
except AttributeError:
98
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
75
version = "1.6.9"
99
76
 
100
77
 
101
78
def milliseconds_to_string(ms):
102
79
    td = datetime.timedelta(0, 0, 0, ms)
103
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
104
 
            .format(days="{}T".format(td.days) if td.days else "",
105
 
                    hours=td.seconds // 3600,
106
 
                    minutes=(td.seconds % 3600) // 60,
107
 
                    seconds=td.seconds % 60))
 
80
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
81
        days = "{}T".format(td.days) if td.days else "",
 
82
        hours = td.seconds // 3600,
 
83
        minutes = (td.seconds % 3600) // 60,
 
84
        seconds = td.seconds % 60))
108
85
 
109
86
 
110
87
def rfc3339_duration_to_delta(duration):
111
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
89
    
113
90
    >>> rfc3339_duration_to_delta("P7D")
114
91
    datetime.timedelta(7)
115
92
    >>> rfc3339_duration_to_delta("PT60S")
116
93
    datetime.timedelta(0, 60)
117
94
    >>> rfc3339_duration_to_delta("PT60M")
118
95
    datetime.timedelta(0, 3600)
119
 
    >>> rfc3339_duration_to_delta("P60M")
120
 
    datetime.timedelta(1680)
121
96
    >>> rfc3339_duration_to_delta("PT24H")
122
97
    datetime.timedelta(1)
123
98
    >>> rfc3339_duration_to_delta("P1W")
126
101
    datetime.timedelta(0, 330)
127
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
128
103
    datetime.timedelta(1, 200)
129
 
    >>> # Can not be empty:
130
 
    >>> rfc3339_duration_to_delta("")
131
 
    Traceback (most recent call last):
132
 
    ...
133
 
    ValueError: Invalid RFC 3339 duration: u''
134
 
    >>> # Must start with "P":
135
 
    >>> rfc3339_duration_to_delta("1D")
136
 
    Traceback (most recent call last):
137
 
    ...
138
 
    ValueError: Invalid RFC 3339 duration: u'1D'
139
 
    >>> # Must use correct order
140
 
    >>> rfc3339_duration_to_delta("PT1S2M")
141
 
    Traceback (most recent call last):
142
 
    ...
143
 
    ValueError: Invalid RFC 3339 duration: u'PT1S2M'
144
 
    >>> # Time needs time marker
145
 
    >>> rfc3339_duration_to_delta("P1H2S")
146
 
    Traceback (most recent call last):
147
 
    ...
148
 
    ValueError: Invalid RFC 3339 duration: u'P1H2S'
149
 
    >>> # Weeks can not be combined with anything else
150
 
    >>> rfc3339_duration_to_delta("P1D2W")
151
 
    Traceback (most recent call last):
152
 
    ...
153
 
    ValueError: Invalid RFC 3339 duration: u'P1D2W'
154
 
    >>> rfc3339_duration_to_delta("P2W2H")
155
 
    Traceback (most recent call last):
156
 
    ...
157
 
    ValueError: Invalid RFC 3339 duration: u'P2W2H'
158
104
    """
159
 
 
 
105
    
160
106
    # Parsing an RFC 3339 duration with regular expressions is not
161
107
    # possible - there would have to be multiple places for the same
162
108
    # values, like seconds.  The current code, while more esoteric, is
163
109
    # cleaner without depending on a parsing library.  If Python had a
164
110
    # built-in library for parsing we would use it, but we'd like to
165
111
    # avoid excessive use of external libraries.
166
 
 
 
112
    
167
113
    # New type for defining tokens, syntax, and semantics all-in-one
168
114
    Token = collections.namedtuple("Token", (
169
115
        "regexp",  # To match token; if "value" is not None, must have
202
148
                           frozenset((token_year, token_month,
203
149
                                      token_day, token_time,
204
150
                                      token_week)))
205
 
    # Define starting values:
206
 
    # Value so far
207
 
    value = datetime.timedelta()
 
151
    # Define starting values
 
152
    value = datetime.timedelta() # Value so far
208
153
    found_token = None
209
 
    # Following valid tokens
210
 
    followers = frozenset((token_duration, ))
211
 
    # String left to parse
212
 
    s = duration
 
154
    followers = frozenset((token_duration, )) # Following valid tokens
 
155
    s = duration                # String left to parse
213
156
    # Loop until end token is found
214
157
    while found_token is not token_end:
215
158
        # Search for any currently valid tokens
239
182
 
240
183
def string_to_delta(interval):
241
184
    """Parse a string and return a datetime.timedelta
 
185
    
 
186
    >>> string_to_delta('7d')
 
187
    datetime.timedelta(7)
 
188
    >>> string_to_delta('60s')
 
189
    datetime.timedelta(0, 60)
 
190
    >>> string_to_delta('60m')
 
191
    datetime.timedelta(0, 3600)
 
192
    >>> string_to_delta('24h')
 
193
    datetime.timedelta(1)
 
194
    >>> string_to_delta('1w')
 
195
    datetime.timedelta(7)
 
196
    >>> string_to_delta('5m 30s')
 
197
    datetime.timedelta(0, 330)
242
198
    """
243
 
 
 
199
    
244
200
    try:
245
201
        return rfc3339_duration_to_delta(interval)
246
 
    except ValueError as e:
247
 
        log.warning("%s - Parsing as pre-1.6.1 interval instead",
248
 
                    ' '.join(e.args))
249
 
    return parse_pre_1_6_1_interval(interval)
250
 
 
251
 
 
252
 
def parse_pre_1_6_1_interval(interval):
253
 
    """Parse an interval string as documented by Mandos before 1.6.1, and
254
 
    return a datetime.timedelta
255
 
    >>> parse_pre_1_6_1_interval('7d')
256
 
    datetime.timedelta(7)
257
 
    >>> parse_pre_1_6_1_interval('60s')
258
 
    datetime.timedelta(0, 60)
259
 
    >>> parse_pre_1_6_1_interval('60m')
260
 
    datetime.timedelta(0, 3600)
261
 
    >>> parse_pre_1_6_1_interval('24h')
262
 
    datetime.timedelta(1)
263
 
    >>> parse_pre_1_6_1_interval('1w')
264
 
    datetime.timedelta(7)
265
 
    >>> parse_pre_1_6_1_interval('5m 30s')
266
 
    datetime.timedelta(0, 330)
267
 
    >>> parse_pre_1_6_1_interval('')
268
 
    datetime.timedelta(0)
269
 
    >>> # Ignore unknown characters, allow any order and repetitions
270
 
    >>> parse_pre_1_6_1_interval('2dxy7zz11y3m5m')
271
 
    datetime.timedelta(2, 480, 18000)
272
 
 
273
 
    """
274
 
 
 
202
    except ValueError:
 
203
        pass
 
204
    
275
205
    value = datetime.timedelta(0)
276
206
    regexp = re.compile(r"(\d+)([dsmhw]?)")
277
 
 
 
207
    
278
208
    for num, suffix in regexp.findall(interval):
279
209
        if suffix == "d":
280
210
            value += datetime.timedelta(int(num))
293
223
 
294
224
def print_clients(clients, keywords):
295
225
    def valuetostring(value, keyword):
296
 
        if isinstance(value, dbus.Boolean):
 
226
        if type(value) is dbus.Boolean:
297
227
            return "Yes" if value else "No"
298
228
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
299
229
                       "ApprovalDuration", "ExtendedTimeout"):
300
230
            return milliseconds_to_string(value)
301
231
        return str(value)
302
 
 
 
232
    
303
233
    # Create format string to print table rows
304
234
    format_string = " ".join("{{{key}:{width}}}".format(
305
 
        width=max(len(tablewords[key]),
306
 
                  max(len(valuetostring(client[key], key))
307
 
                      for client in clients)),
308
 
        key=key)
 
235
        width = max(len(tablewords[key]),
 
236
                    max(len(valuetostring(client[key], key))
 
237
                        for client in clients)),
 
238
        key = key)
309
239
                             for key in keywords)
310
240
    # Print header line
311
241
    print(format_string.format(**tablewords))
312
242
    for client in clients:
313
 
        print(format_string
314
 
              .format(**{key: valuetostring(client[key], key)
315
 
                         for key in keywords}))
 
243
        print(format_string.format(**{
 
244
            key: valuetostring(client[key], key)
 
245
            for key in keywords }))
316
246
 
317
247
 
318
248
def has_actions(options):
339
269
def main():
340
270
    parser = argparse.ArgumentParser()
341
271
    parser.add_argument("--version", action="version",
342
 
                        version="%(prog)s {}".format(version),
 
272
                        version = "%(prog)s {}".format(version),
343
273
                        help="show version number and exit")
344
274
    parser.add_argument("-a", "--all", action="store_true",
345
275
                        help="Select all clients")
346
276
    parser.add_argument("-v", "--verbose", action="store_true",
347
277
                        help="Print all fields")
348
 
    parser.add_argument("-j", "--dump-json", action="store_true",
349
 
                        help="Dump client data in JSON format")
350
278
    parser.add_argument("-e", "--enable", action="store_true",
351
279
                        help="Enable client")
352
280
    parser.add_argument("-d", "--disable", action="store_true",
391
319
                        help="Run self-test")
392
320
    parser.add_argument("client", nargs="*", help="Client name")
393
321
    options = parser.parse_args()
394
 
 
 
322
    
395
323
    if has_actions(options) and not (options.client or options.all):
396
324
        parser.error("Options require clients names or --all.")
397
325
    if options.verbose and has_actions(options):
398
 
        parser.error("--verbose can only be used alone.")
399
 
    if options.dump_json and (options.verbose
400
 
                              or has_actions(options)):
401
 
        parser.error("--dump-json can only be used alone.")
 
326
        parser.error("--verbose can only be used alone or with"
 
327
                     " --all.")
402
328
    if options.all and not has_actions(options):
403
329
        parser.error("--all requires an action.")
404
330
 
 
331
    if options.check:
 
332
        fail_count, test_count = doctest.testmod()
 
333
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
334
    
405
335
    try:
406
336
        bus = dbus.SystemBus()
407
337
        mandos_dbus_objc = bus.get_object(busname, server_path)
408
338
    except dbus.exceptions.DBusException:
409
 
        log.critical("Could not connect to Mandos server")
 
339
        print("Could not connect to Mandos server", file=sys.stderr)
410
340
        sys.exit(1)
411
 
 
 
341
    
412
342
    mandos_serv = dbus.Interface(mandos_dbus_objc,
413
 
                                 dbus_interface=server_interface)
414
 
    mandos_serv_object_manager = dbus.Interface(
415
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
416
 
 
417
 
    # block stderr since dbus library prints to stderr
 
343
                                 dbus_interface = server_interface)
 
344
    
 
345
    #block stderr since dbus library prints to stderr
418
346
    null = os.open(os.path.devnull, os.O_RDWR)
419
347
    stderrcopy = os.dup(sys.stderr.fileno())
420
348
    os.dup2(null, sys.stderr.fileno())
421
349
    os.close(null)
422
350
    try:
423
351
        try:
424
 
            mandos_clients = {path: ifs_and_props[client_interface]
425
 
                              for path, ifs_and_props in
426
 
                              mandos_serv_object_manager
427
 
                              .GetManagedObjects().items()
428
 
                              if client_interface in ifs_and_props}
 
352
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
429
353
        finally:
430
 
            # restore stderr
 
354
            #restore stderr
431
355
            os.dup2(stderrcopy, sys.stderr.fileno())
432
356
            os.close(stderrcopy)
433
 
    except dbus.exceptions.DBusException as e:
434
 
        log.critical("Failed to access Mandos server through D-Bus:"
435
 
                     "\n%s", e)
 
357
    except dbus.exceptions.DBusException:
 
358
        print("Access denied: Accessing mandos server through dbus.",
 
359
              file=sys.stderr)
436
360
        sys.exit(1)
437
 
 
 
361
    
438
362
    # Compile dict of (clients: properties) to process
439
 
    clients = {}
440
 
 
 
363
    clients={}
 
364
    
441
365
    if options.all or not options.client:
442
 
        clients = {bus.get_object(busname, path): properties
443
 
                   for path, properties in mandos_clients.items()}
 
366
        clients = { bus.get_object(busname, path): properties
 
367
                    for path, properties in mandos_clients.items() }
444
368
    else:
445
369
        for name in options.client:
446
370
            for path, client in mandos_clients.items():
449
373
                    clients[client_objc] = client
450
374
                    break
451
375
            else:
452
 
                log.critical("Client not found on server: %r", name)
 
376
                print("Client not found on server: {!r}"
 
377
                      .format(name), file=sys.stderr)
453
378
                sys.exit(1)
454
 
 
 
379
    
455
380
    if not has_actions(options) and clients:
456
 
        if options.verbose or options.dump_json:
 
381
        if options.verbose:
457
382
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
458
 
                        "Created", "Interval", "Host", "KeyID",
459
 
                        "Fingerprint", "CheckerRunning",
460
 
                        "LastEnabled", "ApprovalPending",
461
 
                        "ApprovedByDefault", "LastApprovalRequest",
462
 
                        "ApprovalDelay", "ApprovalDuration",
463
 
                        "Checker", "ExtendedTimeout", "Expires",
464
 
                        "LastCheckerStatus")
 
383
                        "Created", "Interval", "Host", "Fingerprint",
 
384
                        "CheckerRunning", "LastEnabled",
 
385
                        "ApprovalPending", "ApprovedByDefault",
 
386
                        "LastApprovalRequest", "ApprovalDelay",
 
387
                        "ApprovalDuration", "Checker",
 
388
                        "ExtendedTimeout")
465
389
        else:
466
390
            keywords = defaultkeywords
467
 
 
468
 
        if options.dump_json:
469
 
            json.dump({client["Name"]: {key:
470
 
                                        bool(client[key])
471
 
                                        if isinstance(client[key],
472
 
                                                      dbus.Boolean)
473
 
                                        else client[key]
474
 
                                        for key in keywords}
475
 
                       for client in clients.values()},
476
 
                      fp=sys.stdout, indent=4,
477
 
                      separators=(',', ': '))
478
 
            print()
479
 
        else:
480
 
            print_clients(clients.values(), keywords)
 
391
        
 
392
        print_clients(clients.values(), keywords)
481
393
    else:
482
394
        # Process each client in the list by all selected options
483
395
        for client in clients:
484
 
 
 
396
            
485
397
            def set_client_prop(prop, value):
486
398
                """Set a Client D-Bus property"""
487
399
                client.Set(client_interface, prop, value,
488
400
                           dbus_interface=dbus.PROPERTIES_IFACE)
489
 
 
 
401
            
490
402
            def set_client_prop_ms(prop, value):
491
403
                """Set a Client D-Bus property, converted
492
404
                from a string to milliseconds."""
493
405
                set_client_prop(prop,
494
406
                                string_to_delta(value).total_seconds()
495
407
                                * 1000)
496
 
 
 
408
            
497
409
            if options.remove:
498
410
                mandos_serv.RemoveClient(client.__dbus_object_path__)
499
411
            if options.enable:
507
419
            if options.stop_checker:
508
420
                set_client_prop("CheckerRunning", dbus.Boolean(False))
509
421
            if options.is_enabled:
510
 
                if client.Get(client_interface, "Enabled",
511
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
512
 
                    sys.exit(0)
513
 
                else:
514
 
                    sys.exit(1)
 
422
                sys.exit(0 if client.Get(client_interface,
 
423
                                         "Enabled",
 
424
                                         dbus_interface=
 
425
                                         dbus.PROPERTIES_IFACE)
 
426
                         else 1)
515
427
            if options.checker is not None:
516
428
                set_client_prop("Checker", options.checker)
517
429
            if options.host is not None:
543
455
                client.Approve(dbus.Boolean(False),
544
456
                               dbus_interface=client_interface)
545
457
 
546
 
 
547
 
class Test_milliseconds_to_string(unittest.TestCase):
548
 
    def test_all(self):
549
 
        self.assertEqual(milliseconds_to_string(93785000),
550
 
                         "1T02:03:05")
551
 
    def test_no_days(self):
552
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
553
 
    def test_all_zero(self):
554
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
555
 
    def test_no_fractional_seconds(self):
556
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
557
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
558
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
559
 
 
560
 
 
561
 
def should_only_run_tests():
562
 
    parser = argparse.ArgumentParser(add_help=False)
563
 
    parser.add_argument("--check", action='store_true')
564
 
    args, unknown_args = parser.parse_known_args()
565
 
    run_tests = args.check
566
 
    if run_tests:
567
 
        # Remove --check argument from sys.argv
568
 
        sys.argv[1:] = unknown_args
569
 
    return run_tests
570
 
 
571
 
# Add all tests from doctest strings
572
 
def load_tests(loader, tests, none):
573
 
    import doctest
574
 
    tests.addTests(doctest.DocTestSuite())
575
 
    return tests
576
458
 
577
459
if __name__ == "__main__":
578
 
    if should_only_run_tests():
579
 
        # Call using ./tdd-python-script --check [--verbose]
580
 
        unittest.main()
581
 
    else:
582
 
        main()
 
460
    main()