/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2024-11-22 20:28:54 UTC
  • mto: This revision was merged to the branch mainline in revision 412.
  • Revision ID: teddy@recompile.se-20241122202854-dycuf117byxhxl32
mandos-monitor: Avoid debug messages from urwid

Avoid debug messages from urwid.  Any logging output before the screen
has been set up will mangle the screen.

* mandos-monitor: When setting up logging, set urwid to only show log
  messages of level INFO or above.

(Thanks to an anonymous contributor for reporting this.)

Show diffs side-by-side

added added

removed removed

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