/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-ctl

  • Committer: Teddy Hogeborn
  • Date: 2016-03-05 21:42:56 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 335.
  • 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
 
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
 
 
43
import dbus
 
44
 
 
45
if sys.version_info.major == 2:
 
46
    str = unicode
38
47
 
39
48
locale.setlocale(locale.LC_ALL, "")
40
49
 
55
64
    "ApprovalDelay": "Approval Delay",
56
65
    "ApprovalDuration": "Approval Duration",
57
66
    "Checker": "Checker",
58
 
    "ExtendedTimeout" : "Extended Timeout"
59
 
    }
 
67
    "ExtendedTimeout": "Extended Timeout"
 
68
}
60
69
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
61
70
domain = "se.recompile"
62
71
busname = domain + ".Mandos"
63
72
server_path = "/"
64
73
server_interface = domain + ".Mandos"
65
74
client_interface = domain + ".Mandos.Client"
66
 
version = "1.5.4"
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))
 
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"
73
82
 
74
83
def milliseconds_to_string(ms):
75
84
    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
 
                    ))
 
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))
 
90
 
 
91
 
 
92
def rfc3339_duration_to_delta(duration):
 
93
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
94
    
 
95
    >>> rfc3339_duration_to_delta("P7D")
 
96
    datetime.timedelta(7)
 
97
    >>> rfc3339_duration_to_delta("PT60S")
 
98
    datetime.timedelta(0, 60)
 
99
    >>> rfc3339_duration_to_delta("PT60M")
 
100
    datetime.timedelta(0, 3600)
 
101
    >>> rfc3339_duration_to_delta("PT24H")
 
102
    datetime.timedelta(1)
 
103
    >>> rfc3339_duration_to_delta("P1W")
 
104
    datetime.timedelta(7)
 
105
    >>> rfc3339_duration_to_delta("PT5M30S")
 
106
    datetime.timedelta(0, 330)
 
107
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
108
    datetime.timedelta(1, 200)
 
109
    """
 
110
    
 
111
    # Parsing an RFC 3339 duration with regular expressions is not
 
112
    # possible - there would have to be multiple places for the same
 
113
    # values, like seconds.  The current code, while more esoteric, is
 
114
    # cleaner without depending on a parsing library.  If Python had a
 
115
    # built-in library for parsing we would use it, but we'd like to
 
116
    # avoid excessive use of external libraries.
 
117
    
 
118
    # New type for defining tokens, syntax, and semantics all-in-one
 
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
 
124
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
125
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
126
    token_end = Token(re.compile(r"$"), None, frozenset())
 
127
    token_second = Token(re.compile(r"(\d+)S"),
 
128
                         datetime.timedelta(seconds=1),
 
129
                         frozenset((token_end, )))
 
130
    token_minute = Token(re.compile(r"(\d+)M"),
 
131
                         datetime.timedelta(minutes=1),
 
132
                         frozenset((token_second, token_end)))
 
133
    token_hour = Token(re.compile(r"(\d+)H"),
 
134
                       datetime.timedelta(hours=1),
 
135
                       frozenset((token_minute, token_end)))
 
136
    token_time = Token(re.compile(r"T"),
 
137
                       None,
 
138
                       frozenset((token_hour, token_minute,
 
139
                                  token_second)))
 
140
    token_day = Token(re.compile(r"(\d+)D"),
 
141
                      datetime.timedelta(days=1),
 
142
                      frozenset((token_time, token_end)))
 
143
    token_month = Token(re.compile(r"(\d+)M"),
 
144
                        datetime.timedelta(weeks=4),
 
145
                        frozenset((token_day, token_end)))
 
146
    token_year = Token(re.compile(r"(\d+)Y"),
 
147
                       datetime.timedelta(weeks=52),
 
148
                       frozenset((token_month, token_end)))
 
149
    token_week = Token(re.compile(r"(\d+)W"),
 
150
                       datetime.timedelta(weeks=1),
 
151
                       frozenset((token_end, )))
 
152
    token_duration = Token(re.compile(r"P"), None,
 
153
                           frozenset((token_year, token_month,
 
154
                                      token_day, token_time,
 
155
                                      token_week)))
 
156
    # Define starting values
 
157
    value = datetime.timedelta() # Value so far
 
158
    found_token = None
 
159
    followers = frozenset((token_duration, )) # Following valid tokens
 
160
    s = duration                # String left to parse
 
161
    # Loop until end token is found
 
162
    while found_token is not token_end:
 
163
        # Search for any currently valid tokens
 
164
        for token in followers:
 
165
            match = token.regexp.match(s)
 
166
            if match is not None:
 
167
                # Token found
 
168
                if token.value is not None:
 
169
                    # Value found, parse digits
 
170
                    factor = int(match.group(1), 10)
 
171
                    # Add to value so far
 
172
                    value += factor * token.value
 
173
                # Strip token from string
 
174
                s = token.regexp.sub("", s, 1)
 
175
                # Go to found token
 
176
                found_token = token
 
177
                # Set valid next tokens
 
178
                followers = found_token.followers
 
179
                break
 
180
        else:
 
181
            # No currently valid tokens were found
 
182
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
183
                             .format(duration))
 
184
    # End token found
 
185
    return value
 
186
 
82
187
 
83
188
def string_to_delta(interval):
84
189
    """Parse a string and return a datetime.timedelta
85
190
    
86
 
    >>> string_to_delta("7d")
 
191
    >>> string_to_delta('7d')
87
192
    datetime.timedelta(7)
88
 
    >>> string_to_delta("60s")
 
193
    >>> string_to_delta('60s')
89
194
    datetime.timedelta(0, 60)
90
 
    >>> string_to_delta("60m")
 
195
    >>> string_to_delta('60m')
91
196
    datetime.timedelta(0, 3600)
92
 
    >>> string_to_delta("24h")
 
197
    >>> string_to_delta('24h')
93
198
    datetime.timedelta(1)
94
 
    >>> string_to_delta("1w")
 
199
    >>> string_to_delta('1w')
95
200
    datetime.timedelta(7)
96
 
    >>> string_to_delta("5m 30s")
 
201
    >>> string_to_delta('5m 30s')
97
202
    datetime.timedelta(0, 330)
98
203
    """
 
204
    
 
205
    try:
 
206
        return rfc3339_duration_to_delta(interval)
 
207
    except ValueError:
 
208
        pass
 
209
    
99
210
    value = datetime.timedelta(0)
100
 
    regexp = re.compile("(\d+)([dsmhw]?)")
 
211
    regexp = re.compile(r"(\d+)([dsmhw]?)")
101
212
    
102
213
    for num, suffix in regexp.findall(interval):
103
214
        if suffix == "d":
114
225
            value += datetime.timedelta(0, 0, 0, int(num))
115
226
    return value
116
227
 
 
228
 
117
229
def print_clients(clients, keywords):
118
230
    def valuetostring(value, keyword):
119
231
        if type(value) is dbus.Boolean:
121
233
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
122
234
                       "ApprovalDuration", "ExtendedTimeout"):
123
235
            return milliseconds_to_string(value)
124
 
        return unicode(value)
 
236
        return str(value)
125
237
    
126
238
    # Create format string to print table rows
127
239
    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)
 
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)
134
245
    # Print header line
135
246
    print(format_string.format(**tablewords))
136
247
    for client in clients:
137
 
        print(format_string.format(**dict((key,
138
 
                                           valuetostring(client[key],
139
 
                                                         key))
140
 
                                          for key in keywords)))
 
248
        print(format_string.format(**{
 
249
            key: valuetostring(client[key], key)
 
250
            for key in keywords }))
 
251
 
141
252
 
142
253
def has_actions(options):
143
254
    return any((options.enable,
159
270
                options.approve,
160
271
                options.deny))
161
272
 
 
273
 
162
274
def main():
163
275
    parser = argparse.ArgumentParser()
164
276
    parser.add_argument("--version", action="version",
165
 
                        version = "%(prog)s {0}".format(version),
 
277
                        version = "%(prog)s {}".format(version),
166
278
                        help="show version number and exit")
167
279
    parser.add_argument("-a", "--all", action="store_true",
168
280
                        help="Select all clients")
201
313
    parser.add_argument("--approval-duration",
202
314
                        help="Set duration of one client approval")
203
315
    parser.add_argument("-H", "--host", help="Set host for client")
204
 
    parser.add_argument("-s", "--secret", type=file,
 
316
    parser.add_argument("-s", "--secret",
 
317
                        type=argparse.FileType(mode="rb"),
205
318
                        help="Set password blob (file) for client")
206
319
    parser.add_argument("-A", "--approve", action="store_true",
207
320
                        help="Approve any current client request")
208
321
    parser.add_argument("-D", "--deny", action="store_true",
209
322
                        help="Deny any current client request")
 
323
    parser.add_argument("--check", action="store_true",
 
324
                        help="Run self-test")
210
325
    parser.add_argument("client", nargs="*", help="Client name")
211
326
    options = parser.parse_args()
212
327
    
217
332
                     " --all.")
218
333
    if options.all and not has_actions(options):
219
334
        parser.error("--all requires an action.")
 
335
 
 
336
    if options.check:
 
337
        fail_count, test_count = doctest.testmod()
 
338
        sys.exit(os.EX_OK if fail_count == 0 else 1)
220
339
    
221
340
    try:
222
341
        bus = dbus.SystemBus()
223
342
        mandos_dbus_objc = bus.get_object(busname, server_path)
224
343
    except dbus.exceptions.DBusException:
225
 
        print("Could not connect to Mandos server",
226
 
              file=sys.stderr)
 
344
        print("Could not connect to Mandos server", file=sys.stderr)
227
345
        sys.exit(1)
228
346
    
229
347
    mandos_serv = dbus.Interface(mandos_dbus_objc,
230
348
                                 dbus_interface = server_interface)
 
349
    mandos_serv_object_manager = dbus.Interface(
 
350
        mandos_dbus_objc, dbus_interface = dbus.OBJECT_MANAGER_IFACE)
231
351
    
232
352
    #block stderr since dbus library prints to stderr
233
353
    null = os.open(os.path.devnull, os.O_RDWR)
236
356
    os.close(null)
237
357
    try:
238
358
        try:
239
 
            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 }
240
364
        finally:
241
365
            #restore stderr
242
366
            os.dup2(stderrcopy, sys.stderr.fileno())
243
367
            os.close(stderrcopy)
244
 
    except dbus.exceptions.DBusException:
245
 
        print("Access denied: Accessing mandos server through dbus.",
246
 
              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)
247
371
        sys.exit(1)
248
372
    
249
373
    # Compile dict of (clients: properties) to process
250
374
    clients={}
251
375
    
252
376
    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())
 
377
        clients = { bus.get_object(busname, path): properties
 
378
                    for path, properties in mandos_clients.items() }
256
379
    else:
257
380
        for name in options.client:
258
 
            for path, client in mandos_clients.iteritems():
 
381
            for path, client in mandos_clients.items():
259
382
                if client["Name"] == name:
260
383
                    client_objc = bus.get_object(busname, path)
261
384
                    clients[client_objc] = client
262
385
                    break
263
386
            else:
264
 
                print("Client not found on server: {0!r}"
 
387
                print("Client not found on server: {!r}"
265
388
                      .format(name), file=sys.stderr)
266
389
                sys.exit(1)
267
390
    
268
391
    if not has_actions(options) and clients:
269
392
        if options.verbose:
270
 
            keywords = ("Name", "Enabled", "Timeout",
271
 
                        "LastCheckedOK", "Created", "Interval",
272
 
                        "Host", "Fingerprint", "CheckerRunning",
273
 
                        "LastEnabled", "ApprovalPending",
274
 
                        "ApprovedByDefault",
 
393
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
 
394
                        "Created", "Interval", "Host", "Fingerprint",
 
395
                        "CheckerRunning", "LastEnabled",
 
396
                        "ApprovalPending", "ApprovedByDefault",
275
397
                        "LastApprovalRequest", "ApprovalDelay",
276
398
                        "ApprovalDuration", "Checker",
277
399
                        "ExtendedTimeout")
282
404
    else:
283
405
        # Process each client in the list by all selected options
284
406
        for client in clients:
 
407
            
285
408
            def set_client_prop(prop, value):
286
409
                """Set a Client D-Bus property"""
287
410
                client.Set(client_interface, prop, value,
288
411
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
412
            
289
413
            def set_client_prop_ms(prop, value):
290
414
                """Set a Client D-Bus property, converted
291
415
                from a string to milliseconds."""
292
416
                set_client_prop(prop,
293
 
                                timedelta_to_milliseconds
294
 
                                (string_to_delta(value)))
 
417
                                string_to_delta(value).total_seconds()
 
418
                                * 1000)
 
419
            
295
420
            if options.remove:
296
421
                mandos_serv.RemoveClient(client.__dbus_object_path__)
297
422
            if options.enable:
341
466
                client.Approve(dbus.Boolean(False),
342
467
                               dbus_interface=client_interface)
343
468
 
 
469
 
344
470
if __name__ == "__main__":
345
471
    main()