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