/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
24.1.116 by Björn Påhlsson
added a mandos list client program
1
#!/usr/bin/python
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
2
# -*- mode: python; coding: utf-8 -*-
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
3
#
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
4
# Mandos Monitor - Control and monitor the Mandos server
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
5
#
237.7.471 by Teddy Hogeborn
Update copyright year to 2018
6
# Copyright © 2008-2018 Teddy Hogeborn
7
# Copyright © 2008-2018 Björn Påhlsson
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
8
#
237.7.455 by Teddy Hogeborn
Alter copyright notices slightly. Actual license is unchanged!
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
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
13
# the Free Software Foundation, either version 3 of the License, or
14
# (at your option) any later version.
15
#
237.7.455 by Teddy Hogeborn
Alter copyright notices slightly. Actual license is unchanged!
16
#     Mandos is distributed in the hope that it will be useful, but
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19
#     GNU General Public License for more details.
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
20
#
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
21
# You should have received a copy of the GNU General Public License
237.7.455 by Teddy Hogeborn
Alter copyright notices slightly. Actual license is unchanged!
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
23
#
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
24
# Contact the authors at <mandos@recompile.se>.
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
25
#
24.1.116 by Björn Påhlsson
added a mandos list client program
26
237.8.9 by teddy at bsnet
* mandos-ctl: Use print function.
27
from __future__ import (division, absolute_import, print_function,
28
                        unicode_literals)
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
29
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
30
try:
31
    from future_builtins import *
32
except ImportError:
33
    pass
237.7.127 by Teddy Hogeborn
* mandos: Use all new builtins.
34
24.1.119 by Björn Påhlsson
Added more method support for mandos clients through mandos-ctl
35
import sys
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
36
import argparse
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
37
import locale
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
38
import datetime
39
import re
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
40
import os
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
41
import collections
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
42
import json
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
43
44
import dbus
237.2.3 by Teddy Hogeborn
Merge "mandos-list" from belorn.
45
237.23.7 by Teddy Hogeborn
Use the .major attribute on sys.version_info instead of using "[0]".
46
if sys.version_info.major == 2:
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
47
    str = unicode
48
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
49
locale.setlocale(locale.LC_ALL, "")
24.1.116 by Björn Påhlsson
added a mandos list client program
50
51
tablewords = {
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
52
    "Name": "Name",
53
    "Enabled": "Enabled",
54
    "Timeout": "Timeout",
55
    "LastCheckedOK": "Last Successful Check",
56
    "LastApprovalRequest": "Last Approval Request",
57
    "Created": "Created",
58
    "Interval": "Interval",
59
    "Host": "Host",
60
    "Fingerprint": "Fingerprint",
61
    "CheckerRunning": "Check Is Running",
62
    "LastEnabled": "Last Enabled",
63
    "ApprovalPending": "Approval Is Pending",
64
    "ApprovedByDefault": "Approved By Default",
65
    "ApprovalDelay": "Approval Delay",
66
    "ApprovalDuration": "Approval Duration",
67
    "Checker": "Checker",
237.7.413 by Teddy Hogeborn
mandos-ctl: Include "Expires" and "LastCheckerStatus" properties
68
    "ExtendedTimeout": "Extended Timeout",
69
    "Expires": "Expires",
70
    "LastCheckerStatus": "Last Checker Status",
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
71
}
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
72
defaultkeywords = ("Name", "Enabled", "Timeout", "LastCheckedOK")
24.1.186 by Björn Påhlsson
transitional stuff actually working
73
domain = "se.recompile"
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
74
busname = domain + ".Mandos"
75
server_path = "/"
76
server_interface = domain + ".Mandos"
77
client_interface = domain + ".Mandos.Client"
365 by Teddy Hogeborn
* Makefile (version): Change to 1.7.18.
78
version = "1.7.18"
24.1.118 by Björn Påhlsson
Added enable/disable
79
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
80
237.7.333 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
81
try:
82
    dbus.OBJECT_MANAGER_IFACE
83
except AttributeError:
84
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
85
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
86
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
87
def milliseconds_to_string(ms):
88
    td = datetime.timedelta(0, 0, 0, ms)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
89
    return ("{days}{hours:02}:{minutes:02}:{seconds:02}"
90
            .format(days="{}T".format(td.days) if td.days else "",
91
                    hours=td.seconds // 3600,
92
                    minutes=(td.seconds % 3600) // 60,
93
                    seconds=td.seconds % 60))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
94
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
95
96
def rfc3339_duration_to_delta(duration):
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
97
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
98
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
99
    >>> rfc3339_duration_to_delta("P7D")
100
    datetime.timedelta(7)
101
    >>> rfc3339_duration_to_delta("PT60S")
102
    datetime.timedelta(0, 60)
103
    >>> rfc3339_duration_to_delta("PT60M")
104
    datetime.timedelta(0, 3600)
105
    >>> rfc3339_duration_to_delta("PT24H")
106
    datetime.timedelta(1)
107
    >>> rfc3339_duration_to_delta("P1W")
108
    datetime.timedelta(7)
109
    >>> rfc3339_duration_to_delta("PT5M30S")
110
    datetime.timedelta(0, 330)
111
    >>> rfc3339_duration_to_delta("P1DT3M20S")
112
    datetime.timedelta(1, 200)
113
    """
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
114
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
115
    # Parsing an RFC 3339 duration with regular expressions is not
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
116
    # possible - there would have to be multiple places for the same
237.7.157 by Teddy Hogeborn
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
117
    # values, like seconds.  The current code, while more esoteric, is
118
    # cleaner without depending on a parsing library.  If Python had a
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
119
    # built-in library for parsing we would use it, but we'd like to
120
    # avoid excessive use of external libraries.
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
121
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
122
    # New type for defining tokens, syntax, and semantics all-in-one
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
123
    Token = collections.namedtuple("Token", (
124
        "regexp",  # To match token; if "value" is not None, must have
125
                   # a "group" containing digits
126
        "value",   # datetime.timedelta or None
127
        "followers"))           # Tokens valid after this token
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
128
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
129
    # the "duration" ABNF definition in RFC 3339, Appendix A.
130
    token_end = Token(re.compile(r"$"), None, frozenset())
131
    token_second = Token(re.compile(r"(\d+)S"),
132
                         datetime.timedelta(seconds=1),
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
133
                         frozenset((token_end, )))
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
134
    token_minute = Token(re.compile(r"(\d+)M"),
135
                         datetime.timedelta(minutes=1),
136
                         frozenset((token_second, token_end)))
137
    token_hour = Token(re.compile(r"(\d+)H"),
138
                       datetime.timedelta(hours=1),
139
                       frozenset((token_minute, token_end)))
140
    token_time = Token(re.compile(r"T"),
141
                       None,
142
                       frozenset((token_hour, token_minute,
143
                                  token_second)))
144
    token_day = Token(re.compile(r"(\d+)D"),
145
                      datetime.timedelta(days=1),
146
                      frozenset((token_time, token_end)))
147
    token_month = Token(re.compile(r"(\d+)M"),
148
                        datetime.timedelta(weeks=4),
149
                        frozenset((token_day, token_end)))
150
    token_year = Token(re.compile(r"(\d+)Y"),
151
                       datetime.timedelta(weeks=52),
152
                       frozenset((token_month, token_end)))
153
    token_week = Token(re.compile(r"(\d+)W"),
154
                       datetime.timedelta(weeks=1),
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
155
                       frozenset((token_end, )))
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
156
    token_duration = Token(re.compile(r"P"), None,
157
                           frozenset((token_year, token_month,
158
                                      token_day, token_time,
237.7.269 by Teddy Hogeborn
Fix two mutually cancelling bugs.
159
                                      token_week)))
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
160
    # Define starting values:
161
    # Value so far
162
    value = datetime.timedelta()
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
163
    found_token = None
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
164
    # Following valid tokens
165
    followers = frozenset((token_duration, ))
166
    # String left to parse
167
    s = duration
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
168
    # Loop until end token is found
169
    while found_token is not token_end:
170
        # Search for any currently valid tokens
171
        for token in followers:
172
            match = token.regexp.match(s)
173
            if match is not None:
174
                # Token found
175
                if token.value is not None:
176
                    # Value found, parse digits
177
                    factor = int(match.group(1), 10)
178
                    # Add to value so far
179
                    value += factor * token.value
180
                # Strip token from string
181
                s = token.regexp.sub("", s, 1)
182
                # Go to found token
183
                found_token = token
184
                # Set valid next tokens
185
                followers = found_token.followers
186
                break
187
        else:
188
            # No currently valid tokens were found
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
189
            raise ValueError("Invalid RFC 3339 duration: {!r}"
190
                             .format(duration))
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
191
    # End token found
192
    return value
193
194
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
195
def string_to_delta(interval):
196
    """Parse a string and return a datetime.timedelta
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
197
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
198
    >>> string_to_delta('7d')
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
199
    datetime.timedelta(7)
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
200
    >>> string_to_delta('60s')
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
201
    datetime.timedelta(0, 60)
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
202
    >>> string_to_delta('60m')
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
203
    datetime.timedelta(0, 3600)
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
204
    >>> string_to_delta('24h')
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
205
    datetime.timedelta(1)
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
206
    >>> string_to_delta('1w')
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
207
    datetime.timedelta(7)
237.7.301 by Teddy Hogeborn
mandos-ctl: Generate better messages in exceptions.
208
    >>> string_to_delta('5m 30s')
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
209
    datetime.timedelta(0, 330)
210
    """
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
211
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
212
    try:
213
        return rfc3339_duration_to_delta(interval)
214
    except ValueError:
215
        pass
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
216
237.7.164 by Teddy Hogeborn
* mandos-ctl (string_to_delta): Try to parse RFC 3339 duration before
217
    value = datetime.timedelta(0)
218
    regexp = re.compile(r"(\d+)([dsmhw]?)")
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
219
237.14.9 by Teddy Hogeborn
* mandos (ClientDBus.approval_delay, ClientDBus.approval_duration,
220
    for num, suffix in regexp.findall(interval):
221
        if suffix == "d":
222
            value += datetime.timedelta(int(num))
223
        elif suffix == "s":
224
            value += datetime.timedelta(0, int(num))
225
        elif suffix == "m":
226
            value += datetime.timedelta(0, 0, 0, 0, int(num))
227
        elif suffix == "h":
228
            value += datetime.timedelta(0, 0, 0, 0, 0, int(num))
229
        elif suffix == "w":
230
            value += datetime.timedelta(0, 0, 0, 0, 0, 0, int(num))
231
        elif suffix == "":
232
            value += datetime.timedelta(0, 0, 0, int(num))
233
    return value
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
234
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
235
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
236
def print_clients(clients, keywords):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
237
    def valuetostring(value, keyword):
238
        if type(value) is dbus.Boolean:
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
239
            return "Yes" if value else "No"
240
        if keyword in ("Timeout", "Interval", "ApprovalDelay",
237.7.119 by Teddy Hogeborn
* mandos-ctl (print_clients): Bug fix: Don't show "Extended Timeout"
241
                       "ApprovalDuration", "ExtendedTimeout"):
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
242
            return milliseconds_to_string(value)
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
243
        return str(value)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
244
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
245
    # Create format string to print table rows
237.7.117 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
246
    format_string = " ".join("{{{key}:{width}}}".format(
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
247
        width=max(len(tablewords[key]),
248
                  max(len(valuetostring(client[key], key))
249
                      for client in clients)),
250
        key=key)
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
251
                             for key in keywords)
237.2.145 by Teddy Hogeborn
* mandos-ctl: Made work again after D-Bus API changes.
252
    # Print header line
237.7.117 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
253
    print(format_string.format(**tablewords))
24.1.121 by Björn Påhlsson
mandos-ctl: Added support for all client calls
254
    for client in clients:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
255
        print(format_string
256
              .format(**{key: valuetostring(client[key], key)
257
                         for key in keywords}))
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
258
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
259
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
260
def has_actions(options):
261
    return any((options.enable,
262
                options.disable,
263
                options.bump_timeout,
264
                options.start_checker,
265
                options.stop_checker,
266
                options.is_enabled,
267
                options.remove,
268
                options.checker is not None,
269
                options.timeout is not None,
24.1.179 by Björn Påhlsson
New feature:
270
                options.extended_timeout is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
271
                options.interval is not None,
237.2.204 by Teddy Hogeborn
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
272
                options.approved_by_default is not None,
273
                options.approval_delay is not None,
274
                options.approval_duration is not None,
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
275
                options.host is not None,
276
                options.secret is not None,
277
                options.approve,
278
                options.deny))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
279
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
280
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
281
def main():
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
282
    parser = argparse.ArgumentParser()
283
    parser.add_argument("--version", action="version",
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
284
                        version="%(prog)s {}".format(version),
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
285
                        help="show version number and exit")
286
    parser.add_argument("-a", "--all", action="store_true",
287
                        help="Select all clients")
288
    parser.add_argument("-v", "--verbose", action="store_true",
289
                        help="Print all fields")
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
290
    parser.add_argument("-j", "--dump-json", action="store_true",
291
                        help="Dump client data in JSON format")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
292
    parser.add_argument("-e", "--enable", action="store_true",
293
                        help="Enable client")
294
    parser.add_argument("-d", "--disable", action="store_true",
295
                        help="disable client")
296
    parser.add_argument("-b", "--bump-timeout", action="store_true",
297
                        help="Bump timeout for client")
298
    parser.add_argument("--start-checker", action="store_true",
299
                        help="Start checker for client")
300
    parser.add_argument("--stop-checker", action="store_true",
301
                        help="Stop checker for client")
302
    parser.add_argument("-V", "--is-enabled", action="store_true",
303
                        help="Check if client is enabled")
304
    parser.add_argument("-r", "--remove", action="store_true",
305
                        help="Remove client")
306
    parser.add_argument("-c", "--checker",
307
                        help="Set checker command for client")
308
    parser.add_argument("-t", "--timeout",
309
                        help="Set timeout for client")
24.1.179 by Björn Påhlsson
New feature:
310
    parser.add_argument("--extended-timeout",
311
                        help="Set extended timeout for client")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
312
    parser.add_argument("-i", "--interval",
313
                        help="Set checker interval for client")
314
    parser.add_argument("--approve-by-default", action="store_true",
315
                        default=None, dest="approved_by_default",
316
                        help="Set client to be approved by default")
317
    parser.add_argument("--deny-by-default", action="store_false",
318
                        dest="approved_by_default",
319
                        help="Set client to be denied by default")
320
    parser.add_argument("--approval-delay",
321
                        help="Set delay before client approve/deny")
322
    parser.add_argument("--approval-duration",
323
                        help="Set duration of one client approval")
324
    parser.add_argument("-H", "--host", help="Set host for client")
237.7.266 by Teddy Hogeborn
mandos-ctl: Make it work in Python 3.
325
    parser.add_argument("-s", "--secret",
326
                        type=argparse.FileType(mode="rb"),
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
327
                        help="Set password blob (file) for client")
328
    parser.add_argument("-A", "--approve", action="store_true",
329
                        help="Approve any current client request")
330
    parser.add_argument("-D", "--deny", action="store_true",
331
                        help="Deny any current client request")
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
332
    parser.add_argument("--check", action="store_true",
333
                        help="Run self-test")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
334
    parser.add_argument("client", nargs="*", help="Client name")
335
    options = parser.parse_args()
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
336
237.7.120 by Teddy Hogeborn
* mandos-ctl: Break long lines.
337
    if has_actions(options) and not (options.client or options.all):
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
338
        parser.error("Options require clients names or --all.")
339
    if options.verbose and has_actions(options):
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
340
        parser.error("--verbose can only be used alone.")
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
341
    if options.dump_json and (options.verbose
342
                              or has_actions(options)):
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
343
        parser.error("--dump-json can only be used alone.")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
344
    if options.all and not has_actions(options):
345
        parser.error("--all requires an action.")
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
346
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
347
    if options.check:
237.7.450 by Teddy Hogeborn
Don't import doctest module in mandos-ctl unless running tests.
348
        import doctest
237.7.156 by Teddy Hogeborn
* Makefile (check): Also check mandos-ctl.
349
        fail_count, test_count = doctest.testmod()
237.7.202 by Teddy Hogeborn
Fix running of self-tests.
350
        sys.exit(os.EX_OK if fail_count == 0 else 1)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
351
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
352
    try:
353
        bus = dbus.SystemBus()
354
        mandos_dbus_objc = bus.get_object(busname, server_path)
355
    except dbus.exceptions.DBusException:
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
356
        print("Could not connect to Mandos server", file=sys.stderr)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
357
        sys.exit(1)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
358
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
359
    mandos_serv = dbus.Interface(mandos_dbus_objc,
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
360
                                 dbus_interface=server_interface)
237.7.333 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
361
    mandos_serv_object_manager = dbus.Interface(
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
362
        mandos_dbus_objc, dbus_interface=dbus.OBJECT_MANAGER_IFACE)
363
364
    # block stderr since dbus library prints to stderr
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
365
    null = os.open(os.path.devnull, os.O_RDWR)
366
    stderrcopy = os.dup(sys.stderr.fileno())
367
    os.dup2(null, sys.stderr.fileno())
368
    os.close(null)
369
    try:
370
        try:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
371
            mandos_clients = {path: ifs_and_props[client_interface]
372
                              for path, ifs_and_props in
373
                              mandos_serv_object_manager
374
                              .GetManagedObjects().items()
375
                              if client_interface in ifs_and_props}
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
376
        finally:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
377
            # restore stderr
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
378
            os.dup2(stderrcopy, sys.stderr.fileno())
379
            os.close(stderrcopy)
237.7.333 by Teddy Hogeborn
Support the standard org.freedesktop.DBus.ObjectManager interface.
380
    except dbus.exceptions.DBusException as e:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
381
        print("Access denied: "
382
              "Accessing mandos server through D-Bus: {}".format(e),
383
              file=sys.stderr)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
384
        sys.exit(1)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
385
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
386
    # Compile dict of (clients: properties) to process
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
387
    clients = {}
388
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
389
    if options.all or not options.client:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
390
        clients = {bus.get_object(busname, path): properties
391
                   for path, properties in mandos_clients.items()}
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
392
    else:
393
        for name in options.client:
237.23.4 by Teddy Hogeborn
Use the .items() method instead of .iteritems().
394
            for path, client in mandos_clients.items():
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
395
                if client["Name"] == name:
396
                    client_objc = bus.get_object(busname, path)
397
                    clients[client_objc] = client
398
                    break
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
399
            else:
237.23.5 by Teddy Hogeborn
Use the new auto-numbered "{}" syntax for the .format() string method.
400
                print("Client not found on server: {!r}"
237.7.117 by Teddy Hogeborn
* mandos-ctl: Use new string format method. Bug fix: --version now
401
                      .format(name), file=sys.stderr)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
402
                sys.exit(1)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
403
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
404
    if not has_actions(options) and clients:
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
405
        if options.verbose or options.dump_json:
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
406
            keywords = ("Name", "Enabled", "Timeout", "LastCheckedOK",
407
                        "Created", "Interval", "Host", "Fingerprint",
408
                        "CheckerRunning", "LastEnabled",
409
                        "ApprovalPending", "ApprovedByDefault",
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
410
                        "LastApprovalRequest", "ApprovalDelay",
24.1.179 by Björn Påhlsson
New feature:
411
                        "ApprovalDuration", "Checker",
237.7.413 by Teddy Hogeborn
mandos-ctl: Include "Expires" and "LastCheckerStatus" properties
412
                        "ExtendedTimeout", "Expires",
413
                        "LastCheckerStatus")
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
414
        else:
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
415
            keywords = defaultkeywords
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
416
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
417
        if options.dump_json:
237.7.412 by Teddy Hogeborn
mandos-ctl: Dump booleans as booleans in --dump-json output.
418
            json.dump({client["Name"]: {key:
419
                                        bool(client[key])
420
                                        if isinstance(client[key],
421
                                                      dbus.Boolean)
422
                                        else client[key]
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
423
                                        for key in keywords}
424
                       for client in clients.values()},
425
                      fp=sys.stdout, indent=4,
426
                      separators=(',', ': '))
237.7.411 by Teddy Hogeborn
mandos-ctl: Implement --dump-json option
427
            print()
428
        else:
429
            print_clients(clients.values(), keywords)
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
430
    else:
431
        # Process each client in the list by all selected options
432
        for client in clients:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
433
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
434
            def set_client_prop(prop, value):
435
                """Set a Client D-Bus property"""
436
                client.Set(client_interface, prop, value,
437
                           dbus_interface=dbus.PROPERTIES_IFACE)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
438
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
439
            def set_client_prop_ms(prop, value):
440
                """Set a Client D-Bus property, converted
441
                from a string to milliseconds."""
442
                set_client_prop(prop,
237.23.6 by Teddy Hogeborn
Use the new .total_seconds() method on datetime.timedelta objects.
443
                                string_to_delta(value).total_seconds()
444
                                * 1000)
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
445
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
446
            if options.remove:
447
                mandos_serv.RemoveClient(client.__dbus_object_path__)
448
            if options.enable:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
449
                set_client_prop("Enabled", dbus.Boolean(True))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
450
            if options.disable:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
451
                set_client_prop("Enabled", dbus.Boolean(False))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
452
            if options.bump_timeout:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
453
                set_client_prop("LastCheckedOK", "")
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
454
            if options.start_checker:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
455
                set_client_prop("CheckerRunning", dbus.Boolean(True))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
456
            if options.stop_checker:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
457
                set_client_prop("CheckerRunning", dbus.Boolean(False))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
458
            if options.is_enabled:
237.7.420 by Teddy Hogeborn
PEP8 compliance: mandos-ctl
459
                if client.Get(client_interface, "Enabled",
460
                              dbus_interface=dbus.PROPERTIES_IFACE):
461
                    sys.exit(0)
462
                else:
463
                    sys.exit(1)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
464
            if options.checker is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
465
                set_client_prop("Checker", options.checker)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
466
            if options.host is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
467
                set_client_prop("Host", options.host)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
468
            if options.interval is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
469
                set_client_prop_ms("Interval", options.interval)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
470
            if options.approval_delay is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
471
                set_client_prop_ms("ApprovalDelay",
472
                                   options.approval_delay)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
473
            if options.approval_duration is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
474
                set_client_prop_ms("ApprovalDuration",
475
                                   options.approval_duration)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
476
            if options.timeout is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
477
                set_client_prop_ms("Timeout", options.timeout)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
478
            if options.extended_timeout is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
479
                set_client_prop_ms("ExtendedTimeout",
480
                                   options.extended_timeout)
237.11.16 by Teddy Hogeborn
* mandos-ctl (main): Bug fix: Handle empty strings correctly.
481
            if options.secret is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
482
                set_client_prop("Secret",
483
                                dbus.ByteArray(options.secret.read()))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
484
            if options.approved_by_default is not None:
237.20.2 by Teddy Hogeborn
* mandos-ctl (main): Use helper functions to shorten code.
485
                set_client_prop("ApprovedByDefault",
486
                                dbus.Boolean(options
487
                                             .approved_by_default))
237.7.23 by teddy at bsnet
* mandos-ctl: Use the new argparse library instead of optparse.
488
            if options.approve:
489
                client.Approve(dbus.Boolean(True),
490
                               dbus_interface=client_interface)
491
            elif options.deny:
492
                client.Approve(dbus.Boolean(False),
493
                               dbus_interface=client_interface)
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
494
237.7.293 by Teddy Hogeborn
mandos-ctl: Do minor formatting and whitespace adjustments.
495
237.8.8 by teddy at bsnet
* mandos-ctl: Use unicode string literals.
496
if __name__ == "__main__":
24.1.163 by Björn Påhlsson
mandos-client: Added never ending loop for --connect
497
    main()