/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

Show diffs side-by-side

added added

removed removed

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