/mandos/trunk

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