/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-2014 Teddy Hogeborn
7
 
# Copyright © 2009-2014 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.8"
 
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
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
 
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))
184
169
        if os.WIFEXITED(condition):
185
 
            self.logger('Checker for client {} (command "{}") failed'
186
 
                        ' with exit code {}'
187
 
                        .format(self.properties["Name"], command,
188
 
                                os.WEXITSTATUS(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)))
189
174
        elif os.WIFSIGNALED(condition):
190
 
            self.logger('Checker for client {} (command "{}") was'
191
 
                        ' killed by signal {}'
192
 
                        .format(self.properties["Name"], command,
193
 
                                os.WTERMSIG(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)))
194
179
        elif os.WCOREDUMP(condition):
195
 
            self.logger('Checker for client {} (command "{}") dumped'
196
 
                        ' core'.format(self.properties["Name"],
197
 
                                       command))
 
180
            self.logger(u'Checker for client %s (command "%s")'
 
181
                        u' dumped core'
 
182
                        % (self.properties[u"Name"], command))
198
183
        else:
199
 
            self.logger('Checker for client {} completed'
200
 
                        ' mysteriously'
201
 
                        .format(self.properties["Name"]))
 
184
            self.logger(u'Checker for client %s completed'
 
185
                        u' mysteriously')
202
186
        self.update()
203
187
    
204
188
    def checker_started(self, command):
205
 
        """Server signals that a checker started."""
206
 
        self.logger('Client {} started checker "{}"'
207
 
                    .format(self.properties["Name"],
208
 
                            command), level=0)
 
189
        #self.logger(u'Client %s started checker "%s"'
 
190
        #            % (self.properties[u"Name"], unicode(command)))
 
191
        pass
209
192
    
210
193
    def got_secret(self):
211
 
        self.logger('Client {} received its secret'
212
 
                    .format(self.properties["Name"]))
 
194
        self.last_checker_failed = False
 
195
        self.logger(u'Client %s received its secret'
 
196
                    % self.properties[u"Name"])
213
197
    
214
198
    def need_approval(self, timeout, default):
215
199
        if not default:
216
 
            message = 'Client {} needs approval within {} seconds'
 
200
            message = u'Client %s needs approval within %s seconds'
217
201
        else:
218
 
            message = 'Client {} will get its secret in {} seconds'
219
 
        self.logger(message.format(self.properties["Name"],
220
 
                                   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))
221
205
    
222
206
    def rejected(self, reason):
223
 
        self.logger('Client {} was rejected; reason: {}'
224
 
                    .format(self.properties["Name"], reason))
 
207
        self.logger(u'Client %s was rejected; reason: %s'
 
208
                    % (self.properties[u"Name"], reason))
225
209
    
226
210
    def selectable(self):
227
211
        """Make this a "selectable" widget.
228
212
        This overrides the method from urwid.FlowWidget."""
229
213
        return True
230
214
    
231
 
    def rows(self, maxcolrow, focus=False):
 
215
    def rows(self, (maxcol,), focus=False):
232
216
        """How many rows this widget will occupy might depend on
233
217
        whether we have focus or not.
234
218
        This overrides the method from urwid.FlowWidget"""
235
 
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
219
        return self.current_widget(focus).rows((maxcol,), focus=focus)
236
220
    
237
221
    def current_widget(self, focus=False):
238
222
        if focus or self.opened:
242
226
    def update(self):
243
227
        "Called when what is visible on the screen should be updated."
244
228
        # How to add standout mode to a style
245
 
        with_standout = { "normal": "standout",
246
 
                          "bold": "bold-standout",
247
 
                          "underline-blink":
248
 
                              "underline-blink-standout",
249
 
                          "bold-underline-blink":
250
 
                              "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",
251
235
                          }
252
 
        
 
236
 
253
237
        # Rebuild focus and non-focus widgets using current properties
254
 
        
 
238
 
255
239
        # Base part of a client. Name!
256
 
        base = '{name}: '.format(name=self.properties["Name"])
257
 
        if not self.properties["Enabled"]:
258
 
            message = "DISABLED"
259
 
            self.using_timer(False)
260
 
        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:
261
250
            timeout = datetime.timedelta(milliseconds
262
251
                                         = self.properties
263
 
                                         ["ApprovalDelay"])
264
 
            last_approval_request = isoformat_to_datetime(
265
 
                self.properties["LastApprovalRequest"])
266
 
            if last_approval_request is not None:
267
 
                timer = max(timeout - (datetime.datetime.utcnow()
268
 
                                       - last_approval_request),
269
 
                            datetime.timedelta())
270
 
            else:
271
 
                timer = datetime.timedelta()
272
 
            if self.properties["ApprovedByDefault"]:
273
 
                message = "Approval in {}. (d)eny?"
274
 
            else:
275
 
                message = "Denial in {}. (a)pprove?"
276
 
            message = message.format(str(timer).rsplit(".", 1)[0])
277
 
            self.using_timer(True)
278
 
        elif self.properties["LastCheckerStatus"] != 0:
279
 
            # When checker has failed, show timer until client expires
280
 
            expires = self.properties["Expires"]
281
 
            if expires == "":
282
 
                timer = datetime.timedelta(0)
283
 
            else:
284
 
                expires = (datetime.datetime.strptime
285
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
286
 
                timer = max(expires - datetime.datetime.utcnow(),
287
 
                            datetime.timedelta())
288
 
            message = ('A checker has failed! Time until client'
289
 
                       ' gets disabled: {}'
290
 
                       .format(str(timer).rsplit(".", 1)[0]))
291
 
            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])
292
261
        else:
293
 
            message = "enabled"
294
 
            self.using_timer(False)
295
 
        self._text = "{}{}".format(base, message)
296
 
        
 
262
            message = u"enabled"
 
263
        self._text = "%s%s" % (base, message)
 
264
            
297
265
        if not urwid.supports_unicode():
298
266
            self._text = self._text.encode("ascii", "replace")
299
 
        textlist = [("normal", self._text)]
 
267
        textlist = [(u"normal", self._text)]
300
268
        self._text_widget.set_text(textlist)
301
269
        self._focus_text_widget.set_text([(with_standout[text[0]],
302
270
                                           text[1])
311
279
            self.update_hook()
312
280
    
313
281
    def update_timer(self):
314
 
        """called by gobject. Will indefinitely loop until
315
 
        gobject.source_remove() on tag is called"""
 
282
        "called by gobject"
316
283
        self.update()
317
284
        return True             # Keep calling this
318
285
    
319
 
    def delete(self, **kwargs):
 
286
    def delete(self):
320
287
        if self._update_timer_callback_tag is not None:
321
288
            gobject.source_remove(self._update_timer_callback_tag)
322
289
            self._update_timer_callback_tag = None
323
 
        for match in self.match_objects:
324
 
            match.remove()
325
 
        self.match_objects = ()
326
290
        if self.delete_hook is not None:
327
291
            self.delete_hook(self)
328
 
        return super(MandosClientWidget, self).delete(**kwargs)
329
292
    
330
 
    def render(self, maxcolrow, focus=False):
 
293
    def render(self, (maxcol,), focus=False):
331
294
        """Render differently if we have focus.
332
295
        This overrides the method from urwid.FlowWidget"""
333
 
        return self.current_widget(focus).render(maxcolrow,
 
296
        return self.current_widget(focus).render((maxcol,),
334
297
                                                 focus=focus)
335
298
    
336
 
    def keypress(self, maxcolrow, key):
 
299
    def keypress(self, (maxcol,), key):
337
300
        """Handle keys.
338
301
        This overrides the method from urwid.FlowWidget"""
339
 
        if key == "+":
340
 
            self.proxy.Enable(dbus_interface = client_interface,
341
 
                              ignore_reply=True)
342
 
        elif key == "-":
343
 
            self.proxy.Disable(dbus_interface = client_interface,
344
 
                               ignore_reply=True)
345
 
        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":
346
307
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
347
 
                               dbus_interface = client_interface,
348
 
                               ignore_reply=True)
349
 
        elif key == "d":
 
308
                               dbus_interface = client_interface)
 
309
        elif key == u"d":
350
310
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
351
 
                                  dbus_interface = client_interface,
352
 
                               ignore_reply=True)
353
 
        elif key == "R" or key == "_" or key == "ctrl k":
 
311
                                  dbus_interface = client_interface)
 
312
        elif key == u"r" or key == u"_" or key == u"ctrl k":
354
313
            self.server_proxy_object.RemoveClient(self.proxy
355
 
                                                  .object_path,
356
 
                                                  ignore_reply=True)
357
 
        elif key == "s":
358
 
            self.proxy.StartChecker(dbus_interface = client_interface,
359
 
                                    ignore_reply=True)
360
 
        elif key == "S":
361
 
            self.proxy.StopChecker(dbus_interface = client_interface,
362
 
                                   ignore_reply=True)
363
 
        elif key == "C":
364
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
365
 
                                 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)
366
321
        # xxx
367
 
#         elif key == "p" or key == "=":
 
322
#         elif key == u"p" or key == "=":
368
323
#             self.proxy.pause()
369
 
#         elif key == "u" or key == ":":
 
324
#         elif key == u"u" or key == ":":
370
325
#             self.proxy.unpause()
371
 
#         elif key == "RET":
 
326
#         elif key == u"RET":
372
327
#             self.open()
 
328
#        elif key == u"+":
 
329
#            self.proxy.Approve(True)
 
330
#        elif key == u"-":
 
331
#            self.proxy.Approve(False)
373
332
        else:
374
333
            return key
375
334
    
376
 
    def properties_changed(self, interface, properties, invalidated):
377
 
        """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.
378
338
        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):
 
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:
385
344
            self.update()
386
345
 
387
346
 
390
349
    "down" key presses, thus not allowing any containing widgets to
391
350
    use them as an excuse to shift focus away from this widget.
392
351
    """
393
 
    def keypress(self, *args, **kwargs):
394
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
395
 
        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"):
396
356
            return
397
357
        return ret
398
358
 
401
361
    """This is the entire user interface - the whole screen
402
362
    with boxes, lists of client widgets, etc.
403
363
    """
404
 
    def __init__(self, max_log_length=1000, log_level=1):
 
364
    def __init__(self, max_log_length=1000):
405
365
        DBusGMainLoop(set_as_default=True)
406
366
        
407
367
        self.screen = urwid.curses_display.Screen()
408
368
        
409
369
        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"),
 
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")),
428
387
                ))
429
388
        
430
389
        if urwid.supports_unicode():
431
 
            self.divider = "─" # \u2500
432
 
            #self.divider = "━" # \u2501
 
390
            self.divider = u"─" # \u2500
 
391
            #self.divider = u"━" # \u2501
433
392
        else:
434
 
            #self.divider = "-" # \u002d
435
 
            self.divider = "_" # \u005f
 
393
            #self.divider = u"-" # \u002d
 
394
            self.divider = u"_" # \u005f
436
395
        
437
396
        self.screen.start()
438
397
        
445
404
        self.log = []
446
405
        self.max_log_length = max_log_length
447
406
        
448
 
        self.log_level = log_level
449
 
        
450
407
        # We keep a reference to the log widget so we can remove it
451
408
        # from the ListWalker without it getting destroyed
452
409
        self.logbox = ConstrainedListBox(self.log)
454
411
        # This keeps track of whether self.uilist currently has
455
412
        # self.logbox in it or not
456
413
        self.log_visible = True
457
 
        self.log_wrap = "any"
 
414
        self.log_wrap = u"any"
458
415
        
459
416
        self.rebuild()
460
 
        self.log_message_raw(("bold",
461
 
                              "Mandos Monitor version " + version))
462
 
        self.log_message_raw(("bold",
463
 
                              "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"))
464
421
        
465
422
        self.busname = domain + '.Mandos'
466
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)
467
466
    
468
467
    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))
 
468
        self.log_message((u"Client with address %s and fingerprint %s"
 
469
                          u" could not be found" % (address,
 
470
                                                    fingerprint)))
472
471
    
473
472
    def rebuild(self):
474
473
        """This rebuilds the User Interface.
484
483
                                                     self.divider)))
485
484
        if self.log_visible:
486
485
            self.uilist.append(self.logbox)
 
486
            pass
487
487
        self.topwidget = urwid.Pile(self.uilist)
488
488
    
489
 
    def log_message(self, message, level=1):
490
 
        """Log message formatted with timestamp"""
491
 
        if level < self.log_level:
492
 
            return
 
489
    def log_message(self, message):
493
490
        timestamp = datetime.datetime.now().isoformat()
494
 
        self.log_message_raw("{}: {}".format(timestamp, message),
495
 
                             level=level)
 
491
        self.log_message_raw(timestamp + u": " + message)
496
492
    
497
 
    def log_message_raw(self, markup, level=1):
 
493
    def log_message_raw(self, markup):
498
494
        """Add a log message to the log buffer."""
499
 
        if level < self.log_level:
500
 
            return
501
495
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
496
        if (self.max_log_length
503
497
            and len(self.log) > self.max_log_length):
504
498
            del self.log[0:len(self.log)-self.max_log_length-1]
505
499
        self.logbox.set_focus(len(self.logbox.body.contents),
506
 
                              coming_from="above")
 
500
                              coming_from=u"above")
507
501
        self.refresh()
508
502
    
509
503
    def toggle_log_display(self):
510
504
        """Toggle visibility of the log buffer."""
511
505
        self.log_visible = not self.log_visible
512
506
        self.rebuild()
513
 
        self.log_message("Log visibility changed to: {}"
514
 
                         .format(self.log_visible), level=0)
 
507
        self.log_message(u"Log visibility changed to: "
 
508
                         + unicode(self.log_visible))
515
509
    
516
510
    def change_log_display(self):
517
511
        """Change type of log display.
518
512
        Currently, this toggles wrapping of text lines."""
519
 
        if self.log_wrap == "clip":
520
 
            self.log_wrap = "any"
 
513
        if self.log_wrap == u"clip":
 
514
            self.log_wrap = u"any"
521
515
        else:
522
 
            self.log_wrap = "clip"
 
516
            self.log_wrap = u"clip"
523
517
        for textwidget in self.log:
524
518
            textwidget.set_wrap_mode(self.log_wrap)
525
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
526
 
                         level=0)
 
519
        self.log_message(u"Wrap mode: " + self.log_wrap)
527
520
    
528
521
    def find_and_remove_client(self, path, name):
529
 
        """Find a client by its object path and remove it.
 
522
        """Find an client from its object path and remove it.
530
523
        
531
524
        This is connected to the ClientRemoved signal from the
532
525
        Mandos server object."""
534
527
            client = self.clients_dict[path]
535
528
        except KeyError:
536
529
            # not found?
537
 
            self.log_message("Unknown client {!r} ({!r}) removed"
538
 
                             .format(name, path))
539
530
            return
540
 
        client.delete()
 
531
        self.remove_client(client, path)
541
532
    
542
533
    def add_new_client(self, path):
543
534
        client_proxy_object = self.bus.get_object(self.busname, path)
558
549
        if path is None:
559
550
            path = client.proxy.object_path
560
551
        self.clients_dict[path] = client
561
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
552
        self.clients.sort(None, lambda c: c.properties[u"Name"])
562
553
        self.refresh()
563
554
    
564
555
    def remove_client(self, client, path=None):
566
557
        if path is None:
567
558
            path = client.proxy.object_path
568
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()
569
565
        self.refresh()
570
566
    
571
567
    def refresh(self):
575
571
    
576
572
    def run(self):
577
573
        """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
574
        self.refresh()
625
575
        self._input_callback_tag = (gobject.io_add_watch
626
576
                                    (sys.stdin.fileno(),
636
586
    
637
587
    def process_input(self, source, condition):
638
588
        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
 
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
648
598
                         }
649
599
        for key in keys:
650
600
            try:
652
602
            except KeyError:    # :-)
653
603
                pass
654
604
            
655
 
            if key == "q" or key == "Q":
 
605
            if key == u"q" or key == u"Q":
656
606
                self.stop()
657
607
                break
658
 
            elif key == "window resize":
 
608
            elif key == u"window resize":
659
609
                self.size = self.screen.get_cols_rows()
660
610
                self.refresh()
661
 
            elif key == "ctrl l":
662
 
                self.screen.clear()
 
611
            elif key == u"\f":  # Ctrl-L
663
612
                self.refresh()
664
 
            elif key == "l" or key == "D":
 
613
            elif key == u"l" or key == u"D":
665
614
                self.toggle_log_display()
666
615
                self.refresh()
667
 
            elif key == "w" or key == "i":
 
616
            elif key == u"w" or key == u"i":
668
617
                self.change_log_display()
669
618
                self.refresh()
670
 
            elif key == "?" or key == "f1" or key == "esc":
 
619
            elif key == u"?" or key == u"f1" or key == u"esc":
671
620
                if not self.log_visible:
672
621
                    self.log_visible = True
673
622
                    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"))))
 
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"))))
694
641
                self.refresh()
695
 
            elif key == "tab":
 
642
            elif key == u"tab":
696
643
                if self.topwidget.get_focus() is self.logbox:
697
644
                    self.topwidget.set_focus(0)
698
645
                else:
699
646
                    self.topwidget.set_focus(self.logbox)
700
647
                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 == ">"):
 
648
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
649
            #      or key == u">"):
710
650
            #    pass            # xxx end-of-buffer
711
 
            #elif (key == "home" or key == "meta <" or key == "g"
712
 
            #      or key == "<"):
 
651
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
652
            #      or key == u"<"):
713
653
            #    pass            # xxx beginning-of-buffer
714
 
            #elif key == "ctrl e" or key == "$":
 
654
            #elif key == u"ctrl e" or key == u"$":
715
655
            #    pass            # xxx move-end-of-line
716
 
            #elif key == "ctrl a" or key == "^":
 
656
            #elif key == u"ctrl a" or key == u"^":
717
657
            #    pass            # xxx move-beginning-of-line
718
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
658
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
719
659
            #    pass            # xxx left
720
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
660
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
721
661
            #    pass            # xxx right
722
 
            #elif key == "a":
 
662
            #elif key == u"a":
723
663
            #    pass            # scroll up log
724
 
            #elif key == "z":
 
664
            #elif key == u"z":
725
665
            #    pass            # scroll down log
726
666
            elif self.topwidget.selectable():
727
667
                self.topwidget.keypress(self.size, key)
733
673
    ui.run()
734
674
except KeyboardInterrupt:
735
675
    ui.screen.stop()
736
 
except Exception as e:
737
 
    ui.log_message(str(e))
 
676
except Exception, e:
 
677
    ui.log_message(unicode(e))
738
678
    ui.screen.stop()
739
679
    raise