/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

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
 
# 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",
85
 
}
 
67
    "ExtendedTimeout" : "Extended Timeout"
 
68
    }
86
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
87
70
domain = "se.recompile"
88
71
busname = domain + ".Mandos"
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"
99
 
 
 
75
version = "1.6.9"
100
76
 
101
77
def milliseconds_to_string(ms):
102
78
    td = datetime.timedelta(0, 0, 0, ms)
103
79
    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
            .format(days = "{}T".format(td.days) if td.days else "",
 
81
                    hours = td.seconds // 3600,
 
82
                    minutes = (td.seconds % 3600) // 60,
 
83
                    seconds = td.seconds % 60,
 
84
                    ))
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")
125
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
126
103
    datetime.timedelta(1, 200)
127
104
    """
128
 
 
 
105
    
129
106
    # Parsing an RFC 3339 duration with regular expressions is not
130
107
    # possible - there would have to be multiple places for the same
131
108
    # values, like seconds.  The current code, while more esoteric, is
132
109
    # cleaner without depending on a parsing library.  If Python had a
133
110
    # built-in library for parsing we would use it, but we'd like to
134
111
    # avoid excessive use of external libraries.
135
 
 
 
112
    
136
113
    # New type for defining tokens, syntax, and semantics all-in-one
137
 
    Token = collections.namedtuple("Token", (
138
 
        "regexp",  # To match token; if "value" is not None, must have
139
 
                   # a "group" containing digits
140
 
        "value",   # datetime.timedelta or None
141
 
        "followers"))           # Tokens valid after this token
 
114
    Token = collections.namedtuple("Token",
 
115
                                   ("regexp", # To match token; if
 
116
                                              # "value" is not None,
 
117
                                              # must have a "group"
 
118
                                              # containing digits
 
119
                                    "value",  # datetime.timedelta or
 
120
                                              # None
 
121
                                    "followers")) # Tokens valid after
 
122
                                                  # this token
142
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
143
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
144
125
    token_end = Token(re.compile(r"$"), None, frozenset())
145
126
    token_second = Token(re.compile(r"(\d+)S"),
146
127
                         datetime.timedelta(seconds=1),
147
 
                         frozenset((token_end, )))
 
128
                         frozenset((token_end,)))
148
129
    token_minute = Token(re.compile(r"(\d+)M"),
149
130
                         datetime.timedelta(minutes=1),
150
131
                         frozenset((token_second, token_end)))
166
147
                       frozenset((token_month, token_end)))
167
148
    token_week = Token(re.compile(r"(\d+)W"),
168
149
                       datetime.timedelta(weeks=1),
169
 
                       frozenset((token_end, )))
 
150
                       frozenset((token_end,)))
170
151
    token_duration = Token(re.compile(r"P"), None,
171
152
                           frozenset((token_year, token_month,
172
153
                                      token_day, token_time,
173
154
                                      token_week)))
174
 
    # Define starting values:
175
 
    # Value so far
176
 
    value = datetime.timedelta()
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
177
157
    found_token = None
178
 
    # Following valid tokens
179
 
    followers = frozenset((token_duration, ))
180
 
    # String left to parse
181
 
    s = duration
 
158
    followers = frozenset((token_duration,)) # Following valid tokens
 
159
    s = duration                # String left to parse
182
160
    # Loop until end token is found
183
161
    while found_token is not token_end:
184
162
        # Search for any currently valid tokens
200
178
                break
201
179
        else:
202
180
            # No currently valid tokens were found
203
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
204
 
                             .format(duration))
 
181
            raise ValueError("Invalid RFC 3339 duration")
205
182
    # End token found
206
183
    return value
207
184
 
208
185
 
209
186
def string_to_delta(interval):
210
187
    """Parse a string and return a datetime.timedelta
211
 
 
212
 
    >>> string_to_delta('7d')
 
188
    
 
189
    >>> string_to_delta("7d")
213
190
    datetime.timedelta(7)
214
 
    >>> string_to_delta('60s')
 
191
    >>> string_to_delta("60s")
215
192
    datetime.timedelta(0, 60)
216
 
    >>> string_to_delta('60m')
 
193
    >>> string_to_delta("60m")
217
194
    datetime.timedelta(0, 3600)
218
 
    >>> string_to_delta('24h')
 
195
    >>> string_to_delta("24h")
219
196
    datetime.timedelta(1)
220
 
    >>> string_to_delta('1w')
 
197
    >>> string_to_delta("1w")
221
198
    datetime.timedelta(7)
222
 
    >>> string_to_delta('5m 30s')
 
199
    >>> string_to_delta("5m 30s")
223
200
    datetime.timedelta(0, 330)
224
201
    """
225
 
 
 
202
    
226
203
    try:
227
204
        return rfc3339_duration_to_delta(interval)
228
205
    except ValueError:
229
206
        pass
230
 
 
 
207
    
231
208
    value = datetime.timedelta(0)
232
209
    regexp = re.compile(r"(\d+)([dsmhw]?)")
233
 
 
 
210
    
234
211
    for num, suffix in regexp.findall(interval):
235
212
        if suffix == "d":
236
213
            value += datetime.timedelta(int(num))
246
223
            value += datetime.timedelta(0, 0, 0, int(num))
247
224
    return value
248
225
 
249
 
 
250
226
def print_clients(clients, keywords):
251
227
    def valuetostring(value, keyword):
252
228
        if type(value) is dbus.Boolean:
255
231
                       "ApprovalDuration", "ExtendedTimeout"):
256
232
            return milliseconds_to_string(value)
257
233
        return str(value)
258
 
 
 
234
    
259
235
    # Create format string to print table rows
260
236
    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)
265
 
                             for key in keywords)
 
237
            width = max(len(tablewords[key]),
 
238
                        max(len(valuetostring(client[key],
 
239
                                              key))
 
240
                            for client in
 
241
                            clients)),
 
242
            key = key) for key in keywords)
266
243
    # Print header line
267
244
    print(format_string.format(**tablewords))
268
245
    for client in clients:
269
 
        print(format_string
270
 
              .format(**{key: valuetostring(client[key], key)
271
 
                         for key in keywords}))
272
 
 
 
246
        print(format_string.format(**{ key:
 
247
                                           valuetostring(client[key],
 
248
                                                         key)
 
249
                                       for key in keywords }))
273
250
 
274
251
def has_actions(options):
275
252
    return any((options.enable,
291
268
                options.approve,
292
269
                options.deny))
293
270
 
294
 
 
295
271
def main():
296
272
    parser = argparse.ArgumentParser()
297
273
    parser.add_argument("--version", action="version",
298
 
                        version="%(prog)s {}".format(version),
 
274
                        version = "%(prog)s {}".format(version),
299
275
                        help="show version number and exit")
300
276
    parser.add_argument("-a", "--all", action="store_true",
301
277
                        help="Select all clients")
302
278
    parser.add_argument("-v", "--verbose", action="store_true",
303
279
                        help="Print all fields")
304
 
    parser.add_argument("-j", "--dump-json", action="store_true",
305
 
                        help="Dump client data in JSON format")
306
280
    parser.add_argument("-e", "--enable", action="store_true",
307
281
                        help="Enable client")
308
282
    parser.add_argument("-d", "--disable", action="store_true",
347
321
                        help="Run self-test")
348
322
    parser.add_argument("client", nargs="*", help="Client name")
349
323
    options = parser.parse_args()
350
 
 
 
324
    
351
325
    if has_actions(options) and not (options.client or options.all):
352
326
        parser.error("Options require clients names or --all.")
353
327
    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.")
 
328
        parser.error("--verbose can only be used alone or with"
 
329
                     " --all.")
358
330
    if options.all and not has_actions(options):
359
331
        parser.error("--all requires an action.")
360
332
 
 
333
    if options.check:
 
334
        fail_count, test_count = doctest.testmod()
 
335
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
336
    
361
337
    try:
362
338
        bus = dbus.SystemBus()
363
339
        mandos_dbus_objc = bus.get_object(busname, server_path)
364
340
    except dbus.exceptions.DBusException:
365
 
        log.critical("Could not connect to Mandos server")
 
341
        print("Could not connect to Mandos server",
 
342
              file=sys.stderr)
366
343
        sys.exit(1)
367
 
 
 
344
    
368
345
    mandos_serv = dbus.Interface(mandos_dbus_objc,
369
 
                                 dbus_interface=server_interface)
370
 
    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
 
346
                                 dbus_interface = server_interface)
 
347
    
 
348
    #block stderr since dbus library prints to stderr
374
349
    null = os.open(os.path.devnull, os.O_RDWR)
375
350
    stderrcopy = os.dup(sys.stderr.fileno())
376
351
    os.dup2(null, sys.stderr.fileno())
377
352
    os.close(null)
378
353
    try:
379
354
        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}
 
355
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
385
356
        finally:
386
 
            # restore stderr
 
357
            #restore stderr
387
358
            os.dup2(stderrcopy, sys.stderr.fileno())
388
359
            os.close(stderrcopy)
389
 
    except dbus.exceptions.DBusException as e:
390
 
        log.critical("Failed to access Mandos server through D-Bus:"
391
 
                     "\n%s", e)
 
360
    except dbus.exceptions.DBusException:
 
361
        print("Access denied: Accessing mandos server through dbus.",
 
362
              file=sys.stderr)
392
363
        sys.exit(1)
393
 
 
 
364
    
394
365
    # Compile dict of (clients: properties) to process
395
 
    clients = {}
396
 
 
 
366
    clients={}
 
367
    
397
368
    if options.all or not options.client:
398
 
        clients = {bus.get_object(busname, path): properties
399
 
                   for path, properties in mandos_clients.items()}
 
369
        clients = { bus.get_object(busname, path): properties
 
370
                    for path, properties in mandos_clients.items() }
400
371
    else:
401
372
        for name in options.client:
402
373
            for path, client in mandos_clients.items():
405
376
                    clients[client_objc] = client
406
377
                    break
407
378
            else:
408
 
                log.critical("Client not found on server: %r", name)
 
379
                print("Client not found on server: {!r}"
 
380
                      .format(name), file=sys.stderr)
409
381
                sys.exit(1)
410
 
 
 
382
    
411
383
    if not has_actions(options) and clients:
412
 
        if options.verbose or options.dump_json:
413
 
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
414
 
                        "Created", "Interval", "Host", "KeyID",
415
 
                        "Fingerprint", "CheckerRunning",
 
384
        if options.verbose:
 
385
            keywords = ("Name", "Enabled", "Timeout",
 
386
                        "LastCheckedOK", "Created", "Interval",
 
387
                        "Host", "Fingerprint", "CheckerRunning",
416
388
                        "LastEnabled", "ApprovalPending",
417
 
                        "ApprovedByDefault", "LastApprovalRequest",
418
 
                        "ApprovalDelay", "ApprovalDuration",
419
 
                        "Checker", "ExtendedTimeout", "Expires",
420
 
                        "LastCheckerStatus")
 
389
                        "ApprovedByDefault",
 
390
                        "LastApprovalRequest", "ApprovalDelay",
 
391
                        "ApprovalDuration", "Checker",
 
392
                        "ExtendedTimeout")
421
393
        else:
422
394
            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)
 
395
        
 
396
        print_clients(clients.values(), keywords)
437
397
    else:
438
398
        # Process each client in the list by all selected options
439
399
        for client in clients:
440
 
 
441
400
            def set_client_prop(prop, value):
442
401
                """Set a Client D-Bus property"""
443
402
                client.Set(client_interface, prop, value,
444
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
445
 
 
446
404
            def set_client_prop_ms(prop, value):
447
405
                """Set a Client D-Bus property, converted
448
406
                from a string to milliseconds."""
449
407
                set_client_prop(prop,
450
408
                                string_to_delta(value).total_seconds()
451
409
                                * 1000)
452
 
 
453
410
            if options.remove:
454
411
                mandos_serv.RemoveClient(client.__dbus_object_path__)
455
412
            if options.enable:
463
420
            if options.stop_checker:
464
421
                set_client_prop("CheckerRunning", dbus.Boolean(False))
465
422
            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)
 
423
                sys.exit(0 if client.Get(client_interface,
 
424
                                         "Enabled",
 
425
                                         dbus_interface=
 
426
                                         dbus.PROPERTIES_IFACE)
 
427
                         else 1)
471
428
            if options.checker is not None:
472
429
                set_client_prop("Checker", options.checker)
473
430
            if options.host is not None:
499
456
                client.Approve(dbus.Boolean(False),
500
457
                               dbus_interface=client_interface)
501
458
 
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
 
 
533
459
if __name__ == "__main__":
534
 
    if should_only_run_tests():
535
 
        # Call using ./tdd-python-script --check [--verbose]
536
 
        unittest.main()
537
 
    else:
538
 
        main()
 
460
    main()