/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2011-03-08 19:09:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110308190903-j499ebtb9bpk31ar
* INSTALL: Updated.

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