/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: 2011-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

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