/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

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