/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

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