/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2017-02-23 19:11:11 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 358.
  • Revision ID: teddy@recompile.se-20170223191111-poodzw0cr26utaz0
Update copyright year to 2017

* DBUS-API: Update copyright year to 2017.
* debian/copyright: - '' -
* intro.xml: - '' -
* mandos: - '' -
* mandos-clients.conf.xml: - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml: - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml: - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml: - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml: - '' -

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