/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-monitor
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
# 
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
                                                [u"LastCheckedOK"])
 
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
 
146
                                         [u"Interval"]))
 
147
        if self.last_checker_failed:
169
148
            self._update_timer_callback_tag = (gobject.timeout_add
170
149
                                               (1000,
171
150
                                                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
151
    
176
 
    def checker_completed(self, exitstatus, signal, command):
 
152
    def checker_completed(self, exitstatus, condition, command):
177
153
        if exitstatus == 0:
178
 
            self.logger('Checker for client {} (command "{}")'
179
 
                        ' succeeded'.format(self.properties["Name"],
180
 
                                            command), level=0)
 
154
            if self.last_checker_failed:
 
155
                self.last_checker_failed = False
 
156
                gobject.source_remove(self._update_timer_callback_tag)
 
157
                self._update_timer_callback_tag = None
 
158
            self.logger(u'Checker for client %s (command "%s")'
 
159
                        u' was successful'
 
160
                        % (self.properties[u"Name"], command))
181
161
            self.update()
182
162
            return
183
163
        # 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))
 
164
        if not self.last_checker_failed:
 
165
            self.last_checker_failed = True
 
166
            self._update_timer_callback_tag = (gobject.timeout_add
 
167
                                               (1000,
 
168
                                                self.update_timer))
 
169
        if os.WIFEXITED(condition):
 
170
            self.logger(u'Checker for client %s (command "%s")'
 
171
                        u' failed with exit code %s'
 
172
                        % (self.properties[u"Name"], command,
 
173
                           os.WEXITSTATUS(condition)))
 
174
        elif os.WIFSIGNALED(condition):
 
175
            self.logger(u'Checker for client %s (command "%s")'
 
176
                        u' was killed by signal %s'
 
177
                        % (self.properties[u"Name"], command,
 
178
                           os.WTERMSIG(condition)))
 
179
        elif os.WCOREDUMP(condition):
 
180
            self.logger(u'Checker for client %s (command "%s")'
 
181
                        u' dumped core'
 
182
                        % (self.properties[u"Name"], command))
194
183
        else:
195
 
            self.logger('Checker for client {} completed'
196
 
                        ' mysteriously'
197
 
                        .format(self.properties["Name"]))
 
184
            self.logger(u'Checker for client %s completed'
 
185
                        u' mysteriously')
198
186
        self.update()
199
187
    
200
188
    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)
 
189
        #self.logger(u'Client %s started checker "%s"'
 
190
        #            % (self.properties[u"Name"], unicode(command)))
 
191
        pass
205
192
    
206
193
    def got_secret(self):
207
 
        self.logger('Client {} received its secret'
208
 
                    .format(self.properties["Name"]))
 
194
        self.last_checker_failed = False
 
195
        self.logger(u'Client %s received its secret'
 
196
                    % self.properties[u"Name"])
209
197
    
210
198
    def need_approval(self, timeout, default):
211
199
        if not default:
212
 
            message = 'Client {} needs approval within {} seconds'
 
200
            message = u'Client %s needs approval within %s seconds'
213
201
        else:
214
 
            message = 'Client {} will get its secret in {} seconds'
215
 
        self.logger(message.format(self.properties["Name"],
216
 
                                   timeout/1000))
 
202
            message = u'Client %s will get its secret in %s seconds'
 
203
        self.logger(message
 
204
                    % (self.properties[u"Name"], timeout/1000))
217
205
    
218
206
    def rejected(self, reason):
219
 
        self.logger('Client {} was rejected; reason: {}'
220
 
                    .format(self.properties["Name"], reason))
 
207
        self.logger(u'Client %s was rejected; reason: %s'
 
208
                    % (self.properties[u"Name"], reason))
221
209
    
222
210
    def selectable(self):
223
211
        """Make this a "selectable" widget.
224
212
        This overrides the method from urwid.FlowWidget."""
225
213
        return True
226
214
    
227
 
    def rows(self, maxcolrow, focus=False):
 
215
    def rows(self, (maxcol,), focus=False):
228
216
        """How many rows this widget will occupy might depend on
229
217
        whether we have focus or not.
230
218
        This overrides the method from urwid.FlowWidget"""
231
 
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
219
        return self.current_widget(focus).rows((maxcol,), focus=focus)
232
220
    
233
221
    def current_widget(self, focus=False):
234
222
        if focus or self.opened:
238
226
    def update(self):
239
227
        "Called when what is visible on the screen should be updated."
240
228
        # 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",
 
229
        with_standout = { u"normal": u"standout",
 
230
                          u"bold": u"bold-standout",
 
231
                          u"underline-blink":
 
232
                              u"underline-blink-standout",
 
233
                          u"bold-underline-blink":
 
234
                              u"bold-underline-blink-standout",
247
235
                          }
248
 
        
 
236
 
249
237
        # Rebuild focus and non-focus widgets using current properties
250
 
        
 
238
 
251
239
        # 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"]:
 
240
        base = (u'%(name)s: '
 
241
                      % {u"name": self.properties[u"Name"]})
 
242
        if not self.properties[u"Enabled"]:
 
243
            message = u"DISABLED"
 
244
        elif self.properties[u"ApprovalPending"]:
 
245
            if self.properties[u"ApprovedByDefault"]:
 
246
                message = u"Connection established to client. (d)eny?"
 
247
            else:
 
248
                message = u"Seeks approval to send secret. (a)pprove?"
 
249
        elif self.last_checker_failed:
257
250
            timeout = datetime.timedelta(milliseconds
258
251
                                         = 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)
 
252
                                         [u"Timeout"])
 
253
            last_ok = isoformat_to_datetime(
 
254
                max((self.properties[u"LastCheckedOK"]
 
255
                     or self.properties[u"Created"]),
 
256
                    self.properties[u"LastEnabled"]))
 
257
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
258
            message = (u'A checker has failed! Time until client'
 
259
                       u' gets diabled: %s'
 
260
                           % unicode(timer).rsplit(".", 1)[0])
288
261
        else:
289
 
            message = "enabled"
290
 
            self.using_timer(False)
291
 
        self._text = "{}{}".format(base, message)
292
 
        
 
262
            message = u"enabled"
 
263
        self._text = "%s%s" % (base, message)
 
264
            
293
265
        if not urwid.supports_unicode():
294
266
            self._text = self._text.encode("ascii", "replace")
295
 
        textlist = [("normal", self._text)]
 
267
        textlist = [(u"normal", self._text)]
296
268
        self._text_widget.set_text(textlist)
297
269
        self._focus_text_widget.set_text([(with_standout[text[0]],
298
270
                                           text[1])
307
279
            self.update_hook()
308
280
    
309
281
    def update_timer(self):
310
 
        """called by gobject. Will indefinitely loop until
311
 
        gobject.source_remove() on tag is called"""
 
282
        "called by gobject"
312
283
        self.update()
313
284
        return True             # Keep calling this
314
285
    
315
 
    def delete(self, **kwargs):
 
286
    def delete(self):
316
287
        if self._update_timer_callback_tag is not None:
317
288
            gobject.source_remove(self._update_timer_callback_tag)
318
289
            self._update_timer_callback_tag = None
319
 
        for match in self.match_objects:
320
 
            match.remove()
321
 
        self.match_objects = ()
322
290
        if self.delete_hook is not None:
323
291
            self.delete_hook(self)
324
 
        return super(MandosClientWidget, self).delete(**kwargs)
325
292
    
326
 
    def render(self, maxcolrow, focus=False):
 
293
    def render(self, (maxcol,), focus=False):
327
294
        """Render differently if we have focus.
328
295
        This overrides the method from urwid.FlowWidget"""
329
 
        return self.current_widget(focus).render(maxcolrow,
 
296
        return self.current_widget(focus).render((maxcol,),
330
297
                                                 focus=focus)
331
298
    
332
 
    def keypress(self, maxcolrow, key):
 
299
    def keypress(self, (maxcol,), key):
333
300
        """Handle keys.
334
301
        This overrides the method from urwid.FlowWidget"""
335
 
        if key == "+":
336
 
            self.proxy.Enable(dbus_interface = client_interface,
337
 
                              ignore_reply=True)
338
 
        elif key == "-":
339
 
            self.proxy.Disable(dbus_interface = client_interface,
340
 
                               ignore_reply=True)
341
 
        elif key == "a":
 
302
        if key == u"+":
 
303
            self.proxy.Enable(dbus_interface = client_interface)
 
304
        elif key == u"-":
 
305
            self.proxy.Disable(dbus_interface = client_interface)
 
306
        elif key == u"a":
342
307
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
343
 
                               dbus_interface = client_interface,
344
 
                               ignore_reply=True)
345
 
        elif key == "d":
 
308
                               dbus_interface = client_interface)
 
309
        elif key == u"d":
346
310
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
347
 
                                  dbus_interface = client_interface,
348
 
                               ignore_reply=True)
349
 
        elif key == "R" or key == "_" or key == "ctrl k":
 
311
                                  dbus_interface = client_interface)
 
312
        elif key == u"r" or key == u"_" or key == u"ctrl k":
350
313
            self.server_proxy_object.RemoveClient(self.proxy
351
 
                                                  .object_path,
352
 
                                                  ignore_reply=True)
353
 
        elif key == "s":
354
 
            self.proxy.StartChecker(dbus_interface = client_interface,
355
 
                                    ignore_reply=True)
356
 
        elif key == "S":
357
 
            self.proxy.StopChecker(dbus_interface = client_interface,
358
 
                                   ignore_reply=True)
359
 
        elif key == "C":
360
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
361
 
                                 ignore_reply=True)
 
314
                                                  .object_path)
 
315
        elif key == u"s":
 
316
            self.proxy.StartChecker(dbus_interface = client_interface)
 
317
        elif key == u"S":
 
318
            self.proxy.StopChecker(dbus_interface = client_interface)
 
319
        elif key == u"C":
 
320
            self.proxy.CheckedOK(dbus_interface = client_interface)
362
321
        # xxx
363
 
#         elif key == "p" or key == "=":
 
322
#         elif key == u"p" or key == "=":
364
323
#             self.proxy.pause()
365
 
#         elif key == "u" or key == ":":
 
324
#         elif key == u"u" or key == ":":
366
325
#             self.proxy.unpause()
367
 
#         elif key == "RET":
 
326
#         elif key == u"RET":
368
327
#             self.open()
 
328
#        elif key == u"+":
 
329
#            self.proxy.Approve(True)
 
330
#        elif key == u"-":
 
331
#            self.proxy.Approve(False)
369
332
        else:
370
333
            return key
371
334
    
372
 
    def properties_changed(self, interface, properties, invalidated):
373
 
        """Call self.update() if any properties changed.
 
335
    def property_changed(self, property=None, value=None,
 
336
                         *args, **kwargs):
 
337
        """Call self.update() if old value is not new value.
374
338
        This overrides the method from MandosClientPropertyCache"""
375
 
        old_values = { key: self.properties.get(key)
376
 
                       for key in properties.keys() }
377
 
        super(MandosClientWidget, self).properties_changed(
378
 
            interface, properties, invalidated)
379
 
        if any(old_values[key] != self.properties.get(key)
380
 
               for key in old_values):
 
339
        property_name = unicode(property)
 
340
        old_value = self.properties.get(property_name)
 
341
        super(MandosClientWidget, self).property_changed(
 
342
            property=property, value=value, *args, **kwargs)
 
343
        if self.properties.get(property_name) != old_value:
381
344
            self.update()
382
345
 
383
346
 
386
349
    "down" key presses, thus not allowing any containing widgets to
387
350
    use them as an excuse to shift focus away from this widget.
388
351
    """
389
 
    def keypress(self, *args, **kwargs):
390
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
391
 
        if ret in ("up", "down"):
 
352
    def keypress(self, (maxcol, maxrow), key):
 
353
        ret = super(ConstrainedListBox, self).keypress((maxcol,
 
354
                                                        maxrow), key)
 
355
        if ret in (u"up", u"down"):
392
356
            return
393
357
        return ret
394
358
 
397
361
    """This is the entire user interface - the whole screen
398
362
    with boxes, lists of client widgets, etc.
399
363
    """
400
 
    def __init__(self, max_log_length=1000, log_level=1):
 
364
    def __init__(self, max_log_length=1000):
401
365
        DBusGMainLoop(set_as_default=True)
402
366
        
403
367
        self.screen = urwid.curses_display.Screen()
404
368
        
405
369
        self.screen.register_palette((
406
 
                ("normal",
407
 
                 "default", "default", None),
408
 
                ("bold",
409
 
                 "bold", "default", "bold"),
410
 
                ("underline-blink",
411
 
                 "underline,blink", "default", "underline,blink"),
412
 
                ("standout",
413
 
                 "standout", "default", "standout"),
414
 
                ("bold-underline-blink",
415
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
416
 
                ("bold-standout",
417
 
                 "bold,standout", "default", "bold,standout"),
418
 
                ("underline-blink-standout",
419
 
                 "underline,blink,standout", "default",
420
 
                 "underline,blink,standout"),
421
 
                ("bold-underline-blink-standout",
422
 
                 "bold,underline,blink,standout", "default",
423
 
                 "bold,underline,blink,standout"),
 
370
                (u"normal",
 
371
                 u"default", u"default", None),
 
372
                (u"bold",
 
373
                 u"default", u"default", u"bold"),
 
374
                (u"underline-blink",
 
375
                 u"default", u"default", u"underline"),
 
376
                (u"standout",
 
377
                 u"default", u"default", u"standout"),
 
378
                (u"bold-underline-blink",
 
379
                 u"default", u"default", (u"bold", u"underline")),
 
380
                (u"bold-standout",
 
381
                 u"default", u"default", (u"bold", u"standout")),
 
382
                (u"underline-blink-standout",
 
383
                 u"default", u"default", (u"underline", u"standout")),
 
384
                (u"bold-underline-blink-standout",
 
385
                 u"default", u"default", (u"bold", u"underline",
 
386
                                          u"standout")),
424
387
                ))
425
388
        
426
389
        if urwid.supports_unicode():
427
 
            self.divider = "─" # \u2500
428
 
            #self.divider = "━" # \u2501
 
390
            self.divider = u"─" # \u2500
 
391
            #self.divider = u"━" # \u2501
429
392
        else:
430
 
            #self.divider = "-" # \u002d
431
 
            self.divider = "_" # \u005f
 
393
            #self.divider = u"-" # \u002d
 
394
            self.divider = u"_" # \u005f
432
395
        
433
396
        self.screen.start()
434
397
        
441
404
        self.log = []
442
405
        self.max_log_length = max_log_length
443
406
        
444
 
        self.log_level = log_level
445
 
        
446
407
        # We keep a reference to the log widget so we can remove it
447
408
        # from the ListWalker without it getting destroyed
448
409
        self.logbox = ConstrainedListBox(self.log)
450
411
        # This keeps track of whether self.uilist currently has
451
412
        # self.logbox in it or not
452
413
        self.log_visible = True
453
 
        self.log_wrap = "any"
 
414
        self.log_wrap = u"any"
454
415
        
455
416
        self.rebuild()
456
 
        self.log_message_raw(("bold",
457
 
                              "Mandos Monitor version " + version))
458
 
        self.log_message_raw(("bold",
459
 
                              "q: Quit  ?: Help"))
 
417
        self.log_message_raw((u"bold",
 
418
                              u"Mandos Monitor version " + version))
 
419
        self.log_message_raw((u"bold",
 
420
                              u"q: Quit  ?: Help"))
460
421
        
461
422
        self.busname = domain + '.Mandos'
462
423
        self.main_loop = gobject.MainLoop()
 
424
        self.bus = dbus.SystemBus()
 
425
        mandos_dbus_objc = self.bus.get_object(
 
426
            self.busname, u"/", follow_name_owner_changes=True)
 
427
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
428
                                          dbus_interface
 
429
                                          = server_interface)
 
430
        try:
 
431
            mandos_clients = (self.mandos_serv
 
432
                              .GetAllClientsWithProperties())
 
433
        except dbus.exceptions.DBusException:
 
434
            mandos_clients = dbus.Dictionary()
 
435
        
 
436
        (self.mandos_serv
 
437
         .connect_to_signal(u"ClientRemoved",
 
438
                            self.find_and_remove_client,
 
439
                            dbus_interface=server_interface,
 
440
                            byte_arrays=True))
 
441
        (self.mandos_serv
 
442
         .connect_to_signal(u"ClientAdded",
 
443
                            self.add_new_client,
 
444
                            dbus_interface=server_interface,
 
445
                            byte_arrays=True))
 
446
        (self.mandos_serv
 
447
         .connect_to_signal(u"ClientNotFound",
 
448
                            self.client_not_found,
 
449
                            dbus_interface=server_interface,
 
450
                            byte_arrays=True))
 
451
        for path, client in mandos_clients.iteritems():
 
452
            client_proxy_object = self.bus.get_object(self.busname,
 
453
                                                      path)
 
454
            self.add_client(MandosClientWidget(server_proxy_object
 
455
                                               =self.mandos_serv,
 
456
                                               proxy_object
 
457
                                               =client_proxy_object,
 
458
                                               properties=client,
 
459
                                               update_hook
 
460
                                               =self.refresh,
 
461
                                               delete_hook
 
462
                                               =self.remove_client,
 
463
                                               logger
 
464
                                               =self.log_message),
 
465
                            path=path)
463
466
    
464
467
    def client_not_found(self, fingerprint, address):
465
 
        self.log_message("Client with address {} and fingerprint {}"
466
 
                         " could not be found"
467
 
                         .format(address, fingerprint))
 
468
        self.log_message((u"Client with address %s and fingerprint %s"
 
469
                          u" could not be found" % (address,
 
470
                                                    fingerprint)))
468
471
    
469
472
    def rebuild(self):
470
473
        """This rebuilds the User Interface.
480
483
                                                     self.divider)))
481
484
        if self.log_visible:
482
485
            self.uilist.append(self.logbox)
 
486
            pass
483
487
        self.topwidget = urwid.Pile(self.uilist)
484
488
    
485
 
    def log_message(self, message, level=1):
486
 
        """Log message formatted with timestamp"""
487
 
        if level < self.log_level:
488
 
            return
 
489
    def log_message(self, message):
489
490
        timestamp = datetime.datetime.now().isoformat()
490
 
        self.log_message_raw("{}: {}".format(timestamp, message),
491
 
                             level=level)
 
491
        self.log_message_raw(timestamp + u": " + message)
492
492
    
493
 
    def log_message_raw(self, markup, level=1):
 
493
    def log_message_raw(self, markup):
494
494
        """Add a log message to the log buffer."""
495
 
        if level < self.log_level:
496
 
            return
497
495
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
498
496
        if (self.max_log_length
499
497
            and len(self.log) > self.max_log_length):
500
498
            del self.log[0:len(self.log)-self.max_log_length-1]
501
499
        self.logbox.set_focus(len(self.logbox.body.contents),
502
 
                              coming_from="above")
 
500
                              coming_from=u"above")
503
501
        self.refresh()
504
502
    
505
503
    def toggle_log_display(self):
506
504
        """Toggle visibility of the log buffer."""
507
505
        self.log_visible = not self.log_visible
508
506
        self.rebuild()
509
 
        self.log_message("Log visibility changed to: {}"
510
 
                         .format(self.log_visible), level=0)
 
507
        self.log_message(u"Log visibility changed to: "
 
508
                         + unicode(self.log_visible))
511
509
    
512
510
    def change_log_display(self):
513
511
        """Change type of log display.
514
512
        Currently, this toggles wrapping of text lines."""
515
 
        if self.log_wrap == "clip":
516
 
            self.log_wrap = "any"
 
513
        if self.log_wrap == u"clip":
 
514
            self.log_wrap = u"any"
517
515
        else:
518
 
            self.log_wrap = "clip"
 
516
            self.log_wrap = u"clip"
519
517
        for textwidget in self.log:
520
518
            textwidget.set_wrap_mode(self.log_wrap)
521
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
522
 
                         level=0)
 
519
        self.log_message(u"Wrap mode: " + self.log_wrap)
523
520
    
524
521
    def find_and_remove_client(self, path, name):
525
 
        """Find a client by its object path and remove it.
 
522
        """Find an client from its object path and remove it.
526
523
        
527
524
        This is connected to the ClientRemoved signal from the
528
525
        Mandos server object."""
530
527
            client = self.clients_dict[path]
531
528
        except KeyError:
532
529
            # not found?
533
 
            self.log_message("Unknown client {!r} ({!r}) removed"
534
 
                             .format(name, path))
535
530
            return
536
 
        client.delete()
 
531
        self.remove_client(client, path)
537
532
    
538
533
    def add_new_client(self, path):
539
534
        client_proxy_object = self.bus.get_object(self.busname, path)
554
549
        if path is None:
555
550
            path = client.proxy.object_path
556
551
        self.clients_dict[path] = client
557
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
552
        self.clients.sort(None, lambda c: c.properties[u"Name"])
558
553
        self.refresh()
559
554
    
560
555
    def remove_client(self, client, path=None):
562
557
        if path is None:
563
558
            path = client.proxy.object_path
564
559
        del self.clients_dict[path]
 
560
        if not self.clients_dict:
 
561
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
562
            # is completely emptied, we need to recreate it.
 
563
            self.clients = urwid.SimpleListWalker([])
 
564
            self.rebuild()
565
565
        self.refresh()
566
566
    
567
567
    def refresh(self):
571
571
    
572
572
    def run(self):
573
573
        """Start the main loop and exit when it's done."""
574
 
        self.bus = dbus.SystemBus()
575
 
        mandos_dbus_objc = self.bus.get_object(
576
 
            self.busname, "/", follow_name_owner_changes=True)
577
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
578
 
                                          dbus_interface
579
 
                                          = server_interface)
580
 
        try:
581
 
            mandos_clients = (self.mandos_serv
582
 
                              .GetAllClientsWithProperties())
583
 
            if not mandos_clients:
584
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
585
 
        except dbus.exceptions.DBusException:
586
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
587
 
            mandos_clients = dbus.Dictionary()
588
 
        
589
 
        (self.mandos_serv
590
 
         .connect_to_signal("ClientRemoved",
591
 
                            self.find_and_remove_client,
592
 
                            dbus_interface=server_interface,
593
 
                            byte_arrays=True))
594
 
        (self.mandos_serv
595
 
         .connect_to_signal("ClientAdded",
596
 
                            self.add_new_client,
597
 
                            dbus_interface=server_interface,
598
 
                            byte_arrays=True))
599
 
        (self.mandos_serv
600
 
         .connect_to_signal("ClientNotFound",
601
 
                            self.client_not_found,
602
 
                            dbus_interface=server_interface,
603
 
                            byte_arrays=True))
604
 
        for path, client in mandos_clients.items():
605
 
            client_proxy_object = self.bus.get_object(self.busname,
606
 
                                                      path)
607
 
            self.add_client(MandosClientWidget(server_proxy_object
608
 
                                               =self.mandos_serv,
609
 
                                               proxy_object
610
 
                                               =client_proxy_object,
611
 
                                               properties=client,
612
 
                                               update_hook
613
 
                                               =self.refresh,
614
 
                                               delete_hook
615
 
                                               =self.remove_client,
616
 
                                               logger
617
 
                                               =self.log_message),
618
 
                            path=path)
619
 
        
620
574
        self.refresh()
621
575
        self._input_callback_tag = (gobject.io_add_watch
622
576
                                    (sys.stdin.fileno(),
632
586
    
633
587
    def process_input(self, source, condition):
634
588
        keys = self.screen.get_input()
635
 
        translations = { "ctrl n": "down",      # Emacs
636
 
                         "ctrl p": "up",        # Emacs
637
 
                         "ctrl v": "page down", # Emacs
638
 
                         "meta v": "page up",   # Emacs
639
 
                         " ": "page down",      # less
640
 
                         "f": "page down",      # less
641
 
                         "b": "page up",        # less
642
 
                         "j": "down",           # vi
643
 
                         "k": "up",             # vi
 
589
        translations = { u"ctrl n": u"down",      # Emacs
 
590
                         u"ctrl p": u"up",        # Emacs
 
591
                         u"ctrl v": u"page down", # Emacs
 
592
                         u"meta v": u"page up",   # Emacs
 
593
                         u" ": u"page down",      # less
 
594
                         u"f": u"page down",      # less
 
595
                         u"b": u"page up",        # less
 
596
                         u"j": u"down",           # vi
 
597
                         u"k": u"up",             # vi
644
598
                         }
645
599
        for key in keys:
646
600
            try:
648
602
            except KeyError:    # :-)
649
603
                pass
650
604
            
651
 
            if key == "q" or key == "Q":
 
605
            if key == u"q" or key == u"Q":
652
606
                self.stop()
653
607
                break
654
 
            elif key == "window resize":
 
608
            elif key == u"window resize":
655
609
                self.size = self.screen.get_cols_rows()
656
610
                self.refresh()
657
 
            elif key == "ctrl l":
658
 
                self.screen.clear()
 
611
            elif key == u"\f":  # Ctrl-L
659
612
                self.refresh()
660
 
            elif key == "l" or key == "D":
 
613
            elif key == u"l" or key == u"D":
661
614
                self.toggle_log_display()
662
615
                self.refresh()
663
 
            elif key == "w" or key == "i":
 
616
            elif key == u"w" or key == u"i":
664
617
                self.change_log_display()
665
618
                self.refresh()
666
 
            elif key == "?" or key == "f1" or key == "esc":
 
619
            elif key == u"?" or key == u"f1" or key == u"esc":
667
620
                if not self.log_visible:
668
621
                    self.log_visible = True
669
622
                    self.rebuild()
670
 
                self.log_message_raw(("bold",
671
 
                                      "  ".
672
 
                                      join(("q: Quit",
673
 
                                            "?: Help",
674
 
                                            "l: Log window toggle",
675
 
                                            "TAB: Switch window",
676
 
                                            "w: Wrap (log lines)",
677
 
                                            "v: Toggle verbose log",
678
 
                                            ))))
679
 
                self.log_message_raw(("bold",
680
 
                                      "  "
681
 
                                      .join(("Clients:",
682
 
                                             "+: Enable",
683
 
                                             "-: Disable",
684
 
                                             "R: Remove",
685
 
                                             "s: Start new checker",
686
 
                                             "S: Stop checker",
687
 
                                             "C: Checker OK",
688
 
                                             "a: Approve",
689
 
                                             "d: Deny"))))
 
623
                self.log_message_raw((u"bold",
 
624
                                      u"  ".
 
625
                                      join((u"q: Quit",
 
626
                                            u"?: Help",
 
627
                                            u"l: Log window toggle",
 
628
                                            u"TAB: Switch window",
 
629
                                            u"w: Wrap (log)"))))
 
630
                self.log_message_raw((u"bold",
 
631
                                      u"  "
 
632
                                      .join((u"Clients:",
 
633
                                             u"+: Enable",
 
634
                                             u"-: Disable",
 
635
                                             u"r: Remove",
 
636
                                             u"s: Start new checker",
 
637
                                             u"S: Stop checker",
 
638
                                             u"C: Checker OK",
 
639
                                             u"a: Approve",
 
640
                                             u"d: Deny"))))
690
641
                self.refresh()
691
 
            elif key == "tab":
 
642
            elif key == u"tab":
692
643
                if self.topwidget.get_focus() is self.logbox:
693
644
                    self.topwidget.set_focus(0)
694
645
                else:
695
646
                    self.topwidget.set_focus(self.logbox)
696
647
                self.refresh()
697
 
            elif key == "v":
698
 
                if self.log_level == 0:
699
 
                    self.log_level = 1
700
 
                    self.log_message("Verbose mode: Off")
701
 
                else:
702
 
                    self.log_level = 0
703
 
                    self.log_message("Verbose mode: On")
704
 
            #elif (key == "end" or key == "meta >" or key == "G"
705
 
            #      or key == ">"):
 
648
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
649
            #      or key == u">"):
706
650
            #    pass            # xxx end-of-buffer
707
 
            #elif (key == "home" or key == "meta <" or key == "g"
708
 
            #      or key == "<"):
 
651
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
652
            #      or key == u"<"):
709
653
            #    pass            # xxx beginning-of-buffer
710
 
            #elif key == "ctrl e" or key == "$":
 
654
            #elif key == u"ctrl e" or key == u"$":
711
655
            #    pass            # xxx move-end-of-line
712
 
            #elif key == "ctrl a" or key == "^":
 
656
            #elif key == u"ctrl a" or key == u"^":
713
657
            #    pass            # xxx move-beginning-of-line
714
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
658
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
715
659
            #    pass            # xxx left
716
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
660
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
717
661
            #    pass            # xxx right
718
 
            #elif key == "a":
 
662
            #elif key == u"a":
719
663
            #    pass            # scroll up log
720
 
            #elif key == "z":
 
664
            #elif key == u"z":
721
665
            #    pass            # scroll down log
722
666
            elif self.topwidget.selectable():
723
667
                self.topwidget.keypress(self.size, key)
729
673
    ui.run()
730
674
except KeyboardInterrupt:
731
675
    ui.screen.stop()
732
 
except Exception as e:
733
 
    ui.log_message(str(e))
 
676
except Exception, e:
 
677
    ui.log_message(unicode(e))
734
678
    ui.screen.stop()
735
679
    raise