/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 at recompile
  • Date: 2020-02-05 21:39:28 UTC
  • Revision ID: teddy@recompile.se-20200205213928-vpvt0fwfg47ikv6f
Allow users to alter ask-password-mandos.service

If a user uses dracut with systemd and wishes to modify the options
passed to password-agent(8mandos) or mandos-client(8mandos), they
should be able to do so by simply creating a file
/etc/systemd/system/ask-password-mandos.service.d/override.conf,
containing, for instance:

[Service]
Environment=MANDOS_CLIENT_OPTIONS=--debug

Adding PASSWORD_AGENT_OPTIONS should also be possible (but should not
normally be needed).

* dracut-module/ask-password-mandos.service ([Service]/ExecStart): Add
  $PASSWORD_AGENT_OPTIONS before "--" and "$MANDOS_CLIENT_OPTIONS" to
  end of line.
* dracut-module/module-setup.sh (install): Install all files named
  /etc/systemd/system/ask-password-mandos.service.d/*.conf if any
  exists.  Also add --dh-params before $MANDOS_CLIENT_OPTIONS instead
  of at end of line.

Show diffs side-by-side

added added

removed removed

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