/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-05-07 19:13:15 UTC
  • Revision ID: teddy@recompile.se-20120507191315-tbe55n4u1uq3l7ft
* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

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.5.3"
 
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()"
83
86
    properties and calls a hook function when any of them are
84
87
    changed.
85
88
    """
86
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
89
    def __init__(self, proxy_object=None, *args, **kwargs):
87
90
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        self.properties = dict() if properties is None else properties
 
91
        
 
92
        self.properties = dict()
89
93
        self.property_changed_match = (
90
 
            self.proxy.connect_to_signal("PropertiesChanged",
91
 
                                         self.properties_changed,
92
 
                                         dbus.PROPERTIES_IFACE,
 
94
            self.proxy.connect_to_signal("PropertyChanged",
 
95
                                         self.property_changed,
 
96
                                         client_interface,
93
97
                                         byte_arrays=True))
94
98
        
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)
 
99
        self.properties.update(
 
100
            self.proxy.GetAll(client_interface,
 
101
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
102
 
 
103
        #XXX This breaks good super behaviour
 
104
#        super(MandosClientPropertyCache, self).__init__(
 
105
#            *args, **kwargs)
102
106
    
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
    def property_changed(self, property=None, value=None):
 
108
        """This is called whenever we get a PropertyChanged signal
 
109
        It updates the changed property in the "properties" dict.
106
110
        """
107
111
        # Update properties dict with new value
108
 
        self.properties.update(properties)
 
112
        self.properties[property] = value
109
113
    
110
 
    def delete(self):
 
114
    def delete(self, *args, **kwargs):
111
115
        self.property_changed_match.remove()
 
116
        super(MandosClientPropertyCache, self).__init__(
 
117
            *args, **kwargs)
112
118
 
113
119
 
114
120
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
116
122
    """
117
123
    
118
124
    def __init__(self, server_proxy_object=None, update_hook=None,
119
 
                 delete_hook=None, logger=None, **kwargs):
 
125
                 delete_hook=None, logger=None, *args, **kwargs):
120
126
        # Called on update
121
127
        self.update_hook = update_hook
122
128
        # Called on delete
127
133
        self.logger = logger
128
134
        
129
135
        self._update_timer_callback_tag = None
 
136
        self._update_timer_callback_lock = 0
130
137
        
131
138
        # The widget shown normally
132
139
        self._text_widget = urwid.Text("")
133
140
        # The widget shown when we have focus
134
141
        self._focus_text_widget = urwid.Text("")
135
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
142
        super(MandosClientWidget, self).__init__(
 
143
            update_hook=update_hook, delete_hook=delete_hook,
 
144
            *args, **kwargs)
136
145
        self.update()
137
146
        self.opened = False
138
147
        
 
148
        last_checked_ok = isoformat_to_datetime(self.properties
 
149
                                                ["LastCheckedOK"])
 
150
        
 
151
        if self.properties ["LastCheckerStatus"] != 0:
 
152
            self.using_timer(True)
 
153
        
 
154
        if self.need_approval:
 
155
            self.using_timer(True)
 
156
        
139
157
        self.match_objects = (
140
158
            self.proxy.connect_to_signal("CheckerCompleted",
141
159
                                         self.checker_completed,
157
175
                                         self.rejected,
158
176
                                         client_interface,
159
177
                                         byte_arrays=True))
160
 
        self.logger('Created client {}'
161
 
                    .format(self.properties["Name"]), level=0)
 
178
        #self.logger('Created client {0}'
 
179
        #            .format(self.properties["Name"]))
 
180
    
 
181
    def property_changed(self, property=None, value=None):
 
182
        super(self, MandosClientWidget).property_changed(property,
 
183
                                                         value)
 
184
        if property == "ApprovalPending":
 
185
            using_timer(bool(value))
 
186
        if property == "LastCheckerStatus":
 
187
            using_timer(value != 0)
 
188
            #self.logger('Checker for client {0} (command "{1}") was '
 
189
            #            ' successful'.format(self.properties["Name"],
 
190
            #                                 command))
162
191
    
163
192
    def using_timer(self, flag):
164
193
        """Call this method with True or False when timer should be
165
194
        activated or deactivated.
166
195
        """
167
 
        if flag and self._update_timer_callback_tag is None:
 
196
        old = self._update_timer_callback_lock
 
197
        if flag:
 
198
            self._update_timer_callback_lock += 1
 
199
        else:
 
200
            self._update_timer_callback_lock -= 1
 
201
        if old == 0 and self._update_timer_callback_lock:
168
202
            # Will update the shown timer value every second
169
203
            self._update_timer_callback_tag = (gobject.timeout_add
170
204
                                               (1000,
171
205
                                                self.update_timer))
172
 
        elif not (flag or self._update_timer_callback_tag is None):
 
206
        elif old and self._update_timer_callback_lock == 0:
173
207
            gobject.source_remove(self._update_timer_callback_tag)
174
208
            self._update_timer_callback_tag = None
175
209
    
176
210
    def checker_completed(self, exitstatus, condition, command):
177
211
        if exitstatus == 0:
178
 
            self.logger('Checker for client {} (command "{}")'
179
 
                        ' succeeded'.format(self.properties["Name"],
180
 
                                            command), level=0)
181
212
            self.update()
182
213
            return
183
214
        # Checker failed
184
215
        if os.WIFEXITED(condition):
185
 
            self.logger('Checker for client {} (command "{}") failed'
186
 
                        ' with exit code {}'
 
216
            self.logger('Checker for client {0} (command "{1}")'
 
217
                        ' failed with exit code {2}'
187
218
                        .format(self.properties["Name"], command,
188
219
                                os.WEXITSTATUS(condition)))
189
220
        elif os.WIFSIGNALED(condition):
190
 
            self.logger('Checker for client {} (command "{}") was'
191
 
                        ' killed by signal {}'
 
221
            self.logger('Checker for client {0} (command "{1}") was'
 
222
                        ' killed by signal {2}'
192
223
                        .format(self.properties["Name"], command,
193
224
                                os.WTERMSIG(condition)))
194
225
        elif os.WCOREDUMP(condition):
195
 
            self.logger('Checker for client {} (command "{}") dumped'
196
 
                        ' core'.format(self.properties["Name"],
197
 
                                       command))
 
226
            self.logger('Checker for client {0} (command "{1}")'
 
227
                        ' dumped core'
 
228
                        .format(self.properties["Name"], command))
198
229
        else:
199
 
            self.logger('Checker for client {} completed'
 
230
            self.logger('Checker for client {0} completed'
200
231
                        ' mysteriously'
201
232
                        .format(self.properties["Name"]))
202
233
        self.update()
203
234
    
204
235
    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)
 
236
        """Server signals that a checker started. This could be useful
 
237
           to log in the future. """
 
238
        #self.logger('Client {0} started checker "{1}"'
 
239
        #            .format(self.properties["Name"],
 
240
        #                    unicode(command)))
 
241
        pass
209
242
    
210
243
    def got_secret(self):
211
 
        self.logger('Client {} received its secret'
 
244
        self.logger('Client {0} received its secret'
212
245
                    .format(self.properties["Name"]))
213
246
    
214
247
    def need_approval(self, timeout, default):
215
248
        if not default:
216
 
            message = 'Client {} needs approval within {} seconds'
 
249
            message = 'Client {0} needs approval within {1} seconds'
217
250
        else:
218
 
            message = 'Client {} will get its secret in {} seconds'
 
251
            message = 'Client {0} will get its secret in {1} seconds'
219
252
        self.logger(message.format(self.properties["Name"],
220
253
                                   timeout/1000))
 
254
        self.using_timer(True)
221
255
    
222
256
    def rejected(self, reason):
223
 
        self.logger('Client {} was rejected; reason: {}'
 
257
        self.logger('Client {0} was rejected; reason: {1}'
224
258
                    .format(self.properties["Name"], reason))
225
259
    
226
260
    def selectable(self):
249
283
                          "bold-underline-blink":
250
284
                              "bold-underline-blink-standout",
251
285
                          }
252
 
        
 
286
 
253
287
        # Rebuild focus and non-focus widgets using current properties
254
 
        
 
288
 
255
289
        # Base part of a client. Name!
256
290
        base = '{name}: '.format(name=self.properties["Name"])
257
291
        if not self.properties["Enabled"]:
258
292
            message = "DISABLED"
259
 
            self.using_timer(False)
260
293
        elif self.properties["ApprovalPending"]:
261
294
            timeout = datetime.timedelta(milliseconds
262
295
                                         = self.properties
264
297
            last_approval_request = isoformat_to_datetime(
265
298
                self.properties["LastApprovalRequest"])
266
299
            if last_approval_request is not None:
267
 
                timer = max(timeout - (datetime.datetime.utcnow()
268
 
                                       - last_approval_request),
269
 
                            datetime.timedelta())
 
300
                timer = timeout - (datetime.datetime.utcnow()
 
301
                                   - last_approval_request)
270
302
            else:
271
303
                timer = datetime.timedelta()
272
304
            if self.properties["ApprovedByDefault"]:
273
 
                message = "Approval in {}. (d)eny?"
 
305
                message = "Approval in {0}. (d)eny?"
274
306
            else:
275
 
                message = "Denial in {}. (a)pprove?"
276
 
            message = message.format(str(timer).rsplit(".", 1)[0])
277
 
            self.using_timer(True)
 
307
                message = "Denial in {0}. (a)pprove?"
 
308
            message = message.format(unicode(timer).rsplit(".", 1)[0])
278
309
        elif self.properties["LastCheckerStatus"] != 0:
279
310
            # When checker has failed, show timer until client expires
280
311
            expires = self.properties["Expires"]
283
314
            else:
284
315
                expires = (datetime.datetime.strptime
285
316
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
286
 
                timer = max(expires - datetime.datetime.utcnow(),
287
 
                            datetime.timedelta())
 
317
                timer = expires - datetime.datetime.utcnow()
288
318
            message = ('A checker has failed! Time until client'
289
 
                       ' gets disabled: {}'
290
 
                       .format(str(timer).rsplit(".", 1)[0]))
291
 
            self.using_timer(True)
 
319
                       ' gets disabled: {0}'
 
320
                       .format(unicode(timer).rsplit(".", 1)[0]))
292
321
        else:
293
322
            message = "enabled"
294
 
            self.using_timer(False)
295
 
        self._text = "{}{}".format(base, message)
296
 
        
 
323
        self._text = "{0}{1}".format(base, message)
 
324
            
297
325
        if not urwid.supports_unicode():
298
326
            self._text = self._text.encode("ascii", "replace")
299
327
        textlist = [("normal", self._text)]
316
344
        self.update()
317
345
        return True             # Keep calling this
318
346
    
319
 
    def delete(self, **kwargs):
 
347
    def delete(self, *args, **kwargs):
320
348
        if self._update_timer_callback_tag is not None:
321
349
            gobject.source_remove(self._update_timer_callback_tag)
322
350
            self._update_timer_callback_tag = None
325
353
        self.match_objects = ()
326
354
        if self.delete_hook is not None:
327
355
            self.delete_hook(self)
328
 
        return super(MandosClientWidget, self).delete(**kwargs)
 
356
        return super(MandosClientWidget, self).delete(*args, **kwargs)
329
357
    
330
358
    def render(self, maxcolrow, focus=False):
331
359
        """Render differently if we have focus.
373
401
        else:
374
402
            return key
375
403
    
376
 
    def properties_changed(self, interface, properties, invalidated):
377
 
        """Call self.update() if any properties changed.
 
404
    def property_changed(self, property=None, value=None,
 
405
                         *args, **kwargs):
 
406
        """Call self.update() if old value is not new value.
378
407
        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):
 
408
        property_name = unicode(property)
 
409
        old_value = self.properties.get(property_name)
 
410
        super(MandosClientWidget, self).property_changed(
 
411
            property=property, value=value, *args, **kwargs)
 
412
        if self.properties.get(property_name) != old_value:
385
413
            self.update()
386
414
 
387
415
 
390
418
    "down" key presses, thus not allowing any containing widgets to
391
419
    use them as an excuse to shift focus away from this widget.
392
420
    """
393
 
    def keypress(self, *args, **kwargs):
394
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
421
    def keypress(self, maxcolrow, key):
 
422
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
395
423
        if ret in ("up", "down"):
396
424
            return
397
425
        return ret
401
429
    """This is the entire user interface - the whole screen
402
430
    with boxes, lists of client widgets, etc.
403
431
    """
404
 
    def __init__(self, max_log_length=1000, log_level=1):
 
432
    def __init__(self, max_log_length=1000):
405
433
        DBusGMainLoop(set_as_default=True)
406
434
        
407
435
        self.screen = urwid.curses_display.Screen()
410
438
                ("normal",
411
439
                 "default", "default", None),
412
440
                ("bold",
413
 
                 "bold", "default", "bold"),
 
441
                 "default", "default", "bold"),
414
442
                ("underline-blink",
415
 
                 "underline,blink", "default", "underline,blink"),
 
443
                 "default", "default", "underline"),
416
444
                ("standout",
417
 
                 "standout", "default", "standout"),
 
445
                 "default", "default", "standout"),
418
446
                ("bold-underline-blink",
419
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
447
                 "default", "default", ("bold", "underline")),
420
448
                ("bold-standout",
421
 
                 "bold,standout", "default", "bold,standout"),
 
449
                 "default", "default", ("bold", "standout")),
422
450
                ("underline-blink-standout",
423
 
                 "underline,blink,standout", "default",
424
 
                 "underline,blink,standout"),
 
451
                 "default", "default", ("underline", "standout")),
425
452
                ("bold-underline-blink-standout",
426
 
                 "bold,underline,blink,standout", "default",
427
 
                 "bold,underline,blink,standout"),
 
453
                 "default", "default", ("bold", "underline",
 
454
                                          "standout")),
428
455
                ))
429
456
        
430
457
        if urwid.supports_unicode():
445
472
        self.log = []
446
473
        self.max_log_length = max_log_length
447
474
        
448
 
        self.log_level = log_level
449
 
        
450
475
        # We keep a reference to the log widget so we can remove it
451
476
        # from the ListWalker without it getting destroyed
452
477
        self.logbox = ConstrainedListBox(self.log)
466
491
        self.main_loop = gobject.MainLoop()
467
492
    
468
493
    def client_not_found(self, fingerprint, address):
469
 
        self.log_message("Client with address {} and fingerprint {}"
470
 
                         " could not be found"
 
494
        self.log_message("Client with address {0} and fingerprint"
 
495
                         " {1} could not be found"
471
496
                         .format(address, fingerprint))
472
497
    
473
498
    def rebuild(self):
486
511
            self.uilist.append(self.logbox)
487
512
        self.topwidget = urwid.Pile(self.uilist)
488
513
    
489
 
    def log_message(self, message, level=1):
490
 
        """Log message formatted with timestamp"""
491
 
        if level < self.log_level:
492
 
            return
 
514
    def log_message(self, message):
493
515
        timestamp = datetime.datetime.now().isoformat()
494
 
        self.log_message_raw("{}: {}".format(timestamp, message),
495
 
                             level=level)
 
516
        self.log_message_raw(timestamp + ": " + message)
496
517
    
497
 
    def log_message_raw(self, markup, level=1):
 
518
    def log_message_raw(self, markup):
498
519
        """Add a log message to the log buffer."""
499
 
        if level < self.log_level:
500
 
            return
501
520
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
502
521
        if (self.max_log_length
503
522
            and len(self.log) > self.max_log_length):
510
529
        """Toggle visibility of the log buffer."""
511
530
        self.log_visible = not self.log_visible
512
531
        self.rebuild()
513
 
        self.log_message("Log visibility changed to: {}"
514
 
                         .format(self.log_visible), level=0)
 
532
        #self.log_message("Log visibility changed to: "
 
533
        #                 + unicode(self.log_visible))
515
534
    
516
535
    def change_log_display(self):
517
536
        """Change type of log display.
522
541
            self.log_wrap = "clip"
523
542
        for textwidget in self.log:
524
543
            textwidget.set_wrap_mode(self.log_wrap)
525
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
526
 
                         level=0)
 
544
        #self.log_message("Wrap mode: " + self.log_wrap)
527
545
    
528
546
    def find_and_remove_client(self, path, name):
529
547
        """Find a client by its object path and remove it.
534
552
            client = self.clients_dict[path]
535
553
        except KeyError:
536
554
            # not found?
537
 
            self.log_message("Unknown client {!r} ({!r}) removed"
 
555
            self.log_message("Unknown client {0!r} ({1!r}) removed"
538
556
                             .format(name, path))
539
557
            return
540
558
        client.delete()
558
576
        if path is None:
559
577
            path = client.proxy.object_path
560
578
        self.clients_dict[path] = client
561
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
579
        self.clients.sort(None, lambda c: c.properties["Name"])
562
580
        self.refresh()
563
581
    
564
582
    def remove_client(self, client, path=None):
566
584
        if path is None:
567
585
            path = client.proxy.object_path
568
586
        del self.clients_dict[path]
 
587
        if not self.clients_dict:
 
588
            # Work around bug in Urwid 0.9.8.3 - if a SimpleListWalker
 
589
            # is completely emptied, we need to recreate it.
 
590
            self.clients = urwid.SimpleListWalker([])
 
591
            self.rebuild()
569
592
        self.refresh()
570
593
    
571
594
    def refresh(self):
584
607
        try:
585
608
            mandos_clients = (self.mandos_serv
586
609
                              .GetAllClientsWithProperties())
587
 
            if not mandos_clients:
588
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
589
610
        except dbus.exceptions.DBusException:
590
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
591
611
            mandos_clients = dbus.Dictionary()
592
612
        
593
613
        (self.mandos_serv
605
625
                            self.client_not_found,
606
626
                            dbus_interface=server_interface,
607
627
                            byte_arrays=True))
608
 
        for path, client in mandos_clients.items():
 
628
        for path, client in mandos_clients.iteritems():
609
629
            client_proxy_object = self.bus.get_object(self.busname,
610
630
                                                      path)
611
631
            self.add_client(MandosClientWidget(server_proxy_object
620
640
                                               logger
621
641
                                               =self.log_message),
622
642
                            path=path)
623
 
        
 
643
 
624
644
        self.refresh()
625
645
        self._input_callback_tag = (gobject.io_add_watch
626
646
                                    (sys.stdin.fileno(),
658
678
            elif key == "window resize":
659
679
                self.size = self.screen.get_cols_rows()
660
680
                self.refresh()
661
 
            elif key == "ctrl l":
662
 
                self.screen.clear()
 
681
            elif key == "\f":  # Ctrl-L
663
682
                self.refresh()
664
683
            elif key == "l" or key == "D":
665
684
                self.toggle_log_display()
677
696
                                            "?: Help",
678
697
                                            "l: Log window toggle",
679
698
                                            "TAB: Switch window",
680
 
                                            "w: Wrap (log lines)",
681
 
                                            "v: Toggle verbose log",
682
 
                                            ))))
 
699
                                            "w: Wrap (log)"))))
683
700
                self.log_message_raw(("bold",
684
701
                                      "  "
685
702
                                      .join(("Clients:",
698
715
                else:
699
716
                    self.topwidget.set_focus(self.logbox)
700
717
                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
718
            #elif (key == "end" or key == "meta >" or key == "G"
709
719
            #      or key == ">"):
710
720
            #    pass            # xxx end-of-buffer
733
743
    ui.run()
734
744
except KeyboardInterrupt:
735
745
    ui.screen.stop()
736
 
except Exception as e:
737
 
    ui.log_message(str(e))
 
746
except Exception, e:
 
747
    ui.log_message(unicode(e))
738
748
    ui.screen.stop()
739
749
    raise