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