/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2024-11-22 20:28:54 UTC
  • mto: This revision was merged to the branch mainline in revision 412.
  • Revision ID: teddy@recompile.se-20241122202854-dycuf117byxhxl32
mandos-monitor: Avoid debug messages from urwid

Avoid debug messages from urwid.  Any logging output before the screen
has been set up will mangle the screen.

* mandos-monitor: When setting up logging, set urwid to only show log
  messages of level INFO or above.

(Thanks to an anonymous contributor for reporting this.)

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