/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

* DBUS-API: Fix grammar.

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