/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2016-03-09 21:23:21 UTC
  • Revision ID: teddy@recompile.se-20160309212321-2qlkzj9tecepc8xq
Server: Add Python 3 compatibility

Add Python 3 compatibility by not using the python-avahi module.  Also
fix miscellaneous things which differs in Python 3.  Especially hard
to fix is loading and saving clients data between Python 3 and 2,
since pickle formats have problems with strings.

* INSTALL: Remove python-avahi (and change python-gobject to
  python-gi, which is preferred now).
* debian/control (Source: mandos/Build-Depends-Indep): Remove
  "python-avahi".
* mandos: Wrap future_builtins import in try-except clause.  Do not
  import avahi module.  Use codecs.decode(..., "base64) instead of
  .decode("base64).  Use .keys(), .values(), and .items() instead of
  .iterkeys(), .itervalues(), and .iteritems().
  (alternate_dbus_interfaces/wrapper): Python 3 still requires the
  "black magic", but luckily it still works.  The Python 3 type()
  constructor requires first argument to be a string, not a byte
  string.
  (copy_function): New.  Use throughout.
  (Avahi, avahi): New class and global variable.
  (GnuTLS._need_version): Changed to be a byte string.
  (main): Decode byte strings loaded from pickle file.
  (main/cleanup): Dump using pickle prototoc 2 which Python 2 can
  read.

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