/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
3
3
# 
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
# 
6
 
# Copyright © 2008-2012 Teddy Hogeborn
7
 
# Copyright © 2008-2012 Björn Påhlsson
 
6
# Copyright © 2008-2016 Teddy Hogeborn
 
7
# Copyright © 2008-2016 Björn Påhlsson
8
8
# 
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
28
 
29
 
from future_builtins import *
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
30
33
 
31
34
import sys
32
 
import dbus
33
35
import argparse
34
36
import locale
35
37
import datetime
36
38
import re
37
39
import os
 
40
import collections
 
41
import doctest
 
42
import json
 
43
 
 
44
import dbus
 
45
 
 
46
if sys.version_info.major == 2:
 
47
    str = unicode
38
48
 
39
49
locale.setlocale(locale.LC_ALL, "")
40
50
 
55
65
    "ApprovalDelay": "Approval Delay",
56
66
    "ApprovalDuration": "Approval Duration",
57
67
    "Checker": "Checker",
58
 
    "ExtendedTimeout" : "Extended Timeout"
59
 
    }
 
68
    "ExtendedTimeout": "Extended Timeout",
 
69
    "Expires": "Expires",
 
70
    "LastCheckerStatus": "Last Checker Status",
 
71
}
60
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
61
73
domain = "se.recompile"
62
74
busname = domain + ".Mandos"
63
75
server_path = "/"
64
76
server_interface = domain + ".Mandos"
65
77
client_interface = domain + ".Mandos.Client"
66
 
version = "1.5.3"
67
 
 
68
 
def timedelta_to_milliseconds(td):
69
 
    """Convert a datetime.timedelta object to milliseconds"""
70
 
    return ((td.days * 24 * 60 * 60 * 1000)
71
 
            + (td.seconds * 1000)
72
 
            + (td.microseconds // 1000))
 
78
version = "1.7.10"
 
79
 
 
80
 
 
81
try:
 
82
    dbus.OBJECT_MANAGER_IFACE
 
83
except AttributeError:
 
84
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
73
85
 
74
86
def milliseconds_to_string(ms):
75
87
    td = datetime.timedelta(0, 0, 0, ms)
76
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
77
 
            .format(days = "{0}T".format(td.days) if td.days else "",
78
 
                    hours = td.seconds // 3600,
79
 
                    minutes = (td.seconds % 3600) // 60,
80
 
                    seconds = td.seconds % 60,
81
 
                    ))
 
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))
 
93
 
 
94
 
 
95
def rfc3339_duration_to_delta(duration):
 
96
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
97
    
 
98
    >>> rfc3339_duration_to_delta("P7D")
 
99
    datetime.timedelta(7)
 
100
    >>> rfc3339_duration_to_delta("PT60S")
 
101
    datetime.timedelta(0, 60)
 
102
    >>> rfc3339_duration_to_delta("PT60M")
 
103
    datetime.timedelta(0, 3600)
 
104
    >>> rfc3339_duration_to_delta("PT24H")
 
105
    datetime.timedelta(1)
 
106
    >>> rfc3339_duration_to_delta("P1W")
 
107
    datetime.timedelta(7)
 
108
    >>> rfc3339_duration_to_delta("PT5M30S")
 
109
    datetime.timedelta(0, 330)
 
110
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
111
    datetime.timedelta(1, 200)
 
112
    """
 
113
    
 
114
    # Parsing an RFC 3339 duration with regular expressions is not
 
115
    # possible - there would have to be multiple places for the same
 
116
    # values, like seconds.  The current code, while more esoteric, is
 
117
    # cleaner without depending on a parsing library.  If Python had a
 
118
    # built-in library for parsing we would use it, but we'd like to
 
119
    # avoid excessive use of external libraries.
 
120
    
 
121
    # New type for defining tokens, syntax, and semantics all-in-one
 
122
    Token = collections.namedtuple("Token", (
 
123
        "regexp",  # To match token; if "value" is not None, must have
 
124
                   # a "group" containing digits
 
125
        "value",   # datetime.timedelta or None
 
126
        "followers"))           # Tokens valid after this token
 
127
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
128
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
129
    token_end = Token(re.compile(r"$"), None, frozenset())
 
130
    token_second = Token(re.compile(r"(\d+)S"),
 
131
                         datetime.timedelta(seconds=1),
 
132
                         frozenset((token_end, )))
 
133
    token_minute = Token(re.compile(r"(\d+)M"),
 
134
                         datetime.timedelta(minutes=1),
 
135
                         frozenset((token_second, token_end)))
 
136
    token_hour = Token(re.compile(r"(\d+)H"),
 
137
                       datetime.timedelta(hours=1),
 
138
                       frozenset((token_minute, token_end)))
 
139
    token_time = Token(re.compile(r"T"),
 
140
                       None,
 
141
                       frozenset((token_hour, token_minute,
 
142
                                  token_second)))
 
143
    token_day = Token(re.compile(r"(\d+)D"),
 
144
                      datetime.timedelta(days=1),
 
145
                      frozenset((token_time, token_end)))
 
146
    token_month = Token(re.compile(r"(\d+)M"),
 
147
                        datetime.timedelta(weeks=4),
 
148
                        frozenset((token_day, token_end)))
 
149
    token_year = Token(re.compile(r"(\d+)Y"),
 
150
                       datetime.timedelta(weeks=52),
 
151
                       frozenset((token_month, token_end)))
 
152
    token_week = Token(re.compile(r"(\d+)W"),
 
153
                       datetime.timedelta(weeks=1),
 
154
                       frozenset((token_end, )))
 
155
    token_duration = Token(re.compile(r"P"), None,
 
156
                           frozenset((token_year, token_month,
 
157
                                      token_day, token_time,
 
158
                                      token_week)))
 
159
    # Define starting values
 
160
    value = datetime.timedelta() # Value so far
 
161
    found_token = None
 
162
    followers = frozenset((token_duration, )) # Following valid tokens
 
163
    s = duration                # String left to parse
 
164
    # Loop until end token is found
 
165
    while found_token is not token_end:
 
166
        # Search for any currently valid tokens
 
167
        for token in followers:
 
168
            match = token.regexp.match(s)
 
169
            if match is not None:
 
170
                # Token found
 
171
                if token.value is not None:
 
172
                    # Value found, parse digits
 
173
                    factor = int(match.group(1), 10)
 
174
                    # Add to value so far
 
175
                    value += factor * token.value
 
176
                # Strip token from string
 
177
                s = token.regexp.sub("", s, 1)
 
178
                # Go to found token
 
179
                found_token = token
 
180
                # Set valid next tokens
 
181
                followers = found_token.followers
 
182
                break
 
183
        else:
 
184
            # No currently valid tokens were found
 
185
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
186
                             .format(duration))
 
187
    # End token found
 
188
    return value
 
189
 
82
190
 
83
191
def string_to_delta(interval):
84
192
    """Parse a string and return a datetime.timedelta
85
193
    
86
 
    >>> string_to_delta("7d")
 
194
    >>> string_to_delta('7d')
87
195
    datetime.timedelta(7)
88
 
    >>> string_to_delta("60s")
 
196
    >>> string_to_delta('60s')
89
197
    datetime.timedelta(0, 60)
90
 
    >>> string_to_delta("60m")
 
198
    >>> string_to_delta('60m')
91
199
    datetime.timedelta(0, 3600)
92
 
    >>> string_to_delta("24h")
 
200
    >>> string_to_delta('24h')
93
201
    datetime.timedelta(1)
94
 
    >>> string_to_delta("1w")
 
202
    >>> string_to_delta('1w')
95
203
    datetime.timedelta(7)
96
 
    >>> string_to_delta("5m 30s")
 
204
    >>> string_to_delta('5m 30s')
97
205
    datetime.timedelta(0, 330)
98
206
    """
 
207
    
 
208
    try:
 
209
        return rfc3339_duration_to_delta(interval)
 
210
    except ValueError:
 
211
        pass
 
212
    
99
213
    value = datetime.timedelta(0)
100
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
214
    regexp = re.compile(r"(\d+)([dsmhw]?)")
101
215
    
102
216
    for num, suffix in regexp.findall(interval):
103
217
        if suffix == "d":
114
228
            value += datetime.timedelta(0, 0, 0, int(num))
115
229
    return value
116
230
 
 
231
 
117
232
def print_clients(clients, keywords):
118
233
    def valuetostring(value, keyword):
119
234
        if type(value) is dbus.Boolean:
121
236
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
122
237
                       "ApprovalDuration", "ExtendedTimeout"):
123
238
            return milliseconds_to_string(value)
124
 
        return unicode(value)
 
239
        return str(value)
125
240
    
126
241
    # Create format string to print table rows
127
242
    format_string = " ".join("{{{key}:{width}}}".format(
128
 
            width = max(len(tablewords[key]),
129
 
                        max(len(valuetostring(client[key],
130
 
                                              key))
131
 
                            for client in
132
 
                            clients)),
133
 
            key = key) for key in keywords)
 
243
        width = max(len(tablewords[key]),
 
244
                    max(len(valuetostring(client[key], key))
 
245
                        for client in clients)),
 
246
        key = key)
 
247
                             for key in keywords)
134
248
    # Print header line
135
249
    print(format_string.format(**tablewords))
136
250
    for client in clients:
137
 
        print(format_string.format(**dict((key,
138
 
                                           valuetostring(client[key],
139
 
                                                         key))
140
 
                                          for key in keywords)))
 
251
        print(format_string.format(**{
 
252
            key: valuetostring(client[key], key)
 
253
            for key in keywords }))
 
254
 
141
255
 
142
256
def has_actions(options):
143
257
    return any((options.enable,
159
273
                options.approve,
160
274
                options.deny))
161
275
 
 
276
 
162
277
def main():
163
278
    parser = argparse.ArgumentParser()
164
279
    parser.add_argument("--version", action="version",
165
 
                        version = "%(prog)s {0}".format(version),
 
280
                        version = "%(prog)s {}".format(version),
166
281
                        help="show version number and exit")
167
282
    parser.add_argument("-a", "--all", action="store_true",
168
283
                        help="Select all clients")
169
284
    parser.add_argument("-v", "--verbose", action="store_true",
170
285
                        help="Print all fields")
 
286
    parser.add_argument("-j", "--dump-json", action="store_true",
 
287
                        help="Dump client data in JSON format")
171
288
    parser.add_argument("-e", "--enable", action="store_true",
172
289
                        help="Enable client")
173
290
    parser.add_argument("-d", "--disable", action="store_true",
201
318
    parser.add_argument("--approval-duration",
202
319
                        help="Set duration of one client approval")
203
320
    parser.add_argument("-H", "--host", help="Set host for client")
204
 
    parser.add_argument("-s", "--secret", type=file,
 
321
    parser.add_argument("-s", "--secret",
 
322
                        type=argparse.FileType(mode="rb"),
205
323
                        help="Set password blob (file) for client")
206
324
    parser.add_argument("-A", "--approve", action="store_true",
207
325
                        help="Approve any current client request")
208
326
    parser.add_argument("-D", "--deny", action="store_true",
209
327
                        help="Deny any current client request")
 
328
    parser.add_argument("--check", action="store_true",
 
329
                        help="Run self-test")
210
330
    parser.add_argument("client", nargs="*", help="Client name")
211
331
    options = parser.parse_args()
212
332
    
213
333
    if has_actions(options) and not (options.client or options.all):
214
334
        parser.error("Options require clients names or --all.")
215
335
    if options.verbose and has_actions(options):
216
 
        parser.error("--verbose can only be used alone or with"
217
 
                     " --all.")
 
336
        parser.error("--verbose can only be used alone.")
 
337
    if options.dump_json and (options.verbose or has_actions(options)):
 
338
        parser.error("--dump-json can only be used alone.")
218
339
    if options.all and not has_actions(options):
219
340
        parser.error("--all requires an action.")
220
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
    
221
346
    try:
222
347
        bus = dbus.SystemBus()
223
348
        mandos_dbus_objc = bus.get_object(busname, server_path)
224
349
    except dbus.exceptions.DBusException:
225
 
        print("Could not connect to Mandos server",
226
 
              file=sys.stderr)
 
350
        print("Could not connect to Mandos server", file=sys.stderr)
227
351
        sys.exit(1)
228
352
    
229
353
    mandos_serv = dbus.Interface(mandos_dbus_objc,
230
354
                                 dbus_interface = server_interface)
 
355
    mandos_serv_object_manager = dbus.Interface(
 
356
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
231
357
    
232
358
    #block stderr since dbus library prints to stderr
233
359
    null = os.open(os.path.devnull, os.O_RDWR)
236
362
    os.close(null)
237
363
    try:
238
364
        try:
239
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
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 }
240
370
        finally:
241
371
            #restore stderr
242
372
            os.dup2(stderrcopy, sys.stderr.fileno())
243
373
            os.close(stderrcopy)
244
 
    except dbus.exceptions.DBusException:
245
 
        print("Access denied: Accessing mandos server through dbus.",
246
 
              file=sys.stderr)
 
374
    except dbus.exceptions.DBusException as e:
 
375
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
376
              .format(e), file=sys.stderr)
247
377
        sys.exit(1)
248
378
    
249
379
    # Compile dict of (clients: properties) to process
250
380
    clients={}
251
381
    
252
382
    if options.all or not options.client:
253
 
        clients = dict((bus.get_object(busname, path), properties)
254
 
                       for path, properties in
255
 
                       mandos_clients.iteritems())
 
383
        clients = { bus.get_object(busname, path): properties
 
384
                    for path, properties in mandos_clients.items() }
256
385
    else:
257
386
        for name in options.client:
258
 
            for path, client in mandos_clients.iteritems():
 
387
            for path, client in mandos_clients.items():
259
388
                if client["Name"] == name:
260
389
                    client_objc = bus.get_object(busname, path)
261
390
                    clients[client_objc] = client
262
391
                    break
263
392
            else:
264
 
                print("Client not found on server: {0!r}"
 
393
                print("Client not found on server: {!r}"
265
394
                      .format(name), file=sys.stderr)
266
395
                sys.exit(1)
267
396
    
268
397
    if not has_actions(options) and clients:
269
 
        if options.verbose:
270
 
            keywords = ("Name", "Enabled", "Timeout",
271
 
                        "LastCheckedOK", "Created", "Interval",
272
 
                        "Host", "Fingerprint", "CheckerRunning",
273
 
                        "LastEnabled", "ApprovalPending",
274
 
                        "ApprovedByDefault",
 
398
        if options.verbose or options.dump_json:
 
399
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
400
                        "Created", "Interval", "Host", "Fingerprint",
 
401
                        "CheckerRunning", "LastEnabled",
 
402
                        "ApprovalPending", "ApprovedByDefault",
275
403
                        "LastApprovalRequest", "ApprovalDelay",
276
404
                        "ApprovalDuration", "Checker",
277
 
                        "ExtendedTimeout")
 
405
                        "ExtendedTimeout", "Expires",
 
406
                        "LastCheckerStatus")
278
407
        else:
279
408
            keywords = defaultkeywords
280
409
        
281
 
        print_clients(clients.values(), keywords)
 
410
        if options.dump_json:
 
411
            json.dump({client["Name"]: {key:
 
412
                                        bool(client[key])
 
413
                                        if isinstance(client[key],
 
414
                                                      dbus.Boolean)
 
415
                                        else client[key]
 
416
                                        for key in keywords }
 
417
                       for client in clients.values() },
 
418
                      fp = sys.stdout, indent = 4,
 
419
                      separators = (',', ': '))
 
420
            print()
 
421
        else:
 
422
            print_clients(clients.values(), keywords)
282
423
    else:
283
424
        # Process each client in the list by all selected options
284
425
        for client in clients:
 
426
            
285
427
            def set_client_prop(prop, value):
286
428
                """Set a Client D-Bus property"""
287
429
                client.Set(client_interface, prop, value,
288
430
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
431
            
289
432
            def set_client_prop_ms(prop, value):
290
433
                """Set a Client D-Bus property, converted
291
434
                from a string to milliseconds."""
292
435
                set_client_prop(prop,
293
 
                                timedelta_to_milliseconds
294
 
                                (string_to_delta(value)))
 
436
                                string_to_delta(value).total_seconds()
 
437
                                * 1000)
 
438
            
295
439
            if options.remove:
296
440
                mandos_serv.RemoveClient(client.__dbus_object_path__)
297
441
            if options.enable:
341
485
                client.Approve(dbus.Boolean(False),
342
486
                               dbus_interface=client_interface)
343
487
 
 
488
 
344
489
if __name__ == "__main__":
345
490
    main()