/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 Hogeborn
  • Date: 2011-07-13 01:11:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110713011112-bgf3tenqq60uoyyb
* Makefile (plugins.d/mandos-client): Bug fix: Put $^ before all
                                      libraries.  Remove "$(COMMON)".
                                      Thanks to Angel Abad
                                      <angelabad@ubuntu.com>.
* initramfs-tools-script: Work around change in initramfs-tools,
                          Debian bug #633582.
* plugins.d/mandos-client.c (init_gnutls_global): Bug fix: check for
                errors from gnutls_certificate_allocate_credentials().

Show diffs side-by-side

added added

removed removed

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