/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: 2024-09-08 00:08:15 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

Show diffs side-by-side

added added

removed removed

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