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