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