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