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