/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: 2018-02-06 20:03:50 UTC
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

Show diffs side-by-side

added added

removed removed

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