/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: 2016-03-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

Show diffs side-by-side

added added

removed removed

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