/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

More consistent terminology: Clients are no longer "invalid" - they
are "disabled".  All code and documentation changed to reflect this.

D=Bus API change: The "properties" argument was removed from the
"ClientAdded" signal on interface "se.bsnet.fukt.Mandos".  All code in
both "mandos" and "mandos-monitor" changed to reflect this.

* mandos: Replaced "with closing(F)" with simply "with F" in all
          places where F is a file object.
  (Client.still_valid): Removed.  All callers changed to look at
                        "Client.enabled" instead.
  (dbus_service_property): Check for unsupported signatures with the
                           "byte_arrays" option.
  (DBusObjectWithProperties.Set): - '' -
  (ClientHandler.handle): Use the reverse pipe to receive the
                          "Client.enabled" attribute instead of the
                          now-removed "Client.still_valid()" method.
  (ForkingMixInWithPipe): Renamed to "ForkingMixInWithPipes" (all
                          users changed).  Now also create a reverse
                          pipe for sending data to the child process.
  (ForkingMixInWithPipes.add_pipe): Now takes two pipe fd's as
                                    arguments.  All callers changed.
  (IPv6_TCPServer.handle_ipc): Take an additional "reply_fd" argument
                               (all callers changed).  Close the reply
                               pipe when the child data pipe is
                               closed.  New "GETATTR" IPC method; will
                               pickle client attribute and send it
                               over the reply pipe FD.
  (MandosDBusService.ClientAdded): Removed "properties" argument.  All
                                   emitters changed.
* mandos-clients.conf.xml (DESCRIPTION, OPTIONS): Use
                                                  "enabled/disabled"
                                                  terminology.
* mandos-ctl: Option "--is-valid" renamed to "--is-enabled".
* mandos-monitor: Enable user locale.  Try to log exceptions.
  (MandosClientPropertyCache.__init__): Removed "properties" argument.
                                        All callers changed.
  (UserInterface.add_new_client): Remove "properties" argument.  All
                                  callers changed.  Supply "logger"
                                  argument to MandosClientWidget().
  (UserInterface.add_client): New "logger" argument.  All callers
                              changed.
* mandos.xml (BUGS, SECURITY/CLIENTS): Use "enabled/disabled"
                                       terminology.

Show diffs side-by-side

added added

removed removed

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