/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-05 08:53:14 UTC
  • mto: This revision was merged to the branch mainline in revision 570.
  • Revision ID: teddy@recompile.se-20120505085314-57lf21cjfybyljkl
* mandos-ctl (main): Use D-Bus properties instead of methods.

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