/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2024-09-22 17:38:57 UTC
  • Revision ID: teddy@recompile.se-20240922173857-rfhxneq4207tx9o0
Only use D-Bus when necessary

If *both* "use_dbus" and "zeroconf" are false, by either setting them
to False in mandos.conf or by using the --no-dbus and --no-zeroconf
options (and a port number or socket is specified), then we do not
need to connect to D-Bus at all.

From: Mike Klein <mike@kleinnet.com>
Signed-off-by: Teddy Hogeborn <teddy@recompile.se>

Show diffs side-by-side

added added

removed removed

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