/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

merge
new approve/deny functionallity in mandos-monitor

Show diffs side-by-side

added added

removed removed

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