/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: 2014-02-16 02:42:42 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 309.
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

Show diffs side-by-side

added added

removed removed

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