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