/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Björn Påhlsson
  • Date: 2011-06-19 20:25:38 UTC
  • mto: (237.7.33 trunk)
  • mto: This revision was merged to the branch mainline in revision 284.
  • Revision ID: belorn@fukt.bsnet.se-20110619202538-0js072v8fso12u07
prepended mandos plugin to error messages in each plugin. Added a better way in TODO.

Show diffs side-by-side

added added

removed removed

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