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