/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: 2019-11-03 18:58:44 UTC
  • Revision ID: teddy@recompile.se-20191103185844-r5ghn595fdzefg4w
mandos-monitor: Formatting changes only

* mandos-monitor: Re-order imports and normally use double quotes
                  instead of single quotes for strings.

Show diffs side-by-side

added added

removed removed

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