/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 20:46:51 UTC
  • Revision ID: teddy@recompile.se-20120507204651-qx5o5ztwmau54mh4
* mandos-monitor: Speedup: Use properties from D-Bus
                  GetAllClientsWithProperties() call.  Also use
                  super() properly - only use keyword arguments and
                  strip them off as "kwargs" is passed on.
  (MandosClientPropertyCache.__init__): Take new "properties"
                                        argument; use it to skip
                                        calling D-Bus GetAll() method.
                                        Call super().  Bind self._
  (MandosClientPropertyCache._property_changed): New helper function.
  (MandosClientPropertyCache.property_changed): Changed to take
                                                keyword arguments.
  (MandosClientPropertyCache.delete): Bug fix: Don't call
                                      super().__init__().
  (MandosClientWidget.__init__): Don't take *args.  Strip used keyword
                                 arguments before calling super().
  (MandosClientWidget.property_changed): Removed dead code.
  (MandosClientWidget.delete): Don't take *args.
  (MandosClientWidget.property_changed): Don't take "value" argument,
                                         since it is not used.
  (ConstrainedListBox.keypress): Take *args, **kwargs and pass them on
                                 to super().

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.8"
 
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()"
131
134
        self.logger = logger
132
135
        
133
136
        self._update_timer_callback_tag = None
 
137
        self._update_timer_callback_lock = 0
134
138
        
135
139
        # The widget shown normally
136
140
        self._text_widget = urwid.Text("")
140
144
        self.update()
141
145
        self.opened = False
142
146
        
 
147
        last_checked_ok = isoformat_to_datetime(self.properties
 
148
                                                ["LastCheckedOK"])
 
149
        
 
150
        if self.properties ["LastCheckerStatus"] != 0:
 
151
            self.using_timer(True)
 
152
        
 
153
        if self.need_approval:
 
154
            self.using_timer(True)
 
155
        
143
156
        self.match_objects = (
144
157
            self.proxy.connect_to_signal("CheckerCompleted",
145
158
                                         self.checker_completed,
161
174
                                         self.rejected,
162
175
                                         client_interface,
163
176
                                         byte_arrays=True))
164
 
        self.logger('Created client {}'
165
 
                    .format(self.properties["Name"]), level=0)
 
177
        #self.logger('Created client {0}'
 
178
        #            .format(self.properties["Name"]))
 
179
    
 
180
    def property_changed(self, property=None, value=None):
 
181
        super(self, MandosClientWidget).property_changed(property,
 
182
                                                         value)
 
183
        if property == "ApprovalPending":
 
184
            using_timer(bool(value))
 
185
        if property == "LastCheckerStatus":
 
186
            using_timer(value != 0)
 
187
            #self.logger('Checker for client {0} (command "{1}") was '
 
188
            #            ' successful'.format(self.properties["Name"],
 
189
            #                                 command))
166
190
    
167
191
    def using_timer(self, flag):
168
192
        """Call this method with True or False when timer should be
169
193
        activated or deactivated.
170
194
        """
171
 
        if flag and self._update_timer_callback_tag is None:
 
195
        old = self._update_timer_callback_lock
 
196
        if flag:
 
197
            self._update_timer_callback_lock += 1
 
198
        else:
 
199
            self._update_timer_callback_lock -= 1
 
200
        if old == 0 and self._update_timer_callback_lock:
172
201
            # Will update the shown timer value every second
173
202
            self._update_timer_callback_tag = (gobject.timeout_add
174
203
                                               (1000,
175
204
                                                self.update_timer))
176
 
        elif not (flag or self._update_timer_callback_tag is None):
 
205
        elif old and self._update_timer_callback_lock == 0:
177
206
            gobject.source_remove(self._update_timer_callback_tag)
178
207
            self._update_timer_callback_tag = None
179
208
    
180
209
    def checker_completed(self, exitstatus, condition, command):
181
210
        if exitstatus == 0:
182
 
            self.logger('Checker for client {} (command "{}")'
183
 
                        ' succeeded'.format(self.properties["Name"],
184
 
                                            command), level=0)
185
211
            self.update()
186
212
            return
187
213
        # Checker failed
188
214
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {} (command "{}") failed'
190
 
                        ' with exit code {}'
 
215
            self.logger('Checker for client {0} (command "{1}")'
 
216
                        ' failed with exit code {2}'
191
217
                        .format(self.properties["Name"], command,
192
218
                                os.WEXITSTATUS(condition)))
193
219
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {} (command "{}") was'
195
 
                        ' killed by signal {}'
 
220
            self.logger('Checker for client {0} (command "{1}") was'
 
221
                        ' killed by signal {2}'
196
222
                        .format(self.properties["Name"], command,
197
223
                                os.WTERMSIG(condition)))
198
224
        elif os.WCOREDUMP(condition):
199
 
            self.logger('Checker for client {} (command "{}") dumped'
200
 
                        ' core'.format(self.properties["Name"],
201
 
                                       command))
 
225
            self.logger('Checker for client {0} (command "{1}")'
 
226
                        ' dumped core'
 
227
                        .format(self.properties["Name"], command))
202
228
        else:
203
 
            self.logger('Checker for client {} completed'
 
229
            self.logger('Checker for client {0} completed'
204
230
                        ' mysteriously'
205
231
                        .format(self.properties["Name"]))
206
232
        self.update()
207
233
    
208
234
    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)
 
235
        """Server signals that a checker started. This could be useful
 
236
           to log in the future. """
 
237
        #self.logger('Client {0} started checker "{1}"'
 
238
        #            .format(self.properties["Name"],
 
239
        #                    unicode(command)))
 
240
        pass
213
241
    
214
242
    def got_secret(self):
215
 
        self.logger('Client {} received its secret'
 
243
        self.logger('Client {0} received its secret'
216
244
                    .format(self.properties["Name"]))
217
245
    
218
246
    def need_approval(self, timeout, default):
219
247
        if not default:
220
 
            message = 'Client {} needs approval within {} seconds'
 
248
            message = 'Client {0} needs approval within {1} seconds'
221
249
        else:
222
 
            message = 'Client {} will get its secret in {} seconds'
 
250
            message = 'Client {0} will get its secret in {1} seconds'
223
251
        self.logger(message.format(self.properties["Name"],
224
252
                                   timeout/1000))
 
253
        self.using_timer(True)
225
254
    
226
255
    def rejected(self, reason):
227
 
        self.logger('Client {} was rejected; reason: {}'
 
256
        self.logger('Client {0} was rejected; reason: {1}'
228
257
                    .format(self.properties["Name"], reason))
229
258
    
230
259
    def selectable(self):
253
282
                          "bold-underline-blink":
254
283
                              "bold-underline-blink-standout",
255
284
                          }
256
 
        
 
285
 
257
286
        # Rebuild focus and non-focus widgets using current properties
258
 
        
 
287
 
259
288
        # Base part of a client. Name!
260
289
        base = '{name}: '.format(name=self.properties["Name"])
261
290
        if not self.properties["Enabled"]:
262
291
            message = "DISABLED"
263
 
            self.using_timer(False)
264
292
        elif self.properties["ApprovalPending"]:
265
293
            timeout = datetime.timedelta(milliseconds
266
294
                                         = self.properties
268
296
            last_approval_request = isoformat_to_datetime(
269
297
                self.properties["LastApprovalRequest"])
270
298
            if last_approval_request is not None:
271
 
                timer = max(timeout - (datetime.datetime.utcnow()
272
 
                                       - last_approval_request),
273
 
                            datetime.timedelta())
 
299
                timer = timeout - (datetime.datetime.utcnow()
 
300
                                   - last_approval_request)
274
301
            else:
275
302
                timer = datetime.timedelta()
276
303
            if self.properties["ApprovedByDefault"]:
277
 
                message = "Approval in {}. (d)eny?"
 
304
                message = "Approval in {0}. (d)eny?"
278
305
            else:
279
 
                message = "Denial in {}. (a)pprove?"
280
 
            message = message.format(str(timer).rsplit(".", 1)[0])
281
 
            self.using_timer(True)
 
306
                message = "Denial in {0}. (a)pprove?"
 
307
            message = message.format(unicode(timer).rsplit(".", 1)[0])
282
308
        elif self.properties["LastCheckerStatus"] != 0:
283
309
            # When checker has failed, show timer until client expires
284
310
            expires = self.properties["Expires"]
287
313
            else:
288
314
                expires = (datetime.datetime.strptime
289
315
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
290
 
                timer = max(expires - datetime.datetime.utcnow(),
291
 
                            datetime.timedelta())
 
316
                timer = expires - datetime.datetime.utcnow()
292
317
            message = ('A checker has failed! Time until client'
293
 
                       ' gets disabled: {}'
294
 
                       .format(str(timer).rsplit(".", 1)[0]))
295
 
            self.using_timer(True)
 
318
                       ' gets disabled: {0}'
 
319
                       .format(unicode(timer).rsplit(".", 1)[0]))
296
320
        else:
297
321
            message = "enabled"
298
 
            self.using_timer(False)
299
 
        self._text = "{}{}".format(base, message)
300
 
        
 
322
        self._text = "{0}{1}".format(base, message)
 
323
            
301
324
        if not urwid.supports_unicode():
302
325
            self._text = self._text.encode("ascii", "replace")
303
326
        textlist = [("normal", self._text)]
380
403
    def property_changed(self, property=None, **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
409
            property=property, **kwargs)
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
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