/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
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
35
import argparse
39
42
 
40
43
import dbus
41
44
 
 
45
if sys.version_info.major == 2:
 
46
    str = unicode
 
47
 
42
48
locale.setlocale(locale.LC_ALL, "")
43
49
 
44
50
tablewords = {
58
64
    "ApprovalDelay": "Approval Delay",
59
65
    "ApprovalDuration": "Approval Duration",
60
66
    "Checker": "Checker",
61
 
    "ExtendedTimeout" : "Extended Timeout"
62
 
    }
 
67
    "ExtendedTimeout": "Extended Timeout"
 
68
}
63
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
64
70
domain = "se.recompile"
65
71
busname = domain + ".Mandos"
66
72
server_path = "/"
67
73
server_interface = domain + ".Mandos"
68
74
client_interface = domain + ".Mandos.Client"
69
 
version = "1.6.0"
70
 
 
71
 
def timedelta_to_milliseconds(td):
72
 
    """Convert a datetime.timedelta object to milliseconds"""
73
 
    return ((td.days * 24 * 60 * 60 * 1000)
74
 
            + (td.seconds * 1000)
75
 
            + (td.microseconds // 1000))
 
75
version = "1.7.3"
 
76
 
 
77
 
 
78
try:
 
79
    dbus.OBJECT_MANAGER_IFACE
 
80
except AttributeError:
 
81
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
76
82
 
77
83
def milliseconds_to_string(ms):
78
84
    td = datetime.timedelta(0, 0, 0, ms)
79
 
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
80
 
            .format(days = "{0}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
 
                    ))
 
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))
85
90
 
86
91
 
87
92
def rfc3339_duration_to_delta(duration):
111
116
    # avoid excessive use of external libraries.
112
117
    
113
118
    # New type for defining tokens, syntax, and semantics all-in-one
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
 
119
    Token = collections.namedtuple("Token", (
 
120
        "regexp",  # To match token; if "value" is not None, must have
 
121
                   # a "group" containing digits
 
122
        "value",   # datetime.timedelta or None
 
123
        "followers"))           # Tokens valid after this token
123
124
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
124
125
    # the "duration" ABNF definition in RFC 3339, Appendix A.
125
126
    token_end = Token(re.compile(r"$"), None, frozenset())
126
127
    token_second = Token(re.compile(r"(\d+)S"),
127
128
                         datetime.timedelta(seconds=1),
128
 
                         frozenset((token_end,)))
 
129
                         frozenset((token_end, )))
129
130
    token_minute = Token(re.compile(r"(\d+)M"),
130
131
                         datetime.timedelta(minutes=1),
131
132
                         frozenset((token_second, token_end)))
147
148
                       frozenset((token_month, token_end)))
148
149
    token_week = Token(re.compile(r"(\d+)W"),
149
150
                       datetime.timedelta(weeks=1),
150
 
                       frozenset((token_end,)))
 
151
                       frozenset((token_end, )))
151
152
    token_duration = Token(re.compile(r"P"), None,
152
153
                           frozenset((token_year, token_month,
153
154
                                      token_day, token_time,
154
 
                                      token_week))),
 
155
                                      token_week)))
155
156
    # Define starting values
156
157
    value = datetime.timedelta() # Value so far
157
158
    found_token = None
158
 
    followers = frozenset(token_duration,) # Following valid tokens
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
159
160
    s = duration                # String left to parse
160
161
    # Loop until end token is found
161
162
    while found_token is not token_end:
178
179
                break
179
180
        else:
180
181
            # No currently valid tokens were found
181
 
            raise ValueError("Invalid RFC 3339 duration")
 
182
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
183
                             .format(duration))
182
184
    # End token found
183
185
    return value
184
186
 
186
188
def string_to_delta(interval):
187
189
    """Parse a string and return a datetime.timedelta
188
190
    
189
 
    >>> string_to_delta("7d")
 
191
    >>> string_to_delta('7d')
190
192
    datetime.timedelta(7)
191
 
    >>> string_to_delta("60s")
 
193
    >>> string_to_delta('60s')
192
194
    datetime.timedelta(0, 60)
193
 
    >>> string_to_delta("60m")
 
195
    >>> string_to_delta('60m')
194
196
    datetime.timedelta(0, 3600)
195
 
    >>> string_to_delta("24h")
 
197
    >>> string_to_delta('24h')
196
198
    datetime.timedelta(1)
197
 
    >>> string_to_delta("1w")
 
199
    >>> string_to_delta('1w')
198
200
    datetime.timedelta(7)
199
 
    >>> string_to_delta("5m 30s")
 
201
    >>> string_to_delta('5m 30s')
200
202
    datetime.timedelta(0, 330)
201
203
    """
202
 
    value = datetime.timedelta(0)
203
 
    regexp = re.compile(r"(\d+)([dsmhw]?)")
204
204
    
205
205
    try:
206
206
        return rfc3339_duration_to_delta(interval)
207
207
    except ValueError:
208
208
        pass
209
209
    
 
210
    value = datetime.timedelta(0)
 
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
212
    
210
213
    for num, suffix in regexp.findall(interval):
211
214
        if suffix == "d":
212
215
            value += datetime.timedelta(int(num))
222
225
            value += datetime.timedelta(0, 0, 0, int(num))
223
226
    return value
224
227
 
 
228
 
225
229
def print_clients(clients, keywords):
226
230
    def valuetostring(value, keyword):
227
231
        if type(value) is dbus.Boolean:
229
233
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
230
234
                       "ApprovalDuration", "ExtendedTimeout"):
231
235
            return milliseconds_to_string(value)
232
 
        return unicode(value)
 
236
        return str(value)
233
237
    
234
238
    # Create format string to print table rows
235
239
    format_string = " ".join("{{{key}:{width}}}".format(
236
 
            width = max(len(tablewords[key]),
237
 
                        max(len(valuetostring(client[key],
238
 
                                              key))
239
 
                            for client in
240
 
                            clients)),
241
 
            key = key) for key in keywords)
 
240
        width = max(len(tablewords[key]),
 
241
                    max(len(valuetostring(client[key], key))
 
242
                        for client in clients)),
 
243
        key = key)
 
244
                             for key in keywords)
242
245
    # Print header line
243
246
    print(format_string.format(**tablewords))
244
247
    for client in clients:
245
 
        print(format_string.format(**dict((key,
246
 
                                           valuetostring(client[key],
247
 
                                                         key))
248
 
                                          for key in keywords)))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
 
251
 
249
252
 
250
253
def has_actions(options):
251
254
    return any((options.enable,
267
270
                options.approve,
268
271
                options.deny))
269
272
 
 
273
 
270
274
def main():
271
275
    parser = argparse.ArgumentParser()
272
276
    parser.add_argument("--version", action="version",
273
 
                        version = "%(prog)s {0}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
274
278
                        help="show version number and exit")
275
279
    parser.add_argument("-a", "--all", action="store_true",
276
280
                        help="Select all clients")
309
313
    parser.add_argument("--approval-duration",
310
314
                        help="Set duration of one client approval")
311
315
    parser.add_argument("-H", "--host", help="Set host for client")
312
 
    parser.add_argument("-s", "--secret", type=file,
 
316
    parser.add_argument("-s", "--secret",
 
317
                        type=argparse.FileType(mode="rb"),
313
318
                        help="Set password blob (file) for client")
314
319
    parser.add_argument("-A", "--approve", action="store_true",
315
320
                        help="Approve any current client request")
330
335
 
331
336
    if options.check:
332
337
        fail_count, test_count = doctest.testmod()
333
 
        sys.exit(0 if fail_count == 0 else 1)
 
338
        sys.exit(os.EX_OK if fail_count == 0 else 1)
334
339
    
335
340
    try:
336
341
        bus = dbus.SystemBus()
337
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
338
343
    except dbus.exceptions.DBusException:
339
 
        print("Could not connect to Mandos server",
340
 
              file=sys.stderr)
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
341
345
        sys.exit(1)
342
346
    
343
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
344
348
                                 dbus_interface = server_interface)
 
349
    mandos_serv_object_manager = dbus.Interface(
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
345
351
    
346
352
    #block stderr since dbus library prints to stderr
347
353
    null = os.open(os.path.devnull, os.O_RDWR)
350
356
    os.close(null)
351
357
    try:
352
358
        try:
353
 
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
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 }
354
364
        finally:
355
365
            #restore stderr
356
366
            os.dup2(stderrcopy, sys.stderr.fileno())
357
367
            os.close(stderrcopy)
358
 
    except dbus.exceptions.DBusException:
359
 
        print("Access denied: Accessing mandos server through dbus.",
360
 
              file=sys.stderr)
 
368
    except dbus.exceptions.DBusException as e:
 
369
        print("Access denied: Accessing mandos server through D-Bus: {}"
 
370
              .format(e), file=sys.stderr)
361
371
        sys.exit(1)
362
372
    
363
373
    # Compile dict of (clients: properties) to process
364
374
    clients={}
365
375
    
366
376
    if options.all or not options.client:
367
 
        clients = dict((bus.get_object(busname, path), properties)
368
 
                       for path, properties in
369
 
                       mandos_clients.iteritems())
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
370
379
    else:
371
380
        for name in options.client:
372
 
            for path, client in mandos_clients.iteritems():
 
381
            for path, client in mandos_clients.items():
373
382
                if client["Name"] == name:
374
383
                    client_objc = bus.get_object(busname, path)
375
384
                    clients[client_objc] = client
376
385
                    break
377
386
            else:
378
 
                print("Client not found on server: {0!r}"
 
387
                print("Client not found on server: {!r}"
379
388
                      .format(name), file=sys.stderr)
380
389
                sys.exit(1)
381
390
    
382
391
    if not has_actions(options) and clients:
383
392
        if options.verbose:
384
 
            keywords = ("Name", "Enabled", "Timeout",
385
 
                        "LastCheckedOK", "Created", "Interval",
386
 
                        "Host", "Fingerprint", "CheckerRunning",
387
 
                        "LastEnabled", "ApprovalPending",
388
 
                        "ApprovedByDefault",
 
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
389
397
                        "LastApprovalRequest", "ApprovalDelay",
390
398
                        "ApprovalDuration", "Checker",
391
399
                        "ExtendedTimeout")
396
404
    else:
397
405
        # Process each client in the list by all selected options
398
406
        for client in clients:
 
407
            
399
408
            def set_client_prop(prop, value):
400
409
                """Set a Client D-Bus property"""
401
410
                client.Set(client_interface, prop, value,
402
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
412
            
403
413
            def set_client_prop_ms(prop, value):
404
414
                """Set a Client D-Bus property, converted
405
415
                from a string to milliseconds."""
406
416
                set_client_prop(prop,
407
 
                                timedelta_to_milliseconds
408
 
                                (string_to_delta(value)))
 
417
                                string_to_delta(value).total_seconds()
 
418
                                * 1000)
 
419
            
409
420
            if options.remove:
410
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
411
422
            if options.enable:
455
466
                client.Approve(dbus.Boolean(False),
456
467
                               dbus_interface=client_interface)
457
468
 
 
469
 
458
470
if __name__ == "__main__":
459
471
    main()