/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2012-05-06 17:37:23 UTC
  • Revision ID: teddy@recompile.se-20120506173723-znhgx61gpqp1rfor
* mandos (main.cleanup): Use tempfile.NamedTemporaryFile() instead of
                         tempfile.mkstemp().

Show diffs side-by-side

added added

removed removed

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