/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: 2019-11-03 18:44:41 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20191103184441-1vhjuf06hjqgfohh
mandos-monitor: Use Python's standard loggging module

* mandos-monitor: Use Python's standard loggging module, also for
                  warnings.  Suppress BytesWarning from urwid when
                  exiting.
  (log): New global logger object.  This replaces UserInterface
        log_message().
  (MandosClientWidget.__init__): Remove "logger" argument.
  (MandosClientWidget.using_timer): Wrap self.update_timer using new
                                    glib_safely() function.
  (glib_safely): New function to log any exceptions instead of letting
                 exceptions propagate up to GLib.
  (UserInterface.__init__): Remove "log_level" argument.  Set new
                            "loghandler" attribute, instance of new
                            "UILogHandler".
  (UserInterface.log_message): Removed.
  (UserInterface.log_message_raw): Renamed to "add_log_line"; all
                                   callers changed.  Also fix
                                   off-by-one error in max_log_length
                                   logic.
  (UserInterface.run): Add self.loghandler to logger "log". Wrap
                       self.process_input using new glib_safely()
                       function.
  (UserInterface.stop): Remove self.loghandler from logger "log".
  (UserInterface.process_input): Make verbosity toggle affect log
                                 level of logger "log".
  (UILogHandler): New.

Show diffs side-by-side

added added

removed removed

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