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