/mandos/trunk

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

  • Committer: Teddy Hogeborn
  • Date: 2012-07-23 07:01:16 UTC
  • Revision ID: teddy@recompile.se-20120723070116-m53ztbi619gj5txj
* plugins.d/mandos-client.xml: Fix minor grammar.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-2012 Teddy Hogeborn
 
7
# Copyright © 2009-2012 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
25
25
 
26
26
from __future__ import (division, absolute_import, print_function,
27
27
                        unicode_literals)
28
 
try:
29
 
    from future_builtins import *
30
 
except ImportError:
31
 
    pass
 
28
 
 
29
from future_builtins import *
32
30
 
33
31
import sys
34
32
import os
 
33
import signal
35
34
 
36
35
import datetime
37
36
 
39
38
import urwid
40
39
 
41
40
from dbus.mainloop.glib import DBusGMainLoop
42
 
try:
43
 
    import gobject
44
 
except ImportError:
45
 
    from gi.repository import GObject as gobject
 
41
import gobject
46
42
 
47
43
import dbus
48
44
 
 
45
import UserList
 
46
 
49
47
import locale
50
48
 
51
 
if sys.version_info.major == 2:
52
 
    str = unicode
53
 
 
54
49
locale.setlocale(locale.LC_ALL, '')
55
50
 
56
51
import logging
60
55
domain = 'se.recompile'
61
56
server_interface = domain + '.Mandos'
62
57
client_interface = domain + '.Mandos.Client'
63
 
version = "1.6.9"
 
58
version = "1.6.0"
 
59
 
 
60
# Always run in monochrome mode
 
61
urwid.curses_display.curses.has_colors = lambda : False
 
62
 
 
63
# Urwid doesn't support blinking, but we want it.  Since we have no
 
64
# use for underline on its own, we make underline also always blink.
 
65
urwid.curses_display.curses.A_UNDERLINE |= (
 
66
    urwid.curses_display.curses.A_BLINK)
64
67
 
65
68
def isoformat_to_datetime(iso):
66
69
    "Parse an ISO 8601 date string to a datetime.datetime()"
87
90
        self.proxy = proxy_object # Mandos Client proxy object
88
91
        self.properties = dict() if properties is None else properties
89
92
        self.property_changed_match = (
90
 
            self.proxy.connect_to_signal("PropertiesChanged",
91
 
                                         self.properties_changed,
92
 
                                         dbus.PROPERTIES_IFACE,
 
93
            self.proxy.connect_to_signal("PropertyChanged",
 
94
                                         self._property_changed,
 
95
                                         client_interface,
93
96
                                         byte_arrays=True))
94
97
        
95
98
        if properties is None:
100
103
        
101
104
        super(MandosClientPropertyCache, self).__init__(**kwargs)
102
105
    
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
    def _property_changed(self, property, value):
 
107
        """Helper which takes positional arguments"""
 
108
        return self.property_changed(property=property, value=value)
 
109
    
 
110
    def property_changed(self, property=None, value=None):
 
111
        """This is called whenever we get a PropertyChanged signal
 
112
        It updates the changed property in the "properties" dict.
106
113
        """
107
114
        # Update properties dict with new value
108
 
        self.properties.update(properties)
 
115
        self.properties[property] = value
109
116
    
110
117
    def delete(self):
111
118
        self.property_changed_match.remove()
157
164
                                         self.rejected,
158
165
                                         client_interface,
159
166
                                         byte_arrays=True))
160
 
        self.logger('Created client {}'
161
 
                    .format(self.properties["Name"]), level=0)
 
167
        #self.logger('Created client {0}'
 
168
        #            .format(self.properties["Name"]))
162
169
    
163
170
    def using_timer(self, flag):
164
171
        """Call this method with True or False when timer should be
175
182
    
176
183
    def checker_completed(self, exitstatus, condition, command):
177
184
        if exitstatus == 0:
178
 
            self.logger('Checker for client {} (command "{}")'
179
 
                        ' succeeded'.format(self.properties["Name"],
180
 
                                            command), level=0)
181
185
            self.update()
182
186
            return
183
187
        # Checker failed
184
188
        if os.WIFEXITED(condition):
185
 
            self.logger('Checker for client {} (command "{}") failed'
186
 
                        ' with exit code {}'
 
189
            self.logger('Checker for client {0} (command "{1}")'
 
190
                        ' failed with exit code {2}'
187
191
                        .format(self.properties["Name"], command,
188
192
                                os.WEXITSTATUS(condition)))
189
193
        elif os.WIFSIGNALED(condition):
190
 
            self.logger('Checker for client {} (command "{}") was'
191
 
                        ' killed by signal {}'
 
194
            self.logger('Checker for client {0} (command "{1}") was'
 
195
                        ' killed by signal {2}'
192
196
                        .format(self.properties["Name"], command,
193
197
                                os.WTERMSIG(condition)))
194
198
        elif os.WCOREDUMP(condition):
195
 
            self.logger('Checker for client {} (command "{}") dumped'
196
 
                        ' core'.format(self.properties["Name"],
197
 
                                       command))
 
199
            self.logger('Checker for client {0} (command "{1}")'
 
200
                        ' dumped core'
 
201
                        .format(self.properties["Name"], command))
198
202
        else:
199
 
            self.logger('Checker for client {} completed'
 
203
            self.logger('Checker for client {0} completed'
200
204
                        ' mysteriously'
201
205
                        .format(self.properties["Name"]))
202
206
        self.update()
203
207
    
204
208
    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)
 
209
        """Server signals that a checker started. This could be useful
 
210
           to log in the future. """
 
211
        #self.logger('Client {0} started checker "{1}"'
 
212
        #            .format(self.properties["Name"],
 
213
        #                    unicode(command)))
 
214
        pass
209
215
    
210
216
    def got_secret(self):
211
 
        self.logger('Client {} received its secret'
 
217
        self.logger('Client {0} received its secret'
212
218
                    .format(self.properties["Name"]))
213
219
    
214
220
    def need_approval(self, timeout, default):
215
221
        if not default:
216
 
            message = 'Client {} needs approval within {} seconds'
 
222
            message = 'Client {0} needs approval within {1} seconds'
217
223
        else:
218
 
            message = 'Client {} will get its secret in {} seconds'
 
224
            message = 'Client {0} will get its secret in {1} seconds'
219
225
        self.logger(message.format(self.properties["Name"],
220
226
                                   timeout/1000))
221
227
    
222
228
    def rejected(self, reason):
223
 
        self.logger('Client {} was rejected; reason: {}'
 
229
        self.logger('Client {0} was rejected; reason: {1}'
224
230
                    .format(self.properties["Name"], reason))
225
231
    
226
232
    def selectable(self):
270
276
            else:
271
277
                timer = datetime.timedelta()
272
278
            if self.properties["ApprovedByDefault"]:
273
 
                message = "Approval in {}. (d)eny?"
 
279
                message = "Approval in {0}. (d)eny?"
274
280
            else:
275
 
                message = "Denial in {}. (a)pprove?"
276
 
            message = message.format(str(timer).rsplit(".", 1)[0])
 
281
                message = "Denial in {0}. (a)pprove?"
 
282
            message = message.format(unicode(timer).rsplit(".", 1)[0])
277
283
            self.using_timer(True)
278
284
        elif self.properties["LastCheckerStatus"] != 0:
279
285
            # When checker has failed, show timer until client expires
286
292
                timer = max(expires - datetime.datetime.utcnow(),
287
293
                            datetime.timedelta())
288
294
            message = ('A checker has failed! Time until client'
289
 
                       ' gets disabled: {}'
290
 
                       .format(str(timer).rsplit(".", 1)[0]))
 
295
                       ' gets disabled: {0}'
 
296
                       .format(unicode(timer).rsplit(".", 1)[0]))
291
297
            self.using_timer(True)
292
298
        else:
293
299
            message = "enabled"
294
300
            self.using_timer(False)
295
 
        self._text = "{}{}".format(base, message)
 
301
        self._text = "{0}{1}".format(base, message)
296
302
        
297
303
        if not urwid.supports_unicode():
298
304
            self._text = self._text.encode("ascii", "replace")
373
379
        else:
374
380
            return key
375
381
    
376
 
    def properties_changed(self, interface, properties, invalidated):
377
 
        """Call self.update() if any properties changed.
 
382
    def property_changed(self, property=None, **kwargs):
 
383
        """Call self.update() if old value is not new value.
378
384
        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):
 
385
        property_name = unicode(property)
 
386
        old_value = self.properties.get(property_name)
 
387
        super(MandosClientWidget, self).property_changed(
 
388
            property=property, **kwargs)
 
389
        if self.properties.get(property_name) != old_value:
385
390
            self.update()
386
391
 
387
392
 
401
406
    """This is the entire user interface - the whole screen
402
407
    with boxes, lists of client widgets, etc.
403
408
    """
404
 
    def __init__(self, max_log_length=1000, log_level=1):
 
409
    def __init__(self, max_log_length=1000):
405
410
        DBusGMainLoop(set_as_default=True)
406
411
        
407
412
        self.screen = urwid.curses_display.Screen()
410
415
                ("normal",
411
416
                 "default", "default", None),
412
417
                ("bold",
413
 
                 "bold", "default", "bold"),
 
418
                 "default", "default", "bold"),
414
419
                ("underline-blink",
415
 
                 "underline,blink", "default", "underline,blink"),
 
420
                 "default", "default", "underline"),
416
421
                ("standout",
417
 
                 "standout", "default", "standout"),
 
422
                 "default", "default", "standout"),
418
423
                ("bold-underline-blink",
419
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
424
                 "default", "default", ("bold", "underline")),
420
425
                ("bold-standout",
421
 
                 "bold,standout", "default", "bold,standout"),
 
426
                 "default", "default", ("bold", "standout")),
422
427
                ("underline-blink-standout",
423
 
                 "underline,blink,standout", "default",
424
 
                 "underline,blink,standout"),
 
428
                 "default", "default", ("underline", "standout")),
425
429
                ("bold-underline-blink-standout",
426
 
                 "bold,underline,blink,standout", "default",
427
 
                 "bold,underline,blink,standout"),
 
430
                 "default", "default", ("bold", "underline",
 
431
                                          "standout")),
428
432
                ))
429
433
        
430
434
        if urwid.supports_unicode():
445
449
        self.log = []
446
450
        self.max_log_length = max_log_length
447
451
        
448
 
        self.log_level = log_level
449
 
        
450
452
        # We keep a reference to the log widget so we can remove it
451
453
        # from the ListWalker without it getting destroyed
452
454
        self.logbox = ConstrainedListBox(self.log)
466
468
        self.main_loop = gobject.MainLoop()
467
469
    
468
470
    def client_not_found(self, fingerprint, address):
469
 
        self.log_message("Client with address {} and fingerprint {}"
470
 
                         " could not be found"
 
471
        self.log_message("Client with address {0} and fingerprint"
 
472
                         " {1} could not be found"
471
473
                         .format(address, fingerprint))
472
474
    
473
475
    def rebuild(self):
486
488
            self.uilist.append(self.logbox)
487
489
        self.topwidget = urwid.Pile(self.uilist)
488
490
    
489
 
    def log_message(self, message, level=1):
 
491
    def log_message(self, message):
490
492
        """Log message formatted with timestamp"""
491
 
        if level < self.log_level:
492
 
            return
493
493
        timestamp = datetime.datetime.now().isoformat()
494
 
        self.log_message_raw("{}: {}".format(timestamp, message),
495
 
                             level=level)
 
494
        self.log_message_raw(timestamp + ": " + message)
496
495
    
497
 
    def log_message_raw(self, markup, level=1):
 
496
    def log_message_raw(self, markup):
498
497
        """Add a log message to the log buffer."""
499
 
        if level < self.log_level:
500
 
            return
501
498
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
499
        if (self.max_log_length
503
500
            and len(self.log) > self.max_log_length):
510
507
        """Toggle visibility of the log buffer."""
511
508
        self.log_visible = not self.log_visible
512
509
        self.rebuild()
513
 
        self.log_message("Log visibility changed to: {}"
514
 
                         .format(self.log_visible), level=0)
 
510
        #self.log_message("Log visibility changed to: "
 
511
        #                 + unicode(self.log_visible))
515
512
    
516
513
    def change_log_display(self):
517
514
        """Change type of log display.
522
519
            self.log_wrap = "clip"
523
520
        for textwidget in self.log:
524
521
            textwidget.set_wrap_mode(self.log_wrap)
525
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
526
 
                         level=0)
 
522
        #self.log_message("Wrap mode: " + self.log_wrap)
527
523
    
528
524
    def find_and_remove_client(self, path, name):
529
525
        """Find a client by its object path and remove it.
534
530
            client = self.clients_dict[path]
535
531
        except KeyError:
536
532
            # not found?
537
 
            self.log_message("Unknown client {!r} ({!r}) removed"
 
533
            self.log_message("Unknown client {0!r} ({1!r}) removed"
538
534
                             .format(name, path))
539
535
            return
540
536
        client.delete()
558
554
        if path is None:
559
555
            path = client.proxy.object_path
560
556
        self.clients_dict[path] = client
561
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
557
        self.clients.sort(None, lambda c: c.properties["Name"])
562
558
        self.refresh()
563
559
    
564
560
    def remove_client(self, client, path=None):
566
562
        if path is None:
567
563
            path = client.proxy.object_path
568
564
        del self.clients_dict[path]
 
565
        if not self.clients_dict:
 
566
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
567
            # is completely emptied, we need to recreate it.
 
568
            self.clients = urwid.SimpleListWalker([])
 
569
            self.rebuild()
569
570
        self.refresh()
570
571
    
571
572
    def refresh(self):
587
588
            if not mandos_clients:
588
589
                self.log_message_raw(("bold", "Note: Server has no clients."))
589
590
        except dbus.exceptions.DBusException:
590
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
 
591
            self.log_message_raw(("bold", "Note: No Mandos servers running."))
591
592
            mandos_clients = dbus.Dictionary()
592
593
        
593
594
        (self.mandos_serv
605
606
                            self.client_not_found,
606
607
                            dbus_interface=server_interface,
607
608
                            byte_arrays=True))
608
 
        for path, client in mandos_clients.items():
 
609
        for path, client in mandos_clients.iteritems():
609
610
            client_proxy_object = self.bus.get_object(self.busname,
610
611
                                                      path)
611
612
            self.add_client(MandosClientWidget(server_proxy_object
658
659
            elif key == "window resize":
659
660
                self.size = self.screen.get_cols_rows()
660
661
                self.refresh()
661
 
            elif key == "ctrl l":
662
 
                self.screen.clear()
 
662
            elif key == "\f":  # Ctrl-L
663
663
                self.refresh()
664
664
            elif key == "l" or key == "D":
665
665
                self.toggle_log_display()
677
677
                                            "?: Help",
678
678
                                            "l: Log window toggle",
679
679
                                            "TAB: Switch window",
680
 
                                            "w: Wrap (log lines)",
681
 
                                            "v: Toggle verbose log",
682
 
                                            ))))
 
680
                                            "w: Wrap (log)"))))
683
681
                self.log_message_raw(("bold",
684
682
                                      "  "
685
683
                                      .join(("Clients:",
698
696
                else:
699
697
                    self.topwidget.set_focus(self.logbox)
700
698
                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
699
            #elif (key == "end" or key == "meta >" or key == "G"
709
700
            #      or key == ">"):
710
701
            #    pass            # xxx end-of-buffer
733
724
    ui.run()
734
725
except KeyboardInterrupt:
735
726
    ui.screen.stop()
736
 
except Exception as e:
737
 
    ui.log_message(str(e))
 
727
except Exception, e:
 
728
    ui.log_message(unicode(e))
738
729
    ui.screen.stop()
739
730
    raise