/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: 2019-11-03 18:44:41 UTC
  • Revision ID: teddy@recompile.se-20191103184441-1vhjuf06hjqgfohh
mandos-monitor: Use Python's standard loggging module

* mandos-monitor: Use Python's standard loggging module, also for
                  warnings.  Suppress BytesWarning from urwid when
                  exiting.
  (log): New global logger object.  This replaces UserInterface
        log_message().
  (MandosClientWidget.__init__): Remove "logger" argument.
  (MandosClientWidget.using_timer): Wrap self.update_timer using new
                                    glib_safely() function.
  (glib_safely): New function to log any exceptions instead of letting
                 exceptions propagate up to GLib.
  (UserInterface.__init__): Remove "log_level" argument.  Set new
                            "loghandler" attribute, instance of new
                            "UILogHandler".
  (UserInterface.log_message): Removed.
  (UserInterface.log_message_raw): Renamed to "add_log_line"; all
                                   callers changed.  Also fix
                                   off-by-one error in max_log_length
                                   logic.
  (UserInterface.run): Add self.loghandler to logger "log". Wrap
                       self.process_input using new glib_safely()
                       function.
  (UserInterface.stop): Remove self.loghandler from logger "log".
  (UserInterface.process_input): Make verbosity toggle affect log
                                 level of logger "log".
  (UILogHandler): New.

Show diffs side-by-side

added added

removed removed

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