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