/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-12 20:13:34 UTC
  • Revision ID: teddy@recompile.se-20190312201334-my3htrprewjosuw5
mandos-ctl: Refactor

* mandos-ctl: Reorder everything into logical order; put main() first,
              and put every subsequent definition as soon as possible
              after its first use, except superclasses which need to
              be placed before the classes inheriting from them.
              Reorder all tests to match.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
35
import os
8
 
import signal
9
36
 
10
37
import datetime
11
38
 
13
40
import urwid
14
41
 
15
42
from dbus.mainloop.glib import DBusGMainLoop
16
 
import gobject
 
43
from gi.repository import GLib
17
44
 
18
45
import dbus
19
46
 
20
 
import UserList
21
 
 
22
47
import locale
23
48
 
24
 
locale.setlocale(locale.LC_ALL, u'')
 
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)
25
57
 
26
58
# Some useful constants
27
 
domain = 'se.bsnet.fukt'
 
59
domain = 'se.recompile'
28
60
server_interface = domain + '.Mandos'
29
61
client_interface = domain + '.Mandos.Client'
30
 
version = "1.0.14"
31
 
 
32
 
# Always run in monochrome mode
33
 
urwid.curses_display.curses.has_colors = lambda : False
34
 
 
35
 
# Urwid doesn't support blinking, but we want it.  Since we have no
36
 
# use for underline on its own, we make underline also always blink.
37
 
urwid.curses_display.curses.A_UNDERLINE |= (
38
 
    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
 
39
86
 
40
87
class MandosClientPropertyCache(object):
41
88
    """This wraps a Mandos Client D-Bus proxy object, caches the
42
89
    properties and calls a hook function when any of them are
43
90
    changed.
44
91
    """
45
 
    def __init__(self, proxy_object=None, *args, **kwargs):
46
 
        self.proxy = proxy_object # Mandos Client proxy object
47
 
        
48
 
        self.properties = dict()
49
 
        self.proxy.connect_to_signal(u"PropertyChanged",
50
 
                                     self.property_changed,
51
 
                                     client_interface,
52
 
                                     byte_arrays=True)
53
 
 
54
 
        self.properties.update(
55
 
            self.proxy.GetAll(client_interface,
56
 
                              dbus_interface = dbus.PROPERTIES_IFACE))
57
 
        super(MandosClientPropertyCache, self).__init__(
58
 
            proxy_object=proxy_object, *args, **kwargs)
59
 
    
60
 
    def property_changed(self, property=None, value=None):
61
 
        """This is called whenever we get a PropertyChanged signal
62
 
        It updates the changed property in the "properties" dict.
 
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.
63
111
        """
64
112
        # Update properties dict with new value
65
 
        self.properties[property] = value
 
113
        if interface == client_interface:
 
114
            self.properties.update(properties)
 
115
 
 
116
    def delete(self):
 
117
        self.property_changed_match.remove()
66
118
 
67
119
 
68
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
69
121
    """A Mandos Client which is visible on the screen.
70
122
    """
71
 
    
 
123
 
72
124
    def __init__(self, server_proxy_object=None, update_hook=None,
73
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
125
                 delete_hook=None, logger=None, **kwargs):
74
126
        # Called on update
75
127
        self.update_hook = update_hook
76
128
        # Called on delete
79
131
        self.server_proxy_object = server_proxy_object
80
132
        # Logger
81
133
        self.logger = logger
82
 
        
 
134
 
 
135
        self._update_timer_callback_tag = None
 
136
 
83
137
        # The widget shown normally
84
 
        self._text_widget = urwid.Text(u"")
 
138
        self._text_widget = urwid.Text("")
85
139
        # The widget shown when we have focus
86
 
        self._focus_text_widget = urwid.Text(u"")
87
 
        super(MandosClientWidget, self).__init__(
88
 
            update_hook=update_hook, delete_hook=delete_hook,
89
 
            *args, **kwargs)
 
140
        self._focus_text_widget = urwid.Text("")
 
141
        super(MandosClientWidget, self).__init__(**kwargs)
90
142
        self.update()
91
143
        self.opened = False
92
 
        self.proxy.connect_to_signal(u"CheckerCompleted",
93
 
                                     self.checker_completed,
94
 
                                     client_interface,
95
 
                                     byte_arrays=True)
96
 
        self.proxy.connect_to_signal(u"CheckerStarted",
97
 
                                     self.checker_started,
98
 
                                     client_interface,
99
 
                                     byte_arrays=True)
100
 
        self.proxy.connect_to_signal(u"GotSecret",
101
 
                                     self.got_secret,
102
 
                                     client_interface,
103
 
                                     byte_arrays=True)
104
 
        self.proxy.connect_to_signal(u"Rejected",
105
 
                                     self.rejected,
106
 
                                     client_interface,
107
 
                                     byte_arrays=True)
108
 
    
 
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
 
109
182
    def checker_completed(self, exitstatus, condition, command):
110
183
        if exitstatus == 0:
111
 
            self.logger(u'Checker for client %s (command "%s")'
112
 
                        u' was successful'
113
 
                        % (self.properties[u"name"], command))
 
184
            self.logger('Checker for client {} (command "{}")'
 
185
                        ' succeeded'.format(self.properties["Name"],
 
186
                                            command), level=0)
 
187
            self.update()
114
188
            return
 
189
        # Checker failed
115
190
        if os.WIFEXITED(condition):
116
 
            self.logger(u'Checker for client %s (command "%s")'
117
 
                        u' failed with exit code %s'
118
 
                        % (self.properties[u"name"], command,
119
 
                           os.WEXITSTATUS(condition)))
120
 
            return
121
 
        if os.WIFSIGNALED(condition):
122
 
            self.logger(u'Checker for client %s (command "%s")'
123
 
                        u' was killed by signal %s'
124
 
                        % (self.properties[u"name"], command,
125
 
                           os.WTERMSIG(condition)))
126
 
            return
127
 
        if os.WCOREDUMP(condition):
128
 
            self.logger(u'Checker for client %s (command "%s")'
129
 
                        u' dumped core'
130
 
                        % (self.properties[u"name"], command))
131
 
        self.logger(u'Checker for client %s completed mysteriously')
132
 
    
 
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
 
133
202
    def checker_started(self, command):
134
 
        self.logger(u'Client %s started checker "%s"'
135
 
                    % (self.properties[u"name"], unicode(command)))
136
 
    
 
203
        """Server signals that a checker started."""
 
204
        self.logger('Client {} started checker "{}"'
 
205
                    .format(self.properties["Name"],
 
206
                            command), level=0)
 
207
 
137
208
    def got_secret(self):
138
 
        self.logger(u'Client %s received its secret'
139
 
                    % self.properties[u"name"])
140
 
    
141
 
    def rejected(self):
142
 
        self.logger(u'Client %s was rejected'
143
 
                    % self.properties[u"name"])
144
 
    
 
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
 
145
224
    def selectable(self):
146
225
        """Make this a "selectable" widget.
147
226
        This overrides the method from urwid.FlowWidget."""
148
227
        return True
149
 
    
150
 
    def rows(self, (maxcol,), focus=False):
 
228
 
 
229
    def rows(self, maxcolrow, focus=False):
151
230
        """How many rows this widget will occupy might depend on
152
231
        whether we have focus or not.
153
232
        This overrides the method from urwid.FlowWidget"""
154
 
        return self.current_widget(focus).rows((maxcol,), focus=focus)
155
 
    
 
233
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
234
 
156
235
    def current_widget(self, focus=False):
157
236
        if focus or self.opened:
158
237
            return self._focus_widget
159
238
        return self._widget
160
 
    
 
239
 
161
240
    def update(self):
162
241
        "Called when what is visible on the screen should be updated."
163
242
        # How to add standout mode to a style
164
 
        with_standout = { u"normal": u"standout",
165
 
                          u"bold": u"bold-standout",
166
 
                          u"underline-blink":
167
 
                              u"underline-blink-standout",
168
 
                          u"bold-underline-blink":
169
 
                              u"bold-underline-blink-standout",
170
 
                          }
171
 
        
 
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
 
172
251
        # Rebuild focus and non-focus widgets using current properties
173
 
        self._text = (u'%(name)s: %(enabled)s'
174
 
                      % { u"name": self.properties[u"name"],
175
 
                          u"enabled":
176
 
                              (u"enabled"
177
 
                               if self.properties[u"enabled"]
178
 
                               else u"DISABLED")})
 
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
 
179
294
        if not urwid.supports_unicode():
180
295
            self._text = self._text.encode("ascii", "replace")
181
 
        textlist = [(u"normal", self._text)]
 
296
        textlist = [("normal", self._text)]
182
297
        self._text_widget.set_text(textlist)
183
298
        self._focus_text_widget.set_text([(with_standout[text[0]],
184
299
                                           text[1])
191
306
        # Run update hook, if any
192
307
        if self.update_hook is not None:
193
308
            self.update_hook()
194
 
    
195
 
    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 = ()
196
324
        if self.delete_hook is not None:
197
325
            self.delete_hook(self)
198
 
    
199
 
    def render(self, (maxcol,), focus=False):
 
326
        return super(MandosClientWidget, self).delete(**kwargs)
 
327
 
 
328
    def render(self, maxcolrow, focus=False):
200
329
        """Render differently if we have focus.
201
330
        This overrides the method from urwid.FlowWidget"""
202
 
        return self.current_widget(focus).render((maxcol,),
 
331
        return self.current_widget(focus).render(maxcolrow,
203
332
                                                 focus=focus)
204
 
    
205
 
    def keypress(self, (maxcol,), key):
 
333
 
 
334
    def keypress(self, maxcolrow, key):
206
335
        """Handle keys.
207
336
        This overrides the method from urwid.FlowWidget"""
208
 
        if key == u"e" or key == u"+":
209
 
            self.proxy.Enable()
210
 
        elif key == u"d" or key == u"-":
211
 
            self.proxy.Disable()
212
 
        elif key == u"r" or key == u"_" or key == u"ctrl k":
 
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":
213
354
            self.server_proxy_object.RemoveClient(self.proxy
214
 
                                                  .object_path)
215
 
        elif key == u"s":
216
 
            self.proxy.StartChecker()
217
 
        elif key == u"S":
218
 
            self.proxy.StopChecker()
219
 
        elif key == u"C":
220
 
            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)
221
368
        # xxx
222
 
#         elif key == u"p" or key == "=":
 
369
#         elif key == "p" or key == "=":
223
370
#             self.proxy.pause()
224
 
#         elif key == u"u" or key == ":":
 
371
#         elif key == "u" or key == ":":
225
372
#             self.proxy.unpause()
226
 
#         elif key == u"RET":
 
373
#         elif key == "RET":
227
374
#             self.open()
228
375
        else:
229
376
            return key
230
 
    
231
 
    def property_changed(self, property=None, value=None,
232
 
                         *args, **kwargs):
233
 
        """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.
234
380
        This overrides the method from MandosClientPropertyCache"""
235
 
        property_name = unicode(property)
236
 
        old_value = self.properties.get(property_name)
237
 
        super(MandosClientWidget, self).property_changed(
238
 
            property=property, value=value, *args, **kwargs)
239
 
        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):
240
387
            self.update()
241
388
 
242
389
 
245
392
    "down" key presses, thus not allowing any containing widgets to
246
393
    use them as an excuse to shift focus away from this widget.
247
394
    """
248
 
    def keypress(self, (maxcol, maxrow), key):
249
 
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
250
 
        if ret in (u"up", u"down"):
 
395
    def keypress(self, *args, **kwargs):
 
396
        ret = (super(ConstrainedListBox, self)
 
397
               .keypress(*args, **kwargs))
 
398
        if ret in ("up", "down"):
251
399
            return
252
400
        return ret
253
401
 
256
404
    """This is the entire user interface - the whole screen
257
405
    with boxes, lists of client widgets, etc.
258
406
    """
259
 
    def __init__(self, max_log_length=1000):
 
407
    def __init__(self, max_log_length=1000, log_level=1):
260
408
        DBusGMainLoop(set_as_default=True)
261
 
        
 
409
 
262
410
        self.screen = urwid.curses_display.Screen()
263
 
        
 
411
 
264
412
        self.screen.register_palette((
265
 
                (u"normal",
266
 
                 u"default", u"default", None),
267
 
                (u"bold",
268
 
                 u"default", u"default", u"bold"),
269
 
                (u"underline-blink",
270
 
                 u"default", u"default", u"underline"),
271
 
                (u"standout",
272
 
                 u"default", u"default", u"standout"),
273
 
                (u"bold-underline-blink",
274
 
                 u"default", u"default", (u"bold", u"underline")),
275
 
                (u"bold-standout",
276
 
                 u"default", u"default", (u"bold", u"standout")),
277
 
                (u"underline-blink-standout",
278
 
                 u"default", u"default", (u"underline", u"standout")),
279
 
                (u"bold-underline-blink-standout",
280
 
                 u"default", u"default", (u"bold", u"underline",
281
 
                                          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"),
282
432
                ))
283
 
        
 
433
 
284
434
        if urwid.supports_unicode():
285
 
            self.divider = u"─" # \u2500
286
 
            #self.divider = u"━" # \u2501
 
435
            self.divider = "─"  # \u2500
287
436
        else:
288
 
            #self.divider = u"-" # \u002d
289
 
            self.divider = u"_" # \u005f
290
 
        
 
437
            self.divider = "_"  # \u005f
 
438
 
291
439
        self.screen.start()
292
 
        
 
440
 
293
441
        self.size = self.screen.get_cols_rows()
294
 
        
 
442
 
295
443
        self.clients = urwid.SimpleListWalker([])
296
444
        self.clients_dict = {}
297
 
        
 
445
 
298
446
        # We will add Text widgets to this list
299
 
        self.log = []
 
447
        self.log = urwid.SimpleListWalker([])
300
448
        self.max_log_length = max_log_length
301
 
        
 
449
 
 
450
        self.log_level = log_level
 
451
 
302
452
        # We keep a reference to the log widget so we can remove it
303
453
        # from the ListWalker without it getting destroyed
304
454
        self.logbox = ConstrainedListBox(self.log)
305
 
        
 
455
 
306
456
        # This keeps track of whether self.uilist currently has
307
457
        # self.logbox in it or not
308
458
        self.log_visible = True
309
 
        self.log_wrap = u"any"
310
 
        
 
459
        self.log_wrap = "any"
 
460
 
311
461
        self.rebuild()
312
 
        self.log_message_raw((u"bold",
313
 
                              u"Mandos Monitor version " + version))
314
 
        self.log_message_raw((u"bold",
315
 
                              u"q: Quit  ?: Help"))
316
 
        
 
462
        self.log_message_raw(("bold",
 
463
                              "Mandos Monitor version " + version))
 
464
        self.log_message_raw(("bold",
 
465
                              "q: Quit  ?: Help"))
 
466
 
317
467
        self.busname = domain + '.Mandos'
318
 
        self.main_loop = gobject.MainLoop()
319
 
        self.bus = dbus.SystemBus()
320
 
        mandos_dbus_objc = self.bus.get_object(
321
 
            self.busname, u"/", follow_name_owner_changes=True)
322
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
323
 
                                          dbus_interface
324
 
                                          = server_interface)
325
 
        try:
326
 
            mandos_clients = (self.mandos_serv
327
 
                              .GetAllClientsWithProperties())
328
 
        except dbus.exceptions.DBusException:
329
 
            mandos_clients = dbus.Dictionary()
330
 
        
331
 
        (self.mandos_serv
332
 
         .connect_to_signal(u"ClientRemoved",
333
 
                            self.find_and_remove_client,
334
 
                            dbus_interface=server_interface,
335
 
                            byte_arrays=True))
336
 
        (self.mandos_serv
337
 
         .connect_to_signal(u"ClientAdded",
338
 
                            self.add_new_client,
339
 
                            dbus_interface=server_interface,
340
 
                            byte_arrays=True))
341
 
        (self.mandos_serv
342
 
         .connect_to_signal(u"ClientNotFound",
343
 
                            self.client_not_found,
344
 
                            dbus_interface=server_interface,
345
 
                            byte_arrays=True))
346
 
        for path, client in mandos_clients.iteritems():
347
 
            client_proxy_object = self.bus.get_object(self.busname,
348
 
                                                      path)
349
 
            self.add_client(MandosClientWidget(server_proxy_object
350
 
                                               =self.mandos_serv,
351
 
                                               proxy_object
352
 
                                               =client_proxy_object,
353
 
                                               properties=client,
354
 
                                               update_hook
355
 
                                               =self.refresh,
356
 
                                               delete_hook
357
 
                                               =self.remove_client,
358
 
                                               logger
359
 
                                               =self.log_message),
360
 
                            path=path)
361
 
    
 
468
        self.main_loop = GLib.MainLoop()
 
469
 
362
470
    def client_not_found(self, fingerprint, address):
363
 
        self.log_message((u"Client with address %s and fingerprint %s"
364
 
                          u" could not be found" % (address,
365
 
                                                    fingerprint)))
366
 
    
 
471
        self.log_message("Client with address {} and fingerprint {}"
 
472
                         " could not be found"
 
473
                         .format(address, fingerprint))
 
474
 
367
475
    def rebuild(self):
368
476
        """This rebuilds the User Interface.
369
477
        Call this when the widget layout needs to change"""
370
478
        self.uilist = []
371
 
        #self.uilist.append(urwid.ListBox(self.clients))
372
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
373
 
                                       #header=urwid.Divider(),
 
479
        # self.uilist.append(urwid.ListBox(self.clients))
 
480
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
481
                                                          clients),
 
482
                                       # header=urwid.Divider(),
374
483
                                       header=None,
375
 
                                       footer=urwid.Divider(div_char=self.divider)))
 
484
                                       footer=urwid.Divider(
 
485
                                           div_char=self.divider)))
376
486
        if self.log_visible:
377
487
            self.uilist.append(self.logbox)
378
 
            pass
379
488
        self.topwidget = urwid.Pile(self.uilist)
380
 
    
381
 
    def log_message(self, message):
 
489
 
 
490
    def log_message(self, message, level=1):
 
491
        """Log message formatted with timestamp"""
 
492
        if level < self.log_level:
 
493
            return
382
494
        timestamp = datetime.datetime.now().isoformat()
383
 
        self.log_message_raw(timestamp + u": " + message)
384
 
    
385
 
    def log_message_raw(self, markup):
 
495
        self.log_message_raw("{}: {}".format(timestamp, message),
 
496
                             level=level)
 
497
 
 
498
    def log_message_raw(self, markup, level=1):
386
499
        """Add a log message to the log buffer."""
 
500
        if level < self.log_level:
 
501
            return
387
502
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
388
 
        if (self.max_log_length
389
 
            and len(self.log) > self.max_log_length):
390
 
            del self.log[0:len(self.log)-self.max_log_length-1]
391
 
        self.logbox.set_focus(len(self.logbox.body.contents),
392
 
                              coming_from=u"above")
 
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")
393
508
        self.refresh()
394
 
    
 
509
 
395
510
    def toggle_log_display(self):
396
511
        """Toggle visibility of the log buffer."""
397
512
        self.log_visible = not self.log_visible
398
513
        self.rebuild()
399
 
        self.log_message(u"Log visibility changed to: "
400
 
                         + unicode(self.log_visible))
401
 
    
 
514
        self.log_message("Log visibility changed to: {}"
 
515
                         .format(self.log_visible), level=0)
 
516
 
402
517
    def change_log_display(self):
403
518
        """Change type of log display.
404
519
        Currently, this toggles wrapping of text lines."""
405
 
        if self.log_wrap == u"clip":
406
 
            self.log_wrap = u"any"
 
520
        if self.log_wrap == "clip":
 
521
            self.log_wrap = "any"
407
522
        else:
408
 
            self.log_wrap = u"clip"
 
523
            self.log_wrap = "clip"
409
524
        for textwidget in self.log:
410
525
            textwidget.set_wrap_mode(self.log_wrap)
411
 
        self.log_message(u"Wrap mode: " + self.log_wrap)
412
 
    
413
 
    def find_and_remove_client(self, path, name):
414
 
        """Find an client from its object path and remove it.
415
 
        
416
 
        This is connected to the ClientRemoved signal from the
 
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
417
533
        Mandos server object."""
 
534
        if client_interface not in interfaces:
 
535
            # Not a Mandos client object; ignore
 
536
            return
418
537
        try:
419
538
            client = self.clients_dict[path]
420
539
        except KeyError:
421
540
            # not found?
422
 
            return
423
 
        self.remove_client(client, path)
424
 
    
425
 
    def add_new_client(self, path):
 
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
426
555
        client_proxy_object = self.bus.get_object(self.busname, path)
427
 
        self.add_client(MandosClientWidget(server_proxy_object
428
 
                                           =self.mandos_serv,
429
 
                                           proxy_object
430
 
                                           =client_proxy_object,
431
 
                                           update_hook
432
 
                                           =self.refresh,
433
 
                                           delete_hook
434
 
                                           =self.remove_client,
435
 
                                           logger
436
 
                                           =self.log_message),
 
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])),
437
563
                        path=path)
438
 
    
 
564
 
439
565
    def add_client(self, client, path=None):
440
566
        self.clients.append(client)
441
567
        if path is None:
442
568
            path = client.proxy.object_path
443
569
        self.clients_dict[path] = client
444
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
570
        self.clients.sort(key=lambda c: c.properties["Name"])
445
571
        self.refresh()
446
 
    
 
572
 
447
573
    def remove_client(self, client, path=None):
448
574
        self.clients.remove(client)
449
575
        if path is None:
450
576
            path = client.proxy.object_path
451
577
        del self.clients_dict[path]
452
 
        if not self.clients_dict:
453
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
454
 
            # is completely emptied, we need to recreate it.
455
 
            self.clients = urwid.SimpleListWalker([])
456
 
            self.rebuild()
457
578
        self.refresh()
458
 
    
 
579
 
459
580
    def refresh(self):
460
581
        """Redraw the screen"""
461
582
        canvas = self.topwidget.render(self.size, focus=True)
462
583
        self.screen.draw_screen(self.size, canvas)
463
 
    
 
584
 
464
585
    def run(self):
465
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
 
466
630
        self.refresh()
467
 
        self._input_callback_tag = (gobject.io_add_watch
 
631
        self._input_callback_tag = (GLib.io_add_watch
468
632
                                    (sys.stdin.fileno(),
469
 
                                     gobject.IO_IN,
 
633
                                     GLib.IO_IN,
470
634
                                     self.process_input))
471
635
        self.main_loop.run()
472
636
        # Main loop has finished, we should close everything now
473
 
        gobject.source_remove(self._input_callback_tag)
 
637
        GLib.source_remove(self._input_callback_tag)
474
638
        self.screen.stop()
475
 
    
 
639
 
476
640
    def stop(self):
477
641
        self.main_loop.quit()
478
 
    
 
642
 
479
643
    def process_input(self, source, condition):
480
644
        keys = self.screen.get_input()
481
 
        translations = { u"ctrl n": u"down",      # Emacs
482
 
                         u"ctrl p": u"up",        # Emacs
483
 
                         u"ctrl v": u"page down", # Emacs
484
 
                         u"meta v": u"page up",   # Emacs
485
 
                         u" ": u"page down",      # less
486
 
                         u"f": u"page down",      # less
487
 
                         u"b": u"page up",        # less
488
 
                         u"j": u"down",           # vi
489
 
                         u"k": u"up",             # vi
490
 
                         }
 
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
                        }
491
655
        for key in keys:
492
656
            try:
493
657
                key = translations[key]
494
658
            except KeyError:    # :-)
495
659
                pass
496
 
            
497
 
            if key == u"q" or key == u"Q":
 
660
 
 
661
            if key == "q" or key == "Q":
498
662
                self.stop()
499
663
                break
500
 
            elif key == u"window resize":
 
664
            elif key == "window resize":
501
665
                self.size = self.screen.get_cols_rows()
502
666
                self.refresh()
503
 
            elif key == u"\f":  # Ctrl-L
 
667
            elif key == "ctrl l":
 
668
                self.screen.clear()
504
669
                self.refresh()
505
 
            elif key == u"l" or key == u"D":
 
670
            elif key == "l" or key == "D":
506
671
                self.toggle_log_display()
507
672
                self.refresh()
508
 
            elif key == u"w" or key == u"i":
 
673
            elif key == "w" or key == "i":
509
674
                self.change_log_display()
510
675
                self.refresh()
511
 
            elif key == u"?" or key == u"f1" or key == u"esc":
 
676
            elif key == "?" or key == "f1" or key == "esc":
512
677
                if not self.log_visible:
513
678
                    self.log_visible = True
514
679
                    self.rebuild()
515
 
                self.log_message_raw((u"bold",
516
 
                                      u"  ".
517
 
                                      join((u"q: Quit",
518
 
                                            u"?: Help",
519
 
                                            u"l: Log window toggle",
520
 
                                            u"TAB: Switch window",
521
 
                                            u"w: Wrap (log)"))))
522
 
                self.log_message_raw((u"bold",
523
 
                                      u"  "
524
 
                                      .join((u"Clients:",
525
 
                                             u"e: Enable",
526
 
                                             u"d: Disable",
527
 
                                             u"r: Remove",
528
 
                                             u"s: Start new checker",
529
 
                                             u"S: Stop checker",
530
 
                                             u"C: Checker OK"))))
 
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"))))
531
700
                self.refresh()
532
 
            elif key == u"tab":
 
701
            elif key == "tab":
533
702
                if self.topwidget.get_focus() is self.logbox:
534
703
                    self.topwidget.set_focus(0)
535
704
                else:
536
705
                    self.topwidget.set_focus(self.logbox)
537
706
                self.refresh()
538
 
            #elif (key == u"end" or key == u"meta >" or key == u"G"
539
 
            #      or key == u">"):
540
 
            #    pass            # xxx end-of-buffer
541
 
            #elif (key == u"home" or key == u"meta <" or key == u"g"
542
 
            #      or key == u"<"):
543
 
            #    pass            # xxx beginning-of-buffer
544
 
            #elif key == u"ctrl e" or key == u"$":
545
 
            #    pass            # xxx move-end-of-line
546
 
            #elif key == u"ctrl a" or key == u"^":
547
 
            #    pass            # xxx move-beginning-of-line
548
 
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
549
 
            #    pass            # xxx left
550
 
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
551
 
            #    pass            # xxx right
552
 
            #elif key == u"a":
553
 
            #    pass            # scroll up log
554
 
            #elif key == u"z":
555
 
            #    pass            # scroll down log
 
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
556
732
            elif self.topwidget.selectable():
557
733
                self.topwidget.keypress(self.size, key)
558
734
                self.refresh()
559
735
        return True
560
736
 
 
737
 
561
738
ui = UserInterface()
562
739
try:
563
740
    ui.run()
564
 
except Exception, e:
565
 
    ui.log_message(unicode(e))
 
741
except KeyboardInterrupt:
 
742
    ui.screen.stop()
 
743
except Exception as e:
 
744
    ui.log_message(str(e))
566
745
    ui.screen.stop()
567
746
    raise