/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: 2012-05-05 10:52:11 UTC
  • Revision ID: teddy@recompile.se-20120505105211-58z3hyjfzep3z2q9
* mandos: White space and other misc. format fixes only.

Show diffs side-by-side

added added

removed removed

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