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