/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: 2017-02-21 18:23:54 UTC
  • Revision ID: teddy@recompile.se-20170221182354-qjl75f74t02bbm5n
Suppress lintian warning about lsb-base dependency

This warning is erroneous since we do depend on lsb-base, we just also
depend on systemd-sysv as an alternative, since if that is installed,
the /etc/init.d/mandos script (which is the thing which actually
requires lsb-base) is never run anyway.  Suppress this warning.

* debian/mandos.lintian-overrides (mandos): Add new line
  "init.d-script-needs-depends-on-lsb-base etc/init.d/mandos (line
  49)"

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