/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-08-25 17:06:42 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 350.
  • Revision ID: teddy@recompile.se-20160825170642-n4ough8ql1145zak
PEP8 compliance: mandos-monitor

* mandos-monitor: Add PEP8 compliance (as per the "pycodestyle" tool).

Show diffs side-by-side

added added

removed removed

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