/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

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