/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: 2014-06-15 02:48:49 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 317.
  • Revision ID: teddy@recompile.se-20140615024849-68x3q8g4yzadl33s
mandos: New "--no-zeroconf" option.  Also make "--socket=0" work.

* mandos (main): New "--no-zeroconf" option.  Also do not interpret
                 socket=0 as no socket.
* mandos-options.xml (zeroconf): New.
* mandos.conf (socket, zeroconf): New.
* mandos.xml (SYNOPSIS, OPTIONS): Added "--no-zeroconf".

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 -*-
 
3
# 
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
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
 
11
# the Free Software Foundation, either version 3 of the License, or
 
12
# (at your option) any later version.
 
13
#
 
14
#     This program is distributed in the hope that it will be useful,
 
15
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
17
#     GNU General Public License for more details.
 
18
# 
 
19
# You should have received a copy of the GNU General Public License
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
 
22
# 
 
23
# Contact the authors at <mandos@recompile.se>.
 
24
# 
 
25
 
 
26
from __future__ import (division, absolute_import, print_function,
 
27
                        unicode_literals)
 
28
 
 
29
from future_builtins import *
 
30
 
 
31
import sys
 
32
import argparse
 
33
import locale
 
34
import datetime
 
35
import re
 
36
import os
 
37
import collections
 
38
import doctest
2
39
 
3
40
import dbus
4
 
from optparse import OptionParser
 
41
 
 
42
locale.setlocale(locale.LC_ALL, "")
5
43
 
6
44
tablewords = {
7
 
    'name': 'Name',
8
 
    'enabled': 'Enabled',
9
 
    'timeout': 'Timeout',
10
 
    'last_checked_ok': 'Last Successful Check',
11
 
    'created': 'Created',
12
 
    'interval': 'Interval',
13
 
    'host': 'Host',
14
 
    'fingerprint': 'Fingerprint',
15
 
    'checker_running': 'Check Is Running',
16
 
    'last_enabled': 'Last Enabled',
17
 
    'checker': 'Checker',
 
45
    "Name": "Name",
 
46
    "Enabled": "Enabled",
 
47
    "Timeout": "Timeout",
 
48
    "LastCheckedOK": "Last Successful Check",
 
49
    "LastApprovalRequest": "Last Approval Request",
 
50
    "Created": "Created",
 
51
    "Interval": "Interval",
 
52
    "Host": "Host",
 
53
    "Fingerprint": "Fingerprint",
 
54
    "CheckerRunning": "Check Is Running",
 
55
    "LastEnabled": "Last Enabled",
 
56
    "ApprovalPending": "Approval Is Pending",
 
57
    "ApprovedByDefault": "Approved By Default",
 
58
    "ApprovalDelay": "Approval Delay",
 
59
    "ApprovalDuration": "Approval Duration",
 
60
    "Checker": "Checker",
 
61
    "ExtendedTimeout" : "Extended Timeout"
18
62
    }
19
 
busname = 'org.mandos-system.Mandos'
20
 
object_path = '/Mandos'
21
 
interface = 'org.mandos_system.Mandos'
22
 
version = "1.0.0"
23
 
defaultkeywords = ('name', 'enabled', 'timeout', 'last_checked_ok', 'checker')
24
 
 
25
 
parser = OptionParser(version = "%%prog %s" % version)
26
 
parser.add_option("-a", "--all", action="store_true", default=False,
27
 
                      help="Print all fields")
28
 
options = parser.parse_args()[0]
29
 
if options.all:
30
 
    keywords = ( 'name', 'enabled', 'timeout', 'last_checked_ok',
31
 
                 'created', 'interval', 'host', 'fingerprint',
32
 
                 'checker_running', 'last_enabled', 'checker' )
33
 
else:
34
 
    keywords = defaultkeywords
35
 
 
36
 
 
37
 
bus = dbus.SystemBus()
38
 
mandos_dbus_objc = bus.get_object(busname, object_path)
39
 
mandos_serv = dbus.Interface(mandos_dbus_objc, dbus_interface = interface)
40
 
mandos_clients = mandos_serv.GetAllClientsWithProperties()
41
 
 
42
 
def valuetostring(x):
43
 
    if type(x) is dbus.Boolean:
44
 
        return "Yes" if x else "No"
45
 
    else:
46
 
        return str(x)
47
 
 
48
 
format_string = ' '.join('%%-%ds'
49
 
                         % max(len(tablewords[key]),
50
 
                               max(len(valuetostring(client[key]))
51
 
                                   for client
52
 
                                   in mandos_clients.itervalues()))
53
 
                         for key in keywords)
54
 
print format_string % tuple(tablewords[key] for key in keywords) 
55
 
for client in mandos_clients.itervalues():
56
 
    print format_string % tuple(valuetostring(client[key]) for key in keywords)
57
 
 
58
 
 
 
63
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
 
64
domain = "se.recompile"
 
65
busname = domain + ".Mandos"
 
66
server_path = "/"
 
67
server_interface = domain + ".Mandos"
 
68
client_interface = domain + ".Mandos.Client"
 
69
version = "1.6.5"
 
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))
 
76
 
 
77
def milliseconds_to_string(ms):
 
78
    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
 
 
86
 
 
87
def rfc3339_duration_to_delta(duration):
 
88
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
89
    
 
90
    >>> rfc3339_duration_to_delta("P7D")
 
91
    datetime.timedelta(7)
 
92
    >>> rfc3339_duration_to_delta("PT60S")
 
93
    datetime.timedelta(0, 60)
 
94
    >>> rfc3339_duration_to_delta("PT60M")
 
95
    datetime.timedelta(0, 3600)
 
96
    >>> rfc3339_duration_to_delta("PT24H")
 
97
    datetime.timedelta(1)
 
98
    >>> rfc3339_duration_to_delta("P1W")
 
99
    datetime.timedelta(7)
 
100
    >>> rfc3339_duration_to_delta("PT5M30S")
 
101
    datetime.timedelta(0, 330)
 
102
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
103
    datetime.timedelta(1, 200)
 
104
    """
 
105
    
 
106
    # Parsing an RFC 3339 duration with regular expressions is not
 
107
    # possible - there would have to be multiple places for the same
 
108
    # values, like seconds.  The current code, while more esoteric, is
 
109
    # cleaner without depending on a parsing library.  If Python had a
 
110
    # built-in library for parsing we would use it, but we'd like to
 
111
    # avoid excessive use of external libraries.
 
112
    
 
113
    # 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
 
123
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
124
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
125
    token_end = Token(re.compile(r"$"), None, frozenset())
 
126
    token_second = Token(re.compile(r"(\d+)S"),
 
127
                         datetime.timedelta(seconds=1),
 
128
                         frozenset((token_end,)))
 
129
    token_minute = Token(re.compile(r"(\d+)M"),
 
130
                         datetime.timedelta(minutes=1),
 
131
                         frozenset((token_second, token_end)))
 
132
    token_hour = Token(re.compile(r"(\d+)H"),
 
133
                       datetime.timedelta(hours=1),
 
134
                       frozenset((token_minute, token_end)))
 
135
    token_time = Token(re.compile(r"T"),
 
136
                       None,
 
137
                       frozenset((token_hour, token_minute,
 
138
                                  token_second)))
 
139
    token_day = Token(re.compile(r"(\d+)D"),
 
140
                      datetime.timedelta(days=1),
 
141
                      frozenset((token_time, token_end)))
 
142
    token_month = Token(re.compile(r"(\d+)M"),
 
143
                        datetime.timedelta(weeks=4),
 
144
                        frozenset((token_day, token_end)))
 
145
    token_year = Token(re.compile(r"(\d+)Y"),
 
146
                       datetime.timedelta(weeks=52),
 
147
                       frozenset((token_month, token_end)))
 
148
    token_week = Token(re.compile(r"(\d+)W"),
 
149
                       datetime.timedelta(weeks=1),
 
150
                       frozenset((token_end,)))
 
151
    token_duration = Token(re.compile(r"P"), None,
 
152
                           frozenset((token_year, token_month,
 
153
                                      token_day, token_time,
 
154
                                      token_week))),
 
155
    # Define starting values
 
156
    value = datetime.timedelta() # Value so far
 
157
    found_token = None
 
158
    followers = frozenset(token_duration,) # Following valid tokens
 
159
    s = duration                # String left to parse
 
160
    # Loop until end token is found
 
161
    while found_token is not token_end:
 
162
        # Search for any currently valid tokens
 
163
        for token in followers:
 
164
            match = token.regexp.match(s)
 
165
            if match is not None:
 
166
                # Token found
 
167
                if token.value is not None:
 
168
                    # Value found, parse digits
 
169
                    factor = int(match.group(1), 10)
 
170
                    # Add to value so far
 
171
                    value += factor * token.value
 
172
                # Strip token from string
 
173
                s = token.regexp.sub("", s, 1)
 
174
                # Go to found token
 
175
                found_token = token
 
176
                # Set valid next tokens
 
177
                followers = found_token.followers
 
178
                break
 
179
        else:
 
180
            # No currently valid tokens were found
 
181
            raise ValueError("Invalid RFC 3339 duration")
 
182
    # End token found
 
183
    return value
 
184
 
 
185
 
 
186
def string_to_delta(interval):
 
187
    """Parse a string and return a datetime.timedelta
 
188
    
 
189
    >>> string_to_delta("7d")
 
190
    datetime.timedelta(7)
 
191
    >>> string_to_delta("60s")
 
192
    datetime.timedelta(0, 60)
 
193
    >>> string_to_delta("60m")
 
194
    datetime.timedelta(0, 3600)
 
195
    >>> string_to_delta("24h")
 
196
    datetime.timedelta(1)
 
197
    >>> string_to_delta("1w")
 
198
    datetime.timedelta(7)
 
199
    >>> string_to_delta("5m 30s")
 
200
    datetime.timedelta(0, 330)
 
201
    """
 
202
    
 
203
    try:
 
204
        return rfc3339_duration_to_delta(interval)
 
205
    except ValueError:
 
206
        pass
 
207
    
 
208
    value = datetime.timedelta(0)
 
209
    regexp = re.compile(r"(\d+)([dsmhw]?)")
 
210
    
 
211
    for num, suffix in regexp.findall(interval):
 
212
        if suffix == "d":
 
213
            value += datetime.timedelta(int(num))
 
214
        elif suffix == "s":
 
215
            value += datetime.timedelta(0, int(num))
 
216
        elif suffix == "m":
 
217
            value += datetime.timedelta(0, 0, 0, 0, int(num))
 
218
        elif suffix == "h":
 
219
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
 
220
        elif suffix == "w":
 
221
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
 
222
        elif suffix == "":
 
223
            value += datetime.timedelta(0, 0, 0, int(num))
 
224
    return value
 
225
 
 
226
def print_clients(clients, keywords):
 
227
    def valuetostring(value, keyword):
 
228
        if type(value) is dbus.Boolean:
 
229
            return "Yes" if value else "No"
 
230
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
 
231
                       "ApprovalDuration", "ExtendedTimeout"):
 
232
            return milliseconds_to_string(value)
 
233
        return unicode(value)
 
234
    
 
235
    # Create format string to print table rows
 
236
    format_string = " ".join("{{{key}:{width}}}".format(
 
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)
 
243
    # Print header line
 
244
    print(format_string.format(**tablewords))
 
245
    for client in clients:
 
246
        print(format_string.format(**dict((key,
 
247
                                           valuetostring(client[key],
 
248
                                                         key))
 
249
                                          for key in keywords)))
 
250
 
 
251
def has_actions(options):
 
252
    return any((options.enable,
 
253
                options.disable,
 
254
                options.bump_timeout,
 
255
                options.start_checker,
 
256
                options.stop_checker,
 
257
                options.is_enabled,
 
258
                options.remove,
 
259
                options.checker is not None,
 
260
                options.timeout is not None,
 
261
                options.extended_timeout is not None,
 
262
                options.interval is not None,
 
263
                options.approved_by_default is not None,
 
264
                options.approval_delay is not None,
 
265
                options.approval_duration is not None,
 
266
                options.host is not None,
 
267
                options.secret is not None,
 
268
                options.approve,
 
269
                options.deny))
 
270
 
 
271
def main():
 
272
    parser = argparse.ArgumentParser()
 
273
    parser.add_argument("--version", action="version",
 
274
                        version = "%(prog)s {0}".format(version),
 
275
                        help="show version number and exit")
 
276
    parser.add_argument("-a", "--all", action="store_true",
 
277
                        help="Select all clients")
 
278
    parser.add_argument("-v", "--verbose", action="store_true",
 
279
                        help="Print all fields")
 
280
    parser.add_argument("-e", "--enable", action="store_true",
 
281
                        help="Enable client")
 
282
    parser.add_argument("-d", "--disable", action="store_true",
 
283
                        help="disable client")
 
284
    parser.add_argument("-b", "--bump-timeout", action="store_true",
 
285
                        help="Bump timeout for client")
 
286
    parser.add_argument("--start-checker", action="store_true",
 
287
                        help="Start checker for client")
 
288
    parser.add_argument("--stop-checker", action="store_true",
 
289
                        help="Stop checker for client")
 
290
    parser.add_argument("-V", "--is-enabled", action="store_true",
 
291
                        help="Check if client is enabled")
 
292
    parser.add_argument("-r", "--remove", action="store_true",
 
293
                        help="Remove client")
 
294
    parser.add_argument("-c", "--checker",
 
295
                        help="Set checker command for client")
 
296
    parser.add_argument("-t", "--timeout",
 
297
                        help="Set timeout for client")
 
298
    parser.add_argument("--extended-timeout",
 
299
                        help="Set extended timeout for client")
 
300
    parser.add_argument("-i", "--interval",
 
301
                        help="Set checker interval for client")
 
302
    parser.add_argument("--approve-by-default", action="store_true",
 
303
                        default=None, dest="approved_by_default",
 
304
                        help="Set client to be approved by default")
 
305
    parser.add_argument("--deny-by-default", action="store_false",
 
306
                        dest="approved_by_default",
 
307
                        help="Set client to be denied by default")
 
308
    parser.add_argument("--approval-delay",
 
309
                        help="Set delay before client approve/deny")
 
310
    parser.add_argument("--approval-duration",
 
311
                        help="Set duration of one client approval")
 
312
    parser.add_argument("-H", "--host", help="Set host for client")
 
313
    parser.add_argument("-s", "--secret", type=file,
 
314
                        help="Set password blob (file) for client")
 
315
    parser.add_argument("-A", "--approve", action="store_true",
 
316
                        help="Approve any current client request")
 
317
    parser.add_argument("-D", "--deny", action="store_true",
 
318
                        help="Deny any current client request")
 
319
    parser.add_argument("--check", action="store_true",
 
320
                        help="Run self-test")
 
321
    parser.add_argument("client", nargs="*", help="Client name")
 
322
    options = parser.parse_args()
 
323
    
 
324
    if has_actions(options) and not (options.client or options.all):
 
325
        parser.error("Options require clients names or --all.")
 
326
    if options.verbose and has_actions(options):
 
327
        parser.error("--verbose can only be used alone or with"
 
328
                     " --all.")
 
329
    if options.all and not has_actions(options):
 
330
        parser.error("--all requires an action.")
 
331
 
 
332
    if options.check:
 
333
        fail_count, test_count = doctest.testmod()
 
334
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
335
    
 
336
    try:
 
337
        bus = dbus.SystemBus()
 
338
        mandos_dbus_objc = bus.get_object(busname, server_path)
 
339
    except dbus.exceptions.DBusException:
 
340
        print("Could not connect to Mandos server",
 
341
              file=sys.stderr)
 
342
        sys.exit(1)
 
343
    
 
344
    mandos_serv = dbus.Interface(mandos_dbus_objc,
 
345
                                 dbus_interface = server_interface)
 
346
    
 
347
    #block stderr since dbus library prints to stderr
 
348
    null = os.open(os.path.devnull, os.O_RDWR)
 
349
    stderrcopy = os.dup(sys.stderr.fileno())
 
350
    os.dup2(null, sys.stderr.fileno())
 
351
    os.close(null)
 
352
    try:
 
353
        try:
 
354
            mandos_clients = mandos_serv.GetAllClientsWithProperties()
 
355
        finally:
 
356
            #restore stderr
 
357
            os.dup2(stderrcopy, sys.stderr.fileno())
 
358
            os.close(stderrcopy)
 
359
    except dbus.exceptions.DBusException:
 
360
        print("Access denied: Accessing mandos server through dbus.",
 
361
              file=sys.stderr)
 
362
        sys.exit(1)
 
363
    
 
364
    # Compile dict of (clients: properties) to process
 
365
    clients={}
 
366
    
 
367
    if options.all or not options.client:
 
368
        clients = dict((bus.get_object(busname, path), properties)
 
369
                       for path, properties in
 
370
                       mandos_clients.iteritems())
 
371
    else:
 
372
        for name in options.client:
 
373
            for path, client in mandos_clients.iteritems():
 
374
                if client["Name"] == name:
 
375
                    client_objc = bus.get_object(busname, path)
 
376
                    clients[client_objc] = client
 
377
                    break
 
378
            else:
 
379
                print("Client not found on server: {0!r}"
 
380
                      .format(name), file=sys.stderr)
 
381
                sys.exit(1)
 
382
    
 
383
    if not has_actions(options) and clients:
 
384
        if options.verbose:
 
385
            keywords = ("Name", "Enabled", "Timeout",
 
386
                        "LastCheckedOK", "Created", "Interval",
 
387
                        "Host", "Fingerprint", "CheckerRunning",
 
388
                        "LastEnabled", "ApprovalPending",
 
389
                        "ApprovedByDefault",
 
390
                        "LastApprovalRequest", "ApprovalDelay",
 
391
                        "ApprovalDuration", "Checker",
 
392
                        "ExtendedTimeout")
 
393
        else:
 
394
            keywords = defaultkeywords
 
395
        
 
396
        print_clients(clients.values(), keywords)
 
397
    else:
 
398
        # Process each client in the list by all selected options
 
399
        for client in clients:
 
400
            def set_client_prop(prop, value):
 
401
                """Set a Client D-Bus property"""
 
402
                client.Set(client_interface, prop, value,
 
403
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
404
            def set_client_prop_ms(prop, value):
 
405
                """Set a Client D-Bus property, converted
 
406
                from a string to milliseconds."""
 
407
                set_client_prop(prop,
 
408
                                timedelta_to_milliseconds
 
409
                                (string_to_delta(value)))
 
410
            if options.remove:
 
411
                mandos_serv.RemoveClient(client.__dbus_object_path__)
 
412
            if options.enable:
 
413
                set_client_prop("Enabled", dbus.Boolean(True))
 
414
            if options.disable:
 
415
                set_client_prop("Enabled", dbus.Boolean(False))
 
416
            if options.bump_timeout:
 
417
                set_client_prop("LastCheckedOK", "")
 
418
            if options.start_checker:
 
419
                set_client_prop("CheckerRunning", dbus.Boolean(True))
 
420
            if options.stop_checker:
 
421
                set_client_prop("CheckerRunning", dbus.Boolean(False))
 
422
            if options.is_enabled:
 
423
                sys.exit(0 if client.Get(client_interface,
 
424
                                         "Enabled",
 
425
                                         dbus_interface=
 
426
                                         dbus.PROPERTIES_IFACE)
 
427
                         else 1)
 
428
            if options.checker is not None:
 
429
                set_client_prop("Checker", options.checker)
 
430
            if options.host is not None:
 
431
                set_client_prop("Host", options.host)
 
432
            if options.interval is not None:
 
433
                set_client_prop_ms("Interval", options.interval)
 
434
            if options.approval_delay is not None:
 
435
                set_client_prop_ms("ApprovalDelay",
 
436
                                   options.approval_delay)
 
437
            if options.approval_duration is not None:
 
438
                set_client_prop_ms("ApprovalDuration",
 
439
                                   options.approval_duration)
 
440
            if options.timeout is not None:
 
441
                set_client_prop_ms("Timeout", options.timeout)
 
442
            if options.extended_timeout is not None:
 
443
                set_client_prop_ms("ExtendedTimeout",
 
444
                                   options.extended_timeout)
 
445
            if options.secret is not None:
 
446
                set_client_prop("Secret",
 
447
                                dbus.ByteArray(options.secret.read()))
 
448
            if options.approved_by_default is not None:
 
449
                set_client_prop("ApprovedByDefault",
 
450
                                dbus.Boolean(options
 
451
                                             .approved_by_default))
 
452
            if options.approve:
 
453
                client.Approve(dbus.Boolean(True),
 
454
                               dbus_interface=client_interface)
 
455
            elif options.deny:
 
456
                client.Approve(dbus.Boolean(False),
 
457
                               dbus_interface=client_interface)
 
458
 
 
459
if __name__ == "__main__":
 
460
    main()