/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-monitor

* 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-2011 Teddy Hogeborn
7
 
# Copyright © 2009-2011 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
17
17
#     GNU General Public License for more details.
18
18
# 
19
19
# You should have received a copy of the GNU General Public License
20
 
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see
 
21
# <http://www.gnu.org/licenses/>.
21
22
# 
22
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# Contact the authors at <mandos@recompile.se>.
23
24
# 
24
25
 
25
26
from __future__ import (division, absolute_import, print_function,
26
27
                        unicode_literals)
27
28
 
 
29
from future_builtins import *
 
30
 
28
31
import sys
29
32
import os
30
33
import signal
49
52
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
50
53
 
51
54
# Some useful constants
52
 
domain = 'se.bsnet.fukt'
 
55
domain = 'se.recompile'
53
56
server_interface = domain + '.Mandos'
54
57
client_interface = domain + '.Mandos.Client'
55
 
version = "1.3.1"
 
58
version = "1.5.3"
56
59
 
57
60
# Always run in monochrome mode
58
61
urwid.curses_display.curses.has_colors = lambda : False
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, *args, **kwargs):
 
89
    def __init__(self, proxy_object=None, properties=None, **kwargs):
87
90
        self.proxy = proxy_object # Mandos Client proxy object
88
 
        
89
 
        self.properties = dict()
 
91
        self.properties = dict() if properties is None else properties
90
92
        self.property_changed_match = (
91
93
            self.proxy.connect_to_signal("PropertyChanged",
92
 
                                         self.property_changed,
 
94
                                         self._property_changed,
93
95
                                         client_interface,
94
96
                                         byte_arrays=True))
95
97
        
96
 
        self.properties.update(
97
 
            self.proxy.GetAll(client_interface,
98
 
                              dbus_interface = dbus.PROPERTIES_IFACE))
99
 
 
100
 
        #XXX This breaks good super behaviour
101
 
#        super(MandosClientPropertyCache, self).__init__(
102
 
#            *args, **kwargs)
 
98
        if properties is None:
 
99
            self.properties.update(
 
100
                self.proxy.GetAll(client_interface,
 
101
                                  dbus_interface
 
102
                                  = dbus.PROPERTIES_IFACE))
 
103
        
 
104
        super(MandosClientPropertyCache, self).__init__(**kwargs)
 
105
    
 
106
    def _property_changed(self, property, value):
 
107
        """Helper which takes positional arguments"""
 
108
        return self.property_changed(property=property, value=value)
103
109
    
104
110
    def property_changed(self, property=None, value=None):
105
111
        """This is called whenever we get a PropertyChanged signal
108
114
        # Update properties dict with new value
109
115
        self.properties[property] = value
110
116
    
111
 
    def delete(self, *args, **kwargs):
 
117
    def delete(self):
112
118
        self.property_changed_match.remove()
113
 
        super(MandosClientPropertyCache, self).__init__(
114
 
            *args, **kwargs)
115
119
 
116
120
 
117
121
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
119
123
    """
120
124
    
121
125
    def __init__(self, server_proxy_object=None, update_hook=None,
122
 
                 delete_hook=None, logger=None, *args, **kwargs):
 
126
                 delete_hook=None, logger=None, **kwargs):
123
127
        # Called on update
124
128
        self.update_hook = update_hook
125
129
        # Called on delete
131
135
        
132
136
        self._update_timer_callback_tag = None
133
137
        self._update_timer_callback_lock = 0
134
 
        self.last_checker_failed = False
135
138
        
136
139
        # The widget shown normally
137
140
        self._text_widget = urwid.Text("")
138
141
        # The widget shown when we have focus
139
142
        self._focus_text_widget = urwid.Text("")
140
 
        super(MandosClientWidget, self).__init__(
141
 
            update_hook=update_hook, delete_hook=delete_hook,
142
 
            *args, **kwargs)
 
143
        super(MandosClientWidget, self).__init__(**kwargs)
143
144
        self.update()
144
145
        self.opened = False
145
146
        
146
147
        last_checked_ok = isoformat_to_datetime(self.properties
147
148
                                                ["LastCheckedOK"])
148
 
        if last_checked_ok is None:
149
 
            self.last_checker_failed = True
150
 
        else:
151
 
            self.last_checker_failed = ((datetime.datetime.utcnow()
152
 
                                         - last_checked_ok)
153
 
                                        > datetime.timedelta
154
 
                                        (milliseconds=
155
 
                                         self.properties
156
 
                                         ["Interval"]))
157
149
        
158
 
        if self.last_checker_failed:
 
150
        if self.properties ["LastCheckerStatus"] != 0:
159
151
            self.using_timer(True)
160
152
        
161
153
        if self.need_approval:
182
174
                                         self.rejected,
183
175
                                         client_interface,
184
176
                                         byte_arrays=True))
185
 
        #self.logger('Created client %s' % (self.properties["Name"]))
 
177
        #self.logger('Created client {0}'
 
178
        #            .format(self.properties["Name"]))
186
179
    
187
180
    def property_changed(self, property=None, value=None):
188
181
        super(self, MandosClientWidget).property_changed(property,
189
182
                                                         value)
190
183
        if property == "ApprovalPending":
191
184
            using_timer(bool(value))
192
 
        
 
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))
 
190
    
193
191
    def using_timer(self, flag):
194
192
        """Call this method with True or False when timer should be
195
193
        activated or deactivated.
200
198
        else:
201
199
            self._update_timer_callback_lock -= 1
202
200
        if old == 0 and self._update_timer_callback_lock:
 
201
            # Will update the shown timer value every second
203
202
            self._update_timer_callback_tag = (gobject.timeout_add
204
203
                                               (1000,
205
204
                                                self.update_timer))
209
208
    
210
209
    def checker_completed(self, exitstatus, condition, command):
211
210
        if exitstatus == 0:
212
 
            if self.last_checker_failed:
213
 
                self.last_checker_failed = False
214
 
                self.using_timer(False)
215
 
            #self.logger('Checker for client %s (command "%s")'
216
 
            #            ' was successful'
217
 
            #            % (self.properties["Name"], command))
218
211
            self.update()
219
212
            return
220
213
        # Checker failed
221
 
        if not self.last_checker_failed:
222
 
            self.last_checker_failed = True
223
 
            self.using_timer(True)
224
214
        if os.WIFEXITED(condition):
225
 
            self.logger('Checker for client %s (command "%s")'
226
 
                        ' failed with exit code %s'
227
 
                        % (self.properties["Name"], command,
228
 
                           os.WEXITSTATUS(condition)))
 
215
            self.logger('Checker for client {0} (command "{1}")'
 
216
                        ' failed with exit code {2}'
 
217
                        .format(self.properties["Name"], command,
 
218
                                os.WEXITSTATUS(condition)))
229
219
        elif os.WIFSIGNALED(condition):
230
 
            self.logger('Checker for client %s (command "%s")'
231
 
                        ' was killed by signal %s'
232
 
                        % (self.properties["Name"], command,
233
 
                           os.WTERMSIG(condition)))
 
220
            self.logger('Checker for client {0} (command "{1}") was'
 
221
                        ' killed by signal {2}'
 
222
                        .format(self.properties["Name"], command,
 
223
                                os.WTERMSIG(condition)))
234
224
        elif os.WCOREDUMP(condition):
235
 
            self.logger('Checker for client %s (command "%s")'
 
225
            self.logger('Checker for client {0} (command "{1}")'
236
226
                        ' dumped core'
237
 
                        % (self.properties["Name"], command))
 
227
                        .format(self.properties["Name"], command))
238
228
        else:
239
 
            self.logger('Checker for client %s completed'
240
 
                        ' mysteriously')
 
229
            self.logger('Checker for client {0} completed'
 
230
                        ' mysteriously'
 
231
                        .format(self.properties["Name"]))
241
232
        self.update()
242
233
    
243
234
    def checker_started(self, command):
244
 
        #self.logger('Client %s started checker "%s"'
245
 
        #            % (self.properties["Name"], unicode(command)))
 
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)))
246
240
        pass
247
241
    
248
242
    def got_secret(self):
249
 
        self.last_checker_failed = False
250
 
        self.logger('Client %s received its secret'
251
 
                    % self.properties["Name"])
 
243
        self.logger('Client {0} received its secret'
 
244
                    .format(self.properties["Name"]))
252
245
    
253
246
    def need_approval(self, timeout, default):
254
247
        if not default:
255
 
            message = 'Client %s needs approval within %s seconds'
 
248
            message = 'Client {0} needs approval within {1} seconds'
256
249
        else:
257
 
            message = 'Client %s will get its secret in %s seconds'
258
 
        self.logger(message
259
 
                    % (self.properties["Name"], timeout/1000))
 
250
            message = 'Client {0} will get its secret in {1} seconds'
 
251
        self.logger(message.format(self.properties["Name"],
 
252
                                   timeout/1000))
260
253
        self.using_timer(True)
261
254
    
262
255
    def rejected(self, reason):
263
 
        self.logger('Client %s was rejected; reason: %s'
264
 
                    % (self.properties["Name"], reason))
 
256
        self.logger('Client {0} was rejected; reason: {1}'
 
257
                    .format(self.properties["Name"], reason))
265
258
    
266
259
    def selectable(self):
267
260
        """Make this a "selectable" widget.
293
286
        # Rebuild focus and non-focus widgets using current properties
294
287
 
295
288
        # Base part of a client. Name!
296
 
        base = ('%(name)s: '
297
 
                      % {"name": self.properties["Name"]})
 
289
        base = '{name}: '.format(name=self.properties["Name"])
298
290
        if not self.properties["Enabled"]:
299
291
            message = "DISABLED"
300
292
        elif self.properties["ApprovalPending"]:
309
301
            else:
310
302
                timer = datetime.timedelta()
311
303
            if self.properties["ApprovedByDefault"]:
312
 
                message = "Approval in %s. (d)eny?"
313
 
            else:
314
 
                message = "Denial in %s. (a)pprove?"
315
 
            message = message % unicode(timer).rsplit(".", 1)[0]
316
 
        elif self.last_checker_failed:
317
 
            timeout = datetime.timedelta(milliseconds
318
 
                                         = self.properties
319
 
                                         ["Timeout"])
320
 
            last_ok = isoformat_to_datetime(
321
 
                max((self.properties["LastCheckedOK"]
322
 
                     or self.properties["Created"]),
323
 
                    self.properties["LastEnabled"]))
324
 
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
 
304
                message = "Approval in {0}. (d)eny?"
 
305
            else:
 
306
                message = "Denial in {0}. (a)pprove?"
 
307
            message = message.format(unicode(timer).rsplit(".", 1)[0])
 
308
        elif self.properties["LastCheckerStatus"] != 0:
 
309
            # When checker has failed, show timer until client expires
 
310
            expires = self.properties["Expires"]
 
311
            if expires == "":
 
312
                timer = datetime.timedelta(0)
 
313
            else:
 
314
                expires = (datetime.datetime.strptime
 
315
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
 
316
                timer = expires - datetime.datetime.utcnow()
325
317
            message = ('A checker has failed! Time until client'
326
 
                       ' gets disabled: %s'
327
 
                           % unicode(timer).rsplit(".", 1)[0])
 
318
                       ' gets disabled: {0}'
 
319
                       .format(unicode(timer).rsplit(".", 1)[0]))
328
320
        else:
329
321
            message = "enabled"
330
 
        self._text = "%s%s" % (base, message)
 
322
        self._text = "{0}{1}".format(base, message)
331
323
            
332
324
        if not urwid.supports_unicode():
333
325
            self._text = self._text.encode("ascii", "replace")
346
338
            self.update_hook()
347
339
    
348
340
    def update_timer(self):
349
 
        "called by gobject"
 
341
        """called by gobject. Will indefinitely loop until
 
342
        gobject.source_remove() on tag is called"""
350
343
        self.update()
351
344
        return True             # Keep calling this
352
345
    
353
 
    def delete(self, *args, **kwargs):
 
346
    def delete(self, **kwargs):
354
347
        if self._update_timer_callback_tag is not None:
355
348
            gobject.source_remove(self._update_timer_callback_tag)
356
349
            self._update_timer_callback_tag = None
359
352
        self.match_objects = ()
360
353
        if self.delete_hook is not None:
361
354
            self.delete_hook(self)
362
 
        return super(MandosClientWidget, self).delete(*args, **kwargs)
 
355
        return super(MandosClientWidget, self).delete(**kwargs)
363
356
    
364
357
    def render(self, maxcolrow, focus=False):
365
358
        """Render differently if we have focus.
407
400
        else:
408
401
            return key
409
402
    
410
 
    def property_changed(self, property=None, value=None,
411
 
                         *args, **kwargs):
 
403
    def property_changed(self, property=None, **kwargs):
412
404
        """Call self.update() if old value is not new value.
413
405
        This overrides the method from MandosClientPropertyCache"""
414
406
        property_name = unicode(property)
415
407
        old_value = self.properties.get(property_name)
416
408
        super(MandosClientWidget, self).property_changed(
417
 
            property=property, value=value, *args, **kwargs)
 
409
            property=property, **kwargs)
418
410
        if self.properties.get(property_name) != old_value:
419
411
            self.update()
420
412
 
424
416
    "down" key presses, thus not allowing any containing widgets to
425
417
    use them as an excuse to shift focus away from this widget.
426
418
    """
427
 
    def keypress(self, maxcolrow, key):
428
 
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
 
419
    def keypress(self, *args, **kwargs):
 
420
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
429
421
        if ret in ("up", "down"):
430
422
            return
431
423
        return ret
495
487
        
496
488
        self.busname = domain + '.Mandos'
497
489
        self.main_loop = gobject.MainLoop()
498
 
        self.bus = dbus.SystemBus()
499
 
        mandos_dbus_objc = self.bus.get_object(
500
 
            self.busname, "/", follow_name_owner_changes=True)
501
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
502
 
                                          dbus_interface
503
 
                                          = server_interface)
504
 
        try:
505
 
            mandos_clients = (self.mandos_serv
506
 
                              .GetAllClientsWithProperties())
507
 
        except dbus.exceptions.DBusException:
508
 
            mandos_clients = dbus.Dictionary()
509
 
        
510
 
        (self.mandos_serv
511
 
         .connect_to_signal("ClientRemoved",
512
 
                            self.find_and_remove_client,
513
 
                            dbus_interface=server_interface,
514
 
                            byte_arrays=True))
515
 
        (self.mandos_serv
516
 
         .connect_to_signal("ClientAdded",
517
 
                            self.add_new_client,
518
 
                            dbus_interface=server_interface,
519
 
                            byte_arrays=True))
520
 
        (self.mandos_serv
521
 
         .connect_to_signal("ClientNotFound",
522
 
                            self.client_not_found,
523
 
                            dbus_interface=server_interface,
524
 
                            byte_arrays=True))
525
 
        for path, client in mandos_clients.iteritems():
526
 
            client_proxy_object = self.bus.get_object(self.busname,
527
 
                                                      path)
528
 
            self.add_client(MandosClientWidget(server_proxy_object
529
 
                                               =self.mandos_serv,
530
 
                                               proxy_object
531
 
                                               =client_proxy_object,
532
 
                                               properties=client,
533
 
                                               update_hook
534
 
                                               =self.refresh,
535
 
                                               delete_hook
536
 
                                               =self.remove_client,
537
 
                                               logger
538
 
                                               =self.log_message),
539
 
                            path=path)
540
490
    
541
491
    def client_not_found(self, fingerprint, address):
542
 
        self.log_message(("Client with address %s and fingerprint %s"
543
 
                          " could not be found" % (address,
544
 
                                                    fingerprint)))
 
492
        self.log_message("Client with address {0} and fingerprint"
 
493
                         " {1} could not be found"
 
494
                         .format(address, fingerprint))
545
495
    
546
496
    def rebuild(self):
547
497
        """This rebuilds the User Interface.
557
507
                                                     self.divider)))
558
508
        if self.log_visible:
559
509
            self.uilist.append(self.logbox)
560
 
            pass
561
510
        self.topwidget = urwid.Pile(self.uilist)
562
511
    
563
512
    def log_message(self, message):
601
550
            client = self.clients_dict[path]
602
551
        except KeyError:
603
552
            # not found?
604
 
            self.log_message("Unknown client %r (%r) removed", name,
605
 
                             path)
 
553
            self.log_message("Unknown client {0!r} ({1!r}) removed"
 
554
                             .format(name, path))
606
555
            return
607
556
        client.delete()
608
557
    
647
596
    
648
597
    def run(self):
649
598
        """Start the main loop and exit when it's done."""
 
599
        self.bus = dbus.SystemBus()
 
600
        mandos_dbus_objc = self.bus.get_object(
 
601
            self.busname, "/", follow_name_owner_changes=True)
 
602
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
603
                                          dbus_interface
 
604
                                          = server_interface)
 
605
        try:
 
606
            mandos_clients = (self.mandos_serv
 
607
                              .GetAllClientsWithProperties())
 
608
        except dbus.exceptions.DBusException:
 
609
            mandos_clients = dbus.Dictionary()
 
610
        
 
611
        (self.mandos_serv
 
612
         .connect_to_signal("ClientRemoved",
 
613
                            self.find_and_remove_client,
 
614
                            dbus_interface=server_interface,
 
615
                            byte_arrays=True))
 
616
        (self.mandos_serv
 
617
         .connect_to_signal("ClientAdded",
 
618
                            self.add_new_client,
 
619
                            dbus_interface=server_interface,
 
620
                            byte_arrays=True))
 
621
        (self.mandos_serv
 
622
         .connect_to_signal("ClientNotFound",
 
623
                            self.client_not_found,
 
624
                            dbus_interface=server_interface,
 
625
                            byte_arrays=True))
 
626
        for path, client in mandos_clients.iteritems():
 
627
            client_proxy_object = self.bus.get_object(self.busname,
 
628
                                                      path)
 
629
            self.add_client(MandosClientWidget(server_proxy_object
 
630
                                               =self.mandos_serv,
 
631
                                               proxy_object
 
632
                                               =client_proxy_object,
 
633
                                               properties=client,
 
634
                                               update_hook
 
635
                                               =self.refresh,
 
636
                                               delete_hook
 
637
                                               =self.remove_client,
 
638
                                               logger
 
639
                                               =self.log_message),
 
640
                            path=path)
 
641
        
650
642
        self.refresh()
651
643
        self._input_callback_tag = (gobject.io_add_watch
652
644
                                    (sys.stdin.fileno(),