/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

* DBUS-API (se.recompile.Mandos.Client.LastCheckerStatus): New
                                                           property.
* mandos (Client.last_checker_status): Use -2 instead of None to match
                                       D-Bus property.  All users
                                       changed.
  (Client.checked_ok): Remove "timeout" argument and call
                       "self.bump_timeout()" instead.
  (Client.bump_timeout): New; separated out from "checked_ok".
  (ClientDBus.last_checker_status): Hook to a D-Bus property.
  (ClientDBus.LastCheckerStatus_dbus_property): New D-Bus property.
  (ClientHandler.handle): Call client.bump_timeout() instead of
                          client.checked_ok().

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