/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: 2014-07-25 22:44:20 UTC
  • mto: This revision was merged to the branch mainline in revision 724.
  • Revision ID: teddy@recompile.se-20140725224420-4a5ct2ptt0hsc92z
Require Python 2.7.

This is in preparation for the eventual move to Python 3, which will
happen as soon as all Python modules required by Mandos are available.
The mandos-ctl and mandos-monitor programs are already portable
between Python 2.6 and Python 3 without changes; this change will
bring the requirement up to Python 2.7.

* INSTALL (Prerequisites/Libraries/Mandos Server): Document
                                                   requirement of
                                                   Python 2.7; remove
                                                   Python-argparse
                                                   which is in the
                                                   Python 2.7 standard
                                                   library.
* debian/control (Source: mandos/Build-Depends-Indep): Depend on
                                                       exactly the
                                                       python2.7
                                                       package and all
                                                       the Python 2.7
                                                       versions of the
                                                       python modules.
  (Package: mandos/Depends): - '' - but still depend on python (<=2.7)
                            and the generic versions of the Python
                            modules; this is for mandos-ctl and
                            mandos-monitor, both of which are
                            compatible with Python 3, and use
                            #!/usr/bin/python.
* mandos: Use #!/usr/bin/python2.7 instead of #!/usr/bin/python.

Show diffs side-by-side

added added

removed removed

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