/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: 2019-12-04 23:35:08 UTC
  • Revision ID: teddy@recompile.se-20191204233508-npy5ss0cd3q23x9v
Minor refactor of Python code: Move "str = unicode" to top

* mandos: Move "str = unicode" to top of file.
* mandos-ctl: - '' -

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