/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: teddy at bsnet
  • Date: 2010-09-02 18:36:36 UTC
  • mto: (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 421.
  • Revision ID: teddy@fukt.bsnet.se-20100902183636-h0vb4iw3ut2g3mta
* mandos (ClientDBus.approvals_pending): Changed to be a property
                                         which emits D-Bus signals.
  (ClientDBus.approved_pending): Removed - all callers changed.
  (ClientDBus.GotSecret, ClientDBus.Rejected,
  ClientDBus.NeedApproval): Do not emit D-Bus signal.

Show diffs side-by-side

added added

removed removed

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