/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-08-10 09:00:23 UTC
  • Revision ID: teddy@recompile.se-20150810090023-fz6vjqr7zf33e2tf
Support the standard org.freedesktop.DBus.ObjectManager interface.

Now that the D-Bus standard has an interface to keep track of new and
removed objects, use that instead of our own methods.  This deprecates
our D-Bus methods "GetAllClients" and "GetAllClientsWithProperties"
and the signals "ClientAdded" and "ClientRemoved", all on the server
interface "se.recompile.Mandos".

* DBUS-API: Removed references to deprecated methods and signals;
  insert reference to the org.freedesktop.DBus.ObjectManager
  interface.
* mandos (DBusObjectWithProperties._get_all_interface_names): New.
  (dbus.OBJECT_MANAGER_IFACE): If not present, monkey patch.
  (DBusObjectWithObjectManager): New.
  (main/MandosDBusService): Inherit from DBusObjectWithObjectManager.
  (main/MandosDBusService.ClientRemoved): Annotate as deprecated.
  (main/MandosDBusService.GetAllClients): - '' -
  (main/MandosDBusService.GetAllClientsWithProperties): Annotate as
                                                        deprecated.
                                                        Also only
                                                        return
                                                        properties on
                                                        client
                                                        interface.
  (main/MandosDBusService.RemoveClient): Call client_removed_signal
                                         instead of ClientRemoved.
  (main/MandosDBusService.GetManagedObjects): New.
  (main/MandosDBusService.client_added_signal): New.
  (main/MandosDBusService.client_removed_signal): - '' -
  (main/cleanup): Call "client_removed_signal" instead of sending
                  "ClientRemoved" signal directly.
  (main): Call "client_added_signal" instead of sending "ClientAdded"
          signal directly.
* mandos-ctl: Use GetManagedObjects instead of
              GetAllClientsWithProperties.  Also, show better error
              message in case of failure to connect to the D-Bus

* mandos-monitor (MandosClientPropertyCache.properties_changed):
  Bug fix; only update properties on client interface.
  (UserInterface.find_and_remove_client): Change to accept arguments
                                          from InterfacesRemoved
                                          signal.  Also, bug fix:
                                          working error message when
                                          removing unknown client.
  (UserInterface.add_new_client): Change to accept arguments from
                                  InterfacesRemoved signal.  Pass
                                  properties to MandosClientWidget
                                  constructor.
  (UserInterface.run): Connect find_and_remove_client method to
                       InterfacesRemoved signal and the add_new_client
                       method to the InterfacesAdded signal.

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