/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-01 18:03:03 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-20100901180303-u47edb73fczu56ob
bug fixes that prevent problems when runing server as root

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