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