/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

* network-hooks.d: New directory.
* network-hooks.d/bridge: New example hook.
* network-hooks.d/bridge.conf: Config file for bridge example hook.

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