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