/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: teddy at bsnet
  • Date: 2010-09-27 17:39:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927173903-9s5e6a3hl5iswmp7
* mandos: Fixed "--help" output.
* mandos.xml (SYNOPSIS, OPTIONS): Document new option "--debuglevel".

Show diffs side-by-side

added added

removed removed

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