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