/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2023-02-07 23:45:13 UTC
  • Revision ID: teddy@recompile.se-20230207234513-h7eyiq9yg9unc94z
Update Debian Policy version to 4.6.2; no other changes necessary.

* debian/control (Standards-Version): Change to "4.6.2".

Show diffs side-by-side

added added

removed removed

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