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