/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2022-04-23 23:25:49 UTC
  • Revision ID: teddy@recompile.se-20220423232549-1uul4i3jwhums0ek
Minor text adjustment in mandos(8) manual page

* mandos.xml (DESCRIPTION): Break long line.
  (SEE ALSO/RFC 4291): Fix grammatical mistake.

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