/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

* mandos (Client.start_checker): Reworded comment.
 (MandosServer.handle_ipc): Removed dead code.

Show diffs side-by-side

added added

removed removed

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