/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2025-06-27 19:57:27 UTC
  • mfrom: (237.7.868 trunk)
  • Revision ID: teddy@recompile.se-20250627195727-wmn5jvu20sor29ts
Merge from trunk

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-2024 Teddy Hogeborn
 
7
# Copyright © 2009-2024 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.18"
 
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
 
 
61
 
        #XXX This break good super behaviour!
62
 
#        super(MandosClientPropertyCache, self).__init__(
63
 
#            *args, **kwargs)
64
 
    
65
 
    def property_changed(self, property=None, value=None):
66
 
        """This is called whenever we get a PropertyChanged signal
67
 
        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.
68
122
        """
69
123
        # Update properties dict with new value
70
 
        self.properties[property] = value
71
 
 
72
 
 
73
 
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):
74
132
    """A Mandos Client which is visible on the screen.
75
133
    """
76
 
    
 
134
 
 
135
    _sizing = frozenset(["flow"])
 
136
 
77
137
    def __init__(self, server_proxy_object=None, update_hook=None,
78
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
138
                 delete_hook=None, **kwargs):
79
139
        # Called on update
80
140
        self.update_hook = update_hook
81
141
        # Called on delete
82
142
        self.delete_hook = delete_hook
83
143
        # Mandos Server proxy object
84
144
        self.server_proxy_object = server_proxy_object
85
 
        # Logger
86
 
        self.logger = logger
87
 
        
 
145
 
 
146
        self._update_timer_callback_tag = None
 
147
 
88
148
        # The widget shown normally
89
 
        self._text_widget = urwid.Text(u"")
 
149
        self._text_widget = urwid.Text("")
90
150
        # The widget shown when we have focus
91
 
        self._focus_text_widget = urwid.Text(u"")
92
 
        super(MandosClientWidget, self).__init__(
93
 
            update_hook=update_hook, delete_hook=delete_hook,
94
 
            *args, **kwargs)
 
151
        self._focus_text_widget = urwid.Text("")
 
152
        super(MandosClientWidget, self).__init__(**kwargs)
95
153
        self.update()
96
154
        self.opened = False
97
 
        self.proxy.connect_to_signal(u"CheckerCompleted",
98
 
                                     self.checker_completed,
99
 
                                     client_interface,
100
 
                                     byte_arrays=True)
101
 
        self.proxy.connect_to_signal(u"CheckerStarted",
102
 
                                     self.checker_started,
103
 
                                     client_interface,
104
 
                                     byte_arrays=True)
105
 
        self.proxy.connect_to_signal(u"GotSecret",
106
 
                                     self.got_secret,
107
 
                                     client_interface,
108
 
                                     byte_arrays=True)
109
 
        self.proxy.connect_to_signal(u"NeedApproval",
110
 
                                     self.need_approval,
111
 
                                     client_interface,
112
 
                                     byte_arrays=True)
113
 
        self.proxy.connect_to_signal(u"Rejected",
114
 
                                     self.rejected,
115
 
                                     client_interface,
116
 
                                     byte_arrays=True)
117
 
    
 
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
 
118
192
    def checker_completed(self, exitstatus, condition, command):
119
193
        if exitstatus == 0:
120
 
            #self.logger(u'Checker for client %s (command "%s")'
121
 
            #            u' was successful'
122
 
            #            % (self.properties[u"name"], command))
 
194
            log.debug('Checker for client %s (command "%s")'
 
195
                      " succeeded", self.properties["Name"], command)
 
196
            self.update()
123
197
            return
 
198
        # Checker failed
124
199
        if os.WIFEXITED(condition):
125
 
            self.logger(u'Checker for client %s (command "%s")'
126
 
                        u' failed with exit code %s'
127
 
                        % (self.properties[u"name"], command,
128
 
                           os.WEXITSTATUS(condition)))
129
 
            return
130
 
        if os.WIFSIGNALED(condition):
131
 
            self.logger(u'Checker for client %s (command "%s")'
132
 
                        u' was killed by signal %s'
133
 
                        % (self.properties[u"name"], command,
134
 
                           os.WTERMSIG(condition)))
135
 
            return
136
 
        if os.WCOREDUMP(condition):
137
 
            self.logger(u'Checker for client %s (command "%s")'
138
 
                        u' dumped core'
139
 
                        % (self.properties[u"name"], command))
140
 
        self.logger(u'Checker for client %s completed mysteriously')
141
 
    
 
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
 
142
209
    def checker_started(self, command):
143
 
        #self.logger(u'Client %s started checker "%s"'
144
 
        #            % (self.properties[u"name"], unicode(command)))
145
 
        pass
146
 
    
 
210
        """Server signals that a checker started."""
 
211
        log.debug('Client %s started checker "%s"',
 
212
                  self.properties["Name"], command)
 
213
 
147
214
    def got_secret(self):
148
 
        self.logger(u'Client %s received its secret'
149
 
                    % self.properties[u"name"])
150
 
    
 
215
        log.info("Client %s received its secret",
 
216
                 self.properties["Name"])
 
217
 
151
218
    def need_approval(self, timeout, default):
152
219
        if not default:
153
 
            message = u'Client %s needs approval within %s seconds'
 
220
            message = "Client %s needs approval within %f seconds"
154
221
        else:
155
 
            message = u'Client %s will get its secret in %s seconds'
156
 
        self.logger(message
157
 
                    % (self.properties[u"name"], timeout/1000))
158
 
    
 
222
            message = "Client %s will get its secret in %f seconds"
 
223
        log.info(message, self.properties["Name"], timeout/1000)
 
224
 
159
225
    def rejected(self, reason):
160
 
        self.logger(u'Client %s was rejected; reason: %s'
161
 
                    % (self.properties[u"name"], reason))
162
 
    
 
226
        log.info("Client %s was rejected; reason: %s",
 
227
                 self.properties["Name"], reason)
 
228
 
163
229
    def selectable(self):
164
230
        """Make this a "selectable" widget.
165
 
        This overrides the method from urwid.FlowWidget."""
 
231
        This overrides the method from urwid.Widget."""
166
232
        return True
167
 
    
168
 
    def rows(self, (maxcol,), focus=False):
 
233
 
 
234
    def rows(self, maxcolrow, focus=False):
169
235
        """How many rows this widget will occupy might depend on
170
236
        whether we have focus or not.
171
 
        This overrides the method from urwid.FlowWidget"""
172
 
        return self.current_widget(focus).rows((maxcol,), focus=focus)
173
 
    
 
237
        This overrides the method from urwid.Widget"""
 
238
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
239
 
174
240
    def current_widget(self, focus=False):
175
241
        if focus or self.opened:
176
242
            return self._focus_widget
177
243
        return self._widget
178
 
    
 
244
 
179
245
    def update(self):
180
246
        "Called when what is visible on the screen should be updated."
181
247
        # How to add standout mode to a style
182
 
        with_standout = { u"normal": u"standout",
183
 
                          u"bold": u"bold-standout",
184
 
                          u"underline-blink":
185
 
                              u"underline-blink-standout",
186
 
                          u"bold-underline-blink":
187
 
                              u"bold-underline-blink-standout",
188
 
                          }
 
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
                         }
189
255
 
190
256
        # Rebuild focus and non-focus widgets using current properties
191
257
 
192
258
        # Base part of a client. Name!
193
 
        self._text = (u'%(name)s: '
194
 
                      % {u"name": self.properties[u"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)
195
298
 
196
 
        if self.properties[u"approved_pending"]:
197
 
            if self.properties[u"approved_by_default"]:
198
 
                self._text += u"Connection established to client. (d)eny?"
199
 
            else:
200
 
                self._text += u"Seeks approval to send secret. (a)pprove?"
201
 
        else:
202
 
            self._text += (u'%(enabled)s'
203
 
                           % {u"enabled":
204
 
                               (u"enabled"
205
 
                                if self.properties[u"enabled"]
206
 
                                else u"DISABLED")})
207
299
        if not urwid.supports_unicode():
208
300
            self._text = self._text.encode("ascii", "replace")
209
 
        textlist = [(u"normal", self._text)]
 
301
        textlist = [("normal", self._text)]
210
302
        self._text_widget.set_text(textlist)
211
303
        self._focus_text_widget.set_text([(with_standout[text[0]],
212
304
                                           text[1])
219
311
        # Run update hook, if any
220
312
        if self.update_hook is not None:
221
313
            self.update_hook()
222
 
    
223
 
    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 = ()
224
329
        if self.delete_hook is not None:
225
330
            self.delete_hook(self)
226
 
    
227
 
    def render(self, (maxcol,), focus=False):
 
331
        return super(MandosClientWidget, self).delete(**kwargs)
 
332
 
 
333
    def render(self, maxcolrow, focus=False):
228
334
        """Render differently if we have focus.
229
 
        This overrides the method from urwid.FlowWidget"""
230
 
        return self.current_widget(focus).render((maxcol,),
 
335
        This overrides the method from urwid.Widget"""
 
336
        return self.current_widget(focus).render(maxcolrow,
231
337
                                                 focus=focus)
232
 
    
233
 
    def keypress(self, (maxcol,), key):
 
338
 
 
339
    def keypress(self, maxcolrow, key):
234
340
        """Handle keys.
235
 
        This overrides the method from urwid.FlowWidget"""
236
 
        if key == u"+":
237
 
            self.proxy.Enable(dbus_interface = client_interface)
238
 
        elif key == u"-":
239
 
            self.proxy.Disable(dbus_interface = client_interface)
240
 
        elif key == u"a":
 
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":
241
351
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
242
 
                               dbus_interface = client_interface)
243
 
        elif key == u"d":
 
352
                               dbus_interface=client_interface,
 
353
                               ignore_reply=True)
 
354
        elif key == "d":
244
355
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
245
 
                                  dbus_interface = client_interface)
246
 
        elif key == u"r" or key == u"_" or key == u"ctrl k":
 
356
                               dbus_interface=client_interface,
 
357
                               ignore_reply=True)
 
358
        elif key == "R" or key == "_" or key == "ctrl k":
247
359
            self.server_proxy_object.RemoveClient(self.proxy
248
 
                                                  .object_path)
249
 
        elif key == u"s":
250
 
            self.proxy.StartChecker(dbus_interface = client_interface)
251
 
        elif key == u"S":
252
 
            self.proxy.StopChecker(dbus_interface = client_interface)
253
 
        elif key == u"C":
254
 
            self.proxy.CheckedOK(dbus_interface = client_interface)
 
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)
255
373
        # xxx
256
 
#         elif key == u"p" or key == "=":
 
374
#         elif key == "p" or key == "=":
257
375
#             self.proxy.pause()
258
 
#         elif key == u"u" or key == ":":
 
376
#         elif key == "u" or key == ":":
259
377
#             self.proxy.unpause()
260
 
#         elif key == u"RET":
 
378
#         elif key == "RET":
261
379
#             self.open()
262
 
#        elif key == u"+":
263
 
#            self.proxy.Approve(True)
264
 
#        elif key == u"-":
265
 
#            self.proxy.Approve(False)
266
380
        else:
267
381
            return key
268
 
    
269
 
    def property_changed(self, property=None, value=None,
270
 
                         *args, **kwargs):
271
 
        """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.
272
385
        This overrides the method from MandosClientPropertyCache"""
273
 
        property_name = unicode(property)
274
 
        old_value = self.properties.get(property_name)
275
 
        super(MandosClientWidget, self).property_changed(
276
 
            property=property, value=value, *args, **kwargs)
277
 
        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):
278
392
            self.update()
279
393
 
280
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
 
281
405
class ConstrainedListBox(urwid.ListBox):
282
406
    """Like a normal urwid.ListBox, but will consume all "up" or
283
407
    "down" key presses, thus not allowing any containing widgets to
284
408
    use them as an excuse to shift focus away from this widget.
285
409
    """
286
 
    def keypress(self, (maxcol, maxrow), key):
287
 
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
288
 
        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"):
289
414
            return
290
415
        return ret
291
416
 
292
417
 
293
 
class UserInterface(object):
 
418
class UserInterface:
294
419
    """This is the entire user interface - the whole screen
295
420
    with boxes, lists of client widgets, etc.
296
421
    """
297
422
    def __init__(self, max_log_length=1000):
298
423
        DBusGMainLoop(set_as_default=True)
299
 
        
 
424
 
300
425
        self.screen = urwid.curses_display.Screen()
301
 
        
 
426
 
302
427
        self.screen.register_palette((
303
 
                (u"normal",
304
 
                 u"default", u"default", None),
305
 
                (u"bold",
306
 
                 u"default", u"default", u"bold"),
307
 
                (u"underline-blink",
308
 
                 u"default", u"default", u"underline"),
309
 
                (u"standout",
310
 
                 u"default", u"default", u"standout"),
311
 
                (u"bold-underline-blink",
312
 
                 u"default", u"default", (u"bold", u"underline")),
313
 
                (u"bold-standout",
314
 
                 u"default", u"default", (u"bold", u"standout")),
315
 
                (u"underline-blink-standout",
316
 
                 u"default", u"default", (u"underline", u"standout")),
317
 
                (u"bold-underline-blink-standout",
318
 
                 u"default", u"default", (u"bold", u"underline",
319
 
                                          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"),
320
447
                ))
321
 
        
 
448
 
322
449
        if urwid.supports_unicode():
323
 
            self.divider = u"─" # \u2500
324
 
            #self.divider = u"━" # \u2501
 
450
            self.divider = "─"  # \u2500
325
451
        else:
326
 
            #self.divider = u"-" # \u002d
327
 
            self.divider = u"_" # \u005f
328
 
        
 
452
            self.divider = "_"  # \u005f
 
453
 
329
454
        self.screen.start()
330
 
        
 
455
 
331
456
        self.size = self.screen.get_cols_rows()
332
 
        
 
457
 
333
458
        self.clients = urwid.SimpleListWalker([])
334
459
        self.clients_dict = {}
335
 
        
 
460
 
336
461
        # We will add Text widgets to this list
337
 
        self.log = []
 
462
        self.log = urwid.SimpleListWalker([])
338
463
        self.max_log_length = max_log_length
339
 
        
 
464
 
340
465
        # We keep a reference to the log widget so we can remove it
341
466
        # from the ListWalker without it getting destroyed
342
467
        self.logbox = ConstrainedListBox(self.log)
343
 
        
 
468
 
344
469
        # This keeps track of whether self.uilist currently has
345
470
        # self.logbox in it or not
346
471
        self.log_visible = True
347
 
        self.log_wrap = u"any"
348
 
        
 
472
        self.log_wrap = "any"
 
473
 
 
474
        self.loghandler = UILogHandler(self)
 
475
 
349
476
        self.rebuild()
350
 
        self.log_message_raw((u"bold",
351
 
                              u"Mandos Monitor version " + version))
352
 
        self.log_message_raw((u"bold",
353
 
                              u"q: Quit  ?: Help"))
354
 
        
355
 
        self.busname = domain + '.Mandos'
356
 
        self.main_loop = gobject.MainLoop()
357
 
        self.bus = dbus.SystemBus()
358
 
        mandos_dbus_objc = self.bus.get_object(
359
 
            self.busname, u"/", follow_name_owner_changes=True)
360
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
361
 
                                          dbus_interface
362
 
                                          = server_interface)
363
 
        try:
364
 
            mandos_clients = (self.mandos_serv
365
 
                              .GetAllClientsWithProperties())
366
 
        except dbus.exceptions.DBusException:
367
 
            mandos_clients = dbus.Dictionary()
368
 
        
369
 
        (self.mandos_serv
370
 
         .connect_to_signal(u"ClientRemoved",
371
 
                            self.find_and_remove_client,
372
 
                            dbus_interface=server_interface,
373
 
                            byte_arrays=True))
374
 
        (self.mandos_serv
375
 
         .connect_to_signal(u"ClientAdded",
376
 
                            self.add_new_client,
377
 
                            dbus_interface=server_interface,
378
 
                            byte_arrays=True))
379
 
        (self.mandos_serv
380
 
         .connect_to_signal(u"ClientNotFound",
381
 
                            self.client_not_found,
382
 
                            dbus_interface=server_interface,
383
 
                            byte_arrays=True))
384
 
        for path, client in mandos_clients.iteritems():
385
 
            client_proxy_object = self.bus.get_object(self.busname,
386
 
                                                      path)
387
 
            self.add_client(MandosClientWidget(server_proxy_object
388
 
                                               =self.mandos_serv,
389
 
                                               proxy_object
390
 
                                               =client_proxy_object,
391
 
                                               properties=client,
392
 
                                               update_hook
393
 
                                               =self.refresh,
394
 
                                               delete_hook
395
 
                                               =self.remove_client,
396
 
                                               logger
397
 
                                               =self.log_message),
398
 
                            path=path)
399
 
    
400
 
    def client_not_found(self, fingerprint, address):
401
 
        self.log_message((u"Client with address %s and fingerprint %s"
402
 
                          u" could not be found" % (address,
403
 
                                                    fingerprint)))
404
 
    
 
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
 
405
488
    def rebuild(self):
406
489
        """This rebuilds the User Interface.
407
490
        Call this when the widget layout needs to change"""
408
491
        self.uilist = []
409
 
        #self.uilist.append(urwid.ListBox(self.clients))
410
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
411
 
                                       #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(),
412
496
                                       header=None,
413
 
                                       footer=urwid.Divider(div_char=self.divider)))
 
497
                                       footer=urwid.Divider(
 
498
                                           div_char=self.divider)))
414
499
        if self.log_visible:
415
500
            self.uilist.append(self.logbox)
416
 
            pass
417
501
        self.topwidget = urwid.Pile(self.uilist)
418
 
    
419
 
    def log_message(self, message):
420
 
        timestamp = datetime.datetime.now().isoformat()
421
 
        self.log_message_raw(timestamp + u": " + message)
422
 
    
423
 
    def log_message_raw(self, markup):
424
 
        """Add a log message to the log buffer."""
 
502
 
 
503
    def add_log_line(self, markup):
425
504
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
426
 
        if (self.max_log_length
427
 
            and len(self.log) > self.max_log_length):
428
 
            del self.log[0:len(self.log)-self.max_log_length-1]
429
 
        self.logbox.set_focus(len(self.logbox.body.contents),
430
 
                              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")
431
510
        self.refresh()
432
 
    
 
511
 
433
512
    def toggle_log_display(self):
434
513
        """Toggle visibility of the log buffer."""
435
514
        self.log_visible = not self.log_visible
436
515
        self.rebuild()
437
 
        self.log_message(u"Log visibility changed to: "
438
 
                         + unicode(self.log_visible))
439
 
    
 
516
        log.debug("Log visibility changed to: %s", self.log_visible)
 
517
 
440
518
    def change_log_display(self):
441
519
        """Change type of log display.
442
520
        Currently, this toggles wrapping of text lines."""
443
 
        if self.log_wrap == u"clip":
444
 
            self.log_wrap = u"any"
 
521
        if self.log_wrap == "clip":
 
522
            self.log_wrap = "any"
445
523
        else:
446
 
            self.log_wrap = u"clip"
 
524
            self.log_wrap = "clip"
447
525
        for textwidget in self.log:
448
526
            textwidget.set_wrap_mode(self.log_wrap)
449
 
        self.log_message(u"Wrap mode: " + self.log_wrap)
450
 
    
451
 
    def find_and_remove_client(self, path, name):
452
 
        """Find an client from its object path and remove it.
453
 
        
454
 
        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
455
533
        Mandos server object."""
 
534
        if client_interface not in interfaces:
 
535
            # Not a Mandos client object; ignore
 
536
            return
456
537
        try:
457
538
            client = self.clients_dict[path]
458
539
        except KeyError:
459
540
            # not found?
460
 
            return
461
 
        self.remove_client(client, path)
462
 
    
463
 
    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
464
554
        client_proxy_object = self.bus.get_object(self.busname, path)
465
 
        self.add_client(MandosClientWidget(server_proxy_object
466
 
                                           =self.mandos_serv,
467
 
                                           proxy_object
468
 
                                           =client_proxy_object,
469
 
                                           update_hook
470
 
                                           =self.refresh,
471
 
                                           delete_hook
472
 
                                           =self.remove_client,
473
 
                                           logger
474
 
                                           =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])),
475
561
                        path=path)
476
 
    
 
562
 
477
563
    def add_client(self, client, path=None):
478
564
        self.clients.append(client)
479
565
        if path is None:
480
566
            path = client.proxy.object_path
481
567
        self.clients_dict[path] = client
482
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
568
        self.clients.sort(key=lambda c: c.properties["Name"])
483
569
        self.refresh()
484
 
    
 
570
 
485
571
    def remove_client(self, client, path=None):
486
572
        self.clients.remove(client)
487
573
        if path is None:
488
574
            path = client.proxy.object_path
489
575
        del self.clients_dict[path]
490
 
        if not self.clients_dict:
491
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
492
 
            # is completely emptied, we need to recreate it.
493
 
            self.clients = urwid.SimpleListWalker([])
494
 
            self.rebuild()
495
576
        self.refresh()
496
 
    
 
577
 
497
578
    def refresh(self):
498
579
        """Redraw the screen"""
499
580
        canvas = self.topwidget.render(self.size, focus=True)
500
581
        self.screen.draw_screen(self.size, canvas)
501
 
    
 
582
 
502
583
    def run(self):
503
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
 
504
630
        self.refresh()
505
 
        self._input_callback_tag = (gobject.io_add_watch
506
 
                                    (sys.stdin.fileno(),
507
 
                                     gobject.IO_IN,
508
 
                                     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)))
509
636
        self.main_loop.run()
510
637
        # Main loop has finished, we should close everything now
511
 
        gobject.source_remove(self._input_callback_tag)
512
 
        self.screen.stop()
513
 
    
 
638
        GLib.source_remove(self._input_callback_tag)
 
639
        with warnings.catch_warnings():
 
640
            warnings.simplefilter("ignore", BytesWarning)
 
641
            self.screen.stop()
 
642
 
514
643
    def stop(self):
515
644
        self.main_loop.quit()
516
 
    
 
645
        log.removeHandler(self.loghandler)
 
646
        log.propagate = self.orig_log_propagate
 
647
 
517
648
    def process_input(self, source, condition):
518
649
        keys = self.screen.get_input()
519
 
        translations = { u"ctrl n": u"down",      # Emacs
520
 
                         u"ctrl p": u"up",        # Emacs
521
 
                         u"ctrl v": u"page down", # Emacs
522
 
                         u"meta v": u"page up",   # Emacs
523
 
                         u" ": u"page down",      # less
524
 
                         u"f": u"page down",      # less
525
 
                         u"b": u"page up",        # less
526
 
                         u"j": u"down",           # vi
527
 
                         u"k": u"up",             # vi
528
 
                         }
 
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
                        }
529
660
        for key in keys:
530
661
            try:
531
662
                key = translations[key]
532
663
            except KeyError:    # :-)
533
664
                pass
534
 
            
535
 
            if key == u"q" or key == u"Q":
 
665
 
 
666
            if key == "q" or key == "Q":
536
667
                self.stop()
537
668
                break
538
 
            elif key == u"window resize":
 
669
            elif key == "window resize":
539
670
                self.size = self.screen.get_cols_rows()
540
671
                self.refresh()
541
 
            elif key == u"\f":  # Ctrl-L
 
672
            elif key == "ctrl l":
 
673
                self.screen.clear()
542
674
                self.refresh()
543
 
            elif key == u"l" or key == u"D":
 
675
            elif key == "l" or key == "D":
544
676
                self.toggle_log_display()
545
677
                self.refresh()
546
 
            elif key == u"w" or key == u"i":
 
678
            elif key == "w" or key == "i":
547
679
                self.change_log_display()
548
680
                self.refresh()
549
 
            elif key == u"?" or key == u"f1" or key == u"esc":
 
681
            elif key == "?" or key == "f1" or key == "esc":
550
682
                if not self.log_visible:
551
683
                    self.log_visible = True
552
684
                    self.rebuild()
553
 
                self.log_message_raw((u"bold",
554
 
                                      u"  ".
555
 
                                      join((u"q: Quit",
556
 
                                            u"?: Help",
557
 
                                            u"l: Log window toggle",
558
 
                                            u"TAB: Switch window",
559
 
                                            u"w: Wrap (log)"))))
560
 
                self.log_message_raw((u"bold",
561
 
                                      u"  "
562
 
                                      .join((u"Clients:",
563
 
                                             u"+: Enable",
564
 
                                             u"-: Disable",
565
 
                                             u"r: Remove",
566
 
                                             u"s: Start new checker",
567
 
                                             u"S: Stop checker",
568
 
                                             u"C: Checker OK",
569
 
                                             u"a: Approve",
570
 
                                             u"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
                                   ))))
571
704
                self.refresh()
572
 
            elif key == u"tab":
 
705
            elif key == "tab":
573
706
                if self.topwidget.get_focus() is self.logbox:
574
707
                    self.topwidget.set_focus(0)
575
708
                else:
576
709
                    self.topwidget.set_focus(self.logbox)
577
710
                self.refresh()
578
 
            #elif (key == u"end" or key == u"meta >" or key == u"G"
579
 
            #      or key == u">"):
580
 
            #    pass            # xxx end-of-buffer
581
 
            #elif (key == u"home" or key == u"meta <" or key == u"g"
582
 
            #      or key == u"<"):
583
 
            #    pass            # xxx beginning-of-buffer
584
 
            #elif key == u"ctrl e" or key == u"$":
585
 
            #    pass            # xxx move-end-of-line
586
 
            #elif key == u"ctrl a" or key == u"^":
587
 
            #    pass            # xxx move-beginning-of-line
588
 
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
589
 
            #    pass            # xxx left
590
 
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
591
 
            #    pass            # xxx right
592
 
            #elif key == u"a":
593
 
            #    pass            # scroll up log
594
 
            #elif key == u"z":
595
 
            #    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
596
736
            elif self.topwidget.selectable():
597
737
                self.topwidget.keypress(self.size, key)
598
738
                self.refresh()
599
739
        return True
600
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
 
601
755
ui = UserInterface()
602
756
try:
603
757
    ui.run()
604
 
except Exception, e:
605
 
    ui.log_message(unicode(e))
606
 
    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()
607
766
    raise