/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

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