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-2012 Teddy Hogeborn
7
# Copyright © 2009-2012 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.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
def checker_completed(self, exitstatus, condition, command):
176
def checker_completed(self, exitstatus, signal, 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
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)))
216
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)))
221
elif os.WCOREDUMP(condition):
222
self.logger('Checker for client %s (command "%s")'
223
' dumped core'
224
% (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))
225
194
else:
226
self.logger('Checker for client %s completed'
227
' mysteriously')
195
self.logger('Checker for client {} completed'
196
' mysteriously'
197
.format(self.properties["Name"]))
228
198
self.update()
229
199
230
200
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
201
"""Server signals that a checker started."""
202
self.logger('Client {} started checker "{}"'
203
.format(self.properties["Name"],
204
command), level=0)
236
205
237
206
def got_secret(self):
238
self.logger('Client %s received its secret'
239
% self.properties["Name"])
207
self.logger('Client {} received its secret'
208
.format(self.properties["Name"]))
240
209
241
210
def need_approval(self, timeout, default):
242
211
if not default:
243
message = 'Client %s needs approval within %s seconds'
212
message = 'Client {} needs approval within {} seconds'
244
213
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)
214
message = 'Client {} will get its secret in {} seconds'
215
self.logger(message.format(self.properties["Name"],
216
timeout/1000))
249
217
250
218
def rejected(self, reason):
251
self.logger('Client %s was rejected; reason: %s'
252
% (self.properties["Name"], reason))
219
self.logger('Client {} was rejected; reason: {}'
220
.format(self.properties["Name"], reason))
253
221
254
222
def selectable(self):
255
223
"""Make this a "selectable" widget.
277
245
"bold-underline-blink":
278
246
"bold-underline-blink-standout",
279
247
}
280
248
281
249
# Rebuild focus and non-focus widgets using current properties
282
250
283
251
# Base part of a client. Name!
284
base = ('%(name)s: '
285
% {"name": self.properties["Name"]})
252
base = '{name}: '.format(name=self.properties["Name"])
286
253
if not self.properties["Enabled"]:
287
254
message = "DISABLED"
255
self.using_timer(False)
288
256
elif self.properties["ApprovalPending"]:
289
257
timeout = datetime.timedelta(milliseconds
290
258
= self.properties
292
260
last_approval_request = isoformat_to_datetime(
293
261
self.properties["LastApprovalRequest"])
294
262
if last_approval_request is not None:
295
timer = timeout - (datetime.datetime.utcnow()
296
- last_approval_request)
263
timer = max(timeout - (datetime.datetime.utcnow()
264
- last_approval_request),
265
datetime.timedelta())
297
266
else:
298
267
timer = datetime.timedelta()
299
268
if self.properties["ApprovedByDefault"]:
300
message = "Approval in %s. (d)eny?"
269
message = "Approval in {}. (d)eny?"
301
270
else:
302
message = "Denial in %s. (a)pprove?"
303
message = message % unicode(timer).rsplit(".", 1)[0]
271
message = "Denial in {}. (a)pprove?"
272
message = message.format(str(timer).rsplit(".", 1)[0])
273
self.using_timer(True)
304
274
elif self.properties["LastCheckerStatus"] != 0:
305
# When checker has failed, print a timer until client expires
275
# When checker has failed, show timer until client expires
306
276
expires = self.properties["Expires"]
307
277
if expires == "":
308
278
timer = datetime.timedelta(0)
309
279
else:
310
expires = datetime.datetime.strptime(expires,
311
'%Y-%m-%dT%H:%M:%S.%f')
312
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())
313
284
message = ('A checker has failed! Time until client'
314
' gets disabled: %s'
315
% unicode(timer).rsplit(".", 1)[0])
285
' gets disabled: {}'
286
.format(str(timer).rsplit(".", 1)[0]))
287
self.using_timer(True)
316
288
else:
317
289
message = "enabled"
318
self._text = "%s%s" % (base, message)
319
290
self.using_timer(False)
291
self._text = "{}{}".format(base, message)
292
320
293
if not urwid.supports_unicode():
321
294
self._text = self._text.encode("ascii", "replace")
322
295
textlist = [("normal", self._text)]
339
312
self.update()
340
313
return True # Keep calling this
341
314
342
def delete(self, *args, **kwargs):
315
def delete(self, **kwargs):
343
316
if self._update_timer_callback_tag is not None:
344
317
gobject.source_remove(self._update_timer_callback_tag)
345
318
self._update_timer_callback_tag = None
348
321
self.match_objects = ()
349
322
if self.delete_hook is not None:
350
323
self.delete_hook(self)
351
return super(MandosClientWidget, self).delete(*args, **kwargs)
324
return super(MandosClientWidget, self).delete(**kwargs)
352
325
353
326
def render(self, maxcolrow, focus=False):
354
327
"""Render differently if we have focus.
396
369
else:
397
370
return key
398
371
399
def property_changed(self, property=None, value=None,
400
*args, **kwargs):
401
"""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.
402
374
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:
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):
408
381
self.update()
409
382
410
383
413
386
"down" key presses, thus not allowing any containing widgets to
414
387
use them as an excuse to shift focus away from this widget.
415
388
"""
416
def keypress(self, maxcolrow, key):
417
ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
389
def keypress(self, *args, **kwargs):
390
ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
418
391
if ret in ("up", "down"):
419
392
return
420
393
return ret
424
397
"""This is the entire user interface - the whole screen
425
398
with boxes, lists of client widgets, etc.
426
399
"""
427
def __init__(self, max_log_length=1000):
400
def __init__(self, max_log_length=1000, log_level=1):
428
401
DBusGMainLoop(set_as_default=True)
429
402
430
403
self.screen = urwid.curses_display.Screen()
433
406
("normal",
434
407
"default", "default", None),
435
408
("bold",
436
"default", "default", "bold"),
409
"bold", "default", "bold"),
437
410
("underline-blink",
438
"default", "default", "underline"),
411
"underline,blink", "default", "underline,blink"),
439
412
("standout",
440
"default", "default", "standout"),
413
"standout", "default", "standout"),
441
414
("bold-underline-blink",
442
"default", "default", ("bold", "underline")),
415
"bold,underline,blink", "default", "bold,underline,blink"),
443
416
("bold-standout",
444
"default", "default", ("bold", "standout")),
417
"bold,standout", "default", "bold,standout"),
445
418
("underline-blink-standout",
446
"default", "default", ("underline", "standout")),
419
"underline,blink,standout", "default",
420
"underline,blink,standout"),
447
421
("bold-underline-blink-standout",
448
"default", "default", ("bold", "underline",
449
"standout")),
422
"bold,underline,blink,standout", "default",
423
"bold,underline,blink,standout"),
450
424
))
451
425
452
426
if urwid.supports_unicode():
467
441
self.log = []
468
442
self.max_log_length = max_log_length
469
443
444
self.log_level = log_level
445
470
446
# We keep a reference to the log widget so we can remove it
471
447
# from the ListWalker without it getting destroyed
472
448
self.logbox = ConstrainedListBox(self.log)
486
462
self.main_loop = gobject.MainLoop()
487
463
488
464
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)))
465
self.log_message("Client with address {} and fingerprint {}"
466
" could not be found"
467
.format(address, fingerprint))
492
468
493
469
def rebuild(self):
494
470
"""This rebuilds the User Interface.
506
482
self.uilist.append(self.logbox)
507
483
self.topwidget = urwid.Pile(self.uilist)
508
484
509
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
510
489
timestamp = datetime.datetime.now().isoformat()
511
self.log_message_raw(timestamp + ": " + message)
490
self.log_message_raw("{}: {}".format(timestamp, message),
491
level=level)
512
492
513
def log_message_raw(self, markup):
493
def log_message_raw(self, markup, level=1):
514
494
"""Add a log message to the log buffer."""
495
if level < self.log_level:
496
return
515
497
self.log.append(urwid.Text(markup, wrap=self.log_wrap))
516
498
if (self.max_log_length
517
499
and len(self.log) > self.max_log_length):
524
506
"""Toggle visibility of the log buffer."""
525
507
self.log_visible = not self.log_visible
526
508
self.rebuild()
527
#self.log_message("Log visibility changed to: "
528
# + unicode(self.log_visible))
509
self.log_message("Log visibility changed to: {}"
510
.format(self.log_visible), level=0)
529
511
530
512
def change_log_display(self):
531
513
"""Change type of log display.
536
518
self.log_wrap = "clip"
537
519
for textwidget in self.log:
538
520
textwidget.set_wrap_mode(self.log_wrap)
539
#self.log_message("Wrap mode: " + self.log_wrap)
521
self.log_message("Wrap mode: {}".format(self.log_wrap),
522
level=0)
540
523
541
524
def find_and_remove_client(self, path, name):
542
525
"""Find a client by its object path and remove it.
547
530
client = self.clients_dict[path]
548
531
except KeyError:
549
532
# not found?
550
self.log_message("Unknown client %r (%r) removed", name,
551
path)
533
self.log_message("Unknown client {!r} ({!r}) removed"
534
.format(name, path))
552
535
return
553
536
client.delete()
554
537
571
554
if path is None:
572
555
path = client.proxy.object_path
573
556
self.clients_dict[path] = client
574
self.clients.sort(None, lambda c: c.properties["Name"])
557
self.clients.sort(key=lambda c: c.properties["Name"])
575
558
self.refresh()
576
559
577
560
def remove_client(self, client, path=None):
579
562
if path is None:
580
563
path = client.proxy.object_path
581
564
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
565
self.refresh()
588
566
589
567
def refresh(self):
602
580
try:
603
581
mandos_clients = (self.mandos_serv
604
582
.GetAllClientsWithProperties())
583
if not mandos_clients:
584
self.log_message_raw(("bold", "Note: Server has no clients."))
605
585
except dbus.exceptions.DBusException:
586
self.log_message_raw(("bold", "Note: No Mandos server running."))
606
587
mandos_clients = dbus.Dictionary()
607
588
608
589
(self.mandos_serv
620
601
self.client_not_found,
621
602
dbus_interface=server_interface,
622
603
byte_arrays=True))
623
for path, client in mandos_clients.iteritems():
604
for path, client in mandos_clients.items():
624
605
client_proxy_object = self.bus.get_object(self.busname,
625
606
path)
626
607
self.add_client(MandosClientWidget(server_proxy_object
635
616
logger
636
617
=self.log_message),
637
618
path=path)
638
619
639
620
self.refresh()
640
621
self._input_callback_tag = (gobject.io_add_watch
641
622
(sys.stdin.fileno(),
673
654
elif key == "window resize":
674
655
self.size = self.screen.get_cols_rows()
675
656
self.refresh()
676
elif key == "\f": # Ctrl-L
657
elif key == "ctrl l":
658
self.screen.clear()
677
659
self.refresh()
678
660
elif key == "l" or key == "D":
679
661
self.toggle_log_display()
691
673
"?: Help",
692
674
"l: Log window toggle",
693
675
"TAB: Switch window",
694
"w: Wrap (log)"))))
676
"w: Wrap (log lines)",
677
"v: Toggle verbose log",
678
))))
695
679
self.log_message_raw(("bold",
696
680
" "
697
681
.join(("Clients:",
710
694
else:
711
695
self.topwidget.set_focus(self.logbox)
712
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")
713
704
#elif (key == "end" or key == "meta >" or key == "G"
714
705
# or key == ">"):
715
706
# pass # xxx end-of-buffer
738
729
ui.run()
739
730
except KeyboardInterrupt:
740
731
ui.screen.stop()
741
except Exception, e:
742
ui.log_message(unicode(e))
732
except Exception as e:
733
ui.log_message(str(e))
743
734
ui.screen.stop()
744
735
raise
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0