/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-07-03 03:32:28 UTC
  • Revision ID: teddy@recompile.se-20160703033228-cafpnnfs53kdg52g
Change all http:// URLs to https:// wherever possible.

* INSTALL (Prerequisites/Libraries/Mandos Server): Change "http://" to
  "https://" wherever possible.
* Makefile (FORTIFY): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.c (main): - '' -
* plugins.d/mandos-client.c (start_mandos_communication): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -

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
 
41
import doctest
42
42
import json
43
 
import unittest
44
 
import logging
45
43
 
46
44
import dbus
47
45
 
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
46
if sys.version_info.major == 2:
53
47
    str = unicode
54
48
 
64
58
    "Interval": "Interval",
65
59
    "Host": "Host",
66
60
    "Fingerprint": "Fingerprint",
67
 
    "KeyID": "Key ID",
68
61
    "CheckerRunning": "Check Is Running",
69
62
    "LastEnabled": "Last Enabled",
70
63
    "ApprovalPending": "Approval Is Pending",
82
75
server_path = "/"
83
76
server_interface = domain + ".Mandos"
84
77
client_interface = domain + ".Mandos.Client"
85
 
version = "1.8.3"
 
78
version = "1.7.10"
86
79
 
87
80
 
88
81
try:
90
83
except AttributeError:
91
84
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
92
85
 
93
 
 
94
86
def milliseconds_to_string(ms):
95
87
    td = datetime.timedelta(0, 0, 0, ms)
96
 
    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))
 
88
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}".format(
 
89
        days = "{}T".format(td.days) if td.days else "",
 
90
        hours = td.seconds // 3600,
 
91
        minutes = (td.seconds % 3600) // 60,
 
92
        seconds = td.seconds % 60))
101
93
 
102
94
 
103
95
def rfc3339_duration_to_delta(duration):
104
96
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
105
 
 
 
97
    
106
98
    >>> rfc3339_duration_to_delta("P7D")
107
99
    datetime.timedelta(7)
108
100
    >>> rfc3339_duration_to_delta("PT60S")
118
110
    >>> rfc3339_duration_to_delta("P1DT3M20S")
119
111
    datetime.timedelta(1, 200)
120
112
    """
121
 
 
 
113
    
122
114
    # Parsing an RFC 3339 duration with regular expressions is not
123
115
    # possible - there would have to be multiple places for the same
124
116
    # values, like seconds.  The current code, while more esoteric, is
125
117
    # cleaner without depending on a parsing library.  If Python had a
126
118
    # built-in library for parsing we would use it, but we'd like to
127
119
    # avoid excessive use of external libraries.
128
 
 
 
120
    
129
121
    # New type for defining tokens, syntax, and semantics all-in-one
130
122
    Token = collections.namedtuple("Token", (
131
123
        "regexp",  # To match token; if "value" is not None, must have
164
156
                           frozenset((token_year, token_month,
165
157
                                      token_day, token_time,
166
158
                                      token_week)))
167
 
    # Define starting values:
168
 
    # Value so far
169
 
    value = datetime.timedelta()
 
159
    # Define starting values
 
160
    value = datetime.timedelta() # Value so far
170
161
    found_token = None
171
 
    # Following valid tokens
172
 
    followers = frozenset((token_duration, ))
173
 
    # String left to parse
174
 
    s = duration
 
162
    followers = frozenset((token_duration, )) # Following valid tokens
 
163
    s = duration                # String left to parse
175
164
    # Loop until end token is found
176
165
    while found_token is not token_end:
177
166
        # Search for any currently valid tokens
201
190
 
202
191
def string_to_delta(interval):
203
192
    """Parse a string and return a datetime.timedelta
204
 
 
 
193
    
205
194
    >>> string_to_delta('7d')
206
195
    datetime.timedelta(7)
207
196
    >>> string_to_delta('60s')
215
204
    >>> string_to_delta('5m 30s')
216
205
    datetime.timedelta(0, 330)
217
206
    """
218
 
 
 
207
    
219
208
    try:
220
209
        return rfc3339_duration_to_delta(interval)
221
210
    except ValueError:
222
211
        pass
223
 
 
 
212
    
224
213
    value = datetime.timedelta(0)
225
214
    regexp = re.compile(r"(\d+)([dsmhw]?)")
226
 
 
 
215
    
227
216
    for num, suffix in regexp.findall(interval):
228
217
        if suffix == "d":
229
218
            value += datetime.timedelta(int(num))
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)
 
243
        width = max(len(tablewords[key]),
 
244
                    max(len(valuetostring(client[key], key))
 
245
                        for client in clients)),
 
246
        key = key)
258
247
                             for key in keywords)
259
248
    # Print header line
260
249
    print(format_string.format(**tablewords))
261
250
    for client in clients:
262
 
        print(format_string
263
 
              .format(**{key: valuetostring(client[key], key)
264
 
                         for key in keywords}))
 
251
        print(format_string.format(**{
 
252
            key: valuetostring(client[key], key)
 
253
            for key in keywords }))
265
254
 
266
255
 
267
256
def has_actions(options):
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 {}".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")
340
329
                        help="Run self-test")
341
330
    parser.add_argument("client", nargs="*", help="Client name")
342
331
    options = parser.parse_args()
343
 
 
 
332
    
344
333
    if has_actions(options) and not (options.client or options.all):
345
334
        parser.error("Options require clients names or --all.")
346
335
    if options.verbose and has_actions(options):
347
336
        parser.error("--verbose can only be used alone.")
348
 
    if options.dump_json and (options.verbose
349
 
                              or has_actions(options)):
 
337
    if options.dump_json and (options.verbose or has_actions(options)):
350
338
        parser.error("--dump-json can only be used alone.")
351
339
    if options.all and not has_actions(options):
352
340
        parser.error("--all requires an action.")
353
 
 
 
341
    
 
342
    if options.check:
 
343
        fail_count, test_count = doctest.testmod()
 
344
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
345
    
354
346
    try:
355
347
        bus = dbus.SystemBus()
356
348
        mandos_dbus_objc = bus.get_object(busname, server_path)
357
349
    except dbus.exceptions.DBusException:
358
 
        log.critical("Could not connect to Mandos server")
 
350
        print("Could not connect to Mandos server", file=sys.stderr)
359
351
        sys.exit(1)
360
 
 
 
352
    
361
353
    mandos_serv = dbus.Interface(mandos_dbus_objc,
362
 
                                 dbus_interface=server_interface)
 
354
                                 dbus_interface = server_interface)
363
355
    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
 
356
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
 
357
    
 
358
    #block stderr since dbus library prints to stderr
367
359
    null = os.open(os.path.devnull, os.O_RDWR)
368
360
    stderrcopy = os.dup(sys.stderr.fileno())
369
361
    os.dup2(null, sys.stderr.fileno())
370
362
    os.close(null)
371
363
    try:
372
364
        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}
 
365
            mandos_clients = { path: ifs_and_props[client_interface]
 
366
                               for path, ifs_and_props in
 
367
                               mandos_serv_object_manager
 
368
                               .GetManagedObjects().items()
 
369
                               if client_interface in ifs_and_props }
378
370
        finally:
379
 
            # restore stderr
 
371
            #restore stderr
380
372
            os.dup2(stderrcopy, sys.stderr.fileno())
381
373
            os.close(stderrcopy)
382
374
    except dbus.exceptions.DBusException as e:
383
 
        log.critical("Failed to access Mandos server through D-Bus:"
384
 
                     "\n%s", e)
 
375
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
376
              .format(e), file=sys.stderr)
385
377
        sys.exit(1)
386
 
 
 
378
    
387
379
    # Compile dict of (clients: properties) to process
388
 
    clients = {}
389
 
 
 
380
    clients={}
 
381
    
390
382
    if options.all or not options.client:
391
 
        clients = {bus.get_object(busname, path): properties
392
 
                   for path, properties in mandos_clients.items()}
 
383
        clients = { bus.get_object(busname, path): properties
 
384
                    for path, properties in mandos_clients.items() }
393
385
    else:
394
386
        for name in options.client:
395
387
            for path, client in mandos_clients.items():
398
390
                    clients[client_objc] = client
399
391
                    break
400
392
            else:
401
 
                log.critical("Client not found on server: %r", name)
 
393
                print("Client not found on server: {!r}"
 
394
                      .format(name), file=sys.stderr)
402
395
                sys.exit(1)
403
 
 
 
396
    
404
397
    if not has_actions(options) and clients:
405
398
        if options.verbose or options.dump_json:
406
399
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
 
                        "Created", "Interval", "Host", "KeyID",
408
 
                        "Fingerprint", "CheckerRunning",
409
 
                        "LastEnabled", "ApprovalPending",
410
 
                        "ApprovedByDefault", "LastApprovalRequest",
411
 
                        "ApprovalDelay", "ApprovalDuration",
412
 
                        "Checker", "ExtendedTimeout", "Expires",
 
400
                        "Created", "Interval", "Host", "Fingerprint",
 
401
                        "CheckerRunning", "LastEnabled",
 
402
                        "ApprovalPending", "ApprovedByDefault",
 
403
                        "LastApprovalRequest", "ApprovalDelay",
 
404
                        "ApprovalDuration", "Checker",
 
405
                        "ExtendedTimeout", "Expires",
413
406
                        "LastCheckerStatus")
414
407
        else:
415
408
            keywords = defaultkeywords
416
 
 
 
409
        
417
410
        if options.dump_json:
418
411
            json.dump({client["Name"]: {key:
419
412
                                        bool(client[key])
420
413
                                        if isinstance(client[key],
421
414
                                                      dbus.Boolean)
422
415
                                        else client[key]
423
 
                                        for key in keywords}
424
 
                       for client in clients.values()},
425
 
                      fp=sys.stdout, indent=4,
426
 
                      separators=(',', ': '))
 
416
                                        for key in keywords }
 
417
                       for client in clients.values() },
 
418
                      fp = sys.stdout, indent = 4,
 
419
                      separators = (',', ': '))
427
420
            print()
428
421
        else:
429
422
            print_clients(clients.values(), keywords)
430
423
    else:
431
424
        # Process each client in the list by all selected options
432
425
        for client in clients:
433
 
 
 
426
            
434
427
            def set_client_prop(prop, value):
435
428
                """Set a Client D-Bus property"""
436
429
                client.Set(client_interface, prop, value,
437
430
                           dbus_interface=dbus.PROPERTIES_IFACE)
438
 
 
 
431
            
439
432
            def set_client_prop_ms(prop, value):
440
433
                """Set a Client D-Bus property, converted
441
434
                from a string to milliseconds."""
442
435
                set_client_prop(prop,
443
436
                                string_to_delta(value).total_seconds()
444
437
                                * 1000)
445
 
 
 
438
            
446
439
            if options.remove:
447
440
                mandos_serv.RemoveClient(client.__dbus_object_path__)
448
441
            if options.enable:
456
449
            if options.stop_checker:
457
450
                set_client_prop("CheckerRunning", dbus.Boolean(False))
458
451
            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)
 
452
                sys.exit(0 if client.Get(client_interface,
 
453
                                         "Enabled",
 
454
                                         dbus_interface=
 
455
                                         dbus.PROPERTIES_IFACE)
 
456
                         else 1)
464
457
            if options.checker is not None:
465
458
                set_client_prop("Checker", options.checker)
466
459
            if options.host is not None:
492
485
                client.Approve(dbus.Boolean(False),
493
486
                               dbus_interface=client_interface)
494
487
 
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
488
 
526
489
if __name__ == "__main__":
527
 
    if should_only_run_tests():
528
 
        # Call using ./tdd-python-script --check [--verbose]
529
 
        unittest.main()
530
 
    else:
531
 
        main()
 
490
    main()