/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 Hogeborn
  • Date: 2024-09-12 18:31:12 UTC
  • mfrom: (237.4.142 release)
  • Revision ID: teddy@recompile.se-20240912183112-xxy0akg67c0ky0t8
Merge from release branch

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