/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2019-07-15 01:59:36 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190715015936-09xieyg8ogdxvoi2
Debian package change: Add autopkgtest support

* Makefile (check): Run a few more superficial tests.
  (debian/control/[Source: mandos]/Testsuite): New; set to
                                               "autopkgtest".
  (debian/tests/control): New.

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