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