/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-06 17:23:08 UTC
  • Revision ID: teddy@recompile.se-20120506172308-xw7368koksmjmnv3
* mandos (Client.start_checker): Reworded comment.
 (MandosServer.handle_ipc): Removed dead code.

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.7"
 
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
92
            self.proxy.connect_to_signal("PropertyChanged",
91
 
                                         self._property_changed,
 
93
                                         self.property_changed,
92
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)
102
 
    
103
 
    def _property_changed(self, property, value):
104
 
        """Helper which takes positional arguments"""
105
 
        return self.property_changed(property=property, value=value)
 
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)
106
104
    
107
105
    def property_changed(self, property=None, value=None):
108
106
        """This is called whenever we get a PropertyChanged signal
111
109
        # Update properties dict with new value
112
110
        self.properties[property] = value
113
111
    
114
 
    def delete(self):
 
112
    def delete(self, *args, **kwargs):
115
113
        self.property_changed_match.remove()
 
114
        super(MandosClientPropertyCache, self).__init__(
 
115
            *args, **kwargs)
116
116
 
117
117
 
118
118
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
120
120
    """
121
121
    
122
122
    def __init__(self, server_proxy_object=None, update_hook=None,
123
 
                 delete_hook=None, logger=None, **kwargs):
 
123
                 delete_hook=None, logger=None, *args, **kwargs):
124
124
        # Called on update
125
125
        self.update_hook = update_hook
126
126
        # Called on delete
131
131
        self.logger = logger
132
132
        
133
133
        self._update_timer_callback_tag = None
 
134
        self._update_timer_callback_lock = 0
134
135
        
135
136
        # The widget shown normally
136
137
        self._text_widget = urwid.Text("")
137
138
        # The widget shown when we have focus
138
139
        self._focus_text_widget = urwid.Text("")
139
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
140
        super(MandosClientWidget, self).__init__(
 
141
            update_hook=update_hook, delete_hook=delete_hook,
 
142
            *args, **kwargs)
140
143
        self.update()
141
144
        self.opened = False
142
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
        
143
155
        self.match_objects = (
144
156
            self.proxy.connect_to_signal("CheckerCompleted",
145
157
                                         self.checker_completed,
161
173
                                         self.rejected,
162
174
                                         client_interface,
163
175
                                         byte_arrays=True))
164
 
        self.logger('Created client {}'
165
 
                    .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))
166
189
    
167
190
    def using_timer(self, flag):
168
191
        """Call this method with True or False when timer should be
169
192
        activated or deactivated.
170
193
        """
171
 
        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:
172
200
            # Will update the shown timer value every second
173
201
            self._update_timer_callback_tag = (gobject.timeout_add
174
202
                                               (1000,
175
203
                                                self.update_timer))
176
 
        elif not (flag or self._update_timer_callback_tag is None):
 
204
        elif old and self._update_timer_callback_lock == 0:
177
205
            gobject.source_remove(self._update_timer_callback_tag)
178
206
            self._update_timer_callback_tag = None
179
207
    
180
208
    def checker_completed(self, exitstatus, condition, command):
181
209
        if exitstatus == 0:
182
 
            self.logger('Checker for client {} (command "{}")'
183
 
                        ' succeeded'.format(self.properties["Name"],
184
 
                                            command), level=0)
185
210
            self.update()
186
211
            return
187
212
        # Checker failed
188
213
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {} (command "{}") failed'
190
 
                        ' with exit code {}'
 
214
            self.logger('Checker for client {0} (command "{1}")'
 
215
                        ' failed with exit code {2}'
191
216
                        .format(self.properties["Name"], command,
192
217
                                os.WEXITSTATUS(condition)))
193
218
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {} (command "{}") was'
195
 
                        ' killed by signal {}'
 
219
            self.logger('Checker for client {0} (command "{1}") was'
 
220
                        ' killed by signal {2}'
196
221
                        .format(self.properties["Name"], command,
197
222
                                os.WTERMSIG(condition)))
198
223
        elif os.WCOREDUMP(condition):
199
 
            self.logger('Checker for client {} (command "{}") dumped'
200
 
                        ' core'.format(self.properties["Name"],
201
 
                                       command))
 
224
            self.logger('Checker for client {0} (command "{1}")'
 
225
                        ' dumped core'
 
226
                        .format(self.properties["Name"], command))
202
227
        else:
203
 
            self.logger('Checker for client {} completed'
 
228
            self.logger('Checker for client {0} completed'
204
229
                        ' mysteriously'
205
230
                        .format(self.properties["Name"]))
206
231
        self.update()
207
232
    
208
233
    def checker_started(self, command):
209
 
        """Server signals that a checker started."""
210
 
        self.logger('Client {} started checker "{}"'
211
 
                    .format(self.properties["Name"],
212
 
                            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
213
240
    
214
241
    def got_secret(self):
215
 
        self.logger('Client {} received its secret'
 
242
        self.logger('Client {0} received its secret'
216
243
                    .format(self.properties["Name"]))
217
244
    
218
245
    def need_approval(self, timeout, default):
219
246
        if not default:
220
 
            message = 'Client {} needs approval within {} seconds'
 
247
            message = 'Client {0} needs approval within {1} seconds'
221
248
        else:
222
 
            message = 'Client {} will get its secret in {} seconds'
 
249
            message = 'Client {0} will get its secret in {1} seconds'
223
250
        self.logger(message.format(self.properties["Name"],
224
251
                                   timeout/1000))
 
252
        self.using_timer(True)
225
253
    
226
254
    def rejected(self, reason):
227
 
        self.logger('Client {} was rejected; reason: {}'
 
255
        self.logger('Client {0} was rejected; reason: {1}'
228
256
                    .format(self.properties["Name"], reason))
229
257
    
230
258
    def selectable(self):
253
281
                          "bold-underline-blink":
254
282
                              "bold-underline-blink-standout",
255
283
                          }
256
 
        
 
284
 
257
285
        # Rebuild focus and non-focus widgets using current properties
258
 
        
 
286
 
259
287
        # Base part of a client. Name!
260
288
        base = '{name}: '.format(name=self.properties["Name"])
261
289
        if not self.properties["Enabled"]:
262
290
            message = "DISABLED"
263
 
            self.using_timer(False)
264
291
        elif self.properties["ApprovalPending"]:
265
292
            timeout = datetime.timedelta(milliseconds
266
293
                                         = self.properties
268
295
            last_approval_request = isoformat_to_datetime(
269
296
                self.properties["LastApprovalRequest"])
270
297
            if last_approval_request is not None:
271
 
                timer = max(timeout - (datetime.datetime.utcnow()
272
 
                                       - last_approval_request),
273
 
                            datetime.timedelta())
 
298
                timer = timeout - (datetime.datetime.utcnow()
 
299
                                   - last_approval_request)
274
300
            else:
275
301
                timer = datetime.timedelta()
276
302
            if self.properties["ApprovedByDefault"]:
277
 
                message = "Approval in {}. (d)eny?"
 
303
                message = "Approval in {0}. (d)eny?"
278
304
            else:
279
 
                message = "Denial in {}. (a)pprove?"
280
 
            message = message.format(str(timer).rsplit(".", 1)[0])
281
 
            self.using_timer(True)
 
305
                message = "Denial in {0}. (a)pprove?"
 
306
            message = message.format(unicode(timer).rsplit(".", 1)[0])
282
307
        elif self.properties["LastCheckerStatus"] != 0:
283
308
            # When checker has failed, show timer until client expires
284
309
            expires = self.properties["Expires"]
287
312
            else:
288
313
                expires = (datetime.datetime.strptime
289
314
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
290
 
                timer = max(expires - datetime.datetime.utcnow(),
291
 
                            datetime.timedelta())
 
315
                timer = expires - datetime.datetime.utcnow()
292
316
            message = ('A checker has failed! Time until client'
293
 
                       ' gets disabled: {}'
294
 
                       .format(str(timer).rsplit(".", 1)[0]))
295
 
            self.using_timer(True)
 
317
                       ' gets disabled: {0}'
 
318
                       .format(unicode(timer).rsplit(".", 1)[0]))
296
319
        else:
297
320
            message = "enabled"
298
 
            self.using_timer(False)
299
 
        self._text = "{}{}".format(base, message)
300
 
        
 
321
        self._text = "{0}{1}".format(base, message)
 
322
            
301
323
        if not urwid.supports_unicode():
302
324
            self._text = self._text.encode("ascii", "replace")
303
325
        textlist = [("normal", self._text)]
320
342
        self.update()
321
343
        return True             # Keep calling this
322
344
    
323
 
    def delete(self, **kwargs):
 
345
    def delete(self, *args, **kwargs):
324
346
        if self._update_timer_callback_tag is not None:
325
347
            gobject.source_remove(self._update_timer_callback_tag)
326
348
            self._update_timer_callback_tag = None
329
351
        self.match_objects = ()
330
352
        if self.delete_hook is not None:
331
353
            self.delete_hook(self)
332
 
        return super(MandosClientWidget, self).delete(**kwargs)
 
354
        return super(MandosClientWidget, self).delete(*args, **kwargs)
333
355
    
334
356
    def render(self, maxcolrow, focus=False):
335
357
        """Render differently if we have focus.
377
399
        else:
378
400
            return key
379
401
    
380
 
    def property_changed(self, property=None, **kwargs):
 
402
    def property_changed(self, property=None, value=None,
 
403
                         *args, **kwargs):
381
404
        """Call self.update() if old value is not new value.
382
405
        This overrides the method from MandosClientPropertyCache"""
383
 
        property_name = str(property)
 
406
        property_name = unicode(property)
384
407
        old_value = self.properties.get(property_name)
385
408
        super(MandosClientWidget, self).property_changed(
386
 
            property=property, **kwargs)
 
409
            property=property, value=value, *args, **kwargs)
387
410
        if self.properties.get(property_name) != old_value:
388
411
            self.update()
389
412
 
393
416
    "down" key presses, thus not allowing any containing widgets to
394
417
    use them as an excuse to shift focus away from this widget.
395
418
    """
396
 
    def keypress(self, *args, **kwargs):
397
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
419
    def keypress(self, maxcolrow, key):
 
420
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
398
421
        if ret in ("up", "down"):
399
422
            return
400
423
        return ret
404
427
    """This is the entire user interface - the whole screen
405
428
    with boxes, lists of client widgets, etc.
406
429
    """
407
 
    def __init__(self, max_log_length=1000, log_level=1):
 
430
    def __init__(self, max_log_length=1000):
408
431
        DBusGMainLoop(set_as_default=True)
409
432
        
410
433
        self.screen = urwid.curses_display.Screen()
413
436
                ("normal",
414
437
                 "default", "default", None),
415
438
                ("bold",
416
 
                 "bold", "default", "bold"),
 
439
                 "default", "default", "bold"),
417
440
                ("underline-blink",
418
 
                 "underline,blink", "default", "underline,blink"),
 
441
                 "default", "default", "underline"),
419
442
                ("standout",
420
 
                 "standout", "default", "standout"),
 
443
                 "default", "default", "standout"),
421
444
                ("bold-underline-blink",
422
 
                 "bold,underline,blink", "default", "bold,underline,blink"),
 
445
                 "default", "default", ("bold", "underline")),
423
446
                ("bold-standout",
424
 
                 "bold,standout", "default", "bold,standout"),
 
447
                 "default", "default", ("bold", "standout")),
425
448
                ("underline-blink-standout",
426
 
                 "underline,blink,standout", "default",
427
 
                 "underline,blink,standout"),
 
449
                 "default", "default", ("underline", "standout")),
428
450
                ("bold-underline-blink-standout",
429
 
                 "bold,underline,blink,standout", "default",
430
 
                 "bold,underline,blink,standout"),
 
451
                 "default", "default", ("bold", "underline",
 
452
                                          "standout")),
431
453
                ))
432
454
        
433
455
        if urwid.supports_unicode():
448
470
        self.log = []
449
471
        self.max_log_length = max_log_length
450
472
        
451
 
        self.log_level = log_level
452
 
        
453
473
        # We keep a reference to the log widget so we can remove it
454
474
        # from the ListWalker without it getting destroyed
455
475
        self.logbox = ConstrainedListBox(self.log)
469
489
        self.main_loop = gobject.MainLoop()
470
490
    
471
491
    def client_not_found(self, fingerprint, address):
472
 
        self.log_message("Client with address {} and fingerprint {}"
473
 
                         " could not be found"
 
492
        self.log_message("Client with address {0} and fingerprint"
 
493
                         " {1} could not be found"
474
494
                         .format(address, fingerprint))
475
495
    
476
496
    def rebuild(self):
489
509
            self.uilist.append(self.logbox)
490
510
        self.topwidget = urwid.Pile(self.uilist)
491
511
    
492
 
    def log_message(self, message, level=1):
493
 
        """Log message formatted with timestamp"""
494
 
        if level < self.log_level:
495
 
            return
 
512
    def log_message(self, message):
496
513
        timestamp = datetime.datetime.now().isoformat()
497
 
        self.log_message_raw("{}: {}".format(timestamp, message),
498
 
                             level=level)
 
514
        self.log_message_raw(timestamp + ": " + message)
499
515
    
500
 
    def log_message_raw(self, markup, level=1):
 
516
    def log_message_raw(self, markup):
501
517
        """Add a log message to the log buffer."""
502
 
        if level < self.log_level:
503
 
            return
504
518
        self.log.append(urwid.Text(markup, wrap=self.log_wrap))
505
519
        if (self.max_log_length
506
520
            and len(self.log) > self.max_log_length):
513
527
        """Toggle visibility of the log buffer."""
514
528
        self.log_visible = not self.log_visible
515
529
        self.rebuild()
516
 
        self.log_message("Log visibility changed to: {}"
517
 
                         .format(self.log_visible), level=0)
 
530
        #self.log_message("Log visibility changed to: "
 
531
        #                 + unicode(self.log_visible))
518
532
    
519
533
    def change_log_display(self):
520
534
        """Change type of log display.
525
539
            self.log_wrap = "clip"
526
540
        for textwidget in self.log:
527
541
            textwidget.set_wrap_mode(self.log_wrap)
528
 
        self.log_message("Wrap mode: {}".format(self.log_wrap),
529
 
                         level=0)
 
542
        #self.log_message("Wrap mode: " + self.log_wrap)
530
543
    
531
544
    def find_and_remove_client(self, path, name):
532
545
        """Find a client by its object path and remove it.
537
550
            client = self.clients_dict[path]
538
551
        except KeyError:
539
552
            # not found?
540
 
            self.log_message("Unknown client {!r} ({!r}) removed"
 
553
            self.log_message("Unknown client {0!r} ({1!r}) removed"
541
554
                             .format(name, path))
542
555
            return
543
556
        client.delete()
561
574
        if path is None:
562
575
            path = client.proxy.object_path
563
576
        self.clients_dict[path] = client
564
 
        self.clients.sort(key=lambda c: c.properties["Name"])
 
577
        self.clients.sort(None, lambda c: c.properties["Name"])
565
578
        self.refresh()
566
579
    
567
580
    def remove_client(self, client, path=None):
569
582
        if path is None:
570
583
            path = client.proxy.object_path
571
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()
572
590
        self.refresh()
573
591
    
574
592
    def refresh(self):
587
605
        try:
588
606
            mandos_clients = (self.mandos_serv
589
607
                              .GetAllClientsWithProperties())
590
 
            if not mandos_clients:
591
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
592
608
        except dbus.exceptions.DBusException:
593
 
            self.log_message_raw(("bold", "Note: No Mandos server running."))
594
609
            mandos_clients = dbus.Dictionary()
595
610
        
596
611
        (self.mandos_serv
608
623
                            self.client_not_found,
609
624
                            dbus_interface=server_interface,
610
625
                            byte_arrays=True))
611
 
        for path, client in mandos_clients.items():
 
626
        for path, client in mandos_clients.iteritems():
612
627
            client_proxy_object = self.bus.get_object(self.busname,
613
628
                                                      path)
614
629
            self.add_client(MandosClientWidget(server_proxy_object
623
638
                                               logger
624
639
                                               =self.log_message),
625
640
                            path=path)
626
 
        
 
641
 
627
642
        self.refresh()
628
643
        self._input_callback_tag = (gobject.io_add_watch
629
644
                                    (sys.stdin.fileno(),
661
676
            elif key == "window resize":
662
677
                self.size = self.screen.get_cols_rows()
663
678
                self.refresh()
664
 
            elif key == "ctrl l":
665
 
                self.screen.clear()
 
679
            elif key == "\f":  # Ctrl-L
666
680
                self.refresh()
667
681
            elif key == "l" or key == "D":
668
682
                self.toggle_log_display()
680
694
                                            "?: Help",
681
695
                                            "l: Log window toggle",
682
696
                                            "TAB: Switch window",
683
 
                                            "w: Wrap (log lines)",
684
 
                                            "v: Toggle verbose log",
685
 
                                            ))))
 
697
                                            "w: Wrap (log)"))))
686
698
                self.log_message_raw(("bold",
687
699
                                      "  "
688
700
                                      .join(("Clients:",
701
713
                else:
702
714
                    self.topwidget.set_focus(self.logbox)
703
715
                self.refresh()
704
 
            elif key == "v":
705
 
                if self.log_level == 0:
706
 
                    self.log_level = 1
707
 
                    self.log_message("Verbose mode: Off")
708
 
                else:
709
 
                    self.log_level = 0
710
 
                    self.log_message("Verbose mode: On")
711
716
            #elif (key == "end" or key == "meta >" or key == "G"
712
717
            #      or key == ">"):
713
718
            #    pass            # xxx end-of-buffer
736
741
    ui.run()
737
742
except KeyboardInterrupt:
738
743
    ui.screen.stop()
739
 
except Exception as e:
740
 
    ui.log_message(str(e))
 
744
except Exception, e:
 
745
    ui.log_message(unicode(e))
741
746
    ui.screen.stop()
742
747
    raise