/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-05 10:52:11 UTC
  • Revision ID: teddy@recompile.se-20120505105211-58z3hyjfzep3z2q9
* mandos: White space and other misc. format fixes only.

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