/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2023-02-07 19:40:12 UTC
  • Revision ID: teddy@recompile.se-20230207194012-hm2gev01cn7vlodp
Make builds reproducible 

* debian/rules (override_dh_fixperms-arch): Exclude from dh_fixperms
  only what is inside the
  /usr/share/doc/mandos-client/examples/network-hooks.d/ directory.
  That is, do not exclude (i.e. include in the normal dh_fixperms) the
  example/network-hooks.d directory itself.

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