/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-01-01 20:45:53 UTC
  • Revision ID: teddy@recompile.se-20120101204553-f1zlty873gswtf5n
* README: Hint that the intro(8mandos) manual page is in the server
          package.

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