/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: 2011-08-08 21:12:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110808211237-jejsz5brjytrjot8
* Makefile (DOCS): Added "intro.8mandos".
  (intro.8mandos, intro.8mandos.xhtml): New.
* README: Replaced text with link, reference and short summary.
* intro.xml: New.
* mandos-clients.conf.xml (SEE ALSO): Added "intro(8mandos)".
* mandos-ctl.xml (SEE ALSO): - '' -
* mandos-keygen.xml (SEE ALSO): - '' -
* mandos-monitor.xml (SEE ALSO): - '' -
* mandos.conf.xml (SEE ALSO): - '' -
* mandos.xml (SEE ALSO): - '' -
* plugin-runner.xml (SEE ALSO): - '' -
* plugins.d/askpass-fifo.xml (SEE ALSO): - '' -
* plugins.d/mandos-client.xml (SEE ALSO): - '' -
* plugins.d/password-prompt.xml (SEE ALSO): - '' -
* plugins.d/plymouth.xml (SEE ALSO): - '' -
* plugins.d/splashy.xml (SEE ALSO): - '' -
* plugins.d/usplash.xml (SEE ALSO): - '' -

Show diffs side-by-side

added added

removed removed

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