To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos-monitor
- browse files at revision 181
- compare with another revision
- download diff
- download tarball
- view history from revision 181
- Committer: Teddy Hogeborn
- Date: 2008-09-08 18:54:47 UTC
- Revision ID: teddy@fukt.bsnet.se-20080908185447-dm2ertwxa20qbckf
* INSTALL: Even better text.
- files added:
- etc-plugins.d-README
- files removed:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos-monitor
1
#!/usr/bin/python
2
# -*- mode: python; coding: utf-8 -*-
3
#
4
# Mandos Monitor - Control and monitor the Mandos server
5
#
6
# Copyright © 2009-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 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
11
# the Free Software Foundation, either version 3 of the License, or
12
# (at your option) any later version.
13
#
14
# This program is distributed in the hope that it will be useful,
15
# but WITHOUT ANY WARRANTY; without even the implied warranty of
16
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
# GNU General Public License for more details.
18
#
19
# You should have received a copy of the GNU General Public License
20
# along with this program. If not, see
21
# <http://www.gnu.org/licenses/>.
22
#
23
# Contact the authors at <mandos@recompile.se>.
24
#
25
26
from __future__ import (division, absolute_import, print_function,
27
unicode_literals)
28
29
from future_builtins import *
30
31
import sys
32
import os
33
import signal
34
35
import datetime
36
37
import urwid.curses_display
38
import urwid
39
40
from dbus.mainloop.glib import DBusGMainLoop
41
import gobject
42
43
import dbus
44
45
import UserList
46
47
import locale
48
49
locale.setlocale(locale.LC_ALL, '')
50
51
import logging
52
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
53
54
# Some useful constants
55
domain = 'se.recompile'
56
server_interface = domain + '.Mandos'
57
client_interface = domain + '.Mandos.Client'
58
version = "1.6.0"
59
60
# Always run in monochrome mode
61
urwid.curses_display.curses.has_colors = lambda : False
62
63
# Urwid doesn't support blinking, but we want it. Since we have no
64
# use for underline on its own, we make underline also always blink.
65
urwid.curses_display.curses.A_UNDERLINE |= (
66
urwid.curses_display.curses.A_BLINK)
67
68
def isoformat_to_datetime(iso):
69
"Parse an ISO 8601 date string to a datetime.datetime()"
70
if not iso:
71
return None
72
d, t = iso.split("T", 1)
73
year, month, day = d.split("-", 2)
74
hour, minute, second = t.split(":", 2)
75
second, fraction = divmod(float(second), 1)
76
return datetime.datetime(int(year),
77
int(month),
78
int(day),
79
int(hour),
80
int(minute),
81
int(second), # Whole seconds
82
int(fraction*1000000)) # Microseconds
83
84
class MandosClientPropertyCache(object):
85
"""This wraps a Mandos Client D-Bus proxy object, caches the
86
properties and calls a hook function when any of them are
87
changed.
88
"""
89
def __init__(self, proxy_object=None, properties=None, **kwargs):
90
self.proxy = proxy_object # Mandos Client proxy object
91
self.properties = dict() if properties is None else properties
92
self.property_changed_match = (
93
self.proxy.connect_to_signal("PropertyChanged",
94
self._property_changed,
95
client_interface,
96
byte_arrays=True))
97
98
if properties is None:
99
self.properties.update(
100
self.proxy.GetAll(client_interface,
101
dbus_interface
102
= dbus.PROPERTIES_IFACE))
103
104
super(MandosClientPropertyCache, self).__init__(**kwargs)
105
106
def _property_changed(self, property, value):
107
"""Helper which takes positional arguments"""
108
return self.property_changed(property=property, value=value)
109
110
def property_changed(self, property=None, value=None):
111
"""This is called whenever we get a PropertyChanged signal
112
It updates the changed property in the "properties" dict.
113
"""
114
# Update properties dict with new value
115
self.properties[property] = value
116
117
def delete(self):
118
self.property_changed_match.remove()
119
120
121
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
122
"""A Mandos Client which is visible on the screen.
123
"""
124
125
def __init__(self, server_proxy_object=None, update_hook=None,
126
delete_hook=None, logger=None, **kwargs):
127
# Called on update
128
self.update_hook = update_hook
129
# Called on delete
130
self.delete_hook = delete_hook
131
# Mandos Server proxy object
132
self.server_proxy_object = server_proxy_object
133
# Logger
134
self.logger = logger
135
136
self._update_timer_callback_tag = None
137
138
# The widget shown normally
139
self._text_widget = urwid.Text("")
140
# The widget shown when we have focus
141
self._focus_text_widget = urwid.Text("")
142
super(MandosClientWidget, self).__init__(**kwargs)
143
self.update()
144
self.opened = False
145
146
self.match_objects = (
147
self.proxy.connect_to_signal("CheckerCompleted",
148
self.checker_completed,
149
client_interface,
150
byte_arrays=True),
151
self.proxy.connect_to_signal("CheckerStarted",
152
self.checker_started,
153
client_interface,
154
byte_arrays=True),
155
self.proxy.connect_to_signal("GotSecret",
156
self.got_secret,
157
client_interface,
158
byte_arrays=True),
159
self.proxy.connect_to_signal("NeedApproval",
160
self.need_approval,
161
client_interface,
162
byte_arrays=True),
163
self.proxy.connect_to_signal("Rejected",
164
self.rejected,
165
client_interface,
166
byte_arrays=True))
167
#self.logger('Created client {0}'
168
# .format(self.properties["Name"]))
169
170
def using_timer(self, flag):
171
"""Call this method with True or False when timer should be
172
activated or deactivated.
173
"""
174
if flag and self._update_timer_callback_tag is None:
175
# Will update the shown timer value every second
176
self._update_timer_callback_tag = (gobject.timeout_add
177
(1000,
178
self.update_timer))
179
elif not (flag or self._update_timer_callback_tag is None):
180
gobject.source_remove(self._update_timer_callback_tag)
181
self._update_timer_callback_tag = None
182
183
def checker_completed(self, exitstatus, condition, command):
184
if exitstatus == 0:
185
self.update()
186
return
187
# Checker failed
188
if os.WIFEXITED(condition):
189
self.logger('Checker for client {0} (command "{1}")'
190
' failed with exit code {2}'
191
.format(self.properties["Name"], command,
192
os.WEXITSTATUS(condition)))
193
elif os.WIFSIGNALED(condition):
194
self.logger('Checker for client {0} (command "{1}") was'
195
' killed by signal {2}'
196
.format(self.properties["Name"], command,
197
os.WTERMSIG(condition)))
198
elif os.WCOREDUMP(condition):
199
self.logger('Checker for client {0} (command "{1}")'
200
' dumped core'
201
.format(self.properties["Name"], command))
202
else:
203
self.logger('Checker for client {0} completed'
204
' mysteriously'
205
.format(self.properties["Name"]))
206
self.update()
207
208
def checker_started(self, command):
209
"""Server signals that a checker started. This could be useful
210
to log in the future. """
211
#self.logger('Client {0} started checker "{1}"'
212
# .format(self.properties["Name"],
213
# unicode(command)))
214
pass
215
216
def got_secret(self):
217
self.logger('Client {0} received its secret'
218
.format(self.properties["Name"]))
219
220
def need_approval(self, timeout, default):
221
if not default:
222
message = 'Client {0} needs approval within {1} seconds'
223
else:
224
message = 'Client {0} will get its secret in {1} seconds'
225
self.logger(message.format(self.properties["Name"],
226
timeout/1000))
227
228
def rejected(self, reason):
229
self.logger('Client {0} was rejected; reason: {1}'
230
.format(self.properties["Name"], reason))
231
232
def selectable(self):
233
"""Make this a "selectable" widget.
234
This overrides the method from urwid.FlowWidget."""
235
return True
236
237
def rows(self, maxcolrow, focus=False):
238
"""How many rows this widget will occupy might depend on
239
whether we have focus or not.
240
This overrides the method from urwid.FlowWidget"""
241
return self.current_widget(focus).rows(maxcolrow, focus=focus)
242
243
def current_widget(self, focus=False):
244
if focus or self.opened:
245
return self._focus_widget
246
return self._widget
247
248
def update(self):
249
"Called when what is visible on the screen should be updated."
250
# How to add standout mode to a style
251
with_standout = { "normal": "standout",
252
"bold": "bold-standout",
253
"underline-blink":
254
"underline-blink-standout",
255
"bold-underline-blink":
256
"bold-underline-blink-standout",
257
}
258
259
# Rebuild focus and non-focus widgets using current properties
260
261
# Base part of a client. Name!
262
base = '{name}: '.format(name=self.properties["Name"])
263
if not self.properties["Enabled"]:
264
message = "DISABLED"
265
self.using_timer(False)
266
elif self.properties["ApprovalPending"]:
267
timeout = datetime.timedelta(milliseconds
268
= self.properties
269
["ApprovalDelay"])
270
last_approval_request = isoformat_to_datetime(
271
self.properties["LastApprovalRequest"])
272
if last_approval_request is not None:
273
timer = max(timeout - (datetime.datetime.utcnow()
274
- last_approval_request),
275
datetime.timedelta())
276
else:
277
timer = datetime.timedelta()
278
if self.properties["ApprovedByDefault"]:
279
message = "Approval in {0}. (d)eny?"
280
else:
281
message = "Denial in {0}. (a)pprove?"
282
message = message.format(unicode(timer).rsplit(".", 1)[0])
283
self.using_timer(True)
284
elif self.properties["LastCheckerStatus"] != 0:
285
# When checker has failed, show timer until client expires
286
expires = self.properties["Expires"]
287
if expires == "":
288
timer = datetime.timedelta(0)
289
else:
290
expires = (datetime.datetime.strptime
291
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
292
timer = max(expires - datetime.datetime.utcnow(),
293
datetime.timedelta())
294
message = ('A checker has failed! Time until client'
295
' gets disabled: {0}'
296
.format(unicode(timer).rsplit(".", 1)[0]))
297
self.using_timer(True)
298
else:
299
message = "enabled"
300
self.using_timer(False)
301
self._text = "{0}{1}".format(base, message)
302
303
if not urwid.supports_unicode():
304
self._text = self._text.encode("ascii", "replace")
305
textlist = [("normal", self._text)]
306
self._text_widget.set_text(textlist)
307
self._focus_text_widget.set_text([(with_standout[text[0]],
308
text[1])
309
if isinstance(text, tuple)
310
else text
311
for text in textlist])
312
self._widget = self._text_widget
313
self._focus_widget = urwid.AttrWrap(self._focus_text_widget,
314
"standout")
315
# Run update hook, if any
316
if self.update_hook is not None:
317
self.update_hook()
318
319
def update_timer(self):
320
"""called by gobject. Will indefinitely loop until
321
gobject.source_remove() on tag is called"""
322
self.update()
323
return True # Keep calling this
324
325
def delete(self, **kwargs):
326
if self._update_timer_callback_tag is not None:
327
gobject.source_remove(self._update_timer_callback_tag)
328
self._update_timer_callback_tag = None
329
for match in self.match_objects:
330
match.remove()
331
self.match_objects = ()
332
if self.delete_hook is not None:
333
self.delete_hook(self)
334
return super(MandosClientWidget, self).delete(**kwargs)
335
336
def render(self, maxcolrow, focus=False):
337
"""Render differently if we have focus.
338
This overrides the method from urwid.FlowWidget"""
339
return self.current_widget(focus).render(maxcolrow,
340
focus=focus)
341
342
def keypress(self, maxcolrow, key):
343
"""Handle keys.
344
This overrides the method from urwid.FlowWidget"""
345
if key == "+":
346
self.proxy.Enable(dbus_interface = client_interface,
347
ignore_reply=True)
348
elif key == "-":
349
self.proxy.Disable(dbus_interface = client_interface,
350
ignore_reply=True)
351
elif key == "a":
352
self.proxy.Approve(dbus.Boolean(True, variant_level=1),
353
dbus_interface = client_interface,
354
ignore_reply=True)
355
elif key == "d":
356
self.proxy.Approve(dbus.Boolean(False, variant_level=1),
357
dbus_interface = client_interface,
358
ignore_reply=True)
359
elif key == "R" or key == "_" or key == "ctrl k":
360
self.server_proxy_object.RemoveClient(self.proxy
361
.object_path,
362
ignore_reply=True)
363
elif key == "s":
364
self.proxy.StartChecker(dbus_interface = client_interface,
365
ignore_reply=True)
366
elif key == "S":
367
self.proxy.StopChecker(dbus_interface = client_interface,
368
ignore_reply=True)
369
elif key == "C":
370
self.proxy.CheckedOK(dbus_interface = client_interface,
371
ignore_reply=True)
372
# xxx
373
# elif key == "p" or key == "=":
374
# self.proxy.pause()
375
# elif key == "u" or key == ":":
376
# self.proxy.unpause()
377
# elif key == "RET":
378
# self.open()
379
else:
380
return key
381
382
def property_changed(self, property=None, **kwargs):
383
"""Call self.update() if old value is not new value.
384
This overrides the method from MandosClientPropertyCache"""
385
property_name = unicode(property)
386
old_value = self.properties.get(property_name)
387
super(MandosClientWidget, self).property_changed(
388
property=property, **kwargs)
389
if self.properties.get(property_name) != old_value:
390
self.update()
391
392
393
class ConstrainedListBox(urwid.ListBox):
394
"""Like a normal urwid.ListBox, but will consume all "up" or
395
"down" key presses, thus not allowing any containing widgets to
396
use them as an excuse to shift focus away from this widget.
397
"""
398
def keypress(self, *args, **kwargs):
399
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
400
if ret in ("up", "down"):
401
return
402
return ret
403
404
405
class UserInterface(object):
406
"""This is the entire user interface - the whole screen
407
with boxes, lists of client widgets, etc.
408
"""
409
def __init__(self, max_log_length=1000):
410
DBusGMainLoop(set_as_default=True)
411
412
self.screen = urwid.curses_display.Screen()
413
414
self.screen.register_palette((
415
("normal",
416
"default", "default", None),
417
("bold",
418
"default", "default", "bold"),
419
("underline-blink",
420
"default", "default", "underline"),
421
("standout",
422
"default", "default", "standout"),
423
("bold-underline-blink",
424
"default", "default", ("bold", "underline")),
425
("bold-standout",
426
"default", "default", ("bold", "standout")),
427
("underline-blink-standout",
428
"default", "default", ("underline", "standout")),
429
("bold-underline-blink-standout",
430
"default", "default", ("bold", "underline",
431
"standout")),
432
))
433
434
if urwid.supports_unicode():
435
self.divider = "─" # \u2500
436
#self.divider = "━" # \u2501
437
else:
438
#self.divider = "-" # \u002d
439
self.divider = "_" # \u005f
440
441
self.screen.start()
442
443
self.size = self.screen.get_cols_rows()
444
445
self.clients = urwid.SimpleListWalker([])
446
self.clients_dict = {}
447
448
# We will add Text widgets to this list
449
self.log = []
450
self.max_log_length = max_log_length
451
452
# We keep a reference to the log widget so we can remove it
453
# from the ListWalker without it getting destroyed
454
self.logbox = ConstrainedListBox(self.log)
455
456
# This keeps track of whether self.uilist currently has
457
# self.logbox in it or not
458
self.log_visible = True
459
self.log_wrap = "any"
460
461
self.rebuild()
462
self.log_message_raw(("bold",
463
"Mandos Monitor version " + version))
464
self.log_message_raw(("bold",
465
"q: Quit ?: Help"))
466
467
self.busname = domain + '.Mandos'
468
self.main_loop = gobject.MainLoop()
469
470
def client_not_found(self, fingerprint, address):
471
self.log_message("Client with address {0} and fingerprint"
472
" {1} could not be found"
473
.format(address, fingerprint))
474
475
def rebuild(self):
476
"""This rebuilds the User Interface.
477
Call this when the widget layout needs to change"""
478
self.uilist = []
479
#self.uilist.append(urwid.ListBox(self.clients))
480
self.uilist.append(urwid.Frame(ConstrainedListBox(self.
481
clients),
482
#header=urwid.Divider(),
483
header=None,
484
footer=
485
urwid.Divider(div_char=
486
self.divider)))
487
if self.log_visible:
488
self.uilist.append(self.logbox)
489
self.topwidget = urwid.Pile(self.uilist)
490
491
def log_message(self, message):
492
timestamp = datetime.datetime.now().isoformat()
493
self.log_message_raw(timestamp + ": " + message)
494
495
def log_message_raw(self, markup):
496
"""Add a log message to the log buffer."""
497
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
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),
502
coming_from="above")
503
self.refresh()
504
505
def toggle_log_display(self):
506
"""Toggle visibility of the log buffer."""
507
self.log_visible = not self.log_visible
508
self.rebuild()
509
#self.log_message("Log visibility changed to: "
510
# + unicode(self.log_visible))
511
512
def change_log_display(self):
513
"""Change type of log display.
514
Currently, this toggles wrapping of text lines."""
515
if self.log_wrap == "clip":
516
self.log_wrap = "any"
517
else:
518
self.log_wrap = "clip"
519
for textwidget in self.log:
520
textwidget.set_wrap_mode(self.log_wrap)
521
#self.log_message("Wrap mode: " + self.log_wrap)
522
523
def find_and_remove_client(self, path, name):
524
"""Find a client by its object path and remove it.
525
526
This is connected to the ClientRemoved signal from the
527
Mandos server object."""
528
try:
529
client = self.clients_dict[path]
530
except KeyError:
531
# not found?
532
self.log_message("Unknown client {0!r} ({1!r}) removed"
533
.format(name, path))
534
return
535
client.delete()
536
537
def add_new_client(self, path):
538
client_proxy_object = self.bus.get_object(self.busname, path)
539
self.add_client(MandosClientWidget(server_proxy_object
540
=self.mandos_serv,
541
proxy_object
542
=client_proxy_object,
543
update_hook
544
=self.refresh,
545
delete_hook
546
=self.remove_client,
547
logger
548
=self.log_message),
549
path=path)
550
551
def add_client(self, client, path=None):
552
self.clients.append(client)
553
if path is None:
554
path = client.proxy.object_path
555
self.clients_dict[path] = client
556
self.clients.sort(None, lambda c: c.properties["Name"])
557
self.refresh()
558
559
def remove_client(self, client, path=None):
560
self.clients.remove(client)
561
if path is None:
562
path = client.proxy.object_path
563
del self.clients_dict[path]
564
if not self.clients_dict:
565
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
566
# is completely emptied, we need to recreate it.
567
self.clients = urwid.SimpleListWalker([])
568
self.rebuild()
569
self.refresh()
570
571
def refresh(self):
572
"""Redraw the screen"""
573
canvas = self.topwidget.render(self.size, focus=True)
574
self.screen.draw_screen(self.size, canvas)
575
576
def run(self):
577
"""Start the main loop and exit when it's done."""
578
self.bus = dbus.SystemBus()
579
mandos_dbus_objc = self.bus.get_object(
580
self.busname, "/", follow_name_owner_changes=True)
581
self.mandos_serv = dbus.Interface(mandos_dbus_objc,
582
dbus_interface
583
= server_interface)
584
try:
585
mandos_clients = (self.mandos_serv
586
.GetAllClientsWithProperties())
587
except dbus.exceptions.DBusException:
588
mandos_clients = dbus.Dictionary()
589
590
(self.mandos_serv
591
.connect_to_signal("ClientRemoved",
592
self.find_and_remove_client,
593
dbus_interface=server_interface,
594
byte_arrays=True))
595
(self.mandos_serv
596
.connect_to_signal("ClientAdded",
597
self.add_new_client,
598
dbus_interface=server_interface,
599
byte_arrays=True))
600
(self.mandos_serv
601
.connect_to_signal("ClientNotFound",
602
self.client_not_found,
603
dbus_interface=server_interface,
604
byte_arrays=True))
605
for path, client in mandos_clients.iteritems():
606
client_proxy_object = self.bus.get_object(self.busname,
607
path)
608
self.add_client(MandosClientWidget(server_proxy_object
609
=self.mandos_serv,
610
proxy_object
611
=client_proxy_object,
612
properties=client,
613
update_hook
614
=self.refresh,
615
delete_hook
616
=self.remove_client,
617
logger
618
=self.log_message),
619
path=path)
620
621
self.refresh()
622
self._input_callback_tag = (gobject.io_add_watch
623
(sys.stdin.fileno(),
624
gobject.IO_IN,
625
self.process_input))
626
self.main_loop.run()
627
# Main loop has finished, we should close everything now
628
gobject.source_remove(self._input_callback_tag)
629
self.screen.stop()
630
631
def stop(self):
632
self.main_loop.quit()
633
634
def process_input(self, source, condition):
635
keys = self.screen.get_input()
636
translations = { "ctrl n": "down", # Emacs
637
"ctrl p": "up", # Emacs
638
"ctrl v": "page down", # Emacs
639
"meta v": "page up", # Emacs
640
" ": "page down", # less
641
"f": "page down", # less
642
"b": "page up", # less
643
"j": "down", # vi
644
"k": "up", # vi
645
}
646
for key in keys:
647
try:
648
key = translations[key]
649
except KeyError: # :-)
650
pass
651
652
if key == "q" or key == "Q":
653
self.stop()
654
break
655
elif key == "window resize":
656
self.size = self.screen.get_cols_rows()
657
self.refresh()
658
elif key == "\f": # Ctrl-L
659
self.refresh()
660
elif key == "l" or key == "D":
661
self.toggle_log_display()
662
self.refresh()
663
elif key == "w" or key == "i":
664
self.change_log_display()
665
self.refresh()
666
elif key == "?" or key == "f1" or key == "esc":
667
if not self.log_visible:
668
self.log_visible = True
669
self.rebuild()
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)"))))
677
self.log_message_raw(("bold",
678
" "
679
.join(("Clients:",
680
"+: Enable",
681
"-: Disable",
682
"R: Remove",
683
"s: Start new checker",
684
"S: Stop checker",
685
"C: Checker OK",
686
"a: Approve",
687
"d: Deny"))))
688
self.refresh()
689
elif key == "tab":
690
if self.topwidget.get_focus() is self.logbox:
691
self.topwidget.set_focus(0)
692
else:
693
self.topwidget.set_focus(self.logbox)
694
self.refresh()
695
#elif (key == "end" or key == "meta >" or key == "G"
696
# or key == ">"):
697
# pass # xxx end-of-buffer
698
#elif (key == "home" or key == "meta <" or key == "g"
699
# or key == "<"):
700
# pass # xxx beginning-of-buffer
701
#elif key == "ctrl e" or key == "$":
702
# pass # xxx move-end-of-line
703
#elif key == "ctrl a" or key == "^":
704
# pass # xxx move-beginning-of-line
705
#elif key == "ctrl b" or key == "meta (" or key == "h":
706
# pass # xxx left
707
#elif key == "ctrl f" or key == "meta )" or key == "l":
708
# pass # xxx right
709
#elif key == "a":
710
# pass # scroll up log
711
#elif key == "z":
712
# pass # scroll down log
713
elif self.topwidget.selectable():
714
self.topwidget.keypress(self.size, key)
715
self.refresh()
716
return True
717
718
ui = UserInterface()
719
try:
720
ui.run()
721
except KeyboardInterrupt:
722
ui.screen.stop()
723
except Exception, e:
724
ui.log_message(unicode(e))
725
ui.screen.stop()
726
raise
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0