/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 00:24:32 UTC
  • Revision ID: teddy@recompile.se-20240908002432-0exnlv1fp73hps8j
Document how to add options to mandos-client when using dracut

* debian/mandos-client.README.Debian: Remove unnecessary word
  "simply".  Also add instructions on how to add the --connect=
  options to mandos-client when using dracut.
* dracut-module/ask-password-mandos.service ([Service]): Add comments
  that this file should *not* be modified, and explicit instructions
  on how to instead add extra options, like --debug, to mandos-client:
  using a systemd override unit file to set an environment variable.

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.4"
 
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"]))
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:
 
191
            log.debug('Checker for client %s (command "%s")'
 
192
                      " succeeded", self.properties["Name"], command)
182
193
            self.update()
183
194
            return
184
195
        # Checker failed
185
196
        if os.WIFEXITED(condition):
186
 
            self.logger('Checker for client {0} (command "{1}")'
187
 
                        ' failed with exit code {2}'
188
 
                        .format(self.properties["Name"], command,
189
 
                                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))
190
200
        elif os.WIFSIGNALED(condition):
191
 
            self.logger('Checker for client {0} (command "{1}") was'
192
 
                        ' killed by signal {2}'
193
 
                        .format(self.properties["Name"], command,
194
 
                                os.WTERMSIG(condition)))
195
 
        elif os.WCOREDUMP(condition):
196
 
            self.logger('Checker for client {0} (command "{1}")'
197
 
                        ' dumped core'
198
 
                        .format(self.properties["Name"], command))
199
 
        else:
200
 
            self.logger('Checker for client {0} completed'
201
 
                        ' mysteriously'
202
 
                        .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))
203
204
        self.update()
204
 
    
 
205
 
205
206
    def checker_started(self, command):
206
 
        """Server signals that a checker started. This could be useful
207
 
           to log in the future. """
208
 
        #self.logger('Client {0} started checker "{1}"'
209
 
        #            .format(self.properties["Name"],
210
 
        #                    str(command)))
211
 
        pass
212
 
    
 
207
        """Server signals that a checker started."""
 
208
        log.debug('Client %s started checker "%s"',
 
209
                  self.properties["Name"], command)
 
210
 
213
211
    def got_secret(self):
214
 
        self.logger('Client {0} received its secret'
215
 
                    .format(self.properties["Name"]))
216
 
    
 
212
        log.info("Client %s received its secret",
 
213
                 self.properties["Name"])
 
214
 
217
215
    def need_approval(self, timeout, default):
218
216
        if not default:
219
 
            message = 'Client {0} needs approval within {1} seconds'
 
217
            message = "Client %s needs approval within %f seconds"
220
218
        else:
221
 
            message = 'Client {0} will get its secret in {1} seconds'
222
 
        self.logger(message.format(self.properties["Name"],
223
 
                                   timeout/1000))
224
 
    
 
219
            message = "Client %s will get its secret in %f seconds"
 
220
        log.info(message, self.properties["Name"], timeout/1000)
 
221
 
225
222
    def rejected(self, reason):
226
 
        self.logger('Client {0} was rejected; reason: {1}'
227
 
                    .format(self.properties["Name"], reason))
228
 
    
 
223
        log.info("Client %s was rejected; reason: %s",
 
224
                 self.properties["Name"], reason)
 
225
 
229
226
    def selectable(self):
230
227
        """Make this a "selectable" widget.
231
228
        This overrides the method from urwid.FlowWidget."""
232
229
        return True
233
 
    
 
230
 
234
231
    def rows(self, maxcolrow, focus=False):
235
232
        """How many rows this widget will occupy might depend on
236
233
        whether we have focus or not.
237
234
        This overrides the method from urwid.FlowWidget"""
238
235
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
239
 
    
 
236
 
240
237
    def current_widget(self, focus=False):
241
238
        if focus or self.opened:
242
239
            return self._focus_widget
243
240
        return self._widget
244
 
    
 
241
 
245
242
    def update(self):
246
243
        "Called when what is visible on the screen should be updated."
247
244
        # How to add standout mode to a style
248
 
        with_standout = { "normal": "standout",
249
 
                          "bold": "bold-standout",
250
 
                          "underline-blink":
251
 
                              "underline-blink-standout",
252
 
                          "bold-underline-blink":
253
 
                              "bold-underline-blink-standout",
254
 
                          }
255
 
        
 
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
 
256
253
        # Rebuild focus and non-focus widgets using current properties
257
 
        
 
254
 
258
255
        # Base part of a client. Name!
259
 
        base = '{name}: '.format(name=self.properties["Name"])
 
256
        base = "{name}: ".format(name=self.properties["Name"])
260
257
        if not self.properties["Enabled"]:
261
258
            message = "DISABLED"
262
259
            self.using_timer(False)
263
260
        elif self.properties["ApprovalPending"]:
264
 
            timeout = datetime.timedelta(milliseconds
265
 
                                         = self.properties
266
 
                                         ["ApprovalDelay"])
 
261
            timeout = datetime.timedelta(
 
262
                milliseconds=self.properties["ApprovalDelay"])
267
263
            last_approval_request = isoformat_to_datetime(
268
264
                self.properties["LastApprovalRequest"])
269
265
            if last_approval_request is not None:
273
269
            else:
274
270
                timer = datetime.timedelta()
275
271
            if self.properties["ApprovedByDefault"]:
276
 
                message = "Approval in {0}. (d)eny?"
 
272
                message = "Approval in {}. (d)eny?"
277
273
            else:
278
 
                message = "Denial in {0}. (a)pprove?"
 
274
                message = "Denial in {}. (a)pprove?"
279
275
            message = message.format(str(timer).rsplit(".", 1)[0])
280
276
            self.using_timer(True)
281
277
        elif self.properties["LastCheckerStatus"] != 0:
285
281
                timer = datetime.timedelta(0)
286
282
            else:
287
283
                expires = (datetime.datetime.strptime
288
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
284
                           (expires, "%Y-%m-%dT%H:%M:%S.%f"))
289
285
                timer = max(expires - datetime.datetime.utcnow(),
290
286
                            datetime.timedelta())
291
 
            message = ('A checker has failed! Time until client'
292
 
                       ' gets disabled: {0}'
 
287
            message = ("A checker has failed! Time until client"
 
288
                       " gets disabled: {}"
293
289
                       .format(str(timer).rsplit(".", 1)[0]))
294
290
            self.using_timer(True)
295
291
        else:
296
292
            message = "enabled"
297
293
            self.using_timer(False)
298
 
        self._text = "{0}{1}".format(base, message)
299
 
        
 
294
        self._text = "{}{}".format(base, message)
 
295
 
300
296
        if not urwid.supports_unicode():
301
297
            self._text = self._text.encode("ascii", "replace")
302
298
        textlist = [("normal", self._text)]
312
308
        # Run update hook, if any
313
309
        if self.update_hook is not None:
314
310
            self.update_hook()
315
 
    
 
311
 
316
312
    def update_timer(self):
317
 
        """called by gobject. Will indefinitely loop until
318
 
        gobject.source_remove() on tag is called"""
 
313
        """called by GLib. Will indefinitely loop until
 
314
        GLib.source_remove() on tag is called
 
315
        """
319
316
        self.update()
320
317
        return True             # Keep calling this
321
 
    
 
318
 
322
319
    def delete(self, **kwargs):
323
320
        if self._update_timer_callback_tag is not None:
324
 
            gobject.source_remove(self._update_timer_callback_tag)
 
321
            GLib.source_remove(self._update_timer_callback_tag)
325
322
            self._update_timer_callback_tag = None
326
323
        for match in self.match_objects:
327
324
            match.remove()
329
326
        if self.delete_hook is not None:
330
327
            self.delete_hook(self)
331
328
        return super(MandosClientWidget, self).delete(**kwargs)
332
 
    
 
329
 
333
330
    def render(self, maxcolrow, focus=False):
334
331
        """Render differently if we have focus.
335
332
        This overrides the method from urwid.FlowWidget"""
336
333
        return self.current_widget(focus).render(maxcolrow,
337
334
                                                 focus=focus)
338
 
    
 
335
 
339
336
    def keypress(self, maxcolrow, key):
340
337
        """Handle keys.
341
338
        This overrides the method from urwid.FlowWidget"""
342
339
        if key == "+":
343
 
            self.proxy.Enable(dbus_interface = client_interface,
344
 
                              ignore_reply=True)
 
340
            self.proxy.Set(client_interface, "Enabled",
 
341
                           dbus.Boolean(True), ignore_reply=True,
 
342
                           dbus_interface=dbus.PROPERTIES_IFACE)
345
343
        elif key == "-":
346
 
            self.proxy.Disable(dbus_interface = client_interface,
347
 
                               ignore_reply=True)
 
344
            self.proxy.Set(client_interface, "Enabled", False,
 
345
                           ignore_reply=True,
 
346
                           dbus_interface=dbus.PROPERTIES_IFACE)
348
347
        elif key == "a":
349
348
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
350
 
                               dbus_interface = client_interface,
 
349
                               dbus_interface=client_interface,
351
350
                               ignore_reply=True)
352
351
        elif key == "d":
353
352
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
354
 
                                  dbus_interface = client_interface,
 
353
                               dbus_interface=client_interface,
355
354
                               ignore_reply=True)
356
355
        elif key == "R" or key == "_" or key == "ctrl k":
357
356
            self.server_proxy_object.RemoveClient(self.proxy
358
357
                                                  .object_path,
359
358
                                                  ignore_reply=True)
360
359
        elif key == "s":
361
 
            self.proxy.StartChecker(dbus_interface = client_interface,
362
 
                                    ignore_reply=True)
 
360
            self.proxy.Set(client_interface, "CheckerRunning",
 
361
                           dbus.Boolean(True), ignore_reply=True,
 
362
                           dbus_interface=dbus.PROPERTIES_IFACE)
363
363
        elif key == "S":
364
 
            self.proxy.StopChecker(dbus_interface = client_interface,
365
 
                                   ignore_reply=True)
 
364
            self.proxy.Set(client_interface, "CheckerRunning",
 
365
                           dbus.Boolean(False), ignore_reply=True,
 
366
                           dbus_interface=dbus.PROPERTIES_IFACE)
366
367
        elif key == "C":
367
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
 
368
            self.proxy.CheckedOK(dbus_interface=client_interface,
368
369
                                 ignore_reply=True)
369
370
        # xxx
370
371
#         elif key == "p" or key == "=":
375
376
#             self.open()
376
377
        else:
377
378
            return key
378
 
    
379
 
    def property_changed(self, property=None, **kwargs):
380
 
        """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.
381
382
        This overrides the method from MandosClientPropertyCache"""
382
 
        property_name = str(property)
383
 
        old_value = self.properties.get(property_name)
384
 
        super(MandosClientWidget, self).property_changed(
385
 
            property=property, **kwargs)
386
 
        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):
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
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
 
        
 
461
 
450
462
        # We keep a reference to the log widget so we can remove it
451
463
        # from the ListWalker without it getting destroyed
452
464
        self.logbox = ConstrainedListBox(self.log)
453
 
        
 
465
 
454
466
        # This keeps track of whether self.uilist currently has
455
467
        # self.logbox in it or not
456
468
        self.log_visible = True
457
469
        self.log_wrap = "any"
458
 
        
 
470
 
 
471
        self.loghandler = UILogHandler(self)
 
472
 
459
473
        self.rebuild()
460
 
        self.log_message_raw(("bold",
461
 
                              "Mandos Monitor version " + version))
462
 
        self.log_message_raw(("bold",
463
 
                              "q: Quit  ?: Help"))
464
 
        
465
 
        self.busname = domain + '.Mandos'
466
 
        self.main_loop = gobject.MainLoop()
467
 
    
468
 
    def client_not_found(self, fingerprint, address):
469
 
        self.log_message("Client with address {0} and fingerprint"
470
 
                         " {1} could not be found"
471
 
                         .format(address, fingerprint))
472
 
    
 
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
 
473
485
    def rebuild(self):
474
486
        """This rebuilds the User Interface.
475
487
        Call this when the widget layout needs to change"""
476
488
        self.uilist = []
477
 
        #self.uilist.append(urwid.ListBox(self.clients))
 
489
        # self.uilist.append(urwid.ListBox(self.clients))
478
490
        self.uilist.append(urwid.Frame(ConstrainedListBox(self.
479
491
                                                          clients),
480
 
                                       #header=urwid.Divider(),
 
492
                                       # header=urwid.Divider(),
481
493
                                       header=None,
482
 
                                       footer=
483
 
                                       urwid.Divider(div_char=
484
 
                                                     self.divider)))
 
494
                                       footer=urwid.Divider(
 
495
                                           div_char=self.divider)))
485
496
        if self.log_visible:
486
497
            self.uilist.append(self.logbox)
487
498
        self.topwidget = urwid.Pile(self.uilist)
488
 
    
489
 
    def log_message(self, message):
490
 
        """Log message formatted with timestamp"""
491
 
        timestamp = datetime.datetime.now().isoformat()
492
 
        self.log_message_raw(timestamp + ": " + message)
493
 
    
494
 
    def log_message_raw(self, markup):
495
 
        """Add a log message to the log buffer."""
 
499
 
 
500
    def add_log_line(self, markup):
496
501
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
497
 
        if (self.max_log_length
498
 
            and len(self.log) > self.max_log_length):
499
 
            del self.log[0:len(self.log)-self.max_log_length-1]
500
 
        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,
501
506
                              coming_from="above")
502
507
        self.refresh()
503
 
    
 
508
 
504
509
    def toggle_log_display(self):
505
510
        """Toggle visibility of the log buffer."""
506
511
        self.log_visible = not self.log_visible
507
512
        self.rebuild()
508
 
        #self.log_message("Log visibility changed to: "
509
 
        #                 + str(self.log_visible))
510
 
    
 
513
        log.debug("Log visibility changed to: %s", self.log_visible)
 
514
 
511
515
    def change_log_display(self):
512
516
        """Change type of log display.
513
517
        Currently, this toggles wrapping of text lines."""
517
521
            self.log_wrap = "clip"
518
522
        for textwidget in self.log:
519
523
            textwidget.set_wrap_mode(self.log_wrap)
520
 
        #self.log_message("Wrap mode: " + self.log_wrap)
521
 
    
522
 
    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):
523
527
        """Find a client by its object path and remove it.
524
 
        
525
 
        This is connected to the ClientRemoved signal from the
 
528
 
 
529
        This is connected to the InterfacesRemoved signal from the
526
530
        Mandos server object."""
 
531
        if client_interface not in interfaces:
 
532
            # Not a Mandos client object; ignore
 
533
            return
527
534
        try:
528
535
            client = self.clients_dict[path]
529
536
        except KeyError:
530
537
            # not found?
531
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
532
 
                             .format(name, path))
 
538
            log.warning("Unknown client %s removed", path)
533
539
            return
534
540
        client.delete()
535
 
    
536
 
    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
537
551
        client_proxy_object = self.bus.get_object(self.busname, path)
538
 
        self.add_client(MandosClientWidget(server_proxy_object
539
 
                                           =self.mandos_serv,
540
 
                                           proxy_object
541
 
                                           =client_proxy_object,
542
 
                                           update_hook
543
 
                                           =self.refresh,
544
 
                                           delete_hook
545
 
                                           =self.remove_client,
546
 
                                           logger
547
 
                                           =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])),
548
558
                        path=path)
549
 
    
 
559
 
550
560
    def add_client(self, client, path=None):
551
561
        self.clients.append(client)
552
562
        if path is None:
554
564
        self.clients_dict[path] = client
555
565
        self.clients.sort(key=lambda c: c.properties["Name"])
556
566
        self.refresh()
557
 
    
 
567
 
558
568
    def remove_client(self, client, path=None):
559
569
        self.clients.remove(client)
560
570
        if path is None:
561
571
            path = client.proxy.object_path
562
572
        del self.clients_dict[path]
563
573
        self.refresh()
564
 
    
 
574
 
565
575
    def refresh(self):
566
576
        """Redraw the screen"""
567
577
        canvas = self.topwidget.render(self.size, focus=True)
568
578
        self.screen.draw_screen(self.size, canvas)
569
 
    
 
579
 
570
580
    def run(self):
571
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")
572
587
        self.bus = dbus.SystemBus()
573
588
        mandos_dbus_objc = self.bus.get_object(
574
589
            self.busname, "/", follow_name_owner_changes=True)
575
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
576
 
                                          dbus_interface
577
 
                                          = server_interface)
 
590
        self.mandos_serv = dbus.Interface(
 
591
            mandos_dbus_objc, dbus_interface=server_interface)
578
592
        try:
579
593
            mandos_clients = (self.mandos_serv
580
594
                              .GetAllClientsWithProperties())
581
595
            if not mandos_clients:
582
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
 
596
                log.warning("Note: Server has no clients.")
583
597
        except dbus.exceptions.DBusException:
584
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
598
            log.warning("Note: No Mandos server running.")
585
599
            mandos_clients = dbus.Dictionary()
586
 
        
 
600
 
587
601
        (self.mandos_serv
588
 
         .connect_to_signal("ClientRemoved",
 
602
         .connect_to_signal("InterfacesRemoved",
589
603
                            self.find_and_remove_client,
590
 
                            dbus_interface=server_interface,
 
604
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
591
605
                            byte_arrays=True))
592
606
        (self.mandos_serv
593
 
         .connect_to_signal("ClientAdded",
 
607
         .connect_to_signal("InterfacesAdded",
594
608
                            self.add_new_client,
595
 
                            dbus_interface=server_interface,
 
609
                            dbus_interface=dbus.OBJECT_MANAGER_IFACE,
596
610
                            byte_arrays=True))
597
611
        (self.mandos_serv
598
612
         .connect_to_signal("ClientNotFound",
602
616
        for path, client in mandos_clients.items():
603
617
            client_proxy_object = self.bus.get_object(self.busname,
604
618
                                                      path)
605
 
            self.add_client(MandosClientWidget(server_proxy_object
606
 
                                               =self.mandos_serv,
607
 
                                               proxy_object
608
 
                                               =client_proxy_object,
609
 
                                               properties=client,
610
 
                                               update_hook
611
 
                                               =self.refresh,
612
 
                                               delete_hook
613
 
                                               =self.remove_client,
614
 
                                               logger
615
 
                                               =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),
616
625
                            path=path)
617
 
        
 
626
 
618
627
        self.refresh()
619
 
        self._input_callback_tag = (gobject.io_add_watch
620
 
                                    (sys.stdin.fileno(),
621
 
                                     gobject.IO_IN,
622
 
                                     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)))
623
633
        self.main_loop.run()
624
634
        # Main loop has finished, we should close everything now
625
 
        gobject.source_remove(self._input_callback_tag)
626
 
        self.screen.stop()
627
 
    
 
635
        GLib.source_remove(self._input_callback_tag)
 
636
        with warnings.catch_warnings():
 
637
            warnings.simplefilter("ignore", BytesWarning)
 
638
            self.screen.stop()
 
639
 
628
640
    def stop(self):
629
641
        self.main_loop.quit()
630
 
    
 
642
        log.removeHandler(self.loghandler)
 
643
        log.propagate = self.orig_log_propagate
 
644
 
631
645
    def process_input(self, source, condition):
632
646
        keys = self.screen.get_input()
633
 
        translations = { "ctrl n": "down",      # Emacs
634
 
                         "ctrl p": "up",        # Emacs
635
 
                         "ctrl v": "page down", # Emacs
636
 
                         "meta v": "page up",   # Emacs
637
 
                         " ": "page down",      # less
638
 
                         "f": "page down",      # less
639
 
                         "b": "page up",        # less
640
 
                         "j": "down",           # vi
641
 
                         "k": "up",             # vi
642
 
                         }
 
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
                        }
643
657
        for key in keys:
644
658
            try:
645
659
                key = translations[key]
646
660
            except KeyError:    # :-)
647
661
                pass
648
 
            
 
662
 
649
663
            if key == "q" or key == "Q":
650
664
                self.stop()
651
665
                break
652
666
            elif key == "window resize":
653
667
                self.size = self.screen.get_cols_rows()
654
668
                self.refresh()
655
 
            elif key == "\f":  # Ctrl-L
 
669
            elif key == "ctrl l":
 
670
                self.screen.clear()
656
671
                self.refresh()
657
672
            elif key == "l" or key == "D":
658
673
                self.toggle_log_display()
664
679
                if not self.log_visible:
665
680
                    self.log_visible = True
666
681
                    self.rebuild()
667
 
                self.log_message_raw(("bold",
668
 
                                      "  ".
669
 
                                      join(("q: Quit",
670
 
                                            "?: Help",
671
 
                                            "l: Log window toggle",
672
 
                                            "TAB: Switch window",
673
 
                                            "w: Wrap (log)"))))
674
 
                self.log_message_raw(("bold",
675
 
                                      "  "
676
 
                                      .join(("Clients:",
677
 
                                             "+: Enable",
678
 
                                             "-: Disable",
679
 
                                             "R: Remove",
680
 
                                             "s: Start new checker",
681
 
                                             "S: Stop checker",
682
 
                                             "C: Checker OK",
683
 
                                             "a: Approve",
684
 
                                             "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
                                   ))))
685
701
                self.refresh()
686
702
            elif key == "tab":
687
703
                if self.topwidget.get_focus() is self.logbox:
689
705
                else:
690
706
                    self.topwidget.set_focus(self.logbox)
691
707
                self.refresh()
692
 
            #elif (key == "end" or key == "meta >" or key == "G"
693
 
            #      or key == ">"):
694
 
            #    pass            # xxx end-of-buffer
695
 
            #elif (key == "home" or key == "meta <" or key == "g"
696
 
            #      or key == "<"):
697
 
            #    pass            # xxx beginning-of-buffer
698
 
            #elif key == "ctrl e" or key == "$":
699
 
            #    pass            # xxx move-end-of-line
700
 
            #elif key == "ctrl a" or key == "^":
701
 
            #    pass            # xxx move-beginning-of-line
702
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
703
 
            #    pass            # xxx left
704
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
705
 
            #    pass            # xxx right
706
 
            #elif key == "a":
707
 
            #    pass            # scroll up log
708
 
            #elif key == "z":
709
 
            #    pass            # scroll down log
 
708
            elif key == "v":
 
709
                if log.level < logging.INFO:
 
710
                    log.setLevel(logging.INFO)
 
711
                    log.info("Verbose mode: Off")
 
712
                else:
 
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
710
733
            elif self.topwidget.selectable():
711
734
                self.topwidget.keypress(self.size, key)
712
735
                self.refresh()
713
736
        return True
714
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
 
715
752
ui = UserInterface()
716
753
try:
717
754
    ui.run()
718
755
except KeyboardInterrupt:
719
 
    ui.screen.stop()
720
 
except Exception as e:
721
 
    ui.log_message(str(e))
722
 
    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()
723
763
    raise