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 237.7.318
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.318
- Committer: Teddy Hogeborn
- Date: 2015-07-12 01:57:54 UTC
- mto: (237.7.594 trunk)
- mto: This revision was merged to the branch mainline in revision 325.
- Revision ID: teddy@recompile.se-20150712015754-1lq7u2ejo7fdyfvi
* debian/mandos.prerm: Don't run init script, use only invoke-rc.d.
- files added:
- debian/mandos-client.examples
- debian/upstream
- plugin-helpers
- files modified:
- .bzrignore
added
removed
mandos-monitor
3
3
#
4
4
# Mandos Monitor - Control and monitor the Mandos server
5
5
#
6
# Copyright © 2009-2011 Teddy Hogeborn
7
# Copyright © 2009-2011 Björn Påhlsson
6
# Copyright © 2009-2015 Teddy Hogeborn
7
# Copyright © 2009-2015 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.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)
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
self.last_checker_failed = False
135
130
136
131
# The widget shown normally
137
132
self._text_widget = urwid.Text("")
138
133
# The widget shown when we have focus
139
134
self._focus_text_widget = urwid.Text("")
140
super(MandosClientWidget, self).__init__(
141
update_hook=update_hook, delete_hook=delete_hook,
142
*args, **kwargs)
135
super(MandosClientWidget, self).__init__(**kwargs)
143
136
self.update()
144
137
self.opened = False
145
138
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
164
139
self.match_objects = (
165
140
self.proxy.connect_to_signal("CheckerCompleted",
166
141
self.checker_completed,
182
157
self.rejected,
183
158
client_interface,
184
159
byte_arrays=True))
185
#self.logger('Created client %s' % (self.properties["Name"]))
160
self.logger('Created client {}'
161
.format(self.properties["Name"]), level=0)
186
162
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
193
163
def using_timer(self, flag):
194
164
"""Call this method with True or False when timer should be
195
165
activated or deactivated.
196
166
"""
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:
167
if flag and self._update_timer_callback_tag is None:
203
168
# Will update the shown timer value every second
204
169
self._update_timer_callback_tag = (gobject.timeout_add
205
170
(1000,
206
171
self.update_timer))
207
elif old and self._update_timer_callback_lock == 0:
172
elif not (flag or self._update_timer_callback_tag is None):
208
173
gobject.source_remove(self._update_timer_callback_tag)
209
174
self._update_timer_callback_tag = None
210
175
211
def checker_completed(self, exitstatus, condition, command):
176
def checker_completed(self, exitstatus, signal, command):
212
177
if exitstatus == 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))
178
self.logger('Checker for client {} (command "{}")'
179
' succeeded'.format(self.properties["Name"],
180
command), level=0)
219
181
self.update()
220
182
return
221
183
# Checker failed
222
if not self.last_checker_failed:
223
self.last_checker_failed = True
224
self.using_timer(True)
225
if os.WIFEXITED(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)))
230
elif os.WIFSIGNALED(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)))
235
elif os.WCOREDUMP(condition):
236
self.logger('Checker for client %s (command "%s")'
237
' dumped core'
238
% (self.properties["Name"], command))
184
if exitstatus >= 0:
185
self.logger('Checker for client {} (command "{}") failed'
186
' with exit code {}'
187
.format(self.properties["Name"], command,
188
exitstatus))
189
elif signal != 0:
190
self.logger('Checker for client {} (command "{}") was'
191
' killed by signal {}'
192
.format(self.properties["Name"], command,
193
signal))
239
194
else:
240
self.logger('Checker for client %s completed'
241
' mysteriously')
195
self.logger('Checker for client {} completed'
196
' mysteriously'
197
.format(self.properties["Name"]))
242
198
self.update()
243
199
244
200
def checker_started(self, command):
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
201
"""Server signals that a checker started."""
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
204
command), level=0)
250
205
251
206
def got_secret(self):
252
self.last_checker_failed = False
253
self.logger('Client %s received its secret'
254
% self.properties["Name"])
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
255
209
256
210
def need_approval(self, timeout, default):
257
211
if not default:
258
message = 'Client %s needs approval within %s seconds'
212
message = 'Client {} needs approval within {} seconds'
259
213
else:
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)
214
message = 'Client {} will get its secret in {} seconds'
215
self.logger(message.format(self.properties["Name"],
216
timeout/1000))
264
217
265
218
def rejected(self, reason):
266
self.logger('Client %s was rejected; reason: %s'
267
% (self.properties["Name"], reason))
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
268
221
269
222
def selectable(self):
270
223
"""Make this a "selectable" widget.
292
245
"bold-underline-blink":
293
246
"bold-underline-blink-standout",
294
247
}
295
248
296
249
# Rebuild focus and non-focus widgets using current properties
297
250
298
251
# Base part of a client. Name!
299
base = ('%(name)s: '
300
% {"name": self.properties["Name"]})
252
base = '{name}: '.format(name=self.properties["Name"])
301
253
if not self.properties["Enabled"]:
302
254
message = "DISABLED"
255
self.using_timer(False)
303
256
elif self.properties["ApprovalPending"]:
304
257
timeout = datetime.timedelta(milliseconds
305
258
= self.properties
307
260
last_approval_request = isoformat_to_datetime(
308
261
self.properties["LastApprovalRequest"])
309
262
if last_approval_request is not None:
310
timer = timeout - (datetime.datetime.utcnow()
311
- last_approval_request)
263
timer = max(timeout - (datetime.datetime.utcnow()
264
- last_approval_request),
265
datetime.timedelta())
312
266
else:
313
267
timer = datetime.timedelta()
314
268
if self.properties["ApprovedByDefault"]:
315
message = "Approval in %s. (d)eny?"
269
message = "Approval in {}. (d)eny?"
316
270
else:
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
271
message = "Denial in {}. (a)pprove?"
272
message = message.format(str(timer).rsplit(".", 1)[0])
273
self.using_timer(True)
274
elif self.properties["LastCheckerStatus"] != 0:
275
# When checker has failed, show timer until client expires
321
276
expires = self.properties["Expires"]
322
277
if expires == "":
323
278
timer = datetime.timedelta(0)
324
279
else:
325
expires = datetime.datetime.strptime(expires,
326
'%Y-%m-%dT%H:%M:%S.%f')
327
timer = expires - datetime.datetime.utcnow()
280
expires = (datetime.datetime.strptime
281
(expires, '%Y-%m-%dT%H:%M:%S.%f'))
282
timer = max(expires - datetime.datetime.utcnow(),
283
datetime.timedelta())
328
284
message = ('A checker has failed! Time until client'
329
' gets disabled: %s'
330
% unicode(timer).rsplit(".", 1)[0])
285
' gets disabled: {}'
286
.format(str(timer).rsplit(".", 1)[0]))
287
self.using_timer(True)
331
288
else:
332
289
message = "enabled"
333
self._text = "%s%s" % (base, message)
334
290
self.using_timer(False)
291
self._text = "{}{}".format(base, message)
292
335
293
if not urwid.supports_unicode():
336
294
self._text = self._text.encode("ascii", "replace")
337
295
textlist = [("normal", self._text)]
354
312
self.update()
355
313
return True # Keep calling this
356
314
357
def delete(self, *args, **kwargs):
315
def delete(self, **kwargs):
358
316
if self._update_timer_callback_tag is not None:
359
317
gobject.source_remove(self._update_timer_callback_tag)
360
318
self._update_timer_callback_tag = None
363
321
self.match_objects = ()
364
322
if self.delete_hook is not None:
365
323
self.delete_hook(self)
366
return super(MandosClientWidget, self).delete(*args, **kwargs)
324
return super(MandosClientWidget, self).delete(**kwargs)
367
325
368
326
def render(self, maxcolrow, focus=False):
369
327
"""Render differently if we have focus.
411
369
else:
412
370
return key
413
371
414
def property_changed(self, property=None, value=None,
415
*args, **kwargs):
416
"""Call self.update() if old value is not new value.
372
def properties_changed(self, interface, properties, invalidated):
373
"""Call self.update() if any properties changed.
417
374
This overrides the method from MandosClientPropertyCache"""
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:
375
old_values = { key: self.properties.get(key)
376
for key in properties.keys() }
377
super(MandosClientWidget, self).properties_changed(
378
interface, properties, invalidated)
379
if any(old_values[key] != self.properties.get(key)
380
for key in old_values):
423
381
self.update()
424
382
425
383
428
386
"down" key presses, thus not allowing any containing widgets to
429
387
use them as an excuse to shift focus away from this widget.
430
388
"""
431
def keypress(self, maxcolrow, key):
432
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
389
def keypress(self, *args, **kwargs):
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
433
391
if ret in ("up", "down"):
434
392
return
435
393
return ret
439
397
"""This is the entire user interface - the whole screen
440
398
with boxes, lists of client widgets, etc.
441
399
"""
442
def __init__(self, max_log_length=1000):
400
def __init__(self, max_log_length=1000, log_level=1):
443
401
DBusGMainLoop(set_as_default=True)
444
402
445
403
self.screen = urwid.curses_display.Screen()
448
406
("normal",
449
407
"default", "default", None),
450
408
("bold",
451
"default", "default", "bold"),
409
"bold", "default", "bold"),
452
410
("underline-blink",
453
"default", "default", "underline"),
411
"underline,blink", "default", "underline,blink"),
454
412
("standout",
455
"default", "default", "standout"),
413
"standout", "default", "standout"),
456
414
("bold-underline-blink",
457
"default", "default", ("bold", "underline")),
415
"bold,underline,blink", "default", "bold,underline,blink"),
458
416
("bold-standout",
459
"default", "default", ("bold", "standout")),
417
"bold,standout", "default", "bold,standout"),
460
418
("underline-blink-standout",
461
"default", "default", ("underline", "standout")),
419
"underline,blink,standout", "default",
420
"underline,blink,standout"),
462
421
("bold-underline-blink-standout",
463
"default", "default", ("bold", "underline",
464
"standout")),
422
"bold,underline,blink,standout", "default",
423
"bold,underline,blink,standout"),
465
424
))
466
425
467
426
if urwid.supports_unicode():
482
441
self.log = []
483
442
self.max_log_length = max_log_length
484
443
444
self.log_level = log_level
445
485
446
# We keep a reference to the log widget so we can remove it
486
447
# from the ListWalker without it getting destroyed
487
448
self.logbox = ConstrainedListBox(self.log)
501
462
self.main_loop = gobject.MainLoop()
502
463
503
464
def client_not_found(self, fingerprint, address):
504
self.log_message(("Client with address %s and fingerprint %s"
505
" could not be found" % (address,
506
fingerprint)))
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.format(address, fingerprint))
507
468
508
469
def rebuild(self):
509
470
"""This rebuilds the User Interface.
521
482
self.uilist.append(self.logbox)
522
483
self.topwidget = urwid.Pile(self.uilist)
523
484
524
def log_message(self, message):
485
def log_message(self, message, level=1):
486
"""Log message formatted with timestamp"""
487
if level < self.log_level:
488
return
525
489
timestamp = datetime.datetime.now().isoformat()
526
self.log_message_raw(timestamp + ": " + message)
490
self.log_message_raw("{}: {}".format(timestamp, message),
491
level=level)
527
492
528
def log_message_raw(self, markup):
493
def log_message_raw(self, markup, level=1):
529
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
496
return
530
497
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
531
498
if (self.max_log_length
532
499
and len(self.log) > self.max_log_length):
539
506
"""Toggle visibility of the log buffer."""
540
507
self.log_visible = not self.log_visible
541
508
self.rebuild()
542
#self.log_message("Log visibility changed to: "
543
# + unicode(self.log_visible))
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
544
511
545
512
def change_log_display(self):
546
513
"""Change type of log display.
551
518
self.log_wrap = "clip"
552
519
for textwidget in self.log:
553
520
textwidget.set_wrap_mode(self.log_wrap)
554
#self.log_message("Wrap mode: " + self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
522
level=0)
555
523
556
524
def find_and_remove_client(self, path, name):
557
525
"""Find a client by its object path and remove it.
562
530
client = self.clients_dict[path]
563
531
except KeyError:
564
532
# not found?
565
self.log_message("Unknown client %r (%r) removed", name,
566
path)
533
self.log_message("Unknown client {!r} ({!r}) removed"
534
.format(name, path))
567
535
return
568
536
client.delete()
569
537
586
554
if path is None:
587
555
path = client.proxy.object_path
588
556
self.clients_dict[path] = client
589
self.clients.sort(None, lambda c: c.properties["Name"])
557
self.clients.sort(key=lambda c: c.properties["Name"])
590
558
self.refresh()
591
559
592
560
def remove_client(self, client, path=None):
594
562
if path is None:
595
563
path = client.proxy.object_path
596
564
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()
602
565
self.refresh()
603
566
604
567
def refresh(self):
617
580
try:
618
581
mandos_clients = (self.mandos_serv
619
582
.GetAllClientsWithProperties())
583
if not mandos_clients:
584
self.log_message_raw(("bold", "Note: Server has no clients."))
620
585
except dbus.exceptions.DBusException:
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
621
587
mandos_clients = dbus.Dictionary()
622
588
623
589
(self.mandos_serv
635
601
self.client_not_found,
636
602
dbus_interface=server_interface,
637
603
byte_arrays=True))
638
for path, client in mandos_clients.iteritems():
604
for path, client in mandos_clients.items():
639
605
client_proxy_object = self.bus.get_object(self.busname,
640
606
path)
641
607
self.add_client(MandosClientWidget(server_proxy_object
650
616
logger
651
617
=self.log_message),
652
618
path=path)
653
619
654
620
self.refresh()
655
621
self._input_callback_tag = (gobject.io_add_watch
656
622
(sys.stdin.fileno(),
688
654
elif key == "window resize":
689
655
self.size = self.screen.get_cols_rows()
690
656
self.refresh()
691
elif key == "\f": # Ctrl-L
657
elif key == "ctrl l":
658
self.screen.clear()
692
659
self.refresh()
693
660
elif key == "l" or key == "D":
694
661
self.toggle_log_display()
706
673
"?: Help",
707
674
"l: Log window toggle",
708
675
"TAB: Switch window",
709
"w: Wrap (log)"))))
676
"w: Wrap (log lines)",
677
"v: Toggle verbose log",
678
))))
710
679
self.log_message_raw(("bold",
711
680
" "
712
681
.join(("Clients:",
725
694
else:
726
695
self.topwidget.set_focus(self.logbox)
727
696
self.refresh()
697
elif key == "v":
698
if self.log_level == 0:
699
self.log_level = 1
700
self.log_message("Verbose mode: Off")
701
else:
702
self.log_level = 0
703
self.log_message("Verbose mode: On")
728
704
#elif (key == "end" or key == "meta >" or key == "G"
729
705
# or key == ">"):
730
706
# pass # xxx end-of-buffer
753
729
ui.run()
754
730
except KeyboardInterrupt:
755
731
ui.screen.stop()
756
except Exception, e:
757
ui.log_message(unicode(e))
732
except Exception as e:
733
ui.log_message(str(e))
758
734
ui.screen.stop()
759
735
raise
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0