/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

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