/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2024-11-24 00:44:25 UTC
  • Revision ID: teddy@recompile.se-20241124004425-6k3y0ir1ksyjq3c4
mandos-keygen: Show warning about old OpenSSH versions

When generating a config file snippet on the Mandos client system
using mandos-keygen, and the default ssh-keyscan checker is used, and
if the OpenSSH version is 9.8 or later, the "checker" command
generated for the config file on the Mandos server will include the
"-q" option for ssh-keyscan.  This option did not exist on ssh-keyscan
from OpenSSH older than version 9.8.  Therefore, if the Mandos
*server* is running an older version of OpenSSH, where ssh-keyscan
does not support the "-q" option, this option must be removed from the
generated "checker" setting.  Since we cannot know if this is the case
when running mandos-keygen on the Mandos client system, we print this
information as a comment above the generated "checker" setting.

* mandos-keygen: Show warning if the new "-q" options was used with
  ssh-keyscan in the generated "checker" setting.

Show diffs side-by-side

added added

removed removed

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