/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
 
# 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
46
if sys.version_info.major == 2:
60
47
    str = unicode
61
48
 
71
58
    "Interval": "Interval",
72
59
    "Host": "Host",
73
60
    "Fingerprint": "Fingerprint",
74
 
    "KeyID": "Key ID",
75
61
    "CheckerRunning": "Check Is Running",
76
62
    "LastEnabled": "Last Enabled",
77
63
    "ApprovalPending": "Approval Is Pending",
89
75
server_path = "/"
90
76
server_interface = domain + ".Mandos"
91
77
client_interface = domain + ".Mandos.Client"
92
 
version = "1.8.3"
 
78
version = "1.7.10"
93
79
 
94
80
 
95
81
try:
97
83
except AttributeError:
98
84
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
99
85
 
100
 
 
101
86
def milliseconds_to_string(ms):
102
87
    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))
 
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))
108
93
 
109
94
 
110
95
def rfc3339_duration_to_delta(duration):
111
96
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
112
 
 
 
97
    
113
98
    >>> rfc3339_duration_to_delta("P7D")
114
99
    datetime.timedelta(7)
115
100
    >>> rfc3339_duration_to_delta("PT60S")
116
101
    datetime.timedelta(0, 60)
117
102
    >>> rfc3339_duration_to_delta("PT60M")
118
103
    datetime.timedelta(0, 3600)
119
 
    >>> rfc3339_duration_to_delta("P60M")
120
 
    datetime.timedelta(1680)
121
104
    >>> rfc3339_duration_to_delta("PT24H")
122
105
    datetime.timedelta(1)
123
106
    >>> rfc3339_duration_to_delta("P1W")
126
109
    datetime.timedelta(0, 330)
127
110
    >>> rfc3339_duration_to_delta("P1DT3M20S")
128
111
    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
112
    """
159
 
 
 
113
    
160
114
    # Parsing an RFC 3339 duration with regular expressions is not
161
115
    # possible - there would have to be multiple places for the same
162
116
    # values, like seconds.  The current code, while more esoteric, is
163
117
    # cleaner without depending on a parsing library.  If Python had a
164
118
    # built-in library for parsing we would use it, but we'd like to
165
119
    # avoid excessive use of external libraries.
166
 
 
 
120
    
167
121
    # New type for defining tokens, syntax, and semantics all-in-one
168
122
    Token = collections.namedtuple("Token", (
169
123
        "regexp",  # To match token; if "value" is not None, must have
202
156
                           frozenset((token_year, token_month,
203
157
                                      token_day, token_time,
204
158
                                      token_week)))
205
 
    # Define starting values:
206
 
    # Value so far
207
 
    value = datetime.timedelta()
 
159
    # Define starting values
 
160
    value = datetime.timedelta() # Value so far
208
161
    found_token = None
209
 
    # Following valid tokens
210
 
    followers = frozenset((token_duration, ))
211
 
    # String left to parse
212
 
    s = duration
 
162
    followers = frozenset((token_duration, )) # Following valid tokens
 
163
    s = duration                # String left to parse
213
164
    # Loop until end token is found
214
165
    while found_token is not token_end:
215
166
        # Search for any currently valid tokens
239
190
 
240
191
def string_to_delta(interval):
241
192
    """Parse a string and return a datetime.timedelta
242
 
 
 
193
    
243
194
    >>> string_to_delta('7d')
244
195
    datetime.timedelta(7)
245
196
    >>> string_to_delta('60s')
253
204
    >>> string_to_delta('5m 30s')
254
205
    datetime.timedelta(0, 330)
255
206
    """
256
 
 
 
207
    
257
208
    try:
258
209
        return rfc3339_duration_to_delta(interval)
259
210
    except ValueError:
260
211
        pass
261
 
 
 
212
    
262
213
    value = datetime.timedelta(0)
263
214
    regexp = re.compile(r"(\d+)([dsmhw]?)")
264
 
 
 
215
    
265
216
    for num, suffix in regexp.findall(interval):
266
217
        if suffix == "d":
267
218
            value += datetime.timedelta(int(num))
280
231
 
281
232
def print_clients(clients, keywords):
282
233
    def valuetostring(value, keyword):
283
 
        if isinstance(value, dbus.Boolean):
 
234
        if type(value) is dbus.Boolean:
284
235
            return "Yes" if value else "No"
285
236
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
286
237
                       "ApprovalDuration", "ExtendedTimeout"):
287
238
            return milliseconds_to_string(value)
288
239
        return str(value)
289
 
 
 
240
    
290
241
    # Create format string to print table rows
291
242
    format_string = " ".join("{{{key}:{width}}}".format(
292
 
        width=max(len(tablewords[key]),
293
 
                  max(len(valuetostring(client[key], key))
294
 
                      for client in clients)),
295
 
        key=key)
 
243
        width = max(len(tablewords[key]),
 
244
                    max(len(valuetostring(client[key], key))
 
245
                        for client in clients)),
 
246
        key = key)
296
247
                             for key in keywords)
297
248
    # Print header line
298
249
    print(format_string.format(**tablewords))
299
250
    for client in clients:
300
 
        print(format_string
301
 
              .format(**{key: valuetostring(client[key], key)
302
 
                         for key in keywords}))
 
251
        print(format_string.format(**{
 
252
            key: valuetostring(client[key], key)
 
253
            for key in keywords }))
303
254
 
304
255
 
305
256
def has_actions(options):
326
277
def main():
327
278
    parser = argparse.ArgumentParser()
328
279
    parser.add_argument("--version", action="version",
329
 
                        version="%(prog)s {}".format(version),
 
280
                        version = "%(prog)s {}".format(version),
330
281
                        help="show version number and exit")
331
282
    parser.add_argument("-a", "--all", action="store_true",
332
283
                        help="Select all clients")
378
329
                        help="Run self-test")
379
330
    parser.add_argument("client", nargs="*", help="Client name")
380
331
    options = parser.parse_args()
381
 
 
 
332
    
382
333
    if has_actions(options) and not (options.client or options.all):
383
334
        parser.error("Options require clients names or --all.")
384
335
    if options.verbose and has_actions(options):
385
336
        parser.error("--verbose can only be used alone.")
386
 
    if options.dump_json and (options.verbose
387
 
                              or has_actions(options)):
 
337
    if options.dump_json and (options.verbose or has_actions(options)):
388
338
        parser.error("--dump-json can only be used alone.")
389
339
    if options.all and not has_actions(options):
390
340
        parser.error("--all requires an action.")
391
 
 
 
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
    
392
346
    try:
393
347
        bus = dbus.SystemBus()
394
348
        mandos_dbus_objc = bus.get_object(busname, server_path)
395
349
    except dbus.exceptions.DBusException:
396
 
        log.critical("Could not connect to Mandos server")
 
350
        print("Could not connect to Mandos server", file=sys.stderr)
397
351
        sys.exit(1)
398
 
 
 
352
    
399
353
    mandos_serv = dbus.Interface(mandos_dbus_objc,
400
 
                                 dbus_interface=server_interface)
 
354
                                 dbus_interface = server_interface)
401
355
    mandos_serv_object_manager = dbus.Interface(
402
 
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
403
 
 
404
 
    # 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
405
359
    null = os.open(os.path.devnull, os.O_RDWR)
406
360
    stderrcopy = os.dup(sys.stderr.fileno())
407
361
    os.dup2(null, sys.stderr.fileno())
408
362
    os.close(null)
409
363
    try:
410
364
        try:
411
 
            mandos_clients = {path: ifs_and_props[client_interface]
412
 
                              for path, ifs_and_props in
413
 
                              mandos_serv_object_manager
414
 
                              .GetManagedObjects().items()
415
 
                              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 }
416
370
        finally:
417
 
            # restore stderr
 
371
            #restore stderr
418
372
            os.dup2(stderrcopy, sys.stderr.fileno())
419
373
            os.close(stderrcopy)
420
374
    except dbus.exceptions.DBusException as e:
421
 
        log.critical("Failed to access Mandos server through D-Bus:"
422
 
                     "\n%s", e)
 
375
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
376
              .format(e), file=sys.stderr)
423
377
        sys.exit(1)
424
 
 
 
378
    
425
379
    # Compile dict of (clients: properties) to process
426
 
    clients = {}
427
 
 
 
380
    clients={}
 
381
    
428
382
    if options.all or not options.client:
429
 
        clients = {bus.get_object(busname, path): properties
430
 
                   for path, properties in mandos_clients.items()}
 
383
        clients = { bus.get_object(busname, path): properties
 
384
                    for path, properties in mandos_clients.items() }
431
385
    else:
432
386
        for name in options.client:
433
387
            for path, client in mandos_clients.items():
436
390
                    clients[client_objc] = client
437
391
                    break
438
392
            else:
439
 
                log.critical("Client not found on server: %r", name)
 
393
                print("Client not found on server: {!r}"
 
394
                      .format(name), file=sys.stderr)
440
395
                sys.exit(1)
441
 
 
 
396
    
442
397
    if not has_actions(options) and clients:
443
398
        if options.verbose or options.dump_json:
444
399
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
445
 
                        "Created", "Interval", "Host", "KeyID",
446
 
                        "Fingerprint", "CheckerRunning",
447
 
                        "LastEnabled", "ApprovalPending",
448
 
                        "ApprovedByDefault", "LastApprovalRequest",
449
 
                        "ApprovalDelay", "ApprovalDuration",
450
 
                        "Checker", "ExtendedTimeout", "Expires",
 
400
                        "Created", "Interval", "Host", "Fingerprint",
 
401
                        "CheckerRunning", "LastEnabled",
 
402
                        "ApprovalPending", "ApprovedByDefault",
 
403
                        "LastApprovalRequest", "ApprovalDelay",
 
404
                        "ApprovalDuration", "Checker",
 
405
                        "ExtendedTimeout", "Expires",
451
406
                        "LastCheckerStatus")
452
407
        else:
453
408
            keywords = defaultkeywords
454
 
 
 
409
        
455
410
        if options.dump_json:
456
411
            json.dump({client["Name"]: {key:
457
412
                                        bool(client[key])
458
413
                                        if isinstance(client[key],
459
414
                                                      dbus.Boolean)
460
415
                                        else client[key]
461
 
                                        for key in keywords}
462
 
                       for client in clients.values()},
463
 
                      fp=sys.stdout, indent=4,
464
 
                      separators=(',', ': '))
 
416
                                        for key in keywords }
 
417
                       for client in clients.values() },
 
418
                      fp = sys.stdout, indent = 4,
 
419
                      separators = (',', ': '))
465
420
            print()
466
421
        else:
467
422
            print_clients(clients.values(), keywords)
468
423
    else:
469
424
        # Process each client in the list by all selected options
470
425
        for client in clients:
471
 
 
 
426
            
472
427
            def set_client_prop(prop, value):
473
428
                """Set a Client D-Bus property"""
474
429
                client.Set(client_interface, prop, value,
475
430
                           dbus_interface=dbus.PROPERTIES_IFACE)
476
 
 
 
431
            
477
432
            def set_client_prop_ms(prop, value):
478
433
                """Set a Client D-Bus property, converted
479
434
                from a string to milliseconds."""
480
435
                set_client_prop(prop,
481
436
                                string_to_delta(value).total_seconds()
482
437
                                * 1000)
483
 
 
 
438
            
484
439
            if options.remove:
485
440
                mandos_serv.RemoveClient(client.__dbus_object_path__)
486
441
            if options.enable:
494
449
            if options.stop_checker:
495
450
                set_client_prop("CheckerRunning", dbus.Boolean(False))
496
451
            if options.is_enabled:
497
 
                if client.Get(client_interface, "Enabled",
498
 
                              dbus_interface=dbus.PROPERTIES_IFACE):
499
 
                    sys.exit(0)
500
 
                else:
501
 
                    sys.exit(1)
 
452
                sys.exit(0 if client.Get(client_interface,
 
453
                                         "Enabled",
 
454
                                         dbus_interface=
 
455
                                         dbus.PROPERTIES_IFACE)
 
456
                         else 1)
502
457
            if options.checker is not None:
503
458
                set_client_prop("Checker", options.checker)
504
459
            if options.host is not None:
530
485
                client.Approve(dbus.Boolean(False),
531
486
                               dbus_interface=client_interface)
532
487
 
533
 
 
534
 
class Test_milliseconds_to_string(unittest.TestCase):
535
 
    def test_all(self):
536
 
        self.assertEqual(milliseconds_to_string(93785000),
537
 
                         "1T02:03:05")
538
 
    def test_no_days(self):
539
 
        self.assertEqual(milliseconds_to_string(7385000), "02:03:05")
540
 
    def test_all_zero(self):
541
 
        self.assertEqual(milliseconds_to_string(0), "00:00:00")
542
 
    def test_no_fractional_seconds(self):
543
 
        self.assertEqual(milliseconds_to_string(400), "00:00:00")
544
 
        self.assertEqual(milliseconds_to_string(900), "00:00:00")
545
 
        self.assertEqual(milliseconds_to_string(1900), "00:00:01")
546
 
 
547
 
 
548
 
def should_only_run_tests():
549
 
    parser = argparse.ArgumentParser(add_help=False)
550
 
    parser.add_argument("--check", action='store_true')
551
 
    args, unknown_args = parser.parse_known_args()
552
 
    run_tests = args.check
553
 
    if run_tests:
554
 
        # Remove --check argument from sys.argv
555
 
        sys.argv[1:] = unknown_args
556
 
    return run_tests
557
 
 
558
 
# Add all tests from doctest strings
559
 
def load_tests(loader, tests, none):
560
 
    import doctest
561
 
    tests.addTests(doctest.DocTestSuite())
562
 
    return tests
563
488
 
564
489
if __name__ == "__main__":
565
 
    if should_only_run_tests():
566
 
        # Call using ./tdd-python-script --check [--verbose]
567
 
        unittest.main()
568
 
    else:
569
 
        main()
 
490
    main()