/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:
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-2016 Teddy Hogeborn
7
 
# Copyright © 2009-2016 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
 
from gi.repository import GLib
 
16
import gobject
43
17
 
44
18
import dbus
45
19
 
 
20
import UserList
 
21
 
46
22
import locale
47
23
 
48
 
if sys.version_info.major == 2:
49
 
    str = unicode
50
 
 
51
 
locale.setlocale(locale.LC_ALL, '')
 
24
locale.setlocale(locale.LC_ALL, u'')
52
25
 
53
26
import logging
54
27
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
55
28
 
56
29
# Some useful constants
57
 
domain = 'se.recompile'
 
30
domain = 'se.bsnet.fukt'
58
31
server_interface = domain + '.Mandos'
59
32
client_interface = domain + '.Mandos.Client'
60
 
version = "1.7.7"
61
 
 
62
 
try:
63
 
    dbus.OBJECT_MANAGER_IFACE
64
 
except AttributeError:
65
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
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)
66
42
 
67
43
def isoformat_to_datetime(iso):
68
44
    "Parse an ISO 8601 date string to a datetime.datetime()"
69
45
    if not iso:
70
46
        return None
71
 
    d, t = iso.split("T", 1)
72
 
    year, month, day = d.split("-", 2)
73
 
    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)
74
50
    second, fraction = divmod(float(second), 1)
75
51
    return datetime.datetime(int(year),
76
52
                             int(month),
85
61
    properties and calls a hook function when any of them are
86
62
    changed.
87
63
    """
88
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
64
    def __init__(self, proxy_object=None, *args, **kwargs):
89
65
        self.proxy = proxy_object # Mandos Client proxy object
90
 
        self.properties = dict() if properties is None else properties
91
 
        self.property_changed_match = (
92
 
            self.proxy.connect_to_signal("PropertiesChanged",
93
 
                                         self.properties_changed,
94
 
                                         dbus.PROPERTIES_IFACE,
95
 
                                         byte_arrays=True))
96
 
        
97
 
        if properties is None:
98
 
            self.properties.update(
99
 
                self.proxy.GetAll(client_interface,
100
 
                                  dbus_interface
101
 
                                  = dbus.PROPERTIES_IFACE))
102
 
        
103
 
        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)
104
80
    
105
 
    def properties_changed(self, interface, properties, invalidated):
106
 
        """This is called whenever we get a PropertiesChanged signal
107
 
        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.
108
84
        """
109
85
        # Update properties dict with new value
110
 
        if interface == client_interface:
111
 
            self.properties.update(properties)
112
 
    
113
 
    def delete(self):
114
 
        self.property_changed_match.remove()
 
86
        self.properties[property] = value
115
87
 
116
88
 
117
89
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
91
    """
120
92
    
121
93
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, **kwargs):
 
94
                 delete_hook=None, logger=None, *args, **kwargs):
123
95
        # Called on update
124
96
        self.update_hook = update_hook
125
97
        # Called on delete
130
102
        self.logger = logger
131
103
        
132
104
        self._update_timer_callback_tag = None
 
105
        self.last_checker_failed = False
133
106
        
134
107
        # The widget shown normally
135
 
        self._text_widget = urwid.Text("")
 
108
        self._text_widget = urwid.Text(u"")
136
109
        # The widget shown when we have focus
137
 
        self._focus_text_widget = urwid.Text("")
138
 
        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)
139
114
        self.update()
140
115
        self.opened = False
141
 
        
142
 
        self.match_objects = (
143
 
            self.proxy.connect_to_signal("CheckerCompleted",
144
 
                                         self.checker_completed,
145
 
                                         client_interface,
146
 
                                         byte_arrays=True),
147
 
            self.proxy.connect_to_signal("CheckerStarted",
148
 
                                         self.checker_started,
149
 
                                         client_interface,
150
 
                                         byte_arrays=True),
151
 
            self.proxy.connect_to_signal("GotSecret",
152
 
                                         self.got_secret,
153
 
                                         client_interface,
154
 
                                         byte_arrays=True),
155
 
            self.proxy.connect_to_signal("NeedApproval",
156
 
                                         self.need_approval,
157
 
                                         client_interface,
158
 
                                         byte_arrays=True),
159
 
            self.proxy.connect_to_signal("Rejected",
160
 
                                         self.rejected,
161
 
                                         client_interface,
162
 
                                         byte_arrays=True))
163
 
        self.logger('Created client {}'
164
 
                    .format(self.properties["Name"]), level=0)
165
 
    
166
 
    def using_timer(self, flag):
167
 
        """Call this method with True or False when timer should be
168
 
        activated or deactivated.
169
 
        """
170
 
        if flag and self._update_timer_callback_tag is None:
171
 
            # Will update the shown timer value every second
172
 
            self._update_timer_callback_tag = (GLib.timeout_add
 
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:
 
148
            self._update_timer_callback_tag = (gobject.timeout_add
173
149
                                               (1000,
174
150
                                                self.update_timer))
175
 
        elif not (flag or self._update_timer_callback_tag is None):
176
 
            GLib.source_remove(self._update_timer_callback_tag)
177
 
            self._update_timer_callback_tag = None
178
151
    
179
152
    def checker_completed(self, exitstatus, condition, command):
180
153
        if exitstatus == 0:
181
 
            self.logger('Checker for client {} (command "{}")'
182
 
                        ' succeeded'.format(self.properties["Name"],
183
 
                                            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))
184
161
            self.update()
185
162
            return
186
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))
187
169
        if os.WIFEXITED(condition):
188
 
            self.logger('Checker for client {} (command "{}") failed'
189
 
                        ' with exit code {}'
190
 
                        .format(self.properties["Name"], command,
191
 
                                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)))
192
174
        elif os.WIFSIGNALED(condition):
193
 
            self.logger('Checker for client {} (command "{}") was'
194
 
                        ' killed by signal {}'
195
 
                        .format(self.properties["Name"], command,
196
 
                                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)))
 
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))
 
183
        else:
 
184
            self.logger(u'Checker for client %s completed'
 
185
                        u' mysteriously')
197
186
        self.update()
198
187
    
199
188
    def checker_started(self, command):
200
 
        """Server signals that a checker started."""
201
 
        self.logger('Client {} started checker "{}"'
202
 
                    .format(self.properties["Name"],
203
 
                            command), level=0)
 
189
        #self.logger(u'Client %s started checker "%s"'
 
190
        #            % (self.properties[u"Name"], unicode(command)))
 
191
        pass
204
192
    
205
193
    def got_secret(self):
206
 
        self.logger('Client {} received its secret'
207
 
                    .format(self.properties["Name"]))
 
194
        self.last_checker_failed = False
 
195
        self.logger(u'Client %s received its secret'
 
196
                    % self.properties[u"Name"])
208
197
    
209
198
    def need_approval(self, timeout, default):
210
199
        if not default:
211
 
            message = 'Client {} needs approval within {} seconds'
 
200
            message = u'Client %s needs approval within %s seconds'
212
201
        else:
213
 
            message = 'Client {} will get its secret in {} seconds'
214
 
        self.logger(message.format(self.properties["Name"],
215
 
                                   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))
216
205
    
217
206
    def rejected(self, reason):
218
 
        self.logger('Client {} was rejected; reason: {}'
219
 
                    .format(self.properties["Name"], reason))
 
207
        self.logger(u'Client %s was rejected; reason: %s'
 
208
                    % (self.properties[u"Name"], reason))
220
209
    
221
210
    def selectable(self):
222
211
        """Make this a "selectable" widget.
223
212
        This overrides the method from urwid.FlowWidget."""
224
213
        return True
225
214
    
226
 
    def rows(self, maxcolrow, focus=False):
 
215
    def rows(self, (maxcol,), focus=False):
227
216
        """How many rows this widget will occupy might depend on
228
217
        whether we have focus or not.
229
218
        This overrides the method from urwid.FlowWidget"""
230
 
        return self.current_widget(focus).rows(maxcolrow, focus=focus)
 
219
        return self.current_widget(focus).rows((maxcol,), focus=focus)
231
220
    
232
221
    def current_widget(self, focus=False):
233
222
        if focus or self.opened:
237
226
    def update(self):
238
227
        "Called when what is visible on the screen should be updated."
239
228
        # How to add standout mode to a style
240
 
        with_standout = { "normal": "standout",
241
 
                          "bold": "bold-standout",
242
 
                          "underline-blink":
243
 
                              "underline-blink-standout",
244
 
                          "bold-underline-blink":
245
 
                              "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",
246
235
                          }
247
 
        
 
236
 
248
237
        # Rebuild focus and non-focus widgets using current properties
249
 
        
 
238
 
250
239
        # Base part of a client. Name!
251
 
        base = '{name}: '.format(name=self.properties["Name"])
252
 
        if not self.properties["Enabled"]:
253
 
            message = "DISABLED"
254
 
            self.using_timer(False)
255
 
        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:
256
250
            timeout = datetime.timedelta(milliseconds
257
251
                                         = self.properties
258
 
                                         ["ApprovalDelay"])
259
 
            last_approval_request = isoformat_to_datetime(
260
 
                self.properties["LastApprovalRequest"])
261
 
            if last_approval_request is not None:
262
 
                timer = max(timeout - (datetime.datetime.utcnow()
263
 
                                       - last_approval_request),
264
 
                            datetime.timedelta())
265
 
            else:
266
 
                timer = datetime.timedelta()
267
 
            if self.properties["ApprovedByDefault"]:
268
 
                message = "Approval in {}. (d)eny?"
269
 
            else:
270
 
                message = "Denial in {}. (a)pprove?"
271
 
            message = message.format(str(timer).rsplit(".", 1)[0])
272
 
            self.using_timer(True)
273
 
        elif self.properties["LastCheckerStatus"] != 0:
274
 
            # When checker has failed, show timer until client expires
275
 
            expires = self.properties["Expires"]
276
 
            if expires == "":
277
 
                timer = datetime.timedelta(0)
278
 
            else:
279
 
                expires = (datetime.datetime.strptime
280
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
281
 
                timer = max(expires - datetime.datetime.utcnow(),
282
 
                            datetime.timedelta())
283
 
            message = ('A checker has failed! Time until client'
284
 
                       ' gets disabled: {}'
285
 
                       .format(str(timer).rsplit(".", 1)[0]))
286
 
            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])
287
261
        else:
288
 
            message = "enabled"
289
 
            self.using_timer(False)
290
 
        self._text = "{}{}".format(base, message)
291
 
        
 
262
            message = u"enabled"
 
263
        self._text = "%s%s" % (base, message)
 
264
            
292
265
        if not urwid.supports_unicode():
293
266
            self._text = self._text.encode("ascii", "replace")
294
 
        textlist = [("normal", self._text)]
 
267
        textlist = [(u"normal", self._text)]
295
268
        self._text_widget.set_text(textlist)
296
269
        self._focus_text_widget.set_text([(with_standout[text[0]],
297
270
                                           text[1])
306
279
            self.update_hook()
307
280
    
308
281
    def update_timer(self):
309
 
        """called by GLib. Will indefinitely loop until
310
 
        GLib.source_remove() on tag is called
311
 
        """
 
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
 
            GLib.source_remove(self._update_timer_callback_tag)
 
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.Set(client_interface, "Enabled",
337
 
                           dbus.Boolean(True), ignore_reply = True,
338
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
339
 
        elif key == "-":
340
 
            self.proxy.Set(client_interface, "Enabled", False,
341
 
                           ignore_reply = True,
342
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
343
 
        elif key == "a":
 
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":
344
307
            self.proxy.Approve(dbus.Boolean(True, variant_level=1),
345
 
                               dbus_interface = client_interface,
346
 
                               ignore_reply=True)
347
 
        elif key == "d":
 
308
                               dbus_interface = client_interface)
 
309
        elif key == u"d":
348
310
            self.proxy.Approve(dbus.Boolean(False, variant_level=1),
349
 
                                  dbus_interface = client_interface,
350
 
                               ignore_reply=True)
351
 
        elif key == "R" or key == "_" or key == "ctrl k":
 
311
                                  dbus_interface = client_interface)
 
312
        elif key == u"r" or key == u"_" or key == u"ctrl k":
352
313
            self.server_proxy_object.RemoveClient(self.proxy
353
 
                                                  .object_path,
354
 
                                                  ignore_reply=True)
355
 
        elif key == "s":
356
 
            self.proxy.Set(client_interface, "CheckerRunning",
357
 
                           dbus.Boolean(True), ignore_reply = True,
358
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
359
 
        elif key == "S":
360
 
            self.proxy.Set(client_interface, "CheckerRunning",
361
 
                           dbus.Boolean(False), ignore_reply = True,
362
 
                           dbus_interface = dbus.PROPERTIES_IFACE)
363
 
        elif key == "C":
364
 
            self.proxy.CheckedOK(dbus_interface = client_interface,
365
 
                                 ignore_reply=True)
 
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
 
        self.main_loop = GLib.MainLoop()
 
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
 
    def find_and_remove_client(self, path, interfaces):
529
 
        """Find a client by its object path and remove it.
 
521
    def find_and_remove_client(self, path, name):
 
522
        """Find an client from its object path and remove it.
530
523
        
531
 
        This is connected to the InterfacesRemoved signal from the
 
524
        This is connected to the ClientRemoved signal from the
532
525
        Mandos server object."""
533
 
        if client_interface not in interfaces:
534
 
            # Not a Mandos client object; ignore
535
 
            return
536
526
        try:
537
527
            client = self.clients_dict[path]
538
528
        except KeyError:
539
529
            # not found?
540
 
            self.log_message("Unknown client {!r} removed"
541
 
                             .format(path))
542
530
            return
543
 
        client.delete()
 
531
        self.remove_client(client, path)
544
532
    
545
 
    def add_new_client(self, path, ifs_and_props):
546
 
        """Find a client by its object path and remove it.
547
 
        
548
 
        This is connected to the InterfacesAdded signal from the
549
 
        Mandos server object.
550
 
        """
551
 
        if client_interface not in ifs_and_props:
552
 
            # Not a Mandos client object; ignore
553
 
            return
 
533
    def add_new_client(self, path):
554
534
        client_proxy_object = self.bus.get_object(self.busname, path)
555
535
        self.add_client(MandosClientWidget(server_proxy_object
556
536
                                           =self.mandos_serv,
561
541
                                           delete_hook
562
542
                                           =self.remove_client,
563
543
                                           logger
564
 
                                           =self.log_message,
565
 
                                           properties
566
 
                                           = dict(ifs_and_props[
567
 
                                               client_interface])),
 
544
                                           =self.log_message),
568
545
                        path=path)
569
546
    
570
547
    def add_client(self, client, path=None):
572
549
        if path is None:
573
550
            path = client.proxy.object_path
574
551
        self.clients_dict[path] = client
575
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
552
        self.clients.sort(None, lambda c: c.properties[u"Name"])
576
553
        self.refresh()
577
554
    
578
555
    def remove_client(self, client, path=None):
580
557
        if path is None:
581
558
            path = client.proxy.object_path
582
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()
583
565
        self.refresh()
584
566
    
585
567
    def refresh(self):
589
571
    
590
572
    def run(self):
591
573
        """Start the main loop and exit when it's done."""
592
 
        self.bus = dbus.SystemBus()
593
 
        mandos_dbus_objc = self.bus.get_object(
594
 
            self.busname, "/", follow_name_owner_changes=True)
595
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
596
 
                                          dbus_interface
597
 
                                          = server_interface)
598
 
        try:
599
 
            mandos_clients = (self.mandos_serv
600
 
                              .GetAllClientsWithProperties())
601
 
            if not mandos_clients:
602
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
603
 
        except dbus.exceptions.DBusException:
604
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
605
 
            mandos_clients = dbus.Dictionary()
606
 
        
607
 
        (self.mandos_serv
608
 
         .connect_to_signal("InterfacesRemoved",
609
 
                            self.find_and_remove_client,
610
 
                            dbus_interface
611
 
                            = dbus.OBJECT_MANAGER_IFACE,
612
 
                            byte_arrays=True))
613
 
        (self.mandos_serv
614
 
         .connect_to_signal("InterfacesAdded",
615
 
                            self.add_new_client,
616
 
                            dbus_interface
617
 
                            = dbus.OBJECT_MANAGER_IFACE,
618
 
                            byte_arrays=True))
619
 
        (self.mandos_serv
620
 
         .connect_to_signal("ClientNotFound",
621
 
                            self.client_not_found,
622
 
                            dbus_interface=server_interface,
623
 
                            byte_arrays=True))
624
 
        for path, client in mandos_clients.items():
625
 
            client_proxy_object = self.bus.get_object(self.busname,
626
 
                                                      path)
627
 
            self.add_client(MandosClientWidget(server_proxy_object
628
 
                                               =self.mandos_serv,
629
 
                                               proxy_object
630
 
                                               =client_proxy_object,
631
 
                                               properties=client,
632
 
                                               update_hook
633
 
                                               =self.refresh,
634
 
                                               delete_hook
635
 
                                               =self.remove_client,
636
 
                                               logger
637
 
                                               =self.log_message),
638
 
                            path=path)
639
 
        
640
574
        self.refresh()
641
 
        self._input_callback_tag = (GLib.io_add_watch
 
575
        self._input_callback_tag = (gobject.io_add_watch
642
576
                                    (sys.stdin.fileno(),
643
 
                                     GLib.IO_IN,
 
577
                                     gobject.IO_IN,
644
578
                                     self.process_input))
645
579
        self.main_loop.run()
646
580
        # Main loop has finished, we should close everything now
647
 
        GLib.source_remove(self._input_callback_tag)
 
581
        gobject.source_remove(self._input_callback_tag)
648
582
        self.screen.stop()
649
583
    
650
584
    def stop(self):
652
586
    
653
587
    def process_input(self, source, condition):
654
588
        keys = self.screen.get_input()
655
 
        translations = { "ctrl n": "down",      # Emacs
656
 
                         "ctrl p": "up",        # Emacs
657
 
                         "ctrl v": "page down", # Emacs
658
 
                         "meta v": "page up",   # Emacs
659
 
                         " ": "page down",      # less
660
 
                         "f": "page down",      # less
661
 
                         "b": "page up",        # less
662
 
                         "j": "down",           # vi
663
 
                         "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
664
598
                         }
665
599
        for key in keys:
666
600
            try:
668
602
            except KeyError:    # :-)
669
603
                pass
670
604
            
671
 
            if key == "q" or key == "Q":
 
605
            if key == u"q" or key == u"Q":
672
606
                self.stop()
673
607
                break
674
 
            elif key == "window resize":
 
608
            elif key == u"window resize":
675
609
                self.size = self.screen.get_cols_rows()
676
610
                self.refresh()
677
 
            elif key == "ctrl l":
678
 
                self.screen.clear()
 
611
            elif key == u"\f":  # Ctrl-L
679
612
                self.refresh()
680
 
            elif key == "l" or key == "D":
 
613
            elif key == u"l" or key == u"D":
681
614
                self.toggle_log_display()
682
615
                self.refresh()
683
 
            elif key == "w" or key == "i":
 
616
            elif key == u"w" or key == u"i":
684
617
                self.change_log_display()
685
618
                self.refresh()
686
 
            elif key == "?" or key == "f1" or key == "esc":
 
619
            elif key == u"?" or key == u"f1" or key == u"esc":
687
620
                if not self.log_visible:
688
621
                    self.log_visible = True
689
622
                    self.rebuild()
690
 
                self.log_message_raw(("bold",
691
 
                                      "  ".
692
 
                                      join(("q: Quit",
693
 
                                            "?: Help",
694
 
                                            "l: Log window toggle",
695
 
                                            "TAB: Switch window",
696
 
                                            "w: Wrap (log lines)",
697
 
                                            "v: Toggle verbose log",
698
 
                                            ))))
699
 
                self.log_message_raw(("bold",
700
 
                                      "  "
701
 
                                      .join(("Clients:",
702
 
                                             "+: Enable",
703
 
                                             "-: Disable",
704
 
                                             "R: Remove",
705
 
                                             "s: Start new checker",
706
 
                                             "S: Stop checker",
707
 
                                             "C: Checker OK",
708
 
                                             "a: Approve",
709
 
                                             "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"))))
710
641
                self.refresh()
711
 
            elif key == "tab":
 
642
            elif key == u"tab":
712
643
                if self.topwidget.get_focus() is self.logbox:
713
644
                    self.topwidget.set_focus(0)
714
645
                else:
715
646
                    self.topwidget.set_focus(self.logbox)
716
647
                self.refresh()
717
 
            elif key == "v":
718
 
                if self.log_level == 0:
719
 
                    self.log_level = 1
720
 
                    self.log_message("Verbose mode: Off")
721
 
                else:
722
 
                    self.log_level = 0
723
 
                    self.log_message("Verbose mode: On")
724
 
            #elif (key == "end" or key == "meta >" or key == "G"
725
 
            #      or key == ">"):
 
648
            #elif (key == u"end" or key == u"meta >" or key == u"G"
 
649
            #      or key == u">"):
726
650
            #    pass            # xxx end-of-buffer
727
 
            #elif (key == "home" or key == "meta <" or key == "g"
728
 
            #      or key == "<"):
 
651
            #elif (key == u"home" or key == u"meta <" or key == u"g"
 
652
            #      or key == u"<"):
729
653
            #    pass            # xxx beginning-of-buffer
730
 
            #elif key == "ctrl e" or key == "$":
 
654
            #elif key == u"ctrl e" or key == u"$":
731
655
            #    pass            # xxx move-end-of-line
732
 
            #elif key == "ctrl a" or key == "^":
 
656
            #elif key == u"ctrl a" or key == u"^":
733
657
            #    pass            # xxx move-beginning-of-line
734
 
            #elif key == "ctrl b" or key == "meta (" or key == "h":
 
658
            #elif key == u"ctrl b" or key == u"meta (" or key == u"h":
735
659
            #    pass            # xxx left
736
 
            #elif key == "ctrl f" or key == "meta )" or key == "l":
 
660
            #elif key == u"ctrl f" or key == u"meta )" or key == u"l":
737
661
            #    pass            # xxx right
738
 
            #elif key == "a":
 
662
            #elif key == u"a":
739
663
            #    pass            # scroll up log
740
 
            #elif key == "z":
 
664
            #elif key == u"z":
741
665
            #    pass            # scroll down log
742
666
            elif self.topwidget.selectable():
743
667
                self.topwidget.keypress(self.size, key)
749
673
    ui.run()
750
674
except KeyboardInterrupt:
751
675
    ui.screen.stop()
752
 
except Exception as e:
753
 
    ui.log_message(str(e))
 
676
except Exception, e:
 
677
    ui.log_message(unicode(e))
754
678
    ui.screen.stop()
755
679
    raise