/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-07 20:53:34 UTC
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

Show diffs side-by-side

added added

removed removed

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