/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: teddy at bsnet
  • Date: 2011-02-15 19:27:23 UTC
  • mto: This revision was merged to the branch mainline in revision 465.
  • Revision ID: teddy@fukt.bsnet.se-20110215192723-qpftjhlvzadm5cjc
* mandos-ctl: Use unicode string literals.

Show diffs side-by-side

added added

removed removed

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