/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-13 00:37:02 UTC
  • Revision ID: teddy@recompile.se-20160313003702-dulwtwt8ilpojra9
Server: Fix bug where it did not exit timely on signals

Use GLib.unix_signal_add() instead of signal.signal() to catch
signals; this will allow GLib to do its internal magic with signal
file descriptors.  (GLib does not handle signals properly otherwise.)
The function unix_signal_add() requires GLib 2.30 or later, which was
not required by PyGobject until version 3.7.1, so depend on this.

* INSTALL (Mandos Server): Document dependency on PyGObject 3.7.1
* mandos (main): Use GLib.unix_signal_add instead of signal.signal.
* init.d-mandos (do_stop): Remove workaround.
* mandos.service ([Service]): - '' -

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