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 539
- compare with another revision
- download diff
- download tarball
- view history from revision 539
- Committer: teddy at recompile
- Date: 2011-12-27 14:15:40 UTC
- Revision ID: teddy@recompile.se-20111227141540-ajrabf33q59jfa7t
Reorder TODO entries
- files removed:
- 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-2014 Teddy Hogeborn
7
# Copyright © 2009-2014 Björn Påhlsson
6
# Copyright © 2009-2011 Teddy Hogeborn
7
# Copyright © 2009-2011 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
21
# <http://www.gnu.org/licenses/>.
20
# along with this program. If not, see <http://www.gnu.org/licenses/>.
22
21
#
23
22
# Contact the authors at <mandos@recompile.se>.
24
23
#
25
24
26
25
from __future__ import (division, absolute_import, print_function,
27
26
unicode_literals)
28
try:
29
from future_builtins import *
30
except ImportError:
31
pass
32
27
33
28
import sys
34
29
import os
30
import signal
35
31
36
32
import datetime
37
33
39
35
import urwid
40
36
41
37
from dbus.mainloop.glib import DBusGMainLoop
42
try:
43
import gobject
44
except ImportError:
45
from gi.repository import GObject as gobject
38
import gobject
46
39
47
40
import dbus
48
41
42
import UserList
43
49
44
import locale
50
45
51
if sys.version_info.major == 2:
52
str = unicode
53
54
46
locale.setlocale(locale.LC_ALL, '')
55
47
56
48
import logging
60
52
domain = 'se.recompile'
61
53
server_interface = domain + '.Mandos'
62
54
client_interface = domain + '.Mandos.Client'
63
version = "1.6.9"
55
version = "1.4.1"
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)
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, properties=None, **kwargs):
86
def __init__(self, proxy_object=None, *args, **kwargs):
87
87
self.proxy = proxy_object # Mandos Client proxy object
88
self.properties = dict() if properties is None else properties
88
89
self.properties = dict()
89
90
self.property_changed_match = (
90
self.proxy.connect_to_signal("PropertiesChanged",
91
self.properties_changed,
92
dbus.PROPERTIES_IFACE,
91
self.proxy.connect_to_signal("PropertyChanged",
92
self.property_changed,
93
client_interface,
93
94
byte_arrays=True))
94
95
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)
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)
102
103
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.
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.
106
107
"""
107
108
# Update properties dict with new value
108
self.properties.update(properties)
109
self.properties[property] = value
109
110
110
def delete(self):
111
def delete(self, *args, **kwargs):
111
112
self.property_changed_match.remove()
113
super(MandosClientPropertyCache, self).__init__(
114
*args, **kwargs)
112
115
113
116
114
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
116
119
"""
117
120
118
121
def __init__(self, server_proxy_object=None, update_hook=None,
119
delete_hook=None, logger=None, **kwargs):
122
delete_hook=None, logger=None, *args, **kwargs):
120
123
# Called on update
121
124
self.update_hook = update_hook
122
125
# Called on delete
127
130
self.logger = logger
128
131
129
132
self._update_timer_callback_tag = None
133
self._update_timer_callback_lock = 0
134
self.last_checker_failed = False
130
135
131
136
# The widget shown normally
132
137
self._text_widget = urwid.Text("")
133
138
# The widget shown when we have focus
134
139
self._focus_text_widget = urwid.Text("")
135
super(MandosClientWidget, self).__init__(**kwargs)
140
super(MandosClientWidget, self).__init__(
141
update_hook=update_hook, delete_hook=delete_hook,
142
*args, **kwargs)
136
143
self.update()
137
144
self.opened = False
138
145
146
last_checked_ok = isoformat_to_datetime(self.properties
147
["LastCheckedOK"])
148
if last_checked_ok is None:
149
self.last_checker_failed = True
150
else:
151
self.last_checker_failed = ((datetime.datetime.utcnow()
152
- last_checked_ok)
153
> datetime.timedelta
154
(milliseconds=
155
self.properties
156
["Interval"]))
157
158
if self.last_checker_failed:
159
self.using_timer(True)
160
161
if self.need_approval:
162
self.using_timer(True)
163
139
164
self.match_objects = (
140
165
self.proxy.connect_to_signal("CheckerCompleted",
141
166
self.checker_completed,
157
182
self.rejected,
158
183
client_interface,
159
184
byte_arrays=True))
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
185
#self.logger('Created client %s' % (self.properties["Name"]))
162
186
187
def property_changed(self, property=None, value=None):
188
super(self, MandosClientWidget).property_changed(property,
189
value)
190
if property == "ApprovalPending":
191
using_timer(bool(value))
192
163
193
def using_timer(self, flag):
164
194
"""Call this method with True or False when timer should be
165
195
activated or deactivated.
166
196
"""
167
if flag and self._update_timer_callback_tag is None:
197
old = self._update_timer_callback_lock
198
if flag:
199
self._update_timer_callback_lock += 1
200
else:
201
self._update_timer_callback_lock -= 1
202
if old == 0 and self._update_timer_callback_lock:
168
203
# Will update the shown timer value every second
169
204
self._update_timer_callback_tag = (gobject.timeout_add
170
205
(1000,
171
206
self.update_timer))
172
elif not (flag or self._update_timer_callback_tag is None):
207
elif old and self._update_timer_callback_lock == 0:
173
208
gobject.source_remove(self._update_timer_callback_tag)
174
209
self._update_timer_callback_tag = None
175
210
176
211
def checker_completed(self, exitstatus, condition, command):
177
212
if exitstatus == 0:
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
180
command), level=0)
213
if self.last_checker_failed:
214
self.last_checker_failed = False
215
self.using_timer(False)
216
#self.logger('Checker for client %s (command "%s")'
217
# ' was successful'
218
# % (self.properties["Name"], command))
181
219
self.update()
182
220
return
183
221
# Checker failed
222
if not self.last_checker_failed:
223
self.last_checker_failed = True
224
self.using_timer(True)
184
225
if os.WIFEXITED(condition):
185
self.logger('Checker for client {} (command "{}") failed'
186
' with exit code {}'
187
.format(self.properties["Name"], command,
188
os.WEXITSTATUS(condition)))
226
self.logger('Checker for client %s (command "%s")'
227
' failed with exit code %s'
228
% (self.properties["Name"], command,
229
os.WEXITSTATUS(condition)))
189
230
elif os.WIFSIGNALED(condition):
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
os.WTERMSIG(condition)))
231
self.logger('Checker for client %s (command "%s")'
232
' was killed by signal %s'
233
% (self.properties["Name"], command,
234
os.WTERMSIG(condition)))
194
235
elif os.WCOREDUMP(condition):
195
self.logger('Checker for client {} (command "{}") dumped'
196
' core'.format(self.properties["Name"],
197
command))
236
self.logger('Checker for client %s (command "%s")'
237
' dumped core'
238
% (self.properties["Name"], command))
198
239
else:
199
self.logger('Checker for client {} completed'
200
' mysteriously'
201
.format(self.properties["Name"]))
240
self.logger('Checker for client %s completed'
241
' mysteriously')
202
242
self.update()
203
243
204
244
def checker_started(self, command):
205
"""Server signals that a checker started."""
206
self.logger('Client {} started checker "{}"'
207
.format(self.properties["Name"],
208
command), level=0)
245
"""Server signals that a checker started. This could be useful
246
to log in the future. """
247
#self.logger('Client %s started checker "%s"'
248
# % (self.properties["Name"], unicode(command)))
249
pass
209
250
210
251
def got_secret(self):
211
self.logger('Client {} received its secret'
212
.format(self.properties["Name"]))
252
self.last_checker_failed = False
253
self.logger('Client %s received its secret'
254
% self.properties["Name"])
213
255
214
256
def need_approval(self, timeout, default):
215
257
if not default:
216
message = 'Client {} needs approval within {} seconds'
258
message = 'Client %s needs approval within %s seconds'
217
259
else:
218
message = 'Client {} will get its secret in {} seconds'
219
self.logger(message.format(self.properties["Name"],
220
timeout/1000))
260
message = 'Client %s will get its secret in %s seconds'
261
self.logger(message
262
% (self.properties["Name"], timeout/1000))
263
self.using_timer(True)
221
264
222
265
def rejected(self, reason):
223
self.logger('Client {} was rejected; reason: {}'
224
.format(self.properties["Name"], reason))
266
self.logger('Client %s was rejected; reason: %s'
267
% (self.properties["Name"], reason))
225
268
226
269
def selectable(self):
227
270
"""Make this a "selectable" widget.
249
292
"bold-underline-blink":
250
293
"bold-underline-blink-standout",
251
294
}
252
295
253
296
# Rebuild focus and non-focus widgets using current properties
254
297
255
298
# Base part of a client. Name!
256
base = '{name}: '.format(name=self.properties["Name"])
299
base = ('%(name)s: '
300
% {"name": self.properties["Name"]})
257
301
if not self.properties["Enabled"]:
258
302
message = "DISABLED"
259
self.using_timer(False)
260
303
elif self.properties["ApprovalPending"]:
261
304
timeout = datetime.timedelta(milliseconds
262
305
= self.properties
264
307
last_approval_request = isoformat_to_datetime(
265
308
self.properties["LastApprovalRequest"])
266
309
if last_approval_request is not None:
267
timer = max(timeout - (datetime.datetime.utcnow()
268
- last_approval_request),
269
datetime.timedelta())
310
timer = timeout - (datetime.datetime.utcnow()
311
- last_approval_request)
270
312
else:
271
313
timer = datetime.timedelta()
272
314
if self.properties["ApprovedByDefault"]:
273
message = "Approval in {}. (d)eny?"
315
message = "Approval in %s. (d)eny?"
274
316
else:
275
message = "Denial in {}. (a)pprove?"
276
message = message.format(str(timer).rsplit(".", 1)[0])
277
self.using_timer(True)
278
elif self.properties["LastCheckerStatus"] != 0:
279
# When checker has failed, show timer until client expires
317
message = "Denial in %s. (a)pprove?"
318
message = message % unicode(timer).rsplit(".", 1)[0]
319
elif self.last_checker_failed:
320
# When checker has failed, print a timer until client expires
280
321
expires = self.properties["Expires"]
281
322
if expires == "":
282
323
timer = datetime.timedelta(0)
283
324
else:
284
expires = (datetime.datetime.strptime
285
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
286
timer = max(expires - datetime.datetime.utcnow(),
287
datetime.timedelta())
325
expires = datetime.datetime.strptime(expires,
326
'%Y-%m-%dT%H:%M:%S.%f')
327
timer = expires - datetime.datetime.utcnow()
288
328
message = ('A checker has failed! Time until client'
289
' gets disabled: {}'
290
.format(str(timer).rsplit(".", 1)[0]))
291
self.using_timer(True)
329
' gets disabled: %s'
330
% unicode(timer).rsplit(".", 1)[0])
292
331
else:
293
332
message = "enabled"
294
self.using_timer(False)
295
self._text = "{}{}".format(base, message)
296
333
self._text = "%s%s" % (base, message)
334
297
335
if not urwid.supports_unicode():
298
336
self._text = self._text.encode("ascii", "replace")
299
337
textlist = [("normal", self._text)]
316
354
self.update()
317
355
return True # Keep calling this
318
356
319
def delete(self, **kwargs):
357
def delete(self, *args, **kwargs):
320
358
if self._update_timer_callback_tag is not None:
321
359
gobject.source_remove(self._update_timer_callback_tag)
322
360
self._update_timer_callback_tag = None
325
363
self.match_objects = ()
326
364
if self.delete_hook is not None:
327
365
self.delete_hook(self)
328
return super(MandosClientWidget, self).delete(**kwargs)
366
return super(MandosClientWidget, self).delete(*args, **kwargs)
329
367
330
368
def render(self, maxcolrow, focus=False):
331
369
"""Render differently if we have focus.
373
411
else:
374
412
return key
375
413
376
def properties_changed(self, interface, properties, invalidated):
377
"""Call self.update() if any properties changed.
414
def property_changed(self, property=None, value=None,
415
*args, **kwargs):
416
"""Call self.update() if old value is not new value.
378
417
This overrides the method from MandosClientPropertyCache"""
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):
418
property_name = unicode(property)
419
old_value = self.properties.get(property_name)
420
super(MandosClientWidget, self).property_changed(
421
property=property, value=value, *args, **kwargs)
422
if self.properties.get(property_name) != old_value:
385
423
self.update()
386
424
387
425
390
428
"down" key presses, thus not allowing any containing widgets to
391
429
use them as an excuse to shift focus away from this widget.
392
430
"""
393
def keypress(self, *args, **kwargs):
394
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
431
def keypress(self, maxcolrow, key):
432
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
395
433
if ret in ("up", "down"):
396
434
return
397
435
return ret
401
439
"""This is the entire user interface - the whole screen
402
440
with boxes, lists of client widgets, etc.
403
441
"""
404
def __init__(self, max_log_length=1000, log_level=1):
442
def __init__(self, max_log_length=1000):
405
443
DBusGMainLoop(set_as_default=True)
406
444
407
445
self.screen = urwid.curses_display.Screen()
410
448
("normal",
411
449
"default", "default", None),
412
450
("bold",
413
"bold", "default", "bold"),
451
"default", "default", "bold"),
414
452
("underline-blink",
415
"underline,blink", "default", "underline,blink"),
453
"default", "default", "underline"),
416
454
("standout",
417
"standout", "default", "standout"),
455
"default", "default", "standout"),
418
456
("bold-underline-blink",
419
"bold,underline,blink", "default", "bold,underline,blink"),
457
"default", "default", ("bold", "underline")),
420
458
("bold-standout",
421
"bold,standout", "default", "bold,standout"),
459
"default", "default", ("bold", "standout")),
422
460
("underline-blink-standout",
423
"underline,blink,standout", "default",
424
"underline,blink,standout"),
461
"default", "default", ("underline", "standout")),
425
462
("bold-underline-blink-standout",
426
"bold,underline,blink,standout", "default",
427
"bold,underline,blink,standout"),
463
"default", "default", ("bold", "underline",
464
"standout")),
428
465
))
429
466
430
467
if urwid.supports_unicode():
445
482
self.log = []
446
483
self.max_log_length = max_log_length
447
484
448
self.log_level = log_level
449
450
485
# We keep a reference to the log widget so we can remove it
451
486
# from the ListWalker without it getting destroyed
452
487
self.logbox = ConstrainedListBox(self.log)
466
501
self.main_loop = gobject.MainLoop()
467
502
468
503
def client_not_found(self, fingerprint, address):
469
self.log_message("Client with address {} and fingerprint {}"
470
" could not be found"
471
.format(address, fingerprint))
504
self.log_message(("Client with address %s and fingerprint %s"
505
" could not be found" % (address,
506
fingerprint)))
472
507
473
508
def rebuild(self):
474
509
"""This rebuilds the User Interface.
486
521
self.uilist.append(self.logbox)
487
522
self.topwidget = urwid.Pile(self.uilist)
488
523
489
def log_message(self, message, level=1):
490
"""Log message formatted with timestamp"""
491
if level < self.log_level:
492
return
524
def log_message(self, message):
493
525
timestamp = datetime.datetime.now().isoformat()
494
self.log_message_raw("{}: {}".format(timestamp, message),
495
level=level)
526
self.log_message_raw(timestamp + ": " + message)
496
527
497
def log_message_raw(self, markup, level=1):
528
def log_message_raw(self, markup):
498
529
"""Add a log message to the log buffer."""
499
if level < self.log_level:
500
return
501
530
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
531
if (self.max_log_length
503
532
and len(self.log) > self.max_log_length):
510
539
"""Toggle visibility of the log buffer."""
511
540
self.log_visible = not self.log_visible
512
541
self.rebuild()
513
self.log_message("Log visibility changed to: {}"
514
.format(self.log_visible), level=0)
542
#self.log_message("Log visibility changed to: "
543
# + unicode(self.log_visible))
515
544
516
545
def change_log_display(self):
517
546
"""Change type of log display.
522
551
self.log_wrap = "clip"
523
552
for textwidget in self.log:
524
553
textwidget.set_wrap_mode(self.log_wrap)
525
self.log_message("Wrap mode: {}".format(self.log_wrap),
526
level=0)
554
#self.log_message("Wrap mode: " + self.log_wrap)
527
555
528
556
def find_and_remove_client(self, path, name):
529
557
"""Find a client by its object path and remove it.
534
562
client = self.clients_dict[path]
535
563
except KeyError:
536
564
# not found?
537
self.log_message("Unknown client {!r} ({!r}) removed"
538
.format(name, path))
565
self.log_message("Unknown client %r (%r) removed", name,
566
path)
539
567
return
540
568
client.delete()
541
569
558
586
if path is None:
559
587
path = client.proxy.object_path
560
588
self.clients_dict[path] = client
561
self.clients.sort(key=lambda c: c.properties["Name"])
589
self.clients.sort(None, lambda c: c.properties["Name"])
562
590
self.refresh()
563
591
564
592
def remove_client(self, client, path=None):
566
594
if path is None:
567
595
path = client.proxy.object_path
568
596
del self.clients_dict[path]
597
if not self.clients_dict:
598
# Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
599
# is completely emptied, we need to recreate it.
600
self.clients = urwid.SimpleListWalker([])
601
self.rebuild()
569
602
self.refresh()
570
603
571
604
def refresh(self):
584
617
try:
585
618
mandos_clients = (self.mandos_serv
586
619
.GetAllClientsWithProperties())
587
if not mandos_clients:
588
self.log_message_raw(("bold", "Note: Server has no clients."))
589
620
except dbus.exceptions.DBusException:
590
self.log_message_raw(("bold", "Note: No Mandos server running."))
591
621
mandos_clients = dbus.Dictionary()
592
622
593
623
(self.mandos_serv
605
635
self.client_not_found,
606
636
dbus_interface=server_interface,
607
637
byte_arrays=True))
608
for path, client in mandos_clients.items():
638
for path, client in mandos_clients.iteritems():
609
639
client_proxy_object = self.bus.get_object(self.busname,
610
640
path)
611
641
self.add_client(MandosClientWidget(server_proxy_object
620
650
logger
621
651
=self.log_message),
622
652
path=path)
623
653
624
654
self.refresh()
625
655
self._input_callback_tag = (gobject.io_add_watch
626
656
(sys.stdin.fileno(),
658
688
elif key == "window resize":
659
689
self.size = self.screen.get_cols_rows()
660
690
self.refresh()
661
elif key == "ctrl l":
662
self.screen.clear()
691
elif key == "\f": # Ctrl-L
663
692
self.refresh()
664
693
elif key == "l" or key == "D":
665
694
self.toggle_log_display()
677
706
"?: Help",
678
707
"l: Log window toggle",
679
708
"TAB: Switch window",
680
"w: Wrap (log lines)",
681
"v: Toggle verbose log",
682
))))
709
"w: Wrap (log)"))))
683
710
self.log_message_raw(("bold",
684
711
" "
685
712
.join(("Clients:",
698
725
else:
699
726
self.topwidget.set_focus(self.logbox)
700
727
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")
708
728
#elif (key == "end" or key == "meta >" or key == "G"
709
729
# or key == ">"):
710
730
# pass # xxx end-of-buffer
733
753
ui.run()
734
754
except KeyboardInterrupt:
735
755
ui.screen.stop()
736
except Exception as e:
737
ui.log_message(str(e))
756
except Exception, e:
757
ui.log_message(unicode(e))
738
758
ui.screen.stop()
739
759
raise
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0