/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: 2019-02-28 21:45:13 UTC
  • Revision ID: teddy@recompile.se-20190228214513-58glsld2x80fq684
mandos-ctl: Refactor and add more tests

* mandos-ctl (string_to_delta): Factor out old-style parsing to its
                                own function.  Log a warning if
                                old-style parsing is invoked.
  (parse_pre_1_6_1_interval): New; factored out of string_to_delta.
                              Also added more tests.

Show diffs side-by-side

added added

removed removed

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