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