/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2016-03-05 21:42:56 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 335.
  • 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
 
                                                ["last_checked_ok"])
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["interval"]))
146
 
        if self.last_checker_failed:
147
 
            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
148
176
                                               (1000,
149
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
150
181
    
151
182
    def checker_completed(self, exitstatus, condition, command):
152
183
        if exitstatus == 0:
153
 
            if self.last_checker_failed:
154
 
                self.last_checker_failed = False
155
 
                gobject.source_remove(self._update_timer_callback_tag)
156
 
                self._update_timer_callback_tag = None
157
 
            self.logger(u'Checker for client %s (command "%s")'
158
 
                        u' was successful'
159
 
                        % (self.properties[u"name"], command))
 
184
            self.logger('Checker for client {} (command "{}")'
 
185
                        ' succeeded'.format(self.properties["Name"],
 
186
                                            command), level=0)
160
187
            self.update()
161
188
            return
162
189
        # Checker failed
163
 
        if not self.last_checker_failed:
164
 
            self.last_checker_failed = True
165
 
            self._update_timer_callback_tag = (gobject.timeout_add
166
 
                                               (1000,
167
 
                                                self.update_timer))
168
190
        if os.WIFEXITED(condition):
169
 
            self.logger(u'Checker for client %s (command "%s")'
170
 
                        u' failed with exit code %s'
171
 
                        % (self.properties[u"name"], command,
172
 
                           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)))
173
195
        elif os.WIFSIGNALED(condition):
174
 
            self.logger(u'Checker for client %s (command "%s")'
175
 
                        u' was killed by signal %s'
176
 
                        % (self.properties[u"name"], command,
177
 
                           os.WTERMSIG(condition)))
178
 
        elif os.WCOREDUMP(condition):
179
 
            self.logger(u'Checker for client %s (command "%s")'
180
 
                        u' dumped core'
181
 
                        % (self.properties[u"name"], command))
182
 
        else:
183
 
            self.logger(u'Checker for client %s completed mysteriously')
 
196
            self.logger('Checker for client {} (command "{}") was'
 
197
                        ' killed by signal {}'
 
198
                        .format(self.properties["Name"], command,
 
199
                                os.WTERMSIG(condition)))
184
200
        self.update()
185
201
    
186
202
    def checker_started(self, command):
187
 
        #self.logger(u'Client %s started checker "%s"'
188
 
        #            % (self.properties[u"name"], unicode(command)))
189
 
        pass
 
203
        """Server signals that a checker started."""
 
204
        self.logger('Client {} started checker "{}"'
 
205
                    .format(self.properties["Name"],
 
206
                            command), level=0)
190
207
    
191
208
    def got_secret(self):
192
 
        self.logger(u'Client %s received its secret'
193
 
                    % self.properties[u"name"])
 
209
        self.logger('Client {} received its secret'
 
210
                    .format(self.properties["Name"]))
194
211
    
195
212
    def need_approval(self, timeout, default):
196
213
        if not default:
197
 
            message = u'Client %s needs approval within %s seconds'
 
214
            message = 'Client {} needs approval within {} seconds'
198
215
        else:
199
 
            message = u'Client %s will get its secret in %s seconds'
200
 
        self.logger(message
201
 
                    % (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))
202
219
    
203
220
    def rejected(self, reason):
204
 
        self.logger(u'Client %s was rejected; reason: %s'
205
 
                    % (self.properties[u"name"], reason))
 
221
        self.logger('Client {} was rejected; reason: {}'
 
222
                    .format(self.properties["Name"], reason))
206
223
    
207
224
    def selectable(self):
208
225
        """Make this a "selectable" widget.
209
226
        This overrides the method from urwid.FlowWidget."""
210
227
        return True
211
228
    
212
 
    def rows(self, (maxcol,), focus=False):
 
229
    def rows(self, maxcolrow, focus=False):
213
230
        """How many rows this widget will occupy might depend on
214
231
        whether we have focus or not.
215
232
        This overrides the method from urwid.FlowWidget"""
216
 
        return self.current_widget(focus).rows((maxcol,), focus=focus)
 
233
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
217
234
    
218
235
    def current_widget(self, focus=False):
219
236
        if focus or self.opened:
223
240
    def update(self):
224
241
        "Called when what is visible on the screen should be updated."
225
242
        # How to add standout mode to a style
226
 
        with_standout = { u"normal": u"standout",
227
 
                          u"bold": u"bold-standout",
228
 
                          u"underline-blink":
229
 
                              u"underline-blink-standout",
230
 
                          u"bold-underline-blink":
231
 
                              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",
232
249
                          }
233
 
 
 
250
        
234
251
        # Rebuild focus and non-focus widgets using current properties
235
 
 
 
252
        
236
253
        # Base part of a client. Name!
237
 
        base = (u'%(name)s: '
238
 
                      % {u"name": self.properties[u"name"]})
239
 
        if not self.properties[u"enabled"]:
240
 
            message = u"DISABLED"
241
 
        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"]:
242
259
            timeout = datetime.timedelta(milliseconds
243
 
                                         = self.properties[u"timeout"])
244
 
            last_ok = isoformat_to_datetime(
245
 
                max((self.properties["last_checked_ok"]
246
 
                     or self.properties["created"]),
247
 
                    self.properties[u"last_enabled"]))
248
 
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
249
 
            message = (u'A checker has failed! Time until client gets diabled: %s'
250
 
                           % unicode(timer).rsplit(".", 1)[0])
251
 
        elif self.properties[u"approved_pending"]:
252
 
            if self.properties[u"approved_by_default"]:
253
 
                message = u"Connection established to client. (d)eny?"
254
 
            else:
255
 
                message = u"Seeks approval to send secret. (a)pprove?"
 
260
                                         = self.properties
 
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)
256
290
        else:
257
 
            message = u"enabled"
258
 
        self._text = "%s%s" % (base, message)
259
 
            
 
291
            message = "enabled"
 
292
            self.using_timer(False)
 
293
        self._text = "{}{}".format(base, message)
 
294
        
260
295
        if not urwid.supports_unicode():
261
296
            self._text = self._text.encode("ascii", "replace")
262
 
        textlist = [(u"normal", self._text)]
 
297
        textlist = [("normal", self._text)]
263
298
        self._text_widget.set_text(textlist)
264
299
        self._focus_text_widget.set_text([(with_standout[text[0]],
265
300
                                           text[1])
274
309
            self.update_hook()
275
310
    
276
311
    def update_timer(self):
277
 
        "called by gobject"
 
312
        """called by GObject. Will indefinitely loop until
 
313
        GObject.source_remove() on tag is called"""
278
314
        self.update()
279
315
        return True             # Keep calling this
280
316
    
281
 
    def delete(self):
 
317
    def delete(self, **kwargs):
282
318
        if self._update_timer_callback_tag is not None:
283
 
            gobject.source_remove(self._update_timer_callback_tag)
 
319
            GObject.source_remove(self._update_timer_callback_tag)
284
320
            self._update_timer_callback_tag = None
 
321
        for match in self.match_objects:
 
322
            match.remove()
 
323
        self.match_objects = ()
285
324
        if self.delete_hook is not None:
286
325
            self.delete_hook(self)
 
326
        return super(MandosClientWidget, self).delete(**kwargs)
287
327
    
288
 
    def render(self, (maxcol,), focus=False):
 
328
    def render(self, maxcolrow, focus=False):
289
329
        """Render differently if we have focus.
290
330
        This overrides the method from urwid.FlowWidget"""
291
 
        return self.current_widget(focus).render((maxcol,),
 
331
        return self.current_widget(focus).render(maxcolrow,
292
332
                                                 focus=focus)
293
333
    
294
 
    def keypress(self, (maxcol,), key):
 
334
    def keypress(self, maxcolrow, key):
295
335
        """Handle keys.
296
336
        This overrides the method from urwid.FlowWidget"""
297
 
        if key == u"+":
298
 
            self.proxy.Enable(dbus_interface = client_interface)
299
 
        elif key == u"-":
300
 
            self.proxy.Disable(dbus_interface = client_interface)
301
 
        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":
302
346
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
303
 
                               dbus_interface = client_interface)
304
 
        elif key == u"d":
 
347
                               dbus_interface = client_interface,
 
348
                               ignore_reply=True)
 
349
        elif key == "d":
305
350
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
306
 
                                  dbus_interface = client_interface)
307
 
        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":
308
354
            self.server_proxy_object.RemoveClient(self.proxy
309
 
                                                  .object_path)
310
 
        elif key == u"s":
311
 
            self.proxy.StartChecker(dbus_interface = client_interface)
312
 
        elif key == u"S":
313
 
            self.proxy.StopChecker(dbus_interface = client_interface)
314
 
        elif key == u"C":
315
 
            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)
316
368
        # xxx
317
 
#         elif key == u"p" or key == "=":
 
369
#         elif key == "p" or key == "=":
318
370
#             self.proxy.pause()
319
 
#         elif key == u"u" or key == ":":
 
371
#         elif key == "u" or key == ":":
320
372
#             self.proxy.unpause()
321
 
#         elif key == u"RET":
 
373
#         elif key == "RET":
322
374
#             self.open()
323
 
#        elif key == u"+":
324
 
#            self.proxy.Approve(True)
325
 
#        elif key == u"-":
326
 
#            self.proxy.Approve(False)
327
375
        else:
328
376
            return key
329
377
    
330
 
    def property_changed(self, property=None, value=None,
331
 
                         *args, **kwargs):
332
 
        """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.
333
380
        This overrides the method from MandosClientPropertyCache"""
334
 
        property_name = unicode(property)
335
 
        old_value = self.properties.get(property_name)
336
 
        super(MandosClientWidget, self).property_changed(
337
 
            property=property, value=value, *args, **kwargs)
338
 
        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):
339
387
            self.update()
340
388
 
341
389
 
344
392
    "down" key presses, thus not allowing any containing widgets to
345
393
    use them as an excuse to shift focus away from this widget.
346
394
    """
347
 
    def keypress(self, (maxcol, maxrow), key):
348
 
        ret = super(ConstrainedListBox, self).keypress((maxcol, maxrow), key)
349
 
        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"):
350
398
            return
351
399
        return ret
352
400
 
355
403
    """This is the entire user interface - the whole screen
356
404
    with boxes, lists of client widgets, etc.
357
405
    """
358
 
    def __init__(self, max_log_length=1000):
 
406
    def __init__(self, max_log_length=1000, log_level=1):
359
407
        DBusGMainLoop(set_as_default=True)
360
408
        
361
409
        self.screen = urwid.curses_display.Screen()
362
410
        
363
411
        self.screen.register_palette((
364
 
                (u"normal",
365
 
                 u"default", u"default", None),
366
 
                (u"bold",
367
 
                 u"default", u"default", u"bold"),
368
 
                (u"underline-blink",
369
 
                 u"default", u"default", u"underline"),
370
 
                (u"standout",
371
 
                 u"default", u"default", u"standout"),
372
 
                (u"bold-underline-blink",
373
 
                 u"default", u"default", (u"bold", u"underline")),
374
 
                (u"bold-standout",
375
 
                 u"default", u"default", (u"bold", u"standout")),
376
 
                (u"underline-blink-standout",
377
 
                 u"default", u"default", (u"underline", u"standout")),
378
 
                (u"bold-underline-blink-standout",
379
 
                 u"default", u"default", (u"bold", u"underline",
380
 
                                          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"),
381
430
                ))
382
431
        
383
432
        if urwid.supports_unicode():
384
 
            self.divider = u"─" # \u2500
385
 
            #self.divider = u"━" # \u2501
 
433
            self.divider = "─" # \u2500
 
434
            #self.divider = "━" # \u2501
386
435
        else:
387
 
            #self.divider = u"-" # \u002d
388
 
            self.divider = u"_" # \u005f
 
436
            #self.divider = "-" # \u002d
 
437
            self.divider = "_" # \u005f
389
438
        
390
439
        self.screen.start()
391
440
        
398
447
        self.log = []
399
448
        self.max_log_length = max_log_length
400
449
        
 
450
        self.log_level = log_level
 
451
        
401
452
        # We keep a reference to the log widget so we can remove it
402
453
        # from the ListWalker without it getting destroyed
403
454
        self.logbox = ConstrainedListBox(self.log)
405
456
        # This keeps track of whether self.uilist currently has
406
457
        # self.logbox in it or not
407
458
        self.log_visible = True
408
 
        self.log_wrap = u"any"
 
459
        self.log_wrap = "any"
409
460
        
410
461
        self.rebuild()
411
 
        self.log_message_raw((u"bold",
412
 
                              u"Mandos Monitor version " + version))
413
 
        self.log_message_raw((u"bold",
414
 
                              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"))
415
466
        
416
467
        self.busname = domain + '.Mandos'
417
 
        self.main_loop = gobject.MainLoop()
418
 
        self.bus = dbus.SystemBus()
419
 
        mandos_dbus_objc = self.bus.get_object(
420
 
            self.busname, u"/", follow_name_owner_changes=True)
421
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
422
 
                                          dbus_interface
423
 
                                          = server_interface)
424
 
        try:
425
 
            mandos_clients = (self.mandos_serv
426
 
                              .GetAllClientsWithProperties())
427
 
        except dbus.exceptions.DBusException:
428
 
            mandos_clients = dbus.Dictionary()
429
 
        
430
 
        (self.mandos_serv
431
 
         .connect_to_signal(u"ClientRemoved",
432
 
                            self.find_and_remove_client,
433
 
                            dbus_interface=server_interface,
434
 
                            byte_arrays=True))
435
 
        (self.mandos_serv
436
 
         .connect_to_signal(u"ClientAdded",
437
 
                            self.add_new_client,
438
 
                            dbus_interface=server_interface,
439
 
                            byte_arrays=True))
440
 
        (self.mandos_serv
441
 
         .connect_to_signal(u"ClientNotFound",
442
 
                            self.client_not_found,
443
 
                            dbus_interface=server_interface,
444
 
                            byte_arrays=True))
445
 
        for path, client in mandos_clients.iteritems():
446
 
            client_proxy_object = self.bus.get_object(self.busname,
447
 
                                                      path)
448
 
            self.add_client(MandosClientWidget(server_proxy_object
449
 
                                               =self.mandos_serv,
450
 
                                               proxy_object
451
 
                                               =client_proxy_object,
452
 
                                               properties=client,
453
 
                                               update_hook
454
 
                                               =self.refresh,
455
 
                                               delete_hook
456
 
                                               =self.remove_client,
457
 
                                               logger
458
 
                                               =self.log_message),
459
 
                            path=path)
 
468
        self.main_loop = GObject.MainLoop()
460
469
    
461
470
    def client_not_found(self, fingerprint, address):
462
 
        self.log_message((u"Client with address %s and fingerprint %s"
463
 
                          u" could not be found" % (address,
464
 
                                                    fingerprint)))
 
471
        self.log_message("Client with address {} and fingerprint {}"
 
472
                         " could not be found"
 
473
                         .format(address, fingerprint))
465
474
    
466
475
    def rebuild(self):
467
476
        """This rebuilds the User Interface.
468
477
        Call this when the widget layout needs to change"""
469
478
        self.uilist = []
470
479
        #self.uilist.append(urwid.ListBox(self.clients))
471
 
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.clients),
 
480
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
 
481
                                                          clients),
472
482
                                       #header=urwid.Divider(),
473
483
                                       header=None,
474
 
                                       footer=urwid.Divider(div_char=self.divider)))
 
484
                                       footer=
 
485
                                       urwid.Divider(div_char=
 
486
                                                     self.divider)))
475
487
        if self.log_visible:
476
488
            self.uilist.append(self.logbox)
477
 
            pass
478
489
        self.topwidget = urwid.Pile(self.uilist)
479
490
    
480
 
    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
481
495
        timestamp = datetime.datetime.now().isoformat()
482
 
        self.log_message_raw(timestamp + u": " + message)
 
496
        self.log_message_raw("{}: {}".format(timestamp, message),
 
497
                             level=level)
483
498
    
484
 
    def log_message_raw(self, markup):
 
499
    def log_message_raw(self, markup, level=1):
485
500
        """Add a log message to the log buffer."""
 
501
        if level < self.log_level:
 
502
            return
486
503
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
487
504
        if (self.max_log_length
488
505
            and len(self.log) > self.max_log_length):
489
506
            del self.log[0:len(self.log)-self.max_log_length-1]
490
507
        self.logbox.set_focus(len(self.logbox.body.contents),
491
 
                              coming_from=u"above")
 
508
                              coming_from="above")
492
509
        self.refresh()
493
510
    
494
511
    def toggle_log_display(self):
495
512
        """Toggle visibility of the log buffer."""
496
513
        self.log_visible = not self.log_visible
497
514
        self.rebuild()
498
 
        self.log_message(u"Log visibility changed to: "
499
 
                         + unicode(self.log_visible))
 
515
        self.log_message("Log visibility changed to: {}"
 
516
                         .format(self.log_visible), level=0)
500
517
    
501
518
    def change_log_display(self):
502
519
        """Change type of log display.
503
520
        Currently, this toggles wrapping of text lines."""
504
 
        if self.log_wrap == u"clip":
505
 
            self.log_wrap = u"any"
 
521
        if self.log_wrap == "clip":
 
522
            self.log_wrap = "any"
506
523
        else:
507
 
            self.log_wrap = u"clip"
 
524
            self.log_wrap = "clip"
508
525
        for textwidget in self.log:
509
526
            textwidget.set_wrap_mode(self.log_wrap)
510
 
        self.log_message(u"Wrap mode: " + self.log_wrap)
 
527
        self.log_message("Wrap mode: {}".format(self.log_wrap),
 
528
                         level=0)
511
529
    
512
 
    def find_and_remove_client(self, path, name):
513
 
        """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.
514
532
        
515
 
        This is connected to the ClientRemoved signal from the
 
533
        This is connected to the InterfacesRemoved signal from the
516
534
        Mandos server object."""
 
535
        if client_interface not in interfaces:
 
536
            # Not a Mandos client object; ignore
 
537
            return
517
538
        try:
518
539
            client = self.clients_dict[path]
519
540
        except KeyError:
520
541
            # not found?
 
542
            self.log_message("Unknown client {!r} removed"
 
543
                             .format(path))
521
544
            return
522
 
        self.remove_client(client, path)
 
545
        client.delete()
523
546
    
524
 
    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
525
556
        client_proxy_object = self.bus.get_object(self.busname, path)
526
557
        self.add_client(MandosClientWidget(server_proxy_object
527
558
                                           =self.mandos_serv,
532
563
                                           delete_hook
533
564
                                           =self.remove_client,
534
565
                                           logger
535
 
                                           =self.log_message),
 
566
                                           =self.log_message,
 
567
                                           properties
 
568
                                           = dict(ifs_and_props[
 
569
                                               client_interface])),
536
570
                        path=path)
537
571
    
538
572
    def add_client(self, client, path=None):
540
574
        if path is None:
541
575
            path = client.proxy.object_path
542
576
        self.clients_dict[path] = client
543
 
        self.clients.sort(None, lambda c: c.properties[u"name"])
 
577
        self.clients.sort(key=lambda c: c.properties["Name"])
544
578
        self.refresh()
545
579
    
546
580
    def remove_client(self, client, path=None):
548
582
        if path is None:
549
583
            path = client.proxy.object_path
550
584
        del self.clients_dict[path]
551
 
        if not self.clients_dict:
552
 
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
553
 
            # is completely emptied, we need to recreate it.
554
 
            self.clients = urwid.SimpleListWalker([])
555
 
            self.rebuild()
556
585
        self.refresh()
557
586
    
558
587
    def refresh(self):
562
591
    
563
592
    def run(self):
564
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
        
565
642
        self.refresh()
566
 
        self._input_callback_tag = (gobject.io_add_watch
 
643
        self._input_callback_tag = (GObject.io_add_watch
567
644
                                    (sys.stdin.fileno(),
568
 
                                     gobject.IO_IN,
 
645
                                     GObject.IO_IN,
569
646
                                     self.process_input))
570
647
        self.main_loop.run()
571
648
        # Main loop has finished, we should close everything now
572
 
        gobject.source_remove(self._input_callback_tag)
 
649
        GObject.source_remove(self._input_callback_tag)
573
650
        self.screen.stop()
574
651
    
575
652
    def stop(self):
577
654
    
578
655
    def process_input(self, source, condition):
579
656
        keys = self.screen.get_input()
580
 
        translations = { u"ctrl n": u"down",      # Emacs
581
 
                         u"ctrl p": u"up",        # Emacs
582
 
                         u"ctrl v": u"page down", # Emacs
583
 
                         u"meta v": u"page up",   # Emacs
584
 
                         u" ": u"page down",      # less
585
 
                         u"f": u"page down",      # less
586
 
                         u"b": u"page up",        # less
587
 
                         u"j": u"down",           # vi
588
 
                         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
589
666
                         }
590
667
        for key in keys:
591
668
            try:
593
670
            except KeyError:    # :-)
594
671
                pass
595
672
            
596
 
            if key == u"q" or key == u"Q":
 
673
            if key == "q" or key == "Q":
597
674
                self.stop()
598
675
                break
599
 
            elif key == u"window resize":
 
676
            elif key == "window resize":
600
677
                self.size = self.screen.get_cols_rows()
601
678
                self.refresh()
602
 
            elif key == u"\f":  # Ctrl-L
 
679
            elif key == "ctrl l":
 
680
                self.screen.clear()
603
681
                self.refresh()
604
 
            elif key == u"l" or key == u"D":
 
682
            elif key == "l" or key == "D":
605
683
                self.toggle_log_display()
606
684
                self.refresh()
607
 
            elif key == u"w" or key == u"i":
 
685
            elif key == "w" or key == "i":
608
686
                self.change_log_display()
609
687
                self.refresh()
610
 
            elif key == u"?" or key == u"f1" or key == u"esc":
 
688
            elif key == "?" or key == "f1" or key == "esc":
611
689
                if not self.log_visible:
612
690
                    self.log_visible = True
613
691
                    self.rebuild()
614
 
                self.log_message_raw((u"bold",
615
 
                                      u"  ".
616
 
                                      join((u"q: Quit",
617
 
                                            u"?: Help",
618
 
                                            u"l: Log window toggle",
619
 
                                            u"TAB: Switch window",
620
 
                                            u"w: Wrap (log)"))))
621
 
                self.log_message_raw((u"bold",
622
 
                                      u"  "
623
 
                                      .join((u"Clients:",
624
 
                                             u"+: Enable",
625
 
                                             u"-: Disable",
626
 
                                             u"r: Remove",
627
 
                                             u"s: Start new checker",
628
 
                                             u"S: Stop checker",
629
 
                                             u"C: Checker OK",
630
 
                                             u"a: Approve",
631
 
                                             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"))))
632
712
                self.refresh()
633
 
            elif key == u"tab":
 
713
            elif key == "tab":
634
714
                if self.topwidget.get_focus() is self.logbox:
635
715
                    self.topwidget.set_focus(0)
636
716
                else:
637
717
                    self.topwidget.set_focus(self.logbox)
638
718
                self.refresh()
639
 
            #elif (key == u"end" or key == u"meta >" or key == u"G"
640
 
            #      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 == ">"):
641
728
            #    pass            # xxx end-of-buffer
642
 
            #elif (key == u"home" or key == u"meta <" or key == u"g"
643
 
            #      or key == u"<"):
 
729
            #elif (key == "home" or key == "meta <" or key == "g"
 
730
            #      or key == "<"):
644
731
            #    pass            # xxx beginning-of-buffer
645
 
            #elif key == u"ctrl e" or key == u"$":
 
732
            #elif key == "ctrl e" or key == "$":
646
733
            #    pass            # xxx move-end-of-line
647
 
            #elif key == u"ctrl a" or key == u"^":
 
734
            #elif key == "ctrl a" or key == "^":
648
735
            #    pass            # xxx move-beginning-of-line
649
 
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
 
736
            #elif key == "ctrl b" or key == "meta (" or key == "h":
650
737
            #    pass            # xxx left
651
 
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
 
738
            #elif key == "ctrl f" or key == "meta )" or key == "l":
652
739
            #    pass            # xxx right
653
 
            #elif key == u"a":
 
740
            #elif key == "a":
654
741
            #    pass            # scroll up log
655
 
            #elif key == u"z":
 
742
            #elif key == "z":
656
743
            #    pass            # scroll down log
657
744
            elif self.topwidget.selectable():
658
745
                self.topwidget.keypress(self.size, key)
662
749
ui = UserInterface()
663
750
try:
664
751
    ui.run()
665
 
except Exception, e:
666
 
    ui.log_message(unicode(e))
 
752
except KeyboardInterrupt:
 
753
    ui.screen.stop()
 
754
except Exception as e:
 
755
    ui.log_message(str(e))
667
756
    ui.screen.stop()
668
757
    raise