/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: teddy at recompile
  • Date: 2020-02-09 03:38:33 UTC
  • Revision ID: teddy@recompile.se-20200209033833-2la1pujrnv2m0so4
Use reallocarray() if available, or check for overflow

* dracut-module/password-agent.c (add_to_queue): Check for overflow.
  (test_add_to_queue_overflow): New test.
* plugin-runner.c (add_to_char_array, main): Use reallocarray().
* plugins.d/plymouth.c (exec_and_wait): - '' -

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