/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2016-06-27 20:21:50 UTC
  • Revision ID: teddy@recompile.se-20160627202150-ml201ilxwjf1g29w
mandos-ctl: Implement --dump-json option

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