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 736
- compare with another revision
- download diff
- download tarball
- view history from revision 736
- Committer: Teddy Hogeborn
- Date: 2014-10-05 20:59:36 UTC
- mfrom: (237.4.55 release)
- Revision ID: teddy@recompile.se-20141005205936-jz4fepv68d3r6a9u
Merge from release branch.
- files added:
- debian/mandos-client.examples
- debian/upstream
- files modified:
- .bzrignore
added
removed
mandos-monitor
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
6
# Copyright © 2009-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 Björn Påhlsson
6
# Copyright © 2009-2014 Teddy Hogeborn
7
# Copyright © 2009-2014 Björn Påhlsson
8
8
#
9
9
# This program is free software: you can redistribute it and/or modify
10
10
# it under the terms of the GNU General Public License as published by
17
17
# GNU General Public License for more details.
18
18
#
19
19
# You should have received a copy of the GNU General Public License
20
# along with this program. If not, see <http://www.gnu.org/licenses/>.
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
21
22
#
22
23
# Contact the authors at <mandos@recompile.se>.
23
24
#
24
25
25
26
from __future__ import (division, absolute_import, print_function,
26
27
unicode_literals)
28
try:
29
from future_builtins import *
30
except ImportError:
31
pass
27
32
28
33
import sys
29
34
import os
30
import signal
31
35
32
36
import datetime
33
37
35
39
import urwid
36
40
37
41
from dbus.mainloop.glib import DBusGMainLoop
38
import gobject
42
try:
43
import gobject
44
except ImportError:
45
from gi.repository import GObject as gobject
39
46
40
47
import dbus
41
48
42
import UserList
43
44
49
import locale
45
50
51
if sys.version_info.major == 2:
52
str = unicode
53
46
54
locale.setlocale(locale.LC_ALL, '')
47
55
48
56
import logging
52
60
domain = 'se.recompile'
53
61
server_interface = domain + '.Mandos'
54
62
client_interface = domain + '.Mandos.Client'
55
version = "1.5.3"
56
57
# Always run in monochrome mode
58
urwid.curses_display.curses.has_colors = lambda : False
59
60
# Urwid doesn't support blinking, but we want it. Since we have no
61
# use for underline on its own, we make underline also always blink.
62
urwid.curses_display.curses.A_UNDERLINE |= (
63
urwid.curses_display.curses.A_BLINK)
63
version = "1.6.9"
64
64
65
65
def isoformat_to_datetime(iso):
66
66
"Parse an ISO 8601 date string to a datetime.datetime()"
83
83
properties and calls a hook function when any of them are
84
84
changed.
85
85
"""
86
def __init__(self, proxy_object=None, *args, **kwargs):
86
def __init__(self, proxy_object=None, properties=None, **kwargs):
87
87
self.proxy = proxy_object # Mandos Client proxy object
88
89
self.properties = dict()
88
self.properties = dict() if properties is None else properties
90
89
self.property_changed_match = (
91
self.proxy.connect_to_signal("PropertyChanged",
92
self.property_changed,
93
client_interface,
90
self.proxy.connect_to_signal("PropertiesChanged",
91
self.properties_changed,
92
dbus.PROPERTIES_IFACE,
94
93
byte_arrays=True))
95
94
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface = dbus.PROPERTIES_IFACE))
99
100
#XXX This breaks good super behaviour
101
# super(MandosClientPropertyCache, self).__init__(
102
# *args, **kwargs)
95
if properties is None:
96
self.properties.update(
97
self.proxy.GetAll(client_interface,
98
dbus_interface
99
= dbus.PROPERTIES_IFACE))
100
101
super(MandosClientPropertyCache, self).__init__(**kwargs)
103
102
104
def property_changed(self, property=None, value=None):
105
"""This is called whenever we get a PropertyChanged signal
106
It updates the changed property in the "properties" dict.
103
def properties_changed(self, interface, properties, invalidated):
104
"""This is called whenever we get a PropertiesChanged signal
105
It updates the changed properties in the "properties" dict.
107
106
"""
108
107
# Update properties dict with new value
109
self.properties[property] = value
108
self.properties.update(properties)
110
109
111
def delete(self, *args, **kwargs):
110
def delete(self):
112
111
self.property_changed_match.remove()
113
super(MandosClientPropertyCache, self).__init__(
114
*args, **kwargs)
115
112
116
113
117
114
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
116
"""
120
117
121
118
def __init__(self, server_proxy_object=None, update_hook=None,
122
delete_hook=None, logger=None, *args, **kwargs):
119
delete_hook=None, logger=None, **kwargs):
123
120
# Called on update
124
121
self.update_hook = update_hook
125
122
# Called on delete
130
127
self.logger = logger
131
128
132
129
self._update_timer_callback_tag = None
133
self._update_timer_callback_lock = 0
134
130
135
131
# The widget shown normally
136
132
self._text_widget = urwid.Text("")
137
133
# The widget shown when we have focus
138
134
self._focus_text_widget = urwid.Text("")
139
super(MandosClientWidget, self).__init__(
140
update_hook=update_hook, delete_hook=delete_hook,
141
*args, **kwargs)
135
super(MandosClientWidget, self).__init__(**kwargs)
142
136
self.update()
143
137
self.opened = False
144
138
145
last_checked_ok = isoformat_to_datetime(self.properties
146
["LastCheckedOK"])
147
148
if self.properties ["LastCheckerStatus"] != 0:
149
self.using_timer(True)
150
151
if self.need_approval:
152
self.using_timer(True)
153
154
139
self.match_objects = (
155
140
self.proxy.connect_to_signal("CheckerCompleted",
156
141
self.checker_completed,
172
157
self.rejected,
173
158
client_interface,
174
159
byte_arrays=True))
175
#self.logger('Created client %s' % (self.properties["Name"]))
176
177
def property_changed(self, property=None, value=None):
178
super(self, MandosClientWidget).property_changed(property,
179
value)
180
if property == "ApprovalPending":
181
using_timer(bool(value))
182
if property == "LastCheckerStatus":
183
using_timer(value != 0)
184
#self.logger('Checker for client %s (command "%s")'
185
# ' was successful'
186
# % (self.properties["Name"], command))
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
187
162
188
163
def using_timer(self, flag):
189
164
"""Call this method with True or False when timer should be
190
165
activated or deactivated.
191
166
"""
192
old = self._update_timer_callback_lock
193
if flag:
194
self._update_timer_callback_lock += 1
195
else:
196
self._update_timer_callback_lock -= 1
197
if old == 0 and self._update_timer_callback_lock:
167
if flag and self._update_timer_callback_tag is None:
198
168
# Will update the shown timer value every second
199
169
self._update_timer_callback_tag = (gobject.timeout_add
200
170
(1000,
201
171
self.update_timer))
202
elif old and self._update_timer_callback_lock == 0:
172
elif not (flag or self._update_timer_callback_tag is None):
203
173
gobject.source_remove(self._update_timer_callback_tag)
204
174
self._update_timer_callback_tag = None
205
175
206
176
def checker_completed(self, exitstatus, condition, command):
207
177
if exitstatus == 0:
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
180
command), level=0)
208
181
self.update()
209
182
return
210
183
# Checker failed
211
184
if os.WIFEXITED(condition):
212
self.logger('Checker for client %s (command "%s")'
213
' failed with exit code %s'
214
% (self.properties["Name"], command,
215
os.WEXITSTATUS(condition)))
185
self.logger('Checker for client {} (command "{}") failed'
186
' with exit code {}'
187
.format(self.properties["Name"], command,
188
os.WEXITSTATUS(condition)))
216
189
elif os.WIFSIGNALED(condition):
217
self.logger('Checker for client %s (command "%s")'
218
' was killed by signal %s'
219
% (self.properties["Name"], command,
220
os.WTERMSIG(condition)))
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
os.WTERMSIG(condition)))
221
194
elif os.WCOREDUMP(condition):
222
self.logger('Checker for client %s (command "%s")'
223
' dumped core'
224
% (self.properties["Name"], command))
195
self.logger('Checker for client {} (command "{}") dumped'
196
' core'.format(self.properties["Name"],
197
command))
225
198
else:
226
self.logger('Checker for client %s completed'
227
' mysteriously')
199
self.logger('Checker for client {} completed'
200
' mysteriously'
201
.format(self.properties["Name"]))
228
202
self.update()
229
203
230
204
def checker_started(self, command):
231
"""Server signals that a checker started. This could be useful
232
to log in the future. """
233
#self.logger('Client %s started checker "%s"'
234
# % (self.properties["Name"], unicode(command)))
235
pass
205
"""Server signals that a checker started."""
206
self.logger('Client {} started checker "{}"'
207
.format(self.properties["Name"],
208
command), level=0)
236
209
237
210
def got_secret(self):
238
self.logger('Client %s received its secret'
239
% self.properties["Name"])
211
self.logger('Client {} received its secret'
212
.format(self.properties["Name"]))
240
213
241
214
def need_approval(self, timeout, default):
242
215
if not default:
243
message = 'Client %s needs approval within %s seconds'
216
message = 'Client {} needs approval within {} seconds'
244
217
else:
245
message = 'Client %s will get its secret in %s seconds'
246
self.logger(message
247
% (self.properties["Name"], timeout/1000))
248
self.using_timer(True)
218
message = 'Client {} will get its secret in {} seconds'
219
self.logger(message.format(self.properties["Name"],
220
timeout/1000))
249
221
250
222
def rejected(self, reason):
251
self.logger('Client %s was rejected; reason: %s'
252
% (self.properties["Name"], reason))
223
self.logger('Client {} was rejected; reason: {}'
224
.format(self.properties["Name"], reason))
253
225
254
226
def selectable(self):
255
227
"""Make this a "selectable" widget.
277
249
"bold-underline-blink":
278
250
"bold-underline-blink-standout",
279
251
}
280
252
281
253
# Rebuild focus and non-focus widgets using current properties
282
254
283
255
# Base part of a client. Name!
284
base = ('%(name)s: '
285
% {"name": self.properties["Name"]})
256
base = '{name}: '.format(name=self.properties["Name"])
286
257
if not self.properties["Enabled"]:
287
258
message = "DISABLED"
259
self.using_timer(False)
288
260
elif self.properties["ApprovalPending"]:
289
261
timeout = datetime.timedelta(milliseconds
290
262
= self.properties
292
264
last_approval_request = isoformat_to_datetime(
293
265
self.properties["LastApprovalRequest"])
294
266
if last_approval_request is not None:
295
timer = timeout - (datetime.datetime.utcnow()
296
- last_approval_request)
267
timer = max(timeout - (datetime.datetime.utcnow()
268
- last_approval_request),
269
datetime.timedelta())
297
270
else:
298
271
timer = datetime.timedelta()
299
272
if self.properties["ApprovedByDefault"]:
300
message = "Approval in %s. (d)eny?"
273
message = "Approval in {}. (d)eny?"
301
274
else:
302
message = "Denial in %s. (a)pprove?"
303
message = message % unicode(timer).rsplit(".", 1)[0]
275
message = "Denial in {}. (a)pprove?"
276
message = message.format(str(timer).rsplit(".", 1)[0])
277
self.using_timer(True)
304
278
elif self.properties["LastCheckerStatus"] != 0:
305
# When checker has failed, print a timer until client expires
279
# When checker has failed, show timer until client expires
306
280
expires = self.properties["Expires"]
307
281
if expires == "":
308
282
timer = datetime.timedelta(0)
309
283
else:
310
expires = datetime.datetime.strptime(expires,
311
'%Y-%m-%dT%H:%M:%S.%f')
312
timer = expires - datetime.datetime.utcnow()
284
expires = (datetime.datetime.strptime
285
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
286
timer = max(expires - datetime.datetime.utcnow(),
287
datetime.timedelta())
313
288
message = ('A checker has failed! Time until client'
314
' gets disabled: %s'
315
% unicode(timer).rsplit(".", 1)[0])
289
' gets disabled: {}'
290
.format(str(timer).rsplit(".", 1)[0]))
291
self.using_timer(True)
316
292
else:
317
293
message = "enabled"
318
self._text = "%s%s" % (base, message)
319
294
self.using_timer(False)
295
self._text = "{}{}".format(base, message)
296
320
297
if not urwid.supports_unicode():
321
298
self._text = self._text.encode("ascii", "replace")
322
299
textlist = [("normal", self._text)]
339
316
self.update()
340
317
return True # Keep calling this
341
318
342
def delete(self, *args, **kwargs):
319
def delete(self, **kwargs):
343
320
if self._update_timer_callback_tag is not None:
344
321
gobject.source_remove(self._update_timer_callback_tag)
345
322
self._update_timer_callback_tag = None
348
325
self.match_objects = ()
349
326
if self.delete_hook is not None:
350
327
self.delete_hook(self)
351
return super(MandosClientWidget, self).delete(*args, **kwargs)
328
return super(MandosClientWidget, self).delete(**kwargs)
352
329
353
330
def render(self, maxcolrow, focus=False):
354
331
"""Render differently if we have focus.
396
373
else:
397
374
return key
398
375
399
def property_changed(self, property=None, value=None,
400
*args, **kwargs):
401
"""Call self.update() if old value is not new value.
376
def properties_changed(self, interface, properties, invalidated):
377
"""Call self.update() if any properties changed.
402
378
This overrides the method from MandosClientPropertyCache"""
403
property_name = unicode(property)
404
old_value = self.properties.get(property_name)
405
super(MandosClientWidget, self).property_changed(
406
property=property, value=value, *args, **kwargs)
407
if self.properties.get(property_name) != old_value:
379
old_values = { key: self.properties.get(key)
380
for key in properties.keys() }
381
super(MandosClientWidget, self).properties_changed(
382
interface, properties, invalidated)
383
if any(old_values[key] != self.properties.get(key)
384
for key in old_values):
408
385
self.update()
409
386
410
387
413
390
"down" key presses, thus not allowing any containing widgets to
414
391
use them as an excuse to shift focus away from this widget.
415
392
"""
416
def keypress(self, maxcolrow, key):
417
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
393
def keypress(self, *args, **kwargs):
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
418
395
if ret in ("up", "down"):
419
396
return
420
397
return ret
424
401
"""This is the entire user interface - the whole screen
425
402
with boxes, lists of client widgets, etc.
426
403
"""
427
def __init__(self, max_log_length=1000):
404
def __init__(self, max_log_length=1000, log_level=1):
428
405
DBusGMainLoop(set_as_default=True)
429
406
430
407
self.screen = urwid.curses_display.Screen()
433
410
("normal",
434
411
"default", "default", None),
435
412
("bold",
436
"default", "default", "bold"),
413
"bold", "default", "bold"),
437
414
("underline-blink",
438
"default", "default", "underline"),
415
"underline,blink", "default", "underline,blink"),
439
416
("standout",
440
"default", "default", "standout"),
417
"standout", "default", "standout"),
441
418
("bold-underline-blink",
442
"default", "default", ("bold", "underline")),
419
"bold,underline,blink", "default", "bold,underline,blink"),
443
420
("bold-standout",
444
"default", "default", ("bold", "standout")),
421
"bold,standout", "default", "bold,standout"),
445
422
("underline-blink-standout",
446
"default", "default", ("underline", "standout")),
423
"underline,blink,standout", "default",
424
"underline,blink,standout"),
447
425
("bold-underline-blink-standout",
448
"default", "default", ("bold", "underline",
449
"standout")),
426
"bold,underline,blink,standout", "default",
427
"bold,underline,blink,standout"),
450
428
))
451
429
452
430
if urwid.supports_unicode():
467
445
self.log = []
468
446
self.max_log_length = max_log_length
469
447
448
self.log_level = log_level
449
470
450
# We keep a reference to the log widget so we can remove it
471
451
# from the ListWalker without it getting destroyed
472
452
self.logbox = ConstrainedListBox(self.log)
486
466
self.main_loop = gobject.MainLoop()
487
467
488
468
def client_not_found(self, fingerprint, address):
489
self.log_message(("Client with address %s and fingerprint %s"
490
" could not be found" % (address,
491
fingerprint)))
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
492
472
493
473
def rebuild(self):
494
474
"""This rebuilds the User Interface.
506
486
self.uilist.append(self.logbox)
507
487
self.topwidget = urwid.Pile(self.uilist)
508
488
509
def log_message(self, message):
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
492
return
510
493
timestamp = datetime.datetime.now().isoformat()
511
self.log_message_raw(timestamp + ": " + message)
494
self.log_message_raw("{}: {}".format(timestamp, message),
495
level=level)
512
496
513
def log_message_raw(self, markup):
497
def log_message_raw(self, markup, level=1):
514
498
"""Add a log message to the log buffer."""
499
if level < self.log_level:
500
return
515
501
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
516
502
if (self.max_log_length
517
503
and len(self.log) > self.max_log_length):
524
510
"""Toggle visibility of the log buffer."""
525
511
self.log_visible = not self.log_visible
526
512
self.rebuild()
527
#self.log_message("Log visibility changed to: "
528
# + unicode(self.log_visible))
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
529
515
530
516
def change_log_display(self):
531
517
"""Change type of log display.
536
522
self.log_wrap = "clip"
537
523
for textwidget in self.log:
538
524
textwidget.set_wrap_mode(self.log_wrap)
539
#self.log_message("Wrap mode: " + self.log_wrap)
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
526
level=0)
540
527
541
528
def find_and_remove_client(self, path, name):
542
529
"""Find a client by its object path and remove it.
547
534
client = self.clients_dict[path]
548
535
except KeyError:
549
536
# not found?
550
self.log_message("Unknown client %r (%r) removed", name,
551
path)
537
self.log_message("Unknown client {!r} ({!r}) removed"
538
.format(name, path))
552
539
return
553
540
client.delete()
554
541
571
558
if path is None:
572
559
path = client.proxy.object_path
573
560
self.clients_dict[path] = client
574
self.clients.sort(None, lambda c: c.properties["Name"])
561
self.clients.sort(key=lambda c: c.properties["Name"])
575
562
self.refresh()
576
563
577
564
def remove_client(self, client, path=None):
579
566
if path is None:
580
567
path = client.proxy.object_path
581
568
del self.clients_dict[path]
582
if not self.clients_dict:
583
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
584
# is completely emptied, we need to recreate it.
585
self.clients = urwid.SimpleListWalker([])
586
self.rebuild()
587
569
self.refresh()
588
570
589
571
def refresh(self):
602
584
try:
603
585
mandos_clients = (self.mandos_serv
604
586
.GetAllClientsWithProperties())
587
if not mandos_clients:
588
self.log_message_raw(("bold", "Note: Server has no clients."))
605
589
except dbus.exceptions.DBusException:
590
self.log_message_raw(("bold", "Note: No Mandos server running."))
606
591
mandos_clients = dbus.Dictionary()
607
592
608
593
(self.mandos_serv
620
605
self.client_not_found,
621
606
dbus_interface=server_interface,
622
607
byte_arrays=True))
623
for path, client in mandos_clients.iteritems():
608
for path, client in mandos_clients.items():
624
609
client_proxy_object = self.bus.get_object(self.busname,
625
610
path)
626
611
self.add_client(MandosClientWidget(server_proxy_object
635
620
logger
636
621
=self.log_message),
637
622
path=path)
638
623
639
624
self.refresh()
640
625
self._input_callback_tag = (gobject.io_add_watch
641
626
(sys.stdin.fileno(),
673
658
elif key == "window resize":
674
659
self.size = self.screen.get_cols_rows()
675
660
self.refresh()
676
elif key == "\f": # Ctrl-L
661
elif key == "ctrl l":
662
self.screen.clear()
677
663
self.refresh()
678
664
elif key == "l" or key == "D":
679
665
self.toggle_log_display()
691
677
"?: Help",
692
678
"l: Log window toggle",
693
679
"TAB: Switch window",
694
"w: Wrap (log)"))))
680
"w: Wrap (log lines)",
681
"v: Toggle verbose log",
682
))))
695
683
self.log_message_raw(("bold",
696
684
" "
697
685
.join(("Clients:",
710
698
else:
711
699
self.topwidget.set_focus(self.logbox)
712
700
self.refresh()
701
elif key == "v":
702
if self.log_level == 0:
703
self.log_level = 1
704
self.log_message("Verbose mode: Off")
705
else:
706
self.log_level = 0
707
self.log_message("Verbose mode: On")
713
708
#elif (key == "end" or key == "meta >" or key == "G"
714
709
# or key == ">"):
715
710
# pass # xxx end-of-buffer
738
733
ui.run()
739
734
except KeyboardInterrupt:
740
735
ui.screen.stop()
741
except Exception, e:
742
ui.log_message(unicode(e))
736
except Exception as e:
737
ui.log_message(str(e))
743
738
ui.screen.stop()
744
739
raise
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0