/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: Björn Påhlsson
  • Date: 2010-09-02 18:53:38 UTC
  • mto: (237.4.3 mandos-release)
  • mto: This revision was merged to the branch mainline in revision 421.
  • Revision ID: belorn@fukt.bsnet.se-20100902185338-d1022sv517txn3sb
early commit to ease todays coding

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