/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 at recompile
  • Date: 2020-02-07 20:53:34 UTC
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

Show diffs side-by-side

added added

removed removed

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