/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: 2016-03-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

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