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