/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:29:28 UTC
  • Revision ID: teddy@recompile.se-20230207192928-ueasjbsufb92o6ud
Clarify documentation and a comment about GnuTLS versions

* clients.conf ([foo]/secret): In the comment for the example client's
  "secret" setting, clarify GnuTLS version conditions.
* mandos-clients.conf.xml (OPTIONS/fingerprint, OPTIONS/key_id):
  Clarify required/optional status under different GnuTLS versions.

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