/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 21:42:08 UTC
  • Revision ID: teddy@recompile.se-20170221214208-09wu1p4l2hjhqfoj
Use "read -r" in shell scripts to avoid backslash escapes

* initramfs-tools-hook: Use "read -r" to read filenames from network
  hook given the "files" argument.
* initramfs-tools-script: Use "read -e" when parsing
  "/conf/conf.d/cryptroot".
* mandos-keygen (keygen): Use "read -r" when reading passphrase.

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