/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 at bsnet
  • Date: 2010-09-09 18:16:14 UTC
  • mfrom: (237.2.35 mandos-empty-device)
  • Revision ID: teddy@fukt.bsnet.se-20100909181614-oanlmvkzsiodbo3c
Merge in branch to interpret an empty device name to mean
"autodetect".

Show diffs side-by-side

added added

removed removed

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