/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: 2016-03-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

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-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 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"
 
75
version = "1.7.3"
93
76
 
94
77
 
95
78
try:
97
80
except AttributeError:
98
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
82
 
100
 
 
101
83
def milliseconds_to_string(ms):
102
84
    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))
 
85
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
86
        days = "{}T".format(td.days) if td.days else "",
 
87
        hours = td.seconds // 3600,
 
88
        minutes = (td.seconds % 3600) // 60,
 
89
        seconds = td.seconds % 60))
108
90
 
109
91
 
110
92
def rfc3339_duration_to_delta(duration):
111
93
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
94
    
113
95
    >>> rfc3339_duration_to_delta("P7D")
114
96
    datetime.timedelta(7)
115
97
    >>> rfc3339_duration_to_delta("PT60S")
125
107
    >>> rfc3339_duration_to_delta("P1DT3M20S")
126
108
    datetime.timedelta(1, 200)
127
109
    """
128
 
 
 
110
    
129
111
    # Parsing an RFC 3339 duration with regular expressions is not
130
112
    # possible - there would have to be multiple places for the same
131
113
    # values, like seconds.  The current code, while more esoteric, is
132
114
    # cleaner without depending on a parsing library.  If Python had a
133
115
    # built-in library for parsing we would use it, but we'd like to
134
116
    # avoid excessive use of external libraries.
135
 
 
 
117
    
136
118
    # New type for defining tokens, syntax, and semantics all-in-one
137
119
    Token = collections.namedtuple("Token", (
138
120
        "regexp",  # To match token; if "value" is not None, must have
171
153
                           frozenset((token_year, token_month,
172
154
                                      token_day, token_time,
173
155
                                      token_week)))
174
 
    # Define starting values:
175
 
    # Value so far
176
 
    value = datetime.timedelta()
 
156
    # Define starting values
 
157
    value = datetime.timedelta() # Value so far
177
158
    found_token = None
178
 
    # Following valid tokens
179
 
    followers = frozenset((token_duration, ))
180
 
    # String left to parse
181
 
    s = duration
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
 
160
    s = duration                # String left to parse
182
161
    # Loop until end token is found
183
162
    while found_token is not token_end:
184
163
        # Search for any currently valid tokens
208
187
 
209
188
def string_to_delta(interval):
210
189
    """Parse a string and return a datetime.timedelta
211
 
 
 
190
    
212
191
    >>> string_to_delta('7d')
213
192
    datetime.timedelta(7)
214
193
    >>> string_to_delta('60s')
222
201
    >>> string_to_delta('5m 30s')
223
202
    datetime.timedelta(0, 330)
224
203
    """
225
 
 
 
204
    
226
205
    try:
227
206
        return rfc3339_duration_to_delta(interval)
228
207
    except ValueError:
229
208
        pass
230
 
 
 
209
    
231
210
    value = datetime.timedelta(0)
232
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
 
 
 
212
    
234
213
    for num, suffix in regexp.findall(interval):
235
214
        if suffix == "d":
236
215
            value += datetime.timedelta(int(num))
249
228
 
250
229
def print_clients(clients, keywords):
251
230
    def valuetostring(value, keyword):
252
 
        if isinstance(value, dbus.Boolean):
 
231
        if type(value) is dbus.Boolean:
253
232
            return "Yes" if value else "No"
254
233
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
255
234
                       "ApprovalDuration", "ExtendedTimeout"):
256
235
            return milliseconds_to_string(value)
257
236
        return str(value)
258
 
 
 
237
    
259
238
    # Create format string to print table rows
260
239
    format_string = " ".join("{{{key}:{width}}}".format(
261
 
        width=max(len(tablewords[key]),
262
 
                  max(len(valuetostring(client[key], key))
263
 
                      for client in clients)),
264
 
        key=key)
 
240
        width = max(len(tablewords[key]),
 
241
                    max(len(valuetostring(client[key], key))
 
242
                        for client in clients)),
 
243
        key = key)
265
244
                             for key in keywords)
266
245
    # Print header line
267
246
    print(format_string.format(**tablewords))
268
247
    for client in clients:
269
 
        print(format_string
270
 
              .format(**{key: valuetostring(client[key], key)
271
 
                         for key in keywords}))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
272
251
 
273
252
 
274
253
def has_actions(options):
295
274
def main():
296
275
    parser = argparse.ArgumentParser()
297
276
    parser.add_argument("--version", action="version",
298
 
                        version="%(prog)s {}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
299
278
                        help="show version number and exit")
300
279
    parser.add_argument("-a", "--all", action="store_true",
301
280
                        help="Select all clients")
302
281
    parser.add_argument("-v", "--verbose", action="store_true",
303
282
                        help="Print all fields")
304
 
    parser.add_argument("-j", "--dump-json", action="store_true",
305
 
                        help="Dump client data in JSON format")
306
283
    parser.add_argument("-e", "--enable", action="store_true",
307
284
                        help="Enable client")
308
285
    parser.add_argument("-d", "--disable", action="store_true",
347
324
                        help="Run self-test")
348
325
    parser.add_argument("client", nargs="*", help="Client name")
349
326
    options = parser.parse_args()
350
 
 
 
327
    
351
328
    if has_actions(options) and not (options.client or options.all):
352
329
        parser.error("Options require clients names or --all.")
353
330
    if options.verbose and has_actions(options):
354
 
        parser.error("--verbose can only be used alone.")
355
 
    if options.dump_json and (options.verbose
356
 
                              or has_actions(options)):
357
 
        parser.error("--dump-json can only be used alone.")
 
331
        parser.error("--verbose can only be used alone or with"
 
332
                     " --all.")
358
333
    if options.all and not has_actions(options):
359
334
        parser.error("--all requires an action.")
360
335
 
 
336
    if options.check:
 
337
        fail_count, test_count = doctest.testmod()
 
338
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
339
    
361
340
    try:
362
341
        bus = dbus.SystemBus()
363
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
364
343
    except dbus.exceptions.DBusException:
365
 
        log.critical("Could not connect to Mandos server")
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
366
345
        sys.exit(1)
367
 
 
 
346
    
368
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
369
 
                                 dbus_interface=server_interface)
 
348
                                 dbus_interface = server_interface)
370
349
    mandos_serv_object_manager = dbus.Interface(
371
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
372
 
 
373
 
    # block stderr since dbus library prints to stderr
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
351
    
 
352
    #block stderr since dbus library prints to stderr
374
353
    null = os.open(os.path.devnull, os.O_RDWR)
375
354
    stderrcopy = os.dup(sys.stderr.fileno())
376
355
    os.dup2(null, sys.stderr.fileno())
377
356
    os.close(null)
378
357
    try:
379
358
        try:
380
 
            mandos_clients = {path: ifs_and_props[client_interface]
381
 
                              for path, ifs_and_props in
382
 
                              mandos_serv_object_manager
383
 
                              .GetManagedObjects().items()
384
 
                              if client_interface in ifs_and_props}
 
359
            mandos_clients = { path: ifs_and_props[client_interface]
 
360
                               for path, ifs_and_props in
 
361
                               mandos_serv_object_manager
 
362
                               .GetManagedObjects().items()
 
363
                               if client_interface in ifs_and_props }
385
364
        finally:
386
 
            # restore stderr
 
365
            #restore stderr
387
366
            os.dup2(stderrcopy, sys.stderr.fileno())
388
367
            os.close(stderrcopy)
389
368
    except dbus.exceptions.DBusException as e:
390
 
        log.critical("Failed to access Mandos server through D-Bus:"
391
 
                     "\n%s", e)
 
369
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
370
              .format(e), file=sys.stderr)
392
371
        sys.exit(1)
393
 
 
 
372
    
394
373
    # Compile dict of (clients: properties) to process
395
 
    clients = {}
396
 
 
 
374
    clients={}
 
375
    
397
376
    if options.all or not options.client:
398
 
        clients = {bus.get_object(busname, path): properties
399
 
                   for path, properties in mandos_clients.items()}
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
400
379
    else:
401
380
        for name in options.client:
402
381
            for path, client in mandos_clients.items():
405
384
                    clients[client_objc] = client
406
385
                    break
407
386
            else:
408
 
                log.critical("Client not found on server: %r", name)
 
387
                print("Client not found on server: {!r}"
 
388
                      .format(name), file=sys.stderr)
409
389
                sys.exit(1)
410
 
 
 
390
    
411
391
    if not has_actions(options) and clients:
412
 
        if options.verbose or options.dump_json:
 
392
        if options.verbose:
413
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
414
 
                        "Created", "Interval", "Host", "KeyID",
415
 
                        "Fingerprint", "CheckerRunning",
416
 
                        "LastEnabled", "ApprovalPending",
417
 
                        "ApprovedByDefault", "LastApprovalRequest",
418
 
                        "ApprovalDelay", "ApprovalDuration",
419
 
                        "Checker", "ExtendedTimeout", "Expires",
420
 
                        "LastCheckerStatus")
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
 
397
                        "LastApprovalRequest", "ApprovalDelay",
 
398
                        "ApprovalDuration", "Checker",
 
399
                        "ExtendedTimeout")
421
400
        else:
422
401
            keywords = defaultkeywords
423
 
 
424
 
        if options.dump_json:
425
 
            json.dump({client["Name"]: {key:
426
 
                                        bool(client[key])
427
 
                                        if isinstance(client[key],
428
 
                                                      dbus.Boolean)
429
 
                                        else client[key]
430
 
                                        for key in keywords}
431
 
                       for client in clients.values()},
432
 
                      fp=sys.stdout, indent=4,
433
 
                      separators=(',', ': '))
434
 
            print()
435
 
        else:
436
 
            print_clients(clients.values(), keywords)
 
402
        
 
403
        print_clients(clients.values(), keywords)
437
404
    else:
438
405
        # Process each client in the list by all selected options
439
406
        for client in clients:
440
 
 
 
407
            
441
408
            def set_client_prop(prop, value):
442
409
                """Set a Client D-Bus property"""
443
410
                client.Set(client_interface, prop, value,
444
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
 
 
 
412
            
446
413
            def set_client_prop_ms(prop, value):
447
414
                """Set a Client D-Bus property, converted
448
415
                from a string to milliseconds."""
449
416
                set_client_prop(prop,
450
417
                                string_to_delta(value).total_seconds()
451
418
                                * 1000)
452
 
 
 
419
            
453
420
            if options.remove:
454
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
455
422
            if options.enable:
463
430
            if options.stop_checker:
464
431
                set_client_prop("CheckerRunning", dbus.Boolean(False))
465
432
            if options.is_enabled:
466
 
                if client.Get(client_interface, "Enabled",
467
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
468
 
                    sys.exit(0)
469
 
                else:
470
 
                    sys.exit(1)
 
433
                sys.exit(0 if client.Get(client_interface,
 
434
                                         "Enabled",
 
435
                                         dbus_interface=
 
436
                                         dbus.PROPERTIES_IFACE)
 
437
                         else 1)
471
438
            if options.checker is not None:
472
439
                set_client_prop("Checker", options.checker)
473
440
            if options.host is not None:
499
466
                client.Approve(dbus.Boolean(False),
500
467
                               dbus_interface=client_interface)
501
468
 
502
 
 
503
 
class Test_milliseconds_to_string(unittest.TestCase):
504
 
    def test_all(self):
505
 
        self.assertEqual(milliseconds_to_string(93785000),
506
 
                         "1T02:03:05")
507
 
    def test_no_days(self):
508
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
509
 
    def test_all_zero(self):
510
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
511
 
    def test_no_fractional_seconds(self):
512
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
513
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
514
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
515
 
 
516
 
 
517
 
def should_only_run_tests():
518
 
    parser = argparse.ArgumentParser(add_help=False)
519
 
    parser.add_argument("--check", action='store_true')
520
 
    args, unknown_args = parser.parse_known_args()
521
 
    run_tests = args.check
522
 
    if run_tests:
523
 
        # Remove --check argument from sys.argv
524
 
        sys.argv[1:] = unknown_args
525
 
    return run_tests
526
 
 
527
 
# Add all tests from doctest strings
528
 
def load_tests(loader, tests, none):
529
 
    import doctest
530
 
    tests.addTests(doctest.DocTestSuite())
531
 
    return tests
532
469
 
533
470
if __name__ == "__main__":
534
 
    if should_only_run_tests():
535
 
        # Call using ./tdd-python-script --check [--verbose]
536
 
        unittest.main()
537
 
    else:
538
 
        main()
 
471
    main()