/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

merge

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