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