/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2019-03-31 04:39:25 UTC
  • Revision ID: teddy@recompile.se-20190331043925-0j9pdspo3hux5nka
mandos-ctl: Refactor: Move command list generation into argparse

* mandos-ctl (add_command_line_options): Don't simply set flags for
                                         each option; instead, add
                                         command objects to a
                                         "commands" list.
  (check_option_syntax): Rework to deal with an already-generated
                         command list.
  (commands_from_options): Remove all code to generate command list,
                           but add more code to move command.Deny
                           ahead of command.Remove in command list.
  (command.PropertySetterValue.argparse): New; used in
                                          add_command_line_options.
  (Test_check_option_syntax): Refactor to pass actual string arguments
                              to parse_args() instead of modifying an
                              argparse.Namespace.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
 
3
#
 
4
# Mandos Monitor - Control and monitor the Mandos server
 
5
#
 
6
# Copyright © 2009-2019 Teddy Hogeborn
 
7
# Copyright © 2009-2019 Björn Påhlsson
 
8
#
 
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
 
13
# the Free Software Foundation, either version 3 of the License, or
 
14
# (at your option) any later version.
 
15
#
 
16
#     Mandos is distributed in the hope that it will be useful, but
 
17
#     WITHOUT ANY WARRANTY; without even the implied warranty of
 
18
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
19
#     GNU General Public License for more details.
 
20
#
 
21
# You should have received a copy of the GNU General Public License
 
22
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
23
#
 
24
# Contact the authors at <mandos@recompile.se>.
 
25
#
3
26
 
4
 
from __future__ import division, absolute_import, with_statement
 
27
from __future__ import (division, absolute_import, print_function,
 
28
                        unicode_literals)
 
29
try:
 
30
    from future_builtins import *
 
31
except ImportError:
 
32
    pass
5
33
 
6
34
import sys
7
 
import signal
 
35
import os
 
36
 
 
37
import datetime
8
38
 
9
39
import urwid.curses_display
10
40
import urwid
11
41
 
12
42
from dbus.mainloop.glib import DBusGMainLoop
13
 
import gobject
 
43
from gi.repository import GLib
14
44
 
15
45
import dbus
16
46
 
17
 
import UserList
 
47
import locale
 
48
 
 
49
import logging
 
50
 
 
51
if sys.version_info.major == 2:
 
52
    str = unicode
 
53
 
 
54
locale.setlocale(locale.LC_ALL, '')
 
55
 
 
56
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
18
57
 
19
58
# Some useful constants
20
 
domain = 'se.bsnet.fukt'
 
59
domain = 'se.recompile'
21
60
server_interface = domain + '.Mandos'
22
61
client_interface = domain + '.Mandos.Client'
23
 
version = "1.0.14"
24
 
 
25
 
# Always run in monochrome mode
26
 
urwid.curses_display.curses.has_colors = lambda : False
27
 
 
28
 
# Urwid doesn't support blinking, but we want it.  Since we have no
29
 
# use for underline on its own, we make underline also always blink.
30
 
urwid.curses_display.curses.A_UNDERLINE |= (
31
 
    urwid.curses_display.curses.A_BLINK)
 
62
version = "1.8.3"
 
63
 
 
64
try:
 
65
    dbus.OBJECT_MANAGER_IFACE
 
66
except AttributeError:
 
67
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
68
 
 
69
 
 
70
def isoformat_to_datetime(iso):
 
71
    "Parse an ISO 8601 date string to a datetime.datetime()"
 
72
    if not iso:
 
73
        return None
 
74
    d, t = iso.split("T", 1)
 
75
    year, month, day = d.split("-", 2)
 
76
    hour, minute, second = t.split(":", 2)
 
77
    second, fraction = divmod(float(second), 1)
 
78
    return datetime.datetime(int(year),
 
79
                             int(month),
 
80
                             int(day),
 
81
                             int(hour),
 
82
                             int(minute),
 
83
                             int(second),            # Whole seconds
 
84
                             int(fraction*1000000))  # Microseconds
 
85
 
32
86
 
33
87
class MandosClientPropertyCache(object):
34
88
    """This wraps a Mandos Client D-Bus proxy object, caches the
35
89
    properties and calls a hook function when any of them are
36
90
    changed.
37
91
    """
38
 
    def __init__(self, proxy_object=None, properties=None, *args,
39
 
                 **kwargs):
40
 
        # Type conversion mapping
41
 
        self.type_map = {
42
 
            dbus.ObjectPath: unicode,
43
 
            dbus.ByteArray: str,
44
 
            dbus.Signature: unicode,
45
 
            dbus.Byte: chr,
46
 
            dbus.Int16: int,
47
 
            dbus.UInt16: int,
48
 
            dbus.Int32: int,
49
 
            dbus.UInt32: int,
50
 
            dbus.Int64: int,
51
 
            dbus.UInt64: int,
52
 
            dbus.Dictionary: dict,
53
 
            dbus.Array: list,
54
 
            dbus.String: unicode,
55
 
            dbus.Boolean: bool,
56
 
            dbus.Double: float,
57
 
            dbus.Struct: tuple,
58
 
            }
59
 
        self.proxy = proxy_object # Mandos Client proxy object
60
 
        
61
 
        if properties is None:
62
 
            self.properties = dict()
63
 
        else:
64
 
            self.properties = dict(self.convert_property(prop, val)
65
 
                                   for prop, val in
66
 
                                   properties.iteritems())
67
 
        self.proxy.connect_to_signal("PropertyChanged",
68
 
                                     self.property_changed,
69
 
                                     client_interface,
70
 
                                     byte_arrays=True)
71
 
        
72
 
        if properties is None:
73
 
            self.properties.update(
74
 
                self.convert_property(prop, val)
75
 
                for prop, val in
76
 
                self.proxy.GetAll(client_interface,
77
 
                                  dbus_interface =
78
 
                                  dbus.PROPERTIES_IFACE).iteritems())
79
 
        super(MandosClientPropertyCache, self).__init__(
80
 
            proxy_object=proxy_object,
81
 
            properties=properties, *args, **kwargs)
82
 
    
83
 
    def convert_property(self, property, value):
84
 
        """This converts the arguments from a D-Bus signal, which are
85
 
        D-Bus types, into normal Python types, using a conversion
86
 
        function from "self.type_map".
87
 
        """
88
 
        property_name = unicode(property) # Always a dbus.String
89
 
        if isinstance(value, dbus.UTF8String):
90
 
            # Should not happen, but prepare for it anyway
91
 
            value = dbus.String(str(value).decode("utf-8"))
92
 
        try:
93
 
            convfunc = self.type_map[type(value)]
94
 
        except KeyError:
95
 
            # Unknown type, return unmodified
96
 
            return property_name, value
97
 
        return property_name, convfunc(value)
98
 
    def property_changed(self, property=None, value=None):
99
 
        """This is called whenever we get a PropertyChanged signal
100
 
        It updates the changed property in the "properties" dict.
101
 
        """
102
 
        # Convert name and value
103
 
        property_name, cvalue = self.convert_property(property, value)
 
92
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
93
        self.proxy = proxy_object  # Mandos Client proxy object
 
94
        self.properties = dict() if properties is None else properties
 
95
        self.property_changed_match = (
 
96
            self.proxy.connect_to_signal("PropertiesChanged",
 
97
                                         self.properties_changed,
 
98
                                         dbus.PROPERTIES_IFACE,
 
99
                                         byte_arrays=True))
 
100
 
 
101
        if properties is None:
 
102
            self.properties.update(self.proxy.GetAll(
 
103
                client_interface,
 
104
                dbus_interface=dbus.PROPERTIES_IFACE))
 
105
 
 
106
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
107
 
 
108
    def properties_changed(self, interface, properties, invalidated):
 
109
        """This is called whenever we get a PropertiesChanged signal
 
110
        It updates the changed properties in the "properties" dict.
 
111
        """
104
112
        # Update properties dict with new value
105
 
        self.properties[property_name] = cvalue
 
113
        if interface == client_interface:
 
114
            self.properties.update(properties)
 
115
 
 
116
    def delete(self):
 
117
        self.property_changed_match.remove()
106
118
 
107
119
 
108
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
109
121
    """A Mandos Client which is visible on the screen.
110
122
    """
111
 
    
 
123
 
112
124
    def __init__(self, server_proxy_object=None, update_hook=None,
113
 
                 delete_hook=None, *args, **kwargs):
 
125
                 delete_hook=None, logger=None, **kwargs):
114
126
        # Called on update
115
127
        self.update_hook = update_hook
116
128
        # Called on delete
117
129
        self.delete_hook = delete_hook
118
130
        # Mandos Server proxy object
119
131
        self.server_proxy_object = server_proxy_object
120
 
        
 
132
        # Logger
 
133
        self.logger = logger
 
134
 
 
135
        self._update_timer_callback_tag = None
 
136
 
121
137
        # The widget shown normally
122
138
        self._text_widget = urwid.Text("")
123
139
        # The widget shown when we have focus
124
140
        self._focus_text_widget = urwid.Text("")
125
 
        super(MandosClientWidget, self).__init__(
126
 
            update_hook=update_hook, delete_hook=delete_hook,
127
 
            *args, **kwargs)
 
141
        super(MandosClientWidget, self).__init__(**kwargs)
128
142
        self.update()
129
143
        self.opened = False
130
 
    
 
144
 
 
145
        self.match_objects = (
 
146
            self.proxy.connect_to_signal("CheckerCompleted",
 
147
                                         self.checker_completed,
 
148
                                         client_interface,
 
149
                                         byte_arrays=True),
 
150
            self.proxy.connect_to_signal("CheckerStarted",
 
151
                                         self.checker_started,
 
152
                                         client_interface,
 
153
                                         byte_arrays=True),
 
154
            self.proxy.connect_to_signal("GotSecret",
 
155
                                         self.got_secret,
 
156
                                         client_interface,
 
157
                                         byte_arrays=True),
 
158
            self.proxy.connect_to_signal("NeedApproval",
 
159
                                         self.need_approval,
 
160
                                         client_interface,
 
161
                                         byte_arrays=True),
 
162
            self.proxy.connect_to_signal("Rejected",
 
163
                                         self.rejected,
 
164
                                         client_interface,
 
165
                                         byte_arrays=True))
 
166
        self.logger('Created client {}'
 
167
                    .format(self.properties["Name"]), level=0)
 
168
 
 
169
    def using_timer(self, flag):
 
170
        """Call this method with True or False when timer should be
 
171
        activated or deactivated.
 
172
        """
 
173
        if flag and self._update_timer_callback_tag is None:
 
174
            # Will update the shown timer value every second
 
175
            self._update_timer_callback_tag = (GLib.timeout_add
 
176
                                               (1000,
 
177
                                                self.update_timer))
 
178
        elif not (flag or self._update_timer_callback_tag is None):
 
179
            GLib.source_remove(self._update_timer_callback_tag)
 
180
            self._update_timer_callback_tag = None
 
181
 
 
182
    def checker_completed(self, exitstatus, condition, command):
 
183
        if exitstatus == 0:
 
184
            self.logger('Checker for client {} (command "{}")'
 
185
                        ' succeeded'.format(self.properties["Name"],
 
186
                                            command), level=0)
 
187
            self.update()
 
188
            return
 
189
        # Checker failed
 
190
        if os.WIFEXITED(condition):
 
191
            self.logger('Checker for client {} (command "{}") failed'
 
192
                        ' with exit code {}'
 
193
                        .format(self.properties["Name"], command,
 
194
                                os.WEXITSTATUS(condition)))
 
195
        elif os.WIFSIGNALED(condition):
 
196
            self.logger('Checker for client {} (command "{}") was'
 
197
                        ' killed by signal {}'
 
198
                        .format(self.properties["Name"], command,
 
199
                                os.WTERMSIG(condition)))
 
200
        self.update()
 
201
 
 
202
    def checker_started(self, command):
 
203
        """Server signals that a checker started."""
 
204
        self.logger('Client {} started checker "{}"'
 
205
                    .format(self.properties["Name"],
 
206
                            command), level=0)
 
207
 
 
208
    def got_secret(self):
 
209
        self.logger('Client {} received its secret'
 
210
                    .format(self.properties["Name"]))
 
211
 
 
212
    def need_approval(self, timeout, default):
 
213
        if not default:
 
214
            message = 'Client {} needs approval within {} seconds'
 
215
        else:
 
216
            message = 'Client {} will get its secret in {} seconds'
 
217
        self.logger(message.format(self.properties["Name"],
 
218
                                   timeout/1000))
 
219
 
 
220
    def rejected(self, reason):
 
221
        self.logger('Client {} was rejected; reason: {}'
 
222
                    .format(self.properties["Name"], reason))
 
223
 
131
224
    def selectable(self):
132
225
        """Make this a "selectable" widget.
133
226
        This overrides the method from urwid.FlowWidget."""
134
227
        return True
135
 
    
136
 
    def rows(self, (maxcol,), focus=False):
 
228
 
 
229
    def rows(self, maxcolrow, focus=False):
137
230
        """How many rows this widget will occupy might depend on
138
231
        whether we have focus or not.
139
232
        This overrides the method from urwid.FlowWidget"""
140
 
        return self.current_widget(focus).rows((maxcol,), focus=focus)
141
 
    
 
233
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
234
 
142
235
    def current_widget(self, focus=False):
143
236
        if focus or self.opened:
144
237
            return self._focus_widget
145
238
        return self._widget
146
 
    
 
239
 
147
240
    def update(self):
148
241
        "Called when what is visible on the screen should be updated."
149
242
        # How to add standout mode to a style
150
 
        with_standout = { u"normal": u"standout",
151
 
                          u"bold": u"bold-standout",
152
 
                          u"underline-blink":
153
 
                              u"underline-blink-standout",
154
 
                          u"bold-underline-blink":
155
 
                              u"bold-underline-blink-standout",
156
 
                          }
157
 
        
 
243
        with_standout = {"normal": "standout",
 
244
                         "bold": "bold-standout",
 
245
                         "underline-blink":
 
246
                         "underline-blink-standout",
 
247
                         "bold-underline-blink":
 
248
                         "bold-underline-blink-standout",
 
249
                         }
 
250
 
158
251
        # Rebuild focus and non-focus widgets using current properties
159
 
        self._text = (u'name="%(name)s", enabled=%(enabled)s'
160
 
                      % self.properties)
 
252
 
 
253
        # Base part of a client. Name!
 
254
        base = '{name}: '.format(name=self.properties["Name"])
 
255
        if not self.properties["Enabled"]:
 
256
            message = "DISABLED"
 
257
            self.using_timer(False)
 
258
        elif self.properties["ApprovalPending"]:
 
259
            timeout = datetime.timedelta(
 
260
                milliseconds=self.properties["ApprovalDelay"])
 
261
            last_approval_request = isoformat_to_datetime(
 
262
                self.properties["LastApprovalRequest"])
 
263
            if last_approval_request is not None:
 
264
                timer = max(timeout - (datetime.datetime.utcnow()
 
265
                                       - last_approval_request),
 
266
                            datetime.timedelta())
 
267
            else:
 
268
                timer = datetime.timedelta()
 
269
            if self.properties["ApprovedByDefault"]:
 
270
                message = "Approval in {}. (d)eny?"
 
271
            else:
 
272
                message = "Denial in {}. (a)pprove?"
 
273
            message = message.format(str(timer).rsplit(".", 1)[0])
 
274
            self.using_timer(True)
 
275
        elif self.properties["LastCheckerStatus"] != 0:
 
276
            # When checker has failed, show timer until client expires
 
277
            expires = self.properties["Expires"]
 
278
            if expires == "":
 
279
                timer = datetime.timedelta(0)
 
280
            else:
 
281
                expires = (datetime.datetime.strptime
 
282
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
283
                timer = max(expires - datetime.datetime.utcnow(),
 
284
                            datetime.timedelta())
 
285
            message = ('A checker has failed! Time until client'
 
286
                       ' gets disabled: {}'
 
287
                       .format(str(timer).rsplit(".", 1)[0]))
 
288
            self.using_timer(True)
 
289
        else:
 
290
            message = "enabled"
 
291
            self.using_timer(False)
 
292
        self._text = "{}{}".format(base, message)
 
293
 
161
294
        if not urwid.supports_unicode():
162
295
            self._text = self._text.encode("ascii", "replace")
163
 
        textlist = [(u"normal", u"BLÄRGH: "), (u"bold", self._text)]
 
296
        textlist = [("normal", self._text)]
164
297
        self._text_widget.set_text(textlist)
165
298
        self._focus_text_widget.set_text([(with_standout[text[0]],
166
299
                                           text[1])
173
306
        # Run update hook, if any
174
307
        if self.update_hook is not None:
175
308
            self.update_hook()
176
 
    
177
 
    def delete(self):
 
309
 
 
310
    def update_timer(self):
 
311
        """called by GLib. Will indefinitely loop until
 
312
        GLib.source_remove() on tag is called
 
313
        """
 
314
        self.update()
 
315
        return True             # Keep calling this
 
316
 
 
317
    def delete(self, **kwargs):
 
318
        if self._update_timer_callback_tag is not None:
 
319
            GLib.source_remove(self._update_timer_callback_tag)
 
320
            self._update_timer_callback_tag = None
 
321
        for match in self.match_objects:
 
322
            match.remove()
 
323
        self.match_objects = ()
178
324
        if self.delete_hook is not None:
179
325
            self.delete_hook(self)
180
 
    
181
 
    def render(self, (maxcol,), focus=False):
 
326
        return super(MandosClientWidget, self).delete(**kwargs)
 
327
 
 
328
    def render(self, maxcolrow, focus=False):
182
329
        """Render differently if we have focus.
183
330
        This overrides the method from urwid.FlowWidget"""
184
 
        return self.current_widget(focus).render((maxcol,),
 
331
        return self.current_widget(focus).render(maxcolrow,
185
332
                                                 focus=focus)
186
 
    
187
 
    def keypress(self, (maxcol,), key):
 
333
 
 
334
    def keypress(self, maxcolrow, key):
188
335
        """Handle keys.
189
336
        This overrides the method from urwid.FlowWidget"""
190
 
        if key == u"e" or key == u"+":
191
 
            self.proxy.Enable()
192
 
        elif key == u"d" or key == u"-":
193
 
            self.proxy.Disable()
194
 
        elif key == u"r" or key == u"_":
 
337
        if key == "+":
 
338
            self.proxy.Set(client_interface, "Enabled",
 
339
                           dbus.Boolean(True), ignore_reply=True,
 
340
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
341
        elif key == "-":
 
342
            self.proxy.Set(client_interface, "Enabled", False,
 
343
                           ignore_reply=True,
 
344
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
345
        elif key == "a":
 
346
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
 
347
                               dbus_interface=client_interface,
 
348
                               ignore_reply=True)
 
349
        elif key == "d":
 
350
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
 
351
                               dbus_interface=client_interface,
 
352
                               ignore_reply=True)
 
353
        elif key == "R" or key == "_" or key == "ctrl k":
195
354
            self.server_proxy_object.RemoveClient(self.proxy
196
 
                                                  .object_path)
197
 
        elif key == u"s":
198
 
            self.proxy.StartChecker()
199
 
        elif key == u"c":
200
 
            self.proxy.StopChecker()
201
 
        elif key == u"S":
202
 
            self.proxy.CheckedOK()
 
355
                                                  .object_path,
 
356
                                                  ignore_reply=True)
 
357
        elif key == "s":
 
358
            self.proxy.Set(client_interface, "CheckerRunning",
 
359
                           dbus.Boolean(True), ignore_reply=True,
 
360
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
361
        elif key == "S":
 
362
            self.proxy.Set(client_interface, "CheckerRunning",
 
363
                           dbus.Boolean(False), ignore_reply=True,
 
364
                           dbus_interface=dbus.PROPERTIES_IFACE)
 
365
        elif key == "C":
 
366
            self.proxy.CheckedOK(dbus_interface=client_interface,
 
367
                                 ignore_reply=True)
203
368
        # xxx
204
 
#         elif key == u"p" or key == "=":
 
369
#         elif key == "p" or key == "=":
205
370
#             self.proxy.pause()
206
 
#         elif key == u"u" or key == ":":
 
371
#         elif key == "u" or key == ":":
207
372
#             self.proxy.unpause()
208
 
#         elif key == u"RET":
 
373
#         elif key == "RET":
209
374
#             self.open()
210
375
        else:
211
376
            return key
212
 
    
213
 
    def property_changed(self, property=None, value=None,
214
 
                         *args, **kwargs):
215
 
        """Call self.update() if old value is not new value.
 
377
 
 
378
    def properties_changed(self, interface, properties, invalidated):
 
379
        """Call self.update() if any properties changed.
216
380
        This overrides the method from MandosClientPropertyCache"""
217
 
        property_name = unicode(property)
218
 
        old_value = self.properties.get(property_name)
219
 
        super(MandosClientWidget, self).property_changed(
220
 
            property=property, value=value, *args, **kwargs)
221
 
        if self.properties.get(property_name) != old_value:
 
381
        old_values = {key: self.properties.get(key)
 
382
                      for key in properties.keys()}
 
383
        super(MandosClientWidget, self).properties_changed(
 
384
            interface, properties, invalidated)
 
385
        if any(old_values[key] != self.properties.get(key)
 
386
               for key in old_values):
222
387
            self.update()
223
388
 
224
389
 
 
390
class ConstrainedListBox(urwid.ListBox):
 
391
    """Like a normal urwid.ListBox, but will consume all "up" or
 
392
    "down" key presses, thus not allowing any containing widgets to
 
393
    use them as an excuse to shift focus away from this widget.
 
394
    """
 
395
    def keypress(self, *args, **kwargs):
 
396
        ret = (super(ConstrainedListBox, self)
 
397
               .keypress(*args, **kwargs))
 
398
        if ret in ("up", "down"):
 
399
            return
 
400
        return ret
 
401
 
 
402
 
225
403
class UserInterface(object):
226
404
    """This is the entire user interface - the whole screen
227
405
    with boxes, lists of client widgets, etc.
228
406
    """
229
 
    def __init__(self):
230
 
        DBusGMainLoop(set_as_default=True )
231
 
        
 
407
    def __init__(self, max_log_length=1000, log_level=1):
 
408
        DBusGMainLoop(set_as_default=True)
 
409
 
232
410
        self.screen = urwid.curses_display.Screen()
233
 
        
 
411
 
234
412
        self.screen.register_palette((
235
 
                (u"normal",
236
 
                 u"default", u"default", None),
237
 
                (u"bold",
238
 
                 u"default", u"default", u"bold"),
239
 
                (u"underline-blink",
240
 
                 u"default", u"default", u"underline"),
241
 
                (u"standout",
242
 
                 u"default", u"default", u"standout"),
243
 
                (u"bold-underline-blink",
244
 
                 u"default", u"default", (u"bold", u"underline")),
245
 
                (u"bold-standout",
246
 
                 u"default", u"default", (u"bold", u"standout")),
247
 
                (u"underline-blink-standout",
248
 
                 u"default", u"default", (u"underline", u"standout")),
249
 
                (u"bold-underline-blink-standout",
250
 
                 u"default", u"default", (u"bold", u"underline",
251
 
                                          u"standout")),
 
413
                ("normal",
 
414
                 "default", "default", None),
 
415
                ("bold",
 
416
                 "bold", "default", "bold"),
 
417
                ("underline-blink",
 
418
                 "underline,blink", "default", "underline,blink"),
 
419
                ("standout",
 
420
                 "standout", "default", "standout"),
 
421
                ("bold-underline-blink",
 
422
                 "bold,underline,blink", "default",
 
423
                 "bold,underline,blink"),
 
424
                ("bold-standout",
 
425
                 "bold,standout", "default", "bold,standout"),
 
426
                ("underline-blink-standout",
 
427
                 "underline,blink,standout", "default",
 
428
                 "underline,blink,standout"),
 
429
                ("bold-underline-blink-standout",
 
430
                 "bold,underline,blink,standout", "default",
 
431
                 "bold,underline,blink,standout"),
252
432
                ))
253
 
        
 
433
 
 
434
        if urwid.supports_unicode():
 
435
            self.divider = "─"  # \u2500
 
436
        else:
 
437
            self.divider = "_"  # \u005f
 
438
 
254
439
        self.screen.start()
255
 
        
 
440
 
256
441
        self.size = self.screen.get_cols_rows()
257
 
        
 
442
 
258
443
        self.clients = urwid.SimpleListWalker([])
259
444
        self.clients_dict = {}
260
 
        self.topwidget = urwid.LineBox(urwid.ListBox(self.clients))
261
 
        #self.topwidget = urwid.ListBox(clients)
262
 
        
 
445
 
 
446
        # We will add Text widgets to this list
 
447
        self.log = urwid.SimpleListWalker([])
 
448
        self.max_log_length = max_log_length
 
449
 
 
450
        self.log_level = log_level
 
451
 
 
452
        # We keep a reference to the log widget so we can remove it
 
453
        # from the ListWalker without it getting destroyed
 
454
        self.logbox = ConstrainedListBox(self.log)
 
455
 
 
456
        # This keeps track of whether self.uilist currently has
 
457
        # self.logbox in it or not
 
458
        self.log_visible = True
 
459
        self.log_wrap = "any"
 
460
 
 
461
        self.rebuild()
 
462
        self.log_message_raw(("bold",
 
463
                              "Mandos Monitor version " + version))
 
464
        self.log_message_raw(("bold",
 
465
                              "q: Quit  ?: Help"))
 
466
 
263
467
        self.busname = domain + '.Mandos'
264
 
        self.main_loop = gobject.MainLoop()
265
 
        self.bus = dbus.SystemBus()
266
 
        mandos_dbus_objc = self.bus.get_object(
267
 
            self.busname, u"/", follow_name_owner_changes=True)
268
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
269
 
                                          dbus_interface
270
 
                                          = server_interface)
271
 
        try:
272
 
            mandos_clients = (self.mandos_serv
273
 
                              .GetAllClientsWithProperties())
274
 
        except dbus.exceptions.DBusException:
275
 
            mandos_clients = dbus.Dictionary()
276
 
        
277
 
        (self.mandos_serv
278
 
         .connect_to_signal("ClientRemoved",
279
 
                            self.find_and_remove_client,
280
 
                            dbus_interface=server_interface,
281
 
                            byte_arrays=True))
282
 
        (self.mandos_serv
283
 
         .connect_to_signal("ClientAdded",
284
 
                            self.add_new_client,
285
 
                            dbus_interface=server_interface,
286
 
                            byte_arrays=True))
287
 
        for path, client in (mandos_clients.iteritems()):
288
 
            client_proxy_object = self.bus.get_object(self.busname,
289
 
                                                      path)
290
 
            self.add_client(MandosClientWidget(server_proxy_object
291
 
                                               =self.mandos_serv,
292
 
                                               proxy_object
293
 
                                               =client_proxy_object,
294
 
                                               properties=client,
295
 
                                               update_hook
296
 
                                               =self.refresh,
297
 
                                               delete_hook
298
 
                                               =self.remove_client),
299
 
                            path=path)
300
 
    
301
 
    def find_and_remove_client(self, path, name):
302
 
        """Find an client from its object path and remove it.
303
 
        
304
 
        This is connected to the ClientRemoved signal from the
 
468
        self.main_loop = GLib.MainLoop()
 
469
 
 
470
    def client_not_found(self, fingerprint, address):
 
471
        self.log_message("Client with address {} and fingerprint {}"
 
472
                         " could not be found"
 
473
                         .format(address, fingerprint))
 
474
 
 
475
    def rebuild(self):
 
476
        """This rebuilds the User Interface.
 
477
        Call this when the widget layout needs to change"""
 
478
        self.uilist = []
 
479
        # self.uilist.append(urwid.ListBox(self.clients))
 
480
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
481
                                                          clients),
 
482
                                       # header=urwid.Divider(),
 
483
                                       header=None,
 
484
                                       footer=urwid.Divider(
 
485
                                           div_char=self.divider)))
 
486
        if self.log_visible:
 
487
            self.uilist.append(self.logbox)
 
488
        self.topwidget = urwid.Pile(self.uilist)
 
489
 
 
490
    def log_message(self, message, level=1):
 
491
        """Log message formatted with timestamp"""
 
492
        if level < self.log_level:
 
493
            return
 
494
        timestamp = datetime.datetime.now().isoformat()
 
495
        self.log_message_raw("{}: {}".format(timestamp, message),
 
496
                             level=level)
 
497
 
 
498
    def log_message_raw(self, markup, level=1):
 
499
        """Add a log message to the log buffer."""
 
500
        if level < self.log_level:
 
501
            return
 
502
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
 
503
        if self.max_log_length:
 
504
            if len(self.log) > self.max_log_length:
 
505
                del self.log[0:len(self.log)-self.max_log_length-1]
 
506
        self.logbox.set_focus(len(self.logbox.body.contents)-1,
 
507
                              coming_from="above")
 
508
        self.refresh()
 
509
 
 
510
    def toggle_log_display(self):
 
511
        """Toggle visibility of the log buffer."""
 
512
        self.log_visible = not self.log_visible
 
513
        self.rebuild()
 
514
        self.log_message("Log visibility changed to: {}"
 
515
                         .format(self.log_visible), level=0)
 
516
 
 
517
    def change_log_display(self):
 
518
        """Change type of log display.
 
519
        Currently, this toggles wrapping of text lines."""
 
520
        if self.log_wrap == "clip":
 
521
            self.log_wrap = "any"
 
522
        else:
 
523
            self.log_wrap = "clip"
 
524
        for textwidget in self.log:
 
525
            textwidget.set_wrap_mode(self.log_wrap)
 
526
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
527
                         level=0)
 
528
 
 
529
    def find_and_remove_client(self, path, interfaces):
 
530
        """Find a client by its object path and remove it.
 
531
 
 
532
        This is connected to the InterfacesRemoved signal from the
305
533
        Mandos server object."""
 
534
        if client_interface not in interfaces:
 
535
            # Not a Mandos client object; ignore
 
536
            return
306
537
        try:
307
538
            client = self.clients_dict[path]
308
539
        except KeyError:
309
540
            # not found?
310
 
            return
311
 
        self.remove_client(client, path)
312
 
    
313
 
    def add_new_client(self, path, properties):
 
541
            self.log_message("Unknown client {!r} removed"
 
542
                             .format(path))
 
543
            return
 
544
        client.delete()
 
545
 
 
546
    def add_new_client(self, path, ifs_and_props):
 
547
        """Find a client by its object path and remove it.
 
548
 
 
549
        This is connected to the InterfacesAdded signal from the
 
550
        Mandos server object.
 
551
        """
 
552
        if client_interface not in ifs_and_props:
 
553
            # Not a Mandos client object; ignore
 
554
            return
314
555
        client_proxy_object = self.bus.get_object(self.busname, path)
315
 
        self.add_client(MandosClientWidget(server_proxy_object
316
 
                                           =self.mandos_serv,
317
 
                                           proxy_object
318
 
                                           =client_proxy_object,
319
 
                                           properties=properties,
320
 
                                           update_hook
321
 
                                           =self.refresh,
322
 
                                           delete_hook
323
 
                                           =self.remove_client),
 
556
        self.add_client(MandosClientWidget(
 
557
            server_proxy_object=self.mandos_serv,
 
558
            proxy_object=client_proxy_object,
 
559
            update_hook=self.refresh,
 
560
            delete_hook=self.remove_client,
 
561
            logger=self.log_message,
 
562
            properties=dict(ifs_and_props[client_interface])),
324
563
                        path=path)
325
 
    
 
564
 
326
565
    def add_client(self, client, path=None):
327
566
        self.clients.append(client)
328
567
        if path is None:
329
568
            path = client.proxy.object_path
330
569
        self.clients_dict[path] = client
331
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
570
        self.clients.sort(key=lambda c: c.properties["Name"])
332
571
        self.refresh()
333
 
    
 
572
 
334
573
    def remove_client(self, client, path=None):
335
574
        self.clients.remove(client)
336
575
        if path is None:
337
576
            path = client.proxy.object_path
338
577
        del self.clients_dict[path]
339
578
        self.refresh()
340
 
    
 
579
 
341
580
    def refresh(self):
342
581
        """Redraw the screen"""
343
582
        canvas = self.topwidget.render(self.size, focus=True)
344
583
        self.screen.draw_screen(self.size, canvas)
345
 
    
 
584
 
346
585
    def run(self):
347
586
        """Start the main loop and exit when it's done."""
 
587
        self.bus = dbus.SystemBus()
 
588
        mandos_dbus_objc = self.bus.get_object(
 
589
            self.busname, "/", follow_name_owner_changes=True)
 
590
        self.mandos_serv = dbus.Interface(
 
591
            mandos_dbus_objc, dbus_interface=server_interface)
 
592
        try:
 
593
            mandos_clients = (self.mandos_serv
 
594
                              .GetAllClientsWithProperties())
 
595
            if not mandos_clients:
 
596
                self.log_message_raw(("bold",
 
597
                                      "Note: Server has no clients."))
 
598
        except dbus.exceptions.DBusException:
 
599
            self.log_message_raw(("bold",
 
600
                                  "Note: No Mandos server running."))
 
601
            mandos_clients = dbus.Dictionary()
 
602
 
 
603
        (self.mandos_serv
 
604
         .connect_to_signal("InterfacesRemoved",
 
605
                            self.find_and_remove_client,
 
606
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
 
607
                            byte_arrays=True))
 
608
        (self.mandos_serv
 
609
         .connect_to_signal("InterfacesAdded",
 
610
                            self.add_new_client,
 
611
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
 
612
                            byte_arrays=True))
 
613
        (self.mandos_serv
 
614
         .connect_to_signal("ClientNotFound",
 
615
                            self.client_not_found,
 
616
                            dbus_interface=server_interface,
 
617
                            byte_arrays=True))
 
618
        for path, client in mandos_clients.items():
 
619
            client_proxy_object = self.bus.get_object(self.busname,
 
620
                                                      path)
 
621
            self.add_client(MandosClientWidget(
 
622
                server_proxy_object=self.mandos_serv,
 
623
                proxy_object=client_proxy_object,
 
624
                properties=client,
 
625
                update_hook=self.refresh,
 
626
                delete_hook=self.remove_client,
 
627
                logger=self.log_message),
 
628
                            path=path)
 
629
 
348
630
        self.refresh()
349
 
        self._input_callback_tag = (gobject.io_add_watch
 
631
        self._input_callback_tag = (GLib.io_add_watch
350
632
                                    (sys.stdin.fileno(),
351
 
                                     gobject.IO_IN,
 
633
                                     GLib.IO_IN,
352
634
                                     self.process_input))
353
635
        self.main_loop.run()
354
636
        # Main loop has finished, we should close everything now
355
 
        gobject.source_remove(self._input_callback_tag)
 
637
        GLib.source_remove(self._input_callback_tag)
356
638
        self.screen.stop()
357
 
    
 
639
 
358
640
    def stop(self):
359
641
        self.main_loop.quit()
360
 
    
 
642
 
361
643
    def process_input(self, source, condition):
362
644
        keys = self.screen.get_input()
363
 
        translations = { u"j": u"down",
364
 
                         u"k": u"up",
365
 
                         }
 
645
        translations = {"ctrl n": "down",       # Emacs
 
646
                        "ctrl p": "up",         # Emacs
 
647
                        "ctrl v": "page down",  # Emacs
 
648
                        "meta v": "page up",    # Emacs
 
649
                        " ": "page down",       # less
 
650
                        "f": "page down",       # less
 
651
                        "b": "page up",         # less
 
652
                        "j": "down",            # vi
 
653
                        "k": "up",              # vi
 
654
                        }
366
655
        for key in keys:
367
656
            try:
368
657
                key = translations[key]
369
658
            except KeyError:    # :-)
370
659
                pass
371
 
            
372
 
            if key == u"q" or key == u"Q":
 
660
 
 
661
            if key == "q" or key == "Q":
373
662
                self.stop()
374
663
                break
375
 
            elif key == u"window resize":
 
664
            elif key == "window resize":
376
665
                self.size = self.screen.get_cols_rows()
377
666
                self.refresh()
378
 
            elif key == " ":
379
 
                self.refresh()
 
667
            elif key == "ctrl l":
 
668
                self.screen.clear()
 
669
                self.refresh()
 
670
            elif key == "l" or key == "D":
 
671
                self.toggle_log_display()
 
672
                self.refresh()
 
673
            elif key == "w" or key == "i":
 
674
                self.change_log_display()
 
675
                self.refresh()
 
676
            elif key == "?" or key == "f1" or key == "esc":
 
677
                if not self.log_visible:
 
678
                    self.log_visible = True
 
679
                    self.rebuild()
 
680
                self.log_message_raw(("bold",
 
681
                                      "  ".
 
682
                                      join(("q: Quit",
 
683
                                            "?: Help",
 
684
                                            "l: Log window toggle",
 
685
                                            "TAB: Switch window",
 
686
                                            "w: Wrap (log lines)",
 
687
                                            "v: Toggle verbose log",
 
688
                                            ))))
 
689
                self.log_message_raw(("bold",
 
690
                                      "  "
 
691
                                      .join(("Clients:",
 
692
                                             "+: Enable",
 
693
                                             "-: Disable",
 
694
                                             "R: Remove",
 
695
                                             "s: Start new checker",
 
696
                                             "S: Stop checker",
 
697
                                             "C: Checker OK",
 
698
                                             "a: Approve",
 
699
                                             "d: Deny"))))
 
700
                self.refresh()
 
701
            elif key == "tab":
 
702
                if self.topwidget.get_focus() is self.logbox:
 
703
                    self.topwidget.set_focus(0)
 
704
                else:
 
705
                    self.topwidget.set_focus(self.logbox)
 
706
                self.refresh()
 
707
            elif key == "v":
 
708
                if self.log_level == 0:
 
709
                    self.log_level = 1
 
710
                    self.log_message("Verbose mode: Off")
 
711
                else:
 
712
                    self.log_level = 0
 
713
                    self.log_message("Verbose mode: On")
 
714
            # elif (key == "end" or key == "meta >" or key == "G"
 
715
            #       or key == ">"):
 
716
            #     pass            # xxx end-of-buffer
 
717
            # elif (key == "home" or key == "meta <" or key == "g"
 
718
            #       or key == "<"):
 
719
            #     pass            # xxx beginning-of-buffer
 
720
            # elif key == "ctrl e" or key == "$":
 
721
            #     pass            # xxx move-end-of-line
 
722
            # elif key == "ctrl a" or key == "^":
 
723
            #     pass            # xxx move-beginning-of-line
 
724
            # elif key == "ctrl b" or key == "meta (" or key == "h":
 
725
            #     pass            # xxx left
 
726
            # elif key == "ctrl f" or key == "meta )" or key == "l":
 
727
            #     pass            # xxx right
 
728
            # elif key == "a":
 
729
            #     pass            # scroll up log
 
730
            # elif key == "z":
 
731
            #     pass            # scroll down log
380
732
            elif self.topwidget.selectable():
381
733
                self.topwidget.keypress(self.size, key)
382
734
                self.refresh()
383
735
        return True
384
736
 
 
737
 
385
738
ui = UserInterface()
386
739
try:
387
740
    ui.run()
388
 
except:
 
741
except KeyboardInterrupt:
 
742
    ui.screen.stop()
 
743
except Exception as e:
 
744
    ui.log_message(str(e))
389
745
    ui.screen.stop()
390
746
    raise