/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-monitor

* mandos: Use the new argparse library instead of optparse.
* debian/control (mandos): Depend on python (<=2.7) | python-argparse

Show diffs side-by-side

added added

removed removed

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