/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-10 04:20:26 UTC
  • Revision ID: teddy@recompile.se-20190210042026-3ntr3anw5scz07s0
Update copyright year to 2019

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