/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

  • Committer: Björn Påhlsson
  • Date: 2011-07-25 18:46:19 UTC
  • mfrom: (237.7.35 trunk)
  • mto: (237.7.37 trunk)
  • mto: This revision was merged to the branch mainline in revision 284.
  • Revision ID: belorn@fukt.bsnet.se-20110725184619-l7vfsobr0bh9fc3l
merge

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/>.
22
 
# 
23
 
# Contact the authors at <mandos@recompile.se>.
24
 
# 
25
 
 
26
 
from __future__ import (division, absolute_import, print_function,
27
 
                        unicode_literals)
28
 
 
29
 
from future_builtins import *
 
20
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
21
# 
 
22
# Contact the authors at <mandos@fukt.bsnet.se>.
 
23
# 
 
24
 
 
25
from __future__ import division, absolute_import, print_function, unicode_literals
30
26
 
31
27
import sys
32
28
import os
52
48
logging.getLogger('dbus.proxies').setLevel(logging.CRITICAL)
53
49
 
54
50
# Some useful constants
55
 
domain = 'se.recompile'
 
51
domain = 'se.bsnet.fukt'
56
52
server_interface = domain + '.Mandos'
57
53
client_interface = domain + '.Mandos.Client'
58
 
version = "1.5.4"
 
54
version = "1.3.0"
59
55
 
60
56
# Always run in monochrome mode
61
57
urwid.curses_display.curses.has_colors = lambda : False
86
82
    properties and calls a hook function when any of them are
87
83
    changed.
88
84
    """
89
 
    def __init__(self, proxy_object=None, properties=None, **kwargs):
 
85
    def __init__(self, proxy_object=None, *args, **kwargs):
90
86
        self.proxy = proxy_object # Mandos Client proxy object
91
 
        self.properties = dict() if properties is None else properties
92
 
        self.property_changed_match = (
93
 
            self.proxy.connect_to_signal("PropertyChanged",
94
 
                                         self._property_changed,
95
 
                                         client_interface,
96
 
                                         byte_arrays=True))
97
 
        
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)
 
87
        
 
88
        self.properties = dict()
 
89
        self.proxy.connect_to_signal("PropertyChanged",
 
90
                                     self.property_changed,
 
91
                                     client_interface,
 
92
                                     byte_arrays=True)
 
93
        
 
94
        self.properties.update(
 
95
            self.proxy.GetAll(client_interface,
 
96
                              dbus_interface = dbus.PROPERTIES_IFACE))
 
97
 
 
98
        #XXX This break good super behaviour!
 
99
#        super(MandosClientPropertyCache, self).__init__(
 
100
#            *args, **kwargs)
109
101
    
110
102
    def property_changed(self, property=None, value=None):
111
103
        """This is called whenever we get a PropertyChanged signal
113
105
        """
114
106
        # Update properties dict with new value
115
107
        self.properties[property] = value
116
 
    
117
 
    def delete(self):
118
 
        self.property_changed_match.remove()
119
108
 
120
109
 
121
110
class MandosClientWidget(urwid.FlowWidget, MandosClientPropertyCache):
123
112
    """
124
113
    
125
114
    def __init__(self, server_proxy_object=None, update_hook=None,
126
 
                 delete_hook=None, logger=None, **kwargs):
 
115
                 delete_hook=None, logger=None, *args, **kwargs):
127
116
        # Called on update
128
117
        self.update_hook = update_hook
129
118
        # Called on delete
134
123
        self.logger = logger
135
124
        
136
125
        self._update_timer_callback_tag = None
 
126
        self._update_timer_callback_lock = 0
 
127
        self.last_checker_failed = False
137
128
        
138
129
        # The widget shown normally
139
130
        self._text_widget = urwid.Text("")
140
131
        # The widget shown when we have focus
141
132
        self._focus_text_widget = urwid.Text("")
142
 
        super(MandosClientWidget, self).__init__(**kwargs)
 
133
        super(MandosClientWidget, self).__init__(
 
134
            update_hook=update_hook, delete_hook=delete_hook,
 
135
            *args, **kwargs)
143
136
        self.update()
144
137
        self.opened = False
145
138
        
146
 
        self.match_objects = (
147
 
            self.proxy.connect_to_signal("CheckerCompleted",
148
 
                                         self.checker_completed,
149
 
                                         client_interface,
150
 
                                         byte_arrays=True),
151
 
            self.proxy.connect_to_signal("CheckerStarted",
152
 
                                         self.checker_started,
153
 
                                         client_interface,
154
 
                                         byte_arrays=True),
155
 
            self.proxy.connect_to_signal("GotSecret",
156
 
                                         self.got_secret,
157
 
                                         client_interface,
158
 
                                         byte_arrays=True),
159
 
            self.proxy.connect_to_signal("NeedApproval",
160
 
                                         self.need_approval,
161
 
                                         client_interface,
162
 
                                         byte_arrays=True),
163
 
            self.proxy.connect_to_signal("Rejected",
164
 
                                         self.rejected,
165
 
                                         client_interface,
166
 
                                         byte_arrays=True))
167
 
        #self.logger('Created client {0}'
168
 
        #            .format(self.properties["Name"]))
 
139
        last_checked_ok = isoformat_to_datetime(self.properties
 
140
                                                ["LastCheckedOK"])
 
141
        if last_checked_ok is None:
 
142
            self.last_checker_failed = True
 
143
        else:
 
144
            self.last_checker_failed = ((datetime.datetime.utcnow()
 
145
                                         - last_checked_ok)
 
146
                                        > datetime.timedelta
 
147
                                        (milliseconds=
 
148
                                         self.properties
 
149
                                         ["Interval"]))
 
150
        
 
151
        if self.last_checker_failed:
 
152
            self.using_timer(True)
 
153
        
 
154
        if self.need_approval:
 
155
            self.using_timer(True)
 
156
        
 
157
        self.proxy.connect_to_signal("CheckerCompleted",
 
158
                                     self.checker_completed,
 
159
                                     client_interface,
 
160
                                     byte_arrays=True)
 
161
        self.proxy.connect_to_signal("CheckerStarted",
 
162
                                     self.checker_started,
 
163
                                     client_interface,
 
164
                                     byte_arrays=True)
 
165
        self.proxy.connect_to_signal("GotSecret",
 
166
                                     self.got_secret,
 
167
                                     client_interface,
 
168
                                     byte_arrays=True)
 
169
        self.proxy.connect_to_signal("NeedApproval",
 
170
                                     self.need_approval,
 
171
                                     client_interface,
 
172
                                     byte_arrays=True)
 
173
        self.proxy.connect_to_signal("Rejected",
 
174
                                     self.rejected,
 
175
                                     client_interface,
 
176
                                     byte_arrays=True)
169
177
    
 
178
    def property_changed(self, property=None, value=None):
 
179
        super(self, MandosClientWidget).property_changed(property,
 
180
                                                         value)
 
181
        if property == "ApprovalPending":
 
182
            using_timer(bool(value))
 
183
        
170
184
    def using_timer(self, flag):
171
185
        """Call this method with True or False when timer should be
172
186
        activated or deactivated.
173
187
        """
174
 
        if flag and self._update_timer_callback_tag is None:
175
 
            # Will update the shown timer value every second
 
188
        old = self._update_timer_callback_lock
 
189
        if flag:
 
190
            self._update_timer_callback_lock += 1
 
191
        else:
 
192
            self._update_timer_callback_lock -= 1
 
193
        if old == 0 and self._update_timer_callback_lock:
176
194
            self._update_timer_callback_tag = (gobject.timeout_add
177
195
                                               (1000,
178
196
                                                self.update_timer))
179
 
        elif not (flag or self._update_timer_callback_tag is None):
 
197
        elif old and self._update_timer_callback_lock == 0:
180
198
            gobject.source_remove(self._update_timer_callback_tag)
181
199
            self._update_timer_callback_tag = None
182
200
    
183
201
    def checker_completed(self, exitstatus, condition, command):
184
202
        if exitstatus == 0:
 
203
            if self.last_checker_failed:
 
204
                self.last_checker_failed = False
 
205
                self.using_timer(False)
 
206
            #self.logger('Checker for client %s (command "%s")'
 
207
            #            ' was successful'
 
208
            #            % (self.properties["Name"], command))
185
209
            self.update()
186
210
            return
187
211
        # Checker failed
 
212
        if not self.last_checker_failed:
 
213
            self.last_checker_failed = True
 
214
            self.using_timer(True)
188
215
        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)))
 
216
            self.logger('Checker for client %s (command "%s")'
 
217
                        ' failed with exit code %s'
 
218
                        % (self.properties["Name"], command,
 
219
                           os.WEXITSTATUS(condition)))
193
220
        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)))
 
221
            self.logger('Checker for client %s (command "%s")'
 
222
                        ' was killed by signal %s'
 
223
                        % (self.properties["Name"], command,
 
224
                           os.WTERMSIG(condition)))
198
225
        elif os.WCOREDUMP(condition):
199
 
            self.logger('Checker for client {0} (command "{1}")'
 
226
            self.logger('Checker for client %s (command "%s")'
200
227
                        ' dumped core'
201
 
                        .format(self.properties["Name"], command))
 
228
                        % (self.properties["Name"], command))
202
229
        else:
203
 
            self.logger('Checker for client {0} completed'
204
 
                        ' mysteriously'
205
 
                        .format(self.properties["Name"]))
 
230
            self.logger('Checker for client %s completed'
 
231
                        ' mysteriously')
206
232
        self.update()
207
233
    
208
234
    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)))
 
235
        #self.logger('Client %s started checker "%s"'
 
236
        #            % (self.properties["Name"], unicode(command)))
214
237
        pass
215
238
    
216
239
    def got_secret(self):
217
 
        self.logger('Client {0} received its secret'
218
 
                    .format(self.properties["Name"]))
 
240
        self.last_checker_failed = False
 
241
        self.logger('Client %s received its secret'
 
242
                    % self.properties["Name"])
219
243
    
220
244
    def need_approval(self, timeout, default):
221
245
        if not default:
222
 
            message = 'Client {0} needs approval within {1} seconds'
 
246
            message = 'Client %s needs approval within %s seconds'
223
247
        else:
224
 
            message = 'Client {0} will get its secret in {1} seconds'
225
 
        self.logger(message.format(self.properties["Name"],
226
 
                                   timeout/1000))
 
248
            message = 'Client %s will get its secret in %s seconds'
 
249
        self.logger(message
 
250
                    % (self.properties["Name"], timeout/1000))
 
251
        self.using_timer(True)
227
252
    
228
253
    def rejected(self, reason):
229
 
        self.logger('Client {0} was rejected; reason: {1}'
230
 
                    .format(self.properties["Name"], reason))
 
254
        self.logger('Client %s was rejected; reason: %s'
 
255
                    % (self.properties["Name"], reason))
231
256
    
232
257
    def selectable(self):
233
258
        """Make this a "selectable" widget.
255
280
                          "bold-underline-blink":
256
281
                              "bold-underline-blink-standout",
257
282
                          }
258
 
        
 
283
 
259
284
        # Rebuild focus and non-focus widgets using current properties
260
 
        
 
285
 
261
286
        # Base part of a client. Name!
262
 
        base = '{name}: '.format(name=self.properties["Name"])
 
287
        base = ('%(name)s: '
 
288
                      % {"name": self.properties["Name"]})
263
289
        if not self.properties["Enabled"]:
264
290
            message = "DISABLED"
265
 
            self.using_timer(False)
266
291
        elif self.properties["ApprovalPending"]:
267
292
            timeout = datetime.timedelta(milliseconds
268
293
                                         = self.properties
270
295
            last_approval_request = isoformat_to_datetime(
271
296
                self.properties["LastApprovalRequest"])
272
297
            if last_approval_request is not None:
273
 
                timer = max(timeout - (datetime.datetime.utcnow()
274
 
                                       - last_approval_request),
275
 
                            datetime.timedelta())
 
298
                timer = timeout - (datetime.datetime.utcnow()
 
299
                                   - last_approval_request)
276
300
            else:
277
301
                timer = datetime.timedelta()
278
302
            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())
 
303
                message = "Approval in %s. (d)eny?"
 
304
            else:
 
305
                message = "Denial in %s. (a)pprove?"
 
306
            message = message % unicode(timer).rsplit(".", 1)[0]
 
307
        elif self.last_checker_failed:
 
308
            timeout = datetime.timedelta(milliseconds
 
309
                                         = self.properties
 
310
                                         ["Timeout"])
 
311
            last_ok = isoformat_to_datetime(
 
312
                max((self.properties["LastCheckedOK"]
 
313
                     or self.properties["Created"]),
 
314
                    self.properties["LastEnabled"]))
 
315
            timer = timeout - (datetime.datetime.utcnow() - last_ok)
294
316
            message = ('A checker has failed! Time until client'
295
 
                       ' gets disabled: {0}'
296
 
                       .format(unicode(timer).rsplit(".", 1)[0]))
297
 
            self.using_timer(True)
 
317
                       ' gets disabled: %s'
 
318
                           % unicode(timer).rsplit(".", 1)[0])
298
319
        else:
299
320
            message = "enabled"
300
 
            self.using_timer(False)
301
 
        self._text = "{0}{1}".format(base, message)
302
 
        
 
321
        self._text = "%s%s" % (base, message)
 
322
            
303
323
        if not urwid.supports_unicode():
304
324
            self._text = self._text.encode("ascii", "replace")
305
325
        textlist = [("normal", self._text)]
317
337
            self.update_hook()
318
338
    
319
339
    def update_timer(self):
320
 
        """called by gobject. Will indefinitely loop until
321
 
        gobject.source_remove() on tag is called"""
 
340
        "called by gobject"
322
341
        self.update()
323
342
        return True             # Keep calling this
324
343
    
325
 
    def delete(self, **kwargs):
 
344
    def delete(self):
326
345
        if self._update_timer_callback_tag is not None:
327
346
            gobject.source_remove(self._update_timer_callback_tag)
328
347
            self._update_timer_callback_tag = None
329
 
        for match in self.match_objects:
330
 
            match.remove()
331
 
        self.match_objects = ()
332
348
        if self.delete_hook is not None:
333
349
            self.delete_hook(self)
334
 
        return super(MandosClientWidget, self).delete(**kwargs)
335
350
    
336
351
    def render(self, maxcolrow, focus=False):
337
352
        """Render differently if we have focus.
379
394
        else:
380
395
            return key
381
396
    
382
 
    def property_changed(self, property=None, **kwargs):
 
397
    def property_changed(self, property=None, value=None,
 
398
                         *args, **kwargs):
383
399
        """Call self.update() if old value is not new value.
384
400
        This overrides the method from MandosClientPropertyCache"""
385
401
        property_name = unicode(property)
386
402
        old_value = self.properties.get(property_name)
387
403
        super(MandosClientWidget, self).property_changed(
388
 
            property=property, **kwargs)
 
404
            property=property, value=value, *args, **kwargs)
389
405
        if self.properties.get(property_name) != old_value:
390
406
            self.update()
391
407
 
395
411
    "down" key presses, thus not allowing any containing widgets to
396
412
    use them as an excuse to shift focus away from this widget.
397
413
    """
398
 
    def keypress(self, *args, **kwargs):
399
 
        ret = super(ConstrainedListBox, self).keypress(*args, **kwargs)
 
414
    def keypress(self, maxcolrow, key):
 
415
        ret = super(ConstrainedListBox, self).keypress(maxcolrow, key)
400
416
        if ret in ("up", "down"):
401
417
            return
402
418
        return ret
466
482
        
467
483
        self.busname = domain + '.Mandos'
468
484
        self.main_loop = gobject.MainLoop()
 
485
        self.bus = dbus.SystemBus()
 
486
        mandos_dbus_objc = self.bus.get_object(
 
487
            self.busname, "/", follow_name_owner_changes=True)
 
488
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
 
489
                                          dbus_interface
 
490
                                          = server_interface)
 
491
        try:
 
492
            mandos_clients = (self.mandos_serv
 
493
                              .GetAllClientsWithProperties())
 
494
        except dbus.exceptions.DBusException:
 
495
            mandos_clients = dbus.Dictionary()
 
496
        
 
497
        (self.mandos_serv
 
498
         .connect_to_signal("ClientRemoved",
 
499
                            self.find_and_remove_client,
 
500
                            dbus_interface=server_interface,
 
501
                            byte_arrays=True))
 
502
        (self.mandos_serv
 
503
         .connect_to_signal("ClientAdded",
 
504
                            self.add_new_client,
 
505
                            dbus_interface=server_interface,
 
506
                            byte_arrays=True))
 
507
        (self.mandos_serv
 
508
         .connect_to_signal("ClientNotFound",
 
509
                            self.client_not_found,
 
510
                            dbus_interface=server_interface,
 
511
                            byte_arrays=True))
 
512
        for path, client in mandos_clients.iteritems():
 
513
            client_proxy_object = self.bus.get_object(self.busname,
 
514
                                                      path)
 
515
            self.add_client(MandosClientWidget(server_proxy_object
 
516
                                               =self.mandos_serv,
 
517
                                               proxy_object
 
518
                                               =client_proxy_object,
 
519
                                               properties=client,
 
520
                                               update_hook
 
521
                                               =self.refresh,
 
522
                                               delete_hook
 
523
                                               =self.remove_client,
 
524
                                               logger
 
525
                                               =self.log_message),
 
526
                            path=path)
469
527
    
470
528
    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))
 
529
        self.log_message(("Client with address %s and fingerprint %s"
 
530
                          " could not be found" % (address,
 
531
                                                    fingerprint)))
474
532
    
475
533
    def rebuild(self):
476
534
        """This rebuilds the User Interface.
486
544
                                                     self.divider)))
487
545
        if self.log_visible:
488
546
            self.uilist.append(self.logbox)
 
547
            pass
489
548
        self.topwidget = urwid.Pile(self.uilist)
490
549
    
491
550
    def log_message(self, message):
521
580
        #self.log_message("Wrap mode: " + self.log_wrap)
522
581
    
523
582
    def find_and_remove_client(self, path, name):
524
 
        """Find a client by its object path and remove it.
 
583
        """Find an client from its object path and remove it.
525
584
        
526
585
        This is connected to the ClientRemoved signal from the
527
586
        Mandos server object."""
529
588
            client = self.clients_dict[path]
530
589
        except KeyError:
531
590
            # not found?
532
 
            self.log_message("Unknown client {0!r} ({1!r}) removed"
533
 
                             .format(name, path))
534
591
            return
535
 
        client.delete()
 
592
        self.remove_client(client, path)
536
593
    
537
594
    def add_new_client(self, path):
538
595
        client_proxy_object = self.bus.get_object(self.busname, path)
575
632
    
576
633
    def run(self):
577
634
        """Start the main loop and exit when it's done."""
578
 
        self.bus = dbus.SystemBus()
579
 
        mandos_dbus_objc = self.bus.get_object(
580
 
            self.busname, "/", follow_name_owner_changes=True)
581
 
        self.mandos_serv = dbus.Interface(mandos_dbus_objc,
582
 
                                          dbus_interface
583
 
                                          = server_interface)
584
 
        try:
585
 
            mandos_clients = (self.mandos_serv
586
 
                              .GetAllClientsWithProperties())
587
 
        except dbus.exceptions.DBusException:
588
 
            mandos_clients = dbus.Dictionary()
589
 
        
590
 
        (self.mandos_serv
591
 
         .connect_to_signal("ClientRemoved",
592
 
                            self.find_and_remove_client,
593
 
                            dbus_interface=server_interface,
594
 
                            byte_arrays=True))
595
 
        (self.mandos_serv
596
 
         .connect_to_signal("ClientAdded",
597
 
                            self.add_new_client,
598
 
                            dbus_interface=server_interface,
599
 
                            byte_arrays=True))
600
 
        (self.mandos_serv
601
 
         .connect_to_signal("ClientNotFound",
602
 
                            self.client_not_found,
603
 
                            dbus_interface=server_interface,
604
 
                            byte_arrays=True))
605
 
        for path, client in mandos_clients.iteritems():
606
 
            client_proxy_object = self.bus.get_object(self.busname,
607
 
                                                      path)
608
 
            self.add_client(MandosClientWidget(server_proxy_object
609
 
                                               =self.mandos_serv,
610
 
                                               proxy_object
611
 
                                               =client_proxy_object,
612
 
                                               properties=client,
613
 
                                               update_hook
614
 
                                               =self.refresh,
615
 
                                               delete_hook
616
 
                                               =self.remove_client,
617
 
                                               logger
618
 
                                               =self.log_message),
619
 
                            path=path)
620
 
        
621
635
        self.refresh()
622
636
        self._input_callback_tag = (gobject.io_add_watch
623
637
                                    (sys.stdin.fileno(),