/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-monitor

  • Committer: Teddy Hogeborn
  • Date: 2019-09-04 21:12:32 UTC
  • mfrom: (1178 trunk)
  • mto: This revision was merged to the branch mainline in revision 1179.
  • Revision ID: teddy@recompile.se-20190904211232-qwuiramck8i8wmhe
Merge from trunk

Show diffs side-by-side

added added

removed removed

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