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