/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: 2019-12-04 23:52:20 UTC
  • Revision ID: teddy@recompile.se-20191204235220-yn88brp0scmqwy2t
Remove non-project-specific pattern from .bzrignore

Only project-specific patterns should be in the .bzrignore file.
Other generic patterns should be in the ~/.config/breezy/ignore and
~/.bazaar/ignore files.

* .bzrignore (.tramp_history): Remove.

Show diffs side-by-side

added added

removed removed

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