/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: 2011-07-25 18:49:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110725184917-m9eov06ex6vn9877
* mandos-monitor (MandosClientPropertyCache): Save match tag for
                                              PropertyChanged signal.
  (MandosClientPropertyCache.delete): New; unregister signal.
  (MandosClientWidget.__init__): Save matches for signals.
  (MandosClientWidget): Unregister signals.
  (UserInterface.find_and_remove_client): Log message when removing
                                          a nonexisting client.  Call
                                          client.delete() instead of
                                          self.remove_client().

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-2012 Teddy Hogeborn
7
 
# Copyright © 2009-2012 Björn Påhlsson
 
6
# Copyright © 2009-2011 Teddy Hogeborn
 
7
# Copyright © 2009-2011 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
21
 
# <http://www.gnu.org/licenses/>.
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
21
# 
23
 
# Contact the authors at <mandos@recompile.se>.
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
24
23
# 
25
24
 
26
25
from __future__ import (division, absolute_import, print_function,
27
26
                        unicode_literals)
28
27
 
29
 
from future_builtins import *
30
 
 
31
28
import sys
32
29
import os
33
30
import signal
52
49
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
53
50
 
54
51
# Some useful constants
55
 
domain = 'se.recompile'
 
52
domain = 'se.bsnet.fukt'
56
53
server_interface = domain + '.Mandos'
57
54
client_interface = domain + '.Mandos.Client'
58
 
version = "1.6.0"
 
55
version = "1.3.0"
59
56
 
60
57
# Always run in monochrome mode
61
58
urwid.curses_display.curses.has_colors = lambda : False
86
83
    properties and calls a hook function when any of them are
87
84
    changed.
88
85
    """
89
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
86
    def __init__(self, proxy_object=None, *args, **kwargs):
90
87
        self.proxy = proxy_object # Mandos Client proxy object
91
 
        self.properties = dict() if properties is None else properties
 
88
        
 
89
        self.properties = dict()
92
90
        self.property_changed_match = (
93
91
            self.proxy.connect_to_signal("PropertyChanged",
94
 
                                         self._property_changed,
 
92
                                         self.property_changed,
95
93
                                         client_interface,
96
94
                                         byte_arrays=True))
97
95
        
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)
 
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)
109
103
    
110
104
    def property_changed(self, property=None, value=None):
111
105
        """This is called whenever we get a PropertyChanged signal
114
108
        # Update properties dict with new value
115
109
        self.properties[property] = value
116
110
    
117
 
    def delete(self):
 
111
    def delete(self, *args, **kwargs):
118
112
        self.property_changed_match.remove()
 
113
        super(MandosClientPropertyCache, self).__init__(
 
114
            *args, **kwargs)
119
115
 
120
116
 
121
117
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
123
119
    """
124
120
    
125
121
    def __init__(self, server_proxy_object=None, update_hook=None,
126
 
                 delete_hook=None, logger=None, **kwargs):
 
122
                 delete_hook=None, logger=None, *args, **kwargs):
127
123
        # Called on update
128
124
        self.update_hook = update_hook
129
125
        # Called on delete
134
130
        self.logger = logger
135
131
        
136
132
        self._update_timer_callback_tag = None
 
133
        self._update_timer_callback_lock = 0
 
134
        self.last_checker_failed = False
137
135
        
138
136
        # The widget shown normally
139
137
        self._text_widget = urwid.Text("")
140
138
        # The widget shown when we have focus
141
139
        self._focus_text_widget = urwid.Text("")
142
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
140
        super(MandosClientWidget, self).__init__(
 
141
            update_hook=update_hook, delete_hook=delete_hook,
 
142
            *args, **kwargs)
143
143
        self.update()
144
144
        self.opened = False
145
145
        
 
146
        last_checked_ok = isoformat_to_datetime(self.properties
 
147
                                                ["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
        
 
158
        if self.last_checker_failed:
 
159
            self.using_timer(True)
 
160
        
 
161
        if self.need_approval:
 
162
            self.using_timer(True)
 
163
        
146
164
        self.match_objects = (
147
165
            self.proxy.connect_to_signal("CheckerCompleted",
148
166
                                         self.checker_completed,
164
182
                                         self.rejected,
165
183
                                         client_interface,
166
184
                                         byte_arrays=True))
167
 
        #self.logger('Created client {0}'
168
 
        #            .format(self.properties["Name"]))
 
185
        #self.logger('Created client %s' % (self.properties["Name"]))
169
186
    
 
187
    def property_changed(self, property=None, value=None):
 
188
        super(self, MandosClientWidget).property_changed(property,
 
189
                                                         value)
 
190
        if property == "ApprovalPending":
 
191
            using_timer(bool(value))
 
192
        
170
193
    def using_timer(self, flag):
171
194
        """Call this method with True or False when timer should be
172
195
        activated or deactivated.
173
196
        """
174
 
        if flag and self._update_timer_callback_tag is None:
175
 
            # Will update the shown timer value every second
 
197
        old = self._update_timer_callback_lock
 
198
        if flag:
 
199
            self._update_timer_callback_lock += 1
 
200
        else:
 
201
            self._update_timer_callback_lock -= 1
 
202
        if old == 0 and self._update_timer_callback_lock:
176
203
            self._update_timer_callback_tag = (gobject.timeout_add
177
204
                                               (1000,
178
205
                                                self.update_timer))
179
 
        elif not (flag or self._update_timer_callback_tag is None):
 
206
        elif old and self._update_timer_callback_lock == 0:
180
207
            gobject.source_remove(self._update_timer_callback_tag)
181
208
            self._update_timer_callback_tag = None
182
209
    
183
210
    def checker_completed(self, exitstatus, condition, command):
184
211
        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))
185
218
            self.update()
186
219
            return
187
220
        # Checker failed
 
221
        if not self.last_checker_failed:
 
222
            self.last_checker_failed = True
 
223
            self.using_timer(True)
188
224
        if os.WIFEXITED(condition):
189
 
            self.logger('Checker for client {0} (command "{1}")'
190
 
                        ' failed with exit code {2}'
191
 
                        .format(self.properties["Name"], command,
192
 
                                os.WEXITSTATUS(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)))
193
229
        elif os.WIFSIGNALED(condition):
194
 
            self.logger('Checker for client {0} (command "{1}") was'
195
 
                        ' killed by signal {2}'
196
 
                        .format(self.properties["Name"], command,
197
 
                                os.WTERMSIG(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)))
198
234
        elif os.WCOREDUMP(condition):
199
 
            self.logger('Checker for client {0} (command "{1}")'
 
235
            self.logger('Checker for client %s (command "%s")'
200
236
                        ' dumped core'
201
 
                        .format(self.properties["Name"], command))
 
237
                        % (self.properties["Name"], command))
202
238
        else:
203
 
            self.logger('Checker for client {0} completed'
204
 
                        ' mysteriously'
205
 
                        .format(self.properties["Name"]))
 
239
            self.logger('Checker for client %s completed'
 
240
                        ' mysteriously')
206
241
        self.update()
207
242
    
208
243
    def checker_started(self, command):
209
 
        """Server signals that a checker started. This could be useful
210
 
           to log in the future. """
211
 
        #self.logger('Client {0} started checker "{1}"'
212
 
        #            .format(self.properties["Name"],
213
 
        #                    unicode(command)))
 
244
        #self.logger('Client %s started checker "%s"'
 
245
        #            % (self.properties["Name"], unicode(command)))
214
246
        pass
215
247
    
216
248
    def got_secret(self):
217
 
        self.logger('Client {0} received its secret'
218
 
                    .format(self.properties["Name"]))
 
249
        self.last_checker_failed = False
 
250
        self.logger('Client %s received its secret'
 
251
                    % self.properties["Name"])
219
252
    
220
253
    def need_approval(self, timeout, default):
221
254
        if not default:
222
 
            message = 'Client {0} needs approval within {1} seconds'
 
255
            message = 'Client %s needs approval within %s seconds'
223
256
        else:
224
 
            message = 'Client {0} will get its secret in {1} seconds'
225
 
        self.logger(message.format(self.properties["Name"],
226
 
                                   timeout/1000))
 
257
            message = 'Client %s will get its secret in %s seconds'
 
258
        self.logger(message
 
259
                    % (self.properties["Name"], timeout/1000))
 
260
        self.using_timer(True)
227
261
    
228
262
    def rejected(self, reason):
229
 
        self.logger('Client {0} was rejected; reason: {1}'
230
 
                    .format(self.properties["Name"], reason))
 
263
        self.logger('Client %s was rejected; reason: %s'
 
264
                    % (self.properties["Name"], reason))
231
265
    
232
266
    def selectable(self):
233
267
        """Make this a "selectable" widget.
255
289
                          "bold-underline-blink":
256
290
                              "bold-underline-blink-standout",
257
291
                          }
258
 
        
 
292
 
259
293
        # Rebuild focus and non-focus widgets using current properties
260
 
        
 
294
 
261
295
        # Base part of a client. Name!
262
 
        base = '{name}: '.format(name=self.properties["Name"])
 
296
        base = ('%(name)s: '
 
297
                      % {"name": self.properties["Name"]})
263
298
        if not self.properties["Enabled"]:
264
299
            message = "DISABLED"
265
 
            self.using_timer(False)
266
300
        elif self.properties["ApprovalPending"]:
267
301
            timeout = datetime.timedelta(milliseconds
268
302
                                         = self.properties
270
304
            last_approval_request = isoformat_to_datetime(
271
305
                self.properties["LastApprovalRequest"])
272
306
            if last_approval_request is not None:
273
 
                timer = max(timeout - (datetime.datetime.utcnow()
274
 
                                       - last_approval_request),
275
 
                            datetime.timedelta())
 
307
                timer = timeout - (datetime.datetime.utcnow()
 
308
                                   - last_approval_request)
276
309
            else:
277
310
                timer = datetime.timedelta()
278
311
            if self.properties["ApprovedByDefault"]:
279
 
                message = "Approval in {0}. (d)eny?"
280
 
            else:
281
 
                message = "Denial in {0}. (a)pprove?"
282
 
            message = message.format(unicode(timer).rsplit(".", 1)[0])
283
 
            self.using_timer(True)
284
 
        elif self.properties["LastCheckerStatus"] != 0:
285
 
            # When checker has failed, show timer until client expires
286
 
            expires = self.properties["Expires"]
287
 
            if expires == "":
288
 
                timer = datetime.timedelta(0)
289
 
            else:
290
 
                expires = (datetime.datetime.strptime
291
 
                           (expires, '%Y-%m-%dT%H:%M:%S.%f'))
292
 
                timer = max(expires - datetime.datetime.utcnow(),
293
 
                            datetime.timedelta())
 
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)
294
325
            message = ('A checker has failed! Time until client'
295
 
                       ' gets disabled: {0}'
296
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
297
 
            self.using_timer(True)
 
326
                       ' gets disabled: %s'
 
327
                           % unicode(timer).rsplit(".", 1)[0])
298
328
        else:
299
329
            message = "enabled"
300
 
            self.using_timer(False)
301
 
        self._text = "{0}{1}".format(base, message)
302
 
        
 
330
        self._text = "%s%s" % (base, message)
 
331
            
303
332
        if not urwid.supports_unicode():
304
333
            self._text = self._text.encode("ascii", "replace")
305
334
        textlist = [("normal", self._text)]
317
346
            self.update_hook()
318
347
    
319
348
    def update_timer(self):
320
 
        """called by gobject. Will indefinitely loop until
321
 
        gobject.source_remove() on tag is called"""
 
349
        "called by gobject"
322
350
        self.update()
323
351
        return True             # Keep calling this
324
352
    
325
 
    def delete(self, **kwargs):
 
353
    def delete(self, *args, **kwargs):
326
354
        if self._update_timer_callback_tag is not None:
327
355
            gobject.source_remove(self._update_timer_callback_tag)
328
356
            self._update_timer_callback_tag = None
331
359
        self.match_objects = ()
332
360
        if self.delete_hook is not None:
333
361
            self.delete_hook(self)
334
 
        return super(MandosClientWidget, self).delete(**kwargs)
 
362
        return super(MandosClientWidget, self).delete(*args, **kwargs)
335
363
    
336
364
    def render(self, maxcolrow, focus=False):
337
365
        """Render differently if we have focus.
379
407
        else:
380
408
            return key
381
409
    
382
 
    def property_changed(self, property=None, **kwargs):
 
410
    def property_changed(self, property=None, value=None,
 
411
                         *args, **kwargs):
383
412
        """Call self.update() if old value is not new value.
384
413
        This overrides the method from MandosClientPropertyCache"""
385
414
        property_name = unicode(property)
386
415
        old_value = self.properties.get(property_name)
387
416
        super(MandosClientWidget, self).property_changed(
388
 
            property=property, **kwargs)
 
417
            property=property, value=value, *args, **kwargs)
389
418
        if self.properties.get(property_name) != old_value:
390
419
            self.update()
391
420
 
395
424
    "down" key presses, thus not allowing any containing widgets to
396
425
    use them as an excuse to shift focus away from this widget.
397
426
    """
398
 
    def keypress(self, *args, **kwargs):
399
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
427
    def keypress(self, maxcolrow, key):
 
428
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
400
429
        if ret in ("up", "down"):
401
430
            return
402
431
        return ret
466
495
        
467
496
        self.busname = domain + '.Mandos'
468
497
        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)
469
540
    
470
541
    def client_not_found(self, fingerprint, address):
471
 
        self.log_message("Client with address {0} and fingerprint"
472
 
                         " {1} could not be found"
473
 
                         .format(address, fingerprint))
 
542
        self.log_message(("Client with address %s and fingerprint %s"
 
543
                          " could not be found" % (address,
 
544
                                                    fingerprint)))
474
545
    
475
546
    def rebuild(self):
476
547
        """This rebuilds the User Interface.
486
557
                                                     self.divider)))
487
558
        if self.log_visible:
488
559
            self.uilist.append(self.logbox)
 
560
            pass
489
561
        self.topwidget = urwid.Pile(self.uilist)
490
562
    
491
563
    def log_message(self, message):
492
 
        """Log message formatted with timestamp"""
493
564
        timestamp = datetime.datetime.now().isoformat()
494
565
        self.log_message_raw(timestamp + ": " + message)
495
566
    
530
601
            client = self.clients_dict[path]
531
602
        except KeyError:
532
603
            # not found?
533
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
534
 
                             .format(name, path))
 
604
            self.log_message("Unknown client %r (%r) removed", name,
 
605
                             path)
535
606
            return
536
607
        client.delete()
537
608
    
576
647
    
577
648
    def run(self):
578
649
        """Start the main loop and exit when it's done."""
579
 
        self.bus = dbus.SystemBus()
580
 
        mandos_dbus_objc = self.bus.get_object(
581
 
            self.busname, "/", follow_name_owner_changes=True)
582
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
583
 
                                          dbus_interface
584
 
                                          = server_interface)
585
 
        try:
586
 
            mandos_clients = (self.mandos_serv
587
 
                              .GetAllClientsWithProperties())
588
 
            if not mandos_clients:
589
 
                self.log_message_raw(("bold", "Note: Server has no clients."))
590
 
        except dbus.exceptions.DBusException:
591
 
            self.log_message_raw(("bold", "Note: No Mandos servers running."))
592
 
            mandos_clients = dbus.Dictionary()
593
 
        
594
 
        (self.mandos_serv
595
 
         .connect_to_signal("ClientRemoved",
596
 
                            self.find_and_remove_client,
597
 
                            dbus_interface=server_interface,
598
 
                            byte_arrays=True))
599
 
        (self.mandos_serv
600
 
         .connect_to_signal("ClientAdded",
601
 
                            self.add_new_client,
602
 
                            dbus_interface=server_interface,
603
 
                            byte_arrays=True))
604
 
        (self.mandos_serv
605
 
         .connect_to_signal("ClientNotFound",
606
 
                            self.client_not_found,
607
 
                            dbus_interface=server_interface,
608
 
                            byte_arrays=True))
609
 
        for path, client in mandos_clients.iteritems():
610
 
            client_proxy_object = self.bus.get_object(self.busname,
611
 
                                                      path)
612
 
            self.add_client(MandosClientWidget(server_proxy_object
613
 
                                               =self.mandos_serv,
614
 
                                               proxy_object
615
 
                                               =client_proxy_object,
616
 
                                               properties=client,
617
 
                                               update_hook
618
 
                                               =self.refresh,
619
 
                                               delete_hook
620
 
                                               =self.remove_client,
621
 
                                               logger
622
 
                                               =self.log_message),
623
 
                            path=path)
624
 
        
625
650
        self.refresh()
626
651
        self._input_callback_tag = (gobject.io_add_watch
627
652
                                    (sys.stdin.fileno(),