/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 at recompile
  • Date: 2020-02-08 14:01:38 UTC
  • Revision ID: teddy@recompile.se-20200208140138-h3ett0amdelfpt90
mandos: If possible, use shlex.quote() instead of re.escape()

* mandos: Make sure shlex.quote() exists (falling back to assigning
  re.escape to it).
  (Client.start_checker): Use shlex.quote() instead of re.escape().

Show diffs side-by-side

added added

removed removed

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