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