/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

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