/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: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

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
 
# 
24
 
 
 
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.recompile'
53
 
server_interface = domain + '.Mandos'
54
 
client_interface = domain + '.Mandos.Client'
55
 
version = "1.5.0"
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.16"
 
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:
 
180
        if flag and self._update_timer_callback_tag is None:
203
181
            # 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)
 
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)
209
187
            self._update_timer_callback_tag = None
210
 
    
 
188
 
211
189
    def checker_completed(self, exitstatus, condition, command):
212
190
        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))
 
191
            log.debug('Checker for client %s (command "%s")'
 
192
                      " succeeded", self.properties["Name"], command)
219
193
            self.update()
220
194
            return
221
195
        # Checker failed
222
 
        if not self.last_checker_failed:
223
 
            self.last_checker_failed = True
224
 
            self.using_timer(True)
225
196
        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)))
 
197
            log.info('Checker for client %s (command "%s") failed'
 
198
                     " with exit code %d", self.properties["Name"],
 
199
                     command, os.WEXITSTATUS(condition))
230
200
        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')
 
201
            log.info('Checker for client %s (command "%s") was'
 
202
                     " killed by signal %d", self.properties["Name"],
 
203
                     command, os.WTERMSIG(condition))
242
204
        self.update()
243
 
    
 
205
 
244
206
    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
 
    
 
207
        """Server signals that a checker started."""
 
208
        log.debug('Client %s started checker "%s"',
 
209
                  self.properties["Name"], command)
 
210
 
251
211
    def got_secret(self):
252
 
        self.last_checker_failed = False
253
 
        self.logger('Client %s received its secret'
254
 
                    % self.properties["Name"])
255
 
    
 
212
        log.info("Client %s received its secret",
 
213
                 self.properties["Name"])
 
214
 
256
215
    def need_approval(self, timeout, default):
257
216
        if not default:
258
 
            message = 'Client %s needs approval within %s seconds'
 
217
            message = "Client %s needs approval within %f seconds"
259
218
        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
 
    
 
219
            message = "Client %s will get its secret in %f seconds"
 
220
        log.info(message, self.properties["Name"], timeout/1000)
 
221
 
265
222
    def rejected(self, reason):
266
 
        self.logger('Client %s was rejected; reason: %s'
267
 
                    % (self.properties["Name"], reason))
268
 
    
 
223
        log.info("Client %s was rejected; reason: %s",
 
224
                 self.properties["Name"], reason)
 
225
 
269
226
    def selectable(self):
270
227
        """Make this a "selectable" widget.
271
228
        This overrides the method from urwid.FlowWidget."""
272
229
        return True
273
 
    
 
230
 
274
231
    def rows(self, maxcolrow, focus=False):
275
232
        """How many rows this widget will occupy might depend on
276
233
        whether we have focus or not.
277
234
        This overrides the method from urwid.FlowWidget"""
278
235
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
279
 
    
 
236
 
280
237
    def current_widget(self, focus=False):
281
238
        if focus or self.opened:
282
239
            return self._focus_widget
283
240
        return self._widget
284
 
    
 
241
 
285
242
    def update(self):
286
243
        "Called when what is visible on the screen should be updated."
287
244
        # 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
 
                          }
 
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
                         }
295
252
 
296
253
        # Rebuild focus and non-focus widgets using current properties
297
254
 
298
255
        # Base part of a client. Name!
299
 
        base = ('%(name)s: '
300
 
                      % {"name": self.properties["Name"]})
 
256
        base = "{name}: ".format(name=self.properties["Name"])
301
257
        if not self.properties["Enabled"]:
302
258
            message = "DISABLED"
 
259
            self.using_timer(False)
303
260
        elif self.properties["ApprovalPending"]:
304
 
            timeout = datetime.timedelta(milliseconds
305
 
                                         = self.properties
306
 
                                         ["ApprovalDelay"])
 
261
            timeout = datetime.timedelta(
 
262
                milliseconds=self.properties["ApprovalDelay"])
307
263
            last_approval_request = isoformat_to_datetime(
308
264
                self.properties["LastApprovalRequest"])
309
265
            if last_approval_request is not None:
310
 
                timer = timeout - (datetime.datetime.utcnow()
311
 
                                   - last_approval_request)
 
266
                timer = max(timeout - (datetime.datetime.utcnow()
 
267
                                       - last_approval_request),
 
268
                            datetime.timedelta())
312
269
            else:
313
270
                timer = datetime.timedelta()
314
271
            if self.properties["ApprovedByDefault"]:
315
 
                message = "Approval in %s. (d)eny?"
 
272
                message = "Approval in {}. (d)eny?"
316
273
            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
 
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
321
279
            expires = self.properties["Expires"]
322
280
            if expires == "":
323
281
                timer = datetime.timedelta(0)
324
282
            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])
 
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)
331
291
        else:
332
292
            message = "enabled"
333
 
        self._text = "%s%s" % (base, message)
334
 
            
 
293
            self.using_timer(False)
 
294
        self._text = "{}{}".format(base, message)
 
295
 
335
296
        if not urwid.supports_unicode():
336
297
            self._text = self._text.encode("ascii", "replace")
337
298
        textlist = [("normal", self._text)]
347
308
        # Run update hook, if any
348
309
        if self.update_hook is not None:
349
310
            self.update_hook()
350
 
    
 
311
 
351
312
    def update_timer(self):
352
 
        """called by gobject. Will indefinitely loop until
353
 
        gobject.source_remove() on tag is called"""
 
313
        """called by GLib. Will indefinitely loop until
 
314
        GLib.source_remove() on tag is called
 
315
        """
354
316
        self.update()
355
317
        return True             # Keep calling this
356
 
    
357
 
    def delete(self, *args, **kwargs):
 
318
 
 
319
    def delete(self, **kwargs):
358
320
        if self._update_timer_callback_tag is not None:
359
 
            gobject.source_remove(self._update_timer_callback_tag)
 
321
            GLib.source_remove(self._update_timer_callback_tag)
360
322
            self._update_timer_callback_tag = None
361
323
        for match in self.match_objects:
362
324
            match.remove()
363
325
        self.match_objects = ()
364
326
        if self.delete_hook is not None:
365
327
            self.delete_hook(self)
366
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
367
 
    
 
328
        return super(MandosClientWidget, self).delete(**kwargs)
 
329
 
368
330
    def render(self, maxcolrow, focus=False):
369
331
        """Render differently if we have focus.
370
332
        This overrides the method from urwid.FlowWidget"""
371
333
        return self.current_widget(focus).render(maxcolrow,
372
334
                                                 focus=focus)
373
 
    
 
335
 
374
336
    def keypress(self, maxcolrow, key):
375
337
        """Handle keys.
376
338
        This overrides the method from urwid.FlowWidget"""
377
339
        if key == "+":
378
 
            self.proxy.Enable(dbus_interface = client_interface,
379
 
                              ignore_reply=True)
 
340
            self.proxy.Set(client_interface, "Enabled",
 
341
                           dbus.Boolean(True), ignore_reply=True,
 
342
                           dbus_interface=dbus.PROPERTIES_IFACE)
380
343
        elif key == "-":
381
 
            self.proxy.Disable(dbus_interface = client_interface,
382
 
                               ignore_reply=True)
 
344
            self.proxy.Set(client_interface, "Enabled", False,
 
345
                           ignore_reply=True,
 
346
                           dbus_interface=dbus.PROPERTIES_IFACE)
383
347
        elif key == "a":
384
348
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
385
 
                               dbus_interface = client_interface,
 
349
                               dbus_interface=client_interface,
386
350
                               ignore_reply=True)
387
351
        elif key == "d":
388
352
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
389
 
                                  dbus_interface = client_interface,
 
353
                               dbus_interface=client_interface,
390
354
                               ignore_reply=True)
391
355
        elif key == "R" or key == "_" or key == "ctrl k":
392
356
            self.server_proxy_object.RemoveClient(self.proxy
393
357
                                                  .object_path,
394
358
                                                  ignore_reply=True)
395
359
        elif key == "s":
396
 
            self.proxy.StartChecker(dbus_interface = client_interface,
397
 
                                    ignore_reply=True)
 
360
            self.proxy.Set(client_interface, "CheckerRunning",
 
361
                           dbus.Boolean(True), ignore_reply=True,
 
362
                           dbus_interface=dbus.PROPERTIES_IFACE)
398
363
        elif key == "S":
399
 
            self.proxy.StopChecker(dbus_interface = client_interface,
400
 
                                   ignore_reply=True)
 
364
            self.proxy.Set(client_interface, "CheckerRunning",
 
365
                           dbus.Boolean(False), ignore_reply=True,
 
366
                           dbus_interface=dbus.PROPERTIES_IFACE)
401
367
        elif key == "C":
402
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
368
            self.proxy.CheckedOK(dbus_interface=client_interface,
403
369
                                 ignore_reply=True)
404
370
        # xxx
405
371
#         elif key == "p" or key == "=":
410
376
#             self.open()
411
377
        else:
412
378
            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.
 
379
 
 
380
    def properties_changed(self, interface, properties, invalidated):
 
381
        """Call self.update() if any properties changed.
417
382
        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:
 
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):
423
389
            self.update()
424
390
 
425
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
 
426
402
class ConstrainedListBox(urwid.ListBox):
427
403
    """Like a normal urwid.ListBox, but will consume all "up" or
428
404
    "down" key presses, thus not allowing any containing widgets to
429
405
    use them as an excuse to shift focus away from this widget.
430
406
    """
431
 
    def keypress(self, maxcolrow, key):
432
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
407
    def keypress(self, *args, **kwargs):
 
408
        ret = (super(ConstrainedListBox, self)
 
409
               .keypress(*args, **kwargs))
433
410
        if ret in ("up", "down"):
434
411
            return
435
412
        return ret
436
413
 
437
414
 
438
 
class UserInterface(object):
 
415
class UserInterface:
439
416
    """This is the entire user interface - the whole screen
440
417
    with boxes, lists of client widgets, etc.
441
418
    """
442
419
    def __init__(self, max_log_length=1000):
443
420
        DBusGMainLoop(set_as_default=True)
444
 
        
 
421
 
445
422
        self.screen = urwid.curses_display.Screen()
446
 
        
 
423
 
447
424
        self.screen.register_palette((
448
425
                ("normal",
449
426
                 "default", "default", None),
450
427
                ("bold",
451
 
                 "default", "default", "bold"),
 
428
                 "bold", "default", "bold"),
452
429
                ("underline-blink",
453
 
                 "default", "default", "underline"),
 
430
                 "underline,blink", "default", "underline,blink"),
454
431
                ("standout",
455
 
                 "default", "default", "standout"),
 
432
                 "standout", "default", "standout"),
456
433
                ("bold-underline-blink",
457
 
                 "default", "default", ("bold", "underline")),
 
434
                 "bold,underline,blink", "default",
 
435
                 "bold,underline,blink"),
458
436
                ("bold-standout",
459
 
                 "default", "default", ("bold", "standout")),
 
437
                 "bold,standout", "default", "bold,standout"),
460
438
                ("underline-blink-standout",
461
 
                 "default", "default", ("underline", "standout")),
 
439
                 "underline,blink,standout", "default",
 
440
                 "underline,blink,standout"),
462
441
                ("bold-underline-blink-standout",
463
 
                 "default", "default", ("bold", "underline",
464
 
                                          "standout")),
 
442
                 "bold,underline,blink,standout", "default",
 
443
                 "bold,underline,blink,standout"),
465
444
                ))
466
 
        
 
445
 
467
446
        if urwid.supports_unicode():
468
 
            self.divider = "─" # \u2500
469
 
            #self.divider = "━" # \u2501
 
447
            self.divider = "─"  # \u2500
470
448
        else:
471
 
            #self.divider = "-" # \u002d
472
 
            self.divider = "_" # \u005f
473
 
        
 
449
            self.divider = "_"  # \u005f
 
450
 
474
451
        self.screen.start()
475
 
        
 
452
 
476
453
        self.size = self.screen.get_cols_rows()
477
 
        
 
454
 
478
455
        self.clients = urwid.SimpleListWalker([])
479
456
        self.clients_dict = {}
480
 
        
 
457
 
481
458
        # We will add Text widgets to this list
482
 
        self.log = []
 
459
        self.log = urwid.SimpleListWalker([])
483
460
        self.max_log_length = max_log_length
484
 
        
 
461
 
485
462
        # We keep a reference to the log widget so we can remove it
486
463
        # from the ListWalker without it getting destroyed
487
464
        self.logbox = ConstrainedListBox(self.log)
488
 
        
 
465
 
489
466
        # This keeps track of whether self.uilist currently has
490
467
        # self.logbox in it or not
491
468
        self.log_visible = True
492
469
        self.log_wrap = "any"
493
 
        
 
470
 
 
471
        self.loghandler = UILogHandler(self)
 
472
 
494
473
        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
 
    
 
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
 
508
485
    def rebuild(self):
509
486
        """This rebuilds the User Interface.
510
487
        Call this when the widget layout needs to change"""
511
488
        self.uilist = []
512
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
489
        # self.uilist.append(urwid.ListBox(self.clients))
513
490
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
514
491
                                                          clients),
515
 
                                       #header=urwid.Divider(),
 
492
                                       # header=urwid.Divider(),
516
493
                                       header=None,
517
 
                                       footer=
518
 
                                       urwid.Divider(div_char=
519
 
                                                     self.divider)))
 
494
                                       footer=urwid.Divider(
 
495
                                           div_char=self.divider)))
520
496
        if self.log_visible:
521
497
            self.uilist.append(self.logbox)
522
498
        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."""
 
499
 
 
500
    def add_log_line(self, markup):
530
501
        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),
 
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,
535
506
                              coming_from="above")
536
507
        self.refresh()
537
 
    
 
508
 
538
509
    def toggle_log_display(self):
539
510
        """Toggle visibility of the log buffer."""
540
511
        self.log_visible = not self.log_visible
541
512
        self.rebuild()
542
 
        #self.log_message("Log visibility changed to: "
543
 
        #                 + unicode(self.log_visible))
544
 
    
 
513
        log.debug("Log visibility changed to: %s", self.log_visible)
 
514
 
545
515
    def change_log_display(self):
546
516
        """Change type of log display.
547
517
        Currently, this toggles wrapping of text lines."""
551
521
            self.log_wrap = "clip"
552
522
        for textwidget in self.log:
553
523
            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):
 
524
        log.debug("Wrap mode: %s", self.log_wrap)
 
525
 
 
526
    def find_and_remove_client(self, path, interfaces):
557
527
        """Find a client by its object path and remove it.
558
 
        
559
 
        This is connected to the ClientRemoved signal from the
 
528
 
 
529
        This is connected to the InterfacesRemoved signal from the
560
530
        Mandos server object."""
 
531
        if client_interface not in interfaces:
 
532
            # Not a Mandos client object; ignore
 
533
            return
561
534
        try:
562
535
            client = self.clients_dict[path]
563
536
        except KeyError:
564
537
            # not found?
565
 
            self.log_message("Unknown client %r (%r) removed", name,
566
 
                             path)
 
538
            log.warning("Unknown client %s removed", path)
567
539
            return
568
540
        client.delete()
569
 
    
570
 
    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
571
551
        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),
 
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])),
582
558
                        path=path)
583
 
    
 
559
 
584
560
    def add_client(self, client, path=None):
585
561
        self.clients.append(client)
586
562
        if path is None:
587
563
            path = client.proxy.object_path
588
564
        self.clients_dict[path] = client
589
 
        self.clients.sort(None, lambda c: c.properties["Name"])
 
565
        self.clients.sort(key=lambda c: c.properties["Name"])
590
566
        self.refresh()
591
 
    
 
567
 
592
568
    def remove_client(self, client, path=None):
593
569
        self.clients.remove(client)
594
570
        if path is None:
595
571
            path = client.proxy.object_path
596
572
        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
573
        self.refresh()
603
 
    
 
574
 
604
575
    def refresh(self):
605
576
        """Redraw the screen"""
606
577
        canvas = self.topwidget.render(self.size, focus=True)
607
578
        self.screen.draw_screen(self.size, canvas)
608
 
    
 
579
 
609
580
    def run(self):
610
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")
611
587
        self.bus = dbus.SystemBus()
612
588
        mandos_dbus_objc = self.bus.get_object(
613
589
            self.busname, "/", follow_name_owner_changes=True)
614
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
615
 
                                          dbus_interface
616
 
                                          = server_interface)
 
590
        self.mandos_serv = dbus.Interface(
 
591
            mandos_dbus_objc, dbus_interface=server_interface)
617
592
        try:
618
593
            mandos_clients = (self.mandos_serv
619
594
                              .GetAllClientsWithProperties())
 
595
            if not mandos_clients:
 
596
                log.warning("Note: Server has no clients.")
620
597
        except dbus.exceptions.DBusException:
 
598
            log.warning("Note: No Mandos server running.")
621
599
            mandos_clients = dbus.Dictionary()
622
 
        
 
600
 
623
601
        (self.mandos_serv
624
 
         .connect_to_signal("ClientRemoved",
 
602
         .connect_to_signal("InterfacesRemoved",
625
603
                            self.find_and_remove_client,
626
 
                            dbus_interface=server_interface,
 
604
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
627
605
                            byte_arrays=True))
628
606
        (self.mandos_serv
629
 
         .connect_to_signal("ClientAdded",
 
607
         .connect_to_signal("InterfacesAdded",
630
608
                            self.add_new_client,
631
 
                            dbus_interface=server_interface,
 
609
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
632
610
                            byte_arrays=True))
633
611
        (self.mandos_serv
634
612
         .connect_to_signal("ClientNotFound",
635
613
                            self.client_not_found,
636
614
                            dbus_interface=server_interface,
637
615
                            byte_arrays=True))
638
 
        for path, client in mandos_clients.iteritems():
 
616
        for path, client in mandos_clients.items():
639
617
            client_proxy_object = self.bus.get_object(self.busname,
640
618
                                                      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),
 
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),
652
625
                            path=path)
653
626
 
654
627
        self.refresh()
655
 
        self._input_callback_tag = (gobject.io_add_watch
656
 
                                    (sys.stdin.fileno(),
657
 
                                     gobject.IO_IN,
658
 
                                     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)))
659
633
        self.main_loop.run()
660
634
        # Main loop has finished, we should close everything now
661
 
        gobject.source_remove(self._input_callback_tag)
662
 
        self.screen.stop()
663
 
    
 
635
        GLib.source_remove(self._input_callback_tag)
 
636
        with warnings.catch_warnings():
 
637
            warnings.simplefilter("ignore", BytesWarning)
 
638
            self.screen.stop()
 
639
 
664
640
    def stop(self):
665
641
        self.main_loop.quit()
666
 
    
 
642
        log.removeHandler(self.loghandler)
 
643
        log.propagate = self.orig_log_propagate
 
644
 
667
645
    def process_input(self, source, condition):
668
646
        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
 
                         }
 
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
                        }
679
657
        for key in keys:
680
658
            try:
681
659
                key = translations[key]
682
660
            except KeyError:    # :-)
683
661
                pass
684
 
            
 
662
 
685
663
            if key == "q" or key == "Q":
686
664
                self.stop()
687
665
                break
688
666
            elif key == "window resize":
689
667
                self.size = self.screen.get_cols_rows()
690
668
                self.refresh()
691
 
            elif key == "\f":  # Ctrl-L
 
669
            elif key == "ctrl l":
 
670
                self.screen.clear()
692
671
                self.refresh()
693
672
            elif key == "l" or key == "D":
694
673
                self.toggle_log_display()
700
679
                if not self.log_visible:
701
680
                    self.log_visible = True
702
681
                    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"))))
 
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
                                   ))))
721
701
                self.refresh()
722
702
            elif key == "tab":
723
703
                if self.topwidget.get_focus() is self.logbox:
725
705
                else:
726
706
                    self.topwidget.set_focus(self.logbox)
727
707
                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
 
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
746
733
            elif self.topwidget.selectable():
747
734
                self.topwidget.keypress(self.size, key)
748
735
                self.refresh()
749
736
        return True
750
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
 
751
752
ui = UserInterface()
752
753
try:
753
754
    ui.run()
754
755
except KeyboardInterrupt:
755
 
    ui.screen.stop()
756
 
except Exception, e:
757
 
    ui.log_message(unicode(e))
758
 
    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()
759
763
    raise