/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2023-02-07 19:29:28 UTC
  • mto: This revision was merged to the branch mainline in revision 408.
  • Revision ID: teddy@recompile.se-20230207192928-ueasjbsufb92o6ud
Clarify documentation and a comment about GnuTLS versions

* clients.conf ([foo]/secret): In the comment for the example client's
  "secret" setting, clarify GnuTLS version conditions.
* mandos-clients.conf.xml (OPTIONS/fingerprint, OPTIONS/key_id):
  Clarify required/optional status under different GnuTLS versions.

Show diffs side-by-side

added added

removed removed

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